blob: 53c31d28fe3932e242a68f399dff475906331c43 [file] [log] [blame]
<!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.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>AMCL: pbc_support.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>
<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">AMCL
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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&amp;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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">pbc_support.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Auxiliary functions for Pairing-based protocols.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;amcl.h&quot;</code><br />
</div>
<p><a href="pbc__support_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="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a1e05b1cc58149344b3646bfaccd634a6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pbc__support_8h.html#a1e05b1cc58149344b3646bfaccd634a6">TIME_SLOT_MINUTES</a>&#160;&#160;&#160;1440</td></tr>
<tr class="separator:a1e05b1cc58149344b3646bfaccd634a6"><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:abf009dc3e0221e3a0ca8cabdb0426539"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pbc__support_8h.html#abf009dc3e0221e3a0ca8cabdb0426539">mhashit</a> (int sha, int n, <a class="el" href="structoctet.html">octet</a> *x, <a class="el" href="structoctet.html">octet</a> *w)</td></tr>
<tr class="memdesc:abf009dc3e0221e3a0ca8cabdb0426539"><td class="mdescLeft">&#160;</td><td class="mdescRight">general purpose hash function w=hash(n|x) <a href="#abf009dc3e0221e3a0ca8cabdb0426539">More...</a><br /></td></tr>
<tr class="separator:abf009dc3e0221e3a0ca8cabdb0426539"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3ba37964488d50c32164667cade5c47"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arch_8h.html#a59582c63ae040d9b1a47f17b0ac03db0">unsign32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pbc__support_8h.html#ab3ba37964488d50c32164667cade5c47">today</a> (void)</td></tr>
<tr class="memdesc:ab3ba37964488d50c32164667cade5c47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Supply today's date as days from the epoch. <a href="#ab3ba37964488d50c32164667cade5c47">More...</a><br /></td></tr>
<tr class="separator:ab3ba37964488d50c32164667cade5c47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac67c0eddbb5645724893a815837c2a4d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pbc__support_8h.html#ac67c0eddbb5645724893a815837c2a4d">HASH_ALL</a> (int h, <a class="el" href="structoctet.html">octet</a> *I, <a class="el" href="structoctet.html">octet</a> *U, <a class="el" href="structoctet.html">octet</a> *CU, <a class="el" href="structoctet.html">octet</a> *Y, <a class="el" href="structoctet.html">octet</a> *V, <a class="el" href="structoctet.html">octet</a> *R, <a class="el" href="structoctet.html">octet</a> *W, <a class="el" href="structoctet.html">octet</a> *H)</td></tr>
<tr class="memdesc:ac67c0eddbb5645724893a815837c2a4d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hash the session transcript. <a href="#ac67c0eddbb5645724893a815837c2a4d">More...</a><br /></td></tr>
<tr class="separator:ac67c0eddbb5645724893a815837c2a4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a6352129931893109bf7693f7cf1077"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pbc__support_8h.html#a0a6352129931893109bf7693f7cf1077">HASH_ID</a> (int h, <a class="el" href="structoctet.html">octet</a> *ID, <a class="el" href="structoctet.html">octet</a> *HID)</td></tr>
<tr class="memdesc:a0a6352129931893109bf7693f7cf1077"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hash an M-Pin Identity to an octet string. <a href="#a0a6352129931893109bf7693f7cf1077">More...</a><br /></td></tr>
<tr class="separator:a0a6352129931893109bf7693f7cf1077"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0370d54d65ca8da3d4748f49613edcf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arch_8h.html#a59582c63ae040d9b1a47f17b0ac03db0">unsign32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pbc__support_8h.html#ad0370d54d65ca8da3d4748f49613edcf">GET_TIME</a> (void)</td></tr>
<tr class="memdesc:ad0370d54d65ca8da3d4748f49613edcf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get epoch time as unsigned integer. <a href="#ad0370d54d65ca8da3d4748f49613edcf">More...</a><br /></td></tr>
<tr class="separator:ad0370d54d65ca8da3d4748f49613edcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36f18731b0822fcc66120f5d64ece6c1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pbc__support_8h.html#a36f18731b0822fcc66120f5d64ece6c1">AES_GCM_ENCRYPT</a> (<a class="el" href="structoctet.html">octet</a> *K, <a class="el" href="structoctet.html">octet</a> *IV, <a class="el" href="structoctet.html">octet</a> *H, <a class="el" href="structoctet.html">octet</a> *P, <a class="el" href="structoctet.html">octet</a> *C, <a class="el" href="structoctet.html">octet</a> *T)</td></tr>
<tr class="memdesc:a36f18731b0822fcc66120f5d64ece6c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">AES-GCM Encryption. <a href="#a36f18731b0822fcc66120f5d64ece6c1">More...</a><br /></td></tr>
<tr class="separator:a36f18731b0822fcc66120f5d64ece6c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4aa0f36fb96432ff2ed3a0055dc6c0c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pbc__support_8h.html#ae4aa0f36fb96432ff2ed3a0055dc6c0c">AES_GCM_DECRYPT</a> (<a class="el" href="structoctet.html">octet</a> *K, <a class="el" href="structoctet.html">octet</a> *IV, <a class="el" href="structoctet.html">octet</a> *H, <a class="el" href="structoctet.html">octet</a> *C, <a class="el" href="structoctet.html">octet</a> *P, <a class="el" href="structoctet.html">octet</a> *T)</td></tr>
<tr class="memdesc:ae4aa0f36fb96432ff2ed3a0055dc6c0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">AES-GCM Decryption. <a href="#ae4aa0f36fb96432ff2ed3a0055dc6c0c">More...</a><br /></td></tr>
<tr class="separator:ae4aa0f36fb96432ff2ed3a0055dc6c0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section author"><dt>Author</dt><dd>Mike Scott </dd></dl>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a1e05b1cc58149344b3646bfaccd634a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e05b1cc58149344b3646bfaccd634a6">&#9670;&nbsp;</a></span>TIME_SLOT_MINUTES</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TIME_SLOT_MINUTES&#160;&#160;&#160;1440</td>
</tr>
</table>
</div><div class="memdoc">
<p>Time Slot = 1 day </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ae4aa0f36fb96432ff2ed3a0055dc6c0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4aa0f36fb96432ff2ed3a0055dc6c0c">&#9670;&nbsp;</a></span>AES_GCM_DECRYPT()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AES_GCM_DECRYPT </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>K</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>IV</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>H</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>C</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>P</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>T</em>&#160;</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">K</td><td>AES key </td></tr>
<tr><td class="paramname">IV</td><td>Initialization vector </td></tr>
<tr><td class="paramname">H</td><td>Header </td></tr>
<tr><td class="paramname">P</td><td>Plaintext </td></tr>
<tr><td class="paramname">C</td><td>Ciphertext </td></tr>
<tr><td class="paramname">T</td><td>Checksum </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a36f18731b0822fcc66120f5d64ece6c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36f18731b0822fcc66120f5d64ece6c1">&#9670;&nbsp;</a></span>AES_GCM_ENCRYPT()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AES_GCM_ENCRYPT </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>K</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>IV</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>H</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>P</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>C</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>T</em>&#160;</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">K</td><td>AES key </td></tr>
<tr><td class="paramname">IV</td><td>Initialization vector </td></tr>
<tr><td class="paramname">H</td><td>Header </td></tr>
<tr><td class="paramname">P</td><td>Plaintext </td></tr>
<tr><td class="paramname">C</td><td>Ciphertext </td></tr>
<tr><td class="paramname">T</td><td>Checksum </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad0370d54d65ca8da3d4748f49613edcf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0370d54d65ca8da3d4748f49613edcf">&#9670;&nbsp;</a></span>GET_TIME()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="arch_8h.html#a59582c63ae040d9b1a47f17b0ac03db0">unsign32</a> GET_TIME </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>current epoch time in seconds </dd></dl>
</div>
</div>
<a id="ac67c0eddbb5645724893a815837c2a4d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac67c0eddbb5645724893a815837c2a4d">&#9670;&nbsp;</a></span>HASH_ALL()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HASH_ALL </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>h</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>I</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>U</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>CU</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>Y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>V</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>R</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>W</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>H</em>&#160;</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">h</td><td>is the hash type </td></tr>
<tr><td class="paramname">I</td><td>is the hashed input client ID = H(ID) </td></tr>
<tr><td class="paramname">U</td><td>is the client output = x.H(ID) </td></tr>
<tr><td class="paramname">CU</td><td>is the client output = x.(H(ID)+H(T|H(ID))) </td></tr>
<tr><td class="paramname">Y</td><td>is the server challenge </td></tr>
<tr><td class="paramname">V</td><td>is the client part response </td></tr>
<tr><td class="paramname">R</td><td>is the client part response </td></tr>
<tr><td class="paramname">W</td><td>is the server part response </td></tr>
<tr><td class="paramname">H</td><td>the output is the hash of all of the above that apply </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0a6352129931893109bf7693f7cf1077"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a6352129931893109bf7693f7cf1077">&#9670;&nbsp;</a></span>HASH_ID()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HASH_ID </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>h</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>ID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>HID</em>&#160;</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">h</td><td>is the hash type </td></tr>
<tr><td class="paramname">ID</td><td>an octet containing the identity </td></tr>
<tr><td class="paramname">HID</td><td>an octet containing the hashed identity </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="abf009dc3e0221e3a0ca8cabdb0426539"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf009dc3e0221e3a0ca8cabdb0426539">&#9670;&nbsp;</a></span>mhashit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mhashit </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>sha</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>w</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">@param sha is the hash type
@param n integer involved in the hash
@param x octect involved in the h ash
@param w output
</pre>
</div>
</div>
<a id="ab3ba37964488d50c32164667cade5c47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3ba37964488d50c32164667cade5c47">&#9670;&nbsp;</a></span>today()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="arch_8h.html#a59582c63ae040d9b1a47f17b0ac03db0">unsign32</a> today </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>today's date, as number of days elapsed since the epoch </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>