<!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.5"/>
<title>PolarSSL v1.3.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 style="padding-left: 0.5em;">
<div id="projectname">PolarSSL v1.3.8
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_6a9bbd12bf4e19a18c45e270f8fae3fd.html">include</a></li><li class="navelem"><a class="el" href="dir_04272d44da4745cf8b8bfc767d6c6523.html">polarssl</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>Counter with CBC-MAC (CCM) 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">
</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="structccm__context.html">ccm_context</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">CCM context structure. <a href="structccm__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:a511bce4dba4b1934174a199e716ed37d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ccm_8h.html#a511bce4dba4b1934174a199e716ed37d">POLARSSL_ERR_CCM_BAD_INPUT</a>   -0x000D</td></tr>
<tr class="memdesc:a511bce4dba4b1934174a199e716ed37d"><td class="mdescLeft"> </td><td class="mdescRight">Bad input parameters to function. <a href="#a511bce4dba4b1934174a199e716ed37d">More...</a><br/></td></tr>
<tr class="separator:a511bce4dba4b1934174a199e716ed37d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a51ba7afc7f66aa40e849813869c5d402"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ccm_8h.html#a51ba7afc7f66aa40e849813869c5d402">POLARSSL_ERR_CCM_AUTH_FAILED</a>   -0x000F</td></tr>
<tr class="memdesc:a51ba7afc7f66aa40e849813869c5d402"><td class="mdescLeft"> </td><td class="mdescRight">Authenticated decryption failed. <a href="#a51ba7afc7f66aa40e849813869c5d402">More...</a><br/></td></tr>
<tr class="separator:a51ba7afc7f66aa40e849813869c5d402"><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:aeea3832a1d2ee9eb264e3cd9013900d8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ccm_8h.html#aeea3832a1d2ee9eb264e3cd9013900d8">ccm_init</a> (<a class="el" href="structccm__context.html">ccm_context</a> *ctx, <a class="el" href="cipher_8h.html#a373f5d3a0a42c77ff4f5fe4fe7da0560">cipher_id_t</a> cipher, const unsigned char *key, unsigned int keysize)</td></tr>
<tr class="memdesc:aeea3832a1d2ee9eb264e3cd9013900d8"><td class="mdescLeft"> </td><td class="mdescRight">CCM initialization (encryption and decryption) <a href="#aeea3832a1d2ee9eb264e3cd9013900d8">More...</a><br/></td></tr>
<tr class="separator:aeea3832a1d2ee9eb264e3cd9013900d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a884657cd0c69f0870e8ecc92dbdb9dd3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ccm_8h.html#a884657cd0c69f0870e8ecc92dbdb9dd3">ccm_free</a> (<a class="el" href="structccm__context.html">ccm_context</a> *ctx)</td></tr>
<tr class="memdesc:a884657cd0c69f0870e8ecc92dbdb9dd3"><td class="mdescLeft"> </td><td class="mdescRight">Free a CCM context and underlying cipher sub-context. <a href="#a884657cd0c69f0870e8ecc92dbdb9dd3">More...</a><br/></td></tr>
<tr class="separator:a884657cd0c69f0870e8ecc92dbdb9dd3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e501cc42e38bf5e6f9b51920213d4bd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ccm_8h.html#a4e501cc42e38bf5e6f9b51920213d4bd">ccm_encrypt_and_tag</a> (<a class="el" href="structccm__context.html">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:a4e501cc42e38bf5e6f9b51920213d4bd"><td class="mdescLeft"> </td><td class="mdescRight">CCM buffer encryption. <a href="#a4e501cc42e38bf5e6f9b51920213d4bd">More...</a><br/></td></tr>
<tr class="separator:a4e501cc42e38bf5e6f9b51920213d4bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3cabbc9a5e7f023d25b1e9a7e7583506"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ccm_8h.html#a3cabbc9a5e7f023d25b1e9a7e7583506">ccm_auth_decrypt</a> (<a class="el" href="structccm__context.html">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:a3cabbc9a5e7f023d25b1e9a7e7583506"><td class="mdescLeft"> </td><td class="mdescRight">CCM buffer authenticated decryption. <a href="#a3cabbc9a5e7f023d25b1e9a7e7583506">More...</a><br/></td></tr>
<tr class="separator:a3cabbc9a5e7f023d25b1e9a7e7583506"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aec9358c27a327452ef89a3d1e1392eee"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ccm_8h.html#aec9358c27a327452ef89a3d1e1392eee">ccm_self_test</a> (int verbose)</td></tr>
<tr class="memdesc:aec9358c27a327452ef89a3d1e1392eee"><td class="mdescLeft"> </td><td class="mdescRight">Checkup routine. <a href="#aec9358c27a327452ef89a3d1e1392eee">More...</a><br/></td></tr>
<tr class="separator:aec9358c27a327452ef89a3d1e1392eee"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Counter with CBC-MAC (CCM) for 128-bit block ciphers. </p>
<p>Copyright (C) 2014, Brainspark B.V.</p>
<p>This file is part of PolarSSL (<a href="http://www.polarssl.org">http://www.polarssl.org</a>) Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org></p>
<p>All rights reserved.</p>
<p>This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. </p>
<p>Definition in file <a class="el" href="ccm_8h_source.html">ccm.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a51ba7afc7f66aa40e849813869c5d402"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_CCM_AUTH_FAILED   -0x000F</td>
</tr>
</table>
</div><div class="memdoc">
<p>Authenticated decryption failed. </p>
<p>Definition at line <a class="el" href="ccm_8h_source.html#l00033">33</a> of file <a class="el" href="ccm_8h_source.html">ccm.h</a>.</p>
</div>
</div>
<a class="anchor" id="a511bce4dba4b1934174a199e716ed37d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_CCM_BAD_INPUT   -0x000D</td>
</tr>
</table>
</div><div class="memdoc">
<p>Bad input parameters to function. </p>
<p>Definition at line <a class="el" href="ccm_8h_source.html#l00032">32</a> of file <a class="el" href="ccm_8h_source.html">ccm.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a3cabbc9a5e7f023d25b1e9a7e7583506"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ccm_auth_decrypt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structccm__context.html">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>CCM buffer authenticated decryption. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>CCM context </td></tr>
<tr><td class="paramname">length</td><td>length of the input data </td></tr>
<tr><td class="paramname">iv</td><td>initialization vector </td></tr>
<tr><td class="paramname">iv_len</td><td>length of IV </td></tr>
<tr><td class="paramname">add</td><td>additional data </td></tr>
<tr><td class="paramname">add_len</td><td>length of additional data </td></tr>
<tr><td class="paramname">input</td><td>buffer holding the input data </td></tr>
<tr><td class="paramname">output</td><td>buffer for holding the output data </td></tr>
<tr><td class="paramname">tag</td><td>buffer holding the tag </td></tr>
<tr><td class="paramname">tag_len</td><td>length of the tag</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful and authenticated, POLARSSL_ERR_CCM_AUTH_FAILED if tag does not match </dd></dl>
</div>
</div>
<a class="anchor" id="a4e501cc42e38bf5e6f9b51920213d4bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ccm_encrypt_and_tag </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structccm__context.html">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>CCM buffer encryption. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>CCM context </td></tr>
<tr><td class="paramname">length</td><td>length of the input data in bytes </td></tr>
<tr><td class="paramname">iv</td><td>nonce (initialization vector) </td></tr>
<tr><td class="paramname">iv_len</td><td>length of IV in bytes must be 2, 3, 4, 5, 6, 7 or 8 </td></tr>
<tr><td class="paramname">add</td><td>additional data </td></tr>
<tr><td class="paramname">add_len</td><td>length of additional data in bytes must be less than 2^16 - 2^8 </td></tr>
<tr><td class="paramname">input</td><td>buffer holding the input data </td></tr>
<tr><td class="paramname">output</td><td>buffer for holding the output data must be at least 'length' bytes wide </td></tr>
<tr><td class="paramname">tag</td><td>buffer for holding the tag </td></tr>
<tr><td class="paramname">tag_len</td><td>length of the tag to generate in bytes must be 4, 6, 8, 10, 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 get the tag concatenated with the output as in the CCM spec, use tag = output + length and make sure the output buffer is at least length + tag_len wide.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful </dd></dl>
</div>
</div>
<a class="anchor" id="a884657cd0c69f0870e8ecc92dbdb9dd3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ccm_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structccm__context.html">ccm_context</a> * </td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a 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>CCM context to free </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aeea3832a1d2ee9eb264e3cd9013900d8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ccm_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structccm__context.html">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#a373f5d3a0a42c77ff4f5fe4fe7da0560">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>keysize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>CCM initialization (encryption and decryption) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>CCM context to be initialized </td></tr>
<tr><td class="paramname">cipher</td><td>cipher to use (a 128-bit block cipher) </td></tr>
<tr><td class="paramname">key</td><td>encryption key </td></tr>
<tr><td class="paramname">keysize</td><td>key size in bits (must be acceptable by the cipher)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or a cipher specific error code </dd></dl>
</div>
</div>
<a class="anchor" id="aec9358c27a327452ef89a3d1e1392eee"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int 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>Checkup routine. </p>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or 1 if the test failed </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jul 31 2014 11:35:55 for PolarSSL v1.3.8 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
