<!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>BeeCrypt: Block ciphers</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">BeeCrypt
 <span id="projectnumber">4.2.1</span>
</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="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><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#files">Files</a> |
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">Block ciphers</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for Block ciphers:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__BC__m.png" border="0" alt="" usemap="#group____BC____m"/>
<map name="group____BC____m" id="group____BC____m">
<area shape="rect" id="node1" href="group__PRNG__m.html" title="Pseudo-Random Number\l Generators" alt="" coords="235,5,405,46"/><area shape="rect" id="node2" href="group__BC__blowfish__m.html" title="Block ciphers: Blowfish" alt="" coords="241,71,399,97"/><area shape="rect" id="node4" href="group__HASH__m.html" title="Hash Functions" alt="" coords="263,121,377,148"/><area shape="rect" id="node5" href="group__ES__m.html" title="Entropy sources" alt="" coords="261,172,379,199"/><area shape="rect" id="node6" href="group__HMAC__m.html" title="Keyed Hash Functions,\l a.k.a. Message Authentication \lCodes" alt="" coords="217,223,423,279"/><area shape="rect" id="node7" href="group__BC__aes__m.html" title="Block ciphers: AES" alt="" coords="252,303,388,329"/></map>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
Files</h2></td></tr>
<tr class="memitem:aes_8h"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="aes_8h.html">aes.h</a></td></tr>
<tr class="memdesc:aes_8h"><td class="mdescLeft"> </td><td class="mdescRight">AES block cipher, as specified by NIST FIPS 197. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:beecrypt_8h"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="beecrypt_8h.html">beecrypt.h</a></td></tr>
<tr class="memdesc:beecrypt_8h"><td class="mdescLeft"> </td><td class="mdescRight">BeeCrypt API, headers. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:blockmode_8h"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="blockmode_8h.html">blockmode.h</a></td></tr>
<tr class="memdesc:blockmode_8h"><td class="mdescLeft"> </td><td class="mdescRight">Blockcipher operation modes. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:blockpad_8h"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="blockpad_8h.html">blockpad.h</a></td></tr>
<tr class="memdesc:blockpad_8h"><td class="mdescLeft"> </td><td class="mdescRight">Blockcipher padding algorithms. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:blowfish_8h"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="blowfish_8h.html">blowfish.h</a></td></tr>
<tr class="memdesc:blowfish_8h"><td class="mdescLeft"> </td><td class="mdescRight">Blowfish block cipher. <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="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="structblockCipher.html">blockCipher</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Holds information and pointers to code specific to each cipher. <a href="structblockCipher.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structblockCipherContext.html">blockCipherContext</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Holds a pointer to a blockcipher as well as its parameters. <a href="structblockCipherContext.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="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga4bb0a804ab2c38ac56120f1cd35600b3"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__BC__m.html#ga4bb0a804ab2c38ac56120f1cd35600b3">blockCipherSetup</a> )(<a class="el" href="group__BC__m.html#gaa6f6ba122e489fd3c3923c83cb55dae0">blockCipherParam</a> *, const <a class="el" href="api_8h.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> *, size_t, <a class="el" href="group__BC__m.html#gace10d4c0b0409d35c6a703d6445fc558">cipherOperation</a>)</td></tr>
<tr class="memdesc:ga4bb0a804ab2c38ac56120f1cd35600b3"><td class="mdescLeft"> </td><td class="mdescRight">Prototype definition for a setup function. <a href="#ga4bb0a804ab2c38ac56120f1cd35600b3">More...</a><br/></td></tr>
<tr class="separator:ga4bb0a804ab2c38ac56120f1cd35600b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa6f6ba122e489fd3c3923c83cb55dae0"><td class="memItemLeft" align="right" valign="top">typedef void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__BC__m.html#gaa6f6ba122e489fd3c3923c83cb55dae0">blockCipherParam</a></td></tr>
<tr class="memdesc:gaa6f6ba122e489fd3c3923c83cb55dae0"><td class="mdescLeft"> </td><td class="mdescRight">Placeholder type definition for blockcipher parameters. <a href="#gaa6f6ba122e489fd3c3923c83cb55dae0">More...</a><br/></td></tr>
<tr class="separator:gaa6f6ba122e489fd3c3923c83cb55dae0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga40aeffa20f977393fbf10378ef466c25"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__BC__m.html#ga40aeffa20f977393fbf10378ef466c25">blockCipherSetIV</a> )(<a class="el" href="group__BC__m.html#gaa6f6ba122e489fd3c3923c83cb55dae0">blockCipherParam</a> *, const <a class="el" href="api_8h.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> *)</td></tr>
<tr class="memdesc:ga40aeffa20f977393fbf10378ef466c25"><td class="mdescLeft"> </td><td class="mdescRight">Prototype definition for an initialization vector setup function. <a href="#ga40aeffa20f977393fbf10378ef466c25">More...</a><br/></td></tr>
<tr class="separator:ga40aeffa20f977393fbf10378ef466c25"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae6164c8a42013a0b3aadba1bccd416af"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__BC__m.html#gae6164c8a42013a0b3aadba1bccd416af">blockCipherSetCTR</a> )(<a class="el" href="group__BC__m.html#gaa6f6ba122e489fd3c3923c83cb55dae0">blockCipherParam</a> *, const <a class="el" href="api_8h.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> *, size_t)</td></tr>
<tr class="memdesc:gae6164c8a42013a0b3aadba1bccd416af"><td class="mdescLeft"> </td><td class="mdescRight">Prototype definition for an initialization vector setup function. <a href="#gae6164c8a42013a0b3aadba1bccd416af">More...</a><br/></td></tr>
<tr class="separator:gae6164c8a42013a0b3aadba1bccd416af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga49ec3da318c2c3ab4464c8dbb38617c5"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__BC__m.html#ga49ec3da318c2c3ab4464c8dbb38617c5">blockCipherRawcrypt</a> )(<a class="el" href="group__BC__m.html#gaa6f6ba122e489fd3c3923c83cb55dae0">blockCipherParam</a> *, uint32_t *, const uint32_t *)</td></tr>
<tr class="memdesc:ga49ec3da318c2c3ab4464c8dbb38617c5"><td class="mdescLeft"> </td><td class="mdescRight">Prototype for a <em>raw</em> encryption or decryption function. <a href="#ga49ec3da318c2c3ab4464c8dbb38617c5">More...</a><br/></td></tr>
<tr class="separator:ga49ec3da318c2c3ab4464c8dbb38617c5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacc003baa6ffa4b315283282b19f081ec"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__BC__m.html#gacc003baa6ffa4b315283282b19f081ec">blockCipherModcrypt</a> )(<a class="el" href="group__BC__m.html#gaa6f6ba122e489fd3c3923c83cb55dae0">blockCipherParam</a> *, uint32_t *, const uint32_t *, unsigned int)</td></tr>
<tr class="memdesc:gacc003baa6ffa4b315283282b19f081ec"><td class="mdescLeft"> </td><td class="mdescRight">Prototype for a <em>encryption</em> or decryption function which operates on multiple blocks in a certain mode. <a href="#gacc003baa6ffa4b315283282b19f081ec">More...</a><br/></td></tr>
<tr class="separator:gacc003baa6ffa4b315283282b19f081ec"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gace10d4c0b0409d35c6a703d6445fc558"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__BC__m.html#gace10d4c0b0409d35c6a703d6445fc558">cipherOperation</a> { <a class="el" href="group__BC__m.html#gace10d4c0b0409d35c6a703d6445fc558a8d67fb0581b95ff8d49840ebfaedffd4">NOCRYPT</a>,
<a class="el" href="group__BC__m.html#gace10d4c0b0409d35c6a703d6445fc558a606f7451c00ce2831f56eceb9ab6bb96">ENCRYPT</a>,
<a class="el" href="group__BC__m.html#gace10d4c0b0409d35c6a703d6445fc558a3179dbaa639c5906029876801dcf4e11">DECRYPT</a>
}</td></tr>
<tr class="memdesc:gace10d4c0b0409d35c6a703d6445fc558"><td class="mdescLeft"> </td><td class="mdescRight">Specifies whether to perform encryption or decryption. <a href="group__BC__m.html#gace10d4c0b0409d35c6a703d6445fc558">More...</a><br/></td></tr>
<tr class="separator:gace10d4c0b0409d35c6a703d6445fc558"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gacc003baa6ffa4b315283282b19f081ec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* blockCipherModcrypt)(<a class="el" href="group__BC__m.html#gaa6f6ba122e489fd3c3923c83cb55dae0">blockCipherParam</a> *bp, uint32_t *dst, const uint32_t *src, unsigned int nblocks)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Prototype for a <em>encryption</em> or decryption function which operates on multiple blocks in a certain mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bp</td><td>The blockcipher's parameters. </td></tr>
<tr><td class="paramname">dst</td><td>The ciphertext address; must be aligned on 32-bit boundary. </td></tr>
<tr><td class="paramname">src</td><td>The cleartext address; must be aligned on 32-bit boundary. </td></tr>
<tr><td class="paramname">nblocks</td><td>The number of blocks to process. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</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>
<a class="anchor" id="gaa6f6ba122e489fd3c3923c83cb55dae0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="group__BC__m.html#gaa6f6ba122e489fd3c3923c83cb55dae0">blockCipherParam</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Placeholder type definition for blockcipher parameters. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="structaesParam.html" title="Holds all the parameters necessary for the AES cipher. ">aesParam</a>, <a class="el" href="structblowfishParam.html" title="Holds all the parameters necessary for the Blowfish cipher. ">blowfishParam</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="ga49ec3da318c2c3ab4464c8dbb38617c5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* blockCipherRawcrypt)(<a class="el" href="group__BC__m.html#gaa6f6ba122e489fd3c3923c83cb55dae0">blockCipherParam</a> *bp, uint32_t *dst, const uint32_t *src)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Prototype for a <em>raw</em> encryption or decryption function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bp</td><td>The blockcipher's parameters. </td></tr>
<tr><td class="paramname">dst</td><td>The ciphertext address; must be aligned on 32-bit boundary. </td></tr>
<tr><td class="paramname">src</td><td>The cleartext address; must be aligned on 32-bit boundary. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</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>
<a class="anchor" id="gae6164c8a42013a0b3aadba1bccd416af"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* blockCipherSetCTR)(<a class="el" href="group__BC__m.html#gaa6f6ba122e489fd3c3923c83cb55dae0">blockCipherParam</a> *bp, const <a class="el" href="api_8h.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> *nivz, size_t counter)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Prototype definition for an initialization vector setup function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bp</td><td>The blockcipher's parameters. </td></tr>
<tr><td class="paramname">nivz</td><td>The concatenation of the Nonce, IV and padding Zero bytes. </td></tr>
<tr><td class="paramname">counter</td><td>The blockciphers' counter value. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>nivz length must be equal to the cipher's block size. </dd></dl>
<dl class="retval"><dt>Return values</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>
<a class="anchor" id="ga40aeffa20f977393fbf10378ef466c25"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* blockCipherSetIV)(<a class="el" href="group__BC__m.html#gaa6f6ba122e489fd3c3923c83cb55dae0">blockCipherParam</a> *bp, const <a class="el" href="api_8h.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> *iv)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Prototype definition for an initialization vector setup function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bp</td><td>The blockcipher's parameters. </td></tr>
<tr><td class="paramname">iv</td><td>The blockciphers' IV value. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>iv length must be equal to the cipher's block size. </dd></dl>
<dl class="retval"><dt>Return values</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>
<a class="anchor" id="ga4bb0a804ab2c38ac56120f1cd35600b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* blockCipherSetup)(<a class="el" href="group__BC__m.html#gaa6f6ba122e489fd3c3923c83cb55dae0">blockCipherParam</a> *, const <a class="el" href="api_8h.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> *, size_t, <a class="el" href="group__BC__m.html#gace10d4c0b0409d35c6a703d6445fc558">cipherOperation</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Prototype definition for a setup function. </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="gace10d4c0b0409d35c6a703d6445fc558"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__BC__m.html#gace10d4c0b0409d35c6a703d6445fc558">cipherOperation</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Specifies whether to perform encryption or decryption. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gace10d4c0b0409d35c6a703d6445fc558a8d67fb0581b95ff8d49840ebfaedffd4"></a>NOCRYPT</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gace10d4c0b0409d35c6a703d6445fc558a606f7451c00ce2831f56eceb9ab6bb96"></a>ENCRYPT</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gace10d4c0b0409d35c6a703d6445fc558a3179dbaa639c5906029876801dcf4e11"></a>DECRYPT</em> </td><td class="fielddoc">
</td></tr>
</table>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Sep 27 2013 02:36:25 for BeeCrypt 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>
