<!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>BeeCrypt: include/beecrypt/aes.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<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">BeeCrypt <span id="projectnumber">4.2.1</span></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="pages.html"><span>Related Pages</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>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<h1>include/beecrypt/aes.h File Reference<div class="ingroups"><a class="el" href="group__BC__m.html">Block ciphers</a> | <a class="el" href="group__BC__aes__m.html">Block ciphers: AES</a></div></h1> </div>
</div>
<div class="contents">
<p>AES block cipher, as specified by NIST FIPS 197.
<a href="#_details">More...</a></p>
<div class="textblock"><code>#include "beecrypt/beecrypt.h"</code><br/>
<code>#include "beecrypt/aesopt.h"</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for aes.h:</div>
<div class="dyncontent">
<div class="center"><img src="aes_8h__incl.png" border="0" usemap="#include_2beecrypt_2aes_8h" alt=""/></div>
<map name="include_2beecrypt_2aes_8h" id="include_2beecrypt_2aes_8h">
</map>
</div>
</div>
<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>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structaesParam.html">aesParam</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds all the parameters necessary for the AES cipher. <a href="structaesParam.html#_details">More...</a><br/></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#a643aa89c715a711cc441a5a4a7397ea6">aesSetup</a> (<a class="el" href="structaesParam.html">aesParam</a> *ap, const <a class="el" href="api_8h.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> *key, size_t keybits, <a class="el" href="group__BC__m.html#gace10d4c0b0409d35c6a703d6445fc558">cipherOperation</a> op)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function performs the cipher's key expansion. <a href="#a643aa89c715a711cc441a5a4a7397ea6"></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#a778e5ab1749733a37bbca97a43838305">aesSetIV</a> (<a class="el" href="structaesParam.html">aesParam</a> *ap, const <a class="el" href="api_8h.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> *iv)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function sets the Initialization Vector. <a href="#a778e5ab1749733a37bbca97a43838305"></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#abaadaaf3f01f1fde6237ccc08e3677e5">aesSetCTR</a> (<a class="el" href="structaesParam.html">aesParam</a> *ap, const <a class="el" href="api_8h.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> *nivz, size_t counter)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function sets the CTR mode counter. <a href="#abaadaaf3f01f1fde6237ccc08e3677e5"></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#a7a169238993aa7999831c40ae78d941a">aesEncrypt</a> (<a class="el" href="structaesParam.html">aesParam</a> *ap, uint32_t *dst, const uint32_t *src)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function performs the raw AES encryption; it encrypts one block of 128 bits. <a href="#a7a169238993aa7999831c40ae78d941a"></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#a35fce1a4e2f1df8de178ebc667bcedbf">aesDecrypt</a> (<a class="el" href="structaesParam.html">aesParam</a> *ap, uint32_t *dst, const uint32_t *src)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function performs the raw AES decryption; it decrypts one block of 128 bits. <a href="#a35fce1a4e2f1df8de178ebc667bcedbf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="aes_8h.html#ae0b5b285473012afa45a9044048a1f1a">aesFeedback</a> (<a class="el" href="structaesParam.html">aesParam</a> *ap)</td></tr>
<tr><td colspan="2"><h2><a name="var-members"></a>
Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structblockCipher.html">blockCipher</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="aes_8h.html#aa60b0eb68ff417f08ef26ac0eacf021f">aes</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds the full API description of the AES algorithm. <a href="#aa60b0eb68ff417f08ef26ac0eacf021f"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>AES block cipher, as specified by NIST FIPS 197. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Bob Deblier <<a href="mailto:bob.deblier@telenet.be">bob.deblier@telenet.be</a>> </dd></dl>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="a35fce1a4e2f1df8de178ebc667bcedbf"></a><!-- doxytag: member="aes.h::aesDecrypt" ref="a35fce1a4e2f1df8de178ebc667bcedbf" args="(aesParam *ap, uint32_t *dst, const uint32_t *src)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">aesDecrypt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structaesParam.html">aesParam</a> * </td>
<td class="paramname"><em>ap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint32_t * </td>
<td class="paramname"><em>src</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function performs the raw AES decryption; it decrypts one block of 128 bits. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ap</td><td>The cipher's parameter block. </td></tr>
<tr><td class="paramname">dst</td><td>The cleartext; should be aligned on 32-bit boundary. </td></tr>
<tr><td class="paramname">src</td><td>The ciphertext; should be aligned on 32-bit boundary. </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>on success. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7a169238993aa7999831c40ae78d941a"></a><!-- doxytag: member="aes.h::aesEncrypt" ref="a7a169238993aa7999831c40ae78d941a" args="(aesParam *ap, uint32_t *dst, const uint32_t *src)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">aesEncrypt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structaesParam.html">aesParam</a> * </td>
<td class="paramname"><em>ap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint32_t * </td>
<td class="paramname"><em>src</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function performs the raw AES encryption; it encrypts one block of 128 bits. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ap</td><td>The cipher's parameter block. </td></tr>
<tr><td class="paramname">dst</td><td>The ciphertext; should be aligned on 32-bit boundary. </td></tr>
<tr><td class="paramname">src</td><td>The cleartext; should be aligned on 32-bit boundary. </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>on success. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae0b5b285473012afa45a9044048a1f1a"></a><!-- doxytag: member="aes.h::aesFeedback" ref="ae0b5b285473012afa45a9044048a1f1a" args="(aesParam *ap)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t* aesFeedback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structaesParam.html">aesParam</a> * </td>
<td class="paramname"><em>ap</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="abaadaaf3f01f1fde6237ccc08e3677e5"></a><!-- doxytag: member="aes.h::aesSetCTR" ref="abaadaaf3f01f1fde6237ccc08e3677e5" args="(aesParam *ap, const byte *nivz, size_t counter)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int aesSetCTR </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structaesParam.html">aesParam</a> * </td>
<td class="paramname"><em>ap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="api_8h.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> * </td>
<td class="paramname"><em>nivz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>counter</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function sets the CTR mode counter. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This function is only useful in CTR modes. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ap</td><td>The cipher's parameter block. </td></tr>
<tr><td class="paramname">nivz</td><td>The concatenation of Nonce, IV, and padding Zeroes. </td></tr>
<tr><td class="paramname">counter</td><td>The counter. </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>on success. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a778e5ab1749733a37bbca97a43838305"></a><!-- doxytag: member="aes.h::aesSetIV" ref="a778e5ab1749733a37bbca97a43838305" args="(aesParam *ap, const byte *iv)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int aesSetIV </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structaesParam.html">aesParam</a> * </td>
<td class="paramname"><em>ap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="api_8h.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> * </td>
<td class="paramname"><em>iv</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function sets the Initialization Vector. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This function is only useful in block chaining or feedback modes. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ap</td><td>The cipher's parameter block. </td></tr>
<tr><td class="paramname">iv</td><td>The initialization vector; may be null. </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>on success. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a643aa89c715a711cc441a5a4a7397ea6"></a><!-- doxytag: member="aes.h::aesSetup" ref="a643aa89c715a711cc441a5a4a7397ea6" args="(aesParam *ap, const byte *key, size_t keybits, cipherOperation op)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int aesSetup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structaesParam.html">aesParam</a> * </td>
<td class="paramname"><em>ap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="api_8h.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>keybits</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__BC__m.html#gace10d4c0b0409d35c6a703d6445fc558">cipherOperation</a> </td>
<td class="paramname"><em>op</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function performs the cipher's key expansion. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ap</td><td>The cipher's parameter block. </td></tr>
<tr><td class="paramname">key</td><td>The key value. </td></tr>
<tr><td class="paramname">keybits</td><td>The number of bits in the key; legal values are: 128, 192 and 256. </td></tr>
<tr><td class="paramname">op</td><td>ENCRYPT or DECRYPT. </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>on success. </td></tr>
<tr><td class="paramname">-1</td><td>on failure. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Variable Documentation</h2>
<a class="anchor" id="aa60b0eb68ff417f08ef26ac0eacf021f"></a><!-- doxytag: member="aes.h::aes" ref="aa60b0eb68ff417f08ef26ac0eacf021f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="aes_8h.html#aa60b0eb68ff417f08ef26ac0eacf021f">aes</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Holds the full API description of the AES algorithm. </p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Apr 10 2011 20:49:30 for BeeCrypt by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
