<!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.3: ccm.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">mbed TLS v2.7.3
</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="headertitle">
<div class="title">ccm.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="ccm_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> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">/*</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * Copyright (C) 2006-2018, Arm Limited (or its affiliates), All Rights Reserved</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * SPDX-License-Identifier: Apache-2.0</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> *</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License"); you may</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * not use this file except in compliance with the License.</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * You may obtain a copy of the License at</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> *</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> *</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> *</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * This file is part of Mbed TLS (https://tls.mbed.org)</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> */</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#ifndef MBEDTLS_CCM_H</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#define MBEDTLS_CCM_H</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#include "<a class="code" href="cipher_8h.html">cipher.h</a>"</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="ccm_8h.html#a6ad00876b856ad8ac9f366fa7e1cf463"> 39</a></span> <span class="preprocessor">#define MBEDTLS_ERR_CCM_BAD_INPUT -0x000D </span></div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="ccm_8h.html#ae7fda1fbbd14f096374da7ccd54f9d3e"> 40</a></span> <span class="preprocessor">#define MBEDTLS_ERR_CCM_AUTH_FAILED -0x000F </span></div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="ccm_8h.html#a3a03091dfc764b9dbac4eeeddda4f997"> 41</a></span> <span class="preprocessor">#define MBEDTLS_ERR_CCM_HW_ACCEL_FAILED -0x0011 </span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#if !defined(MBEDTLS_CCM_ALT)</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">// Regular implementation</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">//</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structmbedtls__ccm__context.html"> 55</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structmbedtls__ccm__context.html#a6d270f32b6d211bc94be981ac7572b1e"> 56</a></span>  <a class="code" href="structmbedtls__cipher__context__t.html">mbedtls_cipher_context_t</a> <a class="code" href="structmbedtls__ccm__context.html#a6d270f32b6d211bc94be981ac7572b1e">cipher_ctx</a>; </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> }</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <a class="code" href="structmbedtls__ccm__context.html">mbedtls_ccm_context</a>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keywordtype">void</span> <a class="code" href="ccm_8h.html#abaeb0629dfac72016fda58a4f7870040">mbedtls_ccm_init</a>( <a class="code" href="structmbedtls__ccm__context.html">mbedtls_ccm_context</a> *ctx );</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="keywordtype">int</span> <a class="code" href="ccm_8h.html#a464d8e724738b4bbd5b415ca0580f1b1">mbedtls_ccm_setkey</a>( <a class="code" href="structmbedtls__ccm__context.html">mbedtls_ccm_context</a> *ctx,</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="cipher_8h.html#af5b069ffd0b2ad31225e42ee4ee29b1b">mbedtls_cipher_id_t</a> cipher,</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *key,</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> keybits );</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keywordtype">void</span> <a class="code" href="ccm_8h.html#a2bd8130a83c6633a4dfd61b181cdabac">mbedtls_ccm_free</a>( <a class="code" href="structmbedtls__ccm__context.html">mbedtls_ccm_context</a> *ctx );</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="keywordtype">int</span> <a class="code" href="ccm_8h.html#a64de697edfefbff94d7eb0d9a8de926f">mbedtls_ccm_encrypt_and_tag</a>( <a class="code" href="structmbedtls__ccm__context.html">mbedtls_ccm_context</a> *ctx, <span class="keywordtype">size_t</span> length,</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *iv, <span class="keywordtype">size_t</span> iv_len,</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *add, <span class="keywordtype">size_t</span> add_len,</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *input, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *output,</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *tag, <span class="keywordtype">size_t</span> tag_len );</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="keywordtype">int</span> <a class="code" href="ccm_8h.html#a8dc9dfe246064185498f005d8bf22622">mbedtls_ccm_auth_decrypt</a>( <a class="code" href="structmbedtls__ccm__context.html">mbedtls_ccm_context</a> *ctx, <span class="keywordtype">size_t</span> length,</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *iv, <span class="keywordtype">size_t</span> iv_len,</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *add, <span class="keywordtype">size_t</span> add_len,</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *input, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *output,</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *tag, <span class="keywordtype">size_t</span> tag_len );</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> }</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="preprocessor">#else </span><span class="comment">/* MBEDTLS_CCM_ALT */</span><span class="preprocessor"></span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="preprocessor">#include "ccm_alt.h"</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="preprocessor">#endif </span><span class="comment">/* MBEDTLS_CCM_ALT */</span><span class="preprocessor"></span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="preprocessor">#if defined(MBEDTLS_SELF_TEST) && defined(MBEDTLS_AES_C)</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="keywordtype">int</span> <a class="code" href="ccm_8h.html#a14e016798db6cee11977bbdf5e7e0ab8">mbedtls_ccm_self_test</a>( <span class="keywordtype">int</span> verbose );</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="preprocessor">#endif </span><span class="comment">/* MBEDTLS_SELF_TEST && MBEDTLS_AES_C */</span><span class="preprocessor"></span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> }</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="preprocessor">#endif </span><span class="comment">/* MBEDTLS_CCM_H */</span><span class="preprocessor"></span></div><div class="ttc" id="ccm_8h_html_a2bd8130a83c6633a4dfd61b181cdabac"><div class="ttname"><a href="ccm_8h.html#a2bd8130a83c6633a4dfd61b181cdabac">mbedtls_ccm_free</a></div><div class="ttdeci">void mbedtls_ccm_free(mbedtls_ccm_context *ctx)</div><div class="ttdoc">This function releases and clears the specified CCM context and underlying cipher sub-context...</div></div>
<div class="ttc" id="structmbedtls__ccm__context_html"><div class="ttname"><a href="structmbedtls__ccm__context.html">mbedtls_ccm_context</a></div><div class="ttdoc">The CCM context-type definition. The CCM context is passed to the APIs called. </div><div class="ttdef"><b>Definition:</b> <a href="ccm_8h_source.html#l00055">ccm.h:55</a></div></div>
<div class="ttc" id="structmbedtls__cipher__context__t_html"><div class="ttname"><a href="structmbedtls__cipher__context__t.html">mbedtls_cipher_context_t</a></div><div class="ttdef"><b>Definition:</b> <a href="cipher_8h_source.html#l00245">cipher.h:245</a></div></div>
<div class="ttc" id="cipher_8h_html_af5b069ffd0b2ad31225e42ee4ee29b1b"><div class="ttname"><a href="cipher_8h.html#af5b069ffd0b2ad31225e42ee4ee29b1b">mbedtls_cipher_id_t</a></div><div class="ttdeci">mbedtls_cipher_id_t</div><div class="ttdoc">An enumeration of supported ciphers. </div><div class="ttdef"><b>Definition:</b> <a href="cipher_8h_source.html#l00078">cipher.h:78</a></div></div>
<div class="ttc" id="ccm_8h_html_a64de697edfefbff94d7eb0d9a8de926f"><div class="ttname"><a href="ccm_8h.html#a64de697edfefbff94d7eb0d9a8de926f">mbedtls_ccm_encrypt_and_tag</a></div><div class="ttdeci">int mbedtls_ccm_encrypt_and_tag(mbedtls_ccm_context *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)</div><div class="ttdoc">This function encrypts a buffer using CCM. </div></div>
<div class="ttc" id="cipher_8h_html"><div class="ttname"><a href="cipher_8h.html">cipher.h</a></div><div class="ttdoc">The generic cipher wrapper. </div></div>
<div class="ttc" id="ccm_8h_html_a464d8e724738b4bbd5b415ca0580f1b1"><div class="ttname"><a href="ccm_8h.html#a464d8e724738b4bbd5b415ca0580f1b1">mbedtls_ccm_setkey</a></div><div class="ttdeci">int mbedtls_ccm_setkey(mbedtls_ccm_context *ctx, mbedtls_cipher_id_t cipher, const unsigned char *key, unsigned int keybits)</div><div class="ttdoc">This function initializes the CCM context set in the ctx parameter and sets the encryption key...</div></div>
<div class="ttc" id="ccm_8h_html_a8dc9dfe246064185498f005d8bf22622"><div class="ttname"><a href="ccm_8h.html#a8dc9dfe246064185498f005d8bf22622">mbedtls_ccm_auth_decrypt</a></div><div class="ttdeci">int mbedtls_ccm_auth_decrypt(mbedtls_ccm_context *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)</div><div class="ttdoc">This function performs a CCM authenticated decryption of a buffer. </div></div>
<div class="ttc" id="ccm_8h_html_a14e016798db6cee11977bbdf5e7e0ab8"><div class="ttname"><a href="ccm_8h.html#a14e016798db6cee11977bbdf5e7e0ab8">mbedtls_ccm_self_test</a></div><div class="ttdeci">int mbedtls_ccm_self_test(int verbose)</div><div class="ttdoc">The CCM checkup routine. </div></div>
<div class="ttc" id="structmbedtls__ccm__context_html_a6d270f32b6d211bc94be981ac7572b1e"><div class="ttname"><a href="structmbedtls__ccm__context.html#a6d270f32b6d211bc94be981ac7572b1e">mbedtls_ccm_context::cipher_ctx</a></div><div class="ttdeci">mbedtls_cipher_context_t cipher_ctx</div><div class="ttdef"><b>Definition:</b> <a href="ccm_8h_source.html#l00056">ccm.h:56</a></div></div>
<div class="ttc" id="ccm_8h_html_abaeb0629dfac72016fda58a4f7870040"><div class="ttname"><a href="ccm_8h.html#abaeb0629dfac72016fda58a4f7870040">mbedtls_ccm_init</a></div><div class="ttdeci">void mbedtls_ccm_init(mbedtls_ccm_context *ctx)</div><div class="ttdoc">This function initializes the specified CCM context, to make references valid, and prepare the contex...</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue May 8 2018 21:08:41 for mbed TLS v2.7.3 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>
