<!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++: iterhash.h Source File</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="headertitle">
<div class="title">iterhash.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// iterhash.h - originally written and placed in the public domain by Wei Dai</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor">#ifndef CRYPTOPP_ITERHASH_H</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#define CRYPTOPP_ITERHASH_H</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include "<a class="code" href="cryptlib_8h.html">cryptlib.h</a>"</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "<a class="code" href="secblock_8h.html">secblock.h</a>"</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "<a class="code" href="misc_8h.html">misc.h</a>"</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "<a class="code" href="simple_8h.html">simple.h</a>"</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#if CRYPTOPP_MSC_VERSION</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"># pragma warning(push)</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor"># pragma warning(disable: 4231 4275)</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor"># if (CRYPTOPP_MSC_VERSION >= 1400)</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor"># pragma warning(disable: 6011 6386 28193)</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor"># endif</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// GCC cast warning</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define HashWordPtr(x) ((HashWordType*)(void*)(x))</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define ConstHashWordPtr(x) ((const HashWordType*)(const void*)(x))</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> NAMESPACE_BEGIN(<a class="code" href="namespace_crypto_p_p.html">CryptoPP</a>)</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/// \brief Exception thrown when trying to hash more data than is allowed by a hash function</span></div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="class_hash_input_too_long.html"> 26</a></span> <span class="comment"></span>class CRYPTOPP_DLL <a class="code" href="class_hash_input_too_long.html">HashInputTooLong</a> : public <a class="code" href="class_invalid_data_format.html">InvalidDataFormat</a></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keyword">explicit</span> <a class="code" href="class_hash_input_too_long.html">HashInputTooLong</a>(<span class="keyword">const</span> std::string &alg)</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  : <a class="code" href="class_invalid_data_format.html">InvalidDataFormat</a>(<span class="stringliteral">"IteratedHashBase: input data exceeds maximum allowed by hash function "</span> + alg) {}</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> };</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">/// \brief Iterated hash base class</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">/// \tparam T Hash word type</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">/// \tparam BASE HashTransformation derived class</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/// \details IteratedHashBase provides an interface for block-based iterated hashes</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">/// \sa HashTransformation, MessageAuthenticationCode</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> T, <span class="keyword">class</span> BASE></div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="class_iterated_hash_base.html"> 39</a></span> <span class="keyword">class </span>CRYPTOPP_NO_VTABLE <a class="code" href="class_iterated_hash_base.html">IteratedHashBase</a> : <span class="keyword">public</span> BASE</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">typedef</span> T HashWordType;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"></span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> /// \brief Construct an IteratedHashBase</span></div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="class_iterated_hash_base.html#a301ef0d2c6dae2b250cdf9075c0e5f92"> 45</a></span> <span class="comment"></span> <a class="code" href="class_iterated_hash_base.html#a301ef0d2c6dae2b250cdf9075c0e5f92">IteratedHashBase</a>() : m_countLo(0), m_countHi(0) {}</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"></span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> /// \brief Provides the input block size most efficient for this cipher.</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> /// \return The input block size that is most efficient for the cipher</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> /// \details The base class implementation returns MandatoryBlockSize().</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> /// \note Optimal input length is</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> /// <tt>n * OptimalBlockSize() - GetOptimalBlockSizeUsed()</tt> for any <tt>n > 0</tt>.</span></div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="class_iterated_hash_base.html#a4c3fa4d29ad29d2b8add76ea62117523"> 52</a></span> <span class="comment"></span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="class_iterated_hash_base.html#a4c3fa4d29ad29d2b8add76ea62117523">OptimalBlockSize</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> this-><a class="code" href="namespace_name.html#aa93e40d0259a59959d270e6c82a9f1eb">BlockSize</a>();}</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"></span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> /// \brief Provides input and output data alignment for optimal performance.</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> /// \return the input data alignment that provides optimal performance</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> /// \details OptimalDataAlignment returns the natural alignment of the hash word.</span></div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="class_iterated_hash_base.html#a167fbaf6c7e6f9f1744d7204cf118c65"> 57</a></span> <span class="comment"></span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="class_iterated_hash_base.html#a167fbaf6c7e6f9f1744d7204cf118c65">OptimalDataAlignment</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> GetAlignmentOf<T>();}</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"></span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> /// \brief Updates a hash with additional input</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> /// \param input the additional input as a buffer</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> /// \param length the size of the buffer, in bytes</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"></span> <span class="keywordtype">void</span> Update(<span class="keyword">const</span> byte *input, <span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"></span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> /// \brief Requests space which can be written into by the caller</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> /// \param size the requested size of the buffer</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> /// \details The purpose of this method is to help avoid extra memory allocations.</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> /// \details size is an \a IN and \a OUT parameter and used as a hint. When the call is made,</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> /// size is the requested size of the buffer. When the call returns, size is the size of</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> /// the array returned to the caller.</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> /// \details The base class implementation sets size to 0 and returns NULL.</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> /// \note Some objects, like ArraySink, cannot create a space because its fixed.</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"></span> byte * CreateUpdateSpace(<span class="keywordtype">size_t</span> &size);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"></span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> /// \brief Restart the hash</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> /// \details Discards the current state, and restart for a new message</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"></span> <span class="keywordtype">void</span> Restart();</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"></span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> /// \brief Computes the hash of the current message</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> /// \param digest a pointer to the buffer to receive the hash</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> /// \param digestSize the size of the truncated digest, in bytes</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> /// \details TruncatedFinal() call Final() and then copies digestSize bytes to digest.</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> /// The hash is restarted the hash for the next message.</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"></span> <span class="keywordtype">void</span> TruncatedFinal(byte *digest, <span class="keywordtype">size_t</span> digestSize);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">inline</span> T GetBitCountHi()<span class="keyword"> const </span>{<span class="keywordflow">return</span> (m_countLo >> (8*<span class="keyword">sizeof</span>(T)-3)) + (m_countHi << 3);}</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">inline</span> T GetBitCountLo()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_countLo << 3;}</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">void</span> PadLastBlock(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> lastBlockSize, byte padFirst=0x80);</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Init() =0;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">virtual</span> <a class="code" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> GetByteOrder() <span class="keyword">const</span> =0;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> HashEndianCorrectedBlock(<span class="keyword">const</span> HashWordType *data) =0;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> HashMultipleBlocks(<span class="keyword">const</span> T *input, <span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">void</span> HashBlock(<span class="keyword">const</span> HashWordType *input) {HashMultipleBlocks(input, this-><a class="code" href="namespace_name.html#aa93e40d0259a59959d270e6c82a9f1eb">BlockSize</a>());}</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">virtual</span> T* DataBuf() =0;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">virtual</span> T* StateBuf() =0;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  T m_countLo, m_countHi;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> };</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"></span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment">/// \brief Iterated hash base class</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment">/// \tparam T_HashWordType Hash word type</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">/// \tparam T_Endianness Endianness type of hash</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment">/// \tparam T_BlockSize Block size of the hash</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment">/// \tparam T_Base HashTransformation derived class</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment">/// \details IteratedHash provides a default implementation for block-based iterated hashes</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment">/// \sa HashTransformation, MessageAuthenticationCode</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> T_HashWordType, <span class="keyword">class</span> T_Endianness, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> T_BlockSize, <span class="keyword">class</span> T_Base = HashTransformation></div><div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="class_iterated_hash.html"> 112</a></span> <span class="keyword">class </span>CRYPTOPP_NO_VTABLE <a class="code" href="class_iterated_hash.html">IteratedHash</a> : <span class="keyword">public</span> <a class="code" href="class_iterated_hash_base.html">IteratedHashBase</a><T_HashWordType, T_Base></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> {</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">typedef</span> T_Endianness ByteOrderClass;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keyword">typedef</span> T_HashWordType HashWordType;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  CRYPTOPP_CONSTANT(BLOCKSIZE = T_BlockSize)</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="comment">// BCB2006 workaround: can't use BLOCKSIZE here</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <a class="code" href="misc_8h.html#a6b378b1b9b2d4654cc852c088742ba70">CRYPTOPP_COMPILE_ASSERT</a>((T_BlockSize & (T_BlockSize - 1)) == 0); <span class="comment">// blockSize is a power of 2</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_iterated_hash.html">IteratedHash</a>() {}</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"></span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> /// \brief Provides the block size of the hash</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> /// \return the block size of the hash, in bytes</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> /// \details BlockSize() returns <tt>T_BlockSize</tt>.</span></div><div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="class_iterated_hash.html#a76cb174a108aa1178e444681c0d8c2ff"> 127</a></span> <span class="comment"></span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="class_iterated_hash.html#a76cb174a108aa1178e444681c0d8c2ff">BlockSize</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> T_BlockSize;}</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"></span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> /// \brief Provides the byte order of the hash</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> /// \returns the byte order of the hash as an enumeration</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> /// \details GetByteOrder() returns <tt>T_Endianness::ToEnum()</tt>.</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> /// \sa ByteOrder()</span></div><div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="class_iterated_hash.html#a26df02878f3fa09146154f9d6eaba1a4"> 133</a></span> <span class="comment"></span> <a class="code" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> <a class="code" href="class_iterated_hash.html#a26df02878f3fa09146154f9d6eaba1a4">GetByteOrder</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> T_Endianness::ToEnum();}</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"></span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> /// \brief Adjusts the byte ordering of the hash</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> /// \param out the output buffer</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> /// \param in the input buffer</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> /// \param byteCount the size of the buffers, in bytes</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> /// \details CorrectEndianess() calls ConditionalByteReverse() using <tt>T_Endianness</tt>.</span></div><div class="line"><a name="l00140"></a><span class="lineno"><a class="line" href="class_iterated_hash.html#a367c073a215b32e121cf5a4b2d0b96ad"> 140</a></span> <span class="comment"></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="class_iterated_hash.html#a367c073a215b32e121cf5a4b2d0b96ad">CorrectEndianess</a>(HashWordType *out, <span class="keyword">const</span> HashWordType *in, <span class="keywordtype">size_t</span> byteCount)</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  {</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <a class="code" href="misc_8h.html#a8e499ded4f2e7e7705c3cfd39cdf137f">ConditionalByteReverse</a>(T_Endianness::ToEnum(), out, in, byteCount);</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  }</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  T_HashWordType* DataBuf() {<span class="keywordflow">return</span> this->m_data;}</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <a class="code" href="class_fixed_size_sec_block.html">FixedSizeSecBlock</a><T_HashWordType, T_BlockSize/<span class="keyword">sizeof</span>(T_HashWordType)> m_data;</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> };</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"></span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment">/// \brief Iterated hash with a static transformation function</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment">/// \tparam T_HashWordType Hash word type</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment">/// \tparam T_Endianness Endianness type of hash</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment">/// \tparam T_BlockSize Block size of the hash</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment">/// \tparam T_StateSize Internal state size of the hash</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment">/// \tparam T_Transform HashTransformation derived class</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment">/// \tparam T_DigestSize Digest size of the hash</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment">/// \tparam T_StateAligned Flag indicating if state is 16-byte aligned</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment">/// \sa HashTransformation, MessageAuthenticationCode</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> T_HashWordType, <span class="keyword">class</span> T_Endianness, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> T_BlockSize, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> T_StateSize, <span class="keyword">class</span> T_Transform, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> T_DigestSize = 0, <span class="keywordtype">bool</span> T_StateAligned = false></div><div class="line"><a name="l00160"></a><span class="lineno"><a class="line" href="class_iterated_hash_with_static_transform.html"> 160</a></span> <span class="keyword">class </span>CRYPTOPP_NO_VTABLE <a class="code" href="class_iterated_hash_with_static_transform.html">IteratedHashWithStaticTransform</a></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  : <span class="keyword">public</span> <a class="code" href="class_clonable_impl.html">ClonableImpl</a><T_Transform, AlgorithmImpl<IteratedHash<T_HashWordType, T_Endianness, T_BlockSize>, T_Transform> ></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> {</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  CRYPTOPP_CONSTANT(DIGESTSIZE = T_DigestSize ? T_DigestSize : T_StateSize)</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_iterated_hash_with_static_transform.html">IteratedHashWithStaticTransform</a>() {}</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"></span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> /// \brief Provides the digest size of the hash</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> /// \return the digest size of the hash, in bytes</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> /// \details DigestSize() returns <tt>DIGESTSIZE</tt>.</span></div><div class="line"><a name="l00171"></a><span class="lineno"><a class="line" href="class_iterated_hash_with_static_transform.html#a97705945f072fc8f9ba7cfc6193b8f5a"> 171</a></span> <span class="comment"></span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="class_iterated_hash_with_static_transform.html#a97705945f072fc8f9ba7cfc6193b8f5a">DigestSize</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> DIGESTSIZE;};</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <a class="code" href="class_iterated_hash_with_static_transform.html">IteratedHashWithStaticTransform</a>() {this->Init();}</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <span class="keywordtype">void</span> HashEndianCorrectedBlock(<span class="keyword">const</span> T_HashWordType *data) {T_Transform::Transform(this->m_state, data);}</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  <span class="keywordtype">void</span> Init() {T_Transform::InitState(this->m_state);}</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> </div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  T_HashWordType* StateBuf() {<span class="keywordflow">return</span> this->m_state;}</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <a class="code" href="class_fixed_size_aligned_sec_block.html">FixedSizeAlignedSecBlock</a><T_HashWordType, T_BlockSize/<span class="keyword">sizeof</span>(T_HashWordType), T_StateAligned> m_state;</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> };</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="preprocessor">#if !defined(__GNUC__) && !defined(__clang__)</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  CRYPTOPP_DLL_TEMPLATE_CLASS <a class="code" href="class_iterated_hash_base.html">IteratedHashBase<word64, HashTransformation></a>;</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  CRYPTOPP_STATIC_TEMPLATE_CLASS <a class="code" href="class_iterated_hash_base.html">IteratedHashBase<word64, MessageAuthenticationCode></a>;</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  CRYPTOPP_DLL_TEMPLATE_CLASS <a class="code" href="class_iterated_hash_base.html">IteratedHashBase<word32, HashTransformation></a>;</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  CRYPTOPP_STATIC_TEMPLATE_CLASS <a class="code" href="class_iterated_hash_base.html">IteratedHashBase<word32, MessageAuthenticationCode></a>;</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> NAMESPACE_END</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> </div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="preprocessor">#if CRYPTOPP_MSC_VERSION</span></div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="preprocessor"># pragma warning(pop)</span></div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> </div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_iterated_hash_base_html_a301ef0d2c6dae2b250cdf9075c0e5f92"><div class="ttname"><a href="class_iterated_hash_base.html#a301ef0d2c6dae2b250cdf9075c0e5f92">IteratedHashBase::IteratedHashBase</a></div><div class="ttdeci">IteratedHashBase()</div><div class="ttdoc">Construct an IteratedHashBase. </div><div class="ttdef"><b>Definition:</b> <a href="iterhash_8h_source.html#l00045">iterhash.h:45</a></div></div>
<div class="ttc" id="simple_8h_html"><div class="ttname"><a href="simple_8h.html">simple.h</a></div><div class="ttdoc">Classes providing basic library services. </div></div>
<div class="ttc" id="misc_8h_html"><div class="ttname"><a href="misc_8h.html">misc.h</a></div><div class="ttdoc">Utility functions for the Crypto++ library. </div></div>
<div class="ttc" id="cryptlib_8h_html_aaeb92d42f5a6e27b8ba19f18d69d142b"><div class="ttname"><a href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a></div><div class="ttdeci">ByteOrder</div><div class="ttdoc">Provides the byte ordering. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00140">cryptlib.h:140</a></div></div>
<div class="ttc" id="class_clonable_impl_html"><div class="ttname"><a href="class_clonable_impl.html">ClonableImpl</a></div><div class="ttdoc">Base class for identifying alogorithm. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00025">simple.h:25</a></div></div>
<div class="ttc" id="class_iterated_hash_with_static_transform_html"><div class="ttname"><a href="class_iterated_hash_with_static_transform.html">IteratedHashWithStaticTransform</a></div><div class="ttdoc">Iterated hash with a static transformation function. </div><div class="ttdef"><b>Definition:</b> <a href="iterhash_8h_source.html#l00160">iterhash.h:160</a></div></div>
<div class="ttc" id="cryptlib_8h_html"><div class="ttname"><a href="cryptlib_8h.html">cryptlib.h</a></div><div class="ttdoc">Abstract base classes that provide a uniform interface to this library. </div></div>
<div class="ttc" id="class_iterated_hash_html_a76cb174a108aa1178e444681c0d8c2ff"><div class="ttname"><a href="class_iterated_hash.html#a76cb174a108aa1178e444681c0d8c2ff">IteratedHash::BlockSize</a></div><div class="ttdeci">unsigned int BlockSize() const</div><div class="ttdoc">Provides the block size of the hash. </div><div class="ttdef"><b>Definition:</b> <a href="iterhash_8h_source.html#l00127">iterhash.h:127</a></div></div>
<div class="ttc" id="class_hash_input_too_long_html"><div class="ttname"><a href="class_hash_input_too_long.html">HashInputTooLong</a></div><div class="ttdoc">Exception thrown when trying to hash more data than is allowed by a hash function. </div><div class="ttdef"><b>Definition:</b> <a href="iterhash_8h_source.html#l00026">iterhash.h:26</a></div></div>
<div class="ttc" id="secblock_8h_html"><div class="ttname"><a href="secblock_8h.html">secblock.h</a></div><div class="ttdoc">Classes and functions for secure memory allocations. </div></div>
<div class="ttc" id="class_iterated_hash_html_a26df02878f3fa09146154f9d6eaba1a4"><div class="ttname"><a href="class_iterated_hash.html#a26df02878f3fa09146154f9d6eaba1a4">IteratedHash::GetByteOrder</a></div><div class="ttdeci">ByteOrder GetByteOrder() const</div><div class="ttdoc">Provides the byte order of the hash. </div><div class="ttdef"><b>Definition:</b> <a href="iterhash_8h_source.html#l00133">iterhash.h:133</a></div></div>
<div class="ttc" id="misc_8h_html_a6b378b1b9b2d4654cc852c088742ba70"><div class="ttname"><a href="misc_8h.html#a6b378b1b9b2d4654cc852c088742ba70">CRYPTOPP_COMPILE_ASSERT</a></div><div class="ttdeci">#define CRYPTOPP_COMPILE_ASSERT(expr)</div><div class="ttdoc">Compile time assertion. </div><div class="ttdef"><b>Definition:</b> <a href="misc_8h_source.html#l00144">misc.h:144</a></div></div>
<div class="ttc" id="misc_8h_html_a8e499ded4f2e7e7705c3cfd39cdf137f"><div class="ttname"><a href="misc_8h.html#a8e499ded4f2e7e7705c3cfd39cdf137f">ConditionalByteReverse</a></div><div class="ttdeci">T ConditionalByteReverse(ByteOrder order, T value)</div><div class="ttdoc">Reverses bytes in a value depending upon endianness. </div><div class="ttdef"><b>Definition:</b> <a href="misc_8h_source.html#l01979">misc.h:1979</a></div></div>
<div class="ttc" id="class_fixed_size_aligned_sec_block_html"><div class="ttname"><a href="class_fixed_size_aligned_sec_block.html">FixedSizeAlignedSecBlock</a></div><div class="ttdoc">Fixed size stack-based SecBlock with 16-byte alignment. </div><div class="ttdef"><b>Definition:</b> <a href="secblock_8h_source.html#l00853">secblock.h:853</a></div></div>
<div class="ttc" id="class_iterated_hash_html_a367c073a215b32e121cf5a4b2d0b96ad"><div class="ttname"><a href="class_iterated_hash.html#a367c073a215b32e121cf5a4b2d0b96ad">IteratedHash::CorrectEndianess</a></div><div class="ttdeci">void CorrectEndianess(HashWordType *out, const HashWordType *in, size_t byteCount)</div><div class="ttdoc">Adjusts the byte ordering of the hash. </div><div class="ttdef"><b>Definition:</b> <a href="iterhash_8h_source.html#l00140">iterhash.h:140</a></div></div>
<div class="ttc" id="class_iterated_hash_with_static_transform_html_a97705945f072fc8f9ba7cfc6193b8f5a"><div class="ttname"><a href="class_iterated_hash_with_static_transform.html#a97705945f072fc8f9ba7cfc6193b8f5a">IteratedHashWithStaticTransform::DigestSize</a></div><div class="ttdeci">unsigned int DigestSize() const</div><div class="ttdoc">Provides the digest size of the hash. </div><div class="ttdef"><b>Definition:</b> <a href="iterhash_8h_source.html#l00171">iterhash.h:171</a></div></div>
<div class="ttc" id="class_fixed_size_sec_block_html"><div class="ttname"><a href="class_fixed_size_sec_block.html">FixedSizeSecBlock</a></div><div class="ttdoc">Fixed size stack-based SecBlock. </div><div class="ttdef"><b>Definition:</b> <a href="secblock_8h_source.html#l00841">secblock.h:841</a></div></div>
<div class="ttc" id="namespace_name_html_aa93e40d0259a59959d270e6c82a9f1eb"><div class="ttname"><a href="namespace_name.html#aa93e40d0259a59959d270e6c82a9f1eb">Name::BlockSize</a></div><div class="ttdeci">const char * BlockSize()</div><div class="ttdoc">int, in bytes </div><div class="ttdef"><b>Definition:</b> <a href="argnames_8h_source.html#l00027">argnames.h:27</a></div></div>
<div class="ttc" id="class_iterated_hash_base_html_a4c3fa4d29ad29d2b8add76ea62117523"><div class="ttname"><a href="class_iterated_hash_base.html#a4c3fa4d29ad29d2b8add76ea62117523">IteratedHashBase::OptimalBlockSize</a></div><div class="ttdeci">unsigned int OptimalBlockSize() const</div><div class="ttdoc">Provides the input block size most efficient for this cipher. </div><div class="ttdef"><b>Definition:</b> <a href="iterhash_8h_source.html#l00052">iterhash.h:52</a></div></div>
<div class="ttc" id="class_iterated_hash_base_html_a167fbaf6c7e6f9f1744d7204cf118c65"><div class="ttname"><a href="class_iterated_hash_base.html#a167fbaf6c7e6f9f1744d7204cf118c65">IteratedHashBase::OptimalDataAlignment</a></div><div class="ttdeci">unsigned int OptimalDataAlignment() const</div><div class="ttdoc">Provides input and output data alignment for optimal performance. </div><div class="ttdef"><b>Definition:</b> <a href="iterhash_8h_source.html#l00057">iterhash.h:57</a></div></div>
<div class="ttc" id="class_iterated_hash_base_html"><div class="ttname"><a href="class_iterated_hash_base.html">IteratedHashBase</a></div><div class="ttdoc">Iterated hash base class. </div><div class="ttdef"><b>Definition:</b> <a href="iterhash_8h_source.html#l00039">iterhash.h:39</a></div></div>
<div class="ttc" id="class_iterated_hash_html"><div class="ttname"><a href="class_iterated_hash.html">IteratedHash</a></div><div class="ttdoc">Iterated hash base class. </div><div class="ttdef"><b>Definition:</b> <a href="iterhash_8h_source.html#l00112">iterhash.h:112</a></div></div>
<div class="ttc" id="namespace_crypto_p_p_html"><div class="ttname"><a href="namespace_crypto_p_p.html">CryptoPP</a></div><div class="ttdoc">Crypto++ library namespace. </div></div>
<div class="ttc" id="class_invalid_data_format_html"><div class="ttname"><a href="class_invalid_data_format.html">InvalidDataFormat</a></div><div class="ttdoc">Input data was received that did not conform to expected format. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00206">cryptlib.h:206</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 16 2018 07:57:55 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
>
2407
