<!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++: hmac.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">hmac.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="hmac_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// hmac.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> <span class="comment"></span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">/// \file hmac.h</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/// \brief Classes for HMAC message authentication codes</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#ifndef CRYPTOPP_HMAC_H</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#define CRYPTOPP_HMAC_H</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "<a class="code" href="seckey_8h.html">seckey.h</a>"</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "<a class="code" href="secblock_8h.html">secblock.h</a>"</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> NAMESPACE_BEGIN(<a class="code" href="namespace_crypto_p_p.html">CryptoPP</a>)</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">/// \brief HMAC information</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span><span class="comment">/// \details HMAC_Base derives from VariableKeyLength and MessageAuthenticationCode</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"></span><span class="comment">/// \since Crypto++ 2.1</span></div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="class_h_m_a_c___base.html"> 17</a></span> <span class="comment"></span>class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE <a class="code" href="class_h_m_a_c___base.html">HMAC_Base</a> : public <a class="code" href="class_variable_key_length.html">VariableKeyLength</a><16, 0, INT_MAX>, public <a class="code" href="class_message_authentication_code.html">MessageAuthenticationCode</a></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="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> /// \brief Construct a HMAC_Base</span></div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="class_h_m_a_c___base.html#ab593233a7322a1e4cb3fb4d8b298742a"> 21</a></span> <span class="comment"></span> <a class="code" href="class_h_m_a_c___base.html#ab593233a7322a1e4cb3fb4d8b298742a">HMAC_Base</a>() : m_innerHashKeyed(false) {}</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keywordtype">void</span> UncheckedSetKey(<span class="keyword">const</span> byte *userKey, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> keylength, <span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &params);</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keywordtype">void</span> Restart();</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</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="l00026"></a><span class="lineno"> 26</span>  <span class="keywordtype">void</span> TruncatedFinal(byte *mac, <span class="keywordtype">size_t</span> size);</div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="class_h_m_a_c___base.html#a3f8a783fe1da496cf33bf35d6376100b"> 27</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="class_h_m_a_c___base.html#a3f8a783fe1da496cf33bf35d6376100b">OptimalBlockSize</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> <span class="keyword">const_cast<</span><a class="code" href="class_h_m_a_c___base.html">HMAC_Base</a>*<span class="keyword">></span>(<span class="keyword">this</span>)->AccessHash().<a class="code" href="class_h_m_a_c___base.html#a3f8a783fe1da496cf33bf35d6376100b">OptimalBlockSize</a>();}</div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="class_h_m_a_c___base.html#ac47c7569f590e0a2ff2339d058c3337d"> 28</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="class_h_m_a_c___base.html#ac47c7569f590e0a2ff2339d058c3337d">DigestSize</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> <span class="keyword">const_cast<</span><a class="code" href="class_h_m_a_c___base.html">HMAC_Base</a>*<span class="keyword">></span>(<span class="keyword">this</span>)->AccessHash().<a class="code" href="class_h_m_a_c___base.html#ac47c7569f590e0a2ff2339d058c3337d">DigestSize</a>();}</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keyword">virtual</span> <a class="code" href="class_hash_transformation.html">HashTransformation</a> & AccessHash() =0;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  byte * AccessIpad() {<span class="keywordflow">return</span> m_buf;}</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  byte * AccessOpad() {<span class="keywordflow">return</span> m_buf + AccessHash().<a class="code" href="class_hash_transformation.html#a09c66b86bbe3c13ea9e8d74775696d42">BlockSize</a>();}</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  byte * AccessInnerHash() {<span class="keywordflow">return</span> m_buf + 2*AccessHash().BlockSize();}</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordtype">void</span> KeyInnerHash();</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="class_sec_byte_block.html">SecByteBlock</a> m_buf;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">bool</span> m_innerHashKeyed;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> };</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"></span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">/// \brief HMAC</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">/// \tparam T HashTransformation derived class</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">/// \details HMAC derives from MessageAuthenticationCodeImpl. It calculates the HMAC using</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">/// <tt>HMAC(K, text) = H(K XOR opad, H(K XOR ipad, text))</tt>.</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">/// \sa <a href="http://www.weidai.com/scan-mirror/mac.html#HMAC">HMAC</a></span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">/// \since Crypto++ 2.1</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> T></div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="class_h_m_a_c.html"> 50</a></span> <span class="keyword">class </span><a class="code" href="class_h_m_a_c.html">HMAC</a> : <span class="keyword">public</span> <a class="code" href="class_message_authentication_code_impl.html">MessageAuthenticationCodeImpl</a><HMAC_Base, HMAC<T> ></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> {</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  CRYPTOPP_CONSTANT(DIGESTSIZE=T::DIGESTSIZE)</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  CRYPTOPP_CONSTANT(BLOCKSIZE=T::BLOCKSIZE)</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">/// \brief Construct a HMAC</span></div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="class_h_m_a_c.html#a8ca0d4c7d1a29cd46906f6384e2fe615"> 57</a></span> <span class="comment"></span> <a class="code" href="class_h_m_a_c.html">HMAC</a>() {}<span class="comment"></span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> /// \brief Construct a HMAC</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> /// \param key the HMAC key</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> /// \param length the size of the HMAC key</span></div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="class_h_m_a_c.html#a84d6e40e7e5798283afbf40cb77dd19d"> 61</a></span> <span class="comment"></span> <a class="code" href="class_h_m_a_c.html#a84d6e40e7e5798283afbf40cb77dd19d">HMAC</a>(<span class="keyword">const</span> byte *key, <span class="keywordtype">size_t</span> length=<a class="code" href="class_variable_key_length.html#a3788ee30b190bdc0c0e89d2721162614">HMAC_Base::DEFAULT_KEYLENGTH</a>)</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  {this-><a class="code" href="class_simple_keying_interface.html#adf3c29b3ef3af74788a58c7c49887fd7">SetKey</a>(key, length);}</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">static</span> std::string StaticAlgorithmName() {<span class="keywordflow">return</span> std::string(<span class="stringliteral">"HMAC("</span>) + T::StaticAlgorithmName() + <span class="stringliteral">")"</span>;}</div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="class_h_m_a_c.html#a9953ec5c13284a128ff177207ed5681b"> 65</a></span>  std::string <a class="code" href="class_h_m_a_c.html#a9953ec5c13284a128ff177207ed5681b">AlgorithmName</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> std::string(<span class="stringliteral">"HMAC("</span>) + m_hash.AlgorithmName() + <span class="stringliteral">")"</span>;}</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="class_hash_transformation.html">HashTransformation</a> & AccessHash() {<span class="keywordflow">return</span> m_hash;}</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  T m_hash;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> };</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> NAMESPACE_END</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_hash_transformation_html_a09c66b86bbe3c13ea9e8d74775696d42"><div class="ttname"><a href="class_hash_transformation.html#a09c66b86bbe3c13ea9e8d74775696d42">HashTransformation::BlockSize</a></div><div class="ttdeci">virtual unsigned int BlockSize() const</div><div class="ttdoc">Provides the block size of the compression function. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l01116">cryptlib.h:1116</a></div></div>
<div class="ttc" id="class_message_authentication_code_html"><div class="ttname"><a href="class_message_authentication_code.html">MessageAuthenticationCode</a></div><div class="ttdoc">Interface for message authentication codes. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l01245">cryptlib.h:1245</a></div></div>
<div class="ttc" id="class_h_m_a_c___base_html_ab593233a7322a1e4cb3fb4d8b298742a"><div class="ttname"><a href="class_h_m_a_c___base.html#ab593233a7322a1e4cb3fb4d8b298742a">HMAC_Base::HMAC_Base</a></div><div class="ttdeci">HMAC_Base()</div><div class="ttdoc">Construct a HMAC_Base. </div><div class="ttdef"><b>Definition:</b> <a href="hmac_8h_source.html#l00021">hmac.h:21</a></div></div>
<div class="ttc" id="class_simple_keying_interface_html_adf3c29b3ef3af74788a58c7c49887fd7"><div class="ttname"><a href="class_simple_keying_interface.html#adf3c29b3ef3af74788a58c7c49887fd7">SimpleKeyingInterface::SetKey</a></div><div class="ttdeci">virtual void SetKey(const byte *key, size_t length, const NameValuePairs &params=g_nullNameValuePairs)</div><div class="ttdoc">Sets or reset the key of this object. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8cpp_source.html#l00064">cryptlib.cpp:64</a></div></div>
<div class="ttc" id="class_h_m_a_c___base_html_ac47c7569f590e0a2ff2339d058c3337d"><div class="ttname"><a href="class_h_m_a_c___base.html#ac47c7569f590e0a2ff2339d058c3337d">HMAC_Base::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="hmac_8h_source.html#l00028">hmac.h:28</a></div></div>
<div class="ttc" id="class_sec_byte_block_html"><div class="ttname"><a href="class_sec_byte_block.html">SecByteBlock</a></div><div class="ttdoc">SecBlock<byte> typedef. </div><div class="ttdef"><b>Definition:</b> <a href="secblock_8h_source.html#l00822">secblock.h:822</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_h_m_a_c___base_html"><div class="ttname"><a href="class_h_m_a_c___base.html">HMAC_Base</a></div><div class="ttdoc">HMAC information. </div><div class="ttdef"><b>Definition:</b> <a href="hmac_8h_source.html#l00017">hmac.h:17</a></div></div>
<div class="ttc" id="seckey_8h_html"><div class="ttname"><a href="seckey_8h.html">seckey.h</a></div><div class="ttdoc">Classes and functions for implementing secret key algorithms. </div></div>
<div class="ttc" id="class_variable_key_length_html_a3788ee30b190bdc0c0e89d2721162614"><div class="ttname"><a href="class_variable_key_length.html#a3788ee30b190bdc0c0e89d2721162614">VariableKeyLength< 16, 0, INT_MAX >::DEFAULT_KEYLENGTH</a></div><div class="ttdeci">static const int DEFAULT_KEYLENGTH</div><div class="ttdoc">The default key length used by the algorithm provided as a constant. </div><div class="ttdef"><b>Definition:</b> <a href="seckey_8h_source.html#l00207">seckey.h:207</a></div></div>
<div class="ttc" id="class_h_m_a_c_html_a84d6e40e7e5798283afbf40cb77dd19d"><div class="ttname"><a href="class_h_m_a_c.html#a84d6e40e7e5798283afbf40cb77dd19d">HMAC::HMAC</a></div><div class="ttdeci">HMAC(const byte *key, size_t length=HMAC_Base::DEFAULT_KEYLENGTH)</div><div class="ttdoc">Construct a HMAC. </div><div class="ttdef"><b>Definition:</b> <a href="hmac_8h_source.html#l00061">hmac.h:61</a></div></div>
<div class="ttc" id="class_message_authentication_code_impl_html"><div class="ttname"><a href="class_message_authentication_code_impl.html">MessageAuthenticationCodeImpl</a></div><div class="ttdoc">Provides a base implementation of Algorithm and SimpleKeyingInterface for message authentication code...</div><div class="ttdef"><b>Definition:</b> <a href="seckey_8h_source.html#l00384">seckey.h:384</a></div></div>
<div class="ttc" id="class_h_m_a_c_html_a9953ec5c13284a128ff177207ed5681b"><div class="ttname"><a href="class_h_m_a_c.html#a9953ec5c13284a128ff177207ed5681b">HMAC::AlgorithmName</a></div><div class="ttdeci">std::string AlgorithmName() const</div><div class="ttdoc">Provides the name of this algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="hmac_8h_source.html#l00065">hmac.h:65</a></div></div>
<div class="ttc" id="class_h_m_a_c___base_html_a3f8a783fe1da496cf33bf35d6376100b"><div class="ttname"><a href="class_h_m_a_c___base.html#a3f8a783fe1da496cf33bf35d6376100b">HMAC_Base::OptimalBlockSize</a></div><div class="ttdeci">unsigned int OptimalBlockSize() const</div><div class="ttdoc">Provides the input block size most efficient for this hash. </div><div class="ttdef"><b>Definition:</b> <a href="hmac_8h_source.html#l00027">hmac.h:27</a></div></div>
<div class="ttc" id="class_variable_key_length_html"><div class="ttname"><a href="class_variable_key_length.html">VariableKeyLength</a></div><div class="ttdoc">Inherited by keyed algorithms with variable key length. </div><div class="ttdef"><b>Definition:</b> <a href="seckey_8h_source.html#l00188">seckey.h:188</a></div></div>
<div class="ttc" id="class_h_m_a_c_html"><div class="ttname"><a href="class_h_m_a_c.html">HMAC</a></div><div class="ttdoc">HMAC. </div><div class="ttdef"><b>Definition:</b> <a href="hmac_8h_source.html#l00050">hmac.h:50</a></div></div>
<div class="ttc" id="class_hash_transformation_html"><div class="ttname"><a href="class_hash_transformation.html">HashTransformation</a></div><div class="ttdoc">Interface for hash functions and data processing part of MACs. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l01065">cryptlib.h:1065</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_name_value_pairs_html"><div class="ttname"><a href="class_name_value_pairs.html">NameValuePairs</a></div><div class="ttdoc">Interface for retrieving values given their names. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00290">cryptlib.h:290</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:53 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
>
2388
