1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
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_REQUEST_ADD1_NONCE 3"
136 .TH OCSP_REQUEST_ADD1_NONCE 3 "2020-09-22" "1.1.1h" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
142 OCSP_request_add1_nonce, OCSP_basic_add1_nonce, OCSP_check_nonce, OCSP_copy_nonce \- OCSP nonce functions
144 .IX Header "SYNOPSIS"
146 \& #include <openssl/ocsp.h>
148 \& int OCSP_request_add1_nonce(OCSP_REQUEST *req, unsigned char *val, int len);
149 \& int OCSP_basic_add1_nonce(OCSP_BASICRESP *resp, unsigned char *val, int len);
150 \& int OCSP_copy_nonce(OCSP_BASICRESP *resp, OCSP_REQUEST *req);
151 \& int OCSP_check_nonce(OCSP_REQUEST *req, OCSP_BASICRESP *resp);
154 .IX Header "DESCRIPTION"
155 \&\fBOCSP_request_add1_nonce()\fR adds a nonce of value \fBval\fR and length \fBlen\fR to
156 \&\s-1OCSP\s0 request \fBreq\fR. If \fBval\fR is \fB\s-1NULL\s0\fR a random nonce is used. If \fBlen\fR
157 is zero or negative a default length will be used (currently 16 bytes).
159 \&\fBOCSP_basic_add1_nonce()\fR is identical to \fBOCSP_request_add1_nonce()\fR except
160 it adds a nonce to \s-1OCSP\s0 basic response \fBresp\fR.
162 \&\fBOCSP_check_nonce()\fR compares the nonce value in \fBreq\fR and \fBresp\fR.
164 \&\fBOCSP_copy_nonce()\fR copies any nonce value present in \fBreq\fR to \fBresp\fR.
166 .IX Header "RETURN VALUES"
167 \&\fBOCSP_request_add1_nonce()\fR and \fBOCSP_basic_add1_nonce()\fR return 1 for success
170 \&\fBOCSP_copy_nonce()\fR returns 1 if a nonce was successfully copied, 2 if no nonce
171 was present in \fBreq\fR and 0 if an error occurred.
173 \&\fBOCSP_check_nonce()\fR returns the result of the nonce comparison between \fBreq\fR
174 and \fBresp\fR. The return value indicates the result of the comparison. If
175 nonces are present and equal 1 is returned. If the nonces are absent 2 is
176 returned. If a nonce is present in the response only 3 is returned. If nonces
177 are present and unequal 0 is returned. If the nonce is present in the request
178 only then \-1 is returned.
181 For most purposes the nonce value in a request is set to a random value so
182 the \fBval\fR parameter in \fBOCSP_request_add1_nonce()\fR is usually \s-1NULL.\s0
184 An \s-1OCSP\s0 nonce is typically added to an \s-1OCSP\s0 request to thwart replay attacks
185 by checking the same nonce value appears in the response.
187 Some responders may include a nonce in all responses even if one is not
190 Some responders cache \s-1OCSP\s0 responses and do not sign each response for
191 performance reasons. As a result they do not support nonces.
193 The return values of \fBOCSP_check_nonce()\fR can be checked to cover each case. A
194 positive return value effectively indicates success: nonces are both present
195 and match, both absent or present in the response only. A nonzero return
196 additionally covers the case where the nonce is present in the request only:
197 this will happen if the responder doesn't support nonces. A zero return value
198 indicates present and mismatched nonces: this should be treated as an error
201 .IX Header "SEE ALSO"
203 \&\fBOCSP_cert_to_id\fR\|(3),
204 \&\fBOCSP_REQUEST_new\fR\|(3),
205 \&\fBOCSP_resp_find_status\fR\|(3),
206 \&\fBOCSP_response_status\fR\|(3),
207 \&\fBOCSP_sendreq_new\fR\|(3)
209 .IX Header "COPYRIGHT"
210 Copyright 2015\-2020 The OpenSSL Project Authors. All Rights Reserved.
212 Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
213 this file except in compliance with the License. You can obtain a copy
214 in the file \s-1LICENSE\s0 in the source distribution or at
215 <https://www.openssl.org/source/license.html>.