diff options
Diffstat (limited to 'doc/html/group___pairing_primitives.html')
| -rw-r--r-- | doc/html/group___pairing_primitives.html | 257 |
1 files changed, 257 insertions, 0 deletions
diff --git a/doc/html/group___pairing_primitives.html b/doc/html/group___pairing_primitives.html new file mode 100644 index 0000000..db8f244 --- /dev/null +++ b/doc/html/group___pairing_primitives.html @@ -0,0 +1,257 @@ +<!-- HTML header for doxygen 1.8.10--> +<!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.14"/> +<title>Intel® Enhanced Privacy ID SDK: pairing</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="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ + $(document).ready(initResizable); +/* @license-end */</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="epidstyle.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"><a + onclick="storeLink('index.html')" + id="projectlink" + class="index.html" + href="index.html">Intel® Enhanced Privacy ID SDK</a> + <span id="projectnumber">6.0.1</span> +</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.14 --> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('group___pairing_primitives.html','');}); +/* @license-end */ +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#groups">Modules</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">pairing<div class="ingroups"><a class="el" href="group___epid_module.html">epid&nbsp;</a> » <a class="el" href="group___epid_common.html">common</a> » <a class="el" href="group___epid_math.html">math</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p>Pairing operations. +<a href="#details">More...</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a> +Modules</h2></td></tr> +<tr class="memitem:group___epid11_pairing_primitives"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___epid11_pairing_primitives.html">Intel(R) EPID 1.1 specific pairing</a></td></tr> +<tr class="memdesc:group___epid11_pairing_primitives"><td class="mdescLeft"> </td><td class="mdescRight">Intel(R) EPID 1.1 pairing operations. <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="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:ga29f79a645871830754d396b9b4a2a0cc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___pairing_primitives.html#ga29f79a645871830754d396b9b4a2a0cc">NewPairingState</a> (<a class="el" href="group___ec_group_primitives.html#gac91c5a7623c17a868dd15b2e9aaf7159">EcGroup</a> const *ga, <a class="el" href="group___ec_group_primitives.html#gac91c5a7623c17a868dd15b2e9aaf7159">EcGroup</a> const *gb, <a class="el" href="group___finite_field_primitives.html#gab281b24e336a8b3d7d90079d862d969e">FiniteField</a> *ff, <a class="el" href="struct_big_num_str.html">BigNumStr</a> const *t, <a class="el" href="stdtypes_8h.html#ad5c9d4ba3dc37783a528b0925dc981a0">bool</a> neg, <a class="el" href="struct_pairing_state.html">PairingState</a> **ps)</td></tr> +<tr class="memdesc:ga29f79a645871830754d396b9b4a2a0cc"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new pairing state. <a href="#ga29f79a645871830754d396b9b4a2a0cc">More...</a><br /></td></tr> +<tr class="separator:ga29f79a645871830754d396b9b4a2a0cc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad54aebdc331d39b73000fdca9e04f94d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___pairing_primitives.html#gad54aebdc331d39b73000fdca9e04f94d">DeletePairingState</a> (<a class="el" href="struct_pairing_state.html">PairingState</a> **ps)</td></tr> +<tr class="memdesc:gad54aebdc331d39b73000fdca9e04f94d"><td class="mdescLeft"> </td><td class="mdescRight">Frees a previously allocated by <a class="el" href="struct_pairing_state.html" title="A scratch buffer for stateful pairing calls. ">PairingState</a>. <a href="#gad54aebdc331d39b73000fdca9e04f94d">More...</a><br /></td></tr> +<tr class="separator:gad54aebdc331d39b73000fdca9e04f94d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga58a9d3cb6129274a04c72a35a52f768d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___pairing_primitives.html#ga58a9d3cb6129274a04c72a35a52f768d">Pairing</a> (<a class="el" href="struct_pairing_state.html">PairingState</a> *ps, <a class="el" href="group___ec_group_primitives.html#ga85c1d5e106031b385a6e23e598ac98fa">EcPoint</a> const *a, <a class="el" href="group___ec_group_primitives.html#ga85c1d5e106031b385a6e23e598ac98fa">EcPoint</a> const *b, <a class="el" href="group___finite_field_primitives.html#ga6cff5c7c06b07a87442b810ccc0a86fa">FfElement</a> *d)</td></tr> +<tr class="memdesc:ga58a9d3cb6129274a04c72a35a52f768d"><td class="mdescLeft"> </td><td class="mdescRight">Computes an Optimal Ate Pairing for two parameters. <a href="#ga58a9d3cb6129274a04c72a35a52f768d">More...</a><br /></td></tr> +<tr class="separator:ga58a9d3cb6129274a04c72a35a52f768d"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<p>Pairing operations. </p> +<p>Provides APIs for defining and using a pairing relationship between two elliptic curve groups. </p> +<h2 class="groupheader">Function Documentation</h2> +<a id="gad54aebdc331d39b73000fdca9e04f94d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gad54aebdc331d39b73000fdca9e04f94d">◆ </a></span>DeletePairingState()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void DeletePairingState </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_pairing_state.html">PairingState</a> ** </td> + <td class="paramname"><em>ps</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Frees a previously allocated by <a class="el" href="struct_pairing_state.html" title="A scratch buffer for stateful pairing calls. ">PairingState</a>. </p> +<p>Frees memory pointed to by pairing state. Nulls the pointer.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">ps</td><td>The pairing state. Can be NULL.</td></tr> + </table> + </dd> +</dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___pairing_primitives.html#ga29f79a645871830754d396b9b4a2a0cc" title="Constructs a new pairing state. ">NewPairingState</a> </dd></dl> + +</div> +</div> +<a id="ga29f79a645871830754d396b9b4a2a0cc"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga29f79a645871830754d396b9b4a2a0cc">◆ </a></span>NewPairingState()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> NewPairingState </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group___ec_group_primitives.html#gac91c5a7623c17a868dd15b2e9aaf7159">EcGroup</a> const * </td> + <td class="paramname"><em>ga</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group___ec_group_primitives.html#gac91c5a7623c17a868dd15b2e9aaf7159">EcGroup</a> const * </td> + <td class="paramname"><em>gb</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group___finite_field_primitives.html#gab281b24e336a8b3d7d90079d862d969e">FiniteField</a> * </td> + <td class="paramname"><em>ff</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_big_num_str.html">BigNumStr</a> const * </td> + <td class="paramname"><em>t</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="stdtypes_8h.html#ad5c9d4ba3dc37783a528b0925dc981a0">bool</a> </td> + <td class="paramname"><em>neg</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_pairing_state.html">PairingState</a> ** </td> + <td class="paramname"><em>ps</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Constructs a new pairing state. </p> +<p>Allocates memory and creates a new pairing state for Optimal Ate Pairing.</p> +<p>Use <a class="el" href="group___pairing_primitives.html#gad54aebdc331d39b73000fdca9e04f94d" title="Frees a previously allocated by PairingState. ">DeletePairingState()</a> to free memory.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">ga</td><td>The EcGroup from which the first parameter of the pairing is taken. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">gb</td><td>The EcGroup from which the second parameter of the pairing is taken. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">ff</td><td>The result finite field. Must be a Fq12 field. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">t</td><td>A positive integer such that 6(t^2) == q - p, where p and q are parameters of G1. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">neg</td><td>Select the alternate "negate" processing path for Optimal Ate Pairing. </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">ps</td><td>Newly constructed pairing state.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360" title="Return status for SDK functions. ">EpidStatus</a></dd></dl> +<dl class="section attention"><dt>Attention</dt><dd>It is the responsibility of the caller to ensure that ga, gb, and ff exist for the entire lifetime of the new <a class="el" href="struct_pairing_state.html" title="A scratch buffer for stateful pairing calls. ">PairingState</a>.</dd></dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___pairing_primitives.html#gad54aebdc331d39b73000fdca9e04f94d" title="Frees a previously allocated by PairingState. ">DeletePairingState</a> </dd></dl> + +</div> +</div> +<a id="ga58a9d3cb6129274a04c72a35a52f768d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga58a9d3cb6129274a04c72a35a52f768d">◆ </a></span>Pairing()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> Pairing </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_pairing_state.html">PairingState</a> * </td> + <td class="paramname"><em>ps</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group___ec_group_primitives.html#ga85c1d5e106031b385a6e23e598ac98fa">EcPoint</a> const * </td> + <td class="paramname"><em>a</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group___ec_group_primitives.html#ga85c1d5e106031b385a6e23e598ac98fa">EcPoint</a> const * </td> + <td class="paramname"><em>b</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group___finite_field_primitives.html#ga6cff5c7c06b07a87442b810ccc0a86fa">FfElement</a> * </td> + <td class="paramname"><em>d</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Computes an Optimal Ate Pairing for two parameters. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">ps</td><td>The pairing state. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">a</td><td>The first value to pair. Must be in ga used to create ps. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>The second value to pair. Must be in gb used to create ps </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">d</td><td>The result of the pairing. Will be in ff used to create the pairing state.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360" title="Return status for SDK functions. ">EpidStatus</a> </dd></dl> + +</div> +</div> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- HTML footer for doxygen 1.8.10--> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer"> + © 2016-2017 Intel Corporation + </li> + </ul> +</div> +</body> +</html> |