<!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++: MessageAuthenticationCodeFinal< BASE > Class Template 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="class_message_authentication_code_final-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">MessageAuthenticationCodeFinal< BASE > Class Template Reference</div> </div> </div><!--header--> <div class="contents"> <p>Provides class member functions to key a message authentication code. <a href="class_message_authentication_code_final.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 MessageAuthenticationCodeFinal< BASE >:</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_message_authentication_code_final.png" usemap="#MessageAuthenticationCodeFinal_3C_20BASE_20_3E_map" alt=""/> <map id="MessageAuthenticationCodeFinal_3C_20BASE_20_3E_map" name="MessageAuthenticationCodeFinal_3C_20BASE_20_3E_map"> <area href="class_clonable_impl.html" alt="ClonableImpl< MessageAuthenticationCodeFinal< BASE >, MessageAuthenticationCodeImpl< BASE > >" shape="rect" coords="0,224,603,248"/> <area href="class_message_authentication_code_impl.html" alt="MessageAuthenticationCodeImpl< BASE >" shape="rect" coords="0,168,603,192"/> <area href="class_algorithm_impl.html" alt="AlgorithmImpl< SimpleKeyingInterfaceImpl< BASE, BASE >, BASE >" shape="rect" coords="0,112,603,136"/> <area href="class_simple_keying_interface_impl.html" alt="SimpleKeyingInterfaceImpl< BASE, BASE >" shape="rect" coords="0,56,603,80"/> </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:aef7b8842df0ebaae4fdfd9ccd9585f2a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_message_authentication_code_final.html#aef7b8842df0ebaae4fdfd9ccd9585f2a">MessageAuthenticationCodeFinal</a> ()</td></tr> <tr class="memdesc:aef7b8842df0ebaae4fdfd9ccd9585f2a"><td class="mdescLeft"> </td><td class="mdescRight">Construct a default <a class="el" href="class_message_authentication_code_final.html" title="Provides class member functions to key a message authentication code. ">MessageAuthenticationCodeFinal</a>. <a href="#aef7b8842df0ebaae4fdfd9ccd9585f2a">More...</a><br /></td></tr> <tr class="separator:aef7b8842df0ebaae4fdfd9ccd9585f2a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a41d2c1ac0470912e22d99ba8f397781f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_message_authentication_code_final.html#a41d2c1ac0470912e22d99ba8f397781f">MessageAuthenticationCodeFinal</a> (const byte *key)</td></tr> <tr class="memdesc:a41d2c1ac0470912e22d99ba8f397781f"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="class_block_cipher_final.html" title="Provides class member functions to key a block cipher. ">BlockCipherFinal</a>. <a href="#a41d2c1ac0470912e22d99ba8f397781f">More...</a><br /></td></tr> <tr class="separator:a41d2c1ac0470912e22d99ba8f397781f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a39ffff70fea0a92cbe8943a1f11cdb78"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_message_authentication_code_final.html#a39ffff70fea0a92cbe8943a1f11cdb78">MessageAuthenticationCodeFinal</a> (const byte *key, size_t length)</td></tr> <tr class="memdesc:a39ffff70fea0a92cbe8943a1f11cdb78"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="class_block_cipher_final.html" title="Provides class member functions to key a block cipher. ">BlockCipherFinal</a>. <a href="#a39ffff70fea0a92cbe8943a1f11cdb78">More...</a><br /></td></tr> <tr class="separator:a39ffff70fea0a92cbe8943a1f11cdb78"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_class_clonable_impl"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_clonable_impl')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_clonable_impl.html">ClonableImpl< MessageAuthenticationCodeFinal< BASE >, MessageAuthenticationCodeImpl< BASE > ></a></td></tr> <tr class="memitem:a7de60f1498b0a1a0b0a4bde4ddf969bd inherit pub_methods_class_clonable_impl"><td class="memItemLeft" align="right" valign="top"><a id="a7de60f1498b0a1a0b0a4bde4ddf969bd"></a> <a class="el" href="class_clonable.html">Clonable</a> * </td><td class="memItemRight" valign="bottom"><b>Clone</b> () const</td></tr> <tr class="separator:a7de60f1498b0a1a0b0a4bde4ddf969bd inherit pub_methods_class_clonable_impl"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_class_algorithm_impl"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_algorithm_impl')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_algorithm_impl.html">AlgorithmImpl< SimpleKeyingInterfaceImpl< BASE, BASE >, BASE ></a></td></tr> <tr class="memitem:abd1b02bf6cda820fa6cc56ea5a9eac20 inherit pub_methods_class_algorithm_impl"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm_impl.html#abd1b02bf6cda820fa6cc56ea5a9eac20">AlgorithmName</a> () const</td></tr> <tr class="memdesc:abd1b02bf6cda820fa6cc56ea5a9eac20 inherit pub_methods_class_algorithm_impl"><td class="mdescLeft"> </td><td class="mdescRight">The algorithm name. <a href="class_algorithm_impl.html#abd1b02bf6cda820fa6cc56ea5a9eac20">More...</a><br /></td></tr> <tr class="separator:abd1b02bf6cda820fa6cc56ea5a9eac20 inherit pub_methods_class_algorithm_impl"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_class_simple_keying_interface_impl"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_simple_keying_interface_impl')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_simple_keying_interface_impl.html">SimpleKeyingInterfaceImpl< BASE, BASE ></a></td></tr> <tr class="memitem:af3e42c83041a26ffaef5e378e352caa0 inherit pub_methods_class_simple_keying_interface_impl"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface_impl.html#af3e42c83041a26ffaef5e378e352caa0">MinKeyLength</a> () const</td></tr> <tr class="memdesc:af3e42c83041a26ffaef5e378e352caa0 inherit pub_methods_class_simple_keying_interface_impl"><td class="mdescLeft"> </td><td class="mdescRight">The minimum key length used by the algorithm. <a href="class_simple_keying_interface_impl.html#af3e42c83041a26ffaef5e378e352caa0">More...</a><br /></td></tr> <tr class="separator:af3e42c83041a26ffaef5e378e352caa0 inherit pub_methods_class_simple_keying_interface_impl"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac72a5a82d8a5d9e19e18f7e146b35df4 inherit pub_methods_class_simple_keying_interface_impl"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface_impl.html#ac72a5a82d8a5d9e19e18f7e146b35df4">MaxKeyLength</a> () const</td></tr> <tr class="memdesc:ac72a5a82d8a5d9e19e18f7e146b35df4 inherit pub_methods_class_simple_keying_interface_impl"><td class="mdescLeft"> </td><td class="mdescRight">The maximum key length used by the algorithm. <a href="class_simple_keying_interface_impl.html#ac72a5a82d8a5d9e19e18f7e146b35df4">More...</a><br /></td></tr> <tr class="separator:ac72a5a82d8a5d9e19e18f7e146b35df4 inherit pub_methods_class_simple_keying_interface_impl"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a017e0545328286b51892a93f95aabf8e inherit pub_methods_class_simple_keying_interface_impl"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface_impl.html#a017e0545328286b51892a93f95aabf8e">DefaultKeyLength</a> () const</td></tr> <tr class="memdesc:a017e0545328286b51892a93f95aabf8e inherit pub_methods_class_simple_keying_interface_impl"><td class="mdescLeft"> </td><td class="mdescRight">The default key length used by the algorithm. <a href="class_simple_keying_interface_impl.html#a017e0545328286b51892a93f95aabf8e">More...</a><br /></td></tr> <tr class="separator:a017e0545328286b51892a93f95aabf8e inherit pub_methods_class_simple_keying_interface_impl"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5d2b23e29eb994631cf9e06f7ab36023 inherit pub_methods_class_simple_keying_interface_impl"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface_impl.html#a5d2b23e29eb994631cf9e06f7ab36023">GetValidKeyLength</a> (size_t keylength) const</td></tr> <tr class="memdesc:a5d2b23e29eb994631cf9e06f7ab36023 inherit pub_methods_class_simple_keying_interface_impl"><td class="mdescLeft"> </td><td class="mdescRight">Provides a valid key length for the algorithm. <a href="class_simple_keying_interface_impl.html#a5d2b23e29eb994631cf9e06f7ab36023">More...</a><br /></td></tr> <tr class="separator:a5d2b23e29eb994631cf9e06f7ab36023 inherit pub_methods_class_simple_keying_interface_impl"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af9e6ac5f39488b6a3f8220c539c6cfeb inherit pub_methods_class_simple_keying_interface_impl"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_simple_keying_interface.html#a88201c180fbfaa9fef2715252546ad6e">SimpleKeyingInterface::IV_Requirement</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface_impl.html#af9e6ac5f39488b6a3f8220c539c6cfeb">IVRequirement</a> () const</td></tr> <tr class="memdesc:af9e6ac5f39488b6a3f8220c539c6cfeb inherit pub_methods_class_simple_keying_interface_impl"><td class="mdescLeft"> </td><td class="mdescRight">The default IV requirements for the algorithm. <a href="class_simple_keying_interface_impl.html#af9e6ac5f39488b6a3f8220c539c6cfeb">More...</a><br /></td></tr> <tr class="separator:af9e6ac5f39488b6a3f8220c539c6cfeb inherit pub_methods_class_simple_keying_interface_impl"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acba54a012806e2b2d0f61c1aa64a3a25 inherit pub_methods_class_simple_keying_interface_impl"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface_impl.html#acba54a012806e2b2d0f61c1aa64a3a25">IVSize</a> () const</td></tr> <tr class="memdesc:acba54a012806e2b2d0f61c1aa64a3a25 inherit pub_methods_class_simple_keying_interface_impl"><td class="mdescLeft"> </td><td class="mdescRight">The default initialization vector length for the algorithm. <a href="class_simple_keying_interface_impl.html#acba54a012806e2b2d0f61c1aa64a3a25">More...</a><br /></td></tr> <tr class="separator:acba54a012806e2b2d0f61c1aa64a3a25 inherit pub_methods_class_simple_keying_interface_impl"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> Additional Inherited Members</h2></td></tr> <tr class="inherit_header pub_static_methods_class_algorithm_impl"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_class_algorithm_impl')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="class_algorithm_impl.html">AlgorithmImpl< SimpleKeyingInterfaceImpl< BASE, BASE >, BASE ></a></td></tr> <tr class="memitem:a4b388176a0c4853b2a3e747c5e637b95 inherit pub_static_methods_class_algorithm_impl"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm_impl.html#a4b388176a0c4853b2a3e747c5e637b95">StaticAlgorithmName</a> ()</td></tr> <tr class="memdesc:a4b388176a0c4853b2a3e747c5e637b95 inherit pub_static_methods_class_algorithm_impl"><td class="mdescLeft"> </td><td class="mdescRight">The algorithm name. <a href="class_algorithm_impl.html#a4b388176a0c4853b2a3e747c5e637b95">More...</a><br /></td></tr> <tr class="separator:a4b388176a0c4853b2a3e747c5e637b95 inherit pub_static_methods_class_algorithm_impl"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><h3>template<class BASE><br /> class MessageAuthenticationCodeFinal< BASE ></h3> <p>Provides class member functions to key a message authentication code. </p> <dl class="tparams"><dt>Template Parameters</dt><dd> <table class="tparams"> <tr><td class="paramname">BASE</td><td>a <a class="el" href="class_block_cipher_impl.html" title="Provides a base implementation of Algorithm and SimpleKeyingInterface for block ciphers. ">BlockCipherImpl</a> derived class</td></tr> </table> </dd> </dl> <p>A default implementation for <a class="el" href="class_message_authentication_code.html" title="Interface for message authentication codes. ">MessageAuthenticationCode</a> </p> <p class="definition">Definition at line <a class="el" href="seckey_8h_source.html#l00392">392</a> of file <a class="el" href="seckey_8h_source.html">seckey.h</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="aef7b8842df0ebaae4fdfd9ccd9585f2a"></a> <h2 class="memtitle"><span class="permalink"><a href="#aef7b8842df0ebaae4fdfd9ccd9585f2a">◆ </a></span>MessageAuthenticationCodeFinal() <span class="overload">[1/3]</span></h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class BASE> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_message_authentication_code_final.html">MessageAuthenticationCodeFinal</a>< BASE >::<a class="el" href="class_message_authentication_code_final.html">MessageAuthenticationCodeFinal</a> </td> <td>(</td> <td class="paramname"></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 default <a class="el" href="class_message_authentication_code_final.html" title="Provides class member functions to key a message authentication code. ">MessageAuthenticationCodeFinal</a>. </p> <p>The message authentication code is not keyed. </p> <p class="definition">Definition at line <a class="el" href="seckey_8h_source.html#l00397">397</a> of file <a class="el" href="seckey_8h_source.html">seckey.h</a>.</p> </div> </div> <a id="a41d2c1ac0470912e22d99ba8f397781f"></a> <h2 class="memtitle"><span class="permalink"><a href="#a41d2c1ac0470912e22d99ba8f397781f">◆ </a></span>MessageAuthenticationCodeFinal() <span class="overload">[2/3]</span></h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class BASE> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_message_authentication_code_final.html">MessageAuthenticationCodeFinal</a>< BASE >::<a class="el" href="class_message_authentication_code_final.html">MessageAuthenticationCodeFinal</a> </td> <td>(</td> <td class="paramtype">const byte * </td> <td class="paramname"><em>key</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_block_cipher_final.html" title="Provides class member functions to key a block cipher. ">BlockCipherFinal</a>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">key</td><td>a byte array used to key the algorithm</td></tr> </table> </dd> </dl> <p>key must be at least DEFAULT_KEYLENGTH in length. Internally, the function calls <a class="el" href="class_simple_keying_interface.html#adf3c29b3ef3af74788a58c7c49887fd7" title="Sets or reset the key of this object. ">SimpleKeyingInterface::SetKey</a>. </p> <p class="definition">Definition at line <a class="el" href="seckey_8h_source.html#l00402">402</a> of file <a class="el" href="seckey_8h_source.html">seckey.h</a>.</p> </div> </div> <a id="a39ffff70fea0a92cbe8943a1f11cdb78"></a> <h2 class="memtitle"><span class="permalink"><a href="#a39ffff70fea0a92cbe8943a1f11cdb78">◆ </a></span>MessageAuthenticationCodeFinal() <span class="overload">[3/3]</span></h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class BASE> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_message_authentication_code_final.html">MessageAuthenticationCodeFinal</a>< BASE >::<a class="el" href="class_message_authentication_code_final.html">MessageAuthenticationCodeFinal</a> </td> <td>(</td> <td class="paramtype">const byte * </td> <td class="paramname"><em>key</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">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Construct a <a class="el" href="class_block_cipher_final.html" title="Provides class member functions to key a block cipher. ">BlockCipherFinal</a>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">key</td><td>a byte array used to key the algorithm </td></tr> <tr><td class="paramname">length</td><td>the length of the byte array</td></tr> </table> </dd> </dl> <p>key must be at least DEFAULT_KEYLENGTH in length. Internally, the function calls <a class="el" href="class_simple_keying_interface.html#adf3c29b3ef3af74788a58c7c49887fd7" title="Sets or reset the key of this object. ">SimpleKeyingInterface::SetKey</a>. </p> <p class="definition">Definition at line <a class="el" href="seckey_8h_source.html#l00409">409</a> of file <a class="el" href="seckey_8h_source.html">seckey.h</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="seckey_8h_source.html">seckey.h</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Sun Sep 16 2018 07:58:43 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>