crypto/heimdal/doc/doxyout/hx509/man/man3/hx509_revoke.3

   1 .TH "hx509 revokation checking functions" 3 "11 Jan 2012" "Version 1.5.2" "Heimdalx509library" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 hx509 revokation checking functions \-
   6 .SS "Functions"
   7
   8 .in +1c
   9 .ti -1c
  10 .RI "int \fBhx509_revoke_init\fP (hx509_context context, hx509_revoke_ctx *ctx)"
  11 .br
  12 .ti -1c
  13 .RI "void \fBhx509_revoke_free\fP (hx509_revoke_ctx *ctx)"
  14 .br
  15 .ti -1c
  16 .RI "int \fBhx509_revoke_add_ocsp\fP (hx509_context context, hx509_revoke_ctx ctx, const char *path)"
  17 .br
  18 .ti -1c
  19 .RI "int \fBhx509_revoke_add_crl\fP (hx509_context context, hx509_revoke_ctx ctx, const char *path)"
  20 .br
  21 .ti -1c
  22 .RI "int \fBhx509_revoke_verify\fP (hx509_context context, hx509_revoke_ctx ctx, hx509_certs certs, time_t now, hx509_cert cert, hx509_cert parent_cert)"
  23 .br
  24 .ti -1c
  25 .RI "int \fBhx509_ocsp_request\fP (hx509_context context, hx509_certs reqcerts, hx509_certs pool, hx509_cert signer, const AlgorithmIdentifier *digest, heim_octet_string *request, heim_octet_string *nonce)"
  26 .br
  27 .ti -1c
  28 .RI "int \fBhx509_revoke_ocsp_print\fP (hx509_context context, const char *path, FILE *out)"
  29 .br
  30 .in -1c
  31 .SH "Detailed Description"
  32 .PP
  33 See the \fBRevocation methods\fP for description and examples.
  34 .SH "Function Documentation"
  35 .PP
  36 .SS "int hx509_ocsp_request (hx509_context context, hx509_certs reqcerts, hx509_certs pool, hx509_cert signer, const AlgorithmIdentifier * digest, heim_octet_string * request, heim_octet_string * nonce)"
  37 .PP
  38 Create an OCSP request for a set of certificates.
  39 .PP
  40 \fBParameters:\fP
  41 .RS 4
  42 \fIcontext\fP a hx509 context
  43 .br
  44 \fIreqcerts\fP list of certificates to request ocsp data for
  45 .br
  46 \fIpool\fP certificate pool to use when signing
  47 .br
  48 \fIsigner\fP certificate to use to sign the request
  49 .br
  50 \fIdigest\fP the signing algorithm in the request, if NULL use the default signature algorithm,
  51 .br
  52 \fIrequest\fP the encoded request, free with free_heim_octet_string().
  53 .br
  54 \fInonce\fP nonce in the request, free with free_heim_octet_string().
  55 .RE
  56 .PP
  57 \fBReturns:\fP
  58 .RS 4
  59 An hx509 error code, see \fBhx509_get_error_string()\fP.
  60 .RE
  61 .PP
  62
  63 .SS "int hx509_revoke_add_crl (hx509_context context, hx509_revoke_ctx ctx, const char * path)"
  64 .PP
  65 Add a CRL file to the revokation context.
  66 .PP
  67 \fBParameters:\fP
  68 .RS 4
  69 \fIcontext\fP hx509 context
  70 .br
  71 \fIctx\fP hx509 revokation context
  72 .br
  73 \fIpath\fP path to file that is going to be added to the context.
  74 .RE
  75 .PP
  76 \fBReturns:\fP
  77 .RS 4
  78 An hx509 error code, see \fBhx509_get_error_string()\fP.
  79 .RE
  80 .PP
  81
  82 .SS "int hx509_revoke_add_ocsp (hx509_context context, hx509_revoke_ctx ctx, const char * path)"
  83 .PP
  84 Add a OCSP file to the revokation context.
  85 .PP
  86 \fBParameters:\fP
  87 .RS 4
  88 \fIcontext\fP hx509 context
  89 .br
  90 \fIctx\fP hx509 revokation context
  91 .br
  92 \fIpath\fP path to file that is going to be added to the context.
  93 .RE
  94 .PP
  95 \fBReturns:\fP
  96 .RS 4
  97 An hx509 error code, see \fBhx509_get_error_string()\fP.
  98 .RE
  99 .PP
 100
 101 .SS "void hx509_revoke_free (hx509_revoke_ctx * ctx)"
 102 .PP
 103 Free a hx509 revokation context.
 104 .PP
 105 \fBParameters:\fP
 106 .RS 4
 107 \fIctx\fP context to be freed
 108 .RE
 109 .PP
 110
 111 .SS "int hx509_revoke_init (hx509_context context, hx509_revoke_ctx * ctx)"
 112 .PP
 113 Allocate a revokation context. Free with \fBhx509_revoke_free()\fP.
 114 .PP
 115 \fBParameters:\fP
 116 .RS 4
 117 \fIcontext\fP A hx509 context.
 118 .br
 119 \fIctx\fP returns a newly allocated revokation context.
 120 .RE
 121 .PP
 122 \fBReturns:\fP
 123 .RS 4
 124 An hx509 error code, see \fBhx509_get_error_string()\fP.
 125 .RE
 126 .PP
 127
 128 .SS "int hx509_revoke_ocsp_print (hx509_context context, const char * path, FILE * out)"
 129 .PP
 130 Print the OCSP reply stored in a file.
 131 .PP
 132 \fBParameters:\fP
 133 .RS 4
 134 \fIcontext\fP a hx509 context
 135 .br
 136 \fIpath\fP path to a file with a OCSP reply
 137 .br
 138 \fIout\fP the out FILE descriptor to print the reply on
 139 .RE
 140 .PP
 141 \fBReturns:\fP
 142 .RS 4
 143 An hx509 error code, see \fBhx509_get_error_string()\fP.
 144 .RE
 145 .PP
 146
 147 .SS "int hx509_revoke_verify (hx509_context context, hx509_revoke_ctx ctx, hx509_certs certs, time_t now, hx509_cert cert, hx509_cert parent_cert)"
 148 .PP
 149 Check that a certificate is not expired according to a revokation context. Also need the parent certificte to the check OCSP parent identifier.
 150 .PP
 151 \fBParameters:\fP
 152 .RS 4
 153 \fIcontext\fP hx509 context
 154 .br
 155 \fIctx\fP hx509 revokation context
 156 .br
 157 \fIcerts\fP
 158 .br
 159 \fInow\fP
 160 .br
 161 \fIcert\fP
 162 .br
 163 \fIparent_cert\fP
 164 .RE
 165 .PP
 166 \fBReturns:\fP
 167 .RS 4
 168 An hx509 error code, see \fBhx509_get_error_string()\fP.
 169 .RE
 170 .PP
 171