Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 8df484ca79a7b6bb61e4a376e1506870 > files > 43

polarssl-devel-0.14.3-1.fc14.x86_64.rpm

<!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"/>
<title>PolarSSL: polarssl/camellia.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">PolarSSL</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li id="searchli">
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#define-members">Defines</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">polarssl/camellia.h File Reference</div>  </div>
</div>
<div class="contents">
<div class="textblock"><code>#include &lt;inttypes.h&gt;</code><br/>
</div>
<p><a href="camellia_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcamellia__context.html">camellia_context</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">CAMELLIA context structure.  <a href="structcamellia__context.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeac0ba1b8a0caa424d8c33b7d616a758"></a><!-- doxytag: member="camellia.h::CAMELLIA_ENCRYPT" ref="aeac0ba1b8a0caa424d8c33b7d616a758" args="" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CAMELLIA_ENCRYPT</b>&#160;&#160;&#160;1</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f0130ae5c96dd542e1d1d9e87d7f529"></a><!-- doxytag: member="camellia.h::CAMELLIA_DECRYPT" ref="a1f0130ae5c96dd542e1d1d9e87d7f529" args="" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CAMELLIA_DECRYPT</b>&#160;&#160;&#160;0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8bbda0567c613d789430c69ba5069fad"></a><!-- doxytag: member="camellia.h::POLARSSL_ERR_CAMELLIA_INVALID_KEY_LENGTH" ref="a8bbda0567c613d789430c69ba5069fad" args="" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><b>POLARSSL_ERR_CAMELLIA_INVALID_KEY_LENGTH</b>&#160;&#160;&#160;-0x0a00</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0638bc59431e0d199ffc8353feb738aa"></a><!-- doxytag: member="camellia.h::POLARSSL_ERR_CAMELLIA_INVALID_INPUT_LENGTH" ref="a0638bc59431e0d199ffc8353feb738aa" args="" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><b>POLARSSL_ERR_CAMELLIA_INVALID_INPUT_LENGTH</b>&#160;&#160;&#160;-0x0a10</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="camellia_8h.html#af89a45b96409dba1926288ab0e5b9d12">camellia_setkey_enc</a> (<a class="el" href="structcamellia__context.html">camellia_context</a> *ctx, const unsigned char *key, int keysize)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">CAMELLIA key schedule (encryption)  <a href="#af89a45b96409dba1926288ab0e5b9d12"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="camellia_8h.html#aa03870ab00cd673b3fb771666ce32536">camellia_setkey_dec</a> (<a class="el" href="structcamellia__context.html">camellia_context</a> *ctx, const unsigned char *key, int keysize)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">CAMELLIA key schedule (decryption)  <a href="#aa03870ab00cd673b3fb771666ce32536"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="camellia_8h.html#a781be26447d028c07f60247532992c3f">camellia_crypt_ecb</a> (<a class="el" href="structcamellia__context.html">camellia_context</a> *ctx, int mode, const unsigned char input[16], unsigned char output[16])</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">CAMELLIA-ECB block encryption/decryption.  <a href="#a781be26447d028c07f60247532992c3f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="camellia_8h.html#a3015e54afc816df743c0b3b1764d72f9">camellia_crypt_cbc</a> (<a class="el" href="structcamellia__context.html">camellia_context</a> *ctx, int mode, int length, unsigned char iv[16], const unsigned char *input, unsigned char *output)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">CAMELLIA-CBC buffer encryption/decryption Length should be a multiple of the block size (16 bytes)  <a href="#a3015e54afc816df743c0b3b1764d72f9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="camellia_8h.html#a87a3acb7da7d0a37a583ed08d4c8d1cf">camellia_crypt_cfb128</a> (<a class="el" href="structcamellia__context.html">camellia_context</a> *ctx, int mode, int length, int *iv_off, unsigned char iv[16], const unsigned char *input, unsigned char *output)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">CAMELLIA-CFB128 buffer encryption/decryption.  <a href="#a87a3acb7da7d0a37a583ed08d4c8d1cf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="camellia_8h.html#aefe7032855e7365dcb4771b80b6f4d70">camellia_self_test</a> (int verbose)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Checkup routine.  <a href="#aefe7032855e7365dcb4771b80b6f4d70"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Copyright (C) 2006-2010, 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 &lt;polarssl_maintainer at polarssl.org&gt;</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>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="a3015e54afc816df743c0b3b1764d72f9"></a><!-- doxytag: member="camellia.h::camellia_crypt_cbc" ref="a3015e54afc816df743c0b3b1764d72f9" args="(camellia_context *ctx, int mode, int length, unsigned char iv[16], const unsigned char *input, unsigned char *output)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int camellia_crypt_cbc </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcamellia__context.html">camellia_context</a> *&#160;</td>
          <td class="paramname"><em>ctx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>mode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>length</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned char&#160;</td>
          <td class="paramname"><em>iv</em>[16], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const unsigned char *&#160;</td>
          <td class="paramname"><em>input</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned char *&#160;</td>
          <td class="paramname"><em>output</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>CAMELLIA-CBC buffer encryption/decryption Length should be a multiple of the block size (16 bytes) </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">ctx</td><td>CAMELLIA context </td></tr>
    <tr><td class="paramname">mode</td><td>CAMELLIA_ENCRYPT or CAMELLIA_DECRYPT </td></tr>
    <tr><td class="paramname">length</td><td>length of the input data </td></tr>
    <tr><td class="paramname">iv</td><td>initialization vector (updated after use) </td></tr>
    <tr><td class="paramname">input</td><td>buffer holding the input data </td></tr>
    <tr><td class="paramname">output</td><td>buffer holding the output data</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, or POLARSSL_ERR_CAMELLIA_INVALID_INPUT_LENGTH </dd></dl>

</div>
</div>
<a class="anchor" id="a87a3acb7da7d0a37a583ed08d4c8d1cf"></a><!-- doxytag: member="camellia.h::camellia_crypt_cfb128" ref="a87a3acb7da7d0a37a583ed08d4c8d1cf" args="(camellia_context *ctx, int mode, int length, int *iv_off, unsigned char iv[16], const unsigned char *input, unsigned char *output)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int camellia_crypt_cfb128 </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcamellia__context.html">camellia_context</a> *&#160;</td>
          <td class="paramname"><em>ctx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>mode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>length</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int *&#160;</td>
          <td class="paramname"><em>iv_off</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned char&#160;</td>
          <td class="paramname"><em>iv</em>[16], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const unsigned char *&#160;</td>
          <td class="paramname"><em>input</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned char *&#160;</td>
          <td class="paramname"><em>output</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>CAMELLIA-CFB128 buffer encryption/decryption. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">ctx</td><td>CAMELLIA context </td></tr>
    <tr><td class="paramname">mode</td><td>CAMELLIA_ENCRYPT or CAMELLIA_DECRYPT </td></tr>
    <tr><td class="paramname">length</td><td>length of the input data </td></tr>
    <tr><td class="paramname">iv_off</td><td>offset in IV (updated after use) </td></tr>
    <tr><td class="paramname">iv</td><td>initialization vector (updated after use) </td></tr>
    <tr><td class="paramname">input</td><td>buffer holding the input data </td></tr>
    <tr><td class="paramname">output</td><td>buffer holding the output data</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, or POLARSSL_ERR_CAMELLIA_INVALID_INPUT_LENGTH </dd></dl>

</div>
</div>
<a class="anchor" id="a781be26447d028c07f60247532992c3f"></a><!-- doxytag: member="camellia.h::camellia_crypt_ecb" ref="a781be26447d028c07f60247532992c3f" args="(camellia_context *ctx, int mode, const unsigned char input[16], unsigned char output[16])" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int camellia_crypt_ecb </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcamellia__context.html">camellia_context</a> *&#160;</td>
          <td class="paramname"><em>ctx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>mode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const unsigned char&#160;</td>
          <td class="paramname"><em>input</em>[16], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned char&#160;</td>
          <td class="paramname"><em>output</em>[16]&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>CAMELLIA-ECB block encryption/decryption. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">ctx</td><td>CAMELLIA context </td></tr>
    <tr><td class="paramname">mode</td><td>CAMELLIA_ENCRYPT or CAMELLIA_DECRYPT </td></tr>
    <tr><td class="paramname">input</td><td>16-byte input block </td></tr>
    <tr><td class="paramname">output</td><td>16-byte output block</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful </dd></dl>

</div>
</div>
<a class="anchor" id="aefe7032855e7365dcb4771b80b6f4d70"></a><!-- doxytag: member="camellia.h::camellia_self_test" ref="aefe7032855e7365dcb4771b80b6f4d70" args="(int verbose)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int camellia_self_test </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>verbose</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Checkup routine. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, or 1 if the test failed </dd></dl>

</div>
</div>
<a class="anchor" id="aa03870ab00cd673b3fb771666ce32536"></a><!-- doxytag: member="camellia.h::camellia_setkey_dec" ref="aa03870ab00cd673b3fb771666ce32536" args="(camellia_context *ctx, const unsigned char *key, int keysize)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int camellia_setkey_dec </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcamellia__context.html">camellia_context</a> *&#160;</td>
          <td class="paramname"><em>ctx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const unsigned char *&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>keysize</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>CAMELLIA key schedule (decryption) </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">ctx</td><td>CAMELLIA context to be initialized </td></tr>
    <tr><td class="paramname">key</td><td>decryption key </td></tr>
    <tr><td class="paramname">keysize</td><td>must be 128, 192 or 256</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, or POLARSSL_ERR_CAMELLIA_INVALID_KEY_LENGTH </dd></dl>

</div>
</div>
<a class="anchor" id="af89a45b96409dba1926288ab0e5b9d12"></a><!-- doxytag: member="camellia.h::camellia_setkey_enc" ref="af89a45b96409dba1926288ab0e5b9d12" args="(camellia_context *ctx, const unsigned char *key, int keysize)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int camellia_setkey_enc </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcamellia__context.html">camellia_context</a> *&#160;</td>
          <td class="paramname"><em>ctx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const unsigned char *&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>keysize</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>CAMELLIA key schedule (encryption) </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">ctx</td><td>CAMELLIA context to be initialized </td></tr>
    <tr><td class="paramname">key</td><td>encryption key </td></tr>
    <tr><td class="paramname">keysize</td><td>must be 128, 192 or 256</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, or POLARSSL_ERR_CAMELLIA_INVALID_KEY_LENGTH </dd></dl>

</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<hr class="footer"/><address class="footer"><small>Generated on Mon May 16 2011 for PolarSSL by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>