• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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&reg; Enhanced Privacy ID SDK: Intel(R) EPID 1.1 specific 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&amp;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&reg; Enhanced Privacy ID SDK</a>
35&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
57$(document).ready(function(){initNavTree('group___epid11_pairing_primitives.html','');});
58/* @license-end */
59</script>
60<div id="doc-content">
61<div class="header">
62  <div class="summary">
63<a href="#typedef-members">Typedefs</a> &#124;
64<a href="#func-members">Functions</a>  </div>
65  <div class="headertitle">
66<div class="title">Intel(R) EPID 1.1 specific pairing<div class="ingroups"><a class="el" href="group___epid_module.html">epid&amp;nbsp;</a> &raquo; <a class="el" href="group___epid_common.html">common</a> &raquo; <a class="el" href="group___epid_math.html">math</a> &raquo; <a class="el" href="group___pairing_primitives.html">pairing</a></div></div>  </div>
67</div><!--header-->
68<div class="contents">
69
70<p>Intel(R) EPID 1.1 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="typedef-members"></a>
74Typedefs</h2></td></tr>
75<tr class="memitem:ga74236e8ebbfc30a7daa7fa1cf1df148b"><td class="memItemLeft" align="right" valign="top"><a id="ga74236e8ebbfc30a7daa7fa1cf1df148b"></a>
76typedef struct <a class="el" href="group___epid11_pairing_primitives.html#ga74236e8ebbfc30a7daa7fa1cf1df148b">Epid11PairingState</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___epid11_pairing_primitives.html#ga74236e8ebbfc30a7daa7fa1cf1df148b">Epid11PairingState</a></td></tr>
77<tr class="memdesc:ga74236e8ebbfc30a7daa7fa1cf1df148b"><td class="mdescLeft">&#160;</td><td class="mdescRight">A pairing. <br /></td></tr>
78<tr class="separator:ga74236e8ebbfc30a7daa7fa1cf1df148b"><td class="memSeparator" colspan="2">&#160;</td></tr>
79</table><table class="memberdecls">
80<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
81Functions</h2></td></tr>
82<tr class="memitem:ga0ee658e26e9f933ba2ffbf2504dfae7e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___epid11_pairing_primitives.html#ga0ee658e26e9f933ba2ffbf2504dfae7e">NewEpid11PairingState</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> const *ff, <a class="el" href="group___epid11_pairing_primitives.html#ga74236e8ebbfc30a7daa7fa1cf1df148b">Epid11PairingState</a> **ps)</td></tr>
83<tr class="memdesc:ga0ee658e26e9f933ba2ffbf2504dfae7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new Tate pairing state.  <a href="#ga0ee658e26e9f933ba2ffbf2504dfae7e">More...</a><br /></td></tr>
84<tr class="separator:ga0ee658e26e9f933ba2ffbf2504dfae7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
85<tr class="memitem:gaa3457d6f85889bc714910252fd21c758"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___epid11_pairing_primitives.html#gaa3457d6f85889bc714910252fd21c758">DeleteEpid11PairingState</a> (<a class="el" href="group___epid11_pairing_primitives.html#ga74236e8ebbfc30a7daa7fa1cf1df148b">Epid11PairingState</a> **ps)</td></tr>
86<tr class="memdesc:gaa3457d6f85889bc714910252fd21c758"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frees a previously allocated by Epid11PairingState.  <a href="#gaa3457d6f85889bc714910252fd21c758">More...</a><br /></td></tr>
87<tr class="separator:gaa3457d6f85889bc714910252fd21c758"><td class="memSeparator" colspan="2">&#160;</td></tr>
88<tr class="memitem:gaa4076dfe25e8e61ac6753333a322c059"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___epid11_pairing_primitives.html#gaa4076dfe25e8e61ac6753333a322c059">Epid11Pairing</a> (<a class="el" href="group___epid11_pairing_primitives.html#ga74236e8ebbfc30a7daa7fa1cf1df148b">Epid11PairingState</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>
89<tr class="memdesc:gaa4076dfe25e8e61ac6753333a322c059"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes a Tate Pairing for two parameters.  <a href="#gaa4076dfe25e8e61ac6753333a322c059">More...</a><br /></td></tr>
90<tr class="separator:gaa4076dfe25e8e61ac6753333a322c059"><td class="memSeparator" colspan="2">&#160;</td></tr>
91</table>
92<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
93<p>Intel(R) EPID 1.1 pairing operations. </p>
94<p>Provides APIs for defining and using a pairing relationship between two Elliptic curve groups.</p>
95<p>These pairing operations are intended to support Intel(R) EPID 1.1 verification.</p>
96<dl class="section see"><dt>See also</dt><dd><a href="group___epid11_verifier_module.html#details"><b>Intel(R) EPID 1.1 support</b></a> </dd></dl>
97<h2 class="groupheader">Function Documentation</h2>
98<a id="gaa3457d6f85889bc714910252fd21c758"></a>
99<h2 class="memtitle"><span class="permalink"><a href="#gaa3457d6f85889bc714910252fd21c758">&#9670;&nbsp;</a></span>DeleteEpid11PairingState()</h2>
100
101<div class="memitem">
102<div class="memproto">
103      <table class="memname">
104        <tr>
105          <td class="memname">void DeleteEpid11PairingState </td>
106          <td>(</td>
107          <td class="paramtype"><a class="el" href="group___epid11_pairing_primitives.html#ga74236e8ebbfc30a7daa7fa1cf1df148b">Epid11PairingState</a> **&#160;</td>
108          <td class="paramname"><em>ps</em></td><td>)</td>
109          <td></td>
110        </tr>
111      </table>
112</div><div class="memdoc">
113
114<p>Frees a previously allocated by Epid11PairingState. </p>
115<p>Frees memory pointed to by pairing state. Nulls the pointer.</p>
116<p>This pairing operation is intended to support Intel(R) EPID 1.1 verification.</p>
117<dl class="params"><dt>Parameters</dt><dd>
118  <table class="params">
119    <tr><td class="paramdir">[in]</td><td class="paramname">ps</td><td>The pairing state. Can be NULL.</td></tr>
120  </table>
121  </dd>
122</dl>
123<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___epid11_pairing_primitives.html#ga0ee658e26e9f933ba2ffbf2504dfae7e" title="Constructs a new Tate pairing state. ">NewEpid11PairingState</a> </dd>
124<dd>
125<a href="group___epid11_verifier_module.html#details"><b>Intel(R) EPID 1.1 support</b></a> </dd></dl>
126
127</div>
128</div>
129<a id="gaa4076dfe25e8e61ac6753333a322c059"></a>
130<h2 class="memtitle"><span class="permalink"><a href="#gaa4076dfe25e8e61ac6753333a322c059">&#9670;&nbsp;</a></span>Epid11Pairing()</h2>
131
132<div class="memitem">
133<div class="memproto">
134      <table class="memname">
135        <tr>
136          <td class="memname"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> Epid11Pairing </td>
137          <td>(</td>
138          <td class="paramtype"><a class="el" href="group___epid11_pairing_primitives.html#ga74236e8ebbfc30a7daa7fa1cf1df148b">Epid11PairingState</a> *&#160;</td>
139          <td class="paramname"><em>ps</em>, </td>
140        </tr>
141        <tr>
142          <td class="paramkey"></td>
143          <td></td>
144          <td class="paramtype"><a class="el" href="group___ec_group_primitives.html#ga85c1d5e106031b385a6e23e598ac98fa">EcPoint</a> const *&#160;</td>
145          <td class="paramname"><em>a</em>, </td>
146        </tr>
147        <tr>
148          <td class="paramkey"></td>
149          <td></td>
150          <td class="paramtype"><a class="el" href="group___ec_group_primitives.html#ga85c1d5e106031b385a6e23e598ac98fa">EcPoint</a> const *&#160;</td>
151          <td class="paramname"><em>b</em>, </td>
152        </tr>
153        <tr>
154          <td class="paramkey"></td>
155          <td></td>
156          <td class="paramtype"><a class="el" href="group___finite_field_primitives.html#ga6cff5c7c06b07a87442b810ccc0a86fa">FfElement</a> *&#160;</td>
157          <td class="paramname"><em>d</em>&#160;</td>
158        </tr>
159        <tr>
160          <td></td>
161          <td>)</td>
162          <td></td><td></td>
163        </tr>
164      </table>
165</div><div class="memdoc">
166
167<p>Computes a Tate Pairing for two parameters. </p>
168<p>This pairing operation is intended to support Intel(R) EPID 1.1 verification. It frees memory pointed to by an Intel(R) EPID 1.1 pairing state.</p>
169<dl class="params"><dt>Parameters</dt><dd>
170  <table class="params">
171    <tr><td class="paramdir">[in]</td><td class="paramname">ps</td><td>The pairing state. </td></tr>
172    <tr><td class="paramdir">[in]</td><td class="paramname">a</td><td>The first value to pair. Must be in ga. </td></tr>
173    <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>The second value to pair. Must be in gb. </td></tr>
174    <tr><td class="paramdir">[out]</td><td class="paramname">d</td><td>The result of the pairing. Must be in ff.</td></tr>
175  </table>
176  </dd>
177</dl>
178<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>
179<dl class="section see"><dt>See also</dt><dd><a href="group___epid11_verifier_module.html#details"><b>Intel(R) EPID 1.1 support</b></a> </dd></dl>
180
181</div>
182</div>
183<a id="ga0ee658e26e9f933ba2ffbf2504dfae7e"></a>
184<h2 class="memtitle"><span class="permalink"><a href="#ga0ee658e26e9f933ba2ffbf2504dfae7e">&#9670;&nbsp;</a></span>NewEpid11PairingState()</h2>
185
186<div class="memitem">
187<div class="memproto">
188      <table class="memname">
189        <tr>
190          <td class="memname"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> NewEpid11PairingState </td>
191          <td>(</td>
192          <td class="paramtype"><a class="el" href="group___ec_group_primitives.html#gac91c5a7623c17a868dd15b2e9aaf7159">EcGroup</a> const *&#160;</td>
193          <td class="paramname"><em>ga</em>, </td>
194        </tr>
195        <tr>
196          <td class="paramkey"></td>
197          <td></td>
198          <td class="paramtype"><a class="el" href="group___ec_group_primitives.html#gac91c5a7623c17a868dd15b2e9aaf7159">EcGroup</a> const *&#160;</td>
199          <td class="paramname"><em>gb</em>, </td>
200        </tr>
201        <tr>
202          <td class="paramkey"></td>
203          <td></td>
204          <td class="paramtype"><a class="el" href="group___finite_field_primitives.html#gab281b24e336a8b3d7d90079d862d969e">FiniteField</a> const *&#160;</td>
205          <td class="paramname"><em>ff</em>, </td>
206        </tr>
207        <tr>
208          <td class="paramkey"></td>
209          <td></td>
210          <td class="paramtype"><a class="el" href="group___epid11_pairing_primitives.html#ga74236e8ebbfc30a7daa7fa1cf1df148b">Epid11PairingState</a> **&#160;</td>
211          <td class="paramname"><em>ps</em>&#160;</td>
212        </tr>
213        <tr>
214          <td></td>
215          <td>)</td>
216          <td></td><td></td>
217        </tr>
218      </table>
219</div><div class="memdoc">
220
221<p>Constructs a new Tate pairing state. </p>
222<p>Allocates memory and creates a new pairing state for Tate pairing.</p>
223<p>Use <a class="el" href="group___epid11_pairing_primitives.html#gaa3457d6f85889bc714910252fd21c758" title="Frees a previously allocated by Epid11PairingState. ">DeleteEpid11PairingState()</a> to free memory.</p>
224<p>This pairing operation is intended to support Intel(R) EPID 1.1 verification.</p>
225<dl class="params"><dt>Parameters</dt><dd>
226  <table class="params">
227    <tr><td class="paramdir">[in]</td><td class="paramname">ga</td><td>The EcGroup from which the first parameter of the pairing will be taken. </td></tr>
228    <tr><td class="paramdir">[in]</td><td class="paramname">gb</td><td>The EcGroup from which the second parameter of the pairing will be taken. </td></tr>
229    <tr><td class="paramdir">[in]</td><td class="paramname">ff</td><td>The result finite field. Must be a Fq12 field. </td></tr>
230    <tr><td class="paramdir">[out]</td><td class="paramname">ps</td><td>Newly constructed pairing state.</td></tr>
231  </table>
232  </dd>
233</dl>
234<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>
235<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 Epid11PairingState.</dd></dl>
236<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___epid11_pairing_primitives.html#gaa3457d6f85889bc714910252fd21c758" title="Frees a previously allocated by Epid11PairingState. ">DeleteEpid11PairingState</a> </dd>
237<dd>
238<a href="group___epid11_verifier_module.html#details"><b>Intel(R) EPID 1.1 support</b></a> </dd></dl>
239
240</div>
241</div>
242</div><!-- contents -->
243</div><!-- doc-content -->
244<!-- HTML footer for doxygen 1.8.10-->
245<!-- start footer part -->
246<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
247  <ul>
248    <li class="footer">
249      &copy; 2016-2017 Intel Corporation
250    </li>
251  </ul>
252</div>
253</body>
254</html>
255