<!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: cmac.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">cmac.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="cmac_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="l00007"></a><span class="lineno"> 7</span> <span class="comment">/*</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * Copyright (C) 2015-2018, Arm Limited (or its affiliates), All Rights Reserved</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * SPDX-License-Identifier: Apache-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License"); you may</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * not use this file except in compliance with the License.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * You may obtain a copy of the License at</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * limitations under the License.</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"> * This file is part of Mbed TLS (https://tls.mbed.org)</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> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#ifndef MBEDTLS_CMAC_H</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#define MBEDTLS_CMAC_H</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="cipher_8h.html">mbedtls/cipher.h</a>"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="cmac_8h.html#ac1f7e31cddacee936b40c41e4eb525da"> 35</a></span> <span class="preprocessor">#define MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED -0x007A </span></div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="cmac_8h.html#a5c776e34150416e27f28a6a03da68f0e"> 37</a></span> <span class="preprocessor">#define MBEDTLS_AES_BLOCK_SIZE 16</span></div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="cmac_8h.html#aa884d76e1c27c156a788a4763f571c67"> 38</a></span> <span class="preprocessor">#define MBEDTLS_DES3_BLOCK_SIZE 8</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#if defined(MBEDTLS_AES_C)</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#define MBEDTLS_CIPHER_BLKSIZE_MAX 16 </span><span class="comment">/* The longest block used by CMAC is that of AES. */</span><span class="preprocessor"></span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="cmac_8h.html#accb84fb7db8f619f0fdf8ef1ee7552af"> 43</a></span> <span class="preprocessor">#define MBEDTLS_CIPHER_BLKSIZE_MAX 8 </span><span class="comment">/* The longest block used by CMAC is that of 3DES. */</span><span class="preprocessor"></span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#if !defined(MBEDTLS_CMAC_ALT)</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structmbedtls__cmac__context__t.html"> 51</a></span> <span class="keyword">struct </span><a class="code" href="structmbedtls__cmac__context__t.html">mbedtls_cmac_context_t</a></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> {</div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structmbedtls__cmac__context__t.html#ae87d681008dd82481a5b97559db68010"> 54</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <a class="code" href="structmbedtls__cmac__context__t.html#ae87d681008dd82481a5b97559db68010">state</a>[<a class="code" href="cmac_8h.html#accb84fb7db8f619f0fdf8ef1ee7552af">MBEDTLS_CIPHER_BLKSIZE_MAX</a>];</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="structmbedtls__cmac__context__t.html#a2d58c18be7180b1284a06f2a29291663"> 58</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <a class="code" href="structmbedtls__cmac__context__t.html#a2d58c18be7180b1284a06f2a29291663">unprocessed_block</a>[<a class="code" href="cmac_8h.html#accb84fb7db8f619f0fdf8ef1ee7552af">MBEDTLS_CIPHER_BLKSIZE_MAX</a>];</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="structmbedtls__cmac__context__t.html#a96b77ca1c7dba6980356a37086870fab"> 61</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="structmbedtls__cmac__context__t.html#a96b77ca1c7dba6980356a37086870fab">unprocessed_len</a>;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> };</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="keywordtype">int</span> <a class="code" href="cmac_8h.html#ae5835d528bbfec2ae2452ba4617469b8">mbedtls_cipher_cmac_starts</a>( <a class="code" href="structmbedtls__cipher__context__t.html">mbedtls_cipher_context_t</a> *ctx,</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, <span class="keywordtype">size_t</span> keybits );</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="keywordtype">int</span> <a class="code" href="cmac_8h.html#a14441964606982e0a664a8bb48bddad6">mbedtls_cipher_cmac_update</a>( <a class="code" href="structmbedtls__cipher__context__t.html">mbedtls_cipher_context_t</a> *ctx,</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *input, <span class="keywordtype">size_t</span> ilen );</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="keywordtype">int</span> <a class="code" href="cmac_8h.html#a9adc5b4b09b40d41bb6554c8ecfa755d">mbedtls_cipher_cmac_finish</a>( <a class="code" href="structmbedtls__cipher__context__t.html">mbedtls_cipher_context_t</a> *ctx,</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *output );</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="keywordtype">int</span> <a class="code" href="cmac_8h.html#a364af1a9ac845cbf21d7a64f1f43c71a">mbedtls_cipher_cmac_reset</a>( <a class="code" href="structmbedtls__cipher__context__t.html">mbedtls_cipher_context_t</a> *ctx );</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="keywordtype">int</span> <a class="code" href="cmac_8h.html#af44bc935db9b27fbfe485936b5ad99ed">mbedtls_cipher_cmac</a>( <span class="keyword">const</span> <a class="code" href="structmbedtls__cipher__info__t.html">mbedtls_cipher_info_t</a> *cipher_info,</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *key, <span class="keywordtype">size_t</span> keylen,</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *input, <span class="keywordtype">size_t</span> ilen,</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *output );</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> </div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="preprocessor">#if defined(MBEDTLS_AES_C)</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="keywordtype">int</span> mbedtls_aes_cmac_prf_128( <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *key, <span class="keywordtype">size_t</span> key_len,</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *input, <span class="keywordtype">size_t</span> in_len,</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> output[16] );</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="preprocessor">#endif </span><span class="comment">/* MBEDTLS_AES_C */</span><span class="preprocessor"></span></div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> </div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> }</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> </div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="preprocessor">#else </span><span class="comment">/* !MBEDTLS_CMAC_ALT */</span><span class="preprocessor"></span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="preprocessor">#include "cmac_alt.h"</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="preprocessor">#endif </span><span class="comment">/* !MBEDTLS_CMAC_ALT */</span><span class="preprocessor"></span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> </div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> </div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="preprocessor">#if defined(MBEDTLS_SELF_TEST) && ( defined(MBEDTLS_AES_C) || defined(MBEDTLS_DES_C) )</span></div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> </div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="keywordtype">int</span> mbedtls_cmac_self_test( <span class="keywordtype">int</span> verbose );</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="preprocessor">#endif </span><span class="comment">/* MBEDTLS_SELF_TEST && ( MBEDTLS_AES_C || MBEDTLS_DES_C ) */</span><span class="preprocessor"></span></div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> }</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> </div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="preprocessor">#endif </span><span class="comment">/* MBEDTLS_CMAC_H */</span><span class="preprocessor"></span></div><div class="ttc" id="cmac_8h_html_accb84fb7db8f619f0fdf8ef1ee7552af"><div class="ttname"><a href="cmac_8h.html#accb84fb7db8f619f0fdf8ef1ee7552af">MBEDTLS_CIPHER_BLKSIZE_MAX</a></div><div class="ttdeci">#define MBEDTLS_CIPHER_BLKSIZE_MAX</div><div class="ttdef"><b>Definition:</b> <a href="cmac_8h_source.html#l00043">cmac.h:43</a></div></div>
<div class="ttc" id="cmac_8h_html_a364af1a9ac845cbf21d7a64f1f43c71a"><div class="ttname"><a href="cmac_8h.html#a364af1a9ac845cbf21d7a64f1f43c71a">mbedtls_cipher_cmac_reset</a></div><div class="ttdeci">int mbedtls_cipher_cmac_reset(mbedtls_cipher_context_t *ctx)</div><div class="ttdoc">This function prepares the authentication of another message with the same key as the previous CMAC o...</div></div>
<div class="ttc" id="cmac_8h_html_ae5835d528bbfec2ae2452ba4617469b8"><div class="ttname"><a href="cmac_8h.html#ae5835d528bbfec2ae2452ba4617469b8">mbedtls_cipher_cmac_starts</a></div><div class="ttdeci">int mbedtls_cipher_cmac_starts(mbedtls_cipher_context_t *ctx, const unsigned char *key, size_t keybits)</div><div class="ttdoc">This function sets the CMAC key, and prepares to authenticate the input data. Must be called with an ...</div></div>
<div class="ttc" id="structmbedtls__cmac__context__t_html"><div class="ttname"><a href="structmbedtls__cmac__context__t.html">mbedtls_cmac_context_t</a></div><div class="ttdef"><b>Definition:</b> <a href="cmac_8h_source.html#l00051">cmac.h:51</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="structmbedtls__cipher__info__t_html"><div class="ttname"><a href="structmbedtls__cipher__info__t.html">mbedtls_cipher_info_t</a></div><div class="ttdef"><b>Definition:</b> <a href="cipher_8h_source.html#l00207">cipher.h:207</a></div></div>
<div class="ttc" id="structmbedtls__cmac__context__t_html_ae87d681008dd82481a5b97559db68010"><div class="ttname"><a href="structmbedtls__cmac__context__t.html#ae87d681008dd82481a5b97559db68010">mbedtls_cmac_context_t::state</a></div><div class="ttdeci">unsigned char state[MBEDTLS_CIPHER_BLKSIZE_MAX]</div><div class="ttdef"><b>Definition:</b> <a href="cmac_8h_source.html#l00054">cmac.h:54</a></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="structmbedtls__cmac__context__t_html_a2d58c18be7180b1284a06f2a29291663"><div class="ttname"><a href="structmbedtls__cmac__context__t.html#a2d58c18be7180b1284a06f2a29291663">mbedtls_cmac_context_t::unprocessed_block</a></div><div class="ttdeci">unsigned char unprocessed_block[MBEDTLS_CIPHER_BLKSIZE_MAX]</div><div class="ttdef"><b>Definition:</b> <a href="cmac_8h_source.html#l00058">cmac.h:58</a></div></div>
<div class="ttc" id="cmac_8h_html_af44bc935db9b27fbfe485936b5ad99ed"><div class="ttname"><a href="cmac_8h.html#af44bc935db9b27fbfe485936b5ad99ed">mbedtls_cipher_cmac</a></div><div class="ttdeci">int mbedtls_cipher_cmac(const mbedtls_cipher_info_t *cipher_info, const unsigned char *key, size_t keylen, const unsigned char *input, size_t ilen, unsigned char *output)</div><div class="ttdoc">This function calculates the full generic CMAC on the input buffer with the provided key...</div></div>
<div class="ttc" id="structmbedtls__cmac__context__t_html_a96b77ca1c7dba6980356a37086870fab"><div class="ttname"><a href="structmbedtls__cmac__context__t.html#a96b77ca1c7dba6980356a37086870fab">mbedtls_cmac_context_t::unprocessed_len</a></div><div class="ttdeci">size_t unprocessed_len</div><div class="ttdef"><b>Definition:</b> <a href="cmac_8h_source.html#l00061">cmac.h:61</a></div></div>
<div class="ttc" id="cmac_8h_html_a9adc5b4b09b40d41bb6554c8ecfa755d"><div class="ttname"><a href="cmac_8h.html#a9adc5b4b09b40d41bb6554c8ecfa755d">mbedtls_cipher_cmac_finish</a></div><div class="ttdeci">int mbedtls_cipher_cmac_finish(mbedtls_cipher_context_t *ctx, unsigned char *output)</div><div class="ttdoc">This function finishes the CMAC operation, and writes the result to the output buffer. </div></div>
<div class="ttc" id="cmac_8h_html_a14441964606982e0a664a8bb48bddad6"><div class="ttname"><a href="cmac_8h.html#a14441964606982e0a664a8bb48bddad6">mbedtls_cipher_cmac_update</a></div><div class="ttdeci">int mbedtls_cipher_cmac_update(mbedtls_cipher_context_t *ctx, const unsigned char *input, size_t ilen)</div><div class="ttdoc">This function feeds an input buffer into an ongoing CMAC computation. </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>
