<!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"/> <title>PolarSSL: polarssl/aes.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body onload='searchBox.OnSelectItem(0);'> <!-- Generated by Doxygen 1.7.4 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">PolarSSL</div> </td> </tr> </tbody> </table> </div> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li id="searchli"> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </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>File Members</span></a></li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#nested-classes">Classes</a> | <a href="#define-members">Defines</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">polarssl/aes.h File Reference</div> </div> </div> <div class="contents"> <p><a href="aes_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="nested-classes"></a> Classes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structaes__context.html">aes_context</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">AES context structure. <a href="structaes__context.html#details">More...</a><br/></td></tr> <tr><td colspan="2"><h2><a name="define-members"></a> Defines</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a91e721bca5c6db6402fc3a4781d69b10"></a><!-- doxytag: member="aes.h::AES_ENCRYPT" ref="a91e721bca5c6db6402fc3a4781d69b10" args="" --> #define </td><td class="memItemRight" valign="bottom"><b>AES_ENCRYPT</b>   1</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8a3cf36dc3c8860519f33907bad182c9"></a><!-- doxytag: member="aes.h::AES_DECRYPT" ref="a8a3cf36dc3c8860519f33907bad182c9" args="" --> #define </td><td class="memItemRight" valign="bottom"><b>AES_DECRYPT</b>   0</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac9743adb9edbf81a73b5d522902163e4"></a><!-- doxytag: member="aes.h::POLARSSL_ERR_AES_INVALID_KEY_LENGTH" ref="ac9743adb9edbf81a73b5d522902163e4" args="" --> #define </td><td class="memItemRight" valign="bottom"><b>POLARSSL_ERR_AES_INVALID_KEY_LENGTH</b>   -0x0800</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a36fba5d9dcc0a3c8cf190933c7af14"></a><!-- doxytag: member="aes.h::POLARSSL_ERR_AES_INVALID_INPUT_LENGTH" ref="a3a36fba5d9dcc0a3c8cf190933c7af14" args="" --> #define </td><td class="memItemRight" valign="bottom"><b>POLARSSL_ERR_AES_INVALID_INPUT_LENGTH</b>   -0x0810</td></tr> <tr><td colspan="2"><h2><a name="func-members"></a> Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="aes_8h.html#af3d27da1daae5ce8a778a7ddb5aabffc">aes_setkey_enc</a> (<a class="el" href="structaes__context.html">aes_context</a> *ctx, const unsigned char *key, int keysize)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">AES key schedule (encryption) <a href="#af3d27da1daae5ce8a778a7ddb5aabffc"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="aes_8h.html#aee9fd733ec9f726f001179041f2002ce">aes_setkey_dec</a> (<a class="el" href="structaes__context.html">aes_context</a> *ctx, const unsigned char *key, int keysize)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">AES key schedule (decryption) <a href="#aee9fd733ec9f726f001179041f2002ce"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="aes_8h.html#a0c80313f1e98a573f0876366c35f0445">aes_crypt_ecb</a> (<a class="el" href="structaes__context.html">aes_context</a> *ctx, int mode, const unsigned char input[16], unsigned char output[16])</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">AES-ECB block encryption/decryption. <a href="#a0c80313f1e98a573f0876366c35f0445"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="aes_8h.html#a05832e2d36e730c6f5837805f69cd819">aes_crypt_cbc</a> (<a class="el" href="structaes__context.html">aes_context</a> *ctx, int mode, int length, unsigned char iv[16], const unsigned char *input, unsigned char *output)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">AES-CBC buffer encryption/decryption Length should be a multiple of the block size (16 bytes) <a href="#a05832e2d36e730c6f5837805f69cd819"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="aes_8h.html#a319c4ccc642b428b8563c4b3b8b938ed">aes_crypt_cfb128</a> (<a class="el" href="structaes__context.html">aes_context</a> *ctx, int mode, int length, int *iv_off, unsigned char iv[16], const unsigned char *input, unsigned char *output)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">AES-CFB128 buffer encryption/decryption. <a href="#a319c4ccc642b428b8563c4b3b8b938ed"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="aes_8h.html#a3a4d8a79727330aa9bf8be633f9f1516">aes_self_test</a> (int verbose)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Checkup routine. <a href="#a3a4d8a79727330aa9bf8be633f9f1516"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Copyright (C) 2006-2010, 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> </div><hr/><h2>Function Documentation</h2> <a class="anchor" id="a05832e2d36e730c6f5837805f69cd819"></a><!-- doxytag: member="aes.h::aes_crypt_cbc" ref="a05832e2d36e730c6f5837805f69cd819" args="(aes_context *ctx, int mode, int length, unsigned char iv[16], const unsigned char *input, unsigned char *output)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int aes_crypt_cbc </td> <td>(</td> <td class="paramtype"><a class="el" href="structaes__context.html">aes_context</a> * </td> <td class="paramname"><em>ctx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>mode</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>length</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned char </td> <td class="paramname"><em>iv</em>[16], </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></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>AES-CBC buffer encryption/decryption Length should be a multiple of the block size (16 bytes) </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>AES context </td></tr> <tr><td class="paramname">mode</td><td>AES_ENCRYPT or AES_DECRYPT </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 (updated after use) </td></tr> <tr><td class="paramname">input</td><td>buffer holding the input data </td></tr> <tr><td class="paramname">output</td><td>buffer holding the output data</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, or POLARSSL_ERR_AES_INVALID_INPUT_LENGTH </dd></dl> </div> </div> <a class="anchor" id="a319c4ccc642b428b8563c4b3b8b938ed"></a><!-- doxytag: member="aes.h::aes_crypt_cfb128" ref="a319c4ccc642b428b8563c4b3b8b938ed" args="(aes_context *ctx, int mode, int length, int *iv_off, unsigned char iv[16], const unsigned char *input, unsigned char *output)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int aes_crypt_cfb128 </td> <td>(</td> <td class="paramtype"><a class="el" href="structaes__context.html">aes_context</a> * </td> <td class="paramname"><em>ctx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>mode</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>length</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int * </td> <td class="paramname"><em>iv_off</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned char </td> <td class="paramname"><em>iv</em>[16], </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></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>AES-CFB128 buffer encryption/decryption. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>AES context </td></tr> <tr><td class="paramname">mode</td><td>AES_ENCRYPT or AES_DECRYPT </td></tr> <tr><td class="paramname">length</td><td>length of the input data </td></tr> <tr><td class="paramname">iv_off</td><td>offset in IV (updated after use) </td></tr> <tr><td class="paramname">iv</td><td>initialization vector (updated after use) </td></tr> <tr><td class="paramname">input</td><td>buffer holding the input data </td></tr> <tr><td class="paramname">output</td><td>buffer holding the output data</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful </dd></dl> </div> </div> <a class="anchor" id="a0c80313f1e98a573f0876366c35f0445"></a><!-- doxytag: member="aes.h::aes_crypt_ecb" ref="a0c80313f1e98a573f0876366c35f0445" args="(aes_context *ctx, int mode, const unsigned char input[16], unsigned char output[16])" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int aes_crypt_ecb </td> <td>(</td> <td class="paramtype"><a class="el" href="structaes__context.html">aes_context</a> * </td> <td class="paramname"><em>ctx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>mode</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const unsigned char </td> <td class="paramname"><em>input</em>[16], </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>AES-ECB block encryption/decryption. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>AES context </td></tr> <tr><td class="paramname">mode</td><td>AES_ENCRYPT or AES_DECRYPT </td></tr> <tr><td class="paramname">input</td><td>16-byte input block </td></tr> <tr><td class="paramname">output</td><td>16-byte output block</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful </dd></dl> </div> </div> <a class="anchor" id="a3a4d8a79727330aa9bf8be633f9f1516"></a><!-- doxytag: member="aes.h::aes_self_test" ref="a3a4d8a79727330aa9bf8be633f9f1516" args="(int verbose)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int aes_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="return"><dt><b>Returns:</b></dt><dd>0 if successful, or 1 if the test failed </dd></dl> </div> </div> <a class="anchor" id="aee9fd733ec9f726f001179041f2002ce"></a><!-- doxytag: member="aes.h::aes_setkey_dec" ref="aee9fd733ec9f726f001179041f2002ce" args="(aes_context *ctx, const unsigned char *key, int keysize)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int aes_setkey_dec </td> <td>(</td> <td class="paramtype"><a class="el" href="structaes__context.html">aes_context</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">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>AES key schedule (decryption) </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>AES context to be initialized </td></tr> <tr><td class="paramname">key</td><td>decryption key </td></tr> <tr><td class="paramname">keysize</td><td>must be 128, 192 or 256</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, or POLARSSL_ERR_AES_INVALID_KEY_LENGTH </dd></dl> </div> </div> <a class="anchor" id="af3d27da1daae5ce8a778a7ddb5aabffc"></a><!-- doxytag: member="aes.h::aes_setkey_enc" ref="af3d27da1daae5ce8a778a7ddb5aabffc" args="(aes_context *ctx, const unsigned char *key, int keysize)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int aes_setkey_enc </td> <td>(</td> <td class="paramtype"><a class="el" href="structaes__context.html">aes_context</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">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>AES key schedule (encryption) </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>AES context to be initialized </td></tr> <tr><td class="paramname">key</td><td>encryption key </td></tr> <tr><td class="paramname">keysize</td><td>must be 128, 192 or 256</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, or POLARSSL_ERR_AES_INVALID_KEY_LENGTH </dd></dl> </div> </div> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Defines</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <hr class="footer"/><address class="footer"><small>Generated on Mon May 16 2011 for PolarSSL by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address> </body> </html>