<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crypto++: SimpleKeyAgreementDomain Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Crypto++
 <span id="projectnumber">7.0</span>
</div>
<div id="projectbrief">Free C++ class library of cryptographic schemes</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="class_simple_key_agreement_domain-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SimpleKeyAgreementDomain Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Interface for domains of simple key agreement protocols.
<a href="class_simple_key_agreement_domain.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for SimpleKeyAgreementDomain:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="class_simple_key_agreement_domain.png" usemap="#SimpleKeyAgreementDomain_map" alt=""/>
<map id="SimpleKeyAgreementDomain_map" name="SimpleKeyAgreementDomain_map">
<area href="class_key_agreement_algorithm.html" title="Interface for key agreement algorithms. " alt="KeyAgreementAlgorithm" shape="rect" coords="859,168,1422,192"/>
<area href="class_asymmetric_algorithm.html" title="Interface for asymmetric algorithms. " alt="AsymmetricAlgorithm" shape="rect" coords="859,112,1422,136"/>
<area href="class_algorithm.html" title="Interface for all crypto algorithms. " alt="Algorithm" shape="rect" coords="859,56,1422,80"/>
<area href="class_clonable.html" title="Interface for cloning objects. " alt="Clonable" shape="rect" coords="859,0,1422,24"/>
<area href="class_d_l___simple_key_agreement_domain_base.html" title="Discrete Log (DL) simple key agreement base implementation. " alt="DL_SimpleKeyAgreementDomainBase< T >" shape="rect" coords="0,280,563,304"/>
<area href="class_d_l___simple_key_agreement_domain_base.html" alt="DL_SimpleKeyAgreementDomainBase< DL_GroupParameters_GFP_DefaultSafePrime ::Element >" shape="rect" coords="573,280,1136,304"/>
<area href="class_d_l___simple_key_agreement_domain_base.html" alt="DL_SimpleKeyAgreementDomainBase< GROUP_PARAMETERS::Element >" shape="rect" coords="1146,280,1709,304"/>
<area href="class_x_t_r___d_h.html" title="XTR-DH with key validation. " alt="XTR_DH" shape="rect" coords="1719,280,2282,304"/>
<area href="class_d_h___domain.html" alt="DH_Domain< DL_GroupParameters_GFP_DefaultSafePrime >" shape="rect" coords="573,336,1136,360"/>
<area href="class_d_h___domain.html" title="Diffie-Hellman domain. " alt="DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >" shape="rect" coords="1146,336,1709,360"/>
<area href="struct_d_h.html" title="Diffie-Hellman in GF(p) " alt="DH" shape="rect" coords="573,392,1136,416"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aedb873e4aa6fc15ac5245b7af04e4946"><td class="memItemLeft" align="right" valign="top">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 class="memdesc:aedb873e4aa6fc15ac5245b7af04e4946"><td class="mdescLeft"> </td><td class="mdescRight">Provides the size of the agreed value. <a href="#aedb873e4aa6fc15ac5245b7af04e4946">More...</a><br /></td></tr>
<tr class="separator:aedb873e4aa6fc15ac5245b7af04e4946"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8e2e4c5ab6584e4aef0c6da6b122a668"><td class="memItemLeft" align="right" valign="top">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 class="memdesc:a8e2e4c5ab6584e4aef0c6da6b122a668"><td class="mdescLeft"> </td><td class="mdescRight">Provides the size of the private key. <a href="#a8e2e4c5ab6584e4aef0c6da6b122a668">More...</a><br /></td></tr>
<tr class="separator:a8e2e4c5ab6584e4aef0c6da6b122a668"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a717ec0ad52950f8d792466ad591b5104"><td class="memItemLeft" align="right" valign="top">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 class="memdesc:a717ec0ad52950f8d792466ad591b5104"><td class="mdescLeft"> </td><td class="mdescRight">Provides the size of the public key. <a href="#a717ec0ad52950f8d792466ad591b5104">More...</a><br /></td></tr>
<tr class="separator:a717ec0ad52950f8d792466ad591b5104"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee7a4929f8a1a77acd04e12fbcd0a0b1"><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 class="memdesc:aee7a4929f8a1a77acd04e12fbcd0a0b1"><td class="mdescLeft"> </td><td class="mdescRight">Generate private key in this domain. <a href="#aee7a4929f8a1a77acd04e12fbcd0a0b1">More...</a><br /></td></tr>
<tr class="separator:aee7a4929f8a1a77acd04e12fbcd0a0b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a56d0957a43c48f3e6431868f564f574f"><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 class="memdesc:a56d0957a43c48f3e6431868f564f574f"><td class="mdescLeft"> </td><td class="mdescRight">Generate a public key from a private key in this domain. <a href="#a56d0957a43c48f3e6431868f564f574f">More...</a><br /></td></tr>
<tr class="separator:a56d0957a43c48f3e6431868f564f574f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a301bbc5a9feac1c6b9b337a0ddfc8ecf"><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#a301bbc5a9feac1c6b9b337a0ddfc8ecf">GenerateKeyPair</a> (<a class="el" href="class_random_number_generator.html">RandomNumberGenerator</a> &rng, byte *privateKey, byte *publicKey) const</td></tr>
<tr class="memdesc:a301bbc5a9feac1c6b9b337a0ddfc8ecf"><td class="mdescLeft"> </td><td class="mdescRight">Generate a private/public key pair. <a href="#a301bbc5a9feac1c6b9b337a0ddfc8ecf">More...</a><br /></td></tr>
<tr class="separator:a301bbc5a9feac1c6b9b337a0ddfc8ecf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a732339ca730408cca7b1191fc32eb39e"><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 class="memdesc:a732339ca730408cca7b1191fc32eb39e"><td class="mdescLeft"> </td><td class="mdescRight">Derive agreed value. <a href="#a732339ca730408cca7b1191fc32eb39e">More...</a><br /></td></tr>
<tr class="separator:a732339ca730408cca7b1191fc32eb39e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_key_agreement_algorithm"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_key_agreement_algorithm')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_key_agreement_algorithm.html">KeyAgreementAlgorithm</a></td></tr>
<tr class="memitem:ab9c52198ff0dd877243c9520d96beaaa inherit pub_methods_class_key_agreement_algorithm"><td class="memItemLeft" align="right" valign="top"><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 class="memdesc:ab9c52198ff0dd877243c9520d96beaaa inherit pub_methods_class_key_agreement_algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a reference to Crypto Parameters. <a href="class_key_agreement_algorithm.html#ab9c52198ff0dd877243c9520d96beaaa">More...</a><br /></td></tr>
<tr class="separator:ab9c52198ff0dd877243c9520d96beaaa inherit pub_methods_class_key_agreement_algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a1eb8e141b2f26a21efed7a1d7744c9 inherit pub_methods_class_key_agreement_algorithm"><td class="memItemLeft" align="right" valign="top">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#a3a1eb8e141b2f26a21efed7a1d7744c9">GetMaterial</a> () const</td></tr>
<tr class="memdesc:a3a1eb8e141b2f26a21efed7a1d7744c9 inherit pub_methods_class_key_agreement_algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a reference to Crypto Parameters. <a href="class_key_agreement_algorithm.html#a3a1eb8e141b2f26a21efed7a1d7744c9">More...</a><br /></td></tr>
<tr class="separator:a3a1eb8e141b2f26a21efed7a1d7744c9 inherit pub_methods_class_key_agreement_algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abbe709ef84c668901d9e6cf09167d9c9 inherit pub_methods_class_key_agreement_algorithm"><td class="memItemLeft" align="right" valign="top">virtual <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#abbe709ef84c668901d9e6cf09167d9c9">AccessCryptoParameters</a> ()=0</td></tr>
<tr class="memdesc:abbe709ef84c668901d9e6cf09167d9c9 inherit pub_methods_class_key_agreement_algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a reference to Crypto Parameters. <a href="class_key_agreement_algorithm.html#abbe709ef84c668901d9e6cf09167d9c9">More...</a><br /></td></tr>
<tr class="separator:abbe709ef84c668901d9e6cf09167d9c9 inherit pub_methods_class_key_agreement_algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b0e622b88d0b8d319c23e4aefef414d inherit pub_methods_class_key_agreement_algorithm"><td class="memItemLeft" align="right" valign="top">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#a5b0e622b88d0b8d319c23e4aefef414d">GetCryptoParameters</a> () const</td></tr>
<tr class="memdesc:a5b0e622b88d0b8d319c23e4aefef414d inherit pub_methods_class_key_agreement_algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a reference to Crypto Parameters. <a href="class_key_agreement_algorithm.html#a5b0e622b88d0b8d319c23e4aefef414d">More...</a><br /></td></tr>
<tr class="separator:a5b0e622b88d0b8d319c23e4aefef414d inherit pub_methods_class_key_agreement_algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_algorithm"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_algorithm')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_algorithm.html">Algorithm</a></td></tr>
<tr class="memitem:a1c77f5117ca2cd881baf26a364cfc606 inherit pub_methods_class_algorithm"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm.html#a1c77f5117ca2cd881baf26a364cfc606">Algorithm</a> (bool checkSelfTestStatus=true)</td></tr>
<tr class="memdesc:a1c77f5117ca2cd881baf26a364cfc606 inherit pub_methods_class_algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Interface for all crypto algorithms. <a href="class_algorithm.html#a1c77f5117ca2cd881baf26a364cfc606">More...</a><br /></td></tr>
<tr class="separator:a1c77f5117ca2cd881baf26a364cfc606 inherit pub_methods_class_algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f31510a192d1121856efe8ad0a9b844 inherit pub_methods_class_algorithm"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm.html#a4f31510a192d1121856efe8ad0a9b844">AlgorithmName</a> () const</td></tr>
<tr class="memdesc:a4f31510a192d1121856efe8ad0a9b844 inherit pub_methods_class_algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Provides the name of this algorithm. <a href="class_algorithm.html#a4f31510a192d1121856efe8ad0a9b844">More...</a><br /></td></tr>
<tr class="separator:a4f31510a192d1121856efe8ad0a9b844 inherit pub_methods_class_algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_clonable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_clonable')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_clonable.html">Clonable</a></td></tr>
<tr class="memitem:ad0016ba2d505c23aa85aad49e6c19bb7 inherit pub_methods_class_clonable"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_clonable.html">Clonable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_clonable.html#ad0016ba2d505c23aa85aad49e6c19bb7">Clone</a> () const</td></tr>
<tr class="memdesc:ad0016ba2d505c23aa85aad49e6c19bb7 inherit pub_methods_class_clonable"><td class="mdescLeft"> </td><td class="mdescRight">Copies this object. <a href="class_clonable.html#ad0016ba2d505c23aa85aad49e6c19bb7">More...</a><br /></td></tr>
<tr class="separator:ad0016ba2d505c23aa85aad49e6c19bb7 inherit pub_methods_class_clonable"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><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><dl class="section since"><dt>Since</dt><dd>Crypto++ 3.0 </dd></dl>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l02841">2841</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aedb873e4aa6fc15ac5245b7af04e4946"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aedb873e4aa6fc15ac5245b7af04e4946">◆ </a></span>AgreedValueLength()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual unsigned int SimpleKeyAgreementDomain::AgreedValueLength </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides the size of the agreed value. </p>
<dl class="section return"><dt>Returns</dt><dd>size of agreed value produced in this domain </dd></dl>
<p>Implemented in <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#a020c2e9cd50a2036b48ef1efac415f88">DL_SimpleKeyAgreementDomainBase< T ></a>, <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#a020c2e9cd50a2036b48ef1efac415f88">DL_SimpleKeyAgreementDomainBase< DL_GroupParameters_GFP_DefaultSafePrime ::Element ></a>, <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#a020c2e9cd50a2036b48ef1efac415f88">DL_SimpleKeyAgreementDomainBase< GROUP_PARAMETERS::Element ></a>, and <a class="el" href="class_x_t_r___d_h.html#a68d30b38dde37f451a539d0d1907408d">XTR_DH</a>.</p>
</div>
</div>
<a id="a8e2e4c5ab6584e4aef0c6da6b122a668"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e2e4c5ab6584e4aef0c6da6b122a668">◆ </a></span>PrivateKeyLength()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual unsigned int SimpleKeyAgreementDomain::PrivateKeyLength </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides the size of the private key. </p>
<dl class="section return"><dt>Returns</dt><dd>size of private keys in this domain </dd></dl>
<p>Implemented in <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#aef6976621e78f8a0651e24483484d8ed">DL_SimpleKeyAgreementDomainBase< T ></a>, <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#aef6976621e78f8a0651e24483484d8ed">DL_SimpleKeyAgreementDomainBase< DL_GroupParameters_GFP_DefaultSafePrime ::Element ></a>, <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#aef6976621e78f8a0651e24483484d8ed">DL_SimpleKeyAgreementDomainBase< GROUP_PARAMETERS::Element ></a>, and <a class="el" href="class_x_t_r___d_h.html#ae3f6c87695d27b57f218daa0a7a19a6b">XTR_DH</a>.</p>
</div>
</div>
<a id="a717ec0ad52950f8d792466ad591b5104"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a717ec0ad52950f8d792466ad591b5104">◆ </a></span>PublicKeyLength()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual unsigned int SimpleKeyAgreementDomain::PublicKeyLength </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides the size of the public key. </p>
<dl class="section return"><dt>Returns</dt><dd>size of public keys in this domain </dd></dl>
<p>Implemented in <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#af3f9f7c38f24fbe78b635b59936e6068">DL_SimpleKeyAgreementDomainBase< T ></a>, <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#af3f9f7c38f24fbe78b635b59936e6068">DL_SimpleKeyAgreementDomainBase< DL_GroupParameters_GFP_DefaultSafePrime ::Element ></a>, <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#af3f9f7c38f24fbe78b635b59936e6068">DL_SimpleKeyAgreementDomainBase< GROUP_PARAMETERS::Element ></a>, and <a class="el" href="class_x_t_r___d_h.html#ad8086f9959a856e7c1279b18af566b6c">XTR_DH</a>.</p>
</div>
</div>
<a id="aee7a4929f8a1a77acd04e12fbcd0a0b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee7a4929f8a1a77acd04e12fbcd0a0b1">◆ </a></span>GeneratePrivateKey()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate private key in this domain. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rng</td><td>a <a class="el" href="class_random_number_generator.html" title="Interface for random number generators. ">RandomNumberGenerator</a> derived class </td></tr>
<tr><td class="paramname">privateKey</td><td>a byte buffer for the generated private key in this domain </td></tr>
</table>
</dd>
</dl>
<dl class="section pre"><dt>Precondition</dt><dd><code><a class="el" href="misc_8h.html#a2d7e4464ea73d6393ebe78f952253426" title="Counts elements in an array. ">COUNTOF(privateKey)</a> == <a class="el" href="class_simple_key_agreement_domain.html#a8e2e4c5ab6584e4aef0c6da6b122a668" title="Provides the size of the private key. ">PrivateKeyLength()</a></code> </dd></dl>
<p>Implemented in <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#aae265ac6aa9f941678aaa5415da34d43">DL_SimpleKeyAgreementDomainBase< T ></a>, <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#aae265ac6aa9f941678aaa5415da34d43">DL_SimpleKeyAgreementDomainBase< DL_GroupParameters_GFP_DefaultSafePrime ::Element ></a>, <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#aae265ac6aa9f941678aaa5415da34d43">DL_SimpleKeyAgreementDomainBase< GROUP_PARAMETERS::Element ></a>, and <a class="el" href="class_x_t_r___d_h.html#af70e7ee55d4a4077019fa32942d37175">XTR_DH</a>.</p>
</div>
</div>
<a id="a56d0957a43c48f3e6431868f564f574f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56d0957a43c48f3e6431868f564f574f">◆ </a></span>GeneratePublicKey()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate a public key from a private key in this domain. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rng</td><td>a <a class="el" href="class_random_number_generator.html" title="Interface for random number generators. ">RandomNumberGenerator</a> derived class </td></tr>
<tr><td class="paramname">privateKey</td><td>a byte buffer with the previously generated private key </td></tr>
<tr><td class="paramname">publicKey</td><td>a byte buffer for the generated public key in this domain </td></tr>
</table>
</dd>
</dl>
<dl class="section pre"><dt>Precondition</dt><dd><code><a class="el" href="misc_8h.html#a2d7e4464ea73d6393ebe78f952253426" title="Counts elements in an array. ">COUNTOF(publicKey)</a> == <a class="el" href="class_simple_key_agreement_domain.html#a717ec0ad52950f8d792466ad591b5104" title="Provides the size of the public key. ">PublicKeyLength()</a></code> </dd></dl>
<p>Implemented in <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#aecdc210831ffbde6dcb5e9e99c02bfaf">DL_SimpleKeyAgreementDomainBase< T ></a>, <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#aecdc210831ffbde6dcb5e9e99c02bfaf">DL_SimpleKeyAgreementDomainBase< DL_GroupParameters_GFP_DefaultSafePrime ::Element ></a>, <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#aecdc210831ffbde6dcb5e9e99c02bfaf">DL_SimpleKeyAgreementDomainBase< GROUP_PARAMETERS::Element ></a>, <a class="el" href="class_d_h___domain.html#a7539d1338aeff37a9187df0b010d7e8b">DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION ></a>, <a class="el" href="class_d_h___domain.html#a7539d1338aeff37a9187df0b010d7e8b">DH_Domain< DL_GroupParameters_GFP_DefaultSafePrime ></a>, and <a class="el" href="class_x_t_r___d_h.html#afcfd324a874148e36b78b675ad5499ac">XTR_DH</a>.</p>
</div>
</div>
<a id="a301bbc5a9feac1c6b9b337a0ddfc8ecf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a301bbc5a9feac1c6b9b337a0ddfc8ecf">◆ </a></span>GenerateKeyPair()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate a private/public key pair. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rng</td><td>a <a class="el" href="class_random_number_generator.html" title="Interface for random number generators. ">RandomNumberGenerator</a> derived class </td></tr>
<tr><td class="paramname">privateKey</td><td>a byte buffer for the generated private key in this domain </td></tr>
<tr><td class="paramname">publicKey</td><td>a byte buffer for the generated public key in this domain</td></tr>
</table>
</dd>
</dl>
<p><a class="el" href="class_simple_key_agreement_domain.html#a301bbc5a9feac1c6b9b337a0ddfc8ecf" title="Generate a private/public key pair. ">GenerateKeyPair()</a> is equivalent to calling <a class="el" href="class_simple_key_agreement_domain.html#aee7a4929f8a1a77acd04e12fbcd0a0b1" title="Generate private key in this domain. ">GeneratePrivateKey()</a> and then <a class="el" href="class_simple_key_agreement_domain.html#a56d0957a43c48f3e6431868f564f574f" title="Generate a public key from a private key in this domain. ">GeneratePublicKey()</a>. </p><dl class="section pre"><dt>Precondition</dt><dd><code><a class="el" href="misc_8h.html#a2d7e4464ea73d6393ebe78f952253426" title="Counts elements in an array. ">COUNTOF(privateKey)</a> == <a class="el" href="class_simple_key_agreement_domain.html#a8e2e4c5ab6584e4aef0c6da6b122a668" title="Provides the size of the private key. ">PrivateKeyLength()</a></code> </dd>
<dd>
<code><a class="el" href="misc_8h.html#a2d7e4464ea73d6393ebe78f952253426" title="Counts elements in an array. ">COUNTOF(publicKey)</a> == <a class="el" href="class_simple_key_agreement_domain.html#a717ec0ad52950f8d792466ad591b5104" title="Provides the size of the public key. ">PublicKeyLength()</a></code> </dd></dl>
<p class="definition">Definition at line <a class="el" href="cryptlib_8cpp_source.html#l00967">967</a> of file <a class="el" href="cryptlib_8cpp_source.html">cryptlib.cpp</a>.</p>
</div>
</div>
<a id="a732339ca730408cca7b1191fc32eb39e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a732339ca730408cca7b1191fc32eb39e">◆ </a></span>Agree()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Derive agreed value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">agreedValue</td><td>a byte buffer for the shared secret </td></tr>
<tr><td class="paramname">privateKey</td><td>a byte buffer with your private key in this domain </td></tr>
<tr><td class="paramname">otherPublicKey</td><td>a byte buffer with the other party's public key in this domain </td></tr>
<tr><td class="paramname">validateOtherPublicKey</td><td>a flag indicating if the other party's public key should be validated </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true upon success, false in case of failure</dd></dl>
<p><a class="el" href="class_simple_key_agreement_domain.html#a732339ca730408cca7b1191fc32eb39e" title="Derive agreed value. ">Agree()</a> derives an agreed value from your private keys and couterparty's public keys.</p>
<p>The other party's public key is validated by default. If you have previously validated the static public key, use <code>validateStaticOtherPublicKey=false</code> to save time. </p><dl class="section pre"><dt>Precondition</dt><dd><code><a class="el" href="misc_8h.html#a2d7e4464ea73d6393ebe78f952253426" title="Counts elements in an array. ">COUNTOF(agreedValue)</a> == <a class="el" href="class_simple_key_agreement_domain.html#aedb873e4aa6fc15ac5245b7af04e4946" title="Provides the size of the agreed value. ">AgreedValueLength()</a></code> </dd>
<dd>
<code><a class="el" href="misc_8h.html#a2d7e4464ea73d6393ebe78f952253426" title="Counts elements in an array. ">COUNTOF(privateKey)</a> == <a class="el" href="class_simple_key_agreement_domain.html#a8e2e4c5ab6584e4aef0c6da6b122a668" title="Provides the size of the private key. ">PrivateKeyLength()</a></code> </dd>
<dd>
<code><a class="el" href="misc_8h.html#a2d7e4464ea73d6393ebe78f952253426" title="Counts elements in an array. ">COUNTOF(otherPublicKey)</a> == <a class="el" href="class_simple_key_agreement_domain.html#a717ec0ad52950f8d792466ad591b5104" title="Provides the size of the public key. ">PublicKeyLength()</a></code> </dd></dl>
<p>Implemented in <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#a77adf8b02a2d3f663eea59ed55a09c9f">DL_SimpleKeyAgreementDomainBase< T ></a>, <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#a77adf8b02a2d3f663eea59ed55a09c9f">DL_SimpleKeyAgreementDomainBase< DL_GroupParameters_GFP_DefaultSafePrime ::Element ></a>, <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#a77adf8b02a2d3f663eea59ed55a09c9f">DL_SimpleKeyAgreementDomainBase< GROUP_PARAMETERS::Element ></a>, and <a class="el" href="class_x_t_r___d_h.html#a260b984bb13e082f22a6fabfe5671d2d">XTR_DH</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><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 16 2018 07:58:58 for Crypto++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
0a67b807a02637f2cae68649d519a89d
>
files
>
1806
