📄 class_x_t_r___d_h.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++: XTR_DH 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>XTR_DH Class Reference</h1><!-- doxytag: class="XTR_DH" --><!-- doxytag: inherits="SimpleKeyAgreementDomain,CryptoParameters" --><code>#include <<a class="el" href="xtrcrypt_8h-source.html">xtrcrypt.h</a>></code><p><p>Inheritance diagram for XTR_DH:<p><center><img src="class_x_t_r___d_h.png" usemap="#XTR_DH_map" border="0" alt=""></center><map name="XTR_DH_map"><area href="class_simple_key_agreement_domain.html" alt="SimpleKeyAgreementDomain" shape="rect" coords="0,224,174,248"><area href="class_crypto_parameters.html" alt="CryptoParameters" shape="rect" coords="184,224,358,248"><area href="class_key_agreement_algorithm.html" alt="KeyAgreementAlgorithm" shape="rect" coords="0,168,174,192"><area href="class_generatable_crypto_material.html" alt="GeneratableCryptoMaterial" shape="rect" coords="184,168,358,192"><area href="class_asymmetric_algorithm.html" alt="AsymmetricAlgorithm" shape="rect" coords="0,112,174,136"><area href="class_crypto_material.html" alt="CryptoMaterial" shape="rect" coords="184,112,358,136"><area href="class_algorithm.html" alt="Algorithm" shape="rect" coords="0,56,174,80"><area href="class_name_value_pairs.html" alt="NameValuePairs" shape="rect" coords="184,56,358,80"><area href="class_clonable.html" alt="Clonable" shape="rect" coords="0,0,174,24"></map><a href="class_x_t_r___d_h-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>XTR-DH with key validation. <p><p>Definition at line <a class="el" href="xtrcrypt_8h-source.html#l00014">14</a> of file <a class="el" href="xtrcrypt_8h-source.html">xtrcrypt.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="c569da5583dcd3fc1f10795cfda8c123"></a><!-- doxytag: member="XTR_DH::XTR_DH" ref="c569da5583dcd3fc1f10795cfda8c123" args="(const Integer &p, const Integer &q, const GFP2Element &g)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_t_r___d_h.html#c569da5583dcd3fc1f10795cfda8c123">XTR_DH</a> (const <a class="el" href="class_integer.html">Integer</a> &p, const <a class="el" href="class_integer.html">Integer</a> &q, const <a class="el" href="class_g_f_p2_element.html">GFP2Element</a> &g)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="867f652dfc05dde7b6a1866a777e990b"></a><!-- doxytag: member="XTR_DH::XTR_DH" ref="867f652dfc05dde7b6a1866a777e990b" args="(RandomNumberGenerator &rng, unsigned int pbits, unsigned int qbits)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_t_r___d_h.html#867f652dfc05dde7b6a1866a777e990b">XTR_DH</a> (<a class="el" href="class_random_number_generator.html">RandomNumberGenerator</a> &rng, unsigned int pbits, unsigned int qbits)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b55db82b3af6c9b3e1263a757ba01a30"></a><!-- doxytag: member="XTR_DH::XTR_DH" ref="b55db82b3af6c9b3e1263a757ba01a30" args="(BufferedTransformation &domainParams)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_t_r___d_h.html#b55db82b3af6c9b3e1263a757ba01a30">XTR_DH</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &domainParams)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9690ce0b86739e06adeb8de130fede01"></a><!-- doxytag: member="XTR_DH::DEREncode" ref="9690ce0b86739e06adeb8de130fede01" args="(BufferedTransformation &domainParams) const " -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_t_r___d_h.html#9690ce0b86739e06adeb8de130fede01">DEREncode</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &domainParams) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">for backwards compatibility, calls <a class="el" href="class_key_agreement_algorithm.html#3a1eb8e141b2f26a21efed7a1d7744c9" 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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_t_r___d_h.html#27c92e572df6e8c1cf73a88d72e8dba5">Validate</a> (<a class="el" href="class_random_number_generator.html">RandomNumberGenerator</a> &rng, unsigned int level) const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">check this object for errors <a href="#27c92e572df6e8c1cf73a88d72e8dba5"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a27f618e7ee5c615d5288db47f254b1c"></a><!-- doxytag: member="XTR_DH::GetVoidValue" ref="a27f618e7ee5c615d5288db47f254b1c" args="(const char *name, const std::type_info &valueType, void *pValue) const " -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_t_r___d_h.html#a27f618e7ee5c615d5288db47f254b1c">GetVoidValue</a> (const char *name, const std::type_info &valueType, void *pValue) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">to be implemented by derived classes, users should use one of the above functions instead <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_t_r___d_h.html#f2456cb49f5b36edaaef3c0cae25a775">AssignFrom</a> (const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> &source)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">assign values from source to this object <a href="#f2456cb49f5b36edaaef3c0cae25a775"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c8961d7753053e451e951ad8ba808582"></a><!-- doxytag: member="XTR_DH::AccessCryptoParameters" ref="c8961d7753053e451e951ad8ba808582" args="()" --><a class="el" href="class_crypto_parameters.html">CryptoParameters</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_t_r___d_h.html#c8961d7753053e451e951ad8ba808582">AccessCryptoParameters</a> ()</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68d30b38dde37f451a539d0d1907408d"></a><!-- doxytag: member="XTR_DH::AgreedValueLength" ref="68d30b38dde37f451a539d0d1907408d" args="() const" -->unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_t_r___d_h.html#68d30b38dde37f451a539d0d1907408d">AgreedValueLength</a> () const</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="e3f6c87695d27b57f218daa0a7a19a6b"></a><!-- doxytag: member="XTR_DH::PrivateKeyLength" ref="e3f6c87695d27b57f218daa0a7a19a6b" args="() const" -->unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_t_r___d_h.html#e3f6c87695d27b57f218daa0a7a19a6b">PrivateKeyLength</a> () const</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="d8086f9959a856e7c1279b18af566b6c"></a><!-- doxytag: member="XTR_DH::PublicKeyLength" ref="d8086f9959a856e7c1279b18af566b6c" args="() const" -->unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_t_r___d_h.html#d8086f9959a856e7c1279b18af566b6c">PublicKeyLength</a> () const</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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_t_r___d_h.html#f9546b08d1b46a84675cfded8f1176f2">GeneratePrivateKey</a> (<a class="el" href="class_random_number_generator.html">RandomNumberGenerator</a> &rng, byte *privateKey) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">generate private key <a href="#f9546b08d1b46a84675cfded8f1176f2"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_t_r___d_h.html#9b2d088f034d458abccc7fea30a22412">GeneratePublicKey</a> (<a class="el" href="class_random_number_generator.html">RandomNumberGenerator</a> &rng, const byte *privateKey, byte *publicKey) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">generate public key <a href="#9b2d088f034d458abccc7fea30a22412"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_t_r___d_h.html#6947d070cbdba7b811cc79a33a3c6632">Agree</a> (byte *agreedValue, const byte *privateKey, const byte *otherPublicKey, bool validateOtherPublicKey=true) const </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="#6947d070cbdba7b811cc79a33a3c6632"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d7ae6a2f100dd44708abf51e12ad9d9a"></a><!-- doxytag: member="XTR_DH::GetModulus" ref="d7ae6a2f100dd44708abf51e12ad9d9a" args="() const" -->const <a class="el" href="class_integer.html">Integer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_t_r___d_h.html#d7ae6a2f100dd44708abf51e12ad9d9a">GetModulus</a> () const</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="54ad5c5da5e6e8f50294a25f1622e4bd"></a><!-- doxytag: member="XTR_DH::GetSubgroupOrder" ref="54ad5c5da5e6e8f50294a25f1622e4bd" args="() const" -->const <a class="el" href="class_integer.html">Integer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_t_r___d_h.html#54ad5c5da5e6e8f50294a25f1622e4bd">GetSubgroupOrder</a> () const</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="10bb4bfec12520d0874287173cc9e0fe"></a><!-- doxytag: member="XTR_DH::GetSubgroupGenerator" ref="10bb4bfec12520d0874287173cc9e0fe" args="() const" -->const <a class="el" href="class_g_f_p2_element.html">GFP2Element</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_t_r___d_h.html#10bb4bfec12520d0874287173cc9e0fe">GetSubgroupGenerator</a> () const</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="de9c4eff843a1c2fd08e82b3a2a1fc43"></a><!-- doxytag: member="XTR_DH::SetModulus" ref="de9c4eff843a1c2fd08e82b3a2a1fc43" args="(const Integer &p)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_t_r___d_h.html#de9c4eff843a1c2fd08e82b3a2a1fc43">SetModulus</a> (const <a class="el" href="class_integer.html">Integer</a> &p)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="74093256e7be4e3f10d512b2edbfdbbd"></a><!-- doxytag: member="XTR_DH::SetSubgroupOrder" ref="74093256e7be4e3f10d512b2edbfdbbd" args="(const Integer &q)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_t_r___d_h.html#74093256e7be4e3f10d512b2edbfdbbd">SetSubgroupOrder</a> (const <a class="el" href="class_integer.html">Integer</a> &q)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f009d4699f4c7c427c799c5967eae47d"></a><!-- doxytag: member="XTR_DH::SetSubgroupGenerator" ref="f009d4699f4c7c427c799c5967eae47d" args="(const GFP2Element &g)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_t_r___d_h.html#f009d4699f4c7c427c799c5967eae47d">SetSubgroupGenerator</a> (const <a class="el" href="class_g_f_p2_element.html">GFP2Element</a> &g)</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"><a class="anchor" name="b9c52198ff0dd877243c9520d96beaaa"></a><!-- doxytag: member="XTR_DH::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="XTR_DH::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="5b0e622b88d0b8d319c23e4aefef414d"></a><!-- doxytag: member="XTR_DH::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="XTR_DH::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="4f31510a192d1121856efe8ad0a9b844"></a><!-- doxytag: member="XTR_DH::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="XTR_DH::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><tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_generatable_crypto_material.html#be368b52db1ca7079b690f2d6e605f7a">GenerateRandom</a> (<a class="el" href="class_random_number_generator.html">RandomNumberGenerator</a> &rng, const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> &params=<a class="el" href="cryptlib_8h.html#d3205973dd1afa14090a683154c1109c">g_nullNameValuePairs</a>)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">generate a random key or crypto parameters <a href="#be368b52db1ca7079b690f2d6e605f7a"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="38d492343c32e530a5c2781b5797f755"></a><!-- doxytag: member="XTR_DH::GenerateRandomWithKeySize" ref="38d492343c32e530a5c2781b5797f755" args="(RandomNumberGenerator &rng, unsigned int keySize)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_generatable_crypto_material.html#38d492343c32e530a5c2781b5797f755">GenerateRandomWithKeySize</a> (<a class="el" href="class_random_number_generator.html">RandomNumberGenerator</a> &rng, unsigned int keySize)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">calls the above function with a <a class="el" href="class_name_value_pairs.html" title="interface for retrieving values given their names">NameValuePairs</a> object that just specifies "KeySize" <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="edb65ba5323f7bb41fc57973566d20cd"></a><!-- doxytag: member="XTR_DH::ThrowIfInvalid" ref="edb65ba5323f7bb41fc57973566d20cd" args="(RandomNumberGenerator &rng, unsigned int level) const" -->virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_crypto_material.html#edb65ba5323f7bb41fc57973566d20cd">ThrowIfInvalid</a> (<a class="el" href="class_random_number_generator.html">RandomNumberGenerator</a> &rng, unsigned int level) const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">throws <a class="el" href="class_crypto_material_1_1_invalid_material.html" title="exception thrown when invalid crypto material is detected">InvalidMaterial</a> if this object fails <a class="el" href="class_crypto_material.html#439743c6b4e89ca8228a12fa1ea43ab1" title="check this object for errors">Validate()</a> test <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="690c7ce3e765a502b29b47a08c1a4e7b"></a><!-- doxytag: member="XTR_DH::Save" ref="690c7ce3e765a502b29b47a08c1a4e7b" args="(BufferedTransformation &bt) const " -->virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_crypto_material.html#690c7ce3e765a502b29b47a08c1a4e7b">Save</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &bt) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">save key into a <a class="el" href="class_buffered_transformation.html" title="interface for buffered transformations">BufferedTransformation</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_crypto_material.html#e7a94de4c3d3822070db5babbdf8b113">Load</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &bt)</td></tr>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -