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_RESPONSE_STATUS 3"
136 .TH OCSP_RESPONSE_STATUS 3 "2021-03-25" "1.1.1k" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
142 OCSP_response_status, OCSP_response_get1_basic, OCSP_response_create, OCSP_RESPONSE_free, OCSP_RESPID_set_by_name, OCSP_RESPID_set_by_key, OCSP_RESPID_match, OCSP_basic_sign, OCSP_basic_sign_ctx \- OCSP response functions
144 .IX Header "SYNOPSIS"
146 \& #include <openssl/ocsp.h>
148 \& int OCSP_response_status(OCSP_RESPONSE *resp);
149 \& OCSP_BASICRESP *OCSP_response_get1_basic(OCSP_RESPONSE *resp);
150 \& OCSP_RESPONSE *OCSP_response_create(int status, OCSP_BASICRESP *bs);
151 \& void OCSP_RESPONSE_free(OCSP_RESPONSE *resp);
153 \& int OCSP_RESPID_set_by_name(OCSP_RESPID *respid, X509 *cert);
154 \& int OCSP_RESPID_set_by_key(OCSP_RESPID *respid, X509 *cert);
155 \& int OCSP_RESPID_match(OCSP_RESPID *respid, X509 *cert);
157 \& int OCSP_basic_sign(OCSP_BASICRESP *brsp, X509 *signer, EVP_PKEY *key,
158 \& const EVP_MD *dgst, STACK_OF(X509) *certs,
159 \& unsigned long flags);
160 \& int OCSP_basic_sign_ctx(OCSP_BASICRESP *brsp, X509 *signer, EVP_MD_CTX *ctx,
161 \& STACK_OF(X509) *certs, unsigned long flags);
164 .IX Header "DESCRIPTION"
165 \&\fBOCSP_response_status()\fR returns the \s-1OCSP\s0 response status of \fBresp\fR. It returns
166 one of the values: \fB\s-1OCSP_RESPONSE_STATUS_SUCCESSFUL\s0\fR,
167 \&\fB\s-1OCSP_RESPONSE_STATUS_MALFORMEDREQUEST\s0\fR,
168 \&\fB\s-1OCSP_RESPONSE_STATUS_INTERNALERROR\s0\fR, \fB\s-1OCSP_RESPONSE_STATUS_TRYLATER\s0\fR
169 \&\fB\s-1OCSP_RESPONSE_STATUS_SIGREQUIRED\s0\fR, or \fB\s-1OCSP_RESPONSE_STATUS_UNAUTHORIZED\s0\fR.
171 \&\fBOCSP_response_get1_basic()\fR decodes and returns the \fB\s-1OCSP_BASICRESP\s0\fR structure
172 contained in \fBresp\fR.
174 \&\fBOCSP_response_create()\fR creates and returns an \fB\s-1OCSP_RESPONSE\s0\fR structure for
175 \&\fBstatus\fR and optionally including basic response \fBbs\fR.
177 \&\fBOCSP_RESPONSE_free()\fR frees up \s-1OCSP\s0 response \fBresp\fR.
179 \&\fBOCSP_RESPID_set_by_name()\fR sets the name of the \s-1OCSP_RESPID\s0 to be the same as the
180 subject name in the supplied X509 certificate \fBcert\fR for the \s-1OCSP\s0 responder.
182 \&\fBOCSP_RESPID_set_by_key()\fR sets the key of the \s-1OCSP_RESPID\s0 to be the same as the
183 key in the supplied X509 certificate \fBcert\fR for the \s-1OCSP\s0 responder. The key is
184 stored as a \s-1SHA1\s0 hash.
186 Note that an \s-1OCSP_RESPID\s0 can only have one of the name, or the key set. Calling
187 \&\fBOCSP_RESPID_set_by_name()\fR or \fBOCSP_RESPID_set_by_key()\fR will clear any existing
190 \&\fBOCSP_RESPID_match()\fR tests whether the \s-1OCSP_RESPID\s0 given in \fBrespid\fR matches
191 with the X509 certificate \fBcert\fR.
193 \&\fBOCSP_basic_sign()\fR signs \s-1OCSP\s0 response \fBbrsp\fR using certificate \fBsigner\fR, private key
194 \&\fBkey\fR, digest \fBdgst\fR and additional certificates \fBcerts\fR. If the \fBflags\fR option
195 \&\fB\s-1OCSP_NOCERTS\s0\fR is set then no certificates will be included in the response. If the
196 \&\fBflags\fR option \fB\s-1OCSP_RESPID_KEY\s0\fR is set then the responder is identified by key \s-1ID\s0
197 rather than by name. \fBOCSP_basic_sign_ctx()\fR also signs \s-1OCSP\s0 response \fBbrsp\fR but
198 uses the parameters contained in digest context \fBctx\fR.
200 .IX Header "RETURN VALUES"
201 \&\fBOCSP_RESPONSE_status()\fR returns a status value.
203 \&\fBOCSP_response_get1_basic()\fR returns an \fB\s-1OCSP_BASICRESP\s0\fR structure pointer or
204 \&\fB\s-1NULL\s0\fR if an error occurred.
206 \&\fBOCSP_response_create()\fR returns an \fB\s-1OCSP_RESPONSE\s0\fR structure pointer or \fB\s-1NULL\s0\fR
207 if an error occurred.
209 \&\fBOCSP_RESPONSE_free()\fR does not return a value.
211 \&\fBOCSP_RESPID_set_by_name()\fR, \fBOCSP_RESPID_set_by_key()\fR, \fBOCSP_basic_sign()\fR, and
212 \&\fBOCSP_basic_sign_ctx()\fR return 1 on success or 0
215 \&\fBOCSP_RESPID_match()\fR returns 1 if the \s-1OCSP_RESPID\s0 and the X509 certificate match
219 \&\fBOCSP_response_get1_basic()\fR is only called if the status of a response is
220 \&\fB\s-1OCSP_RESPONSE_STATUS_SUCCESSFUL\s0\fR.
222 .IX Header "SEE ALSO"
224 \&\fBOCSP_cert_to_id\fR\|(3)
225 \&\fBOCSP_request_add1_nonce\fR\|(3)
226 \&\fBOCSP_REQUEST_new\fR\|(3)
227 \&\fBOCSP_resp_find_status\fR\|(3)
228 \&\fBOCSP_sendreq_new\fR\|(3)
229 \&\fBOCSP_RESPID_new\fR\|(3)
230 \&\fBOCSP_RESPID_free\fR\|(3)
233 The \fBOCSP_RESPID_set_by_name()\fR, \fBOCSP_RESPID_set_by_key()\fR and \fBOCSP_RESPID_match()\fR
234 functions were added in OpenSSL 1.1.0a.
236 The \fBOCSP_basic_sign_ctx()\fR function was added in OpenSSL 1.1.1.
238 .IX Header "COPYRIGHT"
239 Copyright 2015\-2020 The OpenSSL Project Authors. All Rights Reserved.
241 Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
242 this file except in compliance with the License. You can obtain a copy
243 in the file \s-1LICENSE\s0 in the source distribution or at
244 <https://www.openssl.org/source/license.html>.