<!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: arc4.h File 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 id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b4d146e9a6d8dd56ed4afb2480a97fd3.html">mbedtls</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#nested-classes">Data Structures</a> | <a href="#define-members">Macros</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">arc4.h File Reference</div> </div> </div><!--header--> <div class="contents"> <p>The ARCFOUR stream cipher. <a href="#details">More...</a></p> <div class="textblock"><code>#include "<a class="el" href="config_8h_source.html">config.h</a>"</code><br /> <code>#include <stddef.h></code><br /> </div><div class="textblock"><div class="dynheader"> Include dependency graph for arc4.h:</div> <div class="dyncontent"> <div class="center"><img src="arc4_8h__incl.png" border="0" usemap="#arc4_8h" alt=""/></div> <map name="arc4_8h" id="arc4_8h"> <area shape="rect" id="node2" href="config_8h.html" title="Configuration options (set of defines) " alt="" coords="35,80,138,107"/> <area shape="rect" id="node3" href="check__config_8h.html" title="Consistency checks for configuration options. " alt="" coords="5,155,168,181"/> </map> </div> </div> <p><a href="arc4_8h_source.html">Go to the source code of this file.</a></p> <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="structmbedtls__arc4__context.html">mbedtls_arc4_context</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">ARC4 context structure. <a href="structmbedtls__arc4__context.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="define-members"></a> Macros</h2></td></tr> <tr class="memitem:a8dc53076b58b94fa82cd9a76b39f0e78"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="arc4_8h.html#a8dc53076b58b94fa82cd9a76b39f0e78">MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED</a>   -0x0019</td></tr> <tr class="separator:a8dc53076b58b94fa82cd9a76b39f0e78"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:a7795c92c7a8a4b9cf715da081665ccfd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="arc4_8h.html#a7795c92c7a8a4b9cf715da081665ccfd">mbedtls_arc4_init</a> (<a class="el" href="structmbedtls__arc4__context.html">mbedtls_arc4_context</a> *ctx)</td></tr> <tr class="memdesc:a7795c92c7a8a4b9cf715da081665ccfd"><td class="mdescLeft"> </td><td class="mdescRight">Initialize ARC4 context. <a href="#a7795c92c7a8a4b9cf715da081665ccfd">More...</a><br /></td></tr> <tr class="separator:a7795c92c7a8a4b9cf715da081665ccfd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a888a4167caf8503e9e82a132c7b89313"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="arc4_8h.html#a888a4167caf8503e9e82a132c7b89313">mbedtls_arc4_free</a> (<a class="el" href="structmbedtls__arc4__context.html">mbedtls_arc4_context</a> *ctx)</td></tr> <tr class="memdesc:a888a4167caf8503e9e82a132c7b89313"><td class="mdescLeft"> </td><td class="mdescRight">Clear ARC4 context. <a href="#a888a4167caf8503e9e82a132c7b89313">More...</a><br /></td></tr> <tr class="separator:a888a4167caf8503e9e82a132c7b89313"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6a689a989cb433e41181caef8d8bf4ba"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="arc4_8h.html#a6a689a989cb433e41181caef8d8bf4ba">mbedtls_arc4_setup</a> (<a class="el" href="structmbedtls__arc4__context.html">mbedtls_arc4_context</a> *ctx, const unsigned char *key, unsigned int keylen)</td></tr> <tr class="memdesc:a6a689a989cb433e41181caef8d8bf4ba"><td class="mdescLeft"> </td><td class="mdescRight">ARC4 key schedule. <a href="#a6a689a989cb433e41181caef8d8bf4ba">More...</a><br /></td></tr> <tr class="separator:a6a689a989cb433e41181caef8d8bf4ba"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a51d378246f0c277a68352cdac782e8fb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="arc4_8h.html#a51d378246f0c277a68352cdac782e8fb">mbedtls_arc4_crypt</a> (<a class="el" href="structmbedtls__arc4__context.html">mbedtls_arc4_context</a> *ctx, size_t length, const unsigned char *input, unsigned char *output)</td></tr> <tr class="memdesc:a51d378246f0c277a68352cdac782e8fb"><td class="mdescLeft"> </td><td class="mdescRight">ARC4 cipher function. <a href="#a51d378246f0c277a68352cdac782e8fb">More...</a><br /></td></tr> <tr class="separator:a51d378246f0c277a68352cdac782e8fb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aba830fee9057fa1c63dcc38c7caf7730"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="arc4_8h.html#aba830fee9057fa1c63dcc38c7caf7730">mbedtls_arc4_self_test</a> (int verbose)</td></tr> <tr class="memdesc:aba830fee9057fa1c63dcc38c7caf7730"><td class="mdescLeft"> </td><td class="mdescRight">Checkup routine. <a href="#aba830fee9057fa1c63dcc38c7caf7730">More...</a><br /></td></tr> <tr class="separator:aba830fee9057fa1c63dcc38c7caf7730"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>The ARCFOUR stream cipher. </p> <dl class="section warning"><dt>Warning</dt><dd>ARC4 is considered a weak cipher and its use constitutes a security risk. We recommend considering stronger ciphers instead. </dd></dl> <p class="definition">Definition in file <a class="el" href="arc4_8h_source.html">arc4.h</a>.</p> </div><h2 class="groupheader">Macro Definition Documentation</h2> <a id="a8dc53076b58b94fa82cd9a76b39f0e78"></a> <h2 class="memtitle"><span class="permalink"><a href="#a8dc53076b58b94fa82cd9a76b39f0e78">◆ </a></span>MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED   -0x0019</td> </tr> </table> </div><div class="memdoc"> <p>ARC4 hardware accelerator failed. </p> <p class="definition">Definition at line <a class="el" href="arc4_8h_source.html#l00039">39</a> of file <a class="el" href="arc4_8h_source.html">arc4.h</a>.</p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a id="a51d378246f0c277a68352cdac782e8fb"></a> <h2 class="memtitle"><span class="permalink"><a href="#a51d378246f0c277a68352cdac782e8fb">◆ </a></span>mbedtls_arc4_crypt()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_arc4_crypt </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__arc4__context.html">mbedtls_arc4_context</a> * </td> <td class="paramname"><em>ctx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>length</em>, </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>ARC4 cipher function. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>ARC4 context </td></tr> <tr><td class="paramname">length</td><td>length of the input data </td></tr> <tr><td class="paramname">input</td><td>buffer holding the input data </td></tr> <tr><td class="paramname">output</td><td>buffer for the output data</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>0 if successful</dd></dl> <dl class="section warning"><dt>Warning</dt><dd>ARC4 is considered a weak cipher and its use constitutes a security risk. We recommend considering stronger ciphers instead. </dd></dl> </div> </div> <a id="a888a4167caf8503e9e82a132c7b89313"></a> <h2 class="memtitle"><span class="permalink"><a href="#a888a4167caf8503e9e82a132c7b89313">◆ </a></span>mbedtls_arc4_free()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void mbedtls_arc4_free </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__arc4__context.html">mbedtls_arc4_context</a> * </td> <td class="paramname"><em>ctx</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Clear ARC4 context. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>ARC4 context to be cleared</td></tr> </table> </dd> </dl> <dl class="section warning"><dt>Warning</dt><dd>ARC4 is considered a weak cipher and its use constitutes a security risk. We recommend considering stronger ciphers instead. </dd></dl> </div> </div> <a id="a7795c92c7a8a4b9cf715da081665ccfd"></a> <h2 class="memtitle"><span class="permalink"><a href="#a7795c92c7a8a4b9cf715da081665ccfd">◆ </a></span>mbedtls_arc4_init()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void mbedtls_arc4_init </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__arc4__context.html">mbedtls_arc4_context</a> * </td> <td class="paramname"><em>ctx</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Initialize ARC4 context. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>ARC4 context to be initialized</td></tr> </table> </dd> </dl> <dl class="section warning"><dt>Warning</dt><dd>ARC4 is considered a weak cipher and its use constitutes a security risk. We recommend considering stronger ciphers instead. </dd></dl> </div> </div> <a id="aba830fee9057fa1c63dcc38c7caf7730"></a> <h2 class="memtitle"><span class="permalink"><a href="#aba830fee9057fa1c63dcc38c7caf7730">◆ </a></span>mbedtls_arc4_self_test()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_arc4_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="section return"><dt>Returns</dt><dd>0 if successful, or 1 if the test failed</dd></dl> <dl class="section warning"><dt>Warning</dt><dd>ARC4 is considered a weak cipher and its use constitutes a security risk. We recommend considering stronger ciphers instead. </dd></dl> </div> </div> <a id="a6a689a989cb433e41181caef8d8bf4ba"></a> <h2 class="memtitle"><span class="permalink"><a href="#a6a689a989cb433e41181caef8d8bf4ba">◆ </a></span>mbedtls_arc4_setup()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void mbedtls_arc4_setup </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__arc4__context.html">mbedtls_arc4_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">unsigned int </td> <td class="paramname"><em>keylen</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>ARC4 key schedule. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>ARC4 context to be setup </td></tr> <tr><td class="paramname">key</td><td>the secret key </td></tr> <tr><td class="paramname">keylen</td><td>length of the key, in bytes</td></tr> </table> </dd> </dl> <dl class="section warning"><dt>Warning</dt><dd>ARC4 is considered a weak cipher and its use constitutes a security risk. We recommend considering stronger ciphers instead. </dd></dl> </div> </div> </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>