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>Heimdalx509library: 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">
8 <a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a>
10 <!-- end of header marker -->
11 <!-- Generated by Doxygen 1.5.6 -->
12 <div class="navigation" id="top">
15 <li><a href="index.html"><span>Main Page</span></a></li>
16 <li><a href="pages.html"><span>Related Pages</span></a></li>
17 <li><a href="modules.html"><span>Modules</span></a></li>
21 <div class="contents">
22 <h1>hx509 revokation checking functions</h1><table border="0" cellpadding="0" cellspacing="0">
24 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
25 <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__revoke.html#g83057d3c52d4b298b92571d48cf7099e">hx509_revoke_init</a> (hx509_context context, hx509_revoke_ctx *ctx)</td></tr>
27 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__revoke.html#gc0928df8a473e5a76fd8a2785d43ea9b">hx509_revoke_free</a> (hx509_revoke_ctx *ctx)</td></tr>
29 <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__revoke.html#gbda08999b0473bda2077b54c96be79e9">hx509_revoke_add_ocsp</a> (hx509_context context, hx509_revoke_ctx ctx, const char *path)</td></tr>
31 <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__revoke.html#g90c30e6adae77012e1360bb502b57c72">hx509_revoke_add_crl</a> (hx509_context context, hx509_revoke_ctx ctx, const char *path)</td></tr>
33 <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__revoke.html#g3faf6194dc7429f8850e02b3ae2bbeeb">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>
35 <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__revoke.html#gef3bddfe2f6b619ced673cf9aef07c37">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>
37 <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hx509__revoke.html#gb55b117222f61fd628744f2cd6d5a218">hx509_revoke_ocsp_print</a> (hx509_context context, const char *path, FILE *out)</td></tr>
40 <hr><a name="_details"></a><h2>Detailed Description</h2>
41 See the <a class="el" href="page_revoke.html">Revocation methods</a> for description and examples. <hr><h2>Function Documentation</h2>
42 <a class="anchor" name="gef3bddfe2f6b619ced673cf9aef07c37"></a><!-- doxytag: member="revoke.c::hx509_ocsp_request" ref="gef3bddfe2f6b619ced673cf9aef07c37" args="(hx509_context context, hx509_certs reqcerts, hx509_certs pool, hx509_cert signer, const AlgorithmIdentifier *digest, heim_octet_string *request, heim_octet_string *nonce)" -->
44 <div class="memproto">
45 <table class="memname">
47 <td class="memname">int hx509_ocsp_request </td>
49 <td class="paramtype">hx509_context </td>
50 <td class="paramname"> <em>context</em>, </td>
53 <td class="paramkey"></td>
55 <td class="paramtype">hx509_certs </td>
56 <td class="paramname"> <em>reqcerts</em>, </td>
59 <td class="paramkey"></td>
61 <td class="paramtype">hx509_certs </td>
62 <td class="paramname"> <em>pool</em>, </td>
65 <td class="paramkey"></td>
67 <td class="paramtype">hx509_cert </td>
68 <td class="paramname"> <em>signer</em>, </td>
71 <td class="paramkey"></td>
73 <td class="paramtype">const AlgorithmIdentifier * </td>
74 <td class="paramname"> <em>digest</em>, </td>
77 <td class="paramkey"></td>
79 <td class="paramtype">heim_octet_string * </td>
80 <td class="paramname"> <em>request</em>, </td>
83 <td class="paramkey"></td>
85 <td class="paramtype">heim_octet_string * </td>
86 <td class="paramname"> <em>nonce</em></td><td> </td>
91 <td></td><td></td><td></td>
98 Create an OCSP request for a set of certificates.<p>
99 <dl compact><dt><b>Parameters:</b></dt><dd>
100 <table border="0" cellspacing="2" cellpadding="0">
101 <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>a hx509 context </td></tr>
102 <tr><td valign="top"></td><td valign="top"><em>reqcerts</em> </td><td>list of certificates to request ocsp data for </td></tr>
103 <tr><td valign="top"></td><td valign="top"><em>pool</em> </td><td>certificate pool to use when signing </td></tr>
104 <tr><td valign="top"></td><td valign="top"><em>signer</em> </td><td>certificate to use to sign the request </td></tr>
105 <tr><td valign="top"></td><td valign="top"><em>digest</em> </td><td>the signing algorithm in the request, if NULL use the default signature algorithm, </td></tr>
106 <tr><td valign="top"></td><td valign="top"><em>request</em> </td><td>the encoded request, free with free_heim_octet_string(). </td></tr>
107 <tr><td valign="top"></td><td valign="top"><em>nonce</em> </td><td>nonce in the request, free with free_heim_octet_string().</td></tr>
110 <dl class="return" compact><dt><b>Returns:</b></dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#g15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl>
114 <a class="anchor" name="g90c30e6adae77012e1360bb502b57c72"></a><!-- doxytag: member="revoke.c::hx509_revoke_add_crl" ref="g90c30e6adae77012e1360bb502b57c72" args="(hx509_context context, hx509_revoke_ctx ctx, const char *path)" -->
115 <div class="memitem">
116 <div class="memproto">
117 <table class="memname">
119 <td class="memname">int hx509_revoke_add_crl </td>
121 <td class="paramtype">hx509_context </td>
122 <td class="paramname"> <em>context</em>, </td>
125 <td class="paramkey"></td>
127 <td class="paramtype">hx509_revoke_ctx </td>
128 <td class="paramname"> <em>ctx</em>, </td>
131 <td class="paramkey"></td>
133 <td class="paramtype">const char * </td>
134 <td class="paramname"> <em>path</em></td><td> </td>
139 <td></td><td></td><td></td>
146 Add a CRL file to the revokation context.<p>
147 <dl compact><dt><b>Parameters:</b></dt><dd>
148 <table border="0" cellspacing="2" cellpadding="0">
149 <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>hx509 context </td></tr>
150 <tr><td valign="top"></td><td valign="top"><em>ctx</em> </td><td>hx509 revokation context </td></tr>
151 <tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>path to file that is going to be added to the context.</td></tr>
154 <dl class="return" compact><dt><b>Returns:</b></dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#g15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl>
158 <a class="anchor" name="gbda08999b0473bda2077b54c96be79e9"></a><!-- doxytag: member="revoke.c::hx509_revoke_add_ocsp" ref="gbda08999b0473bda2077b54c96be79e9" args="(hx509_context context, hx509_revoke_ctx ctx, const char *path)" -->
159 <div class="memitem">
160 <div class="memproto">
161 <table class="memname">
163 <td class="memname">int hx509_revoke_add_ocsp </td>
165 <td class="paramtype">hx509_context </td>
166 <td class="paramname"> <em>context</em>, </td>
169 <td class="paramkey"></td>
171 <td class="paramtype">hx509_revoke_ctx </td>
172 <td class="paramname"> <em>ctx</em>, </td>
175 <td class="paramkey"></td>
177 <td class="paramtype">const char * </td>
178 <td class="paramname"> <em>path</em></td><td> </td>
183 <td></td><td></td><td></td>
190 Add a OCSP file to the revokation context.<p>
191 <dl compact><dt><b>Parameters:</b></dt><dd>
192 <table border="0" cellspacing="2" cellpadding="0">
193 <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>hx509 context </td></tr>
194 <tr><td valign="top"></td><td valign="top"><em>ctx</em> </td><td>hx509 revokation context </td></tr>
195 <tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>path to file that is going to be added to the context.</td></tr>
198 <dl class="return" compact><dt><b>Returns:</b></dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#g15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl>
202 <a class="anchor" name="gc0928df8a473e5a76fd8a2785d43ea9b"></a><!-- doxytag: member="revoke.c::hx509_revoke_free" ref="gc0928df8a473e5a76fd8a2785d43ea9b" args="(hx509_revoke_ctx *ctx)" -->
203 <div class="memitem">
204 <div class="memproto">
205 <table class="memname">
207 <td class="memname">void hx509_revoke_free </td>
209 <td class="paramtype">hx509_revoke_ctx * </td>
210 <td class="paramname"> <em>ctx</em> </td>
211 <td> ) </td>
219 Free a hx509 revokation context.<p>
220 <dl compact><dt><b>Parameters:</b></dt><dd>
221 <table border="0" cellspacing="2" cellpadding="0">
222 <tr><td valign="top"></td><td valign="top"><em>ctx</em> </td><td>context to be freed </td></tr>
228 <a class="anchor" name="g83057d3c52d4b298b92571d48cf7099e"></a><!-- doxytag: member="revoke.c::hx509_revoke_init" ref="g83057d3c52d4b298b92571d48cf7099e" args="(hx509_context context, hx509_revoke_ctx *ctx)" -->
229 <div class="memitem">
230 <div class="memproto">
231 <table class="memname">
233 <td class="memname">int hx509_revoke_init </td>
235 <td class="paramtype">hx509_context </td>
236 <td class="paramname"> <em>context</em>, </td>
239 <td class="paramkey"></td>
241 <td class="paramtype">hx509_revoke_ctx * </td>
242 <td class="paramname"> <em>ctx</em></td><td> </td>
247 <td></td><td></td><td></td>
254 Allocate a revokation context. Free with <a class="el" href="group__hx509__revoke.html#gc0928df8a473e5a76fd8a2785d43ea9b">hx509_revoke_free()</a>.<p>
255 <dl compact><dt><b>Parameters:</b></dt><dd>
256 <table border="0" cellspacing="2" cellpadding="0">
257 <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>A hx509 context. </td></tr>
258 <tr><td valign="top"></td><td valign="top"><em>ctx</em> </td><td>returns a newly allocated revokation context.</td></tr>
261 <dl class="return" compact><dt><b>Returns:</b></dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#g15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl>
265 <a class="anchor" name="gb55b117222f61fd628744f2cd6d5a218"></a><!-- doxytag: member="revoke.c::hx509_revoke_ocsp_print" ref="gb55b117222f61fd628744f2cd6d5a218" args="(hx509_context context, const char *path, FILE *out)" -->
266 <div class="memitem">
267 <div class="memproto">
268 <table class="memname">
270 <td class="memname">int hx509_revoke_ocsp_print </td>
272 <td class="paramtype">hx509_context </td>
273 <td class="paramname"> <em>context</em>, </td>
276 <td class="paramkey"></td>
278 <td class="paramtype">const char * </td>
279 <td class="paramname"> <em>path</em>, </td>
282 <td class="paramkey"></td>
284 <td class="paramtype">FILE * </td>
285 <td class="paramname"> <em>out</em></td><td> </td>
290 <td></td><td></td><td></td>
297 Print the OCSP reply stored in a file.<p>
298 <dl compact><dt><b>Parameters:</b></dt><dd>
299 <table border="0" cellspacing="2" cellpadding="0">
300 <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>a hx509 context </td></tr>
301 <tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>path to a file with a OCSP reply </td></tr>
302 <tr><td valign="top"></td><td valign="top"><em>out</em> </td><td>the out FILE descriptor to print the reply on</td></tr>
305 <dl class="return" compact><dt><b>Returns:</b></dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#g15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl>
309 <a class="anchor" name="g3faf6194dc7429f8850e02b3ae2bbeeb"></a><!-- doxytag: member="revoke.c::hx509_revoke_verify" ref="g3faf6194dc7429f8850e02b3ae2bbeeb" args="(hx509_context context, hx509_revoke_ctx ctx, hx509_certs certs, time_t now, hx509_cert cert, hx509_cert parent_cert)" -->
310 <div class="memitem">
311 <div class="memproto">
312 <table class="memname">
314 <td class="memname">int hx509_revoke_verify </td>
316 <td class="paramtype">hx509_context </td>
317 <td class="paramname"> <em>context</em>, </td>
320 <td class="paramkey"></td>
322 <td class="paramtype">hx509_revoke_ctx </td>
323 <td class="paramname"> <em>ctx</em>, </td>
326 <td class="paramkey"></td>
328 <td class="paramtype">hx509_certs </td>
329 <td class="paramname"> <em>certs</em>, </td>
332 <td class="paramkey"></td>
334 <td class="paramtype">time_t </td>
335 <td class="paramname"> <em>now</em>, </td>
338 <td class="paramkey"></td>
340 <td class="paramtype">hx509_cert </td>
341 <td class="paramname"> <em>cert</em>, </td>
344 <td class="paramkey"></td>
346 <td class="paramtype">hx509_cert </td>
347 <td class="paramname"> <em>parent_cert</em></td><td> </td>
352 <td></td><td></td><td></td>
359 Check that a certificate is not expired according to a revokation context. Also need the parent certificte to the check OCSP parent identifier.<p>
360 <dl compact><dt><b>Parameters:</b></dt><dd>
361 <table border="0" cellspacing="2" cellpadding="0">
362 <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>hx509 context </td></tr>
363 <tr><td valign="top"></td><td valign="top"><em>ctx</em> </td><td>hx509 revokation context </td></tr>
364 <tr><td valign="top"></td><td valign="top"><em>certs</em> </td><td></td></tr>
365 <tr><td valign="top"></td><td valign="top"><em>now</em> </td><td></td></tr>
366 <tr><td valign="top"></td><td valign="top"><em>cert</em> </td><td></td></tr>
367 <tr><td valign="top"></td><td valign="top"><em>parent_cert</em> </td><td></td></tr>
370 <dl class="return" compact><dt><b>Returns:</b></dt><dd>An hx509 error code, see <a class="el" href="group__hx509__error.html#g15791abff76719acb531223fdcbcac87">hx509_get_error_string()</a>. </dd></dl>
375 <hr size="1"><address style="text-align: right;"><small>
376 Generated on Wed Jan 11 14:07:40 2012 for Heimdalx509library by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6</small></address>