<!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"/>
<title>Crypto++: Algorithm Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<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="annotated.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="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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>
</div>
<div class="contents">
<h1>Algorithm Class Reference</h1><!-- doxytag: class="Algorithm" --><!-- doxytag: inherits="Clonable" -->
<p>interface for all crypto algorithms
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Algorithm:</div>
<div class="dynsection">
<div class="center">
<img src="class_algorithm.gif" usemap="#Algorithm_map" alt=""/>
<map id="Algorithm_map" name="Algorithm_map">
<area href="class_clonable.html" alt="Clonable" shape="rect" coords="2388,0,2975,24"/>
<area href="class_asymmetric_algorithm.html" alt="AsymmetricAlgorithm" shape="rect" coords="0,112,587,136"/>
<area href="class_block_transformation.html" alt="BlockTransformation" shape="rect" coords="1194,112,1781,136"/>
<area href="class_buffered_transformation.html" alt="BufferedTransformation" shape="rect" coords="1791,112,2378,136"/>
<area href="class_hash_transformation.html" alt="HashTransformation" shape="rect" coords="2985,112,3572,136"/>
<area href="class_random_number_generator.html" alt="RandomNumberGenerator" shape="rect" coords="4179,112,4766,136"/>
<area href="class_stream_transformation.html" alt="StreamTransformation" shape="rect" coords="5373,112,5960,136"/>
<area href="class_key_agreement_algorithm.html" alt="KeyAgreementAlgorithm" shape="rect" coords="597,168,1184,192"/>
<area href="class_private_key_algorithm.html" alt="PrivateKeyAlgorithm" shape="rect" coords="597,224,1184,248"/>
<area href="class_public_key_algorithm.html" alt="PublicKeyAlgorithm" shape="rect" coords="597,280,1184,304"/>
<area href="class_block_cipher.html" alt="BlockCipher" shape="rect" coords="1194,168,1781,192"/>
<area href="class_auto_signaling.html" alt="AutoSignaling< BufferedTransformation >" shape="rect" coords="2388,168,2975,192"/>
<area href="class_bufferless.html" alt="Bufferless< BufferedTransformation >" shape="rect" coords="2388,224,2975,248"/>
<area href="class_filter.html" alt="Filter" shape="rect" coords="2388,280,2975,304"/>
<area href="class_input_rejecting.html" alt="InputRejecting< BufferedTransformation >" shape="rect" coords="2388,336,2975,360"/>
<area href="class_sink.html" alt="Sink" shape="rect" coords="2388,392,2975,416"/>
<area href="class_adler32.html" alt="Adler32" shape="rect" coords="3582,168,4169,192"/>
<area href="class_c_r_c32.html" alt="CRC32" shape="rect" coords="3582,224,4169,248"/>
<area href="class_iterated_hash_base.html" alt="IteratedHashBase< T_HashWordType, HashTransformation >" shape="rect" coords="3582,280,4169,304"/>
<area href="class_iterated_hash_base.html" alt="IteratedHashBase< word32, HashTransformation >" shape="rect" coords="3582,336,4169,360"/>
<area href="class_iterated_hash_base.html" alt="IteratedHashBase< word64, HashTransformation >" shape="rect" coords="3582,392,4169,416"/>
<area href="class_message_authentication_code.html" alt="MessageAuthenticationCode" shape="rect" coords="3582,448,4169,472"/>
<area href="class_null_hash.html" alt="NullHash" shape="rect" coords="3582,504,4169,528"/>
<area href="class_p_k___message_accumulator.html" alt="PK_MessageAccumulator" shape="rect" coords="3582,560,4169,584"/>
<area href="class_truncated_hash_template.html" alt="TruncatedHashTemplate< T >" shape="rect" coords="3582,616,4169,640"/>
<area href="class_weak1_1_1_m_d2.html" alt="Weak1::MD2" shape="rect" coords="3582,672,4169,696"/>
<area href="class_additive_cipher_template.html" alt="AdditiveCipherTemplate< BASE >" shape="rect" coords="4776,168,5363,192"/>
<area href="class_additive_cipher_template.html" alt="AdditiveCipherTemplate< AbstractPolicyHolder< AdditiveCipherAbstractPolicy, CTR_ModePolicy > >" shape="rect" coords="4776,224,5363,248"/>
<area href="class_auto_seeded_x917_r_n_g.html" alt="AutoSeededX917RNG< BLOCK_CIPHER >" shape="rect" coords="4776,280,5363,304"/>
<area href="class_blocking_rng.html" alt="BlockingRng" shape="rect" coords="4776,336,5363,360"/>
<area href="class_class_null_r_n_g.html" alt="ClassNullRNG" shape="rect" coords="4776,392,5363,416"/>
<area href="class_fixed_r_n_g.html" alt="FixedRNG" shape="rect" coords="4776,448,5363,472"/>
<area href="class_k_d_f2___r_n_g.html" alt="KDF2_RNG" shape="rect" coords="4776,504,5363,528"/>
<area href="class_l_c___r_n_g.html" alt="LC_RNG" shape="rect" coords="4776,560,5363,584"/>
<area href="class_nonblocking_rng.html" alt="NonblockingRng" shape="rect" coords="4776,616,5363,640"/>
<area href="class_public_blum_blum_shub.html" alt="PublicBlumBlumShub" shape="rect" coords="4776,672,5363,696"/>
<area href="class_random_pool.html" alt="RandomPool" shape="rect" coords="4776,728,5363,752"/>
<area href="class_weak1_1_1_a_r_c4___base.html" alt="Weak1::ARC4_Base" shape="rect" coords="4776,784,5363,808"/>
<area href="class_x917_r_n_g.html" alt="X917RNG" shape="rect" coords="4776,840,5363,864"/>
<area href="class_authenticated_symmetric_cipher.html" alt="AuthenticatedSymmetricCipher" shape="rect" coords="5970,168,6557,192"/>
<area href="class_public_blum_blum_shub.html" alt="PublicBlumBlumShub" shape="rect" coords="5970,224,6557,248"/>
<area href="class_symmetric_cipher.html" alt="SymmetricCipher" shape="rect" coords="5970,280,6557,304"/>
</map>
</div>
</div>
<p><a href="class_algorithm-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><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><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acd21c6715add4884fa043eaf51655039"></a><!-- doxytag: member="Algorithm::AlgorithmName" ref="acd21c6715add4884fa043eaf51655039" args="() const " -->
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm.html#acd21c6715add4884fa043eaf51655039">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" align="right" valign="top"><a class="anchor" id="a24b43349a71e1f98508eeb10b31a0a62"></a><!-- doxytag: member="Algorithm::Clone" ref="a24b43349a71e1f98508eeb10b31a0a62" 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#a24b43349a71e1f98508eeb10b31a0a62">Clone</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">this is not implemented by most classes yet <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>interface for all crypto algorithms </p>
<p>Definition at line <a class="el" href="cryptlib_8h_source.html#l00343">343</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a1c77f5117ca2cd881baf26a364cfc606"></a><!-- doxytag: member="Algorithm::Algorithm" ref="a1c77f5117ca2cd881baf26a364cfc606" args="(bool checkSelfTestStatus=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Algorithm::Algorithm </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>checkSelfTestStatus</em> = <code>true</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>When FIPS 140-2 compliance is enabled and checkSelfTestStatus == true, this constructor throws <a class="el" href="class_self_test_failure.html" title="exception thrown when a crypto algorithm is used after a self test fails">SelfTestFailure</a> if the self test hasn't been run or fails. </p>
<p>Definition at line <a class="el" href="cryptlib_8cpp_source.html#l00041">41</a> of file <a class="el" href="cryptlib_8cpp_source.html">cryptlib.cpp</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>
<hr size="1"/><address style="text-align: right;"><small>Generated on 9 Dec 2009 for Crypto++ by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
13
>
i386
>
media
>
os
>
by-pkgid
>
07dfcfe50d66c9a48a3c5e6c1693f12a
>
files
>
77
