Google Git
Sign in
apache / incubator-milagro / b63e6dda48758c6d401a89facac899310e183962 / . / website / static / cdocs / bls192__BLS24_8h.html
blob: 2d42d4ed322e705434593a80f3ebdeb0e03561dc [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: bls192_BLS24.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_df7310d1a865926cc859bcfb1880083f.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">bls192_BLS24.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>BLS Header file.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;pair192_BLS24.h&quot;</code><br />
</div>
<p><a href="bls192__BLS24_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:a28d4a9713dd3843aa108a5fb339ec6f4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bls192__BLS24_8h.html#a28d4a9713dd3843aa108a5fb339ec6f4">BGS_BLS24</a>&#160;&#160;&#160;<a class="el" href="config__big__480__56_8h.html#a191ec4881a360e5cfd3a943c8861961d">MODBYTES_480_56</a></td></tr>
<tr class="separator:a28d4a9713dd3843aa108a5fb339ec6f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae26181d2349141710a9aacc1dfb52902"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bls192__BLS24_8h.html#ae26181d2349141710a9aacc1dfb52902">BFS_BLS24</a>&#160;&#160;&#160;<a class="el" href="config__big__480__56_8h.html#a191ec4881a360e5cfd3a943c8861961d">MODBYTES_480_56</a></td></tr>
<tr class="separator:ae26181d2349141710a9aacc1dfb52902"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0954a33675757ad87dde21d92a448805"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bls192__BLS24_8h.html#a0954a33675757ad87dde21d92a448805">BLS_OK</a>&#160;&#160;&#160;0</td></tr>
<tr class="separator:a0954a33675757ad87dde21d92a448805"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7ad1154a1fc1e13c0c9020ba3b2efa8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bls192__BLS24_8h.html#ad7ad1154a1fc1e13c0c9020ba3b2efa8">BLS_FAIL</a>&#160;&#160;&#160;41</td></tr>
<tr class="separator:ad7ad1154a1fc1e13c0c9020ba3b2efa8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf6e7c8f3dac9ed955df538eeddfe65a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bls192__BLS24_8h.html#acf6e7c8f3dac9ed955df538eeddfe65a">BLS_INVALID_G1</a>&#160;&#160;&#160;42</td></tr>
<tr class="separator:acf6e7c8f3dac9ed955df538eeddfe65a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e1f50f8bd36bc147cf2c39e917047aa"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bls192__BLS24_8h.html#a0e1f50f8bd36bc147cf2c39e917047aa">BLS_INVALID_G2</a>&#160;&#160;&#160;43</td></tr>
<tr class="separator:a0e1f50f8bd36bc147cf2c39e917047aa"><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:a3ff9de2861f2c7d30c7cf52d9ea1591c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bls192__BLS24_8h.html#a3ff9de2861f2c7d30c7cf52d9ea1591c">BLS_BLS24_KEY_PAIR_GENERATE</a> (<a class="el" href="structcsprng.html">csprng</a> *RNG, <a class="el" href="structoctet.html">octet</a> *S, <a class="el" href="structoctet.html">octet</a> *W)</td></tr>
<tr class="memdesc:a3ff9de2861f2c7d30c7cf52d9ea1591c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate Key Pair. <a href="#a3ff9de2861f2c7d30c7cf52d9ea1591c">More...</a><br /></td></tr>
<tr class="separator:a3ff9de2861f2c7d30c7cf52d9ea1591c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79cbcdfdb4aef90e5e8d02fbc08dd726"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bls192__BLS24_8h.html#a79cbcdfdb4aef90e5e8d02fbc08dd726">BLS_BLS24_SIGN</a> (<a class="el" href="structoctet.html">octet</a> *SIG, char *m, <a class="el" href="structoctet.html">octet</a> *S)</td></tr>
<tr class="memdesc:a79cbcdfdb4aef90e5e8d02fbc08dd726"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate a signature. <a href="#a79cbcdfdb4aef90e5e8d02fbc08dd726">More...</a><br /></td></tr>
<tr class="separator:a79cbcdfdb4aef90e5e8d02fbc08dd726"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae167d4ff813dd451b8f9c1e54c041a85"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bls192__BLS24_8h.html#ae167d4ff813dd451b8f9c1e54c041a85">BLS_BLS24_VERIFY</a> (<a class="el" href="structoctet.html">octet</a> *SIG, char *m, <a class="el" href="structoctet.html">octet</a> *W)</td></tr>
<tr class="memdesc:ae167d4ff813dd451b8f9c1e54c041a85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Verify a signature. <a href="#ae167d4ff813dd451b8f9c1e54c041a85">More...</a><br /></td></tr>
<tr class="separator:ae167d4ff813dd451b8f9c1e54c041a85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74f85dd3448d0d41f9a1677a6a3ad582"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bls192__BLS24_8h.html#a74f85dd3448d0d41f9a1677a6a3ad582">BLS_BLS24_ADD_G1</a> (<a class="el" href="structoctet.html">octet</a> *R1, <a class="el" href="structoctet.html">octet</a> *R2, <a class="el" href="structoctet.html">octet</a> *R)</td></tr>
<tr class="memdesc:a74f85dd3448d0d41f9a1677a6a3ad582"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add two members from the group G1. <a href="#a74f85dd3448d0d41f9a1677a6a3ad582">More...</a><br /></td></tr>
<tr class="separator:a74f85dd3448d0d41f9a1677a6a3ad582"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2cde91c5e007bf3ac9918e2bc9db6b7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bls192__BLS24_8h.html#ad2cde91c5e007bf3ac9918e2bc9db6b7">BLS_BLS24_ADD_G2</a> (<a class="el" href="structoctet.html">octet</a> *W1, <a class="el" href="structoctet.html">octet</a> *W2, <a class="el" href="structoctet.html">octet</a> *W)</td></tr>
<tr class="memdesc:ad2cde91c5e007bf3ac9918e2bc9db6b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add two members from the group G2. <a href="#ad2cde91c5e007bf3ac9918e2bc9db6b7">More...</a><br /></td></tr>
<tr class="separator:ad2cde91c5e007bf3ac9918e2bc9db6b7"><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>
<dl class="section date"><dt>Date</dt><dd>28th Novemebr 2018 Allows some user configuration defines structures declares functions </dd></dl>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ae26181d2349141710a9aacc1dfb52902"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae26181d2349141710a9aacc1dfb52902">&#9670;&nbsp;</a></span>BFS_BLS24</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BFS_BLS24&#160;&#160;&#160;<a class="el" href="config__big__480__56_8h.html#a191ec4881a360e5cfd3a943c8861961d">MODBYTES_480_56</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>BLS Field Size </p>
</div>
</div>
<a id="a28d4a9713dd3843aa108a5fb339ec6f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28d4a9713dd3843aa108a5fb339ec6f4">&#9670;&nbsp;</a></span>BGS_BLS24</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BGS_BLS24&#160;&#160;&#160;<a class="el" href="config__big__480__56_8h.html#a191ec4881a360e5cfd3a943c8861961d">MODBYTES_480_56</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>BLS Group Size </p>
</div>
</div>
<a id="ad7ad1154a1fc1e13c0c9020ba3b2efa8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7ad1154a1fc1e13c0c9020ba3b2efa8">&#9670;&nbsp;</a></span>BLS_FAIL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BLS_FAIL&#160;&#160;&#160;41</td>
</tr>
</table>
</div><div class="memdoc">
<p>Invalid signature </p>
</div>
</div>
<a id="acf6e7c8f3dac9ed955df538eeddfe65a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf6e7c8f3dac9ed955df538eeddfe65a">&#9670;&nbsp;</a></span>BLS_INVALID_G1</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BLS_INVALID_G1&#160;&#160;&#160;42</td>
</tr>
</table>
</div><div class="memdoc">
<p>Not a valid G1 point on the curve </p>
</div>
</div>
<a id="a0e1f50f8bd36bc147cf2c39e917047aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e1f50f8bd36bc147cf2c39e917047aa">&#9670;&nbsp;</a></span>BLS_INVALID_G2</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BLS_INVALID_G2&#160;&#160;&#160;43</td>
</tr>
</table>
</div><div class="memdoc">
<p>Not a valid G2 point on the curve </p>
</div>
</div>
<a id="a0954a33675757ad87dde21d92a448805"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0954a33675757ad87dde21d92a448805">&#9670;&nbsp;</a></span>BLS_OK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BLS_OK&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function completed without error </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a74f85dd3448d0d41f9a1677a6a3ad582"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74f85dd3448d0d41f9a1677a6a3ad582">&#9670;&nbsp;</a></span>BLS_BLS24_ADD_G1()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BLS_BLS24_ADD_G1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>R1</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>R2</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>R</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">R1</td><td>member of G1 </td></tr>
<tr><td class="paramname">R2</td><td>member of G1 </td></tr>
<tr><td class="paramname">R</td><td>member of G1. R = R1+R2 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Zero for success or else an error code </dd></dl>
</div>
</div>
<a id="ad2cde91c5e007bf3ac9918e2bc9db6b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2cde91c5e007bf3ac9918e2bc9db6b7">&#9670;&nbsp;</a></span>BLS_BLS24_ADD_G2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BLS_BLS24_ADD_G2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>W1</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>W2</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">W1</td><td>member of G2 </td></tr>
<tr><td class="paramname">W2</td><td>member of G2 </td></tr>
<tr><td class="paramname">W</td><td>member of G2. W = W1+W2 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Zero for success or else an error code </dd></dl>
</div>
</div>
<a id="a3ff9de2861f2c7d30c7cf52d9ea1591c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ff9de2861f2c7d30c7cf52d9ea1591c">&#9670;&nbsp;</a></span>BLS_BLS24_KEY_PAIR_GENERATE()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BLS_BLS24_KEY_PAIR_GENERATE </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcsprng.html">csprng</a> *&#160;</td>
<td class="paramname"><em>RNG</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>, </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">RNG</td><td>Pointer to a cryptographically secure random number generator </td></tr>
<tr><td class="paramname">S</td><td>Private key </td></tr>
<tr><td class="paramname">W</td><td>Public Key. W = S*G, where G is fixed generator </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Zero for success or else an error code </dd></dl>
</div>
</div>
<a id="a79cbcdfdb4aef90e5e8d02fbc08dd726"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79cbcdfdb4aef90e5e8d02fbc08dd726">&#9670;&nbsp;</a></span>BLS_BLS24_SIGN()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BLS_BLS24_SIGN </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>SIG</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#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>S</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">SIG</td><td>signature </td></tr>
<tr><td class="paramname">m</td><td>message to be signed </td></tr>
<tr><td class="paramname">S</td><td>Private key </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Zero for success or else an error code </dd></dl>
</div>
</div>
<a id="ae167d4ff813dd451b8f9c1e54c041a85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae167d4ff813dd451b8f9c1e54c041a85">&#9670;&nbsp;</a></span>BLS_BLS24_VERIFY()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int BLS_BLS24_VERIFY </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>SIG</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#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">SIG</td><td>signature </td></tr>
<tr><td class="paramname">m</td><td>message whose signature is to be verified. </td></tr>
<tr><td class="paramname">W</td><td>Public key </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Zero for success or else an error code </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>