<!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++: PrivateKeyAlgorithm 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_private_key_algorithm-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PrivateKeyAlgorithm Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Interface for asymmetric algorithms using private keys.
<a href="class_private_key_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 PrivateKeyAlgorithm:</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_private_key_algorithm.png" usemap="#PrivateKeyAlgorithm_map" alt=""/>
<map id="PrivateKeyAlgorithm_map" name="PrivateKeyAlgorithm_map">
<area href="class_asymmetric_algorithm.html" title="Interface for asymmetric algorithms. " alt="AsymmetricAlgorithm" shape="rect" coords="1952,112,2723,136"/>
<area href="class_algorithm.html" title="Interface for all crypto algorithms. " alt="Algorithm" shape="rect" coords="1952,56,2723,80"/>
<area href="class_clonable.html" title="Interface for cloning objects. " alt="Clonable" shape="rect" coords="1952,0,2723,24"/>
<area href="class_p_k___decryptor.html" title="Interface for public-key decryptors. " alt="PK_Decryptor" shape="rect" coords="781,224,1552,248"/>
<area href="class_p_k___signer.html" title="Interface for public-key signers. " alt="PK_Signer" shape="rect" coords="3124,224,3895,248"/>
<area href="class_d_l___crypto_system_base.html" alt="DL_CryptoSystemBase< PK_Decryptor, DL_PrivateKey< SCHEME_OPTIONS::Element > >" shape="rect" coords="0,280,771,304"/>
<area href="class_d_l___crypto_system_base.html" alt="DL_CryptoSystemBase< PK_Decryptor, DL_PrivateKey< T > >" shape="rect" coords="781,280,1552,304"/>
<area href="class_p_k___fixed_length_crypto_system_impl.html" alt="PK_FixedLengthCryptoSystemImpl< PK_Decryptor >" shape="rect" coords="1562,280,2333,304"/>
<area href="class_d_l___signature_scheme_base.html" alt="DL_SignatureSchemeBase< PK_Signer, DL_PrivateKey< SCHEME_OPTIONS::Element > >" shape="rect" coords="2343,280,3114,304"/>
<area href="class_d_l___signature_scheme_base.html" alt="DL_SignatureSchemeBase< PK_Signer, DL_PrivateKey< T > >" shape="rect" coords="3124,280,3895,304"/>
<area href="class_t_f___signature_scheme_base.html" alt="TF_SignatureSchemeBase< PK_Signer, TF_Base< RandomizedTrapdoorFunctionInverse, PK_SignatureMessageEncodingMethod > >" shape="rect" coords="3905,280,4676,304"/>
<area href="class_d_l___decryptor_base.html" alt="DL_DecryptorBase< SCHEME_OPTIONS::Element >" shape="rect" coords="0,336,771,360"/>
<area href="class_d_l___decryptor_base.html" title="Discrete Log (DL) decryptor base implementation. " alt="DL_DecryptorBase< T >" shape="rect" coords="781,336,1552,360"/>
<area href="class_t_f___crypto_system_base.html" alt="TF_CryptoSystemBase< PK_Decryptor, TF_Base< TrapdoorFunctionInverse, PK_EncryptionMessageEncodingMethod > >" shape="rect" coords="1562,336,2333,360"/>
<area href="class_d_l___signer_base.html" alt="DL_SignerBase< SCHEME_OPTIONS::Element >" shape="rect" coords="2343,336,3114,360"/>
<area href="class_d_l___signer_base.html" title="Discrete Log (DL) signature scheme signer base implementation. " alt="DL_SignerBase< T >" shape="rect" coords="3124,336,3895,360"/>
<area href="class_t_f___signer_base.html" title="Trapdoor Function (TF) Signer base class. " alt="TF_SignerBase" shape="rect" coords="3905,336,4676,360"/>
<area href="class_algorithm_impl.html" alt="AlgorithmImpl< DL_DecryptorBase< SCHEME_OPTIONS::Element >, SCHEME_OPTIONS::AlgorithmInfo >" shape="rect" coords="0,392,771,416"/>
<area href="class_t_f___decryptor_base.html" title="Trapdoor function cryptosystems decryption base class. " alt="TF_DecryptorBase" shape="rect" coords="1562,392,2333,416"/>
<area href="class_algorithm_impl.html" alt="AlgorithmImpl< DL_SignerBase< SCHEME_OPTIONS::Element >, SCHEME_OPTIONS::AlgorithmInfo >" shape="rect" coords="2343,392,3114,416"/>
<area href="class_algorithm_impl.html" alt="AlgorithmImpl< TF_SignerBase, SCHEME_OPTIONS::AlgorithmInfo >" shape="rect" coords="3905,392,4676,416"/>
<area href="class_d_l___object_impl_base.html" alt="DL_ObjectImplBase< DL_DecryptorBase< SCHEME_OPTIONS::Element >, SCHEME_OPTIONS, SCHEME_OPTIONS::PrivateKey >" shape="rect" coords="0,448,771,472"/>
<area href="class_algorithm_impl.html" alt="AlgorithmImpl< TF_DecryptorBase, SCHEME_OPTIONS::AlgorithmInfo >" shape="rect" coords="1562,448,2333,472"/>
<area href="class_d_l___object_impl_base.html" alt="DL_ObjectImplBase< DL_SignerBase< SCHEME_OPTIONS::Element >, SCHEME_OPTIONS, SCHEME_OPTIONS::PrivateKey >" shape="rect" coords="2343,448,3114,472"/>
<area href="class_t_f___object_impl_base.html" alt="TF_ObjectImplBase< TF_SignerBase, SCHEME_OPTIONS, SCHEME_OPTIONS::PrivateKey >" shape="rect" coords="3905,448,4676,472"/>
<area href="class_d_l___object_impl.html" alt="DL_ObjectImpl< DL_DecryptorBase< SCHEME_OPTIONS::Element >, SCHEME_OPTIONS, SCHEME_OPTIONS::PrivateKey >" shape="rect" coords="0,504,771,528"/>
<area href="class_t_f___object_impl_base.html" alt="TF_ObjectImplBase< TF_DecryptorBase, SCHEME_OPTIONS, SCHEME_OPTIONS::PrivateKey >" shape="rect" coords="1562,504,2333,528"/>
<area href="class_d_l___object_impl.html" alt="DL_ObjectImpl< DL_SignerBase< SCHEME_OPTIONS::Element >, SCHEME_OPTIONS, SCHEME_OPTIONS::PrivateKey >" shape="rect" coords="2343,504,3114,528"/>
<area href="class_t_f___object_impl.html" alt="TF_ObjectImpl< TF_SignerBase, SCHEME_OPTIONS, SCHEME_OPTIONS::PrivateKey >" shape="rect" coords="3905,504,4676,528"/>
<area href="class_d_l___decryptor_impl.html" title="Discrete Log (DL) decryptor implementation. " alt="DL_DecryptorImpl< SCHEME_OPTIONS >" shape="rect" coords="0,560,771,584"/>
<area href="class_t_f___object_impl.html" alt="TF_ObjectImpl< TF_DecryptorBase, SCHEME_OPTIONS, SCHEME_OPTIONS::PrivateKey >" shape="rect" coords="1562,560,2333,584"/>
<area href="class_d_l___signer_impl.html" title="Discrete Log (DL) signer implementation. " alt="DL_SignerImpl< SCHEME_OPTIONS >" shape="rect" coords="2343,560,3114,584"/>
<area href="class_t_f___signer_impl.html" title="Trapdoor Function (TF) encryptor options. " alt="TF_SignerImpl< SCHEME_OPTIONS >" shape="rect" coords="3905,560,4676,584"/>
<area href="class_t_f___decryptor_impl.html" title="Trapdoor Function (TF) decryptor options. " alt="TF_DecryptorImpl< SCHEME_OPTIONS >" shape="rect" coords="1562,616,2333,640"/>
</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:a48cf4528f16263f2200d5b908a0b8ffb"><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_private_key_algorithm.html#a48cf4528f16263f2200d5b908a0b8ffb">AccessMaterial</a> ()</td></tr>
<tr class="memdesc:a48cf4528f16263f2200d5b908a0b8ffb"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a reference to a Private Key. <a href="#a48cf4528f16263f2200d5b908a0b8ffb">More...</a><br /></td></tr>
<tr class="separator:a48cf4528f16263f2200d5b908a0b8ffb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a59f3867165685cc6ac6be3f53d5f371b"><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_private_key_algorithm.html#a59f3867165685cc6ac6be3f53d5f371b">GetMaterial</a> () const</td></tr>
<tr class="memdesc:a59f3867165685cc6ac6be3f53d5f371b"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a reference to a Private Key. <a href="#a59f3867165685cc6ac6be3f53d5f371b">More...</a><br /></td></tr>
<tr class="separator:a59f3867165685cc6ac6be3f53d5f371b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae2085815947c2ae7b3f9f614612e0c17"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_private_key.html">PrivateKey</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_private_key_algorithm.html#ae2085815947c2ae7b3f9f614612e0c17">AccessPrivateKey</a> ()=0</td></tr>
<tr class="memdesc:ae2085815947c2ae7b3f9f614612e0c17"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a reference to a Private Key. <a href="#ae2085815947c2ae7b3f9f614612e0c17">More...</a><br /></td></tr>
<tr class="separator:ae2085815947c2ae7b3f9f614612e0c17"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab36fe7af04ef624d38c0c06da5b89bb4"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="class_private_key.html">PrivateKey</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_private_key_algorithm.html#ab36fe7af04ef624d38c0c06da5b89bb4">GetPrivateKey</a> () const</td></tr>
<tr class="memdesc:ab36fe7af04ef624d38c0c06da5b89bb4"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a reference to a Private Key. <a href="#ab36fe7af04ef624d38c0c06da5b89bb4">More...</a><br /></td></tr>
<tr class="separator:ab36fe7af04ef624d38c0c06da5b89bb4"><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 asymmetric algorithms using private keys. </p>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l02445">2445</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="a48cf4528f16263f2200d5b908a0b8ffb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48cf4528f16263f2200d5b908a0b8ffb">◆ </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>& PrivateKeyAlgorithm::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 a Private Key. </p>
<dl class="section return"><dt>Returns</dt><dd>a reference the private key </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#l02452">2452</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div>
</div>
<a id="a59f3867165685cc6ac6be3f53d5f371b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59f3867165685cc6ac6be3f53d5f371b">◆ </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>& PrivateKeyAlgorithm::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 a Private Key. </p>
<dl class="section return"><dt>Returns</dt><dd>a const reference the private key </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#l02455">2455</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div>
</div>
<a id="ae2085815947c2ae7b3f9f614612e0c17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2085815947c2ae7b3f9f614612e0c17">◆ </a></span>AccessPrivateKey()</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_private_key.html">PrivateKey</a>& PrivateKeyAlgorithm::AccessPrivateKey </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 a Private Key. </p>
<dl class="section return"><dt>Returns</dt><dd>a reference the private key </dd></dl>
</div>
</div>
<a id="ab36fe7af04ef624d38c0c06da5b89bb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab36fe7af04ef624d38c0c06da5b89bb4">◆ </a></span>GetPrivateKey()</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_private_key.html">PrivateKey</a>& PrivateKeyAlgorithm::GetPrivateKey </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 a Private Key. </p>
<dl class="section return"><dt>Returns</dt><dd>a const reference the private key </dd></dl>
<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l02462">2462</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:50 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
>
1510
