<!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.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>mbed TLS v2.7.6: mbedtls_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 id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">mbed TLS v2.7.6 </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.13 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> $(function() { initMenu('',false,false,'search.php','Search'); }); </script> <div id="main-nav"></div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-attribs">Data Fields</a> </div> <div class="headertitle"> <div class="title">mbedtls_cipher_info_t Struct Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="cipher_8h_source.html">cipher.h</a>></code></p> <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:a399f289efa81ca0da63bc80686b5fe82"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cipher_8h.html#a00c5885f1ea7279c5a7d8e12e596569d">mbedtls_cipher_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmbedtls__cipher__info__t.html#a399f289efa81ca0da63bc80686b5fe82">type</a></td></tr> <tr class="separator:a399f289efa81ca0da63bc80686b5fe82"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6603375900f4834ae6c91e305aef34f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cipher_8h.html#adf5f7524a682fa63093dd0fa608fb2f8">mbedtls_cipher_mode_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmbedtls__cipher__info__t.html#a6603375900f4834ae6c91e305aef34f6">mode</a></td></tr> <tr class="separator:a6603375900f4834ae6c91e305aef34f6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a21ac3fc6bf536ce16f1754301e7fe3c9"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structmbedtls__cipher__info__t.html#a21ac3fc6bf536ce16f1754301e7fe3c9">key_bitlen</a></td></tr> <tr class="separator:a21ac3fc6bf536ce16f1754301e7fe3c9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7e79a9fb2bd143cc08d59b89b86c9ed7"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmbedtls__cipher__info__t.html#a7e79a9fb2bd143cc08d59b89b86c9ed7">name</a></td></tr> <tr class="separator:a7e79a9fb2bd143cc08d59b89b86c9ed7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3416bc1e18e1694da17bc922f152b20d"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structmbedtls__cipher__info__t.html#a3416bc1e18e1694da17bc922f152b20d">iv_size</a></td></tr> <tr class="separator:a3416bc1e18e1694da17bc922f152b20d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af0aa5e7fedfd8a85434ec43691d890d8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structmbedtls__cipher__info__t.html#af0aa5e7fedfd8a85434ec43691d890d8">flags</a></td></tr> <tr class="separator:af0aa5e7fedfd8a85434ec43691d890d8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7be9560c375110a1d829407e74ab698f"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structmbedtls__cipher__info__t.html#a7be9560c375110a1d829407e74ab698f">block_size</a></td></tr> <tr class="separator:a7be9560c375110a1d829407e74ab698f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab49e136926e04b02806503deb8844f2d"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="cipher_8h.html#aa8cada37dceeb13446c7c31459b31a07">mbedtls_cipher_base_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmbedtls__cipher__info__t.html#ab49e136926e04b02806503deb8844f2d">base</a></td></tr> <tr class="separator:ab49e136926e04b02806503deb8844f2d"><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. Allows calling cipher functions in a generic way. </p> <p class="definition">Definition at line <a class="el" href="cipher_8h_source.html#l00207">207</a> of file <a class="el" href="cipher_8h_source.html">cipher.h</a>.</p> </div><h2 class="groupheader">Field Documentation</h2> <a id="ab49e136926e04b02806503deb8844f2d"></a> <h2 class="memtitle"><span class="permalink"><a href="#ab49e136926e04b02806503deb8844f2d">◆ </a></span>base</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="cipher_8h.html#aa8cada37dceeb13446c7c31459b31a07">mbedtls_cipher_base_t</a>* mbedtls_cipher_info_t::base</td> </tr> </table> </div><div class="memdoc"> <p>Struct for base cipher information and functions. </p> <p class="definition">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> </div> </div> <a id="a7be9560c375110a1d829407e74ab698f"></a> <h2 class="memtitle"><span class="permalink"><a href="#a7be9560c375110a1d829407e74ab698f">◆ </a></span>block_size</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int mbedtls_cipher_info_t::block_size</td> </tr> </table> </div><div class="memdoc"> <p>The block size, in Bytes. </p> <p class="definition">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 class="reference">Referenced by <a class="el" href="cipher_8h_source.html#l00374">mbedtls_cipher_get_block_size()</a>.</p> </div> </div> <a id="af0aa5e7fedfd8a85434ec43691d890d8"></a> <h2 class="memtitle"><span class="permalink"><a href="#af0aa5e7fedfd8a85434ec43691d890d8">◆ </a></span>flags</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_cipher_info_t::flags</td> </tr> </table> </div><div class="memdoc"> <p>Flags to set. For example, if the cipher supports variable IV sizes or variable key sizes. </p> <p class="definition">Definition at line <a class="el" href="cipher_8h_source.html#l00232">232</a> of file <a class="el" href="cipher_8h_source.html">cipher.h</a>.</p> </div> </div> <a id="a3416bc1e18e1694da17bc922f152b20d"></a> <h2 class="memtitle"><span class="permalink"><a href="#a3416bc1e18e1694da17bc922f152b20d">◆ </a></span>iv_size</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int mbedtls_cipher_info_t::iv_size</td> </tr> </table> </div><div class="memdoc"> <p>IV or nonce size, in Bytes. For ciphers that accept variable IV sizes, this is the recommended size. </p> <p class="definition">Definition at line <a class="el" href="cipher_8h_source.html#l00229">229</a> of file <a class="el" href="cipher_8h_source.html">cipher.h</a>.</p> <p class="reference">Referenced by <a class="el" href="cipher_8h_source.html#l00409">mbedtls_cipher_get_iv_size()</a>.</p> </div> </div> <a id="a21ac3fc6bf536ce16f1754301e7fe3c9"></a> <h2 class="memtitle"><span class="permalink"><a href="#a21ac3fc6bf536ce16f1754301e7fe3c9">◆ </a></span>key_bitlen</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int mbedtls_cipher_info_t::key_bitlen</td> </tr> </table> </div><div class="memdoc"> <p>The cipher key length, in bits. This is the default length for variable sized ciphers. Includes parity bits for ciphers like DES. </p> <p class="definition">Definition at line <a class="el" href="cipher_8h_source.html#l00220">220</a> of file <a class="el" href="cipher_8h_source.html">cipher.h</a>.</p> <p class="reference">Referenced by <a class="el" href="cipher_8h_source.html#l00462">mbedtls_cipher_get_key_bitlen()</a>.</p> </div> </div> <a id="a6603375900f4834ae6c91e305aef34f6"></a> <h2 class="memtitle"><span class="permalink"><a href="#a6603375900f4834ae6c91e305aef34f6">◆ </a></span>mode</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="cipher_8h.html#adf5f7524a682fa63093dd0fa608fb2f8">mbedtls_cipher_mode_t</a> mbedtls_cipher_info_t::mode</td> </tr> </table> </div><div class="memdoc"> <p>The cipher mode. For example, MBEDTLS_MODE_CBC. </p> <p class="definition">Definition at line <a class="el" href="cipher_8h_source.html#l00214">214</a> of file <a class="el" href="cipher_8h_source.html">cipher.h</a>.</p> <p class="reference">Referenced by <a class="el" href="cipher_8h_source.html#l00391">mbedtls_cipher_get_cipher_mode()</a>.</p> </div> </div> <a id="a7e79a9fb2bd143cc08d59b89b86c9ed7"></a> <h2 class="memtitle"><span class="permalink"><a href="#a7e79a9fb2bd143cc08d59b89b86c9ed7">◆ </a></span>name</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* mbedtls_cipher_info_t::name</td> </tr> </table> </div><div class="memdoc"> <p>Name of the cipher. </p> <p class="definition">Definition at line <a class="el" href="cipher_8h_source.html#l00223">223</a> of file <a class="el" href="cipher_8h_source.html">cipher.h</a>.</p> <p class="reference">Referenced by <a class="el" href="cipher_8h_source.html#l00445">mbedtls_cipher_get_name()</a>.</p> </div> </div> <a id="a399f289efa81ca0da63bc80686b5fe82"></a> <h2 class="memtitle"><span class="permalink"><a href="#a399f289efa81ca0da63bc80686b5fe82">◆ </a></span>type</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="cipher_8h.html#a00c5885f1ea7279c5a7d8e12e596569d">mbedtls_cipher_type_t</a> mbedtls_cipher_info_t::type</td> </tr> </table> </div><div class="memdoc"> <p>Full cipher identifier. For example, MBEDTLS_CIPHER_AES_256_CBC. </p> <p class="definition">Definition at line <a class="el" href="cipher_8h_source.html#l00211">211</a> of file <a class="el" href="cipher_8h_source.html">cipher.h</a>.</p> <p class="reference">Referenced by <a class="el" href="cipher_8h_source.html#l00428">mbedtls_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 Fri Oct 12 2018 20:26:59 for mbed TLS v2.7.6 by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.13 </small></address> </body> </html>