Google Git
Sign in
android / platform / external / epid-sdk / HEAD / . / doc / html / group___epid11_pairing_primitives.html
blob: da9e8f8bb30ae16d9d9d49ca4f01306893d3ec1e [file] [log] [blame]
<!-- 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&reg; Enhanced Privacy ID SDK: Intel(R) EPID 1.1 specific 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&amp;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&reg; Enhanced Privacy ID SDK</a>
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group___epid11_pairing_primitives.html','');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<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>
</div><!--header-->
<div class="contents">
<p>Intel(R) EPID 1.1 pairing operations.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga74236e8ebbfc30a7daa7fa1cf1df148b"><td class="memItemLeft" align="right" valign="top"><a id="ga74236e8ebbfc30a7daa7fa1cf1df148b"></a>
typedef 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>
<tr class="memdesc:ga74236e8ebbfc30a7daa7fa1cf1df148b"><td class="mdescLeft">&#160;</td><td class="mdescRight">A pairing. <br /></td></tr>
<tr class="separator:ga74236e8ebbfc30a7daa7fa1cf1df148b"><td class="memSeparator" colspan="2">&#160;</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: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>
<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>
<tr class="separator:ga0ee658e26e9f933ba2ffbf2504dfae7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:gaa3457d6f85889bc714910252fd21c758"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:gaa4076dfe25e8e61ac6753333a322c059"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Intel(R) EPID 1.1 pairing operations. </p>
<p>Provides APIs for defining and using a pairing relationship between two Elliptic curve groups.</p>
<p>These pairing operations are intended to support Intel(R) EPID 1.1 verification.</p>
<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>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaa3457d6f85889bc714910252fd21c758"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa3457d6f85889bc714910252fd21c758">&#9670;&nbsp;</a></span>DeleteEpid11PairingState()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DeleteEpid11PairingState </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___epid11_pairing_primitives.html#ga74236e8ebbfc30a7daa7fa1cf1df148b">Epid11PairingState</a> **&#160;</td>
<td class="paramname"><em>ps</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees a previously allocated by Epid11PairingState. </p>
<p>Frees memory pointed to by pairing state. Nulls the pointer.</p>
<p>This pairing operation is intended to support Intel(R) EPID 1.1 verification.</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___epid11_pairing_primitives.html#ga0ee658e26e9f933ba2ffbf2504dfae7e" title="Constructs a new Tate pairing state. ">NewEpid11PairingState</a> </dd>
<dd>
<a href="group___epid11_verifier_module.html#details"><b>Intel(R) EPID 1.1 support</b></a> </dd></dl>
</div>
</div>
<a id="gaa4076dfe25e8e61ac6753333a322c059"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa4076dfe25e8e61ac6753333a322c059">&#9670;&nbsp;</a></span>Epid11Pairing()</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> Epid11Pairing </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___epid11_pairing_primitives.html#ga74236e8ebbfc30a7daa7fa1cf1df148b">Epid11PairingState</a> *&#160;</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 *&#160;</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 *&#160;</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> *&#160;</td>
<td class="paramname"><em>d</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Computes a Tate Pairing for two parameters. </p>
<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>
<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. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>The second value to pair. Must be in gb. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">d</td><td>The result of the pairing. Must be in ff.</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 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>
</div>
</div>
<a id="ga0ee658e26e9f933ba2ffbf2504dfae7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0ee658e26e9f933ba2ffbf2504dfae7e">&#9670;&nbsp;</a></span>NewEpid11PairingState()</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> NewEpid11PairingState </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___ec_group_primitives.html#gac91c5a7623c17a868dd15b2e9aaf7159">EcGroup</a> const *&#160;</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 *&#160;</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> const *&#160;</td>
<td class="paramname"><em>ff</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___epid11_pairing_primitives.html#ga74236e8ebbfc30a7daa7fa1cf1df148b">Epid11PairingState</a> **&#160;</td>
<td class="paramname"><em>ps</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a new Tate pairing state. </p>
<p>Allocates memory and creates a new pairing state for Tate pairing.</p>
<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>
<p>This pairing operation is intended to support Intel(R) EPID 1.1 verification.</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 will be 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 will be 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">[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 Epid11PairingState.</dd></dl>
<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>
<dd>
<a href="group___epid11_verifier_module.html#details"><b>Intel(R) EPID 1.1 support</b></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">
&copy; 2016-2017 Intel Corporation
</li>
</ul>
</div>
</body>
</html>