<!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++: Keccak 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="#pub-static-methods">Static Public Member Functions</a> |
<a href="class_keccak-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Keccak Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="class_keccak.html" title="Keccak message digest base class. ">Keccak</a> message digest base class.
<a href="class_keccak.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 Keccak:</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_keccak.png" usemap="#Keccak_map" alt=""/>
<map id="Keccak_map" name="Keccak_map">
<area href="class_hash_transformation.html" title="Interface for hash functions and data processing part of MACs. " alt="HashTransformation" shape="rect" coords="0,112,186,136"/>
<area href="class_algorithm.html" title="Interface for all crypto algorithms. " alt="Algorithm" shape="rect" coords="0,56,186,80"/>
<area href="class_clonable.html" title="Interface for cloning objects. " alt="Clonable" shape="rect" coords="0,0,186,24"/>
<area href="class_keccak___final.html" title="Keccak message digest template. " alt="Keccak_Final< T_DigestSize >" shape="rect" coords="0,224,186,248"/>
</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:a280221957dcabf511e23a0002bb7b5f7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_keccak.html#a280221957dcabf511e23a0002bb7b5f7">Keccak</a> (unsigned int digestSize)</td></tr>
<tr class="memdesc:a280221957dcabf511e23a0002bb7b5f7"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="class_keccak.html" title="Keccak message digest base class. ">Keccak</a>. <a href="#a280221957dcabf511e23a0002bb7b5f7">More...</a><br /></td></tr>
<tr class="separator:a280221957dcabf511e23a0002bb7b5f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a24075bc16b4600d30959841c0d6c5b2a"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_keccak.html#a24075bc16b4600d30959841c0d6c5b2a">DigestSize</a> () const</td></tr>
<tr class="memdesc:a24075bc16b4600d30959841c0d6c5b2a"><td class="mdescLeft"> </td><td class="mdescRight">Provides the digest size of the hash. <a href="#a24075bc16b4600d30959841c0d6c5b2a">More...</a><br /></td></tr>
<tr class="separator:a24075bc16b4600d30959841c0d6c5b2a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99b4bd31b9a422923c693042285bcc64"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_keccak.html#a99b4bd31b9a422923c693042285bcc64">AlgorithmName</a> () const</td></tr>
<tr class="memdesc:a99b4bd31b9a422923c693042285bcc64"><td class="mdescLeft"> </td><td class="mdescRight">Provides the name of this algorithm. <a href="#a99b4bd31b9a422923c693042285bcc64">More...</a><br /></td></tr>
<tr class="separator:a99b4bd31b9a422923c693042285bcc64"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abf8c68ac5978cb79fe6454535f00d3ea"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_keccak.html#abf8c68ac5978cb79fe6454535f00d3ea">OptimalDataAlignment</a> () const</td></tr>
<tr class="memdesc:abf8c68ac5978cb79fe6454535f00d3ea"><td class="mdescLeft"> </td><td class="mdescRight">Provides input and output data alignment for optimal performance. <a href="#abf8c68ac5978cb79fe6454535f00d3ea">More...</a><br /></td></tr>
<tr class="separator:abf8c68ac5978cb79fe6454535f00d3ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a873cf34ada4ddc8bf0d14452fc233589"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_keccak.html#a873cf34ada4ddc8bf0d14452fc233589">Update</a> (const byte *input, size_t length)</td></tr>
<tr class="memdesc:a873cf34ada4ddc8bf0d14452fc233589"><td class="mdescLeft"> </td><td class="mdescRight">Updates a hash with additional input. <a href="#a873cf34ada4ddc8bf0d14452fc233589">More...</a><br /></td></tr>
<tr class="separator:a873cf34ada4ddc8bf0d14452fc233589"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a58059090416c1cb266dbf7df7e74e685"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_keccak.html#a58059090416c1cb266dbf7df7e74e685">Restart</a> ()</td></tr>
<tr class="memdesc:a58059090416c1cb266dbf7df7e74e685"><td class="mdescLeft"> </td><td class="mdescRight">Restart the hash. <a href="#a58059090416c1cb266dbf7df7e74e685">More...</a><br /></td></tr>
<tr class="separator:a58059090416c1cb266dbf7df7e74e685"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b084325a2333fe1019b988113828f57"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_keccak.html#a0b084325a2333fe1019b988113828f57">TruncatedFinal</a> (byte *hash, size_t size)</td></tr>
<tr class="memdesc:a0b084325a2333fe1019b988113828f57"><td class="mdescLeft"> </td><td class="mdescRight">Computes the hash of the current message. <a href="#a0b084325a2333fe1019b988113828f57">More...</a><br /></td></tr>
<tr class="separator:a0b084325a2333fe1019b988113828f57"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_hash_transformation"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_hash_transformation')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_hash_transformation.html">HashTransformation</a></td></tr>
<tr class="memitem:a39b0a4c4cdc11fda358f9975b5e4137e inherit pub_methods_class_hash_transformation"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_hash_transformation.html">HashTransformation</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_hash_transformation.html#a39b0a4c4cdc11fda358f9975b5e4137e">Ref</a> ()</td></tr>
<tr class="memdesc:a39b0a4c4cdc11fda358f9975b5e4137e inherit pub_methods_class_hash_transformation"><td class="mdescLeft"> </td><td class="mdescRight">Provides a reference to this object. <a href="class_hash_transformation.html#a39b0a4c4cdc11fda358f9975b5e4137e">More...</a><br /></td></tr>
<tr class="separator:a39b0a4c4cdc11fda358f9975b5e4137e inherit pub_methods_class_hash_transformation"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9fc0b332ef36900ca6ea5d949e95aba1 inherit pub_methods_class_hash_transformation"><td class="memItemLeft" align="right" valign="top">virtual byte * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_hash_transformation.html#a9fc0b332ef36900ca6ea5d949e95aba1">CreateUpdateSpace</a> (size_t &size)</td></tr>
<tr class="memdesc:a9fc0b332ef36900ca6ea5d949e95aba1 inherit pub_methods_class_hash_transformation"><td class="mdescLeft"> </td><td class="mdescRight">Request space which can be written into by the caller. <a href="class_hash_transformation.html#a9fc0b332ef36900ca6ea5d949e95aba1">More...</a><br /></td></tr>
<tr class="separator:a9fc0b332ef36900ca6ea5d949e95aba1 inherit pub_methods_class_hash_transformation"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa0b8c7a110d8968268fd02ec32b9a8e8 inherit pub_methods_class_hash_transformation"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_hash_transformation.html#aa0b8c7a110d8968268fd02ec32b9a8e8">Final</a> (byte *digest)</td></tr>
<tr class="memdesc:aa0b8c7a110d8968268fd02ec32b9a8e8 inherit pub_methods_class_hash_transformation"><td class="mdescLeft"> </td><td class="mdescRight">Computes the hash of the current message. <a href="class_hash_transformation.html#aa0b8c7a110d8968268fd02ec32b9a8e8">More...</a><br /></td></tr>
<tr class="separator:aa0b8c7a110d8968268fd02ec32b9a8e8 inherit pub_methods_class_hash_transformation"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af68588a8333e11066a0da91506cebbb4 inherit pub_methods_class_hash_transformation"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_hash_transformation.html#af68588a8333e11066a0da91506cebbb4">TagSize</a> () const</td></tr>
<tr class="memdesc:af68588a8333e11066a0da91506cebbb4 inherit pub_methods_class_hash_transformation"><td class="mdescLeft"> </td><td class="mdescRight">Provides the tag size of the hash. <a href="class_hash_transformation.html#af68588a8333e11066a0da91506cebbb4">More...</a><br /></td></tr>
<tr class="separator:af68588a8333e11066a0da91506cebbb4 inherit pub_methods_class_hash_transformation"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a09c66b86bbe3c13ea9e8d74775696d42 inherit pub_methods_class_hash_transformation"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_hash_transformation.html#a09c66b86bbe3c13ea9e8d74775696d42">BlockSize</a> () const</td></tr>
<tr class="memdesc:a09c66b86bbe3c13ea9e8d74775696d42 inherit pub_methods_class_hash_transformation"><td class="mdescLeft"> </td><td class="mdescRight">Provides the block size of the compression function. <a href="class_hash_transformation.html#a09c66b86bbe3c13ea9e8d74775696d42">More...</a><br /></td></tr>
<tr class="separator:a09c66b86bbe3c13ea9e8d74775696d42 inherit pub_methods_class_hash_transformation"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee97908d965930ee454f7a88b0ff0f71 inherit pub_methods_class_hash_transformation"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_hash_transformation.html#aee97908d965930ee454f7a88b0ff0f71">OptimalBlockSize</a> () const</td></tr>
<tr class="memdesc:aee97908d965930ee454f7a88b0ff0f71 inherit pub_methods_class_hash_transformation"><td class="mdescLeft"> </td><td class="mdescRight">Provides the input block size most efficient for this hash. <a href="class_hash_transformation.html#aee97908d965930ee454f7a88b0ff0f71">More...</a><br /></td></tr>
<tr class="separator:aee97908d965930ee454f7a88b0ff0f71 inherit pub_methods_class_hash_transformation"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8124c4fca23b74bbdc43660bdae692c inherit pub_methods_class_hash_transformation"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_hash_transformation.html#af8124c4fca23b74bbdc43660bdae692c">CalculateDigest</a> (byte *digest, const byte *input, size_t length)</td></tr>
<tr class="memdesc:af8124c4fca23b74bbdc43660bdae692c inherit pub_methods_class_hash_transformation"><td class="mdescLeft"> </td><td class="mdescRight">Updates the hash with additional input and computes the hash of the current message. <a href="class_hash_transformation.html#af8124c4fca23b74bbdc43660bdae692c">More...</a><br /></td></tr>
<tr class="separator:af8124c4fca23b74bbdc43660bdae692c inherit pub_methods_class_hash_transformation"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a16c4aecd047015d513feef4ed5b929ba inherit pub_methods_class_hash_transformation"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_hash_transformation.html#a16c4aecd047015d513feef4ed5b929ba">Verify</a> (const byte *digest)</td></tr>
<tr class="memdesc:a16c4aecd047015d513feef4ed5b929ba inherit pub_methods_class_hash_transformation"><td class="mdescLeft"> </td><td class="mdescRight">Verifies the hash of the current message. <a href="class_hash_transformation.html#a16c4aecd047015d513feef4ed5b929ba">More...</a><br /></td></tr>
<tr class="separator:a16c4aecd047015d513feef4ed5b929ba inherit pub_methods_class_hash_transformation"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acad96df68e70d922683e5063057130b2 inherit pub_methods_class_hash_transformation"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_hash_transformation.html#acad96df68e70d922683e5063057130b2">VerifyDigest</a> (const byte *digest, const byte *input, size_t length)</td></tr>
<tr class="memdesc:acad96df68e70d922683e5063057130b2 inherit pub_methods_class_hash_transformation"><td class="mdescLeft"> </td><td class="mdescRight">Updates the hash with additional input and verifies the hash of the current message. <a href="class_hash_transformation.html#acad96df68e70d922683e5063057130b2">More...</a><br /></td></tr>
<tr class="separator:acad96df68e70d922683e5063057130b2 inherit pub_methods_class_hash_transformation"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b6917657eaec935750fd83e28270d76 inherit pub_methods_class_hash_transformation"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_hash_transformation.html#a0b6917657eaec935750fd83e28270d76">CalculateTruncatedDigest</a> (byte *digest, size_t digestSize, const byte *input, size_t length)</td></tr>
<tr class="memdesc:a0b6917657eaec935750fd83e28270d76 inherit pub_methods_class_hash_transformation"><td class="mdescLeft"> </td><td class="mdescRight">Updates the hash with additional input and computes the hash of the current message. <a href="class_hash_transformation.html#a0b6917657eaec935750fd83e28270d76">More...</a><br /></td></tr>
<tr class="separator:a0b6917657eaec935750fd83e28270d76 inherit pub_methods_class_hash_transformation"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0f6069eadf492d970c3eb8cdf656e742 inherit pub_methods_class_hash_transformation"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_hash_transformation.html#a0f6069eadf492d970c3eb8cdf656e742">TruncatedVerify</a> (const byte *digest, size_t digestLength)</td></tr>
<tr class="memdesc:a0f6069eadf492d970c3eb8cdf656e742 inherit pub_methods_class_hash_transformation"><td class="mdescLeft"> </td><td class="mdescRight">Verifies the hash of the current message. <a href="class_hash_transformation.html#a0f6069eadf492d970c3eb8cdf656e742">More...</a><br /></td></tr>
<tr class="separator:a0f6069eadf492d970c3eb8cdf656e742 inherit pub_methods_class_hash_transformation"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7958e99717019e8b9f91672bdfe9e086 inherit pub_methods_class_hash_transformation"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_hash_transformation.html#a7958e99717019e8b9f91672bdfe9e086">VerifyTruncatedDigest</a> (const byte *digest, size_t digestLength, const byte *input, size_t length)</td></tr>
<tr class="memdesc:a7958e99717019e8b9f91672bdfe9e086 inherit pub_methods_class_hash_transformation"><td class="mdescLeft"> </td><td class="mdescRight">Updates the hash with additional input and verifies the hash of the current message. <a href="class_hash_transformation.html#a7958e99717019e8b9f91672bdfe9e086">More...</a><br /></td></tr>
<tr class="separator:a7958e99717019e8b9f91672bdfe9e086 inherit pub_methods_class_hash_transformation"><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="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><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a213c6a3fc530849fd6860df905cafed7"><td class="memItemLeft" align="right" valign="top"><a id="a213c6a3fc530849fd6860df905cafed7"></a>
static const char * </td><td class="memItemRight" valign="bottom"><b>StaticAlgorithmName</b> ()</td></tr>
<tr class="separator:a213c6a3fc530849fd6860df905cafed7"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="class_keccak.html" title="Keccak message digest base class. ">Keccak</a> message digest base class. </p>
<p>The Crypto++ <a class="el" href="class_keccak.html" title="Keccak message digest base class. ">Keccak</a> implementation uses F1600 with XOF d=0x01. FIPS 202 conformance (XOF d=0x06) is available in <a class="el" href="class_s_h_a3.html" title="SHA3 message digest base class. ">SHA3</a> classes.</p>
<p><a class="el" href="class_keccak.html" title="Keccak message digest base class. ">Keccak</a> is the base class for Keccak_224, Keccak_256, Keccak_384 and Keccak_512. Library users should instantiate a derived class, and only use <a class="el" href="class_keccak.html" title="Keccak message digest base class. ">Keccak</a> as a base class reference or pointer.</p>
<p><a class="el" href="class_keccak.html" title="Keccak message digest base class. ">Keccak</a> will likely change in the future to accommodate extensibility of the round function and the XOF functions.</p>
<p>Perform the following to specify a different digest size. The class will use F1600, XOF d=0x01, and a new vaue for <code>r()</code> (which will be <code>200-2*24 = 152</code>). </p><pre> Keccack_192 : public Keccack
{
public:
CRYPTOPP_CONSTANT(DIGESTSIZE = 24)
Keccack_192() : Keccack(DIGESTSIZE) {}
};
</pre><dl class="section see"><dt>See also</dt><dd><a class="el" href="class_s_h_a3.html" title="SHA3 message digest base class. ">SHA3</a>, <a class="el" href="keccak_8h.html#a6ec8053b635cae2f01b9462093d5aa89" title="Keccak-224 message digest. ">Keccak_224</a>, <a class="el" href="keccak_8h.html#aadbe50b383f9efd5bf7bb072e9553648" title="Keccak-256 message digest. ">Keccak_256</a>, <a class="el" href="keccak_8h.html#a19cf66c84e2ec033afbd4afd7d7eb799" title="Keccak-384 message digest. ">Keccak_384</a> and <a class="el" href="keccak_8h.html#a4525acd75510cf423fa949ad9dc206e8" title="Keccak-512 message digest. ">Keccak_512</a>. </dd></dl>
<dl class="section since"><dt>Since</dt><dd>Crypto++ 5.6.4 </dd></dl>
<p class="definition">Definition at line <a class="el" href="keccak_8h_source.html#l00040">40</a> of file <a class="el" href="keccak_8h_source.html">keccak.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a280221957dcabf511e23a0002bb7b5f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a280221957dcabf511e23a0002bb7b5f7">◆ </a></span>Keccak()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Keccak::Keccak </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>digestSize</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>Construct a <a class="el" href="class_keccak.html" title="Keccak message digest base class. ">Keccak</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">digestSize</td><td>the digest size, in bytes</td></tr>
</table>
</dd>
</dl>
<p><a class="el" href="class_keccak.html" title="Keccak message digest base class. ">Keccak</a> is the base class for Keccak_224, Keccak_256, Keccak_384 and Keccak_512. Library users should instantiate a derived class, and only use <a class="el" href="class_keccak.html" title="Keccak message digest base class. ">Keccak</a> as a base class reference or pointer. </p><dl class="section since"><dt>Since</dt><dd>Crypto++ 5.6.4 </dd></dl>
<p class="definition">Definition at line <a class="el" href="keccak_8h_source.html#l00049">49</a> of file <a class="el" href="keccak_8h_source.html">keccak.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a24075bc16b4600d30959841c0d6c5b2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24075bc16b4600d30959841c0d6c5b2a">◆ </a></span>DigestSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int Keccak::DigestSize </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>Provides the digest size of the hash. </p>
<dl class="section return"><dt>Returns</dt><dd>the digest size of the hash. </dd></dl>
<p>Implements <a class="el" href="class_hash_transformation.html#a9f42cc280bac76b884ad12615c0dabb5">HashTransformation</a>.</p>
<p class="definition">Definition at line <a class="el" href="keccak_8h_source.html#l00050">50</a> of file <a class="el" href="keccak_8h_source.html">keccak.h</a>.</p>
</div>
</div>
<a id="a99b4bd31b9a422923c693042285bcc64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99b4bd31b9a422923c693042285bcc64">◆ </a></span>AlgorithmName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string Keccak::AlgorithmName </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>Provides the name of this algorithm. </p>
<dl class="section return"><dt>Returns</dt><dd>the standard algorithm name</dd></dl>
<p>The standard algorithm name can be a name like <em><a class="el" href="class_a_e_s.html" title="AES block cipher (Rijndael) ">AES</a></em> or <em>AES/GCM</em>. Some algorithms do not have standard names yet. For example, there is no standard algorithm name for Shoup's <a class="el" href="struct_e_c_i_e_s.html" title="Elliptic Curve Integrated Encryption Scheme. ">ECIES</a>. </p><dl class="section note"><dt>Note</dt><dd>AlgorithmName is not universally implemented yet </dd></dl>
<p>Reimplemented from <a class="el" href="class_algorithm.html#a4f31510a192d1121856efe8ad0a9b844">Algorithm</a>.</p>
<p class="definition">Definition at line <a class="el" href="keccak_8h_source.html#l00051">51</a> of file <a class="el" href="keccak_8h_source.html">keccak.h</a>.</p>
</div>
</div>
<a id="abf8c68ac5978cb79fe6454535f00d3ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf8c68ac5978cb79fe6454535f00d3ea">◆ </a></span>OptimalDataAlignment()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int Keccak::OptimalDataAlignment </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>Provides input and output data alignment for optimal performance. </p>
<dl class="section return"><dt>Returns</dt><dd>the input data alignment that provides optimal performance </dd></dl>
<dl class="section see"><dt>See also</dt><dd>GetAlignment() and <a class="el" href="class_hash_transformation.html#aee97908d965930ee454f7a88b0ff0f71" title="Provides the input block size most efficient for this hash. ">OptimalBlockSize()</a> </dd></dl>
<p>Reimplemented from <a class="el" href="class_hash_transformation.html#a927a808007503246a745a564ad451da5">HashTransformation</a>.</p>
<p class="definition">Definition at line <a class="el" href="keccak_8h_source.html#l00053">53</a> of file <a class="el" href="keccak_8h_source.html">keccak.h</a>.</p>
</div>
</div>
<a id="a873cf34ada4ddc8bf0d14452fc233589"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a873cf34ada4ddc8bf0d14452fc233589">◆ </a></span>Update()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Keccak::Update </td>
<td>(</td>
<td class="paramtype">const byte * </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>length</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Updates a hash with additional input. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">input</td><td>the additional input as a buffer </td></tr>
<tr><td class="paramname">length</td><td>the size of the buffer, in bytes </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="class_hash_transformation.html#aafabefaf445b65d3ba0d8e1c0294afe5">HashTransformation</a>.</p>
<p class="definition">Definition at line <a class="el" href="keccak_8cpp_source.html#l00252">252</a> of file <a class="el" href="keccak_8cpp_source.html">keccak.cpp</a>.</p>
</div>
</div>
<a id="a58059090416c1cb266dbf7df7e74e685"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58059090416c1cb266dbf7df7e74e685">◆ </a></span>Restart()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Keccak::Restart </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Restart the hash. </p>
<p>Discards the current state, and restart for a new message </p>
<p>Reimplemented from <a class="el" href="class_hash_transformation.html#a92752eebac10497211d7a065faba8725">HashTransformation</a>.</p>
<p class="definition">Definition at line <a class="el" href="keccak_8cpp_source.html#l00273">273</a> of file <a class="el" href="keccak_8cpp_source.html">keccak.cpp</a>.</p>
</div>
</div>
<a id="a0b084325a2333fe1019b988113828f57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b084325a2333fe1019b988113828f57">◆ </a></span>TruncatedFinal()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Keccak::TruncatedFinal </td>
<td>(</td>
<td class="paramtype">byte * </td>
<td class="paramname"><em>digest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>digestSize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Computes the hash of the current message. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">digest</td><td>a pointer to the buffer to receive the hash </td></tr>
<tr><td class="paramname">digestSize</td><td>the size of the truncated digest, in bytes</td></tr>
</table>
</dd>
</dl>
<p><a class="el" href="class_keccak.html#a0b084325a2333fe1019b988113828f57" title="Computes the hash of the current message. ">TruncatedFinal()</a> call <a class="el" href="class_hash_transformation.html#aa0b8c7a110d8968268fd02ec32b9a8e8" title="Computes the hash of the current message. ">Final()</a> and then copies digestSize bytes to digest. The hash is restarted the hash for the next message. </p>
<p>Implements <a class="el" href="class_hash_transformation.html#a590ecda344aa0fb045abf42ec08823b2">HashTransformation</a>.</p>
<p class="definition">Definition at line <a class="el" href="keccak_8cpp_source.html#l00279">279</a> of file <a class="el" href="keccak_8cpp_source.html">keccak.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="keccak_8h_source.html">keccak.h</a></li>
<li><a class="el" href="keccak_8cpp_source.html">keccak.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 16 2018 07:58:41 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
>
1168
