diff options
Diffstat (limited to 'doc/doxyout/hx509/html/group__hx509__keyset.html')
| -rw-r--r-- | doc/doxyout/hx509/html/group__hx509__keyset.html | 781 |
1 files changed, 0 insertions, 781 deletions
diff --git a/doc/doxyout/hx509/html/group__hx509__keyset.html b/doc/doxyout/hx509/html/group__hx509__keyset.html deleted file mode 100644 index 3c66b24878e3..000000000000 --- a/doc/doxyout/hx509/html/group__hx509__keyset.html +++ /dev/null @@ -1,781 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> -<title>hx509 certificate store functions</title> -<link href="doxygen.css" rel="stylesheet" type="text/css"> -<link href="tabs.css" rel="stylesheet" type="text/css"> -</head><body> -<p> -<a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a> -</p> -<!-- end of header marker --> -<!-- Generated by Doxygen 1.9.1 --> -<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&dn=gpl-2.0.txt GPL-v2 */ -$(function() { - initMenu('',false,false,'search.php','Search'); -}); -/* @license-end */</script> -<div id="main-nav"></div> -</div><!-- top --> -<div class="header"> - <div class="summary"> -<a href="#func-members">Functions</a> </div> - <div class="headertitle"> -<div class="title">hx509 certificate store functions</div> </div> -</div><!--header--> -<div class="contents"> -<table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> -Functions</h2></td></tr> -<tr class="memitem:ga38cec16ab23ae65a6113f6e323a38032"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__keyset.html#ga38cec16ab23ae65a6113f6e323a38032">hx509_certs_init</a> (hx509_context context, const char *name, int flags, hx509_lock lock, hx509_certs *certs)</td></tr> -<tr class="separator:ga38cec16ab23ae65a6113f6e323a38032"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga1dbde45fbffbaf909cd99b339f8641bd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__keyset.html#ga1dbde45fbffbaf909cd99b339f8641bd">hx509_certs_store</a> (hx509_context context, hx509_certs certs, int flags, hx509_lock lock)</td></tr> -<tr class="separator:ga1dbde45fbffbaf909cd99b339f8641bd"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaa3df96cfe4137beaea7e7b87b95dbe3f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__keyset.html#gaa3df96cfe4137beaea7e7b87b95dbe3f">hx509_certs_free</a> (hx509_certs *certs)</td></tr> -<tr class="separator:gaa3df96cfe4137beaea7e7b87b95dbe3f"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga8734f5269e166329c0b66d546187a4a9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__keyset.html#ga8734f5269e166329c0b66d546187a4a9">hx509_certs_start_seq</a> (hx509_context context, hx509_certs certs, hx509_cursor *cursor)</td></tr> -<tr class="separator:ga8734f5269e166329c0b66d546187a4a9"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga63c38b4729df8a074f191db831ac9db7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__keyset.html#ga63c38b4729df8a074f191db831ac9db7">hx509_certs_next_cert</a> (hx509_context context, hx509_certs certs, hx509_cursor cursor, hx509_cert *cert)</td></tr> -<tr class="separator:ga63c38b4729df8a074f191db831ac9db7"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga9f05c59f97dcfade924a72fe82cf9a16"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__keyset.html#ga9f05c59f97dcfade924a72fe82cf9a16">hx509_certs_end_seq</a> (hx509_context context, hx509_certs certs, hx509_cursor cursor)</td></tr> -<tr class="separator:ga9f05c59f97dcfade924a72fe82cf9a16"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga4ba1d8deb9545c59b8f6bde86585014b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__keyset.html#ga4ba1d8deb9545c59b8f6bde86585014b">hx509_certs_iter_f</a> (hx509_context context, hx509_certs certs, int(*func)(hx509_context, void *, hx509_cert), void *ctx)</td></tr> -<tr class="separator:ga4ba1d8deb9545c59b8f6bde86585014b"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaee9789b91e1b425c17ddd6a5c1f2a834"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__keyset.html#gaee9789b91e1b425c17ddd6a5c1f2a834">hx509_ci_print_names</a> (hx509_context context, void *ctx, hx509_cert c)</td></tr> -<tr class="separator:gaee9789b91e1b425c17ddd6a5c1f2a834"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga4ebe1ee219223b590bdf3e58dc2182da"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__keyset.html#ga4ebe1ee219223b590bdf3e58dc2182da">hx509_certs_add</a> (hx509_context context, hx509_certs certs, hx509_cert cert)</td></tr> -<tr class="separator:ga4ebe1ee219223b590bdf3e58dc2182da"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga5f0c737b4dddb2a8c7bbab05b04ceb7a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__keyset.html#ga5f0c737b4dddb2a8c7bbab05b04ceb7a">hx509_certs_find</a> (hx509_context context, hx509_certs certs, const hx509_query *q, hx509_cert *r)</td></tr> -<tr class="separator:ga5f0c737b4dddb2a8c7bbab05b04ceb7a"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga1a7b21b477dc3a43286fd1ff96163609"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__keyset.html#ga1a7b21b477dc3a43286fd1ff96163609">hx509_certs_filter</a> (hx509_context context, hx509_certs certs, const hx509_query *q, hx509_certs *result)</td></tr> -<tr class="separator:ga1a7b21b477dc3a43286fd1ff96163609"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga201bbf3425e451337abb26589202d9fe"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__keyset.html#ga201bbf3425e451337abb26589202d9fe">hx509_certs_merge</a> (hx509_context context, hx509_certs to, hx509_certs from)</td></tr> -<tr class="separator:ga201bbf3425e451337abb26589202d9fe"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga5aa16e2f2d1bd1349e0586fdb53b85e6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__keyset.html#ga5aa16e2f2d1bd1349e0586fdb53b85e6">hx509_certs_append</a> (hx509_context context, hx509_certs to, hx509_lock lock, const char *name)</td></tr> -<tr class="separator:ga5aa16e2f2d1bd1349e0586fdb53b85e6"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga0457faff2ddddfbae50fa62ec1369072"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__keyset.html#ga0457faff2ddddfbae50fa62ec1369072">hx509_get_one_cert</a> (hx509_context context, hx509_certs certs, hx509_cert *c)</td></tr> -<tr class="separator:ga0457faff2ddddfbae50fa62ec1369072"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga82fc84cff0a174d58e763ffe2c2a0aad"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__keyset.html#ga82fc84cff0a174d58e763ffe2c2a0aad">hx509_certs_info</a> (hx509_context context, hx509_certs certs, int(*func)(void *, const char *), void *ctx)</td></tr> -<tr class="separator:ga82fc84cff0a174d58e763ffe2c2a0aad"><td class="memSeparator" colspan="2"> </td></tr> -</table> -<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<p>See the <a class="el" href="page_keyset.html">Certificate store operations</a> for description and examples. </p> -<h2 class="groupheader">Function Documentation</h2> -<a id="ga4ebe1ee219223b590bdf3e58dc2182da"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga4ebe1ee219223b590bdf3e58dc2182da">◆ </a></span>hx509_certs_add()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int hx509_certs_add </td> - <td>(</td> - <td class="paramtype">hx509_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_certs </td> - <td class="paramname"><em>certs</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_cert </td> - <td class="paramname"><em>cert</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Add a certificate to the certificiate store.</p> -<p>The receiving keyset certs will either increase reference counter of the cert or make a deep copy, either way, the caller needs to free the cert itself.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>a hx509 context. </td></tr> - <tr><td class="paramname">certs</td><td>certificate store to add the certificate to. </td></tr> - <tr><td class="paramname">cert</td><td>certificate to add.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns an hx509 error code. </dd></dl> - -</div> -</div> -<a id="ga5aa16e2f2d1bd1349e0586fdb53b85e6"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga5aa16e2f2d1bd1349e0586fdb53b85e6">◆ </a></span>hx509_certs_append()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int hx509_certs_append </td> - <td>(</td> - <td class="paramtype">hx509_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_certs </td> - <td class="paramname"><em>to</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_lock </td> - <td class="paramname"><em>lock</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const char * </td> - <td class="paramname"><em>name</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Same a <a class="el" href="group__hx509__keyset.html#ga201bbf3425e451337abb26589202d9fe">hx509_certs_merge()</a> but use a lock and name to describe the from source.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>a hx509 context. </td></tr> - <tr><td class="paramname">to</td><td>the store to merge into. </td></tr> - <tr><td class="paramname">lock</td><td>a lock that unlocks the certificates store, use NULL to select no password/certifictes/prompt lock (see <a class="el" href="page_lock.html">Locking and unlocking certificates and encrypted data.</a>). </td></tr> - <tr><td class="paramname">name</td><td>name of the source store</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns an hx509 error code. </dd></dl> - -</div> -</div> -<a id="ga9f05c59f97dcfade924a72fe82cf9a16"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga9f05c59f97dcfade924a72fe82cf9a16">◆ </a></span>hx509_certs_end_seq()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int hx509_certs_end_seq </td> - <td>(</td> - <td class="paramtype">hx509_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_certs </td> - <td class="paramname"><em>certs</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_cursor </td> - <td class="paramname"><em>cursor</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>End the iteration over certificates.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>a hx509 context. </td></tr> - <tr><td class="paramname">certs</td><td>certificate store to iterate over. </td></tr> - <tr><td class="paramname">cursor</td><td>cursor that will keep track of progress, freed.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns an hx509 error code. </dd></dl> - -</div> -</div> -<a id="ga1a7b21b477dc3a43286fd1ff96163609"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga1a7b21b477dc3a43286fd1ff96163609">◆ </a></span>hx509_certs_filter()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int hx509_certs_filter </td> - <td>(</td> - <td class="paramtype">hx509_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_certs </td> - <td class="paramname"><em>certs</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const hx509_query * </td> - <td class="paramname"><em>q</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_certs * </td> - <td class="paramname"><em>result</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Filter certificate matching the query.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>a hx509 context. </td></tr> - <tr><td class="paramname">certs</td><td>certificate store to search. </td></tr> - <tr><td class="paramname">q</td><td>query allocated with <a class="el" href="group__hx509__query.html">hx509 query functions</a> functions. </td></tr> - <tr><td class="paramname">result</td><td>the filtered certificate store, caller must free with <a class="el" href="group__hx509__keyset.html#gaa3df96cfe4137beaea7e7b87b95dbe3f">hx509_certs_free()</a>.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns an hx509 error code. </dd></dl> -<p>Return HX509_CERT_NOT_FOUND if no certificate in certs matched the query.</p> - -</div> -</div> -<a id="ga5f0c737b4dddb2a8c7bbab05b04ceb7a"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga5f0c737b4dddb2a8c7bbab05b04ceb7a">◆ </a></span>hx509_certs_find()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int hx509_certs_find </td> - <td>(</td> - <td class="paramtype">hx509_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_certs </td> - <td class="paramname"><em>certs</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const hx509_query * </td> - <td class="paramname"><em>q</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_cert * </td> - <td class="paramname"><em>r</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Find a certificate matching the query.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>a hx509 context. </td></tr> - <tr><td class="paramname">certs</td><td>certificate store to search. </td></tr> - <tr><td class="paramname">q</td><td>query allocated with <a class="el" href="group__hx509__query.html">hx509 query functions</a> functions. </td></tr> - <tr><td class="paramname">r</td><td>return certificate (or NULL on error), should be freed with <a class="el" href="group__hx509__cert.html#gad2f9bb0ddc4babb26a8ccd983db8c948">hx509_cert_free()</a>.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns an hx509 error code. </dd></dl> -<p>Return HX509_CERT_NOT_FOUND if no certificate in certs matched the query.</p> - -</div> -</div> -<a id="gaa3df96cfe4137beaea7e7b87b95dbe3f"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gaa3df96cfe4137beaea7e7b87b95dbe3f">◆ </a></span>hx509_certs_free()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void hx509_certs_free </td> - <td>(</td> - <td class="paramtype">hx509_certs * </td> - <td class="paramname"><em>certs</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Free a certificate store.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">certs</td><td>certificate store to free. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a id="ga82fc84cff0a174d58e763ffe2c2a0aad"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga82fc84cff0a174d58e763ffe2c2a0aad">◆ </a></span>hx509_certs_info()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int hx509_certs_info </td> - <td>(</td> - <td class="paramtype">hx509_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_certs </td> - <td class="paramname"><em>certs</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">int(*)(void *, const char *) </td> - <td class="paramname"><em>func</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">void * </td> - <td class="paramname"><em>ctx</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Print some info about the certificate store.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>a hx509 context. </td></tr> - <tr><td class="paramname">certs</td><td>certificate store to print information about. </td></tr> - <tr><td class="paramname">func</td><td>function that will get each line of the information, if NULL is used the data is printed on a FILE descriptor that should be passed in ctx, if ctx also is NULL, stdout is used. </td></tr> - <tr><td class="paramname">ctx</td><td>parameter to func.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns an hx509 error code. </dd></dl> - -</div> -</div> -<a id="ga38cec16ab23ae65a6113f6e323a38032"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga38cec16ab23ae65a6113f6e323a38032">◆ </a></span>hx509_certs_init()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int hx509_certs_init </td> - <td>(</td> - <td class="paramtype">hx509_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const char * </td> - <td class="paramname"><em>name</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">int </td> - <td class="paramname"><em>flags</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_lock </td> - <td class="paramname"><em>lock</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_certs * </td> - <td class="paramname"><em>certs</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Open or creates a new hx509 certificate store.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>A hx509 context </td></tr> - <tr><td class="paramname">name</td><td>name of the store, format is TYPE:type-specific-string, if NULL is used the MEMORY store is used. </td></tr> - <tr><td class="paramname">flags</td><td>list of flags:<ul> -<li>HX509_CERTS_CREATE create a new keystore of the specific TYPE.</li> -<li>HX509_CERTS_UNPROTECT_ALL fails if any private key failed to be extracted. </li> -</ul> -</td></tr> - <tr><td class="paramname">lock</td><td>a lock that unlocks the certificates store, use NULL to select no password/certifictes/prompt lock (see <a class="el" href="page_lock.html">Locking and unlocking certificates and encrypted data.</a>). </td></tr> - <tr><td class="paramname">certs</td><td>return pointer, free with <a class="el" href="group__hx509__keyset.html#gaa3df96cfe4137beaea7e7b87b95dbe3f">hx509_certs_free()</a>.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns an hx509 error code. </dd></dl> - -</div> -</div> -<a id="ga4ba1d8deb9545c59b8f6bde86585014b"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga4ba1d8deb9545c59b8f6bde86585014b">◆ </a></span>hx509_certs_iter_f()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int hx509_certs_iter_f </td> - <td>(</td> - <td class="paramtype">hx509_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_certs </td> - <td class="paramname"><em>certs</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">int(*)(hx509_context, void *, hx509_cert) </td> - <td class="paramname"><em>func</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">void * </td> - <td class="paramname"><em>ctx</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Iterate over all certificates in a keystore and call a function for each of them.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>a hx509 context. </td></tr> - <tr><td class="paramname">certs</td><td>certificate store to iterate over. </td></tr> - <tr><td class="paramname">func</td><td>function to call for each certificate. The function should return non-zero to abort the iteration, that value is passed back to the caller of <a class="el" href="group__hx509__keyset.html#ga4ba1d8deb9545c59b8f6bde86585014b">hx509_certs_iter_f()</a>. </td></tr> - <tr><td class="paramname">ctx</td><td>context variable that will passed to the function.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns an hx509 error code. </dd></dl> - -</div> -</div> -<a id="ga201bbf3425e451337abb26589202d9fe"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga201bbf3425e451337abb26589202d9fe">◆ </a></span>hx509_certs_merge()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int hx509_certs_merge </td> - <td>(</td> - <td class="paramtype">hx509_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_certs </td> - <td class="paramname"><em>to</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_certs </td> - <td class="paramname"><em>from</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Merge a certificate store into another. The from store is keep intact.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>a hx509 context. </td></tr> - <tr><td class="paramname">to</td><td>the store to merge into. </td></tr> - <tr><td class="paramname">from</td><td>the store to copy the object from.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns an hx509 error code. </dd></dl> - -</div> -</div> -<a id="ga63c38b4729df8a074f191db831ac9db7"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga63c38b4729df8a074f191db831ac9db7">◆ </a></span>hx509_certs_next_cert()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int hx509_certs_next_cert </td> - <td>(</td> - <td class="paramtype">hx509_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_certs </td> - <td class="paramname"><em>certs</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_cursor </td> - <td class="paramname"><em>cursor</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_cert * </td> - <td class="paramname"><em>cert</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Get next ceritificate from the certificate keystore pointed out by cursor.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>a hx509 context. </td></tr> - <tr><td class="paramname">certs</td><td>certificate store to iterate over. </td></tr> - <tr><td class="paramname">cursor</td><td>cursor that keeps track of progress. </td></tr> - <tr><td class="paramname">cert</td><td>return certificate next in store, NULL if the store contains no more certificates. Free with <a class="el" href="group__hx509__cert.html#gad2f9bb0ddc4babb26a8ccd983db8c948">hx509_cert_free()</a>.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns an hx509 error code. </dd></dl> - -</div> -</div> -<a id="ga8734f5269e166329c0b66d546187a4a9"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga8734f5269e166329c0b66d546187a4a9">◆ </a></span>hx509_certs_start_seq()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int hx509_certs_start_seq </td> - <td>(</td> - <td class="paramtype">hx509_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_certs </td> - <td class="paramname"><em>certs</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_cursor * </td> - <td class="paramname"><em>cursor</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Start the integration</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>a hx509 context. </td></tr> - <tr><td class="paramname">certs</td><td>certificate store to iterate over </td></tr> - <tr><td class="paramname">cursor</td><td>cursor that will keep track of progress, free with <a class="el" href="group__hx509__keyset.html#ga9f05c59f97dcfade924a72fe82cf9a16">hx509_certs_end_seq()</a>.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns an hx509 error code. HX509_UNSUPPORTED_OPERATION is returned if the certificate store doesn't support the iteration operation. </dd></dl> - -</div> -</div> -<a id="ga1dbde45fbffbaf909cd99b339f8641bd"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga1dbde45fbffbaf909cd99b339f8641bd">◆ </a></span>hx509_certs_store()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int hx509_certs_store </td> - <td>(</td> - <td class="paramtype">hx509_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_certs </td> - <td class="paramname"><em>certs</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">int </td> - <td class="paramname"><em>flags</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_lock </td> - <td class="paramname"><em>lock</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Write the certificate store to stable storage.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>A hx509 context. </td></tr> - <tr><td class="paramname">certs</td><td>a certificate store to store. </td></tr> - <tr><td class="paramname">flags</td><td>currently unused, use 0. </td></tr> - <tr><td class="paramname">lock</td><td>a lock that unlocks the certificates store, use NULL to select no password/certifictes/prompt lock (see <a class="el" href="page_lock.html">Locking and unlocking certificates and encrypted data.</a>).</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns an hx509 error code. HX509_UNSUPPORTED_OPERATION if the certificate store doesn't support the store operation. </dd></dl> - -</div> -</div> -<a id="gaee9789b91e1b425c17ddd6a5c1f2a834"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gaee9789b91e1b425c17ddd6a5c1f2a834">◆ </a></span>hx509_ci_print_names()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int hx509_ci_print_names </td> - <td>(</td> - <td class="paramtype">hx509_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">void * </td> - <td class="paramname"><em>ctx</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_cert </td> - <td class="paramname"><em>c</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Function to use to <a class="el" href="group__hx509__keyset.html#ga4ba1d8deb9545c59b8f6bde86585014b">hx509_certs_iter_f()</a> as a function argument, the ctx variable to <a class="el" href="group__hx509__keyset.html#ga4ba1d8deb9545c59b8f6bde86585014b">hx509_certs_iter_f()</a> should be a FILE file descriptor.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>a hx509 context. </td></tr> - <tr><td class="paramname">ctx</td><td>used by <a class="el" href="group__hx509__keyset.html#ga4ba1d8deb9545c59b8f6bde86585014b">hx509_certs_iter_f()</a>. </td></tr> - <tr><td class="paramname">c</td><td>a certificate</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns an hx509 error code. </dd></dl> - -</div> -</div> -<a id="ga0457faff2ddddfbae50fa62ec1369072"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga0457faff2ddddfbae50fa62ec1369072">◆ </a></span>hx509_get_one_cert()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int hx509_get_one_cert </td> - <td>(</td> - <td class="paramtype">hx509_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_certs </td> - <td class="paramname"><em>certs</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">hx509_cert * </td> - <td class="paramname"><em>c</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Get one random certificate from the certificate store.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>a hx509 context. </td></tr> - <tr><td class="paramname">certs</td><td>a certificate store to get the certificate from. </td></tr> - <tr><td class="paramname">c</td><td>return certificate, should be freed with <a class="el" href="group__hx509__cert.html#gad2f9bb0ddc4babb26a8ccd983db8c948">hx509_cert_free()</a>.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns an hx509 error code. </dd></dl> - -</div> -</div> -</div><!-- contents --> -<hr size="1"><address style="text-align: right;"><small> -Generated on Tue Nov 15 2022 14:04:25 for Heimdal x509 library by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.9.1</small></address> -</body> -</html> |