blob: 421d8d1737d2032577c590cb77333977bc0ae75e [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>AMCL: rsa_support.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>
<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.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">rsa_support.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>RSA Support Header File.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;amcl.h&quot;</code><br />
</div>
<p><a href="rsa__support_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="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:aa735a301da394741fbd7737fb35141e8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rsa__support_8h.html#aa735a301da394741fbd7737fb35141e8">MAX_RSA_BYTES</a>&#160;&#160;&#160;512</td></tr>
<tr class="separator:aa735a301da394741fbd7737fb35141e8"><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:a512f095800aeb50f09531474b04aaafd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rsa__support_8h.html#a512f095800aeb50f09531474b04aaafd">PKCS15</a> (int h, <a class="el" href="structoctet.html">octet</a> *M, <a class="el" href="structoctet.html">octet</a> *W)</td></tr>
<tr class="memdesc:a512f095800aeb50f09531474b04aaafd"><td class="mdescLeft">&#160;</td><td class="mdescRight">PKCS V1.5 padding of a message prior to RSA signature. <a href="#a512f095800aeb50f09531474b04aaafd">More...</a><br /></td></tr>
<tr class="separator:a512f095800aeb50f09531474b04aaafd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22d206244890a93a86fd77efb64a09a2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rsa__support_8h.html#a22d206244890a93a86fd77efb64a09a2">OAEP_ENCODE</a> (int h, <a class="el" href="structoctet.html">octet</a> *M, <a class="el" href="structcsprng.html">csprng</a> *R, <a class="el" href="structoctet.html">octet</a> *P, <a class="el" href="structoctet.html">octet</a> *F)</td></tr>
<tr class="memdesc:a22d206244890a93a86fd77efb64a09a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">OAEP padding of a message prior to RSA encryption. <a href="#a22d206244890a93a86fd77efb64a09a2">More...</a><br /></td></tr>
<tr class="separator:a22d206244890a93a86fd77efb64a09a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d96d5f657823c3c9736f6c0d4125273"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rsa__support_8h.html#a8d96d5f657823c3c9736f6c0d4125273">OAEP_DECODE</a> (int h, <a class="el" href="structoctet.html">octet</a> *P, <a class="el" href="structoctet.html">octet</a> *F)</td></tr>
<tr class="memdesc:a8d96d5f657823c3c9736f6c0d4125273"><td class="mdescLeft">&#160;</td><td class="mdescRight">OAEP unpadding of a message after RSA decryption. <a href="#a8d96d5f657823c3c9736f6c0d4125273">More...</a><br /></td></tr>
<tr class="separator:a8d96d5f657823c3c9736f6c0d4125273"><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 </dd></dl>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="aa735a301da394741fbd7737fb35141e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa735a301da394741fbd7737fb35141e8">&#9670;&nbsp;</a></span>MAX_RSA_BYTES</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MAX_RSA_BYTES&#160;&#160;&#160;512</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum of 4096 </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a8d96d5f657823c3c9736f6c0d4125273"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d96d5f657823c3c9736f6c0d4125273">&#9670;&nbsp;</a></span>OAEP_DECODE()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int OAEP_DECODE </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>h</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>F</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unpadding is done in-place </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">h</td><td>is the hash type </td></tr>
<tr><td class="paramname">P</td><td>are input encoding parameter string (could be NULL) </td></tr>
<tr><td class="paramname">F</td><td>is input padded message, unpadded on output </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK, else 1 </dd></dl>
</div>
</div>
<a id="a22d206244890a93a86fd77efb64a09a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22d206244890a93a86fd77efb64a09a2">&#9670;&nbsp;</a></span>OAEP_ENCODE()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int OAEP_ENCODE </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>h</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>M</em>, </td>
</tr>
<tr>
<td class="paramkey"></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="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>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">h</td><td>is the hash type </td></tr>
<tr><td class="paramname">M</td><td>is the input message </td></tr>
<tr><td class="paramname">R</td><td>is a pointer to a cryptographically secure random number generator </td></tr>
<tr><td class="paramname">P</td><td>are input encoding parameter string (could be NULL) </td></tr>
<tr><td class="paramname">F</td><td>is the output encoding, ready for RSA encryption </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK, else 1 </dd></dl>
</div>
</div>
<a id="a512f095800aeb50f09531474b04aaafd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a512f095800aeb50f09531474b04aaafd">&#9670;&nbsp;</a></span>PKCS15()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int PKCS15 </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>h</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>M</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>W</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">h</td><td>is the hash type </td></tr>
<tr><td class="paramname">M</td><td>is the input message </td></tr>
<tr><td class="paramname">W</td><td>is the output encoding, ready for RSA signature </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if OK, else 0 </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.15
</small></address>
</body>
</html>