Google Git
Sign in
apache / incubator-milagro / 0f9f3486eeb44998c679da951836f726c8e0773d / . / website / static / cdocs / bls__BN254_8h_source.html
blob: 0528c4e1d75d37af1b95f0a75482f8886e627f1f [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: bls_BN254.h Source File</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="headertitle">
<div class="title">bls_BN254.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="bls__BN254_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">distributed with this work for additional information</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">&quot;License&quot;); you may not use this file except in compliance</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">software distributed under the License is distributed on an</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">&quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">specific language governing permissions and limitations</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">under the License.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#ifndef BLS_BN254_H</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#define BLS_BN254_H</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="pair__BN254_8h.html">pair_BN254.h</a>&quot;</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment">/* Field size is assumed to be greater than or equal to group size */</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="bls__BN254_8h.html#a3da9cd3a39c61c07e4a8efb147743b36"> 39</a></span>&#160;<span class="preprocessor">#define BGS_BN254 MODBYTES_256_56 </span></div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="bls__BN254_8h.html#a3541c1b78fa4172a85c5840d13af46da"> 40</a></span>&#160;<span class="preprocessor">#define BFS_BN254 MODBYTES_256_56 </span></div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="bls__BN254_8h.html#a0954a33675757ad87dde21d92a448805"> 42</a></span>&#160;<span class="preprocessor">#define BLS_OK 0 </span></div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="bls__BN254_8h.html#ad7ad1154a1fc1e13c0c9020ba3b2efa8"> 43</a></span>&#160;<span class="preprocessor">#define BLS_FAIL 41 </span></div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="bls__BN254_8h.html#acf6e7c8f3dac9ed955df538eeddfe65a"> 44</a></span>&#160;<span class="preprocessor">#define BLS_INVALID_G1 42 </span></div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="bls__BN254_8h.html#a0e1f50f8bd36bc147cf2c39e917047aa"> 45</a></span>&#160;<span class="preprocessor">#define BLS_INVALID_G2 43 </span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor"></span><span class="comment">/* BLS API functions */</span><span class="preprocessor"></span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="keywordtype">int</span> <a class="code" href="bls__BN254_8h.html#ae3c46fdd8b37de562e16e5f765067036">BLS_BN254_KEY_PAIR_GENERATE</a>(<a class="code" href="structcsprng.html">csprng</a> *RNG,<a class="code" href="structoctet.html">octet</a>* S,<a class="code" href="structoctet.html">octet</a> *W);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="keywordtype">int</span> <a class="code" href="bls__BN254_8h.html#a5ae7e925844eb58dc8ad104d18e92bb9">BLS_BN254_SIGN</a>(<a class="code" href="structoctet.html">octet</a> *SIG,<a class="code" href="structoctet.html">octet</a> *M,<a class="code" href="structoctet.html">octet</a> *S);</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="keywordtype">int</span> <a class="code" href="bls__BN254_8h.html#a5f94d1fc3631280015e93174db72ed5c">BLS_BN254_VERIFY</a>(<a class="code" href="structoctet.html">octet</a> *SIG,<a class="code" href="structoctet.html">octet</a> *M,<a class="code" href="structoctet.html">octet</a> *W);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="keywordtype">int</span> <a class="code" href="bls__BN254_8h.html#a2f14c4eea0585a79cc353b7a718f16a0">BLS_BN254_ADD_G1</a>(<a class="code" href="structoctet.html">octet</a> *R1,<a class="code" href="structoctet.html">octet</a> *R2,<a class="code" href="structoctet.html">octet</a> *R);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;<span class="keywordtype">int</span> <a class="code" href="bls__BN254_8h.html#a1d3d52cb10930fd4ea541d39ac29c4e2">BLS_BN254_ADD_G2</a>(<a class="code" href="structoctet.html">octet</a> *W1,<a class="code" href="structoctet.html">octet</a> *W2,<a class="code" href="structoctet.html">octet</a> *W);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;<span class="keywordtype">int</span> <a class="code" href="bls__BN254_8h.html#a857a1e998e2aa2f954899e8e179bf1dd">BLS_BN254_MAKE_SHARES</a>(<span class="keywordtype">int</span> k, <span class="keywordtype">int</span> n, <a class="code" href="structcsprng.html">csprng</a> *RNG, <a class="code" href="structoctet.html">octet</a>* X, <a class="code" href="structoctet.html">octet</a>* Y, <a class="code" href="structoctet.html">octet</a>* SKI, <a class="code" href="structoctet.html">octet</a>* SKO);</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;<span class="keywordtype">int</span> <a class="code" href="bls__BN254_8h.html#a7f1095cf77f84b79dd6d9db2c6df2022">BLS_BN254_RECOVER_SECRET</a>(<span class="keywordtype">int</span> k, <a class="code" href="structoctet.html">octet</a>* X, <a class="code" href="structoctet.html">octet</a>* Y, <a class="code" href="structoctet.html">octet</a>* SK);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;<span class="keywordtype">int</span> <a class="code" href="bls__BN254_8h.html#a77a7b86612258446419fa1bc592ab397">BLS_BN254_RECOVER_SIGNATURE</a>(<span class="keywordtype">int</span> k, <a class="code" href="structoctet.html">octet</a>* X, <a class="code" href="structoctet.html">octet</a>* Y, <a class="code" href="structoctet.html">octet</a>* SIG);</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;</div><div class="ttc" id="bls__BN254_8h_html_a5f94d1fc3631280015e93174db72ed5c"><div class="ttname"><a href="bls__BN254_8h.html#a5f94d1fc3631280015e93174db72ed5c">BLS_BN254_VERIFY</a></div><div class="ttdeci">int BLS_BN254_VERIFY(octet *SIG, octet *M, octet *W)</div><div class="ttdoc">Verify a signature. </div><div class="ttdef"><b>Definition:</b> bls_BN254.c:155</div></div>
<div class="ttc" id="bls__BN254_8h_html_a7f1095cf77f84b79dd6d9db2c6df2022"><div class="ttname"><a href="bls__BN254_8h.html#a7f1095cf77f84b79dd6d9db2c6df2022">BLS_BN254_RECOVER_SECRET</a></div><div class="ttdeci">int BLS_BN254_RECOVER_SECRET(int k, octet *X, octet *Y, octet *SK)</div><div class="ttdoc">Use Shamir&amp;#39;s secret sharing to recover a BLS secret key. </div><div class="ttdef"><b>Definition:</b> bls_BN254.c:290</div></div>
<div class="ttc" id="structoctet_html"><div class="ttname"><a href="structoctet.html">octet</a></div><div class="ttdoc">Portable representation of a big positive number. </div><div class="ttdef"><b>Definition:</b> amcl.h:209</div></div>
<div class="ttc" id="bls__BN254_8h_html_a2f14c4eea0585a79cc353b7a718f16a0"><div class="ttname"><a href="bls__BN254_8h.html#a2f14c4eea0585a79cc353b7a718f16a0">BLS_BN254_ADD_G1</a></div><div class="ttdeci">int BLS_BN254_ADD_G1(octet *R1, octet *R2, octet *R)</div><div class="ttdoc">Add two members from the group G1. </div><div class="ttdef"><b>Definition:</b> bls_BN254.c:186</div></div>
<div class="ttc" id="pair__BN254_8h_html"><div class="ttname"><a href="pair__BN254_8h.html">pair_BN254.h</a></div><div class="ttdoc">PAIR Header File. </div></div>
<div class="ttc" id="bls__BN254_8h_html_a1d3d52cb10930fd4ea541d39ac29c4e2"><div class="ttname"><a href="bls__BN254_8h.html#a1d3d52cb10930fd4ea541d39ac29c4e2">BLS_BN254_ADD_G2</a></div><div class="ttdeci">int BLS_BN254_ADD_G2(octet *W1, octet *W2, octet *W)</div><div class="ttdoc">Add two members from the group G2. </div><div class="ttdef"><b>Definition:</b> bls_BN254.c:208</div></div>
<div class="ttc" id="bls__BN254_8h_html_a857a1e998e2aa2f954899e8e179bf1dd"><div class="ttname"><a href="bls__BN254_8h.html#a857a1e998e2aa2f954899e8e179bf1dd">BLS_BN254_MAKE_SHARES</a></div><div class="ttdeci">int BLS_BN254_MAKE_SHARES(int k, int n, csprng *RNG, octet *X, octet *Y, octet *SKI, octet *SKO)</div><div class="ttdoc">Use Shamir&amp;#39;s secret sharing to distribute BLS secret keys. </div><div class="ttdef"><b>Definition:</b> bls_BN254.c:229</div></div>
<div class="ttc" id="bls__BN254_8h_html_a77a7b86612258446419fa1bc592ab397"><div class="ttname"><a href="bls__BN254_8h.html#a77a7b86612258446419fa1bc592ab397">BLS_BN254_RECOVER_SIGNATURE</a></div><div class="ttdeci">int BLS_BN254_RECOVER_SIGNATURE(int k, octet *X, octet *Y, octet *SIG)</div><div class="ttdoc">Use Shamir&amp;#39;s secret sharing to recover a BLS signature. </div><div class="ttdef"><b>Definition:</b> bls_BN254.c:326</div></div>
<div class="ttc" id="structcsprng_html"><div class="ttname"><a href="structcsprng.html">csprng</a></div><div class="ttdoc">Cryptographically secure pseudo-random number generator instance. </div><div class="ttdef"><b>Definition:</b> amcl.h:195</div></div>
<div class="ttc" id="bls__BN254_8h_html_a5ae7e925844eb58dc8ad104d18e92bb9"><div class="ttname"><a href="bls__BN254_8h.html#a5ae7e925844eb58dc8ad104d18e92bb9">BLS_BN254_SIGN</a></div><div class="ttdeci">int BLS_BN254_SIGN(octet *SIG, octet *M, octet *S)</div><div class="ttdoc">Calculate a signature. </div><div class="ttdef"><b>Definition:</b> bls_BN254.c:141</div></div>
<div class="ttc" id="bls__BN254_8h_html_ae3c46fdd8b37de562e16e5f765067036"><div class="ttname"><a href="bls__BN254_8h.html#ae3c46fdd8b37de562e16e5f765067036">BLS_BN254_KEY_PAIR_GENERATE</a></div><div class="ttdeci">int BLS_BN254_KEY_PAIR_GENERATE(csprng *RNG, octet *S, octet *W)</div><div class="ttdoc">Generate Key Pair. </div><div class="ttdef"><b>Definition:</b> bls_BN254.c:115</div></div>
</div><!-- fragment --></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>