hasufell/pqc
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
b333b7d765
pqc/ntru__keypair_8c.html
travis-ci b333b7d765 Lastest doxygen docs updated 
travis build: 29
	commit: 03f3b4b230
	auto-pushed to gh-pages
2014-06-08 23:33:25 +00:00

401 lines
20 KiB
HTML
Raw Blame History

<!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: /home/travis/build/hasufell/pqc/src/ntru_keypair.c 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&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Data&#160;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&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</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>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">ntru_keypair.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>key creation and operations
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="ntru__ascii__poly_8h_source.html">ntru_ascii_poly.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ntru__file_8h_source.html">ntru_file.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ntru__keypair_8h_source.html">ntru_keypair.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ntru__params_8h_source.html">ntru_params.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ntru__poly_8h_source.html">ntru_poly.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ntru__poly__ascii_8h_source.html">ntru_poly_ascii.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ntru__string_8h_source.html">ntru_string.h</a>&quot;</code><br />
<code>#include &lt;fmpz_poly.h&gt;</code><br />
<code>#include &lt;fmpz.h&gt;</code><br />
<code>#include &lt;stdbool.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for ntru_keypair.c:</div>
<div class="dyncontent">
<div class="center"><img src="ntru__keypair_8c__incl.png" border="0" usemap="#_2home_2travis_2build_2hasufell_2pqc_2src_2ntru__keypair_8c" alt=""/></div>
<map name="_2home_2travis_2build_2hasufell_2pqc_2src_2ntru__keypair_8c" id="_2home_2travis_2build_2hasufell_2pqc_2src_2ntru__keypair_8c">
<area shape="rect" id="node3" href="ntru__ascii__poly_8h.html" title="header for ntru_ascii_poly.c " alt="" coords="176,117,296,147"/><area shape="rect" id="node9" href="ntru__string_8h.html" title="header for ntru_string.c " alt="" coords="59,195,152,224"/><area shape="rect" id="node12" href="ntru__params_8h.html" title="NTRU parameters. " alt="" coords="515,195,619,224"/><area shape="rect" id="node20" href="ntru__file_8h.html" title="header for ntru_file.c " alt="" coords="24,117,102,147"/><area shape="rect" id="node26" href="ntru__keypair_8h.html" title="header for ntru_keypair.c " alt="" coords="515,117,619,147"/><area shape="rect" id="node33" href="ntru__poly_8h.html" title="header for ntru_poly.c " alt="" coords="744,117,830,147"/><area shape="rect" id="node44" href="ntru__poly__ascii_8h.html" title="header for ntru_poly_ascii.c " alt="" coords="320,117,440,147"/><area shape="rect" id="node5" href="ntru__common_8h.html" title="common macros/functions " alt="" coords="176,195,288,224"/><area shape="rect" id="node35" href="ntru__err_8h.html" title="error handling " alt="" coords="792,195,870,224"/></map>
</div>
</div>
<p><a href="ntru__keypair_8c_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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a6873d41211a92c4f6b0074ef34ae1743"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ntru__keypair_8c.html#a6873d41211a92c4f6b0074ef34ae1743">ntru_create_keypair</a> (fmpz_poly_t f, fmpz_poly_t g, <a class="el" href="structkeypair.html">keypair</a> *pair, <a class="el" href="structntru__params.html">ntru_params</a> *params)</td></tr>
<tr class="separator:a6873d41211a92c4f6b0074ef34ae1743"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41741ed660cb806c47335f66055e1bdd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ntru__keypair_8c.html#a41741ed660cb806c47335f66055e1bdd">export_public_key</a> (char const *const filename, fmpz_poly_t pub, <a class="el" href="structntru__params.html">ntru_params</a> *params)</td></tr>
<tr class="separator:a41741ed660cb806c47335f66055e1bdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa29f14a14486d3f6b979ee900d7e738"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ntru__keypair_8c.html#afa29f14a14486d3f6b979ee900d7e738">export_priv_key</a> (char const *const filename, fmpz_poly_t priv, <a class="el" href="structntru__params.html">ntru_params</a> *params)</td></tr>
<tr class="separator:afa29f14a14486d3f6b979ee900d7e738"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e2c6da04c55e8c1b6c447f4cc9f1d6f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ntru__keypair_8c.html#a4e2c6da04c55e8c1b6c447f4cc9f1d6f">import_public_key</a> (char const *const filename, fmpz_poly_t pub, <a class="el" href="structntru__params.html">ntru_params</a> *params)</td></tr>
<tr class="separator:a4e2c6da04c55e8c1b6c447f4cc9f1d6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f917ea6ef5302826c888e5c88e0869e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ntru__keypair_8c.html#a1f917ea6ef5302826c888e5c88e0869e">import_priv_key</a> (char const *const filename, fmpz_poly_t priv, fmpz_poly_t priv_inv, <a class="el" href="structntru__params.html">ntru_params</a> *params)</td></tr>
<tr class="separator:a1f917ea6ef5302826c888e5c88e0869e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5279c4990bc22bb9e735fe36372a6786"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ntru__keypair_8c.html#a5279c4990bc22bb9e735fe36372a6786">ntru_delete_keypair</a> (<a class="el" href="structkeypair.html">keypair</a> *pair)</td></tr>
<tr class="separator:a5279c4990bc22bb9e735fe36372a6786"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>key creation and operations </p>
<p>This file handles the creation of the key pair and possibly common operations on them. </p>
<p>Definition in file <a class="el" href="ntru__keypair_8c_source.html">ntru_keypair.c</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="afa29f14a14486d3f6b979ee900d7e738"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void export_priv_key </td>
<td>(</td>
<td class="paramtype">char const *const&#160;</td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">fmpz_poly_t&#160;</td>
<td class="paramname"><em>priv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structntru__params.html">ntru_params</a> *&#160;</td>
<td class="paramname"><em>params</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Export the private key to a file.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>the file to save the private key into </td></tr>
<tr><td class="paramname">priv</td><td>the private key </td></tr>
<tr><td class="paramname">params</td><td>the NTRU context </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="ntru__keypair_8c_source.html#l00111">111</a> of file <a class="el" href="ntru__keypair_8c_source.html">ntru_keypair.c</a>.</p>
</div>
</div>
<a class="anchor" id="a41741ed660cb806c47335f66055e1bdd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void export_public_key </td>
<td>(</td>
<td class="paramtype">char const *const&#160;</td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">fmpz_poly_t&#160;</td>
<td class="paramname"><em>pub</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structntru__params.html">ntru_params</a> *&#160;</td>
<td class="paramname"><em>params</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Export the public key to a file.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>the file to save the public key into </td></tr>
<tr><td class="paramname">pub</td><td>the public key </td></tr>
<tr><td class="paramname">params</td><td>the NTRU context </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="ntru__keypair_8c_source.html#l00096">96</a> of file <a class="el" href="ntru__keypair_8c_source.html">ntru_keypair.c</a>.</p>
</div>
</div>
<a class="anchor" id="a1f917ea6ef5302826c888e5c88e0869e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void import_priv_key </td>
<td>(</td>
<td class="paramtype">char const *const&#160;</td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">fmpz_poly_t&#160;</td>
<td class="paramname"><em>priv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">fmpz_poly_t&#160;</td>
<td class="paramname"><em>priv_inv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structntru__params.html">ntru_params</a> *&#160;</td>
<td class="paramname"><em>params</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Import the private key from a file and store him along with his inverse.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>the file to get the private key from </td></tr>
<tr><td class="paramname">priv</td><td>where to save the private key [out] </td></tr>
<tr><td class="paramname">priv_inv</td><td>where to save the inverse of the private key [out] </td></tr>
<tr><td class="paramname">params</td><td>the NTRU context </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="ntru__keypair_8c_source.html#l00157">157</a> of file <a class="el" href="ntru__keypair_8c_source.html">ntru_keypair.c</a>.</p>
</div>
</div>
<a class="anchor" id="a4e2c6da04c55e8c1b6c447f4cc9f1d6f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void import_public_key </td>
<td>(</td>
<td class="paramtype">char const *const&#160;</td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">fmpz_poly_t&#160;</td>
<td class="paramname"><em>pub</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structntru__params.html">ntru_params</a> *&#160;</td>
<td class="paramname"><em>params</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Import the public key from a file. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>the file to get the public key from </td></tr>
<tr><td class="paramname">pub</td><td>where to save the public key [out] </td></tr>
<tr><td class="paramname">params</td><td>the NTRU context </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="ntru__keypair_8c_source.html#l00132">132</a> of file <a class="el" href="ntru__keypair_8c_source.html">ntru_keypair.c</a>.</p>
</div>
</div>
<a class="anchor" id="a6873d41211a92c4f6b0074ef34ae1743"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ntru_create_keypair </td>
<td>(</td>
<td class="paramtype">fmpz_poly_t&#160;</td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">fmpz_poly_t&#160;</td>
<td class="paramname"><em>g</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structkeypair.html">keypair</a> *&#160;</td>
<td class="paramname"><em>pair</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structntru__params.html">ntru_params</a> *&#160;</td>
<td class="paramname"><em>params</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an NTRU key pair, consisting of public and private components.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td>a random polynomial </td></tr>
<tr><td class="paramname">g</td><td>a random polynomial </td></tr>
<tr><td class="paramname">pair</td><td>store private and public components here [out] </td></tr>
<tr><td class="paramname">params</td><td>the NTRU context </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true for success, false if f or g are not invertible (then the caller hast to try different ones) </dd></dl>
<p>Definition at line <a class="el" href="ntru__keypair_8c_source.html#l00047">47</a> of file <a class="el" href="ntru__keypair_8c_source.html">ntru_keypair.c</a>.</p>
</div>
</div>
<a class="anchor" id="a5279c4990bc22bb9e735fe36372a6786"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ntru_delete_keypair </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkeypair.html">keypair</a> *&#160;</td>
<td class="paramname"><em>pair</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to free the inner structure of a keypair. This will not call free() on the pair itself.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pair</td><td>the pair to free the inner structure of </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="ntru__keypair_8c_source.html#l00197">197</a> of file <a class="el" href="ntru__keypair_8c_source.html">ntru_keypair.c</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Jun 8 2014 23:33:23 for post quantum cryptography by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.7
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink