blob: bc72a8a249a6aa548c3bf3a8a6434e80d91969d6 [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: x509.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>
<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="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">x509.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>X509 function Header File.
<a href="#details">More...</a></p>
<p><a href="x509_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="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpktype.html">pktype</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Public key type. <a href="structpktype.html#details">More...</a><br /></td></tr>
<tr class="separator:"><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:ae0f8e162ae838f0f3d675d81dafd10ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpktype.html">pktype</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="x509_8h.html#ae0f8e162ae838f0f3d675d81dafd10ac">X509_extract_cert_sig</a> (<a class="el" href="structoctet.html">octet</a> *c, <a class="el" href="structoctet.html">octet</a> *s)</td></tr>
<tr class="memdesc:ae0f8e162ae838f0f3d675d81dafd10ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extract certificate signature. <a href="#ae0f8e162ae838f0f3d675d81dafd10ac">More...</a><br /></td></tr>
<tr class="separator:ae0f8e162ae838f0f3d675d81dafd10ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8fd7a9bc77a561d693b8afcc5bb91bf7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="x509_8h.html#a8fd7a9bc77a561d693b8afcc5bb91bf7">X509_extract_cert</a> (<a class="el" href="structoctet.html">octet</a> *sc, <a class="el" href="structoctet.html">octet</a> *c)</td></tr>
<tr class="separator:a8fd7a9bc77a561d693b8afcc5bb91bf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aade69b25d9239a69124a4344a6acba1b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpktype.html">pktype</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="x509_8h.html#aade69b25d9239a69124a4344a6acba1b">X509_extract_public_key</a> (<a class="el" href="structoctet.html">octet</a> *c, <a class="el" href="structoctet.html">octet</a> *k)</td></tr>
<tr class="separator:aade69b25d9239a69124a4344a6acba1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a953eaefd9f39994de4cd118ddae12f4e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="x509_8h.html#a953eaefd9f39994de4cd118ddae12f4e">X509_find_issuer</a> (<a class="el" href="structoctet.html">octet</a> *c)</td></tr>
<tr class="separator:a953eaefd9f39994de4cd118ddae12f4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ee2b5a0783b98ab653dbde63ec04813"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="x509_8h.html#a3ee2b5a0783b98ab653dbde63ec04813">X509_find_validity</a> (<a class="el" href="structoctet.html">octet</a> *c)</td></tr>
<tr class="separator:a3ee2b5a0783b98ab653dbde63ec04813"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16ce3e4274aceac0b08d92dbe99ae776"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="x509_8h.html#a16ce3e4274aceac0b08d92dbe99ae776">X509_find_subject</a> (<a class="el" href="structoctet.html">octet</a> *c)</td></tr>
<tr class="separator:a16ce3e4274aceac0b08d92dbe99ae776"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62f9d5cc04dcef705b11f0c122c4d7d2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="x509_8h.html#a62f9d5cc04dcef705b11f0c122c4d7d2">X509_find_entity_property</a> (<a class="el" href="structoctet.html">octet</a> *c, <a class="el" href="structoctet.html">octet</a> *S, int s, int *f)</td></tr>
<tr class="separator:a62f9d5cc04dcef705b11f0c122c4d7d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d9667214b4268ef0a3f7497932efec7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="x509_8h.html#a7d9667214b4268ef0a3f7497932efec7">X509_find_start_date</a> (<a class="el" href="structoctet.html">octet</a> *c, int s)</td></tr>
<tr class="separator:a7d9667214b4268ef0a3f7497932efec7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc9869d135b533b823627775b1a03686"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="x509_8h.html#adc9869d135b533b823627775b1a03686">X509_find_expiry_date</a> (<a class="el" href="structoctet.html">octet</a> *c, int s)</td></tr>
<tr class="separator:adc9869d135b533b823627775b1a03686"><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">Function Documentation</h2>
<a id="a8fd7a9bc77a561d693b8afcc5bb91bf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fd7a9bc77a561d693b8afcc5bb91bf7">&#9670;&nbsp;</a></span>X509_extract_cert()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int X509_extract_cert </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>sc</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>&#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">sc</td><td>a signed certificate </td></tr>
<tr><td class="paramname">c</td><td>the extracted certificate </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on failure </dd></dl>
</div>
</div>
<a id="ae0f8e162ae838f0f3d675d81dafd10ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0f8e162ae838f0f3d675d81dafd10ac">&#9670;&nbsp;</a></span>X509_extract_cert_sig()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpktype.html">pktype</a> X509_extract_cert_sig </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>s</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">c</td><td>an X.509 certificate </td></tr>
<tr><td class="paramname">s</td><td>the extracted signature </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on failure, or indicator of signature type (ECC or RSA) </dd></dl>
</div>
</div>
<a id="aade69b25d9239a69124a4344a6acba1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aade69b25d9239a69124a4344a6acba1b">&#9670;&nbsp;</a></span>X509_extract_public_key()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpktype.html">pktype</a> X509_extract_public_key </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>k</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">c</td><td>an X.509 certificate </td></tr>
<tr><td class="paramname">k</td><td>the extracted key </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on failure, or indicator of public key type (ECC or RSA) </dd></dl>
</div>
</div>
<a id="a62f9d5cc04dcef705b11f0c122c4d7d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62f9d5cc04dcef705b11f0c122c4d7d2">&#9670;&nbsp;</a></span>X509_find_entity_property()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int X509_find_entity_property </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>S</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int *&#160;</td>
<td class="paramname"><em>f</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">c</td><td>an X.509 certificate </td></tr>
<tr><td class="paramname">S</td><td>is OID of property we are looking for </td></tr>
<tr><td class="paramname">s</td><td>is a pointer to the section of interest in the cert </td></tr>
<tr><td class="paramname">f</td><td>is pointer to the length of the property </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on failure, or pointer to the property </dd></dl>
</div>
</div>
<a id="adc9869d135b533b823627775b1a03686"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc9869d135b533b823627775b1a03686">&#9670;&nbsp;</a></span>X509_find_expiry_date()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int X509_find_expiry_date </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">int&#160;</td>
<td class="paramname"><em>s</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">c</td><td>an X.509 certificate </td></tr>
<tr><td class="paramname">s</td><td>is a pointer to the start of the validity field </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on failure, or pointer to the expiry date </dd></dl>
</div>
</div>
<a id="a953eaefd9f39994de4cd118ddae12f4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a953eaefd9f39994de4cd118ddae12f4e">&#9670;&nbsp;</a></span>X509_find_issuer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int X509_find_issuer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>c</em></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">c</td><td>an X.509 certificate </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on failure, or pointer to issuer field in cert </dd></dl>
</div>
</div>
<a id="a7d9667214b4268ef0a3f7497932efec7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d9667214b4268ef0a3f7497932efec7">&#9670;&nbsp;</a></span>X509_find_start_date()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int X509_find_start_date </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">int&#160;</td>
<td class="paramname"><em>s</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">c</td><td>an X.509 certificate </td></tr>
<tr><td class="paramname">s</td><td>is a pointer to the start of the validity field </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on failure, or pointer to the start date </dd></dl>
</div>
</div>
<a id="a16ce3e4274aceac0b08d92dbe99ae776"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16ce3e4274aceac0b08d92dbe99ae776">&#9670;&nbsp;</a></span>X509_find_subject()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int X509_find_subject </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>c</em></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">c</td><td>an X.509 certificate </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on failure, or pointer to subject field in cert </dd></dl>
</div>
</div>
<a id="a3ee2b5a0783b98ab653dbde63ec04813"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ee2b5a0783b98ab653dbde63ec04813">&#9670;&nbsp;</a></span>X509_find_validity()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int X509_find_validity </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>c</em></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">c</td><td>an X.509 certificate </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on failure, or pointer to validity field in cert </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.13
</small></address>
</body>
</html>