<!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: 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 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><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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_6a9bbd12bf4e19a18c45e270f8fae3fd.html">include</a></li><li class="navelem"><a class="el" href="dir_04272d44da4745cf8b8bfc767d6c6523.html">polarssl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</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 <string.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">
</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="structarc4__context.html">arc4_context</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">ARC4 context structure. <a href="structarc4__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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a32d90c8a314010e5ac0384bbcc193264"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="arc4_8h.html#a32d90c8a314010e5ac0384bbcc193264">arc4_init</a> (<a class="el" href="structarc4__context.html">arc4_context</a> *ctx)</td></tr>
<tr class="memdesc:a32d90c8a314010e5ac0384bbcc193264"><td class="mdescLeft"> </td><td class="mdescRight">Initialize ARC4 context. <a href="#a32d90c8a314010e5ac0384bbcc193264">More...</a><br/></td></tr>
<tr class="separator:a32d90c8a314010e5ac0384bbcc193264"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab3cb9f8e84a0f4ac61adeaddfe4cf09f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="arc4_8h.html#ab3cb9f8e84a0f4ac61adeaddfe4cf09f">arc4_free</a> (<a class="el" href="structarc4__context.html">arc4_context</a> *ctx)</td></tr>
<tr class="memdesc:ab3cb9f8e84a0f4ac61adeaddfe4cf09f"><td class="mdescLeft"> </td><td class="mdescRight">Clear ARC4 context. <a href="#ab3cb9f8e84a0f4ac61adeaddfe4cf09f">More...</a><br/></td></tr>
<tr class="separator:ab3cb9f8e84a0f4ac61adeaddfe4cf09f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1fd99cbe46d7967970631b7479570797"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="arc4_8h.html#a1fd99cbe46d7967970631b7479570797">arc4_setup</a> (<a class="el" href="structarc4__context.html">arc4_context</a> *ctx, const unsigned char *key, unsigned int keylen)</td></tr>
<tr class="memdesc:a1fd99cbe46d7967970631b7479570797"><td class="mdescLeft"> </td><td class="mdescRight">ARC4 key schedule. <a href="#a1fd99cbe46d7967970631b7479570797">More...</a><br/></td></tr>
<tr class="separator:a1fd99cbe46d7967970631b7479570797"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa67f458b02967bbf09f14592de4edece"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="arc4_8h.html#aa67f458b02967bbf09f14592de4edece">arc4_crypt</a> (<a class="el" href="structarc4__context.html">arc4_context</a> *ctx, size_t length, const unsigned char *input, unsigned char *output)</td></tr>
<tr class="memdesc:aa67f458b02967bbf09f14592de4edece"><td class="mdescLeft"> </td><td class="mdescRight">ARC4 cipher function. <a href="#aa67f458b02967bbf09f14592de4edece">More...</a><br/></td></tr>
<tr class="separator:aa67f458b02967bbf09f14592de4edece"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae9b94957789aa35bb249236fb1b2cf86"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="arc4_8h.html#ae9b94957789aa35bb249236fb1b2cf86">arc4_self_test</a> (int verbose)</td></tr>
<tr class="memdesc:ae9b94957789aa35bb249236fb1b2cf86"><td class="mdescLeft"> </td><td class="mdescRight">Checkup routine. <a href="#ae9b94957789aa35bb249236fb1b2cf86">More...</a><br/></td></tr>
<tr class="separator:ae9b94957789aa35bb249236fb1b2cf86"><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>
<p>Copyright (C) 2006-2014, Brainspark B.V.</p>
<p>This file is part of PolarSSL (<a href="http://www.polarssl.org">http://www.polarssl.org</a>) Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org></p>
<p>All rights reserved.</p>
<p>This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. </p>
<p>Definition in file <a class="el" href="arc4_8h_source.html">arc4.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="aa67f458b02967bbf09f14592de4edece"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int arc4_crypt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structarc4__context.html">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>
</div>
</div>
<a class="anchor" id="ab3cb9f8e84a0f4ac61adeaddfe4cf09f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void arc4_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structarc4__context.html">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>
</div>
</div>
<a class="anchor" id="a32d90c8a314010e5ac0384bbcc193264"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void arc4_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structarc4__context.html">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>
</div>
</div>
<a class="anchor" id="ae9b94957789aa35bb249236fb1b2cf86"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int 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>
</div>
</div>
<a class="anchor" id="a1fd99cbe46d7967970631b7479570797"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void arc4_setup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structarc4__context.html">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>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jul 31 2014 11:35:55 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>
