<!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: xtea.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="#define-members">Macros</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">xtea.h File Reference</div> </div> </div><!--header--> <div class="contents"> <p>XTEA block cipher (32-bit) <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/> <code>#include <inttypes.h></code><br/> </div><div class="textblock"><div class="dynheader"> Include dependency graph for xtea.h:</div> <div class="dyncontent"> <div class="center"><img src="xtea_8h__incl.png" border="0" usemap="#xtea_8h" alt=""/></div> <map name="xtea_8h" id="xtea_8h"> </map> </div> </div> <p><a href="xtea_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="structxtea__context.html">xtea_context</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">XTEA context structure. <a href="structxtea__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:aa75a338c8b1485f3dcd52ff788312136"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xtea_8h.html#aa75a338c8b1485f3dcd52ff788312136">XTEA_ENCRYPT</a>   1</td></tr> <tr class="separator:aa75a338c8b1485f3dcd52ff788312136"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a12112dc96c2e7b6f1b6a5b38a9471c01"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xtea_8h.html#a12112dc96c2e7b6f1b6a5b38a9471c01">XTEA_DECRYPT</a>   0</td></tr> <tr class="separator:a12112dc96c2e7b6f1b6a5b38a9471c01"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9c09eafcc6b5bacc7d3617daaf357727"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xtea_8h.html#a9c09eafcc6b5bacc7d3617daaf357727">POLARSSL_ERR_XTEA_INVALID_INPUT_LENGTH</a>   -0x0028</td></tr> <tr class="memdesc:a9c09eafcc6b5bacc7d3617daaf357727"><td class="mdescLeft"> </td><td class="mdescRight">The data input has an invalid length. <a href="#a9c09eafcc6b5bacc7d3617daaf357727">More...</a><br/></td></tr> <tr class="separator:a9c09eafcc6b5bacc7d3617daaf357727"><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:a6e92b27a7301c5b521c13d844f06f0ab"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xtea_8h.html#a6e92b27a7301c5b521c13d844f06f0ab">xtea_init</a> (<a class="el" href="structxtea__context.html">xtea_context</a> *ctx)</td></tr> <tr class="memdesc:a6e92b27a7301c5b521c13d844f06f0ab"><td class="mdescLeft"> </td><td class="mdescRight">Initialize XTEA context. <a href="#a6e92b27a7301c5b521c13d844f06f0ab">More...</a><br/></td></tr> <tr class="separator:a6e92b27a7301c5b521c13d844f06f0ab"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a51b6944567d78a15810ad74ca1603735"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xtea_8h.html#a51b6944567d78a15810ad74ca1603735">xtea_free</a> (<a class="el" href="structxtea__context.html">xtea_context</a> *ctx)</td></tr> <tr class="memdesc:a51b6944567d78a15810ad74ca1603735"><td class="mdescLeft"> </td><td class="mdescRight">Clear XTEA context. <a href="#a51b6944567d78a15810ad74ca1603735">More...</a><br/></td></tr> <tr class="separator:a51b6944567d78a15810ad74ca1603735"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af3dbab39c255385de39650070c1bbfa2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xtea_8h.html#af3dbab39c255385de39650070c1bbfa2">xtea_setup</a> (<a class="el" href="structxtea__context.html">xtea_context</a> *ctx, const unsigned char key[16])</td></tr> <tr class="memdesc:af3dbab39c255385de39650070c1bbfa2"><td class="mdescLeft"> </td><td class="mdescRight">XTEA key schedule. <a href="#af3dbab39c255385de39650070c1bbfa2">More...</a><br/></td></tr> <tr class="separator:af3dbab39c255385de39650070c1bbfa2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a567fc0be7301210fa16f33a9062f71ed"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xtea_8h.html#a567fc0be7301210fa16f33a9062f71ed">xtea_crypt_ecb</a> (<a class="el" href="structxtea__context.html">xtea_context</a> *ctx, int mode, const unsigned char input[8], unsigned char output[8])</td></tr> <tr class="memdesc:a567fc0be7301210fa16f33a9062f71ed"><td class="mdescLeft"> </td><td class="mdescRight">XTEA cipher function. <a href="#a567fc0be7301210fa16f33a9062f71ed">More...</a><br/></td></tr> <tr class="separator:a567fc0be7301210fa16f33a9062f71ed"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a51653f454cb805f026e9ce940d6f5bae"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xtea_8h.html#a51653f454cb805f026e9ce940d6f5bae">xtea_crypt_cbc</a> (<a class="el" href="structxtea__context.html">xtea_context</a> *ctx, int mode, size_t length, unsigned char iv[8], const unsigned char *input, unsigned char *output)</td></tr> <tr class="memdesc:a51653f454cb805f026e9ce940d6f5bae"><td class="mdescLeft"> </td><td class="mdescRight">XTEA CBC cipher function. <a href="#a51653f454cb805f026e9ce940d6f5bae">More...</a><br/></td></tr> <tr class="separator:a51653f454cb805f026e9ce940d6f5bae"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a03b5858d119c1b2674612c2e94ece5f1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xtea_8h.html#a03b5858d119c1b2674612c2e94ece5f1">xtea_self_test</a> (int verbose)</td></tr> <tr class="memdesc:a03b5858d119c1b2674612c2e94ece5f1"><td class="mdescLeft"> </td><td class="mdescRight">Checkup routine. <a href="#a03b5858d119c1b2674612c2e94ece5f1">More...</a><br/></td></tr> <tr class="separator:a03b5858d119c1b2674612c2e94ece5f1"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>XTEA block cipher (32-bit) </p> <p>Copyright (C) 2006-2013, 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="xtea_8h_source.html">xtea.h</a>.</p> </div><h2 class="groupheader">Macro Definition Documentation</h2> <a class="anchor" id="a9c09eafcc6b5bacc7d3617daaf357727"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define POLARSSL_ERR_XTEA_INVALID_INPUT_LENGTH   -0x0028</td> </tr> </table> </div><div class="memdoc"> <p>The data input has an invalid length. </p> <p>Definition at line <a class="el" href="xtea_8h_source.html#l00048">48</a> of file <a class="el" href="xtea_8h_source.html">xtea.h</a>.</p> </div> </div> <a class="anchor" id="a12112dc96c2e7b6f1b6a5b38a9471c01"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define XTEA_DECRYPT   0</td> </tr> </table> </div><div class="memdoc"> <p>Definition at line <a class="el" href="xtea_8h_source.html#l00046">46</a> of file <a class="el" href="xtea_8h_source.html">xtea.h</a>.</p> </div> </div> <a class="anchor" id="aa75a338c8b1485f3dcd52ff788312136"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define XTEA_ENCRYPT   1</td> </tr> </table> </div><div class="memdoc"> <p>Definition at line <a class="el" href="xtea_8h_source.html#l00045">45</a> of file <a class="el" href="xtea_8h_source.html">xtea.h</a>.</p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="a51653f454cb805f026e9ce940d6f5bae"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int xtea_crypt_cbc </td> <td>(</td> <td class="paramtype"><a class="el" href="structxtea__context.html">xtea_context</a> * </td> <td class="paramname"><em>ctx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>mode</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">unsigned char </td> <td class="paramname"><em>iv</em>[8], </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>XTEA CBC cipher function. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>XTEA context </td></tr> <tr><td class="paramname">mode</td><td>XTEA_ENCRYPT or XTEA_DECRYPT </td></tr> <tr><td class="paramname">length</td><td>the length of input, multiple of 8 </td></tr> <tr><td class="paramname">iv</td><td>initialization vector for CBC mode </td></tr> <tr><td class="paramname">input</td><td>input block </td></tr> <tr><td class="paramname">output</td><td>output block</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>0 if successful, POLARSSL_ERR_XTEA_INVALID_INPUT_LENGTH if the length % 8 != 0 </dd></dl> </div> </div> <a class="anchor" id="a567fc0be7301210fa16f33a9062f71ed"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int xtea_crypt_ecb </td> <td>(</td> <td class="paramtype"><a class="el" href="structxtea__context.html">xtea_context</a> * </td> <td class="paramname"><em>ctx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>mode</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const unsigned char </td> <td class="paramname"><em>input</em>[8], </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned char </td> <td class="paramname"><em>output</em>[8] </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>XTEA cipher function. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>XTEA context </td></tr> <tr><td class="paramname">mode</td><td>XTEA_ENCRYPT or XTEA_DECRYPT </td></tr> <tr><td class="paramname">input</td><td>8-byte input block </td></tr> <tr><td class="paramname">output</td><td>8-byte output block</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>0 if successful </dd></dl> </div> </div> <a class="anchor" id="a51b6944567d78a15810ad74ca1603735"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void xtea_free </td> <td>(</td> <td class="paramtype"><a class="el" href="structxtea__context.html">xtea_context</a> * </td> <td class="paramname"><em>ctx</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Clear XTEA context. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>XTEA context to be cleared </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a6e92b27a7301c5b521c13d844f06f0ab"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void xtea_init </td> <td>(</td> <td class="paramtype"><a class="el" href="structxtea__context.html">xtea_context</a> * </td> <td class="paramname"><em>ctx</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Initialize XTEA context. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>XTEA context to be initialized </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a03b5858d119c1b2674612c2e94ece5f1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int xtea_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="af3dbab39c255385de39650070c1bbfa2"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void xtea_setup </td> <td>(</td> <td class="paramtype"><a class="el" href="structxtea__context.html">xtea_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>[16] </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>XTEA key schedule. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>XTEA context to be initialized </td></tr> <tr><td class="paramname">key</td><td>the secret key </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: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>