diff options
Diffstat (limited to 'src/lib/libcrypto/man')
| -rw-r--r-- | src/lib/libcrypto/man/OCSP_cert_to_id.3 | 68 |
1 files changed, 52 insertions, 16 deletions
diff --git a/src/lib/libcrypto/man/OCSP_cert_to_id.3 b/src/lib/libcrypto/man/OCSP_cert_to_id.3 index 5d6503d2b0..c1ba1f59ba 100644 --- a/src/lib/libcrypto/man/OCSP_cert_to_id.3 +++ b/src/lib/libcrypto/man/OCSP_cert_to_id.3 | |||
| @@ -1,7 +1,24 @@ | |||
| 1 | .\" $OpenBSD: OCSP_cert_to_id.3,v 1.3 2016/12/06 14:54:55 schwarze Exp $ | 1 | .\" $OpenBSD: OCSP_cert_to_id.3,v 1.4 2016/12/12 20:41:48 schwarze Exp $ |
| 2 | .\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 | 2 | .\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 |
| 3 | .\" | 3 | .\" |
| 4 | .\" This file was written by Dr. Stephen Henson <steve@openssl.org>. | 4 | .\" This file is a derived work. |
| 5 | .\" The changes are covered by the following Copyright and license: | ||
| 6 | .\" | ||
| 7 | .\" Copyright (c) 2016 Ingo Schwarze <schwarze@openbsd.org> | ||
| 8 | .\" | ||
| 9 | .\" Permission to use, copy, modify, and distribute this software for any | ||
| 10 | .\" purpose with or without fee is hereby granted, provided that the above | ||
| 11 | .\" copyright notice and this permission notice appear in all copies. | ||
| 12 | .\" | ||
| 13 | .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | ||
| 14 | .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | ||
| 15 | .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | ||
| 16 | .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||
| 17 | .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | ||
| 18 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | ||
| 19 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | ||
| 20 | .\" | ||
| 21 | .\" The original file was written by Dr. Stephen Henson <steve@openssl.org>. | ||
| 5 | .\" Copyright (c) 2014, 2016 The OpenSSL Project. All rights reserved. | 22 | .\" Copyright (c) 2014, 2016 The OpenSSL Project. All rights reserved. |
| 6 | .\" | 23 | .\" |
| 7 | .\" Redistribution and use in source and binary forms, with or without | 24 | .\" Redistribution and use in source and binary forms, with or without |
| @@ -48,13 +65,14 @@ | |||
| 48 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | 65 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
| 49 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | 66 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. |
| 50 | .\" | 67 | .\" |
| 51 | .Dd $Mdocdate: December 6 2016 $ | 68 | .Dd $Mdocdate: December 12 2016 $ |
| 52 | .Dt OCSP_CERT_TO_ID 3 | 69 | .Dt OCSP_CERT_TO_ID 3 |
| 53 | .Os | 70 | .Os |
| 54 | .Sh NAME | 71 | .Sh NAME |
| 72 | .Nm OCSP_CERTID_new , | ||
| 73 | .Nm OCSP_CERTID_free , | ||
| 55 | .Nm OCSP_cert_to_id , | 74 | .Nm OCSP_cert_to_id , |
| 56 | .Nm OCSP_cert_id_new , | 75 | .Nm OCSP_cert_id_new , |
| 57 | .Nm OCSP_CERTID_free , | ||
| 58 | .Nm OCSP_id_issuer_cmp , | 76 | .Nm OCSP_id_issuer_cmp , |
| 59 | .Nm OCSP_id_cmp , | 77 | .Nm OCSP_id_cmp , |
| 60 | .Nm OCSP_id_get0_info | 78 | .Nm OCSP_id_get0_info |
| @@ -62,6 +80,10 @@ | |||
| 62 | .Sh SYNOPSIS | 80 | .Sh SYNOPSIS |
| 63 | .In openssl/ocsp.h | 81 | .In openssl/ocsp.h |
| 64 | .Ft OCSP_CERTID * | 82 | .Ft OCSP_CERTID * |
| 83 | .Fn OCSP_CERTID_new void | ||
| 84 | .Ft void | ||
| 85 | .Fn OCSP_CERTID_free "OCSP_CERTID *id" | ||
| 86 | .Ft OCSP_CERTID * | ||
| 65 | .Fo OCSP_cert_to_id | 87 | .Fo OCSP_cert_to_id |
| 66 | .Fa "const EVP_MD *dgst" | 88 | .Fa "const EVP_MD *dgst" |
| 67 | .Fa "X509 *subject" | 89 | .Fa "X509 *subject" |
| @@ -74,10 +96,6 @@ | |||
| 74 | .Fa "ASN1_BIT_STRING *issuerKey" | 96 | .Fa "ASN1_BIT_STRING *issuerKey" |
| 75 | .Fa "ASN1_INTEGER *serialNumber" | 97 | .Fa "ASN1_INTEGER *serialNumber" |
| 76 | .Fc | 98 | .Fc |
| 77 | .Ft void | ||
| 78 | .Fo OCSP_CERTID_free | ||
| 79 | .Fa "OCSP_CERTID *id" | ||
| 80 | .Fc | ||
| 81 | .Ft int | 99 | .Ft int |
| 82 | .Fo OCSP_id_issuer_cmp | 100 | .Fo OCSP_id_issuer_cmp |
| 83 | .Fa "OCSP_CERTID *a" | 101 | .Fa "OCSP_CERTID *a" |
| @@ -97,10 +115,28 @@ | |||
| 97 | .Fa "OCSP_CERTID *cid" | 115 | .Fa "OCSP_CERTID *cid" |
| 98 | .Fc | 116 | .Fc |
| 99 | .Sh DESCRIPTION | 117 | .Sh DESCRIPTION |
| 118 | .Fn OCSP_CERTID_new | ||
| 119 | allocates and initializes an empty | ||
| 120 | .Vt OCSP_CERTID | ||
| 121 | object, representing an ASN.1 CertID structure defined in RFC 6960. | ||
| 122 | It can store hashes of an issuer's distinguished name and public | ||
| 123 | key together with a serial number of a certificate. | ||
| 124 | It is used by the | ||
| 125 | .Vt OCSP_ONEREQ | ||
| 126 | object described in | ||
| 127 | .Xr OCSP_ONEREQ_new 3 | ||
| 128 | and by the | ||
| 129 | .Vt OCSP_SINGLERESP | ||
| 130 | object described in | ||
| 131 | .Xr OCSP_SINGLERESP_new 3 . | ||
| 132 | .Fn OCSP_CERTID_free | ||
| 133 | frees | ||
| 134 | .Fa id . | ||
| 135 | .Pp | ||
| 100 | .Fn OCSP_cert_to_id | 136 | .Fn OCSP_cert_to_id |
| 101 | creates and returns a new | 137 | creates and returns a new |
| 102 | .Vt OCSP_CERTID | 138 | .Vt OCSP_CERTID |
| 103 | structure using message digest | 139 | object using message digest |
| 104 | .Fa dgst | 140 | .Fa dgst |
| 105 | for certificate | 141 | for certificate |
| 106 | .Fa subject | 142 | .Fa subject |
| @@ -124,10 +160,6 @@ issuer key hash | |||
| 124 | and serial number | 160 | and serial number |
| 125 | .Fa serialNumber . | 161 | .Fa serialNumber . |
| 126 | .Pp | 162 | .Pp |
| 127 | .Fn OCSP_CERTID_free | ||
| 128 | frees up | ||
| 129 | .Fa id . | ||
| 130 | .Pp | ||
| 131 | .Fn OCSP_id_cmp | 163 | .Fn OCSP_id_cmp |
| 132 | compares | 164 | compares |
| 133 | .Vt OCSP_CERTID | 165 | .Vt OCSP_CERTID |
| @@ -154,7 +186,7 @@ The values returned by | |||
| 154 | are internal pointers and must not be freed up by an application: | 186 | are internal pointers and must not be freed up by an application: |
| 155 | they will be freed when the corresponding | 187 | they will be freed when the corresponding |
| 156 | .Vt OCSP_CERTID | 188 | .Vt OCSP_CERTID |
| 157 | structure is freed. | 189 | object is freed. |
| 158 | .Pp | 190 | .Pp |
| 159 | OCSP clients will typically only use | 191 | OCSP clients will typically only use |
| 160 | .Fn OCSP_cert_to_id | 192 | .Fn OCSP_cert_to_id |
| @@ -162,12 +194,13 @@ or | |||
| 162 | .Fn OCSP_cert_id_new : | 194 | .Fn OCSP_cert_id_new : |
| 163 | the other functions are used by responder applications. | 195 | the other functions are used by responder applications. |
| 164 | .Sh RETURN VALUES | 196 | .Sh RETURN VALUES |
| 165 | .Fn OCSP_cert_to_id | 197 | .Fn OCSP_CERTID_new , |
| 198 | .Fn OCSP_cert_to_id , | ||
| 166 | and | 199 | and |
| 167 | .Fn OCSP_cert_id_new | 200 | .Fn OCSP_cert_id_new |
| 168 | return either a pointer to a valid | 201 | return either a pointer to a valid |
| 169 | .Vt OCSP_CERTID | 202 | .Vt OCSP_CERTID |
| 170 | structure or | 203 | object or |
| 171 | .Dv NULL | 204 | .Dv NULL |
| 172 | if an error occurred. | 205 | if an error occurred. |
| 173 | .Pp | 206 | .Pp |
| @@ -184,3 +217,6 @@ returns 1 for success or 0 for failure. | |||
| 184 | .Xr OCSP_resp_find_status 3 , | 217 | .Xr OCSP_resp_find_status 3 , |
| 185 | .Xr OCSP_response_status 3 , | 218 | .Xr OCSP_response_status 3 , |
| 186 | .Xr OCSP_sendreq_new 3 | 219 | .Xr OCSP_sendreq_new 3 |
| 220 | .Sh STANDARDS | ||
| 221 | RFC 6960: X.509 Internet Public Key Infrastructure Online Certificate | ||
| 222 | Status Protocol, section 4: Details of the Protocol | ||
