<!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.7"/> <title>post quantum cryptography: ntru.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="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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">post quantum cryptography </div> <div id="projectbrief">Highly optimized implementation of the NTRUEncrypt algorithm</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.7 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</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> <li> <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 List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Pages</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> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#nested-classes">Data Structures</a> | <a href="#typedef-members">Typedefs</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">ntru.h File Reference</div> </div> </div><!--header--> <div class="contents"> <p>public API, basic data types <a href="#details">More...</a></p> <div class="textblock"><code>#include <fmpz_poly.h></code><br /> <code>#include <fmpz.h></code><br /> <code>#include <stdint.h></code><br /> </div><div class="textblock"><div class="dynheader"> Include dependency graph for ntru.h:</div> <div class="dyncontent"> <div class="center"><img src="ntru_8h__incl.png" border="0" usemap="#ntru_8h" alt=""/></div> <map name="ntru_8h" id="ntru_8h"> </map> </div> </div> <p><a href="ntru_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="structntru__params.html">ntru_params</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structstring.html">string</a></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="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:a2f326c88fc033eca78a47ee8d387c592"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structntru__params.html">ntru_params</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ntru_8h.html#a2f326c88fc033eca78a47ee8d387c592">ntru_params</a></td></tr> <tr class="separator:a2f326c88fc033eca78a47ee8d387c592"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a63e2e3ee7db5274c6a3929edfc07c6c9"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structstring.html">string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ntru_8h.html#a63e2e3ee7db5274c6a3929edfc07c6c9">string</a></td></tr> <tr class="separator:a63e2e3ee7db5274c6a3929edfc07c6c9"><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:a55d4ce182c335ff6cca360909a7be395"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ntru_8h.html#a55d4ce182c335ff6cca360909a7be395">prints</a> (const <a class="el" href="structstring.html">string</a> *print_string)</td></tr> <tr class="separator:a55d4ce182c335ff6cca360909a7be395"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac1b5f66fbbbdfc7901357ddcfec52e5a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ntru_8h.html#ac1b5f66fbbbdfc7901357ddcfec52e5a">string_delete</a> (<a class="el" href="structstring.html">string</a> *del_string)</td></tr> <tr class="separator:ac1b5f66fbbbdfc7901357ddcfec52e5a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a20f86085d5eb5372fd25dc270069d38c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ntru_8h.html#a20f86085d5eb5372fd25dc270069d38c">poly_new</a> (fmpz_poly_t new_poly, int const *const c, const size_t len)</td></tr> <tr class="separator:a20f86085d5eb5372fd25dc270069d38c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a27ff2116f70bcbf5028219adcae4c5f0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ntru_8h.html#a27ff2116f70bcbf5028219adcae4c5f0">poly_delete</a> (fmpz_poly_t poly)</td></tr> <tr class="separator:a27ff2116f70bcbf5028219adcae4c5f0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3f53c63383ff301b20dcede0783869a7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ntru_8h.html#a3f53c63383ff301b20dcede0783869a7">poly_delete_array</a> (fmpz_poly_t **poly_array)</td></tr> <tr class="separator:a3f53c63383ff301b20dcede0783869a7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a83297bc2ab5b6e7ce42553570dd8268f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ntru_8h.html#a83297bc2ab5b6e7ce42553570dd8268f">poly_delete_all</a> (fmpz_poly_t poly,...)</td></tr> <tr class="separator:a83297bc2ab5b6e7ce42553570dd8268f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a80a8ce0f2944bc3df94291ef2f781498"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ntru_8h.html#a80a8ce0f2944bc3df94291ef2f781498">poly_draw</a> (const fmpz_poly_t poly)</td></tr> <tr class="separator:a80a8ce0f2944bc3df94291ef2f781498"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aec098d00160d2d502eb1f8a7c3fa5453"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ntru_8h.html#aec098d00160d2d502eb1f8a7c3fa5453">poly_draw_pretty</a> (const fmpz_poly_t poly)</td></tr> <tr class="separator:aec098d00160d2d502eb1f8a7c3fa5453"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a348c2a56837571f410d44631abc09dc4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structstring.html">string</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ntru_8h.html#a348c2a56837571f410d44631abc09dc4">read_file</a> (char const *const filename)</td></tr> <tr class="separator:a348c2a56837571f410d44631abc09dc4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af2a0fc4dd4109749d8f3100a913cc304"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ntru_8h.html#af2a0fc4dd4109749d8f3100a913cc304">write_file</a> (<a class="el" href="structstring.html">string</a> const *wstring, char const *const filename)</td></tr> <tr class="separator:af2a0fc4dd4109749d8f3100a913cc304"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>public API, basic data types </p> <p>This file holds the public API of the most basic data types and operations of the pqc NTRU implementation and is meant to be installed on the client system. </p> <p>Definition in file <a class="el" href="ntru_8h_source.html">ntru.h</a>.</p> </div><h2 class="groupheader">Typedef Documentation</h2> <a class="anchor" id="a2f326c88fc033eca78a47ee8d387c592"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structntru__params.html">ntru_params</a> <a class="el" href="structntru__params.html">ntru_params</a></td> </tr> </table> </div><div class="memdoc"> <p>Definition at line <a class="el" href="ntru_8h_source.html#l00039">39</a> of file <a class="el" href="ntru_8h_source.html">ntru.h</a>.</p> </div> </div> <a class="anchor" id="a63e2e3ee7db5274c6a3929edfc07c6c9"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structstring.html">string</a> <a class="el" href="structstring.html">string</a></td> </tr> </table> </div><div class="memdoc"> <p>Definition at line <a class="el" href="ntru_8h_source.html#l00040">40</a> of file <a class="el" href="ntru_8h_source.html">ntru.h</a>.</p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="a27ff2116f70bcbf5028219adcae4c5f0"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void poly_delete </td> <td>(</td> <td class="paramtype">fmpz_poly_t </td> <td class="paramname"><em>poly</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>This deletes the internal structure of a polynomial, and frees the pointer.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">poly</td><td>the polynomial to delete </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a83297bc2ab5b6e7ce42553570dd8268f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void poly_delete_all </td> <td>(</td> <td class="paramtype">fmpz_poly_t </td> <td class="paramname"><em>poly</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname"><em>...</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>This deletes the internal structure of all polynomials, and frees the pointers. You must call this with NULL as last argument!</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">poly</td><td>the polynomial to delete </td></tr> <tr><td class="paramname">...</td><td>follow up polynomials </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a3f53c63383ff301b20dcede0783869a7"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void poly_delete_array </td> <td>(</td> <td class="paramtype">fmpz_poly_t ** </td> <td class="paramname"><em>poly_array</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Delete the internal structure of a polynomial array which must be NULL terminated. It is expected that poly_array is not on the stack and was obtained by a function like ascii_to_poly().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">poly_array</td><td>the polynomial array </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a80a8ce0f2944bc3df94291ef2f781498"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void poly_draw </td> <td>(</td> <td class="paramtype">const fmpz_poly_t </td> <td class="paramname"><em>poly</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Draws a polynomial to stdout.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">poly</td><td>draw this </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="aec098d00160d2d502eb1f8a7c3fa5453"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void poly_draw_pretty </td> <td>(</td> <td class="paramtype">const fmpz_poly_t </td> <td class="paramname"><em>poly</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Draws a polynomial to stdout, in pretty format.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">poly</td><td>draw this </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a20f86085d5eb5372fd25dc270069d38c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void poly_new </td> <td>(</td> <td class="paramtype">fmpz_poly_t </td> <td class="paramname"><em>new_poly</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int const *const </td> <td class="paramname"><em>c</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const size_t </td> <td class="paramname"><em>len</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Initializes and builds a polynomial with the coefficient values of c[] of size len within NTRU parameters and returns a newly allocated polynomial. For an empty polynom, both c and len can be NULL/0.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">new_poly</td><td>the polynomial to initialize and fill with coefficients [out] </td></tr> <tr><td class="paramname">c</td><td>array of polynomial coefficients, can be NULL </td></tr> <tr><td class="paramname">len</td><td>size of the coefficient array, can be 0 </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>newly allocated polynomial pointer, must be freed with fmpz_poly_clear() </dd></dl> </div> </div> <a class="anchor" id="a55d4ce182c335ff6cca360909a7be395"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void prints </td> <td>(</td> <td class="paramtype">const <a class="el" href="structstring.html">string</a> * </td> <td class="paramname"><em>print_string</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Prints the given string to stdout.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">print_string</td><td>the print to string </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a348c2a56837571f410d44631abc09dc4"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structstring.html">string</a>* read_file </td> <td>(</td> <td class="paramtype">char const *const </td> <td class="paramname"><em>filename</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Reads a file and returns a newly allocated string.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">filename</td><td>file to open </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>a newly allocated string which must be freed by the caller or NULL on failure </dd></dl> </div> </div> <a class="anchor" id="ac1b5f66fbbbdfc7901357ddcfec52e5a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void string_delete </td> <td>(</td> <td class="paramtype"><a class="el" href="structstring.html">string</a> * </td> <td class="paramname"><em>del_string</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Delete the inner structure of the string and frees the string itself from the heap. Must not be called on stack variables.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">del_string</td><td>the string to delete </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="af2a0fc4dd4109749d8f3100a913cc304"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void write_file </td> <td>(</td> <td class="paramtype"><a class="el" href="structstring.html">string</a> const * </td> <td class="paramname"><em>wstring</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">char const *const </td> <td class="paramname"><em>filename</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Write a string to a file. The file will be pruned or created if it does not exist.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">wstring</td><td>the string to write to the file </td></tr> <tr><td class="paramname">filename</td><td>the name of the file to write to </td></tr> </table> </dd> </dl> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Sun Jun 22 2014 21:37:13 for post quantum cryptography by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.7 </small></address> </body> </html>