2014-06-08 21:44:14 +00:00
|
|
|
<!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"/>
|
2014-06-08 23:33:25 +00:00
|
|
|
<meta name="generator" content="Doxygen 1.8.7"/>
|
2014-06-22 20:59:53 +00:00
|
|
|
<title>post quantum cryptography: ntru_encrypt.h File Reference</title>
|
2014-06-08 21:44:14 +00:00
|
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
|
|
|
<script type="text/javascript" src="jquery.js"></script>
|
2014-06-08 23:33:25 +00:00
|
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
|
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
2014-06-08 21:44:14 +00:00
|
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
|
|
|
<script type="text/javascript">
|
|
|
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
|
|
|
</script>
|
2014-06-08 23:33:25 +00:00
|
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
2014-06-08 21:44:14 +00:00
|
|
|
</head>
|
|
|
|
|
<body>
|
2014-06-08 23:33:25 +00:00
|
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
2014-06-08 21:44:14 +00:00
|
|
|
<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>
|
2014-06-08 23:33:25 +00:00
|
|
|
<!-- end header part -->
|
|
|
|
|
<!-- Generated by Doxygen 1.8.7 -->
|
2014-06-08 21:44:14 +00:00
|
|
|
<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>
|
2014-06-08 23:33:25 +00:00
|
|
|
<!-- window showing the filter options -->
|
|
|
|
|
<div id="MSearchSelectWindow"
|
|
|
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
|
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
|
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
2014-06-09 00:26:41 +00:00
|
|
|
<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>
|
2014-06-08 23:33:25 +00:00
|
|
|
|
|
|
|
|
<!-- 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 -->
|
2014-06-08 21:44:14 +00:00
|
|
|
<div class="header">
|
|
|
|
|
<div class="summary">
|
|
|
|
|
<a href="#func-members">Functions</a> </div>
|
|
|
|
|
<div class="headertitle">
|
2014-06-22 20:59:53 +00:00
|
|
|
<div class="title">ntru_encrypt.h File Reference</div> </div>
|
2014-06-08 21:44:14 +00:00
|
|
|
</div><!--header-->
|
|
|
|
|
<div class="contents">
|
|
|
|
|
|
|
|
|
|
<p>public API, encryption
|
|
|
|
|
<a href="#details">More...</a></p>
|
2014-06-22 20:59:53 +00:00
|
|
|
<div class="textblock"><code>#include <<a class="el" href="ntru_8h_source.html">ntru.h</a>></code><br />
|
2014-06-08 23:33:25 +00:00
|
|
|
<code>#include <fmpz_poly.h></code><br />
|
|
|
|
|
<code>#include <fmpz.h></code><br />
|
2014-06-08 21:44:14 +00:00
|
|
|
</div><div class="textblock"><div class="dynheader">
|
2014-06-22 20:59:53 +00:00
|
|
|
Include dependency graph for ntru_encrypt.h:</div>
|
2014-06-08 21:44:14 +00:00
|
|
|
<div class="dyncontent">
|
2014-06-22 20:59:53 +00:00
|
|
|
<div class="center"><img src="ntru__encrypt_8h__incl.png" border="0" usemap="#ntru__encrypt_8h" alt=""/></div>
|
|
|
|
|
<map name="ntru__encrypt_8h" id="ntru__encrypt_8h">
|
2014-06-27 23:12:14 +00:00
|
|
|
<area shape="rect" id="node3" href="ntru_8h.html" title="public API, basic data types " alt="" coords="177,83,231,112"/></map>
|
2014-06-08 21:44:14 +00:00
|
|
|
</div>
|
|
|
|
|
</div>
|
2014-06-22 20:59:53 +00:00
|
|
|
<p><a href="ntru__encrypt_8h_source.html">Go to the source code of this file.</a></p>
|
2014-06-08 21:44:14 +00:00
|
|
|
<table class="memberdecls">
|
2014-06-08 23:33:25 +00:00
|
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
2014-06-08 21:44:14 +00:00
|
|
|
Functions</h2></td></tr>
|
2014-06-22 20:59:53 +00:00
|
|
|
<tr class="memitem:a0bb47c0fa0dd4a4cfa0c0f7a722fd554"><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__encrypt_8h.html#a0bb47c0fa0dd4a4cfa0c0f7a722fd554">ntru_encrypt_string</a> (const <a class="el" href="structstring.html">string</a> *msg, const fmpz_poly_t pub_key, const fmpz_poly_t rnd, const <a class="el" href="structntru__params.html">ntru_params</a> *params)</td></tr>
|
2014-06-08 23:33:25 +00:00
|
|
|
<tr class="separator:a0bb47c0fa0dd4a4cfa0c0f7a722fd554"><td class="memSeparator" colspan="2"> </td></tr>
|
2014-06-08 21:44:14 +00:00
|
|
|
</table>
|
2014-06-08 23:33:25 +00:00
|
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
2014-06-08 21:44:14 +00:00
|
|
|
<div class="textblock"><p>public API, encryption </p>
|
|
|
|
|
<p>This file holds the public API of encryption of the pqc NTRU implementation and is meant to be installed on the client system. </p>
|
|
|
|
|
|
2014-06-22 20:59:53 +00:00
|
|
|
<p>Definition in file <a class="el" href="ntru__encrypt_8h_source.html">ntru_encrypt.h</a>.</p>
|
2014-06-08 23:33:25 +00:00
|
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
|
|
|
|
<a class="anchor" id="a0bb47c0fa0dd4a4cfa0c0f7a722fd554"></a>
|
2014-06-08 21:44:14 +00:00
|
|
|
<div class="memitem">
|
|
|
|
|
<div class="memproto">
|
|
|
|
|
<table class="memname">
|
|
|
|
|
<tr>
|
2014-06-08 23:33:25 +00:00
|
|
|
<td class="memname"><a class="el" href="structstring.html">string</a>* ntru_encrypt_string </td>
|
2014-06-08 21:44:14 +00:00
|
|
|
<td>(</td>
|
|
|
|
|
<td class="paramtype">const <a class="el" href="structstring.html">string</a> * </td>
|
|
|
|
|
<td class="paramname"><em>msg</em>, </td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td class="paramkey"></td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td class="paramtype">const fmpz_poly_t </td>
|
|
|
|
|
<td class="paramname"><em>pub_key</em>, </td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td class="paramkey"></td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td class="paramtype">const fmpz_poly_t </td>
|
|
|
|
|
<td class="paramname"><em>rnd</em>, </td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td class="paramkey"></td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td class="paramtype">const <a class="el" href="structntru__params.html">ntru_params</a> * </td>
|
|
|
|
|
<td class="paramname"><em>params</em> </td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td>)</td>
|
|
|
|
|
<td></td><td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
2014-06-08 23:33:25 +00:00
|
|
|
</div><div class="memdoc">
|
2014-06-08 21:44:14 +00:00
|
|
|
<p>Encrypt a message in the form of a null-terminated char array and return a string.</p>
|
2014-06-08 23:33:25 +00:00
|
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
2014-06-08 21:44:14 +00:00
|
|
|
<table class="params">
|
|
|
|
|
<tr><td class="paramname">msg</td><td>the message </td></tr>
|
|
|
|
|
<tr><td class="paramname">pub_key</td><td>the public key </td></tr>
|
|
|
|
|
<tr><td class="paramname">rnd</td><td>the random poly (should have relatively small coefficients, but not restricted to {-1, 0, 1}) </td></tr>
|
|
|
|
|
<tr><td class="paramname">params</td><td><a class="el" href="structntru__params.html">ntru_params</a> the ntru context </td></tr>
|
|
|
|
|
</table>
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
2014-06-09 00:26:41 +00:00
|
|
|
<dl class="section return"><dt>Returns</dt><dd>the newly allocated encrypted string, NULL on failure </dd></dl>
|
2014-06-08 21:44:14 +00:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div><!-- contents -->
|
2014-06-08 23:33:25 +00:00
|
|
|
<!-- start footer part -->
|
2014-06-08 21:44:14 +00:00
|
|
|
<hr class="footer"/><address class="footer"><small>
|
2014-06-27 23:20:44 +00:00
|
|
|
Generated on Fri Jun 27 2014 23:20:41 for post quantum cryptography by  <a href="http://www.doxygen.org/index.html">
|
2014-06-08 21:44:14 +00:00
|
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
2014-06-08 23:33:25 +00:00
|
|
|
</a> 1.8.7
|
2014-06-08 21:44:14 +00:00
|
|
|
</small></address>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
