<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crypto++: Crypto++ Library 7.0 API 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.15 -->
<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="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">Crypto++ Library 7.0 API Reference </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><dl>
<dt>Abstract Base Classes</dt>
<dd><a class="el" href="cryptlib_8h.html" title="Abstract base classes that provide a uniform interface to this library.">cryptlib.h</a> </dd>
<dt>Authenticated Encryption Modes</dt>
<dd><a class="el" href="struct_c_c_m.html" title="CCM block cipher mode of operation.">CCM</a>, <a class="el" href="struct_e_a_x.html" title="EAX block cipher mode of operation.">EAX</a>, <a class="el" href="struct_g_c_m.html">GCM (2K tables)</a>, <a class="el" href="struct_g_c_m.html">GCM (64K tables)</a> </dd>
<dt>Block Ciphers</dt>
<dd><a class="el" href="class_rijndael.html">AES</a>, <a class="el" href="class_a_r_i_a.html" title="ARIA block cipher.">ARIA</a>, <a class="el" href="class_weak_1_1_a_r_c4.html" title="Alleged RC4.">Weak::ARC4</a>, <a class="el" href="class_blowfish.html" title="Blowfish block cipher.">Blowfish</a>, <a class="el" href="class_b_t_e_a.html" title="BTEA block cipher.">BTEA</a>, <a class="el" href="class_camellia.html" title="Camellia block cipher.">Camellia</a>, <a class="el" href="class_c_a_s_t128.html" title="CAST128 block cipher.">CAST128</a>, <a class="el" href="class_c_a_s_t256.html" title="CAST256 block cipher.">CAST256</a>, <a class="el" href="class_d_e_s.html" title="DES block cipher.">DES</a>, <a class="el" href="class_d_e_s___e_d_e2.html">2-key Triple-DES</a>, <a class="el" href="class_d_e_s___e_d_e3.html">3-key Triple-DES</a>, <a class="el" href="class_d_e_s___x_e_x3.html">DESX</a>, <a class="el" href="class_g_o_s_t.html" title="GOST block cipher.">GOST</a>, <a class="el" href="class_i_d_e_a.html" title="IDEA block cipher.">IDEA</a>, <a class="el" href="class_l_r.html">Luby-Rackoff</a>, Kalyna (128/256/512), <a class="el" href="class_m_a_r_s.html" title="MARS block cipher.">MARS</a>, <a class="el" href="class_r_c2.html" title="RC2 block cipher.">RC2</a>, <a class="el" href="class_r_c5.html" title="RC5 block cipher.">RC5</a>, <a class="el" href="class_r_c6.html" title="RC6 block cipher.">RC6</a>, <a class="el" href="class_s_a_f_e_r___k.html">SAFER-K</a>, <a class="el" href="class_s_a_f_e_r___s_k.html">SAFER-SK</a>, <a class="el" href="class_s_e_e_d.html" title="SEED block cipher.">SEED</a>, <a class="el" href="class_serpent.html" title="Serpent block cipher.">Serpent</a>, <a class="el" href="class_s_h_a_c_a_l2.html">SHACAL-2</a>, <a class="el" href="class_s_h_a_r_k.html" title="SHARK block cipher SHARK-E">SHARK</a>, <a class="el" href="class_s_k_i_p_j_a_c_k.html" title="SKIPJACK block cipher.">SKIPJACK</a>, <a class="el" href="class_s_m4.html" title="Classes for the SM4 block cipher.">SM4</a>, <a class="el" href="class_square.html" title="Square block cipher.">Square</a>, <a class="el" href="class_t_e_a.html" title="TEA block cipher.">TEA</a>, <a class="el" href="class_three_way.html">3-Way</a>, <a class="el" href="class_threefish256.html">Threefish (256/512/1024)</a>, <a class="el" href="class_twofish.html" title="Twofish block cipher.">Twofish</a>, <a class="el" href="class_x_t_e_a.html" title="XTEA block cipher.">XTEA</a> </dd>
<dt>Stream Ciphers</dt>
<dd>ChaCha (ChaCha-8/12/20), <a class="el" href="class_panama.html">Panama-LE</a>, <a class="el" href="class_panama.html">Panama-BE</a>, <a class="el" href="struct_salsa20.html" title="Salsa20 stream cipher.">Salsa20</a>, <a class="el" href="struct_s_e_a_l.html">SEAL-LE</a>, <a class="el" href="struct_s_e_a_l.html">SEAL-BE</a>, WAKE, <a class="el" href="struct_x_salsa20.html" title="XSalsa20 stream cipher.">XSalsa20</a> </dd>
<dt>Hash Functions</dt>
<dd><a class="el" href="class_b_l_a_k_e2s.html" title="The BLAKE2s cryptographic hash function.">BLAKE2s</a>, <a class="el" href="class_b_l_a_k_e2b.html" title="The BLAKE2b cryptographic hash function.">BLAKE2b</a>, <a class="el" href="class_keccak.html">Keccak (F1600)</a>, <a class="el" href="class_s_h_a1.html" title="SHA-1 message digest.">SHA1</a>, <a class="el" href="class_s_h_a224.html" title="SHA-224 message digest.">SHA224</a>, <a class="el" href="class_s_h_a256.html" title="SHA-256 message digest.">SHA256</a>, <a class="el" href="class_s_h_a384.html" title="SHA-384 message digest.">SHA384</a>, <a class="el" href="class_s_h_a512.html" title="SHA-512 message digest.">SHA512</a>, <a class="el" href="class_s_h_a3.html">SHA-3</a>, <a class="el" href="class_s_m3.html" title="SM3 hash function.">SM3</a>, <a class="el" href="class_tiger.html" title="Tiger message digest.">Tiger</a>, <a class="el" href="class_r_i_p_e_m_d160.html" title="RIPEMD-160 message digest.">RIPEMD160</a>, <a class="el" href="class_r_i_p_e_m_d320.html" title="RIPEMD-320 message digest.">RIPEMD320</a>, <a class="el" href="class_r_i_p_e_m_d128.html" title="RIPEMD-128 message digest.">RIPEMD128</a>, <a class="el" href="class_r_i_p_e_m_d256.html" title="RIPEMD-256 message digest.">RIPEMD256</a>, <a class="el" href="class_sip_hash.html" title="SipHash message authentication code.">SipHash</a>, <a class="el" href="class_whirlpool.html" title="Whirlpool message digest.">Whirlpool</a>, <a class="el" href="class_weak_1_1_m_d2.html" title="MD2 message digest.">Weak::MD2</a>, <a class="el" href="class_weak_1_1_m_d4.html" title="MD4">Weak::MD4</a>, <a class="el" href="class_weak_1_1_m_d5.html" title="MD5 message digest.">Weak::MD5</a> </dd>
<dt>Non-Cryptographic Checksums</dt>
<dd><a class="el" href="class_c_r_c32.html" title="CRC-32 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_b_l_a_k_e2b.html" title="The BLAKE2b cryptographic hash function.">BLAKE2b</a>, <a class="el" href="class_b_l_a_k_e2s.html" title="The BLAKE2s cryptographic hash function.">BLAKE2s</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 message authentication code.">CMAC</a>, <a class="el" href="class_d_m_a_c.html" title="DMAC message authentication code.">DMAC</a>, <a class="el" href="struct_g_c_m.html">GCM (GMAC)</a>, <a class="el" href="class_h_m_a_c.html" title="HMAC.">HMAC</a>, <a class="el" href="class_poly1305.html" title="Poly1305 message authentication code.">Poly1305</a>, <a class="el" href="class_t_t_m_a_c.html" title="Two-Track-MAC message authentication code.">TTMAC</a>, <a class="el" href="class_v_m_a_c.html" title="VMAC message authentication code.">VMAC</a> </dd>
<dt>Random Number Generators</dt>
<dd><a class="el" href="cryptlib_8h.html#a1e53479a6d427158247ac1ece3161a6d" title="Random Number Generator that does not produce random numbers.">NullRNG()</a>, <a class="el" href="class_l_c___r_n_g.html" title="Linear Congruential Generator (LCG)">LC_RNG</a>, <a class="el" href="class_random_pool.html" title="Randomness Pool based on AES-256.">RandomPool</a>, <a class="el" href="class_blocking_rng.html" title="Wrapper class for /dev/random and /dev/srandom.">BlockingRng</a>, <a class="el" href="class_nonblocking_rng.html" title="Wrapper class for /dev/random and /dev/srandom.">NonblockingRng</a>, <a class="el" href="class_auto_seeded_random_pool.html" title="Automatically Seeded Randomness Pool.">AutoSeededRandomPool</a>, <a class="el" href="class_auto_seeded_x917_r_n_g.html" title="Automatically Seeded X9.17 RNG.">AutoSeededX917RNG</a>, NIST <a class="el" href="class_hash___d_r_b_g.html" title="Hash_DRBG from SP 800-90A Rev 1 (June 2015)">Hash_DRBG</a> and <a class="el" href="class_h_m_a_c___d_r_b_g.html" title="HMAC_DRBG from SP 800-90A Rev 1 (June 2015)">HMAC_DRBG</a>, <a class="el" href="class_mersenne_twister.html">MersenneTwister (MT19937 and MT19937-AR)</a>, <a class="el" href="class_r_d_r_a_n_d.html" title="Hardware generated random numbers using RDRAND instruction.">RDRAND</a>, <a class="el" href="class_r_d_s_e_e_d.html" title="Hardware generated random numbers using RDSEED instruction.">RDSEED</a> </dd>
<dt>Key Derivation and Password-based Cryptography</dt>
<dd><a class="el" href="class_h_k_d_f.html" title="Extract-and-Expand Key Derivation Function (HKDF)">HKDF</a>, <a class="el" href="class_p_k_c_s12___p_b_k_d_f.html">PBKDF (PKCS #12)</a>, <a class="el" href="class_p_k_c_s5___p_b_k_d_f1.html">PBKDF-1 (PKCS #5)</a>, <a class="el" href="class_p_k_c_s5___p_b_k_d_f2___h_m_a_c.html">PBKDF-2/HMAC (PKCS #5)</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.">DLIES</a>, <a class="el" href="struct_e_c_i_e_s.html" title="Elliptic Curve Integrated Encryption Scheme.">ECIES</a>, <a class="el" href="struct_l_u_c_e_s.html" title="LUC encryption scheme.">LUCES</a>, <a class="el" href="struct_r_s_a_e_s.html" title="RSA encryption algorithm.">RSAES</a>, <a class="el" href="struct_rabin_e_s.html" title="Rabin encryption scheme.">RabinES</a>, <a class="el" href="struct_l_u_c___i_e_s.html" title="LUC Integrated Encryption Scheme.">LUC_IES</a> </dd>
<dt>Public Key Signature Schemes</dt>
<dd><a class="el" href="class_d_s_a2.html" title="DSA signature scheme.">DSA2</a>, <a class="el" href="struct_g_d_s_a.html" title="DSA signature scheme.">GDSA</a>, <a class="el" href="struct_e_c_d_s_a.html" title="Elliptic Curve DSA (ECDSA) signature scheme.">ECDSA</a>, <a class="el" href="struct_n_r.html" title="NR signature scheme.">NR</a>, <a class="el" href="struct_e_c_n_r.html" title="Elliptic Curve NR (ECNR) signature scheme.">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 algorithm.">RSASS</a>, <a class="el" href="struct_r_s_a_s_s___i_s_o.html" title="RSA signature algorithm.">RSASS_ISO</a>, <a class="el" href="struct_rabin_s_s.html" title="Rabin signature scheme.">RabinSS</a>, <a class="el" href="struct_r_w_s_s.html" title="Rabin-Williams signature scheme.">RWSS</a>, <a class="el" href="struct_e_s_i_g_n.html" title="ESIGN signature scheme, IEEE P1363a.">ESIGN</a> </dd>
<dt>Key Agreement</dt>
<dd><a class="el" href="struct_d_h.html" title="Diffie-Hellman in GF(p)">DH</a>, <a class="el" href="class_d_h2.html" title="Unified Diffie-Hellman in GF(p)">DH2</a>, <a class="el" href="class_m_q_v___domain.html">MQV</a>, <a class="el" href="class_h_m_q_v___domain.html">HMQV</a>, <a class="el" href="class_f_h_m_q_v___domain.html">FHMQV</a>, <a class="el" href="struct_e_c_d_h.html" title="Elliptic Curve Diffie-Hellman.">ECDH</a>, <a class="el" href="struct_e_c_m_q_v.html" title="Elliptic Curve Menezes-Qu-Vanstone.">ECMQV</a>, <a class="el" href="struct_e_c_h_m_q_v.html" title="Hashed Elliptic Curve Menezes-Qu-Vanstone.">ECHMQV</a>, <a class="el" href="struct_e_c_f_h_m_q_v.html" title="Fully Hashed Elliptic Curve Menezes-Qu-Vanstone.">ECFHMQV</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 with arithmetic operations.">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="Performs modular arithmetic 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="Shamir's Secret Sharing Algorithm.">SecretSharing</a>, <a class="el" href="class_secret_recovery.html" title="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="Rabin's Information Dispersal Algorithm.">InformationRecovery</a> </dd>
<dt>Compression</dt>
<dd><a class="el" href="class_deflator.html" title="DEFLATE compressor (RFC 1951)">Deflator</a>, <a class="el" href="class_inflator.html" title="DEFLATE decompressor (RFC 1951)">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="Implementation of BufferedTransformation's attachment interface.">Source</a> Classes</dt>
<dd><a class="el" href="class_string_source.html" title="String-based implementation of the Source interface.">StringSource</a>, <a class="el" href="class_array_source.html" title="Pointer-based implementation of the Source interface.">ArraySource</a>, <a class="el" href="class_file_source.html" title="Implementation of Store 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="Implementation of BufferedTransformation's attachment interface.">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_string_sink.html" title="Append input to a string object.">StringSink</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="Implementation of Store 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="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.">StreamTransformationFilter</a>, <a class="el" href="class_authenticated_encryption_filter.html" title="Filter wrapper for encrypting with AuthenticatedSymmetricCipher.">AuthenticatedEncryptionFilter</a>, <a class="el" href="class_authenticated_decryption_filter.html" title="Filter wrapper for decrypting with AuthenticatedSymmetricCipher.">AuthenticatedDecryptionFilter</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 encodes data using DUDE.">Base64Encoder</a>, <a class="el" href="class_base64_decoder.html" title="Base64 decodes data using DUDE.">Base64Decoder</a>, <a class="el" href="class_base64_u_r_l_encoder.html" title="Base64 encodes data using a web safe alphabet.">Base64URLEncoder</a>, <a class="el" href="class_base64_u_r_l_decoder.html" title="Base64 decodes data using a web safe alphabet.">Base64URLDecoder</a>, <a class="el" href="class_base32_encoder.html" title="Base32 encodes data using DUDE encoding.">Base32Encoder</a>, <a class="el" href="class_base32_decoder.html" title="Base32 decodes data using DUDE encoding.">Base32Decoder</a> </dd>
<dt>Wrappers for OS features</dt>
<dd><p class="startdd"><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></p>
<p class="enddd"></p>
</dd>
</dl>
<p>This reference manual is a work in progress. Some classes lack 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 us started on the manual. </p>
</div></div><!-- PageDoc -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 27 2019 15:04:51 for Crypto++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
17f48c047155a7d4c992d6a672acd57f
>
files
>
2402
