<!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: cipher_info_t Struct 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 class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">cipher_info_t Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Cipher information.
<a href="structcipher__info__t.html#details">More...</a></p>
<p><code>#include <<a class="el" href="cipher_8h_source.html">cipher.h</a>></code></p>
<div class="dynheader">
Collaboration diagram for cipher_info_t:</div>
<div class="dyncontent">
<div class="center"><img src="structcipher__info__t__coll__graph.png" border="0" usemap="#cipher__info__t_coll__map" alt="Collaboration graph"/></div>
<map name="cipher__info__t_coll__map" id="cipher__info__t_coll__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a4cd6c957b0a94edbc002b5ab070dc0fe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cipher_8h.html#a806c82ed7e8b591dedc86093f38274e6">cipher_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structcipher__info__t.html#a4cd6c957b0a94edbc002b5ab070dc0fe">type</a></td></tr>
<tr class="memdesc:a4cd6c957b0a94edbc002b5ab070dc0fe"><td class="mdescLeft"> </td><td class="mdescRight">Full cipher identifier (e.g. <a href="#a4cd6c957b0a94edbc002b5ab070dc0fe">More...</a><br/></td></tr>
<tr class="separator:a4cd6c957b0a94edbc002b5ab070dc0fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a61c2ca01508859a6119d8b4c22e2edd2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cipher_8h.html#af65d0bd9b5c3504fd010cf54955b179c">cipher_mode_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structcipher__info__t.html#a61c2ca01508859a6119d8b4c22e2edd2">mode</a></td></tr>
<tr class="memdesc:a61c2ca01508859a6119d8b4c22e2edd2"><td class="mdescLeft"> </td><td class="mdescRight">Cipher mode (e.g. <a href="#a61c2ca01508859a6119d8b4c22e2edd2">More...</a><br/></td></tr>
<tr class="separator:a61c2ca01508859a6119d8b4c22e2edd2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a22ee6e5c529e10cbe6225d71460b26"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structcipher__info__t.html#a2a22ee6e5c529e10cbe6225d71460b26">key_length</a></td></tr>
<tr class="memdesc:a2a22ee6e5c529e10cbe6225d71460b26"><td class="mdescLeft"> </td><td class="mdescRight">Cipher key length, in bits (default length for variable sized ciphers) (Includes parity bits for ciphers like DES) <a href="#a2a22ee6e5c529e10cbe6225d71460b26">More...</a><br/></td></tr>
<tr class="separator:a2a22ee6e5c529e10cbe6225d71460b26"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9b189d0ce9de3eada6b874f1ce8a7393"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcipher__info__t.html#a9b189d0ce9de3eada6b874f1ce8a7393">name</a></td></tr>
<tr class="memdesc:a9b189d0ce9de3eada6b874f1ce8a7393"><td class="mdescLeft"> </td><td class="mdescRight">Name of the cipher. <a href="#a9b189d0ce9de3eada6b874f1ce8a7393">More...</a><br/></td></tr>
<tr class="separator:a9b189d0ce9de3eada6b874f1ce8a7393"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae8fde413dc240da60f4062c3138eec0a"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structcipher__info__t.html#ae8fde413dc240da60f4062c3138eec0a">iv_size</a></td></tr>
<tr class="memdesc:ae8fde413dc240da60f4062c3138eec0a"><td class="mdescLeft"> </td><td class="mdescRight">IV/NONCE size, in bytes. <a href="#ae8fde413dc240da60f4062c3138eec0a">More...</a><br/></td></tr>
<tr class="separator:ae8fde413dc240da60f4062c3138eec0a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab3a9f706fa42f9a43a0e8d50ac54a959"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structcipher__info__t.html#ab3a9f706fa42f9a43a0e8d50ac54a959">flags</a></td></tr>
<tr class="memdesc:ab3a9f706fa42f9a43a0e8d50ac54a959"><td class="mdescLeft"> </td><td class="mdescRight">Flags for variable IV size, variable key size, etc. <a href="#ab3a9f706fa42f9a43a0e8d50ac54a959">More...</a><br/></td></tr>
<tr class="separator:ab3a9f706fa42f9a43a0e8d50ac54a959"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7e21795685c79613b5125ca608b0c63b"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structcipher__info__t.html#a7e21795685c79613b5125ca608b0c63b">block_size</a></td></tr>
<tr class="memdesc:a7e21795685c79613b5125ca608b0c63b"><td class="mdescLeft"> </td><td class="mdescRight">block size, in bytes <a href="#a7e21795685c79613b5125ca608b0c63b">More...</a><br/></td></tr>
<tr class="separator:a7e21795685c79613b5125ca608b0c63b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a12c80723dd2c354ff5596b0931d4fedb"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structcipher__base__t.html">cipher_base_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcipher__info__t.html#a12c80723dd2c354ff5596b0931d4fedb">base</a></td></tr>
<tr class="memdesc:a12c80723dd2c354ff5596b0931d4fedb"><td class="mdescLeft"> </td><td class="mdescRight">Base cipher information and functions. <a href="#a12c80723dd2c354ff5596b0931d4fedb">More...</a><br/></td></tr>
<tr class="separator:a12c80723dd2c354ff5596b0931d4fedb"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Cipher information. </p>
<p>Allows cipher functions to be called in a generic way. </p>
<p>Definition at line <a class="el" href="cipher_8h_source.html#l00226">226</a> of file <a class="el" href="cipher_8h_source.html">cipher.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a12c80723dd2c354ff5596b0931d4fedb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structcipher__base__t.html">cipher_base_t</a>* cipher_info_t::base</td>
</tr>
</table>
</div><div class="memdoc">
<p>Base cipher information and functions. </p>
<p>Definition at line <a class="el" href="cipher_8h_source.html#l00251">251</a> of file <a class="el" href="cipher_8h_source.html">cipher.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7e21795685c79613b5125ca608b0c63b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int cipher_info_t::block_size</td>
</tr>
</table>
</div><div class="memdoc">
<p>block size, in bytes </p>
<p>Definition at line <a class="el" href="cipher_8h_source.html#l00248">248</a> of file <a class="el" href="cipher_8h_source.html">cipher.h</a>.</p>
<p>Referenced by <a class="el" href="cipher_8h_source.html#l00384">cipher_get_block_size()</a>.</p>
</div>
</div>
<a class="anchor" id="ab3a9f706fa42f9a43a0e8d50ac54a959"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int cipher_info_t::flags</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flags for variable IV size, variable key size, etc. </p>
<p>Definition at line <a class="el" href="cipher_8h_source.html#l00245">245</a> of file <a class="el" href="cipher_8h_source.html">cipher.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae8fde413dc240da60f4062c3138eec0a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int cipher_info_t::iv_size</td>
</tr>
</table>
</div><div class="memdoc">
<p>IV/NONCE size, in bytes. </p>
<p>For cipher that accept many sizes: recommended size </p>
<p>Definition at line <a class="el" href="cipher_8h_source.html#l00242">242</a> of file <a class="el" href="cipher_8h_source.html">cipher.h</a>.</p>
<p>Referenced by <a class="el" href="cipher_8h_source.html#l00418">cipher_get_iv_size()</a>.</p>
</div>
</div>
<a class="anchor" id="a2a22ee6e5c529e10cbe6225d71460b26"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int cipher_info_t::key_length</td>
</tr>
</table>
</div><div class="memdoc">
<p>Cipher key length, in bits (default length for variable sized ciphers) (Includes parity bits for ciphers like DES) </p>
<p>Definition at line <a class="el" href="cipher_8h_source.html#l00235">235</a> of file <a class="el" href="cipher_8h_source.html">cipher.h</a>.</p>
<p>Referenced by <a class="el" href="cipher_8h_source.html#l00469">cipher_get_key_size()</a>.</p>
</div>
</div>
<a class="anchor" id="a61c2ca01508859a6119d8b4c22e2edd2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="cipher_8h.html#af65d0bd9b5c3504fd010cf54955b179c">cipher_mode_t</a> cipher_info_t::mode</td>
</tr>
</table>
</div><div class="memdoc">
<p>Cipher mode (e.g. </p>
<p>POLARSSL_MODE_CBC) </p>
<p>Definition at line <a class="el" href="cipher_8h_source.html#l00231">231</a> of file <a class="el" href="cipher_8h_source.html">cipher.h</a>.</p>
<p>Referenced by <a class="el" href="cipher_8h_source.html#l00401">cipher_get_cipher_mode()</a>.</p>
</div>
</div>
<a class="anchor" id="a9b189d0ce9de3eada6b874f1ce8a7393"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* cipher_info_t::name</td>
</tr>
</table>
</div><div class="memdoc">
<p>Name of the cipher. </p>
<p>Definition at line <a class="el" href="cipher_8h_source.html#l00238">238</a> of file <a class="el" href="cipher_8h_source.html">cipher.h</a>.</p>
<p>Referenced by <a class="el" href="cipher_8h_source.html#l00452">cipher_get_name()</a>.</p>
</div>
</div>
<a class="anchor" id="a4cd6c957b0a94edbc002b5ab070dc0fe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="cipher_8h.html#a806c82ed7e8b591dedc86093f38274e6">cipher_type_t</a> cipher_info_t::type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Full cipher identifier (e.g. </p>
<p>POLARSSL_CIPHER_AES_256_CBC) </p>
<p>Definition at line <a class="el" href="cipher_8h_source.html#l00228">228</a> of file <a class="el" href="cipher_8h_source.html">cipher.h</a>.</p>
<p>Referenced by <a class="el" href="cipher_8h_source.html#l00437">cipher_get_type()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="cipher_8h_source.html">cipher.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jul 31 2014 11:35:56 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>
