<!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++: Crypto++ Library 5.6.0 API 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 class="current"><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Crypto++ Library 5.6.0 API Reference</h1><dl>
<dt>Abstract Base Classes</dt>
<dd><a class="el" href="cryptlib_8h.html">cryptlib.h</a> </dd>
<dt>Authenticated Encryption</dt>
<dd><a class="el" href="struct_authenticated_symmetric_cipher_documentation.html" title="Each class derived from this one defines two types, Encryption and Decryption, both...">AuthenticatedSymmetricCipherDocumentation</a> </dd>
<dt>Symmetric Ciphers</dt>
<dd><a class="el" href="struct_symmetric_cipher_documentation.html" title="Each class derived from this one defines two types, Encryption and Decryption, both...">SymmetricCipherDocumentation</a> </dd>
<dt>Hash Functions</dt>
<dd><a class="el" href="class_s_h_a1.html" title="SHA-1">SHA1</a>, <a class="el" href="class_s_h_a224.html" title="implements the SHA-224 standard">SHA224</a>, <a class="el" href="class_s_h_a256.html" title="implements the SHA-256 standard">SHA256</a>, <a class="el" href="class_s_h_a384.html" title="implements the SHA-384 standard">SHA384</a>, <a class="el" href="class_s_h_a512.html" title="implements the SHA-512 standard">SHA512</a>, <a class="el" href="class_tiger.html" title="Tiger">Tiger</a>, <a class="el" href="class_whirlpool.html" title="Whirlpool">Whirlpool</a>, <a class="el" href="class_r_i_p_e_m_d160.html" title="RIPEMD-160">RIPEMD160</a>, <a class="el" href="class_r_i_p_e_m_d320.html">RIPEMD320</a>, <a class="el" href="class_r_i_p_e_m_d128.html">RIPEMD128</a>, <a class="el" href="class_r_i_p_e_m_d256.html">RIPEMD256</a>, <a class="el" href="class_weak1_1_1_m_d2.html" title="MD2">Weak1::MD2</a>, <a class="el" href="class_weak1_1_1_m_d4.html" title="MD4">Weak1::MD4</a>, <a class="el" href="class_weak1_1_1_m_d5.html" title="MD5">Weak1::MD5</a> </dd>
<dt>Non-Cryptographic Checksums</dt>
<dd><a class="el" href="class_c_r_c32.html" title="CRC Checksum Calculation.">CRC32</a>, <a class="el" href="class_adler32.html" title="ADLER-32 checksum calculations.">Adler32</a> </dd>
<dt>Message Authentication Codes</dt>
<dd><a class="el" href="class_v_m_a_c.html" title="VMAC">VMAC</a>, <a class="el" href="class_h_m_a_c.html" title="HMAC">HMAC</a>, <a class="el" href="class_c_b_c___m_a_c.html" title="CBC-MAC">CBC_MAC</a>, <a class="el" href="class_c_m_a_c.html" title="CMAC">CMAC</a>, <a class="el" href="class_d_m_a_c.html" title="DMAC.">DMAC</a>, <a class="el" href="class_t_t_m_a_c.html" title="Two-Track-MAC">TTMAC</a>, <a class="el" href="struct_g_c_m.html" title="GCM">GCM</a> (GMAC) </dd>
<dt>Random Number Generators</dt>
<dd><a class="el" href="cryptlib_8h.html#afcd6162a0a4d19df92106149e7eaf55a" title="returns a reference that can be passed to functions that ask for a RNG but doesn't...">NullRNG()</a>, <a class="el" href="class_l_c___r_n_g.html" title="linear congruential generator">LC_RNG</a>, <a class="el" href="class_random_pool.html" title="Randomness Pool.">RandomPool</a>, <a class="el" href="class_blocking_rng.html" title="encapsulate /dev/random, or /dev/srandom on OpenBSD">BlockingRng</a>, <a class="el" href="class_nonblocking_rng.html" title="encapsulate CryptoAPI's CryptGenRandom or /dev/urandom">NonblockingRng</a>, <a class="el" href="class_auto_seeded_random_pool.html" title="Automaticly Seeded Randomness Pool.">AutoSeededRandomPool</a>, <a class="el" href="class_auto_seeded_x917_r_n_g.html" title="RNG from ANSI X9.17 Appendix C, seeded using an OS provided RNG.">AutoSeededX917RNG</a>, DefaultAutoSeededRNG </dd>
<dt>Password-based Cryptography</dt>
<dd><a class="el" href="class_password_based_key_derivation_function.html" title="abstract base class for password based key derivation function">PasswordBasedKeyDerivationFunction</a> </dd>
<dt>Public Key Cryptosystems</dt>
<dd><a class="el" href="struct_d_l_i_e_s.html" title="Discrete Log Integrated Encryption Scheme, AKA DLIES.">DLIES</a>, <a class="el" href="struct_e_c_i_e_s.html" title="Elliptic Curve Integrated Encryption Scheme, AKA ECIES.">ECIES</a>, <a class="el" href="struct_l_u_c_e_s.html" title="LUC cryptosystem.">LUCES</a>, <a class="el" href="struct_r_s_a_e_s.html" title="RSA cryptosystem">RSAES</a>, <a class="el" href="struct_rabin_e_s.html" title="Rabin encryption.">RabinES</a>, <a class="el" href="struct_l_u_c___i_e_s.html" title="LUC-IES.">LUC_IES</a> </dd>
<dt>Public Key Signature Schemes</dt>
<dd><a class="el" href="struct_d_s_a.html" title="DSA">DSA</a>, <a class="el" href="struct_g_d_s_a.html" title="DSA-1363">GDSA</a>, <a class="el" href="struct_e_c_d_s_a.html" title="ECDSA">ECDSA</a>, <a class="el" href="struct_n_r.html" title="NR">NR</a>, <a class="el" href="struct_e_c_n_r.html" title="ECNR.">ECNR</a>, <a class="el" href="struct_l_u_c_s_s.html" title="LUC signature scheme with appendix.">LUCSS</a>, <a class="el" href="struct_r_s_a_s_s.html" title="RSA signature scheme with appendix">RSASS</a>, <a class="el" href="struct_r_s_a_s_s___i_s_o.html">RSASS_ISO</a>, <a class="el" href="struct_rabin_s_s.html" title="Rabin signature.">RabinSS</a>, <a class="el" href="struct_r_w_s_s.html" title="RWSS.">RWSS</a>, <a class="el" href="struct_e_s_i_g_n.html" title="ESIGN, as defined in IEEE P1363a.">ESIGN</a> </dd>
<dt>Key Agreement</dt>
<dd><a class="el" href="dh_8h.html#ad6400f70a2f740693b62d66d59171a32" title="Diffie-Hellman in GF(p) with key validation">DH</a>, <a class="el" href="class_d_h2.html" title="Unified Diffie-Hellman">DH2</a>, <a class="el" href="mqv_8h.html#a55efec2ab777263bc0d165afa0c3fe3b" title="Menezes-Qu-Vanstone in GF(p) with key validation, AKA MQV.">MQV</a>, <a class="el" href="struct_e_c_d_h.html" title="Elliptic Curve Diffie-Hellman, AKA ECDH.">ECDH</a>, <a class="el" href="struct_e_c_m_q_v.html" title="Elliptic Curve Menezes-Qu-Vanstone, AKA ECMQV.">ECMQV</a>, <a class="el" href="class_x_t_r___d_h.html" title="XTR-DH with key validation.">XTR_DH</a> </dd>
<dt>Algebraic Structures</dt>
<dd><a class="el" href="class_integer.html" title="multiple precision integer and basic arithmetics">Integer</a>, <a class="el" href="class_polynomial_mod2.html" title="Polynomial with Coefficients in GF(2).">PolynomialMod2</a>, <a class="el" href="class_polynomial_over.html" title="represents single-variable polynomials over arbitrary rings">PolynomialOver</a>, <a class="el" href="class_ring_of_polynomials_over.html" title="Ring of polynomials over another ring.">RingOfPolynomialsOver</a>, <a class="el" href="class_modular_arithmetic.html" title="ring of congruence classes modulo n">ModularArithmetic</a>, <a class="el" href="class_montgomery_representation.html" title="do modular arithmetics in Montgomery representation for increased speed">MontgomeryRepresentation</a>, <a class="el" href="class_g_f_p2___o_n_b.html" title="GF(p^2), optimal normal basis.">GFP2_ONB</a>, <a class="el" href="class_g_f2_n_p.html" title="GF(2^n) with Polynomial Basis.">GF2NP</a>, <a class="el" href="class_g_f256.html" title="GF(256) with polynomial basis.">GF256</a>, <a class="el" href="class_g_f2__32.html" title="GF(2^32) with polynomial basis.">GF2_32</a>, <a class="el" href="class_e_c2_n.html" title="Elliptic Curve over GF(2^n).">EC2N</a>, <a class="el" href="class_e_c_p.html" title="Elliptic Curve over GF(p), where p is prime.">ECP</a> </dd>
<dt>Secret Sharing and Information Dispersal</dt>
<dd><a class="el" href="class_secret_sharing.html" title="a variant of Shamir's Secret Sharing Algorithm">SecretSharing</a>, <a class="el" href="class_secret_recovery.html" title="a variant of Shamir's Secret Sharing Algorithm">SecretRecovery</a>, <a class="el" href="class_information_dispersal.html" title="a variant of Rabin's Information Dispersal Algorithm">InformationDispersal</a>, <a class="el" href="class_information_recovery.html" title="a variant of Rabin's Information Dispersal Algorithm">InformationRecovery</a> </dd>
<dt>Compression</dt>
<dd><a class="el" href="class_deflator.html" title="DEFLATE (RFC 1951) compressor.">Deflator</a>, <a class="el" href="class_inflator.html" title="DEFLATE (RFC 1951) decompressor.">Inflator</a>, <a class="el" href="class_gzip.html" title="GZIP Compression (RFC 1952).">Gzip</a>, <a class="el" href="class_gunzip.html" title="GZIP Decompression (RFC 1952).">Gunzip</a>, <a class="el" href="class_zlib_compressor.html" title="ZLIB Compressor (RFC 1950).">ZlibCompressor</a>, <a class="el" href="class_zlib_decompressor.html" title="ZLIB Decompressor (RFC 1950).">ZlibDecompressor</a> </dd>
<dt>Input <a class="el" href="class_source.html" title="A Filter that pumps data into its attachment as input.">Source</a> Classes</dt>
<dd><a class="el" href="class_string_source.html" title="string-based implementation of Source interface">StringSource</a>, ArraySource, <a class="el" href="class_file_source.html" title="file-based implementation of Source interface">FileSource</a>, <a class="el" href="class_socket_source.html" title="socket-based implementation of NetworkSource">SocketSource</a>, <a class="el" href="class_windows_pipe_source.html" title="Windows Pipe Source.">WindowsPipeSource</a>, <a class="el" href="class_random_number_source.html" title="RNG-based implementation of Source interface.">RandomNumberSource</a> </dd>
<dt>Output <a class="el" href="class_sink.html" title="A BufferedTransformation that doesn't produce any retrievable output.">Sink</a> Classes</dt>
<dd><a class="el" href="class_string_sink_template.html" title="Append input to a string object.">StringSinkTemplate</a>, <a class="el" href="class_array_sink.html" title="Copy input to a memory buffer.">ArraySink</a>, <a class="el" href="class_file_sink.html" title="file-based implementation of Sink interface">FileSink</a>, <a class="el" href="class_socket_sink.html" title="socket-based implementation of NetworkSink">SocketSink</a>, <a class="el" href="class_windows_pipe_sink.html" title="Windows Pipe Sink.">WindowsPipeSink</a>, <a class="el" href="class_random_number_sink.html" title="incorporates input into RNG as additional entropy">RandomNumberSink</a> </dd>
<dt><a class="el" href="class_filter.html" title="provides an implementation of BufferedTransformation's attachment interface">Filter</a> Wrappers</dt>
<dd><a class="el" href="class_stream_transformation_filter.html" title="Filter Wrapper for StreamTransformation, optionally handling padding/unpadding when...">StreamTransformationFilter</a>, <a class="el" href="class_hash_filter.html" title="Filter Wrapper for HashTransformation.">HashFilter</a>, <a class="el" href="class_hash_verification_filter.html" title="Filter Wrapper for HashTransformation.">HashVerificationFilter</a>, <a class="el" href="class_signer_filter.html" title="Filter Wrapper for PK_Signer.">SignerFilter</a>, <a class="el" href="class_signature_verification_filter.html" title="Filter Wrapper for PK_Verifier.">SignatureVerificationFilter</a> </dd>
<dt>Binary to Text Encoders and Decoders</dt>
<dd><a class="el" href="class_hex_encoder.html" title="Converts given data to base 16.">HexEncoder</a>, <a class="el" href="class_hex_decoder.html" title="Decode base 16 data back to bytes.">HexDecoder</a>, <a class="el" href="class_base64_encoder.html" title="Base64 Encoder Class.">Base64Encoder</a>, <a class="el" href="class_base64_decoder.html" title="Base64 Decoder Class.">Base64Decoder</a>, <a class="el" href="class_base32_encoder.html" title="Converts given data to base 32, the default code is based on draft-ietf-idn-dude-02...">Base32Encoder</a>, <a class="el" href="class_base32_decoder.html" title="Decode base 32 data back to bytes, the default code is based on draft-ietf-idn-dude-02...">Base32Decoder</a> </dd>
<dt>Wrappers for OS features</dt>
<dd><a class="el" href="class_timer.html" title="high resolution timer">Timer</a>, <a class="el" href="class_socket.html" title="wrapper for Windows or Berkeley Sockets">Socket</a>, <a class="el" href="class_windows_handle.html" title="Windows Handle.">WindowsHandle</a>, <a class="el" href="class_thread_local_storage.html" title="thread local storage">ThreadLocalStorage</a>, <a class="el" href="class_thread_user_timer.html" title="measure CPU time spent executing instructions of this thread (if supported by OS)...">ThreadUserTimer</a> </dd>
<dt>FIPS 140 related</dt>
<dd><a class="el" href="fips140_8h.html">fips140.h</a> </dd>
</dl>
<p>In the FIPS 140-2 validated DLL version of Crypto++, only the following implementation class are available. </p>
<dl>
<dt>Block Ciphers</dt>
<dd>AES, <a class="el" href="class_d_e_s___e_d_e2.html" title="DES-EDE2">DES_EDE2</a>, <a class="el" href="class_d_e_s___e_d_e3.html" title="DES-EDE3">DES_EDE3</a>, <a class="el" href="class_s_k_i_p_j_a_c_k.html" title="SKIPJACK">SKIPJACK</a> </dd>
<dt>Cipher Modes (replace template parameter BC with one of the block ciphers above)</dt>
<dd><a class="el" href="struct_e_c_b___mode.html" title="ECB mode.">ECB_Mode</a><BC>, <a class="el" href="struct_c_t_r___mode.html" title="CTR mode.">CTR_Mode</a><BC>, <a class="el" href="struct_c_b_c___mode.html" title="CBC mode.">CBC_Mode</a><BC>, <a class="el" href="struct_c_f_b___f_i_p_s___mode.html" title="CFB mode FIPS variant, requiring full block plaintext according to FIPS 800-38A.">CFB_FIPS_Mode</a><BC>, <a class="el" href="struct_o_f_b___mode.html" title="OFB mode.">OFB_Mode</a><BC> </dd>
<dt>Hash Functions</dt>
<dd><a class="el" href="class_s_h_a1.html" title="SHA-1">SHA1</a>, <a class="el" href="class_s_h_a224.html" title="implements the SHA-224 standard">SHA224</a>, <a class="el" href="class_s_h_a256.html" title="implements the SHA-256 standard">SHA256</a>, <a class="el" href="class_s_h_a384.html" title="implements the SHA-384 standard">SHA384</a>, <a class="el" href="class_s_h_a512.html" title="implements the SHA-512 standard">SHA512</a> </dd>
<dt>Public Key Signature Schemes (replace template parameter H with one of the hash functions above)</dt>
<dd><a class="el" href="struct_r_s_a_s_s.html" title="RSA signature scheme with appendix">RSASS</a><<a class="el" href="struct_p_k_c_s1v15.html" title="PKCS #1 version 1.5, for use with RSAES and RSASS.">PKCS1v15</a>, H>, <a class="el" href="struct_r_s_a_s_s.html" title="RSA signature scheme with appendix">RSASS</a><<a class="el" href="struct_p_s_s.html" title="PSS-MGF1">PSS</a>, H>, <a class="el" href="struct_r_s_a_s_s___i_s_o.html">RSASS_ISO</a><H>, <a class="el" href="struct_r_w_s_s.html" title="RWSS.">RWSS</a><<a class="el" href="struct_p1363___e_m_s_a2.html" title="EMSA2, for use with RWSS and RSA_ISO.">P1363_EMSA2</a>, H>, <a class="el" href="struct_d_s_a.html" title="DSA">DSA</a>, <a class="el" href="struct_e_c_d_s_a.html" title="ECDSA">ECDSA</a><<a class="el" href="class_e_c_p.html" title="Elliptic Curve over GF(p), where p is prime.">ECP</a>, H>, <a class="el" href="struct_e_c_d_s_a.html" title="ECDSA">ECDSA</a><<a class="el" href="class_e_c2_n.html" title="Elliptic Curve over GF(2^n).">EC2N</a>, H> </dd>
<dt>Message Authentication Codes (replace template parameter H with one of the hash functions above)</dt>
<dd><a class="el" href="class_h_m_a_c.html" title="HMAC">HMAC</a><H>, <a class="el" href="class_c_b_c___m_a_c.html" title="CBC-MAC">CBC_MAC</a><<a class="el" href="class_d_e_s___e_d_e2.html" title="DES-EDE2">DES_EDE2</a>>, <a class="el" href="class_c_b_c___m_a_c.html" title="CBC-MAC">CBC_MAC</a><<a class="el" href="class_d_e_s___e_d_e3.html" title="DES-EDE3">DES_EDE3</a>> </dd>
<dt>Random Number Generators</dt>
<dd>DefaultAutoSeededRNG (<a class="el" href="class_auto_seeded_x917_r_n_g.html" title="RNG from ANSI X9.17 Appendix C, seeded using an OS provided RNG.">AutoSeededX917RNG</a><AES>) </dd>
<dt>Key Agreement</dt>
<dd><a class="el" href="dh_8h.html#ad6400f70a2f740693b62d66d59171a32" title="Diffie-Hellman in GF(p) with key validation">DH</a> </dd>
<dt>Public Key Cryptosystems</dt>
<dd><a class="el" href="struct_r_s_a_e_s.html" title="RSA cryptosystem">RSAES</a><<a class="el" href="class_o_a_e_p.html" title="EME-OAEP, for use with classes derived from TF_ES">OAEP</a><<a class="el" href="class_s_h_a1.html" title="SHA-1">SHA1</a>> > </dd>
</dl>
<p>This reference manual is a work in progress. Some classes are still lacking detailed descriptions. </p>
<p>Click <a href="CryptoPPRef.zip">here</a> to download a zip archive containing this manual. </p>
<p>Thanks to Ryan Phillips for providing the Doxygen configuration file and getting me started with this manual. </p>
</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
>
1814
