<!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++: DL_PrivateKey< T > Class Template 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-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="class_d_l___private_key-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">DL_PrivateKey< T > Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> </div><!--header--> <div class="contents"> <p>Interface for Discrete Log (DL) private keys. <a href="class_d_l___private_key.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 DL_PrivateKey< T >:</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_d_l___private_key.png" usemap="#DL_5FPrivateKey_3C_20T_20_3E_map" alt=""/> <map id="DL_5FPrivateKey_3C_20T_20_3E_map" name="DL_5FPrivateKey_3C_20T_20_3E_map"> <area href="class_d_l___key.html" title="Base class for a Discrete Log (DL) key. " alt="DL_Key< T >" shape="rect" coords="0,0,128,24"/> </map> </div></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> Public Types</h2></td></tr> <tr class="memitem:a3639a8fec074f4176e42a2be8fde6bbf"><td class="memItemLeft" align="right" valign="top"><a id="a3639a8fec074f4176e42a2be8fde6bbf"></a> typedef T </td><td class="memItemRight" valign="bottom"><b>Element</b></td></tr> <tr class="separator:a3639a8fec074f4176e42a2be8fde6bbf"><td class="memSeparator" colspan="2"> </td></tr> </table><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:a7b33d39542ee60d708b924b9d2057ef0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_l___private_key.html#a7b33d39542ee60d708b924b9d2057ef0">MakePublicKey</a> (<a class="el" href="class_d_l___public_key.html">DL_PublicKey</a>< T > &pub) const</td></tr> <tr class="memdesc:a7b33d39542ee60d708b924b9d2057ef0"><td class="mdescLeft"> </td><td class="mdescRight">Initializes a public key from this key. <a href="#a7b33d39542ee60d708b924b9d2057ef0">More...</a><br /></td></tr> <tr class="separator:a7b33d39542ee60d708b924b9d2057ef0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5fb4645481f42e5660abd7793fc0f484"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_l___private_key.html#a5fb4645481f42e5660abd7793fc0f484">GetVoidValue</a> (const char *name, const std::type_info &valueType, void *pValue) const</td></tr> <tr class="memdesc:a5fb4645481f42e5660abd7793fc0f484"><td class="mdescLeft"> </td><td class="mdescRight">Get a named value. <a href="#a5fb4645481f42e5660abd7793fc0f484">More...</a><br /></td></tr> <tr class="separator:a5fb4645481f42e5660abd7793fc0f484"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af7d9355890a52c1f71c86e490da37ac5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_l___private_key.html#af7d9355890a52c1f71c86e490da37ac5">AssignFrom</a> (const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> &source)</td></tr> <tr class="memdesc:af7d9355890a52c1f71c86e490da37ac5"><td class="mdescLeft"> </td><td class="mdescRight">Initialize or reinitialize this this key. <a href="#af7d9355890a52c1f71c86e490da37ac5">More...</a><br /></td></tr> <tr class="separator:af7d9355890a52c1f71c86e490da37ac5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac2c0ba40eeb8b935135648b967b3ddd3"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="class_integer.html">Integer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_l___private_key.html#ac2c0ba40eeb8b935135648b967b3ddd3">GetPrivateExponent</a> () const =0</td></tr> <tr class="memdesc:ac2c0ba40eeb8b935135648b967b3ddd3"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the private exponent. <a href="#ac2c0ba40eeb8b935135648b967b3ddd3">More...</a><br /></td></tr> <tr class="separator:ac2c0ba40eeb8b935135648b967b3ddd3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aade66a183c41178bc4fbaa3492987862"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_l___private_key.html#aade66a183c41178bc4fbaa3492987862">SetPrivateExponent</a> (const <a class="el" href="class_integer.html">Integer</a> &x)=0</td></tr> <tr class="memdesc:aade66a183c41178bc4fbaa3492987862"><td class="mdescLeft"> </td><td class="mdescRight">Sets the private exponent. <a href="#aade66a183c41178bc4fbaa3492987862">More...</a><br /></td></tr> <tr class="separator:aade66a183c41178bc4fbaa3492987862"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_class_d_l___key"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_d_l___key')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_d_l___key.html">DL_Key< T ></a></td></tr> <tr class="memitem:a85e3d4eddb546c05acdca33a9939755e inherit pub_methods_class_d_l___key"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="class_d_l___group_parameters.html">DL_GroupParameters</a>< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_l___key.html#a85e3d4eddb546c05acdca33a9939755e">GetAbstractGroupParameters</a> () const =0</td></tr> <tr class="memdesc:a85e3d4eddb546c05acdca33a9939755e inherit pub_methods_class_d_l___key"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves abstract group parameters. <a href="class_d_l___key.html#a85e3d4eddb546c05acdca33a9939755e">More...</a><br /></td></tr> <tr class="separator:a85e3d4eddb546c05acdca33a9939755e inherit pub_methods_class_d_l___key"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aaffcc772fd8fe1d37fae92ed77c54829 inherit pub_methods_class_d_l___key"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_d_l___group_parameters.html">DL_GroupParameters</a>< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_l___key.html#aaffcc772fd8fe1d37fae92ed77c54829">AccessAbstractGroupParameters</a> ()=0</td></tr> <tr class="memdesc:aaffcc772fd8fe1d37fae92ed77c54829 inherit pub_methods_class_d_l___key"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves abstract group parameters. <a href="class_d_l___key.html#aaffcc772fd8fe1d37fae92ed77c54829">More...</a><br /></td></tr> <tr class="separator:aaffcc772fd8fe1d37fae92ed77c54829 inherit pub_methods_class_d_l___key"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><h3>template<class T><br /> class DL_PrivateKey< T ></h3> <p>Interface for Discrete Log (DL) private keys. </p> <p class="definition">Definition at line <a class="el" href="pubkey_8h_source.html#l01105">1105</a> of file <a class="el" href="pubkey_8h_source.html">pubkey.h</a>.</p> </div><h2 class="groupheader">Member Function Documentation</h2> <a id="a7b33d39542ee60d708b924b9d2057ef0"></a> <h2 class="memtitle"><span class="permalink"><a href="#a7b33d39542ee60d708b924b9d2057ef0">◆ </a></span>MakePublicKey()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void <a class="el" href="class_d_l___private_key.html">DL_PrivateKey</a>< T >::MakePublicKey </td> <td>(</td> <td class="paramtype"><a class="el" href="class_d_l___public_key.html">DL_PublicKey</a>< T > & </td> <td class="paramname"><em>pub</em></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Initializes a public key from this key. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pub</td><td>reference to a public key </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="pubkey_8h_source.html#l01116">1116</a> of file <a class="el" href="pubkey_8h_source.html">pubkey.h</a>.</p> </div> </div> <a id="a5fb4645481f42e5660abd7793fc0f484"></a> <h2 class="memtitle"><span class="permalink"><a href="#a5fb4645481f42e5660abd7793fc0f484">◆ </a></span>GetVoidValue()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="class_d_l___private_key.html">DL_PrivateKey</a>< T >::GetVoidValue </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>name</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::type_info & </td> <td class="paramname"><em>valueType</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void * </td> <td class="paramname"><em>pValue</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">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Get a named value. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">name</td><td>the name of the object or value to retrieve </td></tr> <tr><td class="paramname">valueType</td><td>reference to a variable that receives the value </td></tr> <tr><td class="paramname">pValue</td><td>void pointer to a variable that receives the value </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true if the value was retrieved, false otherwise</dd></dl> <p><a class="el" href="class_d_l___private_key.html#a5fb4645481f42e5660abd7793fc0f484" title="Get a named value. ">GetVoidValue()</a> retrieves the value of name if it exists. </p><dl class="section note"><dt>Note</dt><dd><a class="el" href="class_d_l___private_key.html#a5fb4645481f42e5660abd7793fc0f484" title="Get a named value. ">GetVoidValue()</a> is an internal function and should be implemented by derived classes. Users should use one of the other functions instead. </dd></dl> <dl class="section see"><dt>See also</dt><dd>GetValue(), GetValueWithDefault(), GetIntValue(), GetIntValueWithDefault(), GetRequiredParameter() and GetRequiredIntParameter() </dd></dl> <p class="definition">Definition at line <a class="el" href="pubkey_8h_source.html#l01132">1132</a> of file <a class="el" href="pubkey_8h_source.html">pubkey.h</a>.</p> </div> </div> <a id="af7d9355890a52c1f71c86e490da37ac5"></a> <h2 class="memtitle"><span class="permalink"><a href="#af7d9355890a52c1f71c86e490da37ac5">◆ </a></span>AssignFrom()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void <a class="el" href="class_d_l___private_key.html">DL_PrivateKey</a>< T >::AssignFrom </td> <td>(</td> <td class="paramtype">const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> & </td> <td class="paramname"><em>source</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Initialize or reinitialize this this key. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">source</td><td><a class="el" href="class_name_value_pairs.html" title="Interface for retrieving values given their names. ">NameValuePairs</a> to assign </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="pubkey_8h_source.html#l01140">1140</a> of file <a class="el" href="pubkey_8h_source.html">pubkey.h</a>.</p> </div> </div> <a id="ac2c0ba40eeb8b935135648b967b3ddd3"></a> <h2 class="memtitle"><span class="permalink"><a href="#ac2c0ba40eeb8b935135648b967b3ddd3">◆ </a></span>GetPrivateExponent()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual const <a class="el" href="class_integer.html">Integer</a>& <a class="el" href="class_d_l___private_key.html">DL_PrivateKey</a>< T >::GetPrivateExponent </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>Retrieves the private exponent. </p> <dl class="section return"><dt>Returns</dt><dd>the private exponent</dd></dl> <p>Must be overridden in derived classes. </p> <p>Implemented in <a class="el" href="class_d_l___private_key_impl.html#a6fe4a4b57881fd8785294843c0f864d0">DL_PrivateKeyImpl< GP ></a>, and <a class="el" href="class_d_l___private_key_impl.html#a6fe4a4b57881fd8785294843c0f864d0">DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > ></a>.</p> </div> </div> <a id="aade66a183c41178bc4fbaa3492987862"></a> <h2 class="memtitle"><span class="permalink"><a href="#aade66a183c41178bc4fbaa3492987862">◆ </a></span>SetPrivateExponent()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void <a class="el" href="class_d_l___private_key.html">DL_PrivateKey</a>< T >::SetPrivateExponent </td> <td>(</td> <td class="paramtype">const <a class="el" href="class_integer.html">Integer</a> & </td> <td class="paramname"><em>x</em></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>Sets the private exponent. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">x</td><td>the private exponent</td></tr> </table> </dd> </dl> <p>Must be overridden in derived classes. </p> <p>Implemented in <a class="el" href="class_d_l___private_key_impl.html#ad2756b046f9ee7f3c254c9fc2bb8be5d">DL_PrivateKeyImpl< GP ></a>, and <a class="el" href="class_d_l___private_key_impl.html#ad2756b046f9ee7f3c254c9fc2bb8be5d">DL_PrivateKeyImpl< DL_GroupParameters_EC< EC > ></a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="pubkey_8h_source.html">pubkey.h</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Sun Sep 16 2018 07:58:28 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>