<!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.8: ccm.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.8 </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">ccm.h File Reference</div> </div> </div><!--header--> <div class="contents"> <p>CCM combines Counter mode encryption with CBC-MAC authentication for 128-bit block ciphers. <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 ccm.h:</div> <div class="dyncontent"> <div class="center"><img src="ccm_8h__incl.png" border="0" usemap="#ccm_8h" alt=""/></div> <map name="ccm_8h" id="ccm_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="ccm_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__ccm__context.html">mbedtls_ccm_context</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The CCM context-type definition. The CCM context is passed to the APIs called. <a href="structmbedtls__ccm__context.html#details">More...</a><br /></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:a6ad00876b856ad8ac9f366fa7e1cf463"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ccm_8h.html#a6ad00876b856ad8ac9f366fa7e1cf463">MBEDTLS_ERR_CCM_BAD_INPUT</a>   -0x000D</td></tr> <tr class="separator:a6ad00876b856ad8ac9f366fa7e1cf463"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae7fda1fbbd14f096374da7ccd54f9d3e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ccm_8h.html#ae7fda1fbbd14f096374da7ccd54f9d3e">MBEDTLS_ERR_CCM_AUTH_FAILED</a>   -0x000F</td></tr> <tr class="separator:ae7fda1fbbd14f096374da7ccd54f9d3e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3a03091dfc764b9dbac4eeeddda4f997"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ccm_8h.html#a3a03091dfc764b9dbac4eeeddda4f997">MBEDTLS_ERR_CCM_HW_ACCEL_FAILED</a>   -0x0011</td></tr> <tr class="separator:a3a03091dfc764b9dbac4eeeddda4f997"><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:abaeb0629dfac72016fda58a4f7870040"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ccm_8h.html#abaeb0629dfac72016fda58a4f7870040">mbedtls_ccm_init</a> (<a class="el" href="structmbedtls__ccm__context.html">mbedtls_ccm_context</a> *ctx)</td></tr> <tr class="memdesc:abaeb0629dfac72016fda58a4f7870040"><td class="mdescLeft"> </td><td class="mdescRight">This function initializes the specified CCM context, to make references valid, and prepare the context for <a class="el" href="ccm_8h.html#a464d8e724738b4bbd5b415ca0580f1b1" title="This function initializes the CCM context set in the ctx parameter and sets the encryption key...">mbedtls_ccm_setkey()</a> or <a class="el" href="ccm_8h.html#a2bd8130a83c6633a4dfd61b181cdabac" title="This function releases and clears the specified CCM context and underlying cipher sub-context...">mbedtls_ccm_free()</a>. <a href="#abaeb0629dfac72016fda58a4f7870040">More...</a><br /></td></tr> <tr class="separator:abaeb0629dfac72016fda58a4f7870040"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a464d8e724738b4bbd5b415ca0580f1b1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ccm_8h.html#a464d8e724738b4bbd5b415ca0580f1b1">mbedtls_ccm_setkey</a> (<a class="el" href="structmbedtls__ccm__context.html">mbedtls_ccm_context</a> *ctx, <a class="el" href="cipher_8h.html#af5b069ffd0b2ad31225e42ee4ee29b1b">mbedtls_cipher_id_t</a> cipher, const unsigned char *key, unsigned int keybits)</td></tr> <tr class="memdesc:a464d8e724738b4bbd5b415ca0580f1b1"><td class="mdescLeft"> </td><td class="mdescRight">This function initializes the CCM context set in the <code>ctx</code> parameter and sets the encryption key. <a href="#a464d8e724738b4bbd5b415ca0580f1b1">More...</a><br /></td></tr> <tr class="separator:a464d8e724738b4bbd5b415ca0580f1b1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2bd8130a83c6633a4dfd61b181cdabac"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ccm_8h.html#a2bd8130a83c6633a4dfd61b181cdabac">mbedtls_ccm_free</a> (<a class="el" href="structmbedtls__ccm__context.html">mbedtls_ccm_context</a> *ctx)</td></tr> <tr class="memdesc:a2bd8130a83c6633a4dfd61b181cdabac"><td class="mdescLeft"> </td><td class="mdescRight">This function releases and clears the specified CCM context and underlying cipher sub-context. <a href="#a2bd8130a83c6633a4dfd61b181cdabac">More...</a><br /></td></tr> <tr class="separator:a2bd8130a83c6633a4dfd61b181cdabac"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a64de697edfefbff94d7eb0d9a8de926f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ccm_8h.html#a64de697edfefbff94d7eb0d9a8de926f">mbedtls_ccm_encrypt_and_tag</a> (<a class="el" href="structmbedtls__ccm__context.html">mbedtls_ccm_context</a> *ctx, size_t length, const unsigned char *iv, size_t iv_len, const unsigned char *add, size_t add_len, const unsigned char *input, unsigned char *output, unsigned char *tag, size_t tag_len)</td></tr> <tr class="memdesc:a64de697edfefbff94d7eb0d9a8de926f"><td class="mdescLeft"> </td><td class="mdescRight">This function encrypts a buffer using CCM. <a href="#a64de697edfefbff94d7eb0d9a8de926f">More...</a><br /></td></tr> <tr class="separator:a64de697edfefbff94d7eb0d9a8de926f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8dc9dfe246064185498f005d8bf22622"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ccm_8h.html#a8dc9dfe246064185498f005d8bf22622">mbedtls_ccm_auth_decrypt</a> (<a class="el" href="structmbedtls__ccm__context.html">mbedtls_ccm_context</a> *ctx, size_t length, const unsigned char *iv, size_t iv_len, const unsigned char *add, size_t add_len, const unsigned char *input, unsigned char *output, const unsigned char *tag, size_t tag_len)</td></tr> <tr class="memdesc:a8dc9dfe246064185498f005d8bf22622"><td class="mdescLeft"> </td><td class="mdescRight">This function performs a CCM authenticated decryption of a buffer. <a href="#a8dc9dfe246064185498f005d8bf22622">More...</a><br /></td></tr> <tr class="separator:a8dc9dfe246064185498f005d8bf22622"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a14e016798db6cee11977bbdf5e7e0ab8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ccm_8h.html#a14e016798db6cee11977bbdf5e7e0ab8">mbedtls_ccm_self_test</a> (int verbose)</td></tr> <tr class="memdesc:a14e016798db6cee11977bbdf5e7e0ab8"><td class="mdescLeft"> </td><td class="mdescRight">The CCM checkup routine. <a href="#a14e016798db6cee11977bbdf5e7e0ab8">More...</a><br /></td></tr> <tr class="separator:a14e016798db6cee11977bbdf5e7e0ab8"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>CCM combines Counter mode encryption with CBC-MAC authentication for 128-bit block ciphers. </p> <p>Input to CCM includes the following elements: </p><ul> <li> Payload - data that is both authenticated and encrypted. </li> <li> Associated data (Adata) - data that is authenticated but not encrypted, For example, a header. </li> <li> Nonce - A unique value that is assigned to the payload and the associated data.</li> </ul> <p class="definition">Definition in file <a class="el" href="ccm_8h_source.html">ccm.h</a>.</p> </div><h2 class="groupheader">Macro Definition Documentation</h2> <a id="ae7fda1fbbd14f096374da7ccd54f9d3e"></a> <h2 class="memtitle"><span class="permalink"><a href="#ae7fda1fbbd14f096374da7ccd54f9d3e">◆ </a></span>MBEDTLS_ERR_CCM_AUTH_FAILED</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_ERR_CCM_AUTH_FAILED   -0x000F</td> </tr> </table> </div><div class="memdoc"> <p>Authenticated decryption failed. </p> <p class="definition">Definition at line <a class="el" href="ccm_8h_source.html#l00040">40</a> of file <a class="el" href="ccm_8h_source.html">ccm.h</a>.</p> </div> </div> <a id="a6ad00876b856ad8ac9f366fa7e1cf463"></a> <h2 class="memtitle"><span class="permalink"><a href="#a6ad00876b856ad8ac9f366fa7e1cf463">◆ </a></span>MBEDTLS_ERR_CCM_BAD_INPUT</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_ERR_CCM_BAD_INPUT   -0x000D</td> </tr> </table> </div><div class="memdoc"> <p>Bad input parameters to the function. </p> <p class="definition">Definition at line <a class="el" href="ccm_8h_source.html#l00039">39</a> of file <a class="el" href="ccm_8h_source.html">ccm.h</a>.</p> </div> </div> <a id="a3a03091dfc764b9dbac4eeeddda4f997"></a> <h2 class="memtitle"><span class="permalink"><a href="#a3a03091dfc764b9dbac4eeeddda4f997">◆ </a></span>MBEDTLS_ERR_CCM_HW_ACCEL_FAILED</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_ERR_CCM_HW_ACCEL_FAILED   -0x0011</td> </tr> </table> </div><div class="memdoc"> <p>CCM hardware accelerator failed. </p> <p class="definition">Definition at line <a class="el" href="ccm_8h_source.html#l00041">41</a> of file <a class="el" href="ccm_8h_source.html">ccm.h</a>.</p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a id="a8dc9dfe246064185498f005d8bf22622"></a> <h2 class="memtitle"><span class="permalink"><a href="#a8dc9dfe246064185498f005d8bf22622">◆ </a></span>mbedtls_ccm_auth_decrypt()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_ccm_auth_decrypt </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__ccm__context.html">mbedtls_ccm_context</a> * </td> <td class="paramname"><em>ctx</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 class="paramkey"></td> <td></td> <td class="paramtype">const unsigned char * </td> <td class="paramname"><em>iv</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>iv_len</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const unsigned char * </td> <td class="paramname"><em>add</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>add_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">unsigned char * </td> <td class="paramname"><em>output</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const unsigned char * </td> <td class="paramname"><em>tag</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>tag_len</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>This function performs a CCM authenticated decryption of a buffer. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>The CCM context to use for decryption. </td></tr> <tr><td class="paramname">length</td><td>The length of the input data in Bytes. </td></tr> <tr><td class="paramname">iv</td><td>Initialization vector. </td></tr> <tr><td class="paramname">iv_len</td><td>The length of the IV in Bytes: 7, 8, 9, 10, 11, 12, or 13. </td></tr> <tr><td class="paramname">add</td><td>The additional data field. </td></tr> <tr><td class="paramname">add_len</td><td>The length of additional data in Bytes. Must be less than 2^16 - 2^8. </td></tr> <tr><td class="paramname">input</td><td>The buffer holding the input data. </td></tr> <tr><td class="paramname">output</td><td>The buffer holding the output data. Must be at least <code>length</code> Bytes wide. </td></tr> <tr><td class="paramname">tag</td><td>The buffer holding the tag. </td></tr> <tr><td class="paramname">tag_len</td><td>The length of the tag in Bytes. 4, 6, 8, 10, 12, 14 or 16.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>0 if successful and authenticated, or <a class="el" href="ccm_8h.html#ae7fda1fbbd14f096374da7ccd54f9d3e">MBEDTLS_ERR_CCM_AUTH_FAILED</a> if the tag does not match. </dd></dl> </div> </div> <a id="a64de697edfefbff94d7eb0d9a8de926f"></a> <h2 class="memtitle"><span class="permalink"><a href="#a64de697edfefbff94d7eb0d9a8de926f">◆ </a></span>mbedtls_ccm_encrypt_and_tag()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_ccm_encrypt_and_tag </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__ccm__context.html">mbedtls_ccm_context</a> * </td> <td class="paramname"><em>ctx</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 class="paramkey"></td> <td></td> <td class="paramtype">const unsigned char * </td> <td class="paramname"><em>iv</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>iv_len</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const unsigned char * </td> <td class="paramname"><em>add</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>add_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">unsigned char * </td> <td class="paramname"><em>output</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned char * </td> <td class="paramname"><em>tag</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>tag_len</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>This function encrypts a buffer using CCM. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>The CCM context to use for encryption. </td></tr> <tr><td class="paramname">length</td><td>The length of the input data in Bytes. </td></tr> <tr><td class="paramname">iv</td><td>Initialization vector (nonce). </td></tr> <tr><td class="paramname">iv_len</td><td>The length of the IV in Bytes: 7, 8, 9, 10, 11, 12, or 13. </td></tr> <tr><td class="paramname">add</td><td>The additional data field. </td></tr> <tr><td class="paramname">add_len</td><td>The length of additional data in Bytes. Must be less than 2^16 - 2^8. </td></tr> <tr><td class="paramname">input</td><td>The buffer holding the input data. </td></tr> <tr><td class="paramname">output</td><td>The buffer holding the output data. Must be at least <code>length</code> Bytes wide. </td></tr> <tr><td class="paramname">tag</td><td>The buffer holding the tag. </td></tr> <tr><td class="paramname">tag_len</td><td>The length of the tag to generate in Bytes: 4, 6, 8, 10, 12, 14 or 16.</td></tr> </table> </dd> </dl> <dl class="section note"><dt>Note</dt><dd>The tag is written to a separate buffer. To concatenate the <code>tag</code> with the <code>output</code>, as done in <em>RFC-3610: Counter with CBC-MAC (CCM)</em>, use <code>tag</code> = <code>output</code> + <code>length</code>, and make sure that the output buffer is at least <code>length</code> + <code>tag_len</code> wide.</dd></dl> <dl class="section return"><dt>Returns</dt><dd><code>0</code> on success. </dd></dl> </div> </div> <a id="a2bd8130a83c6633a4dfd61b181cdabac"></a> <h2 class="memtitle"><span class="permalink"><a href="#a2bd8130a83c6633a4dfd61b181cdabac">◆ </a></span>mbedtls_ccm_free()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void mbedtls_ccm_free </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__ccm__context.html">mbedtls_ccm_context</a> * </td> <td class="paramname"><em>ctx</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>This function releases and clears the specified CCM context and underlying cipher sub-context. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>The CCM context to clear. </td></tr> </table> </dd> </dl> </div> </div> <a id="abaeb0629dfac72016fda58a4f7870040"></a> <h2 class="memtitle"><span class="permalink"><a href="#abaeb0629dfac72016fda58a4f7870040">◆ </a></span>mbedtls_ccm_init()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void mbedtls_ccm_init </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__ccm__context.html">mbedtls_ccm_context</a> * </td> <td class="paramname"><em>ctx</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>This function initializes the specified CCM context, to make references valid, and prepare the context for <a class="el" href="ccm_8h.html#a464d8e724738b4bbd5b415ca0580f1b1" title="This function initializes the CCM context set in the ctx parameter and sets the encryption key...">mbedtls_ccm_setkey()</a> or <a class="el" href="ccm_8h.html#a2bd8130a83c6633a4dfd61b181cdabac" title="This function releases and clears the specified CCM context and underlying cipher sub-context...">mbedtls_ccm_free()</a>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>The CCM context to initialize. </td></tr> </table> </dd> </dl> </div> </div> <a id="a14e016798db6cee11977bbdf5e7e0ab8"></a> <h2 class="memtitle"><span class="permalink"><a href="#a14e016798db6cee11977bbdf5e7e0ab8">◆ </a></span>mbedtls_ccm_self_test()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_ccm_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 CCM 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> <a id="a464d8e724738b4bbd5b415ca0580f1b1"></a> <h2 class="memtitle"><span class="permalink"><a href="#a464d8e724738b4bbd5b415ca0580f1b1">◆ </a></span>mbedtls_ccm_setkey()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_ccm_setkey </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__ccm__context.html">mbedtls_ccm_context</a> * </td> <td class="paramname"><em>ctx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="cipher_8h.html#af5b069ffd0b2ad31225e42ee4ee29b1b">mbedtls_cipher_id_t</a> </td> <td class="paramname"><em>cipher</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">unsigned int </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 initializes the CCM context set in the <code>ctx</code> parameter and sets the encryption key. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>The CCM context to initialize. </td></tr> <tr><td class="paramname">cipher</td><td>The 128-bit block cipher to use. </td></tr> <tr><td class="paramname">key</td><td>The encryption key. </td></tr> <tr><td class="paramname">keybits</td><td>The key size in bits. This must be acceptable 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> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Tue Jan 1 2019 18:27:17 for mbed TLS v2.7.8 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>