summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--src/lib/libcrypto/man/OCSP_REQUEST_new.3121
1 files changed, 95 insertions, 26 deletions
diff --git a/src/lib/libcrypto/man/OCSP_REQUEST_new.3 b/src/lib/libcrypto/man/OCSP_REQUEST_new.3
index 33b7440633..deac9104d9 100644
--- a/src/lib/libcrypto/man/OCSP_REQUEST_new.3
+++ b/src/lib/libcrypto/man/OCSP_REQUEST_new.3
@@ -1,7 +1,24 @@
1.\" $OpenBSD: OCSP_REQUEST_new.3,v 1.3 2016/12/06 14:54:55 schwarze Exp $ 1.\" $OpenBSD: OCSP_REQUEST_new.3,v 1.4 2016/12/12 17:46:23 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,12 +65,18 @@
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_REQUEST_NEW 3 69.Dt OCSP_REQUEST_NEW 3
53.Os 70.Os
54.Sh NAME 71.Sh NAME
55.Nm OCSP_REQUEST_new , 72.Nm OCSP_REQUEST_new ,
56.Nm OCSP_REQUEST_free , 73.Nm OCSP_REQUEST_free ,
74.Nm OCSP_SIGNATURE_new ,
75.Nm OCSP_SIGNATURE_free ,
76.Nm OCSP_REQINFO_new ,
77.Nm OCSP_REQINFO_free ,
78.Nm OCSP_ONEREQ_new ,
79.Nm OCSP_ONEREQ_free ,
57.Nm OCSP_request_add0_id , 80.Nm OCSP_request_add0_id ,
58.Nm OCSP_request_sign , 81.Nm OCSP_request_sign ,
59.Nm OCSP_request_add1_cert , 82.Nm OCSP_request_add1_cert ,
@@ -65,9 +88,19 @@
65.Ft OCSP_REQUEST * 88.Ft OCSP_REQUEST *
66.Fn OCSP_REQUEST_new void 89.Fn OCSP_REQUEST_new void
67.Ft void 90.Ft void
68.Fo OCSP_REQUEST_free 91.Fn OCSP_REQUEST_free "OCSP_REQUEST *req"
69.Fa "OCSP_REQUEST *req" 92.Ft OCSP_SIGNATURE *
70.Fc 93.Fn OCSP_SIGNATURE_new void
94.Ft void
95.Fn OCSP_SIGNATURE_free "OCSP_SIGNATURE *signature"
96.Ft OCSP_REQINFO *
97.Fn OCSP_REQINFO_new void
98.Ft void
99.Fn OCSP_REQINFO_free "OCSP_REQINFO *reqinfo"
100.Ft OCSP_ONEREQ *
101.Fn OCSP_ONEREQ_new void
102.Ft void
103.Fn OCSP_ONEREQ_free "OCSP_ONEREQ *onereq"
71.Ft OCSP_ONEREQ * 104.Ft OCSP_ONEREQ *
72.Fo OCSP_request_add0_id 105.Fo OCSP_request_add0_id
73.Fa "OCSP_REQUEST *req" 106.Fa "OCSP_REQUEST *req"
@@ -98,14 +131,45 @@
98.Fc 131.Fc
99.Sh DESCRIPTION 132.Sh DESCRIPTION
100.Fn OCSP_REQUEST_new 133.Fn OCSP_REQUEST_new
101allocates and returns an empty 134allocates and initializes an empty
102.Vt OCSP_REQUEST 135.Vt OCSP_REQUEST
103structure. 136object, representing an ASN.1 OCSPRequest structure defined in RFC 6960.
104.Pp
105.Fn OCSP_REQUEST_free 137.Fn OCSP_REQUEST_free
106frees up the request structure 138frees
107.Fa req . 139.Fa req .
108.Pp 140.Pp
141.Fn OCSP_SIGNATURE_new
142allocates and initializes an empty
143.Vt OCSP_SIGNATURE
144object, representing an ASN.1 Signature structure defined in RFC 6960.
145Such an object is used inside
146.Vt OCSP_REQUEST .
147.Fn OCSP_SIGNATURE_free
148frees
149.Fa signature .
150.Pp
151.Fn OCSP_REQINFO_new
152allocates and initializes an empty
153.Vt OCSP_REQINFO
154object, representing an ASN.1 TBSRequest structure defined in RFC 6960.
155Such an object is used inside
156.Vt OCSP_REQUEST .
157It asks about the validity of one or more certificates.
158.Fn OCSP_REQINFO_free
159frees
160.Fa reqinfo .
161.Pp
162.Fn OCSP_ONEREQ_new
163allocates and initializes an empty
164.Vt OCSP_ONEREQ
165object, representing an ASN.1 Request structure defined in RFC 6960.
166Such objects are used inside
167.Vt OCSP_REQINFO .
168Each one asks about the validity of one certificiate.
169.Fn OCSP_ONEREQ_free
170frees
171.Fa onereq .
172.Pp
109.Fn OCSP_request_add0_id 173.Fn OCSP_request_add0_id
110adds certificate ID 174adds certificate ID
111.Fa cid 175.Fa cid
@@ -113,7 +177,7 @@ to
113.Fa req . 177.Fa req .
114It returns the 178It returns the
115.Vt OCSP_ONEREQ 179.Vt OCSP_ONEREQ
116structure added so an application can add additional extensions to the 180object added so an application can add additional extensions to the
117request. 181request.
118The 182The
119.Fa cid 183.Fa cid
@@ -148,7 +212,7 @@ after use.
148.Fn OCSP_request_onereq_count 212.Fn OCSP_request_onereq_count
149returns the total number of 213returns the total number of
150.Vt OCSP_ONEREQ 214.Vt OCSP_ONEREQ
151structures in 215objects in
152.Fa req . 216.Fa req .
153.Pp 217.Pp
154.Fn OCSP_request_onereq_get0 218.Fn OCSP_request_onereq_get0
@@ -163,28 +227,30 @@ The index value
163runs from 0 to 227runs from 0 to
164.Fn OCSP_request_onereq_count req No - 1 . 228.Fn OCSP_request_onereq_count req No - 1 .
165.Pp 229.Pp
166An
167.Vt OCSP_REQUEST
168structure contains one or more
169.Vt OCSP_ONEREQ
170structures corresponding to each certificate.
171.Pp
172.Fn OCSP_request_onereq_count 230.Fn OCSP_request_onereq_count
173and 231and
174.Fn OCSP_request_onereq_get0 232.Fn OCSP_request_onereq_get0
175are mainly used by OCSP responders. 233are mainly used by OCSP responders.
176.Sh RETURN VALUES 234.Sh RETURN VALUES
177.Fn OCSP_REQUEST_new 235.Fn OCSP_REQUEST_new ,
178returns an empty 236.Fn OCSP_SIGNATURE_new ,
179.Vt OCSP_REQUEST 237.Fn OCSP_REQINFO_new ,
180structure or 238and
239.Fn OCSP_ONEREQ_new
240return an empty
241.Vt OCSP_REQUEST ,
242.Vt OCSP_SIGNATURE ,
243.Vt OCSP_REQINFO ,
244or
245.Vt OCSP_ONEREQ
246object, respectively, or
181.Dv NULL 247.Dv NULL
182if an error occurred. 248if an error occurred.
183.Pp 249.Pp
184.Fn OCSP_request_add0_id 250.Fn OCSP_request_add0_id
185returns the 251returns the
186.Vt OCSP_ONEREQ 252.Vt OCSP_ONEREQ
187structure containing 253object containing
188.Fa cid 254.Fa cid
189or 255or
190.Dv NULL 256.Dv NULL
@@ -198,19 +264,19 @@ return 1 for success or 0 for failure.
198.Fn OCSP_request_onereq_count 264.Fn OCSP_request_onereq_count
199returns the total number of 265returns the total number of
200.Vt OCSP_ONEREQ 266.Vt OCSP_ONEREQ
201structures in 267objects in
202.Fa req . 268.Fa req .
203.Pp 269.Pp
204.Fn OCSP_request_onereq_get0 270.Fn OCSP_request_onereq_get0
205returns a pointer to an 271returns a pointer to an
206.Vt OCSP_ONEREQ 272.Vt OCSP_ONEREQ
207structure or 273object or
208.Dv NULL 274.Dv NULL
209if the index value is out of range. 275if the index value is out of range.
210.Sh EXAMPLES 276.Sh EXAMPLES
211Create an 277Create an
212.Vt OCSP_REQUEST 278.Vt OCSP_REQUEST
213structure for certificate 279object for certificate
214.Fa cert 280.Fa cert
215with issuer 281with issuer
216.Fa issuer : 282.Fa issuer :
@@ -238,3 +304,6 @@ OCSP_REQUEST_free(req);
238.Xr OCSP_resp_find_status 3 , 304.Xr OCSP_resp_find_status 3 ,
239.Xr OCSP_response_status 3 , 305.Xr OCSP_response_status 3 ,
240.Xr OCSP_sendreq_new 3 306.Xr OCSP_sendreq_new 3
307.Sh STANDARDS
308RFC 6960: X.509 Internet Public Key Infrastructure Online Certificate
309Status Protocol, section 4.1: Request Syntax