Google Git
Sign in
apache / incubator-milagro / 0f9f3486eeb44998c679da951836f726c8e0773d / . / website / static / cdocs / rsa__3072_8h.html
blob: 9929821f03d4a46073e4baa425b4f8e5477e3f03 [file] [log] [blame]
<!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>AMCL: rsa_3072.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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.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">AMCL
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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_df7310d1a865926cc859bcfb1880083f.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">rsa_3072.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>RSA Header file for implementation of RSA protocol.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="ff__3072_8h_source.html">ff_3072.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="rsa__support_8h_source.html">rsa_support.h</a>&quot;</code><br />
</div>
<p><a href="rsa__3072_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 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrsa__public__key__3072.html">rsa_public_key_3072</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Integer Factorisation Public Key. <a href="structrsa__public__key__3072.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrsa__private__key__3072.html">rsa_private_key_3072</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Integer Factorisation Private Key. <a href="structrsa__private__key__3072.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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:a7ccf1504fdbe6fbb51b3bdc6559fe686"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rsa__3072_8h.html#a7ccf1504fdbe6fbb51b3bdc6559fe686">HASH_TYPE_RSA_3072</a>&#160;&#160;&#160;SHA256</td></tr>
<tr class="separator:a7ccf1504fdbe6fbb51b3bdc6559fe686"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5bc8ba0098cdfd21bacd832f1f4d2ac8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rsa__3072_8h.html#a5bc8ba0098cdfd21bacd832f1f4d2ac8">RFS_3072</a>&#160;&#160;&#160;<a class="el" href="config__big__384__56_8h.html#ab097d53a21c3885285dbb6c6c72b608d">MODBYTES_384_56</a>*<a class="el" href="config__ff__3072_8h.html#aaaf83c3d8d02afcc96d24bcabc418da4">FFLEN_3072</a></td></tr>
<tr class="separator:a5bc8ba0098cdfd21bacd832f1f4d2ac8"><td class="memSeparator" colspan="2">&#160;</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:ae45aa8fdf906ca4c128712ee9cfa4af6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rsa__3072_8h.html#ae45aa8fdf906ca4c128712ee9cfa4af6">RSA_3072_KEY_PAIR</a> (<a class="el" href="structcsprng.html">csprng</a> *R, <a class="el" href="arch_8h.html#af31fcb3b74c4bcf6507f62d801277492">sign32</a> e, <a class="el" href="structrsa__private__key__3072.html">rsa_private_key_3072</a> *PRIV, <a class="el" href="structrsa__public__key__3072.html">rsa_public_key_3072</a> *PUB, <a class="el" href="structoctet.html">octet</a> *P, <a class="el" href="structoctet.html">octet</a> *Q)</td></tr>
<tr class="memdesc:ae45aa8fdf906ca4c128712ee9cfa4af6"><td class="mdescLeft">&#160;</td><td class="mdescRight">RSA Key Pair Generator. <a href="#ae45aa8fdf906ca4c128712ee9cfa4af6">More...</a><br /></td></tr>
<tr class="separator:ae45aa8fdf906ca4c128712ee9cfa4af6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aefea96c0e2cdc7116adb71332a94198e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rsa__3072_8h.html#aefea96c0e2cdc7116adb71332a94198e">RSA_3072_ENCRYPT</a> (<a class="el" href="structrsa__public__key__3072.html">rsa_public_key_3072</a> *PUB, <a class="el" href="structoctet.html">octet</a> *F, <a class="el" href="structoctet.html">octet</a> *G)</td></tr>
<tr class="memdesc:aefea96c0e2cdc7116adb71332a94198e"><td class="mdescLeft">&#160;</td><td class="mdescRight">RSA encryption of suitably padded plaintext. <a href="#aefea96c0e2cdc7116adb71332a94198e">More...</a><br /></td></tr>
<tr class="separator:aefea96c0e2cdc7116adb71332a94198e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afabe0231911df90e8d0ebc121a383f85"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rsa__3072_8h.html#afabe0231911df90e8d0ebc121a383f85">RSA_3072_DECRYPT</a> (<a class="el" href="structrsa__private__key__3072.html">rsa_private_key_3072</a> *PRIV, <a class="el" href="structoctet.html">octet</a> *G, <a class="el" href="structoctet.html">octet</a> *F)</td></tr>
<tr class="memdesc:afabe0231911df90e8d0ebc121a383f85"><td class="mdescLeft">&#160;</td><td class="mdescRight">RSA decryption of ciphertext. <a href="#afabe0231911df90e8d0ebc121a383f85">More...</a><br /></td></tr>
<tr class="separator:afabe0231911df90e8d0ebc121a383f85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3cbeb08aa7f23eb33b57c200bc0be3c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rsa__3072_8h.html#aa3cbeb08aa7f23eb33b57c200bc0be3c">RSA_3072_PRIVATE_KEY_KILL</a> (<a class="el" href="structrsa__private__key__3072.html">rsa_private_key_3072</a> *PRIV)</td></tr>
<tr class="memdesc:aa3cbeb08aa7f23eb33b57c200bc0be3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy an RSA private Key. <a href="#aa3cbeb08aa7f23eb33b57c200bc0be3c">More...</a><br /></td></tr>
<tr class="separator:aa3cbeb08aa7f23eb33b57c200bc0be3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae218fa230c4b45045d6730785ac526a5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rsa__3072_8h.html#ae218fa230c4b45045d6730785ac526a5">RSA_3072_fromOctet</a> (<a class="el" href="big__384__56_8h.html#a84b175c07377e6d2a06d66603d2e719c">BIG_384_56</a> *x, <a class="el" href="structoctet.html">octet</a> *S)</td></tr>
<tr class="memdesc:ae218fa230c4b45045d6730785ac526a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Populates an RSA public key from an octet string. <a href="#ae218fa230c4b45045d6730785ac526a5">More...</a><br /></td></tr>
<tr class="separator:ae218fa230c4b45045d6730785ac526a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section author"><dt>Author</dt><dd>Mike Scott declares functions </dd></dl>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a7ccf1504fdbe6fbb51b3bdc6559fe686"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ccf1504fdbe6fbb51b3bdc6559fe686">&#9670;&nbsp;</a></span>HASH_TYPE_RSA_3072</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define HASH_TYPE_RSA_3072&#160;&#160;&#160;SHA256</td>
</tr>
</table>
</div><div class="memdoc">
<p>Chosen Hash algorithm </p>
</div>
</div>
<a id="a5bc8ba0098cdfd21bacd832f1f4d2ac8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5bc8ba0098cdfd21bacd832f1f4d2ac8">&#9670;&nbsp;</a></span>RFS_3072</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define RFS_3072&#160;&#160;&#160;<a class="el" href="config__big__384__56_8h.html#ab097d53a21c3885285dbb6c6c72b608d">MODBYTES_384_56</a>*<a class="el" href="config__ff__3072_8h.html#aaaf83c3d8d02afcc96d24bcabc418da4">FFLEN_3072</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>RSA Public Key Size in bytes </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="afabe0231911df90e8d0ebc121a383f85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afabe0231911df90e8d0ebc121a383f85">&#9670;&nbsp;</a></span>RSA_3072_DECRYPT()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RSA_3072_DECRYPT </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structrsa__private__key__3072.html">rsa_private_key_3072</a> *&#160;</td>
<td class="paramname"><em>PRIV</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>G</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>F</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">PRIV</td><td>the input RSA private key </td></tr>
<tr><td class="paramname">G</td><td>is the input ciphertext </td></tr>
<tr><td class="paramname">F</td><td>is output plaintext (requires unpadding) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aefea96c0e2cdc7116adb71332a94198e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aefea96c0e2cdc7116adb71332a94198e">&#9670;&nbsp;</a></span>RSA_3072_ENCRYPT()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RSA_3072_ENCRYPT </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structrsa__public__key__3072.html">rsa_public_key_3072</a> *&#160;</td>
<td class="paramname"><em>PUB</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>F</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>G</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">PUB</td><td>the input RSA public key </td></tr>
<tr><td class="paramname">F</td><td>is input padded message </td></tr>
<tr><td class="paramname">G</td><td>is the output ciphertext </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae218fa230c4b45045d6730785ac526a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae218fa230c4b45045d6730785ac526a5">&#9670;&nbsp;</a></span>RSA_3072_fromOctet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RSA_3072_fromOctet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="big__384__56_8h.html#a84b175c07377e6d2a06d66603d2e719c">BIG_384_56</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>S</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates RSA public key from big-endian base 256 form. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FF instance to be created from an octet string </td></tr>
<tr><td class="paramname">S</td><td>input octet string </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae45aa8fdf906ca4c128712ee9cfa4af6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae45aa8fdf906ca4c128712ee9cfa4af6">&#9670;&nbsp;</a></span>RSA_3072_KEY_PAIR()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RSA_3072_KEY_PAIR </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcsprng.html">csprng</a> *&#160;</td>
<td class="paramname"><em>R</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="arch_8h.html#af31fcb3b74c4bcf6507f62d801277492">sign32</a>&#160;</td>
<td class="paramname"><em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structrsa__private__key__3072.html">rsa_private_key_3072</a> *&#160;</td>
<td class="paramname"><em>PRIV</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structrsa__public__key__3072.html">rsa_public_key_3072</a> *&#160;</td>
<td class="paramname"><em>PUB</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>P</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>Q</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">R</td><td>is a pointer to a cryptographically secure random number generator </td></tr>
<tr><td class="paramname">e</td><td>the encryption exponent </td></tr>
<tr><td class="paramname">PRIV</td><td>the output RSA private key </td></tr>
<tr><td class="paramname">PUB</td><td>the output RSA public key </td></tr>
<tr><td class="paramname">P</td><td>Input prime number. Used when R is equal to NULL for testing </td></tr>
<tr><td class="paramname">Q</td><td>Inpuy prime number. Used when R is equal to NULL for testing </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa3cbeb08aa7f23eb33b57c200bc0be3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3cbeb08aa7f23eb33b57c200bc0be3c">&#9670;&nbsp;</a></span>RSA_3072_PRIVATE_KEY_KILL()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RSA_3072_PRIVATE_KEY_KILL </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structrsa__private__key__3072.html">rsa_private_key_3072</a> *&#160;</td>
<td class="paramname"><em>PRIV</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">PRIV</td><td>the input RSA private key. Destroyed on output. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>