1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
54 .\" Avoid warning from groff about undefined register 'F'.
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
62 . tm Index:\\$1\t\\n%\t"\\$2"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear. Run. Save yourself. No user-serviceable parts.
74 . \" fudge factors for nroff and troff
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
89 . \" simple accents for nroff and troff
99 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
106 . \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 . \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 . \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
133 .\" ========================================================================
135 .IX Title "OCSP_CERT_TO_ID 3"
136 .TH OCSP_CERT_TO_ID 3 "2021-02-16" "1.1.1j" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
142 OCSP_cert_to_id, OCSP_cert_id_new, OCSP_CERTID_free, OCSP_id_issuer_cmp, OCSP_id_cmp, OCSP_id_get0_info \- OCSP certificate ID utility functions
144 .IX Header "SYNOPSIS"
146 \& #include <openssl/ocsp.h>
148 \& OCSP_CERTID *OCSP_cert_to_id(const EVP_MD *dgst,
149 \& X509 *subject, X509 *issuer);
151 \& OCSP_CERTID *OCSP_cert_id_new(const EVP_MD *dgst,
152 \& X509_NAME *issuerName,
153 \& ASN1_BIT_STRING *issuerKey,
154 \& ASN1_INTEGER *serialNumber);
156 \& void OCSP_CERTID_free(OCSP_CERTID *id);
158 \& int OCSP_id_issuer_cmp(const OCSP_CERTID *a, const OCSP_CERTID *b);
159 \& int OCSP_id_cmp(const OCSP_CERTID *a, const OCSP_CERTID *b);
161 \& int OCSP_id_get0_info(ASN1_OCTET_STRING **piNameHash, ASN1_OBJECT **pmd,
162 \& ASN1_OCTET_STRING **pikeyHash,
163 \& ASN1_INTEGER **pserial, OCSP_CERTID *cid);
166 .IX Header "DESCRIPTION"
167 \&\fBOCSP_cert_to_id()\fR creates and returns a new \fB\s-1OCSP_CERTID\s0\fR structure using
168 message digest \fBdgst\fR for certificate \fBsubject\fR with issuer \fBissuer\fR. If
169 \&\fBdgst\fR is \fB\s-1NULL\s0\fR then \s-1SHA1\s0 is used.
171 \&\fBOCSP_cert_id_new()\fR creates and returns a new \fB\s-1OCSP_CERTID\s0\fR using \fBdgst\fR and
172 issuer name \fBissuerName\fR, issuer key hash \fBissuerKey\fR and serial number
173 \&\fBserialNumber\fR.
175 \&\fBOCSP_CERTID_free()\fR frees up \fBid\fR.
177 \&\fBOCSP_id_cmp()\fR compares \fB\s-1OCSP_CERTID\s0\fR \fBa\fR and \fBb\fR.
179 \&\fBOCSP_id_issuer_cmp()\fR compares only the issuer name of \fB\s-1OCSP_CERTID\s0\fR \fBa\fR and \fBb\fR.
181 \&\fBOCSP_id_get0_info()\fR returns the issuer name hash, hash \s-1OID,\s0 issuer key hash and
182 serial number contained in \fBcid\fR. If any of the values are not required the
183 corresponding parameter can be set to \fB\s-1NULL\s0\fR.
185 .IX Header "RETURN VALUES"
186 \&\fBOCSP_cert_to_id()\fR and \fBOCSP_cert_id_new()\fR return either a pointer to a valid
187 \&\fB\s-1OCSP_CERTID\s0\fR structure or \fB\s-1NULL\s0\fR if an error occurred.
189 \&\fBOCSP_id_cmp()\fR and \fBOCSP_id_issuer_cmp()\fR returns zero for a match and nonzero
192 \&\fBOCSP_CERTID_free()\fR does not return a value.
194 \&\fBOCSP_id_get0_info()\fR returns 1 for success and 0 for failure.
197 \&\s-1OCSP\s0 clients will typically only use \fBOCSP_cert_to_id()\fR or \fBOCSP_cert_id_new()\fR:
198 the other functions are used by responder applications.
200 The values returned by \fBOCSP_id_get0_info()\fR are internal pointers and \fB\s-1MUST
201 NOT\s0\fR be freed up by an application: they will be freed when the corresponding
202 \&\fB\s-1OCSP_CERTID\s0\fR structure is freed.
204 .IX Header "SEE ALSO"
206 \&\fBOCSP_request_add1_nonce\fR\|(3),
207 \&\fBOCSP_REQUEST_new\fR\|(3),
208 \&\fBOCSP_resp_find_status\fR\|(3),
209 \&\fBOCSP_response_status\fR\|(3),
210 \&\fBOCSP_sendreq_new\fR\|(3)
212 .IX Header "COPYRIGHT"
213 Copyright 2015\-2020 The OpenSSL Project Authors. All Rights Reserved.
215 Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
216 this file except in compliance with the License. You can obtain a copy
217 in the file \s-1LICENSE\s0 in the source distribution or at
218 <https://www.openssl.org/source/license.html>.