<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crypto++: SimpleKeyAgreementDomain Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>SimpleKeyAgreementDomain Class Reference</h1><!-- doxytag: class="SimpleKeyAgreementDomain" --><!-- doxytag: inherits="KeyAgreementAlgorithm" -->
<p>interface for domains of simple key agreement protocols
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for SimpleKeyAgreementDomain:</div>
<div class="dynsection">
<div class="center">
<img src="class_simple_key_agreement_domain.gif" usemap="#SimpleKeyAgreementDomain_map" alt=""/>
<map id="SimpleKeyAgreementDomain_map" name="SimpleKeyAgreementDomain_map">
<area href="class_key_agreement_algorithm.html" alt="KeyAgreementAlgorithm" shape="rect" coords="443,168,876,192"/>
<area href="class_asymmetric_algorithm.html" alt="AsymmetricAlgorithm" shape="rect" coords="443,112,876,136"/>
<area href="class_algorithm.html" alt="Algorithm" shape="rect" coords="443,56,876,80"/>
<area href="class_clonable.html" alt="Clonable" shape="rect" coords="443,0,876,24"/>
<area href="class_d_l___simple_key_agreement_domain_base.html" alt="DL_SimpleKeyAgreementDomainBase< T >" shape="rect" coords="0,280,433,304"/>
<area href="class_d_l___simple_key_agreement_domain_base.html" alt="DL_SimpleKeyAgreementDomainBase< GROUP_PARAMETERS::Element >" shape="rect" coords="443,280,876,304"/>
<area href="class_x_t_r___d_h.html" alt="XTR_DH" shape="rect" coords="886,280,1319,304"/>
<area href="class_d_h___domain.html" alt="DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >" shape="rect" coords="443,336,876,360"/>
</map>
</div>
</div>
<p><a href="class_simple_key_agreement_domain-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aedb873e4aa6fc15ac5245b7af04e4946"></a><!-- doxytag: member="SimpleKeyAgreementDomain::AgreedValueLength" ref="aedb873e4aa6fc15ac5245b7af04e4946" args="() const =0" -->
virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_key_agreement_domain.html#aedb873e4aa6fc15ac5245b7af04e4946">AgreedValueLength</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return length of agreed value produced <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e2e4c5ab6584e4aef0c6da6b122a668"></a><!-- doxytag: member="SimpleKeyAgreementDomain::PrivateKeyLength" ref="a8e2e4c5ab6584e4aef0c6da6b122a668" args="() const =0" -->
virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_key_agreement_domain.html#a8e2e4c5ab6584e4aef0c6da6b122a668">PrivateKeyLength</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return length of private keys in this domain <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a717ec0ad52950f8d792466ad591b5104"></a><!-- doxytag: member="SimpleKeyAgreementDomain::PublicKeyLength" ref="a717ec0ad52950f8d792466ad591b5104" args="() const =0" -->
virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_key_agreement_domain.html#a717ec0ad52950f8d792466ad591b5104">PublicKeyLength</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return length of public keys in this domain <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_key_agreement_domain.html#aee7a4929f8a1a77acd04e12fbcd0a0b1">GeneratePrivateKey</a> (<a class="el" href="class_random_number_generator.html">RandomNumberGenerator</a> &rng, byte *privateKey) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">generate private key <a href="#aee7a4929f8a1a77acd04e12fbcd0a0b1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_key_agreement_domain.html#a56d0957a43c48f3e6431868f564f574f">GeneratePublicKey</a> (<a class="el" href="class_random_number_generator.html">RandomNumberGenerator</a> &rng, const byte *privateKey, byte *publicKey) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">generate public key <a href="#a56d0957a43c48f3e6431868f564f574f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_key_agreement_domain.html#a75629cd8157dca667c6aff0562ca59af">GenerateKeyPair</a> (<a class="el" href="class_random_number_generator.html">RandomNumberGenerator</a> &rng, byte *privateKey, byte *publicKey) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">generate private/public key pair <a href="#a75629cd8157dca667c6aff0562ca59af"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_key_agreement_domain.html#a732339ca730408cca7b1191fc32eb39e">Agree</a> (byte *agreedValue, const byte *privateKey, const byte *otherPublicKey, bool validateOtherPublicKey=true) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">derive agreed value from your private key and couterparty's public key, return false in case of failure <a href="#a732339ca730408cca7b1191fc32eb39e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab9c52198ff0dd877243c9520d96beaaa"></a><!-- doxytag: member="SimpleKeyAgreementDomain::AccessMaterial" ref="ab9c52198ff0dd877243c9520d96beaaa" args="()" -->
<a class="el" href="class_crypto_material.html">CryptoMaterial</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_key_agreement_algorithm.html#ab9c52198ff0dd877243c9520d96beaaa">AccessMaterial</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns a reference to the crypto material used by this object <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeef052b9f5db7aa72d451c272e578e47"></a><!-- doxytag: member="SimpleKeyAgreementDomain::GetMaterial" ref="aeef052b9f5db7aa72d451c272e578e47" args="() const " -->
const <a class="el" href="class_crypto_material.html">CryptoMaterial</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_key_agreement_algorithm.html#aeef052b9f5db7aa72d451c272e578e47">GetMaterial</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns a const reference to the crypto material used by this object <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abbe709ef84c668901d9e6cf09167d9c9"></a><!-- doxytag: member="SimpleKeyAgreementDomain::AccessCryptoParameters" ref="abbe709ef84c668901d9e6cf09167d9c9" args="()=0" -->
virtual <a class="el" href="class_crypto_parameters.html">CryptoParameters</a> & </td><td class="memItemRight" valign="bottom"><b>AccessCryptoParameters</b> ()=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad3641afd3786b1fbd50a55c3c69a2389"></a><!-- doxytag: member="SimpleKeyAgreementDomain::GetCryptoParameters" ref="ad3641afd3786b1fbd50a55c3c69a2389" args="() const " -->
virtual const <a class="el" href="class_crypto_parameters.html">CryptoParameters</a> & </td><td class="memItemRight" valign="bottom"><b>GetCryptoParameters</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a522dbfcd5c1a46bf1be301cec26d6534"></a><!-- doxytag: member="SimpleKeyAgreementDomain::BERDecode" ref="a522dbfcd5c1a46bf1be301cec26d6534" args="(BufferedTransformation &bt)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_asymmetric_algorithm.html#a522dbfcd5c1a46bf1be301cec26d6534">BERDecode</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &bt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">for backwards compatibility, calls <a class="el" href="class_asymmetric_algorithm.html#ad99d55413166b69a0a12e10d111926c8" title="returns a reference to the crypto material used by this object">AccessMaterial()</a>.Load(bt) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2d704079890783422b0a44653480ab83"></a><!-- doxytag: member="SimpleKeyAgreementDomain::DEREncode" ref="a2d704079890783422b0a44653480ab83" args="(BufferedTransformation &bt) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_asymmetric_algorithm.html#a2d704079890783422b0a44653480ab83">DEREncode</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &bt) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">for backwards compatibility, calls <a class="el" href="class_asymmetric_algorithm.html#adf9cc798c5a2d20ab3436dbad8e6df2d" title="returns a const reference to the crypto material used by this object">GetMaterial()</a>.Save(bt) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acd21c6715add4884fa043eaf51655039"></a><!-- doxytag: member="SimpleKeyAgreementDomain::AlgorithmName" ref="acd21c6715add4884fa043eaf51655039" args="() const " -->
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm.html#acd21c6715add4884fa043eaf51655039">AlgorithmName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns name of this algorithm, not universally implemented yet <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24b43349a71e1f98508eeb10b31a0a62"></a><!-- doxytag: member="SimpleKeyAgreementDomain::Clone" ref="a24b43349a71e1f98508eeb10b31a0a62" args="() const " -->
virtual <a class="el" href="class_clonable.html">Clonable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_clonable.html#a24b43349a71e1f98508eeb10b31a0a62">Clone</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">this is not implemented by most classes yet <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>interface for domains of simple key agreement protocols </p>
<p>A key agreement domain is a set of parameters that must be shared by two parties in a key agreement protocol, along with the algorithms for generating key pairs and deriving agreed values. </p>
<p>Definition at line <a class="el" href="cryptlib_8h_source.html#l01444">1444</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aee7a4929f8a1a77acd04e12fbcd0a0b1"></a><!-- doxytag: member="SimpleKeyAgreementDomain::GeneratePrivateKey" ref="aee7a4929f8a1a77acd04e12fbcd0a0b1" args="(RandomNumberGenerator &rng, byte *privateKey) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SimpleKeyAgreementDomain::GeneratePrivateKey </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_random_number_generator.html">RandomNumberGenerator</a> & </td>
<td class="paramname"> <em>rng</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">byte * </td>
<td class="paramname"> <em>privateKey</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>generate private key </p>
<dl class="pre"><dt><b>Precondition:</b></dt><dd>size of privateKey == <a class="el" href="class_simple_key_agreement_domain.html#a8e2e4c5ab6584e4aef0c6da6b122a668" title="return length of private keys in this domain">PrivateKeyLength()</a> </dd></dl>
<p>Implemented in <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#ad3208753e84fde55582823abdd9922a5">DL_SimpleKeyAgreementDomainBase< T ></a>, <a class="el" href="class_x_t_r___d_h.html#af9546b08d1b46a84675cfded8f1176f2">XTR_DH</a>, and <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#ad3208753e84fde55582823abdd9922a5">DL_SimpleKeyAgreementDomainBase< GROUP_PARAMETERS::Element ></a>.</p>
<p>Referenced by <a class="el" href="cryptlib_8cpp_source.html#l00801">GenerateKeyPair()</a>.</p>
</div>
</div>
<a class="anchor" id="a56d0957a43c48f3e6431868f564f574f"></a><!-- doxytag: member="SimpleKeyAgreementDomain::GeneratePublicKey" ref="a56d0957a43c48f3e6431868f564f574f" args="(RandomNumberGenerator &rng, const byte *privateKey, byte *publicKey) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SimpleKeyAgreementDomain::GeneratePublicKey </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_random_number_generator.html">RandomNumberGenerator</a> & </td>
<td class="paramname"> <em>rng</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const byte * </td>
<td class="paramname"> <em>privateKey</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">byte * </td>
<td class="paramname"> <em>publicKey</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>generate public key </p>
<dl class="pre"><dt><b>Precondition:</b></dt><dd>size of publicKey == <a class="el" href="class_simple_key_agreement_domain.html#a717ec0ad52950f8d792466ad591b5104" title="return length of public keys in this domain">PublicKeyLength()</a> </dd></dl>
<p>Implemented in <a class="el" href="class_d_h___domain.html#ab1fd61cdab38427665d83a4c37e66083">DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION ></a>, <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#a3e1caeee8c363962a1c766e53f95ef95">DL_SimpleKeyAgreementDomainBase< T ></a>, <a class="el" href="class_x_t_r___d_h.html#a9b2d088f034d458abccc7fea30a22412">XTR_DH</a>, and <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#a3e1caeee8c363962a1c766e53f95ef95">DL_SimpleKeyAgreementDomainBase< GROUP_PARAMETERS::Element ></a>.</p>
<p>Referenced by <a class="el" href="cryptlib_8cpp_source.html#l00801">GenerateKeyPair()</a>.</p>
</div>
</div>
<a class="anchor" id="a75629cd8157dca667c6aff0562ca59af"></a><!-- doxytag: member="SimpleKeyAgreementDomain::GenerateKeyPair" ref="a75629cd8157dca667c6aff0562ca59af" args="(RandomNumberGenerator &rng, byte *privateKey, byte *publicKey) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SimpleKeyAgreementDomain::GenerateKeyPair </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_random_number_generator.html">RandomNumberGenerator</a> & </td>
<td class="paramname"> <em>rng</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">byte * </td>
<td class="paramname"> <em>privateKey</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">byte * </td>
<td class="paramname"> <em>publicKey</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>generate private/public key pair </p>
<dl class="note"><dt><b>Note:</b></dt><dd>equivalent to calling <a class="el" href="class_simple_key_agreement_domain.html#aee7a4929f8a1a77acd04e12fbcd0a0b1" title="generate private key">GeneratePrivateKey()</a> and then <a class="el" href="class_simple_key_agreement_domain.html#a56d0957a43c48f3e6431868f564f574f" title="generate public key">GeneratePublicKey()</a> </dd></dl>
<p>Definition at line <a class="el" href="cryptlib_8cpp_source.html#l00801">801</a> of file <a class="el" href="cryptlib_8cpp_source.html">cryptlib.cpp</a>.</p>
<p>References <a class="el" href="class_simple_key_agreement_domain.html#aee7a4929f8a1a77acd04e12fbcd0a0b1">GeneratePrivateKey()</a>, and <a class="el" href="class_simple_key_agreement_domain.html#a56d0957a43c48f3e6431868f564f574f">GeneratePublicKey()</a>.</p>
</div>
</div>
<a class="anchor" id="a732339ca730408cca7b1191fc32eb39e"></a><!-- doxytag: member="SimpleKeyAgreementDomain::Agree" ref="a732339ca730408cca7b1191fc32eb39e" args="(byte *agreedValue, const byte *privateKey, const byte *otherPublicKey, bool validateOtherPublicKey=true) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool SimpleKeyAgreementDomain::Agree </td>
<td>(</td>
<td class="paramtype">byte * </td>
<td class="paramname"> <em>agreedValue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const byte * </td>
<td class="paramname"> <em>privateKey</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const byte * </td>
<td class="paramname"> <em>otherPublicKey</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>validateOtherPublicKey</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>derive agreed value from your private key and couterparty's public key, return false in case of failure </p>
<dl class="note"><dt><b>Note:</b></dt><dd>If you have previously validated the public key, use validateOtherPublicKey=false to save time. </dd></dl>
<dl class="pre"><dt><b>Precondition:</b></dt><dd>size of agreedValue == <a class="el" href="class_simple_key_agreement_domain.html#aedb873e4aa6fc15ac5245b7af04e4946" title="return length of agreed value produced">AgreedValueLength()</a> </dd>
<dd>
length of privateKey == <a class="el" href="class_simple_key_agreement_domain.html#a8e2e4c5ab6584e4aef0c6da6b122a668" title="return length of private keys in this domain">PrivateKeyLength()</a> </dd>
<dd>
length of otherPublicKey == <a class="el" href="class_simple_key_agreement_domain.html#a717ec0ad52950f8d792466ad591b5104" title="return length of public keys in this domain">PublicKeyLength()</a> </dd></dl>
<p>Implemented in <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#aa27177cea8a872273736e593d1327157">DL_SimpleKeyAgreementDomainBase< T ></a>, <a class="el" href="class_x_t_r___d_h.html#a6947d070cbdba7b811cc79a33a3c6632">XTR_DH</a>, and <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#aa27177cea8a872273736e593d1327157">DL_SimpleKeyAgreementDomainBase< GROUP_PARAMETERS::Element ></a>.</p>
<p>Referenced by <a class="el" href="dh2_8cpp_source.html#l00013">DH2::Agree()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="cryptlib_8h_source.html">cryptlib.h</a></li>
<li><a class="el" href="cryptlib_8cpp_source.html">cryptlib.cpp</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 9 Dec 2009 for Crypto++ by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
13
>
i386
>
media
>
os
>
by-pkgid
>
07dfcfe50d66c9a48a3c5e6c1693f12a
>
files
>
1360
