<!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: 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 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">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 <stddef.h></code><br /> <code>#include <stdint.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"> <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="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="structmbedtls__xtea__context.html">mbedtls_xtea_context</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">XTEA context structure. <a href="structmbedtls__xtea__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:a52a8e7d7e042c6d11541312838130069"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xtea_8h.html#a52a8e7d7e042c6d11541312838130069">MBEDTLS_XTEA_ENCRYPT</a>   1</td></tr> <tr class="separator:a52a8e7d7e042c6d11541312838130069"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af5ddb7bfc34c65a4b48926f087ab5c26"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xtea_8h.html#af5ddb7bfc34c65a4b48926f087ab5c26">MBEDTLS_XTEA_DECRYPT</a>   0</td></tr> <tr class="separator:af5ddb7bfc34c65a4b48926f087ab5c26"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:addf91fc82370cb27115b725ceb261b3d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xtea_8h.html#addf91fc82370cb27115b725ceb261b3d">MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH</a>   -0x0028</td></tr> <tr class="separator:addf91fc82370cb27115b725ceb261b3d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5e7745d85886bc0564338f562f83c059"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xtea_8h.html#a5e7745d85886bc0564338f562f83c059">MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED</a>   -0x0029</td></tr> <tr class="separator:a5e7745d85886bc0564338f562f83c059"><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:ade30d4f60411e181757ffab0da902e75"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xtea_8h.html#ade30d4f60411e181757ffab0da902e75">mbedtls_xtea_init</a> (<a class="el" href="structmbedtls__xtea__context.html">mbedtls_xtea_context</a> *ctx)</td></tr> <tr class="memdesc:ade30d4f60411e181757ffab0da902e75"><td class="mdescLeft"> </td><td class="mdescRight">Initialize XTEA context. <a href="#ade30d4f60411e181757ffab0da902e75">More...</a><br /></td></tr> <tr class="separator:ade30d4f60411e181757ffab0da902e75"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a55eea1f415f3ed5dbf488fa0d9fb5cab"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xtea_8h.html#a55eea1f415f3ed5dbf488fa0d9fb5cab">mbedtls_xtea_free</a> (<a class="el" href="structmbedtls__xtea__context.html">mbedtls_xtea_context</a> *ctx)</td></tr> <tr class="memdesc:a55eea1f415f3ed5dbf488fa0d9fb5cab"><td class="mdescLeft"> </td><td class="mdescRight">Clear XTEA context. <a href="#a55eea1f415f3ed5dbf488fa0d9fb5cab">More...</a><br /></td></tr> <tr class="separator:a55eea1f415f3ed5dbf488fa0d9fb5cab"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3de8a424080f233f2a71c76b93bab130"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xtea_8h.html#a3de8a424080f233f2a71c76b93bab130">mbedtls_xtea_setup</a> (<a class="el" href="structmbedtls__xtea__context.html">mbedtls_xtea_context</a> *ctx, const unsigned char key[16])</td></tr> <tr class="memdesc:a3de8a424080f233f2a71c76b93bab130"><td class="mdescLeft"> </td><td class="mdescRight">XTEA key schedule. <a href="#a3de8a424080f233f2a71c76b93bab130">More...</a><br /></td></tr> <tr class="separator:a3de8a424080f233f2a71c76b93bab130"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a73a0ce1ac62aa079107736ef2aa4b21d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xtea_8h.html#a73a0ce1ac62aa079107736ef2aa4b21d">mbedtls_xtea_crypt_ecb</a> (<a class="el" href="structmbedtls__xtea__context.html">mbedtls_xtea_context</a> *ctx, int mode, const unsigned char input[8], unsigned char output[8])</td></tr> <tr class="memdesc:a73a0ce1ac62aa079107736ef2aa4b21d"><td class="mdescLeft"> </td><td class="mdescRight">XTEA cipher function. <a href="#a73a0ce1ac62aa079107736ef2aa4b21d">More...</a><br /></td></tr> <tr class="separator:a73a0ce1ac62aa079107736ef2aa4b21d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad0458b0fba8f223b9343e06e714f50e9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xtea_8h.html#ad0458b0fba8f223b9343e06e714f50e9">mbedtls_xtea_crypt_cbc</a> (<a class="el" href="structmbedtls__xtea__context.html">mbedtls_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:ad0458b0fba8f223b9343e06e714f50e9"><td class="mdescLeft"> </td><td class="mdescRight">XTEA CBC cipher function. <a href="#ad0458b0fba8f223b9343e06e714f50e9">More...</a><br /></td></tr> <tr class="separator:ad0458b0fba8f223b9343e06e714f50e9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac9684542d55cc9d81ea8260f70a4a239"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xtea_8h.html#ac9684542d55cc9d81ea8260f70a4a239">mbedtls_xtea_self_test</a> (int verbose)</td></tr> <tr class="memdesc:ac9684542d55cc9d81ea8260f70a4a239"><td class="mdescLeft"> </td><td class="mdescRight">Checkup routine. <a href="#ac9684542d55cc9d81ea8260f70a4a239">More...</a><br /></td></tr> <tr class="separator:ac9684542d55cc9d81ea8260f70a4a239"><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 class="definition">Definition in file <a class="el" href="xtea_8h_source.html">xtea.h</a>.</p> </div><h2 class="groupheader">Macro Definition Documentation</h2> <a id="a5e7745d85886bc0564338f562f83c059"></a> <h2 class="memtitle"><span class="permalink"><a href="#a5e7745d85886bc0564338f562f83c059">◆ </a></span>MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED   -0x0029</td> </tr> </table> </div><div class="memdoc"> <p>XTEA hardware accelerator failed. </p> <p class="definition">Definition at line <a class="el" href="xtea_8h_source.html#l00040">40</a> of file <a class="el" href="xtea_8h_source.html">xtea.h</a>.</p> </div> </div> <a id="addf91fc82370cb27115b725ceb261b3d"></a> <h2 class="memtitle"><span class="permalink"><a href="#addf91fc82370cb27115b725ceb261b3d">◆ </a></span>MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH   -0x0028</td> </tr> </table> </div><div class="memdoc"> <p>The data input has an invalid length. </p> <p class="definition">Definition at line <a class="el" href="xtea_8h_source.html#l00039">39</a> of file <a class="el" href="xtea_8h_source.html">xtea.h</a>.</p> </div> </div> <a id="af5ddb7bfc34c65a4b48926f087ab5c26"></a> <h2 class="memtitle"><span class="permalink"><a href="#af5ddb7bfc34c65a4b48926f087ab5c26">◆ </a></span>MBEDTLS_XTEA_DECRYPT</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_XTEA_DECRYPT   0</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="xtea_8h_source.html#l00037">37</a> of file <a class="el" href="xtea_8h_source.html">xtea.h</a>.</p> </div> </div> <a id="a52a8e7d7e042c6d11541312838130069"></a> <h2 class="memtitle"><span class="permalink"><a href="#a52a8e7d7e042c6d11541312838130069">◆ </a></span>MBEDTLS_XTEA_ENCRYPT</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MBEDTLS_XTEA_ENCRYPT   1</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="xtea_8h_source.html#l00036">36</a> of file <a class="el" href="xtea_8h_source.html">xtea.h</a>.</p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a id="ad0458b0fba8f223b9343e06e714f50e9"></a> <h2 class="memtitle"><span class="permalink"><a href="#ad0458b0fba8f223b9343e06e714f50e9">◆ </a></span>mbedtls_xtea_crypt_cbc()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_xtea_crypt_cbc </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__xtea__context.html">mbedtls_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>MBEDTLS_XTEA_ENCRYPT or MBEDTLS_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, MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH if the length % 8 != 0 </dd></dl> </div> </div> <a id="a73a0ce1ac62aa079107736ef2aa4b21d"></a> <h2 class="memtitle"><span class="permalink"><a href="#a73a0ce1ac62aa079107736ef2aa4b21d">◆ </a></span>mbedtls_xtea_crypt_ecb()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_xtea_crypt_ecb </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__xtea__context.html">mbedtls_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>MBEDTLS_XTEA_ENCRYPT or MBEDTLS_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 id="a55eea1f415f3ed5dbf488fa0d9fb5cab"></a> <h2 class="memtitle"><span class="permalink"><a href="#a55eea1f415f3ed5dbf488fa0d9fb5cab">◆ </a></span>mbedtls_xtea_free()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void mbedtls_xtea_free </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__xtea__context.html">mbedtls_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 id="ade30d4f60411e181757ffab0da902e75"></a> <h2 class="memtitle"><span class="permalink"><a href="#ade30d4f60411e181757ffab0da902e75">◆ </a></span>mbedtls_xtea_init()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void mbedtls_xtea_init </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__xtea__context.html">mbedtls_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 id="ac9684542d55cc9d81ea8260f70a4a239"></a> <h2 class="memtitle"><span class="permalink"><a href="#ac9684542d55cc9d81ea8260f70a4a239">◆ </a></span>mbedtls_xtea_self_test()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mbedtls_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 id="a3de8a424080f233f2a71c76b93bab130"></a> <h2 class="memtitle"><span class="permalink"><a href="#a3de8a424080f233f2a71c76b93bab130">◆ </a></span>mbedtls_xtea_setup()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void mbedtls_xtea_setup </td> <td>(</td> <td class="paramtype"><a class="el" href="structmbedtls__xtea__context.html">mbedtls_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 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>