<!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.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>mbed TLS v2.7.6: cmac.h File 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">mbed TLS v2.7.6 </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.13 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> $(function() { initMenu('',false,false,'search.php','Search'); }); </script> <div id="main-nav"></div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b4d146e9a6d8dd56ed4afb2480a97fd3.html">mbedtls</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#nested-classes">Data Structures</a> | <a href="#define-members">Macros</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">cmac.h File Reference</div> </div> </div><!--header--> <div class="contents"> <p>The Cipher-based Message Authentication Code (CMAC) Mode for Authentication. <a href="#details">More...</a></p> <div class="textblock"><code>#include "<a class="el" href="cipher_8h_source.html">cipher.h</a>"</code><br /> </div><div class="textblock"><div class="dynheader"> Include dependency graph for cmac.h:</div> <div class="dyncontent"> <div class="center"><img src="cmac_8h__incl.png" border="0" usemap="#cmac_8h" alt=""/></div> <map name="cmac_8h" id="cmac_8h"> <area shape="rect" id="node2" href="cipher_8h.html" title="The generic cipher wrapper. " alt="" coords="98,80,201,107"/> <area shape="rect" id="node3" href="config_8h.html" title="Configuration options (set of defines) " alt="" coords="35,155,138,181"/> <area shape="rect" id="node4" href="check__config_8h.html" title="Consistency checks for configuration options. " alt="" coords="5,229,168,256"/> </map> </div> </div> <p><a href="cmac_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Data Structures</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmbedtls__cmac__context__t.html">mbedtls_cmac_context_t</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> <tr class="memitem:ac1f7e31cddacee936b40c41e4eb525da"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmac_8h.html#ac1f7e31cddacee936b40c41e4eb525da">MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED</a>   -0x007A</td></tr> <tr class="separator:ac1f7e31cddacee936b40c41e4eb525da"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5c776e34150416e27f28a6a03da68f0e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmac_8h.html#a5c776e34150416e27f28a6a03da68f0e">MBEDTLS_AES_BLOCK_SIZE</a>   16</td></tr> <tr class="separator:a5c776e34150416e27f28a6a03da68f0e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa884d76e1c27c156a788a4763f571c67"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmac_8h.html#aa884d76e1c27c156a788a4763f571c67">MBEDTLS_DES3_BLOCK_SIZE</a>   8</td></tr> <tr class="separator:aa884d76e1c27c156a788a4763f571c67"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:accb84fb7db8f619f0fdf8ef1ee7552af"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmac_8h.html#accb84fb7db8f619f0fdf8ef1ee7552af">MBEDTLS_CIPHER_BLKSIZE_MAX</a>   16 /* The longest block used by CMAC is that of AES. */</td></tr> <tr class="separator:accb84fb7db8f619f0fdf8ef1ee7552af"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:ae5835d528bbfec2ae2452ba4617469b8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="cmac_8h.html#ae5835d528bbfec2ae2452ba4617469b8">mbedtls_cipher_cmac_starts</a> (<a class="el" href="structmbedtls__cipher__context__t.html">mbedtls_cipher_context_t</a> *ctx, const unsigned char *key, size_t keybits)</td></tr> <tr class="memdesc:ae5835d528bbfec2ae2452ba4617469b8"><td class="mdescLeft"> </td><td class="mdescRight">This function sets the CMAC key, and prepares to authenticate the input data. Must be called with an initialized cipher context. <a href="#ae5835d528bbfec2ae2452ba4617469b8">More...</a><br /></td></tr> <tr class="separator:ae5835d528bbfec2ae2452ba4617469b8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a14441964606982e0a664a8bb48bddad6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="cmac_8h.html#a14441964606982e0a664a8bb48bddad6">mbedtls_cipher_cmac_update</a> (<a class="el" href="structmbedtls__cipher__context__t.html">mbedtls_cipher_context_t</a> *ctx, const unsigned char *input, size_t ilen)</td></tr> <tr class="memdesc:a14441964606982e0a664a8bb48bddad6"><td class="mdescLeft"> </td><td class="mdescRight">This function feeds an input buffer into an ongoing CMAC computation. <a href="#a14441964606982e0a664a8bb48bddad6">More...</a><br /></td></tr> <tr class="separator:a14441964606982e0a664a8bb48bddad6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9adc5b4b09b40d41bb6554c8ecfa755d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="cmac_8h.html#a9adc5b4b09b40d41bb6554c8ecfa755d">mbedtls_cipher_cmac_finish</a> (<a class="el" href="structmbedtls__cipher__context__t.html">mbedtls_cipher_context_t</a> *ctx, unsigned char *output)</td></tr> <tr class="memdesc:a9adc5b4b09b40d41bb6554c8ecfa755d"><td class="mdescLeft"> </td><td class="mdescRight">This function finishes the CMAC operation, and writes the result to the output buffer. <a href="#a9adc5b4b09b40d41bb6554c8ecfa755d">More...</a><br /></td></tr> <tr class="separator:a9adc5b4b09b40d41bb6554c8ecfa755d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a364af1a9ac845cbf21d7a64f1f43c71a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="cmac_8h.html#a364af1a9ac845cbf21d7a64f1f43c71a">mbedtls_cipher_cmac_reset</a> (<a class="el" href="structmbedtls__cipher__context__t.html">mbedtls_cipher_context_t</a> *ctx)</td></tr> <tr class="memdesc:a364af1a9ac845cbf21d7a64f1f43c71a"><td class="mdescLeft"> </td><td class="mdescRight">This function prepares the authentication of another message with the same key as the previous CMAC operation. <a href="#a364af1a9ac845cbf21d7a64f1f43c71a">More...</a><br /></td></tr> <tr class="separator:a364af1a9ac845cbf21d7a64f1f43c71a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af44bc935db9b27fbfe485936b5ad99ed"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="cmac_8h.html#af44bc935db9b27fbfe485936b5ad99ed">mbedtls_cipher_cmac</a> (const <a class="el" href="structmbedtls__cipher__info__t.html">mbedtls_cipher_info_t</a> *cipher_info, const unsigned char *key, size_t keylen, const unsigned char *input, size_t ilen, unsigned char *output)</td></tr> <tr class="memdesc:af44bc935db9b27fbfe485936b5ad99ed"><td class="mdescLeft"> </td><td class="mdescRight">This function calculates the full generic CMAC on the input buffer with the provided key. <a href="#af44bc935db9b27fbfe485936b5ad99ed">More...</a><br /></td></tr> <tr class="separator:af44bc935db9b27fbfe485936b5ad99ed"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad9ef677703a2837a50382dcbcc544cc6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="cmac_8h.html#ad9ef677703a2837a50382dcbcc544cc6">mbedtls_aes_cmac_prf_128</a> (const unsigned char *key, size_t key_len, const unsigned char *input, size_t in_len, unsigned char output[16])</td></tr> <tr class="memdesc:ad9ef677703a2837a50382dcbcc544cc6"><td class="mdescLeft"> </td><td class="mdescRight">This function implements the AES-CMAC-PRF-128 pseudorandom function, as defined in <em>RFC-4615: The Advanced Encryption Standard-Cipher-based Message Authentication Code-Pseudo-Random Function-128 (AES-CMAC-PRF-128) Algorithm for the Internet Key Exchange Protocol (IKE).</em> <a href="#ad9ef677703a2837a50382dcbcc544cc6">More...</a><br /></td></tr> <tr class="separator:ad9ef677703a2837a50382dcbcc544cc6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a615cf527d17950ce8bfc9207010aee19"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="cmac_8h.html#a615cf527d17950ce8bfc9207010aee19">mbedtls_cmac_self_test</a> (int verbose)</td></tr> <tr class="memdesc:a615cf527d17950ce8bfc9207010aee19"><td class="mdescLeft"> </td><td class="mdescRight">The CMAC checkup routine. <a href="#a615cf527d17950ce8bfc9207010aee19">More...</a><br /></td></tr> <tr class="separator:a615cf527d17950ce8bfc9207010aee19"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>The Cipher-based Message Authentication Code (CMAC) Mode for Authentication. </p> <p class="definition">Definition in file <a class="el" href="cmac_8h_source.html">cmac.h</a>.</p> </div><h2 class="groupheader">Macro Definition Documentation</h2> <a id="a5c776e34150416e27f28a6a03da68f0e"></a> <h2 class="memtitle"><span class="permalink"><a href="#a5c776e34150416e27f28a6a03da68f0e">◆ </a></span>MBEDTLS_AES_BLOCK_SIZE</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_AES_BLOCK_SIZE   16</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="cmac_8h_source.html#l00037">37</a> of file <a class="el" href="cmac_8h_source.html">cmac.h</a>.</p> </div> </div> <a id="accb84fb7db8f619f0fdf8ef1ee7552af"></a> <h2 class="memtitle"><span class="permalink"><a href="#accb84fb7db8f619f0fdf8ef1ee7552af">◆ </a></span>MBEDTLS_CIPHER_BLKSIZE_MAX</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_CIPHER_BLKSIZE_MAX   16 /* The longest block used by CMAC is that of AES. */</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="cmac_8h_source.html#l00041">41</a> of file <a class="el" href="cmac_8h_source.html">cmac.h</a>.</p> </div> </div> <a id="aa884d76e1c27c156a788a4763f571c67"></a> <h2 class="memtitle"><span class="permalink"><a href="#aa884d76e1c27c156a788a4763f571c67">◆ </a></span>MBEDTLS_DES3_BLOCK_SIZE</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_DES3_BLOCK_SIZE   8</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="cmac_8h_source.html#l00038">38</a> of file <a class="el" href="cmac_8h_source.html">cmac.h</a>.</p> </div> </div> <a id="ac1f7e31cddacee936b40c41e4eb525da"></a> <h2 class="memtitle"><span class="permalink"><a href="#ac1f7e31cddacee936b40c41e4eb525da">◆ </a></span>MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED   -0x007A</td> </tr> </table> </div><div class="memdoc"> <p>CMAC hardware accelerator failed. </p> <p class="definition">Definition at line <a class="el" href="cmac_8h_source.html#l00035">35</a> of file <a class="el" href="cmac_8h_source.html">cmac.h</a>.</p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a id="ad9ef677703a2837a50382dcbcc544cc6"></a> <h2 class="memtitle"><span class="permalink"><a href="#ad9ef677703a2837a50382dcbcc544cc6">◆ </a></span>mbedtls_aes_cmac_prf_128()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_aes_cmac_prf_128 </td> <td>(</td> <td class="paramtype">const unsigned char * </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>key_len</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const unsigned char * </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>in_len</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned char </td> <td class="paramname"><em>output</em>[16] </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>This function implements the AES-CMAC-PRF-128 pseudorandom function, as defined in <em>RFC-4615: The Advanced Encryption Standard-Cipher-based Message Authentication Code-Pseudo-Random Function-128 (AES-CMAC-PRF-128) Algorithm for the Internet Key Exchange Protocol (IKE).</em> </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">key</td><td>The key to use. </td></tr> <tr><td class="paramname">key_len</td><td>The key length in Bytes. </td></tr> <tr><td class="paramname">input</td><td>The buffer holding the input data. </td></tr> <tr><td class="paramname">in_len</td><td>The length of the input data in Bytes. </td></tr> <tr><td class="paramname">output</td><td>The buffer holding the generated 16 Bytes of pseudorandom output.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>0</code> on success. </dd></dl> </div> </div> <a id="af44bc935db9b27fbfe485936b5ad99ed"></a> <h2 class="memtitle"><span class="permalink"><a href="#af44bc935db9b27fbfe485936b5ad99ed">◆ </a></span>mbedtls_cipher_cmac()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_cipher_cmac </td> <td>(</td> <td class="paramtype">const <a class="el" href="structmbedtls__cipher__info__t.html">mbedtls_cipher_info_t</a> * </td> <td class="paramname"><em>cipher_info</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const unsigned char * </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>keylen</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const unsigned char * </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>ilen</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned char * </td> <td class="paramname"><em>output</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>This function calculates the full generic CMAC on the input buffer with the provided key. </p> <p>The function allocates the context, performs the calculation, and frees the context.</p> <p>The CMAC result is calculated as output = generic CMAC(cmac key, input buffer).</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">cipher_info</td><td>The cipher information. </td></tr> <tr><td class="paramname">key</td><td>The CMAC key. </td></tr> <tr><td class="paramname">keylen</td><td>The length of the CMAC key in bits. </td></tr> <tr><td class="paramname">input</td><td>The buffer holding the input data. </td></tr> <tr><td class="paramname">ilen</td><td>The length of the input data. </td></tr> <tr><td class="paramname">output</td><td>The buffer for the generic CMAC result.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>0</code> on success, or <a class="el" href="md_8h.html#aeeb355bf3d3d39a2a6ba50544139b9a7">MBEDTLS_ERR_MD_BAD_INPUT_DATA</a> if parameter verification fails. </dd></dl> </div> </div> <a id="a9adc5b4b09b40d41bb6554c8ecfa755d"></a> <h2 class="memtitle"><span class="permalink"><a href="#a9adc5b4b09b40d41bb6554c8ecfa755d">◆ </a></span>mbedtls_cipher_cmac_finish()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_cipher_cmac_finish </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__cipher__context__t.html">mbedtls_cipher_context_t</a> * </td> <td class="paramname"><em>ctx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned char * </td> <td class="paramname"><em>output</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>This function finishes the CMAC operation, and writes the result to the output buffer. </p> <p>It is called after <a class="el" href="cmac_8h.html#a14441964606982e0a664a8bb48bddad6" title="This function feeds an input buffer into an ongoing CMAC computation. ">mbedtls_cipher_cmac_update()</a>. It can be followed by <a class="el" href="cmac_8h.html#a364af1a9ac845cbf21d7a64f1f43c71a" title="This function prepares the authentication of another message with the same key as the previous CMAC o...">mbedtls_cipher_cmac_reset()</a> and <a class="el" href="cmac_8h.html#a14441964606982e0a664a8bb48bddad6" title="This function feeds an input buffer into an ongoing CMAC computation. ">mbedtls_cipher_cmac_update()</a>, or <a class="el" href="cipher_8h.html#a903c4146b471207690988584b83854a9" title="This function frees and clears the cipher-specific context of ctx. Freeing ctx itself remains the res...">mbedtls_cipher_free()</a>.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>The cipher context used for the CMAC operation. </td></tr> <tr><td class="paramname">output</td><td>The output buffer for the CMAC checksum result.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>0</code> on success, or <a class="el" href="md_8h.html#aeeb355bf3d3d39a2a6ba50544139b9a7">MBEDTLS_ERR_MD_BAD_INPUT_DATA</a> if parameter verification fails. </dd></dl> </div> </div> <a id="a364af1a9ac845cbf21d7a64f1f43c71a"></a> <h2 class="memtitle"><span class="permalink"><a href="#a364af1a9ac845cbf21d7a64f1f43c71a">◆ </a></span>mbedtls_cipher_cmac_reset()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_cipher_cmac_reset </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__cipher__context__t.html">mbedtls_cipher_context_t</a> * </td> <td class="paramname"><em>ctx</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>This function prepares the authentication of another message with the same key as the previous CMAC operation. </p> <p>It is called after <a class="el" href="cmac_8h.html#a9adc5b4b09b40d41bb6554c8ecfa755d" title="This function finishes the CMAC operation, and writes the result to the output buffer. ">mbedtls_cipher_cmac_finish()</a> and before <a class="el" href="cmac_8h.html#a14441964606982e0a664a8bb48bddad6" title="This function feeds an input buffer into an ongoing CMAC computation. ">mbedtls_cipher_cmac_update()</a>.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>The cipher context used for the CMAC operation.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>0</code> on success, or <a class="el" href="md_8h.html#aeeb355bf3d3d39a2a6ba50544139b9a7">MBEDTLS_ERR_MD_BAD_INPUT_DATA</a> if parameter verification fails. </dd></dl> </div> </div> <a id="ae5835d528bbfec2ae2452ba4617469b8"></a> <h2 class="memtitle"><span class="permalink"><a href="#ae5835d528bbfec2ae2452ba4617469b8">◆ </a></span>mbedtls_cipher_cmac_starts()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_cipher_cmac_starts </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__cipher__context__t.html">mbedtls_cipher_context_t</a> * </td> <td class="paramname"><em>ctx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const unsigned char * </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>keybits</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>This function sets the CMAC key, and prepares to authenticate the input data. Must be called with an initialized cipher context. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>The cipher context used for the CMAC operation, initialized as one of the following types:<ul> <li> MBEDTLS_CIPHER_AES_128_ECB </li> <li> MBEDTLS_CIPHER_AES_192_ECB </li> <li> MBEDTLS_CIPHER_AES_256_ECB </li> <li> MBEDTLS_CIPHER_DES_EDE3_ECB</li> </ul> </td></tr> <tr><td class="paramname">key</td><td>The CMAC key. </td></tr> <tr><td class="paramname">keybits</td><td>The length of the CMAC key in bits. Must be supported by the cipher.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>0</code> on success, or a cipher-specific error code. </dd></dl> </div> </div> <a id="a14441964606982e0a664a8bb48bddad6"></a> <h2 class="memtitle"><span class="permalink"><a href="#a14441964606982e0a664a8bb48bddad6">◆ </a></span>mbedtls_cipher_cmac_update()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_cipher_cmac_update </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__cipher__context__t.html">mbedtls_cipher_context_t</a> * </td> <td class="paramname"><em>ctx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const unsigned char * </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>ilen</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>This function feeds an input buffer into an ongoing CMAC computation. </p> <p>It is called between <a class="el" href="cmac_8h.html#ae5835d528bbfec2ae2452ba4617469b8" title="This function sets the CMAC key, and prepares to authenticate the input data. Must be called with an ...">mbedtls_cipher_cmac_starts()</a> or <a class="el" href="cmac_8h.html#a364af1a9ac845cbf21d7a64f1f43c71a" title="This function prepares the authentication of another message with the same key as the previous CMAC o...">mbedtls_cipher_cmac_reset()</a>, and <a class="el" href="cmac_8h.html#a9adc5b4b09b40d41bb6554c8ecfa755d" title="This function finishes the CMAC operation, and writes the result to the output buffer. ">mbedtls_cipher_cmac_finish()</a>. Can be called repeatedly.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>The cipher context used for the CMAC operation. </td></tr> <tr><td class="paramname">input</td><td>The buffer holding the input data. </td></tr> <tr><td class="paramname">ilen</td><td>The length of the input data.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>0</code> on success, or <a class="el" href="md_8h.html#aeeb355bf3d3d39a2a6ba50544139b9a7">MBEDTLS_ERR_MD_BAD_INPUT_DATA</a> if parameter verification fails. </dd></dl> </div> </div> <a id="a615cf527d17950ce8bfc9207010aee19"></a> <h2 class="memtitle"><span class="permalink"><a href="#a615cf527d17950ce8bfc9207010aee19">◆ </a></span>mbedtls_cmac_self_test()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_cmac_self_test </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>verbose</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>The CMAC checkup routine. </p> <dl class="section return"><dt>Returns</dt><dd><code>0</code> on success, or <code>1</code> on failure. </dd></dl> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Oct 12 2018 20:26:59 for mbed TLS v2.7.6 by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.13 </small></address> </body> </html>