blob: 6dc8fa01e614178a79c07aa29b2e88db55613782 [file] [log] [blame]
<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>AMCL: utils.h Source File</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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.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.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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="headertitle">
<div class="title">utils.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="utils_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> distributed with this work for additional information</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> &quot;License&quot;); you may not use this file except in compliance</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> software distributed under the License is distributed on an</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> specific language governing permissions and limitations</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> under the License.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment">/* AMCL Support functions for M-Pin servers */</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#ifndef UTILS_H</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#define UTILS_H</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#include &quot;amcl.h&quot;</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="keywordtype">void</span> <a class="code" href="utils_8h.html#ae83713794e16e5aaca8c26fa3b2a53e0">amcl_hex2bin</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *src, <span class="keywordtype">char</span> *dst, <span class="keywordtype">int</span> src_len);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="keywordtype">void</span> <a class="code" href="utils_8h.html#af3f99e6869645e7a199f5455d1b8b5ff">amcl_bin2hex</a>(<span class="keywordtype">char</span> *src, <span class="keywordtype">char</span> *dst, <span class="keywordtype">int</span> src_len);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="keywordtype">void</span> <a class="code" href="utils_8h.html#a0a2cf72b4b90aacd14063ed1b294658d">amcl_print_hex</a>(<span class="keywordtype">char</span> *src, <span class="keywordtype">int</span> src_len);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="keywordtype">void</span> <a class="code" href="utils_8h.html#aac29f2d3dfb9593dba84f2bfe7051aba">generateRandom</a>(<a class="code" href="structcsprng.html">csprng</a>* RNG, <a class="code" href="structoctet.html">octet</a>* randomValue);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="keywordtype">int</span> <a class="code" href="utils_8h.html#a453d001cb992b62b8cf2620a4a1f4778">generateOTP</a>(<a class="code" href="structcsprng.html">csprng</a>* RNG);</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="structoctet_html"><div class="ttname"><a href="structoctet.html">octet</a></div><div class="ttdoc">Portable representation of a big positive number. </div><div class="ttdef"><b>Definition:</b> amcl.h:209</div></div>
<div class="ttc" id="utils_8h_html_aac29f2d3dfb9593dba84f2bfe7051aba"><div class="ttname"><a href="utils_8h.html#aac29f2d3dfb9593dba84f2bfe7051aba">generateRandom</a></div><div class="ttdeci">void generateRandom(csprng *RNG, octet *randomValue)</div><div class="ttdoc">Generate a random Octet. </div><div class="ttdef"><b>Definition:</b> utils.c:126</div></div>
<div class="ttc" id="utils_8h_html_a453d001cb992b62b8cf2620a4a1f4778"><div class="ttname"><a href="utils_8h.html#a453d001cb992b62b8cf2620a4a1f4778">generateOTP</a></div><div class="ttdeci">int generateOTP(csprng *RNG)</div><div class="ttdoc">Generate a random six digit one time password. </div><div class="ttdef"><b>Definition:</b> utils.c:104</div></div>
<div class="ttc" id="utils_8h_html_af3f99e6869645e7a199f5455d1b8b5ff"><div class="ttname"><a href="utils_8h.html#af3f99e6869645e7a199f5455d1b8b5ff">amcl_bin2hex</a></div><div class="ttdeci">void amcl_bin2hex(char *src, char *dst, int src_len)</div><div class="ttdoc">Encode binary string. </div><div class="ttdef"><b>Definition:</b> utils.c:83</div></div>
<div class="ttc" id="utils_8h_html_a0a2cf72b4b90aacd14063ed1b294658d"><div class="ttname"><a href="utils_8h.html#a0a2cf72b4b90aacd14063ed1b294658d">amcl_print_hex</a></div><div class="ttdeci">void amcl_print_hex(char *src, int src_len)</div><div class="ttdoc">Print encoded binary string in hex. </div><div class="ttdef"><b>Definition:</b> utils.c:93</div></div>
<div class="ttc" id="structcsprng_html"><div class="ttname"><a href="structcsprng.html">csprng</a></div><div class="ttdoc">Cryptographically secure pseudo-random number generator instance. </div><div class="ttdef"><b>Definition:</b> amcl.h:195</div></div>
<div class="ttc" id="utils_8h_html_ae83713794e16e5aaca8c26fa3b2a53e0"><div class="ttname"><a href="utils_8h.html#ae83713794e16e5aaca8c26fa3b2a53e0">amcl_hex2bin</a></div><div class="ttdeci">void amcl_hex2bin(const char *src, char *dst, int src_len)</div><div class="ttdoc">Decode hex value. </div><div class="ttdef"><b>Definition:</b> utils.c:37</div></div>
</div><!-- fragment --></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.13
</small></address>
</body>
</html>