📄 class_simple_key_agreement_domain.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"><title>Crypto++: SimpleKeyAgreementDomain Class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"><link href="tabs.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.5.2 --><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="classes.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="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</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><h1>SimpleKeyAgreementDomain Class Reference</h1><!-- doxytag: class="SimpleKeyAgreementDomain" --><!-- doxytag: inherits="KeyAgreementAlgorithm" --><code>#include <<a class="el" href="cryptlib_8h-source.html">cryptlib.h</a>></code><p><p>Inheritance diagram for SimpleKeyAgreementDomain:<p><center><img src="class_simple_key_agreement_domain.png" usemap="#SimpleKeyAgreementDomain_map" border="0" alt=""></center><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><a href="class_simple_key_agreement_domain-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>interface for domains of simple key agreement protocols <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#l01384">1384</a> of file <a class="el" href="cryptlib_8h-source.html">cryptlib.h</a>.<table border="0" cellpadding="0" cellspacing="0"><tr><td></td></tr><tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fbf257cf0f75e66070e2636939e9c2ca"></a><!-- doxytag: member="SimpleKeyAgreementDomain::AgreedValueLength" ref="fbf257cf0f75e66070e2636939e9c2ca" args="() const=0" -->virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_key_agreement_domain.html#fbf257cf0f75e66070e2636939e9c2ca">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" nowrap align="right" valign="top"><a class="anchor" name="131fa4e8260ec044fc12a540e8470325"></a><!-- doxytag: member="SimpleKeyAgreementDomain::PrivateKeyLength" ref="131fa4e8260ec044fc12a540e8470325" args="() const=0" -->virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_key_agreement_domain.html#131fa4e8260ec044fc12a540e8470325">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" nowrap align="right" valign="top"><a class="anchor" name="0a96f98bb61ae0777604e035e7984bd1"></a><!-- doxytag: member="SimpleKeyAgreementDomain::PublicKeyLength" ref="0a96f98bb61ae0777604e035e7984bd1" args="() const=0" -->virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_key_agreement_domain.html#0a96f98bb61ae0777604e035e7984bd1">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" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_key_agreement_domain.html#ee7a4929f8a1a77acd04e12fbcd0a0b1">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="#ee7a4929f8a1a77acd04e12fbcd0a0b1"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_key_agreement_domain.html#56d0957a43c48f3e6431868f564f574f">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="#56d0957a43c48f3e6431868f564f574f"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_key_agreement_domain.html#75629cd8157dca667c6aff0562ca59af">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="#75629cd8157dca667c6aff0562ca59af"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_key_agreement_domain.html#732339ca730408cca7b1191fc32eb39e">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="#732339ca730408cca7b1191fc32eb39e"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b9c52198ff0dd877243c9520d96beaaa"></a><!-- doxytag: member="SimpleKeyAgreementDomain::AccessMaterial" ref="b9c52198ff0dd877243c9520d96beaaa" 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#b9c52198ff0dd877243c9520d96beaaa">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" nowrap align="right" valign="top"><a class="anchor" name="3a1eb8e141b2f26a21efed7a1d7744c9"></a><!-- doxytag: member="SimpleKeyAgreementDomain::GetMaterial" ref="3a1eb8e141b2f26a21efed7a1d7744c9" 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#3a1eb8e141b2f26a21efed7a1d7744c9">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" nowrap align="right" valign="top"><a class="anchor" name="bbe709ef84c668901d9e6cf09167d9c9"></a><!-- doxytag: member="SimpleKeyAgreementDomain::AccessCryptoParameters" ref="bbe709ef84c668901d9e6cf09167d9c9" 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" nowrap align="right" valign="top"><a class="anchor" name="5b0e622b88d0b8d319c23e4aefef414d"></a><!-- doxytag: member="SimpleKeyAgreementDomain::GetCryptoParameters" ref="5b0e622b88d0b8d319c23e4aefef414d" args="() const" -->virtual const <a class="el" href="class_crypto_parameters.html">CryptoParameters</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_key_agreement_algorithm.html#5b0e622b88d0b8d319c23e4aefef414d">GetCryptoParameters</a> () const</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="522dbfcd5c1a46bf1be301cec26d6534"></a><!-- doxytag: member="SimpleKeyAgreementDomain::BERDecode" ref="522dbfcd5c1a46bf1be301cec26d6534" args="(BufferedTransformation &bt)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_asymmetric_algorithm.html#522dbfcd5c1a46bf1be301cec26d6534">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#d99d55413166b69a0a12e10d111926c8" title="returns a reference to the crypto material used by this object">AccessMaterial()</a>.Load(bt) <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2d704079890783422b0a44653480ab83"></a><!-- doxytag: member="SimpleKeyAgreementDomain::DEREncode" ref="2d704079890783422b0a44653480ab83" args="(BufferedTransformation &bt) const " -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_asymmetric_algorithm.html#2d704079890783422b0a44653480ab83">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#eafe2b12d8353b6c639be41b57ef25de" title="returns a const reference to the crypto material used by this object">GetMaterial()</a>.Save(bt) <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f31510a192d1121856efe8ad0a9b844"></a><!-- doxytag: member="SimpleKeyAgreementDomain::AlgorithmName" ref="4f31510a192d1121856efe8ad0a9b844" args="() const" -->virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm.html#4f31510a192d1121856efe8ad0a9b844">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" nowrap align="right" valign="top"><a class="anchor" name="d0016ba2d505c23aa85aad49e6c19bb7"></a><!-- doxytag: member="SimpleKeyAgreementDomain::Clone" ref="d0016ba2d505c23aa85aad49e6c19bb7" 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#d0016ba2d505c23aa85aad49e6c19bb7">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><h2>Member Function Documentation</h2><a class="anchor" name="ee7a4929f8a1a77acd04e12fbcd0a0b1"></a><!-- doxytag: member="SimpleKeyAgreementDomain::GeneratePrivateKey" ref="ee7a4929f8a1a77acd04e12fbcd0a0b1" 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 width="100%"> const<code> [pure virtual]</code></td> </tr> </table></div><div class="memdoc"><p>generate private key <p><dl class="pre" compact><dt><b>Precondition:</b></dt><dd>size of privateKey == <a class="el" href="class_simple_key_agreement_domain.html#131fa4e8260ec044fc12a540e8470325" 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#d3208753e84fde55582823abdd9922a5">DL_SimpleKeyAgreementDomainBase< T ></a>, <a class="el" href="class_x_t_r___d_h.html#f9546b08d1b46a84675cfded8f1176f2">XTR_DH</a>, and <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#d3208753e84fde55582823abdd9922a5">DL_SimpleKeyAgreementDomainBase< GROUP_PARAMETERS::Element ></a>.<p>Referenced by <a class="el" href="cryptlib_8cpp-source.html#l00701">GenerateKeyPair()</a>.</div></div><p><a class="anchor" name="56d0957a43c48f3e6431868f564f574f"></a><!-- doxytag: member="SimpleKeyAgreementDomain::GeneratePublicKey" ref="56d0957a43c48f3e6431868f564f574f" args="(RandomNumberGenerator &rng, const byte *privateKey, byte *publicKey) const =0" --><div class="memitem">⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -