<!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++: KeyAgreementAlgorithm 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_key_agreement_algorithm-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">KeyAgreementAlgorithm Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Interface for key agreement algorithms.
<a href="class_key_agreement_algorithm.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 KeyAgreementAlgorithm:</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_key_agreement_algorithm.png" usemap="#KeyAgreementAlgorithm_map" alt=""/>
<map id="KeyAgreementAlgorithm_map" name="KeyAgreementAlgorithm_map">
<area href="class_asymmetric_algorithm.html" title="Interface for asymmetric algorithms. " alt="AsymmetricAlgorithm" shape="rect" coords="573,112,1136,136"/>
<area href="class_algorithm.html" title="Interface for all crypto algorithms. " alt="Algorithm" shape="rect" coords="573,56,1136,80"/>
<area href="class_clonable.html" title="Interface for cloning objects. " alt="Clonable" shape="rect" coords="573,0,1136,24"/>
<area href="class_authenticated_key_agreement_domain.html" title="Interface for domains of authenticated key agreement protocols. " alt="AuthenticatedKeyAgreementDomain" shape="rect" coords="0,224,563,248"/>
<area href="class_simple_key_agreement_domain.html" title="Interface for domains of simple key agreement protocols. " alt="SimpleKeyAgreementDomain" shape="rect" coords="1146,224,1709,248"/>
<area href="class_d_h2.html" title="Unified Diffie-Hellman in GF(p) " alt="DH2" shape="rect" coords="573,280,1136,304"/>
<area href="class_f_h_m_q_v___domain.html" title="Fully Hashed Menezes-Qu-Vanstone in GF(p) " alt="FHMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >" shape="rect" coords="573,336,1136,360"/>
<area href="class_h_m_q_v___domain.html" title="Hashed Menezes-Qu-Vanstone in GF(p) " alt="HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH >" shape="rect" coords="573,392,1136,416"/>
<area href="class_m_q_v___domain.html" title="MQV domain for performing authenticated key agreement. " alt="MQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >" shape="rect" coords="573,448,1136,472"/>
<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="1719,280,2282,304"/>
<area href="class_d_l___simple_key_agreement_domain_base.html" alt="DL_SimpleKeyAgreementDomainBase< DL_GroupParameters_GFP_DefaultSafePrime ::Element >" shape="rect" coords="1719,336,2282,360"/>
<area href="class_d_l___simple_key_agreement_domain_base.html" alt="DL_SimpleKeyAgreementDomainBase< GROUP_PARAMETERS::Element >" shape="rect" coords="1719,392,2282,416"/>
<area href="class_x_t_r___d_h.html" title="XTR-DH with key validation. " alt="XTR_DH" shape="rect" coords="1719,448,2282,472"/>
</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:ab9c52198ff0dd877243c9520d96beaaa"><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"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a reference to Crypto Parameters. <a href="#ab9c52198ff0dd877243c9520d96beaaa">More...</a><br /></td></tr>
<tr class="separator:ab9c52198ff0dd877243c9520d96beaaa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a1eb8e141b2f26a21efed7a1d7744c9"><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"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a reference to Crypto Parameters. <a href="#a3a1eb8e141b2f26a21efed7a1d7744c9">More...</a><br /></td></tr>
<tr class="separator:a3a1eb8e141b2f26a21efed7a1d7744c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abbe709ef84c668901d9e6cf09167d9c9"><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"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a reference to Crypto Parameters. <a href="#abbe709ef84c668901d9e6cf09167d9c9">More...</a><br /></td></tr>
<tr class="separator:abbe709ef84c668901d9e6cf09167d9c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b0e622b88d0b8d319c23e4aefef414d"><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"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a reference to Crypto Parameters. <a href="#a5b0e622b88d0b8d319c23e4aefef414d">More...</a><br /></td></tr>
<tr class="separator:a5b0e622b88d0b8d319c23e4aefef414d"><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 key agreement algorithms. </p>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l02466">2466</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="ab9c52198ff0dd877243c9520d96beaaa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9c52198ff0dd877243c9520d96beaaa">◆ </a></span>AccessMaterial()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_crypto_material.html">CryptoMaterial</a>& KeyAgreementAlgorithm::AccessMaterial </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves a reference to Crypto Parameters. </p>
<dl class="section return"><dt>Returns</dt><dd>a reference the crypto parameters </dd></dl>
<p>Implements <a class="el" href="class_asymmetric_algorithm.html#ad99d55413166b69a0a12e10d111926c8">AsymmetricAlgorithm</a>.</p>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l02473">2473</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div>
</div>
<a id="a3a1eb8e141b2f26a21efed7a1d7744c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a1eb8e141b2f26a21efed7a1d7744c9">◆ </a></span>GetMaterial()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="class_crypto_material.html">CryptoMaterial</a>& KeyAgreementAlgorithm::GetMaterial </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">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves a reference to Crypto Parameters. </p>
<dl class="section return"><dt>Returns</dt><dd>a const reference the crypto parameters </dd></dl>
<p>Implements <a class="el" href="class_asymmetric_algorithm.html#adf9cc798c5a2d20ab3436dbad8e6df2d">AsymmetricAlgorithm</a>.</p>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l02476">2476</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div>
</div>
<a id="abbe709ef84c668901d9e6cf09167d9c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbe709ef84c668901d9e6cf09167d9c9">◆ </a></span>AccessCryptoParameters()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="class_crypto_parameters.html">CryptoParameters</a>& KeyAgreementAlgorithm::AccessCryptoParameters </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>Retrieves a reference to Crypto Parameters. </p>
<dl class="section return"><dt>Returns</dt><dd>a reference the crypto parameters </dd></dl>
<p>Implemented in <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#a87e47aa9cc5343877270960680d51e3f">DL_SimpleKeyAgreementDomainBase< T ></a>, <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#a87e47aa9cc5343877270960680d51e3f">DL_SimpleKeyAgreementDomainBase< DL_GroupParameters_GFP_DefaultSafePrime ::Element ></a>, <a class="el" href="class_d_l___simple_key_agreement_domain_base.html#a87e47aa9cc5343877270960680d51e3f">DL_SimpleKeyAgreementDomainBase< GROUP_PARAMETERS::Element ></a>, <a class="el" href="class_m_q_v___domain.html#af4dda134c82bac3cd13bb1b468159cde">MQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION ></a>, <a class="el" href="class_f_h_m_q_v___domain.html#ab7d5e9183b47e7f407730c134d90f9e6">FHMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH ></a>, <a class="el" href="class_h_m_q_v___domain.html#a6e17a9bd0f489294987a891902b2a68e">HMQV_Domain< GROUP_PARAMETERS, COFACTOR_OPTION, HASH ></a>, <a class="el" href="class_d_h2.html#a8873541aa29f886dc4c38c183e231bac">DH2</a>, and <a class="el" href="class_x_t_r___d_h.html#ac8961d7753053e451e951ad8ba808582">XTR_DH</a>.</p>
</div>
</div>
<a id="a5b0e622b88d0b8d319c23e4aefef414d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b0e622b88d0b8d319c23e4aefef414d">◆ </a></span>GetCryptoParameters()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="class_crypto_parameters.html">CryptoParameters</a>& KeyAgreementAlgorithm::GetCryptoParameters </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">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves a reference to Crypto Parameters. </p>
<dl class="section return"><dt>Returns</dt><dd>a const reference the crypto parameters </dd></dl>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l02483">2483</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="cryptlib_8h_source.html">cryptlib.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 16 2018 07:58:41 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
>
1174
