| <!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.9.1"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>libmpc: commitments.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" async="async" 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">libmpc |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.1 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); |
| /* @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&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><li class="navelem"><a class="el" href="dir_a166689341c37329f24f96bdba87a08b.html">amcl</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Data Structures</a> | |
| <a href="#define-members">Macros</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">commitments.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Commitment schemes declarations. |
| <a href="#details">More...</a></p> |
| <div class="textblock"><code>#include "amcl/amcl.h"</code><br /> |
| <code>#include "amcl/ff_2048.h"</code><br /> |
| </div> |
| <p><a href="commitments_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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structCOMMITMENTS__BC__priv__modulus.html">COMMITMENTS_BC_priv_modulus</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">RSA modulus for Bit Commitment. <a href="structCOMMITMENTS__BC__priv__modulus.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structCOMMITMENTS__BC__pub__modulus.html">COMMITMENTS_BC_pub_modulus</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Public RSA modulus for Bit Commitment. <a href="structCOMMITMENTS__BC__pub__modulus.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </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:a296158654474a636d999781ddcb9f9d8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="commitments_8h.html#a296158654474a636d999781ddcb9f9d8">COMMITMENTS_OK</a>   0</td></tr> |
| <tr class="separator:a296158654474a636d999781ddcb9f9d8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0280d7c876b77a0bae100933dc61c9bb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="commitments_8h.html#a0280d7c876b77a0bae100933dc61c9bb">COMMITMENTS_FAIL</a>   81</td></tr> |
| <tr class="separator:a0280d7c876b77a0bae100933dc61c9bb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae3ce9abc99cec679346a7d38bed96d9b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="commitments_8h.html#ae3ce9abc99cec679346a7d38bed96d9b">FS_2048</a>   MODBYTES_1024_58 * FFLEN_2048</td></tr> |
| <tr class="separator:ae3ce9abc99cec679346a7d38bed96d9b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af12daa3ccdbe8c973ca455b53f58f13b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="commitments_8h.html#af12daa3ccdbe8c973ca455b53f58f13b">HFS_2048</a>   MODBYTES_1024_58 * HFLEN_2048</td></tr> |
| <tr class="separator:af12daa3ccdbe8c973ca455b53f58f13b"><td class="memSeparator" colspan="2"> </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:a03557be3cbf16370e9113fff93bc8169"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="commitments_8h.html#a03557be3cbf16370e9113fff93bc8169">COMMITMENTS_NM_commit</a> (csprng *RNG, const octet *X, octet *R, octet *C)</td></tr> |
| <tr class="memdesc:a03557be3cbf16370e9113fff93bc8169"><td class="mdescLeft"> </td><td class="mdescRight">Generate a commitment for the value X. <a href="commitments_8h.html#a03557be3cbf16370e9113fff93bc8169">More...</a><br /></td></tr> |
| <tr class="separator:a03557be3cbf16370e9113fff93bc8169"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a224adcc226ada8b5b999db0ff00f0986"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="commitments_8h.html#a224adcc226ada8b5b999db0ff00f0986">COMMITMENTS_NM_decommit</a> (const octet *X, const octet *R, octet *C)</td></tr> |
| <tr class="memdesc:a224adcc226ada8b5b999db0ff00f0986"><td class="mdescLeft"> </td><td class="mdescRight">Decommit the value X. <a href="commitments_8h.html#a224adcc226ada8b5b999db0ff00f0986">More...</a><br /></td></tr> |
| <tr class="separator:a224adcc226ada8b5b999db0ff00f0986"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a522d6f485494a7a2297007121529db4a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="commitments_8h.html#a522d6f485494a7a2297007121529db4a">COMMITMENTS_BC_setup</a> (csprng *RNG, <a class="el" href="structCOMMITMENTS__BC__priv__modulus.html">COMMITMENTS_BC_priv_modulus</a> *m, octet *P, octet *Q, octet *B0, octet *ALPHA)</td></tr> |
| <tr class="memdesc:a522d6f485494a7a2297007121529db4a"><td class="mdescLeft"> </td><td class="mdescRight">Set up an RSA modulus and the necessary values. <a href="commitments_8h.html#a522d6f485494a7a2297007121529db4a">More...</a><br /></td></tr> |
| <tr class="separator:a522d6f485494a7a2297007121529db4a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a347b682fd4742fff73a9c924c88254ce"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="commitments_8h.html#a347b682fd4742fff73a9c924c88254ce">COMMITMENTS_BC_kill_priv_modulus</a> (<a class="el" href="structCOMMITMENTS__BC__priv__modulus.html">COMMITMENTS_BC_priv_modulus</a> *m)</td></tr> |
| <tr class="memdesc:a347b682fd4742fff73a9c924c88254ce"><td class="mdescLeft"> </td><td class="mdescRight">Clean secret values from the modulus. <a href="commitments_8h.html#a347b682fd4742fff73a9c924c88254ce">More...</a><br /></td></tr> |
| <tr class="separator:a347b682fd4742fff73a9c924c88254ce"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad1c607c0e295be5b496475c3c4959fad"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="commitments_8h.html#ad1c607c0e295be5b496475c3c4959fad">COMMITMENTS_BC_export_public_modulus</a> (<a class="el" href="structCOMMITMENTS__BC__pub__modulus.html">COMMITMENTS_BC_pub_modulus</a> *pub, <a class="el" href="structCOMMITMENTS__BC__priv__modulus.html">COMMITMENTS_BC_priv_modulus</a> *priv)</td></tr> |
| <tr class="memdesc:ad1c607c0e295be5b496475c3c4959fad"><td class="mdescLeft"> </td><td class="mdescRight">Export the public part of the modulus. <a href="commitments_8h.html#ad1c607c0e295be5b496475c3c4959fad">More...</a><br /></td></tr> |
| <tr class="separator:ad1c607c0e295be5b496475c3c4959fad"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Macro Definition Documentation</h2> |
| <a id="a0280d7c876b77a0bae100933dc61c9bb"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0280d7c876b77a0bae100933dc61c9bb">◆ </a></span>COMMITMENTS_FAIL</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define COMMITMENTS_FAIL   81</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Invalid Commitment </p> |
| |
| </div> |
| </div> |
| <a id="a296158654474a636d999781ddcb9f9d8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a296158654474a636d999781ddcb9f9d8">◆ </a></span>COMMITMENTS_OK</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define COMMITMENTS_OK   0</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Success </p> |
| |
| </div> |
| </div> |
| <a id="ae3ce9abc99cec679346a7d38bed96d9b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae3ce9abc99cec679346a7d38bed96d9b">◆ </a></span>FS_2048</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define FS_2048   MODBYTES_1024_58 * FFLEN_2048</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>2048 field size in bytes </p> |
| |
| </div> |
| </div> |
| <a id="af12daa3ccdbe8c973ca455b53f58f13b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af12daa3ccdbe8c973ca455b53f58f13b">◆ </a></span>HFS_2048</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define HFS_2048   MODBYTES_1024_58 * HFLEN_2048</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Half 2048 field size in bytes </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a id="ad1c607c0e295be5b496475c3c4959fad"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad1c607c0e295be5b496475c3c4959fad">◆ </a></span>COMMITMENTS_BC_export_public_modulus()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void COMMITMENTS_BC_export_public_modulus </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structCOMMITMENTS__BC__pub__modulus.html">COMMITMENTS_BC_pub_modulus</a> * </td> |
| <td class="paramname"><em>pub</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structCOMMITMENTS__BC__priv__modulus.html">COMMITMENTS_BC_priv_modulus</a> * </td> |
| <td class="paramname"><em>priv</em> </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 destination public modulus </td></tr> |
| <tr><td class="paramname">priv</td><td>The source private modulus </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a347b682fd4742fff73a9c924c88254ce"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a347b682fd4742fff73a9c924c88254ce">◆ </a></span>COMMITMENTS_BC_kill_priv_modulus()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void COMMITMENTS_BC_kill_priv_modulus </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structCOMMITMENTS__BC__priv__modulus.html">COMMITMENTS_BC_priv_modulus</a> * </td> |
| <td class="paramname"><em>m</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">m</td><td>The modulus to clean </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a522d6f485494a7a2297007121529db4a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a522d6f485494a7a2297007121529db4a">◆ </a></span>COMMITMENTS_BC_setup()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void COMMITMENTS_BC_setup </td> |
| <td>(</td> |
| <td class="paramtype">csprng * </td> |
| <td class="paramname"><em>RNG</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structCOMMITMENTS__BC__priv__modulus.html">COMMITMENTS_BC_priv_modulus</a> * </td> |
| <td class="paramname"><em>m</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">octet * </td> |
| <td class="paramname"><em>P</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">octet * </td> |
| <td class="paramname"><em>Q</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">octet * </td> |
| <td class="paramname"><em>B0</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">octet * </td> |
| <td class="paramname"><em>ALPHA</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>RNG is only used to generate the values not explicitly specified. This allows using safe primes P and Q generated externally while still randomly generating B0 and ALPHA. In turn, this allows the user to generate P and Q with ad hoc libraries for the generation of primes instead of the (slow) safe prime generation utility included here.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">RNG</td><td>CSPRNG to generate P, Q, B0 and ALPHA </td></tr> |
| <tr><td class="paramname">m</td><td>Private modulus to populate </td></tr> |
| <tr><td class="paramname">P</td><td>Safe prime 2p+1. Generated if NULL </td></tr> |
| <tr><td class="paramname">Q</td><td>Safe prime 2q+1. Generated if NULL </td></tr> |
| <tr><td class="paramname">B0</td><td>Generator of G_pq as subgroup of Z/PQZ. Generated if NULL </td></tr> |
| <tr><td class="paramname">ALPHA</td><td>DLOG exponent for B1 = B0^ALPHA. Generated if NULL </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a03557be3cbf16370e9113fff93bc8169"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a03557be3cbf16370e9113fff93bc8169">◆ </a></span>COMMITMENTS_NM_commit()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void COMMITMENTS_NM_commit </td> |
| <td>(</td> |
| <td class="paramtype">csprng * </td> |
| <td class="paramname"><em>RNG</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const octet * </td> |
| <td class="paramname"><em>X</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">octet * </td> |
| <td class="paramname"><em>R</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">octet * </td> |
| <td class="paramname"><em>C</em> </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>CSPRNG to use for commitment </td></tr> |
| <tr><td class="paramname">X</td><td>Value to commit to </td></tr> |
| <tr><td class="paramname">R</td><td>Decommitment value. If RNG is null then this value is read and must be 256 bit long </td></tr> |
| <tr><td class="paramname">C</td><td>Commitment value </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a224adcc226ada8b5b999db0ff00f0986"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a224adcc226ada8b5b999db0ff00f0986">◆ </a></span>COMMITMENTS_NM_decommit()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int COMMITMENTS_NM_decommit </td> |
| <td>(</td> |
| <td class="paramtype">const octet * </td> |
| <td class="paramname"><em>X</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const octet * </td> |
| <td class="paramname"><em>R</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">octet * </td> |
| <td class="paramname"><em>C</em> </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">X</td><td>Committed value </td></tr> |
| <tr><td class="paramname">R</td><td>Decommitment value. Must be 256 bit long </td></tr> |
| <tr><td class="paramname">C</td><td>Commitment value </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Returns 1 for a valid decommitment, 0 otherwise </dd></dl> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 |
| </small></address> |
| </body> |
| </html> |
