xref: /netbsd-src/crypto/external/bsd/heimdal/dist/doc/doxyout/hx509/html/group__hx509__revoke.html (revision dd75ac5b443e967e26b4d18cc8cd5eb98512bfbf) 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>hx509 revokation checking functions</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<p>
8<a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a>
9</p>
10<!-- end of header marker -->
11<!-- Generated by Doxygen 1.9.1 -->
12<script type="text/javascript" src="menudata.js"></script>
13<script type="text/javascript" src="menu.js"></script>
14<script type="text/javascript">
15/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
16$(function() {
17  initMenu('',false,false,'search.php','Search');
18});
19/* @license-end */</script>
20<div id="main-nav"></div>
21</div><!-- top -->
22<div class="header">
23  <div class="summary">
24<a href="#func-members">Functions</a>  </div>
25  <div class="headertitle">
26<div class="title">hx509 revokation checking functions</div>  </div>
27</div><!--header-->
28<div class="contents">
29<table class="memberdecls">
30<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
31Functions</h2></td></tr>
32<tr class="memitem:ga83057d3c52d4b298b92571d48cf7099e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__revoke.html#ga83057d3c52d4b298b92571d48cf7099e">hx509_revoke_init</a> (hx509_context context, hx509_revoke_ctx *ctx)</td></tr>
33<tr class="separator:ga83057d3c52d4b298b92571d48cf7099e"><td class="memSeparator" colspan="2">&#160;</td></tr>
34<tr class="memitem:gac0928df8a473e5a76fd8a2785d43ea9b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__revoke.html#gac0928df8a473e5a76fd8a2785d43ea9b">hx509_revoke_free</a> (hx509_revoke_ctx *ctx)</td></tr>
35<tr class="separator:gac0928df8a473e5a76fd8a2785d43ea9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
36<tr class="memitem:gabda08999b0473bda2077b54c96be79e9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__revoke.html#gabda08999b0473bda2077b54c96be79e9">hx509_revoke_add_ocsp</a> (hx509_context context, hx509_revoke_ctx ctx, const char *path)</td></tr>
37<tr class="separator:gabda08999b0473bda2077b54c96be79e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
38<tr class="memitem:ga90c30e6adae77012e1360bb502b57c72"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__revoke.html#ga90c30e6adae77012e1360bb502b57c72">hx509_revoke_add_crl</a> (hx509_context context, hx509_revoke_ctx ctx, const char *path)</td></tr>
39<tr class="separator:ga90c30e6adae77012e1360bb502b57c72"><td class="memSeparator" colspan="2">&#160;</td></tr>
40<tr class="memitem:ga3faf6194dc7429f8850e02b3ae2bbeeb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__revoke.html#ga3faf6194dc7429f8850e02b3ae2bbeeb">hx509_revoke_verify</a> (hx509_context context, hx509_revoke_ctx ctx, hx509_certs certs, time_t now, hx509_cert cert, hx509_cert parent_cert)</td></tr>
41<tr class="separator:ga3faf6194dc7429f8850e02b3ae2bbeeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
42<tr class="memitem:gaef3bddfe2f6b619ced673cf9aef07c37"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__revoke.html#gaef3bddfe2f6b619ced673cf9aef07c37">hx509_ocsp_request</a> (hx509_context context, hx509_certs reqcerts, hx509_certs pool, hx509_cert signer, const AlgorithmIdentifier *digest, heim_octet_string *request, heim_octet_string *nonce)</td></tr>
43<tr class="separator:gaef3bddfe2f6b619ced673cf9aef07c37"><td class="memSeparator" colspan="2">&#160;</td></tr>
44<tr class="memitem:gab55b117222f61fd628744f2cd6d5a218"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__revoke.html#gab55b117222f61fd628744f2cd6d5a218">hx509_revoke_ocsp_print</a> (hx509_context context, const char *path, FILE *out)</td></tr>
45<tr class="separator:gab55b117222f61fd628744f2cd6d5a218"><td class="memSeparator" colspan="2">&#160;</td></tr>
46</table>
47<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
48<p>See the <a class="el" href="page_revoke.html">Revocation methods</a> for description and examples. </p>
49<h2 class="groupheader">Function Documentation</h2>
50<a id="gaef3bddfe2f6b619ced673cf9aef07c37"></a>
51<h2 class="memtitle"><span class="permalink"><a href="#gaef3bddfe2f6b619ced673cf9aef07c37">&#9670;&nbsp;</a></span>hx509_ocsp_request()</h2>
52
53<div class="memitem">
54<div class="memproto">
55      <table class="memname">
56        <tr>
57          <td class="memname">int hx509_ocsp_request </td>
58          <td>(</td>
59          <td class="paramtype">hx509_context&#160;</td>
60          <td class="paramname"><em>context</em>, </td>
61        </tr>
62        <tr>
63          <td class="paramkey"></td>
64          <td></td>
65          <td class="paramtype">hx509_certs&#160;</td>
66          <td class="paramname"><em>reqcerts</em>, </td>
67        </tr>
68        <tr>
69          <td class="paramkey"></td>
70          <td></td>
71          <td class="paramtype">hx509_certs&#160;</td>
72          <td class="paramname"><em>pool</em>, </td>
73        </tr>
74        <tr>
75          <td class="paramkey"></td>
76          <td></td>
77          <td class="paramtype">hx509_cert&#160;</td>
78          <td class="paramname"><em>signer</em>, </td>
79        </tr>
80        <tr>
81          <td class="paramkey"></td>
82          <td></td>
83          <td class="paramtype">const AlgorithmIdentifier *&#160;</td>
84          <td class="paramname"><em>digest</em>, </td>
85        </tr>
86        <tr>
87          <td class="paramkey"></td>
88          <td></td>
89          <td class="paramtype">heim_octet_string *&#160;</td>
90          <td class="paramname"><em>request</em>, </td>
91        </tr>
92        <tr>
93          <td class="paramkey"></td>
94          <td></td>
95          <td class="paramtype">heim_octet_string *&#160;</td>
96          <td class="paramname"><em>nonce</em>&#160;</td>
97        </tr>
98        <tr>
99          <td></td>
100          <td>)</td>
101          <td></td><td></td>
102        </tr>
103      </table>
104</div><div class="memdoc">
105<p>Create an OCSP request for a set of certificates.</p>
106<dl class="params"><dt>Parameters</dt><dd>
107  <table class="params">
108    <tr><td class="paramname">context</td><td>a hx509 context </td></tr>
109    <tr><td class="paramname">reqcerts</td><td>list of certificates to request ocsp data for </td></tr>
110    <tr><td class="paramname">pool</td><td>certificate pool to use when signing </td></tr>
111    <tr><td class="paramname">signer</td><td>certificate to use to sign the request </td></tr>
112    <tr><td class="paramname">digest</td><td>the signing algorithm in the request, if NULL use the default signature algorithm, </td></tr>
113    <tr><td class="paramname">request</td><td>the encoded request, free with free_heim_octet_string(). </td></tr>
114    <tr><td class="paramname">nonce</td><td>nonce in the request, free with free_heim_octet_string().</td></tr>
115  </table>
116  </dd>
117</dl>
118<dl class="section return"><dt>Returns</dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#ga15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl>
119
120</div>
121</div>
122<a id="ga90c30e6adae77012e1360bb502b57c72"></a>
123<h2 class="memtitle"><span class="permalink"><a href="#ga90c30e6adae77012e1360bb502b57c72">&#9670;&nbsp;</a></span>hx509_revoke_add_crl()</h2>
124
125<div class="memitem">
126<div class="memproto">
127      <table class="memname">
128        <tr>
129          <td class="memname">int hx509_revoke_add_crl </td>
130          <td>(</td>
131          <td class="paramtype">hx509_context&#160;</td>
132          <td class="paramname"><em>context</em>, </td>
133        </tr>
134        <tr>
135          <td class="paramkey"></td>
136          <td></td>
137          <td class="paramtype">hx509_revoke_ctx&#160;</td>
138          <td class="paramname"><em>ctx</em>, </td>
139        </tr>
140        <tr>
141          <td class="paramkey"></td>
142          <td></td>
143          <td class="paramtype">const char *&#160;</td>
144          <td class="paramname"><em>path</em>&#160;</td>
145        </tr>
146        <tr>
147          <td></td>
148          <td>)</td>
149          <td></td><td></td>
150        </tr>
151      </table>
152</div><div class="memdoc">
153<p>Add a CRL file to the revokation context.</p>
154<dl class="params"><dt>Parameters</dt><dd>
155  <table class="params">
156    <tr><td class="paramname">context</td><td>hx509 context </td></tr>
157    <tr><td class="paramname">ctx</td><td>hx509 revokation context </td></tr>
158    <tr><td class="paramname">path</td><td>path to file that is going to be added to the context.</td></tr>
159  </table>
160  </dd>
161</dl>
162<dl class="section return"><dt>Returns</dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#ga15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl>
163
164</div>
165</div>
166<a id="gabda08999b0473bda2077b54c96be79e9"></a>
167<h2 class="memtitle"><span class="permalink"><a href="#gabda08999b0473bda2077b54c96be79e9">&#9670;&nbsp;</a></span>hx509_revoke_add_ocsp()</h2>
168
169<div class="memitem">
170<div class="memproto">
171      <table class="memname">
172        <tr>
173          <td class="memname">int hx509_revoke_add_ocsp </td>
174          <td>(</td>
175          <td class="paramtype">hx509_context&#160;</td>
176          <td class="paramname"><em>context</em>, </td>
177        </tr>
178        <tr>
179          <td class="paramkey"></td>
180          <td></td>
181          <td class="paramtype">hx509_revoke_ctx&#160;</td>
182          <td class="paramname"><em>ctx</em>, </td>
183        </tr>
184        <tr>
185          <td class="paramkey"></td>
186          <td></td>
187          <td class="paramtype">const char *&#160;</td>
188          <td class="paramname"><em>path</em>&#160;</td>
189        </tr>
190        <tr>
191          <td></td>
192          <td>)</td>
193          <td></td><td></td>
194        </tr>
195      </table>
196</div><div class="memdoc">
197<p>Add a OCSP file to the revokation context.</p>
198<dl class="params"><dt>Parameters</dt><dd>
199  <table class="params">
200    <tr><td class="paramname">context</td><td>hx509 context </td></tr>
201    <tr><td class="paramname">ctx</td><td>hx509 revokation context </td></tr>
202    <tr><td class="paramname">path</td><td>path to file that is going to be added to the context.</td></tr>
203  </table>
204  </dd>
205</dl>
206<dl class="section return"><dt>Returns</dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#ga15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl>
207
208</div>
209</div>
210<a id="gac0928df8a473e5a76fd8a2785d43ea9b"></a>
211<h2 class="memtitle"><span class="permalink"><a href="#gac0928df8a473e5a76fd8a2785d43ea9b">&#9670;&nbsp;</a></span>hx509_revoke_free()</h2>
212
213<div class="memitem">
214<div class="memproto">
215      <table class="memname">
216        <tr>
217          <td class="memname">void hx509_revoke_free </td>
218          <td>(</td>
219          <td class="paramtype">hx509_revoke_ctx *&#160;</td>
220          <td class="paramname"><em>ctx</em></td><td>)</td>
221          <td></td>
222        </tr>
223      </table>
224</div><div class="memdoc">
225<p>Free a hx509 revokation context.</p>
226<dl class="params"><dt>Parameters</dt><dd>
227  <table class="params">
228    <tr><td class="paramname">ctx</td><td>context to be freed </td></tr>
229  </table>
230  </dd>
231</dl>
232
233</div>
234</div>
235<a id="ga83057d3c52d4b298b92571d48cf7099e"></a>
236<h2 class="memtitle"><span class="permalink"><a href="#ga83057d3c52d4b298b92571d48cf7099e">&#9670;&nbsp;</a></span>hx509_revoke_init()</h2>
237
238<div class="memitem">
239<div class="memproto">
240      <table class="memname">
241        <tr>
242          <td class="memname">int hx509_revoke_init </td>
243          <td>(</td>
244          <td class="paramtype">hx509_context&#160;</td>
245          <td class="paramname"><em>context</em>, </td>
246        </tr>
247        <tr>
248          <td class="paramkey"></td>
249          <td></td>
250          <td class="paramtype">hx509_revoke_ctx *&#160;</td>
251          <td class="paramname"><em>ctx</em>&#160;</td>
252        </tr>
253        <tr>
254          <td></td>
255          <td>)</td>
256          <td></td><td></td>
257        </tr>
258      </table>
259</div><div class="memdoc">
260<p>Allocate a revokation context. Free with <a class="el" href="group__hx509__revoke.html#gac0928df8a473e5a76fd8a2785d43ea9b">hx509_revoke_free()</a>.</p>
261<dl class="params"><dt>Parameters</dt><dd>
262  <table class="params">
263    <tr><td class="paramname">context</td><td>A hx509 context. </td></tr>
264    <tr><td class="paramname">ctx</td><td>returns a newly allocated revokation context.</td></tr>
265  </table>
266  </dd>
267</dl>
268<dl class="section return"><dt>Returns</dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#ga15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl>
269
270</div>
271</div>
272<a id="gab55b117222f61fd628744f2cd6d5a218"></a>
273<h2 class="memtitle"><span class="permalink"><a href="#gab55b117222f61fd628744f2cd6d5a218">&#9670;&nbsp;</a></span>hx509_revoke_ocsp_print()</h2>
274
275<div class="memitem">
276<div class="memproto">
277      <table class="memname">
278        <tr>
279          <td class="memname">int hx509_revoke_ocsp_print </td>
280          <td>(</td>
281          <td class="paramtype">hx509_context&#160;</td>
282          <td class="paramname"><em>context</em>, </td>
283        </tr>
284        <tr>
285          <td class="paramkey"></td>
286          <td></td>
287          <td class="paramtype">const char *&#160;</td>
288          <td class="paramname"><em>path</em>, </td>
289        </tr>
290        <tr>
291          <td class="paramkey"></td>
292          <td></td>
293          <td class="paramtype">FILE *&#160;</td>
294          <td class="paramname"><em>out</em>&#160;</td>
295        </tr>
296        <tr>
297          <td></td>
298          <td>)</td>
299          <td></td><td></td>
300        </tr>
301      </table>
302</div><div class="memdoc">
303<p>Print the OCSP reply stored in a file.</p>
304<dl class="params"><dt>Parameters</dt><dd>
305  <table class="params">
306    <tr><td class="paramname">context</td><td>a hx509 context </td></tr>
307    <tr><td class="paramname">path</td><td>path to a file with a OCSP reply </td></tr>
308    <tr><td class="paramname">out</td><td>the out FILE descriptor to print the reply on</td></tr>
309  </table>
310  </dd>
311</dl>
312<dl class="section return"><dt>Returns</dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#ga15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl>
313
314</div>
315</div>
316<a id="ga3faf6194dc7429f8850e02b3ae2bbeeb"></a>
317<h2 class="memtitle"><span class="permalink"><a href="#ga3faf6194dc7429f8850e02b3ae2bbeeb">&#9670;&nbsp;</a></span>hx509_revoke_verify()</h2>
318
319<div class="memitem">
320<div class="memproto">
321      <table class="memname">
322        <tr>
323          <td class="memname">int hx509_revoke_verify </td>
324          <td>(</td>
325          <td class="paramtype">hx509_context&#160;</td>
326          <td class="paramname"><em>context</em>, </td>
327        </tr>
328        <tr>
329          <td class="paramkey"></td>
330          <td></td>
331          <td class="paramtype">hx509_revoke_ctx&#160;</td>
332          <td class="paramname"><em>ctx</em>, </td>
333        </tr>
334        <tr>
335          <td class="paramkey"></td>
336          <td></td>
337          <td class="paramtype">hx509_certs&#160;</td>
338          <td class="paramname"><em>certs</em>, </td>
339        </tr>
340        <tr>
341          <td class="paramkey"></td>
342          <td></td>
343          <td class="paramtype">time_t&#160;</td>
344          <td class="paramname"><em>now</em>, </td>
345        </tr>
346        <tr>
347          <td class="paramkey"></td>
348          <td></td>
349          <td class="paramtype">hx509_cert&#160;</td>
350          <td class="paramname"><em>cert</em>, </td>
351        </tr>
352        <tr>
353          <td class="paramkey"></td>
354          <td></td>
355          <td class="paramtype">hx509_cert&#160;</td>
356          <td class="paramname"><em>parent_cert</em>&#160;</td>
357        </tr>
358        <tr>
359          <td></td>
360          <td>)</td>
361          <td></td><td></td>
362        </tr>
363      </table>
364</div><div class="memdoc">
365<p>Check that a certificate is not expired according to a revokation context. Also need the parent certificte to the check OCSP parent identifier.</p>
366<dl class="params"><dt>Parameters</dt><dd>
367  <table class="params">
368    <tr><td class="paramname">context</td><td>hx509 context </td></tr>
369    <tr><td class="paramname">ctx</td><td>hx509 revokation context </td></tr>
370    <tr><td class="paramname">certs</td><td></td></tr>
371    <tr><td class="paramname">now</td><td></td></tr>
372    <tr><td class="paramname">cert</td><td></td></tr>
373    <tr><td class="paramname">parent_cert</td><td></td></tr>
374  </table>
375  </dd>
376</dl>
377<dl class="section return"><dt>Returns</dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#ga15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl>
378
379</div>
380</div>
381</div><!-- contents -->
382<hr size="1"><address style="text-align: right;"><small>
383Generated on Tue Nov 15 2022 14:04:25 for Heimdal x509 library by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.9.1</small></address>
384</body>
385</html>
386