Google Git
Sign in
apache / incubator-milagro / refs/heads/asf-site / . / cdocs / rsa__4096_8h.html
blob: 4dd1332d92ee8db2a602f3e579b0db17f1aa5d91 [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_4096.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_4096.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__4096_8h_source.html">ff_4096.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__4096_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__4096.html">rsa_public_key_4096</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Integer Factorisation Public Key. <a href="structrsa__public__key__4096.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__4096.html">rsa_private_key_4096</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Integer Factorisation Private Key. <a href="structrsa__private__key__4096.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:acf16200cf44f099048f8a6e26ebdb0f0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rsa__4096_8h.html#acf16200cf44f099048f8a6e26ebdb0f0">HASH_TYPE_RSA_4096</a>&#160;&#160;&#160;SHA256</td></tr>
<tr class="separator:acf16200cf44f099048f8a6e26ebdb0f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad11a752c61ee9bf2690d65e783381132"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rsa__4096_8h.html#ad11a752c61ee9bf2690d65e783381132">RFS_4096</a>&#160;&#160;&#160;<a class="el" href="config__big__512__60_8h.html#ab19d60ee027e5dad97c3c89e3d3d7525">MODBYTES_512_60</a>*<a class="el" href="config__ff__4096_8h.html#af3c21ac004bc32aa00e7a20811de549c">FFLEN_4096</a></td></tr>
<tr class="separator:ad11a752c61ee9bf2690d65e783381132"><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:a07b031a91d1833f3a1ab79e60f9b4bb1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rsa__4096_8h.html#a07b031a91d1833f3a1ab79e60f9b4bb1">RSA_4096_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__4096.html">rsa_private_key_4096</a> *PRIV, <a class="el" href="structrsa__public__key__4096.html">rsa_public_key_4096</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:a07b031a91d1833f3a1ab79e60f9b4bb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">RSA Key Pair Generator. <a href="#a07b031a91d1833f3a1ab79e60f9b4bb1">More...</a><br /></td></tr>
<tr class="separator:a07b031a91d1833f3a1ab79e60f9b4bb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09030c5f9f4842eeb4c2c831aa65b498"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rsa__4096_8h.html#a09030c5f9f4842eeb4c2c831aa65b498">RSA_4096_ENCRYPT</a> (<a class="el" href="structrsa__public__key__4096.html">rsa_public_key_4096</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:a09030c5f9f4842eeb4c2c831aa65b498"><td class="mdescLeft">&#160;</td><td class="mdescRight">RSA encryption of suitably padded plaintext. <a href="#a09030c5f9f4842eeb4c2c831aa65b498">More...</a><br /></td></tr>
<tr class="separator:a09030c5f9f4842eeb4c2c831aa65b498"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33ca71c71b4ff57a70160ad133ca2bf5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rsa__4096_8h.html#a33ca71c71b4ff57a70160ad133ca2bf5">RSA_4096_DECRYPT</a> (<a class="el" href="structrsa__private__key__4096.html">rsa_private_key_4096</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:a33ca71c71b4ff57a70160ad133ca2bf5"><td class="mdescLeft">&#160;</td><td class="mdescRight">RSA decryption of ciphertext. <a href="#a33ca71c71b4ff57a70160ad133ca2bf5">More...</a><br /></td></tr>
<tr class="separator:a33ca71c71b4ff57a70160ad133ca2bf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a8f7623af6518be48dec472a3eee0f5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rsa__4096_8h.html#a6a8f7623af6518be48dec472a3eee0f5">RSA_4096_PRIVATE_KEY_KILL</a> (<a class="el" href="structrsa__private__key__4096.html">rsa_private_key_4096</a> *PRIV)</td></tr>
<tr class="memdesc:a6a8f7623af6518be48dec472a3eee0f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy an RSA private Key. <a href="#a6a8f7623af6518be48dec472a3eee0f5">More...</a><br /></td></tr>
<tr class="separator:a6a8f7623af6518be48dec472a3eee0f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a11cfd22c2d694005fb63be2192a83a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rsa__4096_8h.html#a8a11cfd22c2d694005fb63be2192a83a">RSA_4096_fromOctet</a> (<a class="el" href="big__512__60_8h.html#a38953b585df73ecbd30fded6cc5b54b7">BIG_512_60</a> *x, <a class="el" href="structoctet.html">octet</a> *S)</td></tr>
<tr class="memdesc:a8a11cfd22c2d694005fb63be2192a83a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Populates an RSA public key from an octet string. <a href="#a8a11cfd22c2d694005fb63be2192a83a">More...</a><br /></td></tr>
<tr class="separator:a8a11cfd22c2d694005fb63be2192a83a"><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="acf16200cf44f099048f8a6e26ebdb0f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf16200cf44f099048f8a6e26ebdb0f0">&#9670;&nbsp;</a></span>HASH_TYPE_RSA_4096</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define HASH_TYPE_RSA_4096&#160;&#160;&#160;SHA256</td>
</tr>
</table>
</div><div class="memdoc">
<p>Chosen Hash algorithm </p>
</div>
</div>
<a id="ad11a752c61ee9bf2690d65e783381132"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad11a752c61ee9bf2690d65e783381132">&#9670;&nbsp;</a></span>RFS_4096</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define RFS_4096&#160;&#160;&#160;<a class="el" href="config__big__512__60_8h.html#ab19d60ee027e5dad97c3c89e3d3d7525">MODBYTES_512_60</a>*<a class="el" href="config__ff__4096_8h.html#af3c21ac004bc32aa00e7a20811de549c">FFLEN_4096</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="a33ca71c71b4ff57a70160ad133ca2bf5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33ca71c71b4ff57a70160ad133ca2bf5">&#9670;&nbsp;</a></span>RSA_4096_DECRYPT()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RSA_4096_DECRYPT </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structrsa__private__key__4096.html">rsa_private_key_4096</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="a09030c5f9f4842eeb4c2c831aa65b498"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09030c5f9f4842eeb4c2c831aa65b498">&#9670;&nbsp;</a></span>RSA_4096_ENCRYPT()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RSA_4096_ENCRYPT </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structrsa__public__key__4096.html">rsa_public_key_4096</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="a8a11cfd22c2d694005fb63be2192a83a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a11cfd22c2d694005fb63be2192a83a">&#9670;&nbsp;</a></span>RSA_4096_fromOctet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RSA_4096_fromOctet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="big__512__60_8h.html#a38953b585df73ecbd30fded6cc5b54b7">BIG_512_60</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="a07b031a91d1833f3a1ab79e60f9b4bb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07b031a91d1833f3a1ab79e60f9b4bb1">&#9670;&nbsp;</a></span>RSA_4096_KEY_PAIR()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RSA_4096_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__4096.html">rsa_private_key_4096</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__4096.html">rsa_public_key_4096</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="a6a8f7623af6518be48dec472a3eee0f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a8f7623af6518be48dec472a3eee0f5">&#9670;&nbsp;</a></span>RSA_4096_PRIVATE_KEY_KILL()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RSA_4096_PRIVATE_KEY_KILL </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structrsa__private__key__4096.html">rsa_private_key_4096</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>