1 <!-- HTML header for doxygen 1.8.10--> 2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3 <html xmlns="http://www.w3.org/1999/xhtml"> 4 <head> 5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 6 <meta http-equiv="X-UA-Compatible" content="IE=9"/> 7 <meta name="generator" content="Doxygen 1.8.14"/> 8 <title>Intel® Enhanced Privacy ID SDK: pairing</title> 9 <link href="tabs.css" rel="stylesheet" type="text/css"/> 10 <script type="text/javascript" src="jquery.js"></script> 11 <script type="text/javascript" src="dynsections.js"></script> 12 <link href="navtree.css" rel="stylesheet" type="text/css"/> 13 <script type="text/javascript" src="resize.js"></script> 14 <script type="text/javascript" src="navtreedata.js"></script> 15 <script type="text/javascript" src="navtree.js"></script> 16 <script type="text/javascript"> 17 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 18 $(document).ready(initResizable); 19 /* @license-end */</script> 20 <link href="doxygen.css" rel="stylesheet" type="text/css" /> 21 <link href="epidstyle.css" rel="stylesheet" type="text/css"/> 22 </head> 23 <body> 24 <div id="top"><!-- do not remove this div, it is closed by doxygen! --> 25 <div id="titlearea"> 26 <table cellspacing="0" cellpadding="0"> 27 <tbody> 28 <tr style="height: 56px;"> 29 <td id="projectalign" style="padding-left: 0.5em;"> 30 <div id="projectname"><a 31 onclick="storeLink('index.html')" 32 id="projectlink" 33 class="index.html" 34 href="index.html">Intel® Enhanced Privacy ID SDK</a> 35  <span id="projectnumber">6.0.1</span> 36 </div> 37 </td> 38 </tr> 39 </tbody> 40 </table> 41 </div> 42 <!-- end header part --> 43 <!-- Generated by Doxygen 1.8.14 --> 44 </div><!-- top --> 45 <div id="side-nav" class="ui-resizable side-nav-resizable"> 46 <div id="nav-tree"> 47 <div id="nav-tree-contents"> 48 <div id="nav-sync" class="sync"></div> 49 </div> 50 </div> 51 <div id="splitbar" style="-moz-user-select:none;" 52 class="ui-resizable-handle"> 53 </div> 54 </div> 55 <script type="text/javascript"> 56 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 57 $(document).ready(function(){initNavTree('group___pairing_primitives.html','');}); 58 /* @license-end */ 59 </script> 60 <div id="doc-content"> 61 <div class="header"> 62 <div class="summary"> 63 <a href="#groups">Modules</a> | 64 <a href="#func-members">Functions</a> </div> 65 <div class="headertitle"> 66 <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> 67 </div><!--header--> 68 <div class="contents"> 69 70 <p>Pairing operations. 71 <a href="#details">More...</a></p> 72 <table class="memberdecls"> 73 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a> 74 Modules</h2></td></tr> 75 <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> 76 <tr class="memdesc:group___epid11_pairing_primitives"><td class="mdescLeft"> </td><td class="mdescRight">Intel(R) EPID 1.1 pairing operations. <br /></td></tr> 77 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> 78 </table><table class="memberdecls"> 79 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> 80 Functions</h2></td></tr> 81 <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> 82 <tr class="memdesc:ga29f79a645871830754d396b9b4a2a0cc"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new pairing state. <a href="#ga29f79a645871830754d396b9b4a2a0cc">More...</a><br /></td></tr> 83 <tr class="separator:ga29f79a645871830754d396b9b4a2a0cc"><td class="memSeparator" colspan="2"> </td></tr> 84 <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> 85 <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> 86 <tr class="separator:gad54aebdc331d39b73000fdca9e04f94d"><td class="memSeparator" colspan="2"> </td></tr> 87 <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> 88 <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> 89 <tr class="separator:ga58a9d3cb6129274a04c72a35a52f768d"><td class="memSeparator" colspan="2"> </td></tr> 90 </table> 91 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 92 <p>Pairing operations. </p> 93 <p>Provides APIs for defining and using a pairing relationship between two elliptic curve groups. </p> 94 <h2 class="groupheader">Function Documentation</h2> 95 <a id="gad54aebdc331d39b73000fdca9e04f94d"></a> 96 <h2 class="memtitle"><span class="permalink"><a href="#gad54aebdc331d39b73000fdca9e04f94d">◆ </a></span>DeletePairingState()</h2> 97 98 <div class="memitem"> 99 <div class="memproto"> 100 <table class="memname"> 101 <tr> 102 <td class="memname">void DeletePairingState </td> 103 <td>(</td> 104 <td class="paramtype"><a class="el" href="struct_pairing_state.html">PairingState</a> ** </td> 105 <td class="paramname"><em>ps</em></td><td>)</td> 106 <td></td> 107 </tr> 108 </table> 109 </div><div class="memdoc"> 110 111 <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> 112 <p>Frees memory pointed to by pairing state. Nulls the pointer.</p> 113 <dl class="params"><dt>Parameters</dt><dd> 114 <table class="params"> 115 <tr><td class="paramdir">[in]</td><td class="paramname">ps</td><td>The pairing state. Can be NULL.</td></tr> 116 </table> 117 </dd> 118 </dl> 119 <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> 120 121 </div> 122 </div> 123 <a id="ga29f79a645871830754d396b9b4a2a0cc"></a> 124 <h2 class="memtitle"><span class="permalink"><a href="#ga29f79a645871830754d396b9b4a2a0cc">◆ </a></span>NewPairingState()</h2> 125 126 <div class="memitem"> 127 <div class="memproto"> 128 <table class="memname"> 129 <tr> 130 <td class="memname"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> NewPairingState </td> 131 <td>(</td> 132 <td class="paramtype"><a class="el" href="group___ec_group_primitives.html#gac91c5a7623c17a868dd15b2e9aaf7159">EcGroup</a> const * </td> 133 <td class="paramname"><em>ga</em>, </td> 134 </tr> 135 <tr> 136 <td class="paramkey"></td> 137 <td></td> 138 <td class="paramtype"><a class="el" href="group___ec_group_primitives.html#gac91c5a7623c17a868dd15b2e9aaf7159">EcGroup</a> const * </td> 139 <td class="paramname"><em>gb</em>, </td> 140 </tr> 141 <tr> 142 <td class="paramkey"></td> 143 <td></td> 144 <td class="paramtype"><a class="el" href="group___finite_field_primitives.html#gab281b24e336a8b3d7d90079d862d969e">FiniteField</a> * </td> 145 <td class="paramname"><em>ff</em>, </td> 146 </tr> 147 <tr> 148 <td class="paramkey"></td> 149 <td></td> 150 <td class="paramtype"><a class="el" href="struct_big_num_str.html">BigNumStr</a> const * </td> 151 <td class="paramname"><em>t</em>, </td> 152 </tr> 153 <tr> 154 <td class="paramkey"></td> 155 <td></td> 156 <td class="paramtype"><a class="el" href="stdtypes_8h.html#ad5c9d4ba3dc37783a528b0925dc981a0">bool</a> </td> 157 <td class="paramname"><em>neg</em>, </td> 158 </tr> 159 <tr> 160 <td class="paramkey"></td> 161 <td></td> 162 <td class="paramtype"><a class="el" href="struct_pairing_state.html">PairingState</a> ** </td> 163 <td class="paramname"><em>ps</em> </td> 164 </tr> 165 <tr> 166 <td></td> 167 <td>)</td> 168 <td></td><td></td> 169 </tr> 170 </table> 171 </div><div class="memdoc"> 172 173 <p>Constructs a new pairing state. </p> 174 <p>Allocates memory and creates a new pairing state for Optimal Ate Pairing.</p> 175 <p>Use <a class="el" href="group___pairing_primitives.html#gad54aebdc331d39b73000fdca9e04f94d" title="Frees a previously allocated by PairingState. ">DeletePairingState()</a> to free memory.</p> 176 <dl class="params"><dt>Parameters</dt><dd> 177 <table class="params"> 178 <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> 179 <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> 180 <tr><td class="paramdir">[in]</td><td class="paramname">ff</td><td>The result finite field. Must be a Fq12 field. </td></tr> 181 <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> 182 <tr><td class="paramdir">[in]</td><td class="paramname">neg</td><td>Select the alternate "negate" processing path for Optimal Ate Pairing. </td></tr> 183 <tr><td class="paramdir">[out]</td><td class="paramname">ps</td><td>Newly constructed pairing state.</td></tr> 184 </table> 185 </dd> 186 </dl> 187 <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> 188 <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> 189 <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> 190 191 </div> 192 </div> 193 <a id="ga58a9d3cb6129274a04c72a35a52f768d"></a> 194 <h2 class="memtitle"><span class="permalink"><a href="#ga58a9d3cb6129274a04c72a35a52f768d">◆ </a></span>Pairing()</h2> 195 196 <div class="memitem"> 197 <div class="memproto"> 198 <table class="memname"> 199 <tr> 200 <td class="memname"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> Pairing </td> 201 <td>(</td> 202 <td class="paramtype"><a class="el" href="struct_pairing_state.html">PairingState</a> * </td> 203 <td class="paramname"><em>ps</em>, </td> 204 </tr> 205 <tr> 206 <td class="paramkey"></td> 207 <td></td> 208 <td class="paramtype"><a class="el" href="group___ec_group_primitives.html#ga85c1d5e106031b385a6e23e598ac98fa">EcPoint</a> const * </td> 209 <td class="paramname"><em>a</em>, </td> 210 </tr> 211 <tr> 212 <td class="paramkey"></td> 213 <td></td> 214 <td class="paramtype"><a class="el" href="group___ec_group_primitives.html#ga85c1d5e106031b385a6e23e598ac98fa">EcPoint</a> const * </td> 215 <td class="paramname"><em>b</em>, </td> 216 </tr> 217 <tr> 218 <td class="paramkey"></td> 219 <td></td> 220 <td class="paramtype"><a class="el" href="group___finite_field_primitives.html#ga6cff5c7c06b07a87442b810ccc0a86fa">FfElement</a> * </td> 221 <td class="paramname"><em>d</em> </td> 222 </tr> 223 <tr> 224 <td></td> 225 <td>)</td> 226 <td></td><td></td> 227 </tr> 228 </table> 229 </div><div class="memdoc"> 230 231 <p>Computes an Optimal Ate Pairing for two parameters. </p> 232 <dl class="params"><dt>Parameters</dt><dd> 233 <table class="params"> 234 <tr><td class="paramdir">[in]</td><td class="paramname">ps</td><td>The pairing state. </td></tr> 235 <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> 236 <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> 237 <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> 238 </table> 239 </dd> 240 </dl> 241 <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> 242 243 </div> 244 </div> 245 </div><!-- contents --> 246 </div><!-- doc-content --> 247 <!-- HTML footer for doxygen 1.8.10--> 248 <!-- start footer part --> 249 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> 250 <ul> 251 <li class="footer"> 252 © 2016-2017 Intel Corporation 253 </li> 254 </ul> 255 </div> 256 </body> 257 </html> 258
