summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/OCSP_response_status.3
diff options
context:
space:
mode:
authorschwarze <>2016-11-27 20:40:07 +0000
committerschwarze <>2016-11-27 20:40:07 +0000
commit2613b464a5e73671df478b07cbb7bb84c6ceea0d (patch)
tree37809d727204ff4a84215c775599f31426aed275 /src/lib/libcrypto/man/OCSP_response_status.3
parent9dfb65eab2197f3d5d42b3a11527c846bb6c584c (diff)
downloadopenbsd-2613b464a5e73671df478b07cbb7bb84c6ceea0d.tar.gz
openbsd-2613b464a5e73671df478b07cbb7bb84c6ceea0d.tar.bz2
openbsd-2613b464a5e73671df478b07cbb7bb84c6ceea0d.zip
Import OCSP documentation from OpenSSL, leaving out some stuff
that we don't have, fixing some bugs and tweaking some parts for readability. P.S. Why did some people write a HTTP client implementation and then decide that the best place to publish it might be a crypto(3) library? Oh never mind, to go easy on my sanity, i should probably stop asking such questions and just document what i find.
Diffstat (limited to 'src/lib/libcrypto/man/OCSP_response_status.3')
-rw-r--r--src/lib/libcrypto/man/OCSP_response_status.3134
1 files changed, 134 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/OCSP_response_status.3 b/src/lib/libcrypto/man/OCSP_response_status.3
new file mode 100644
index 0000000000..c6fef0dc2e
--- /dev/null
+++ b/src/lib/libcrypto/man/OCSP_response_status.3
@@ -0,0 +1,134 @@
1.\" $OpenBSD: OCSP_response_status.3,v 1.1 2016/11/27 20:40:07 schwarze Exp $
2.\" OpenSSL bb9ad09e Jun 6 00:43:05 2016 -0400
3.\"
4.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
5.\" Copyright (c) 2014, 2016 The OpenSSL Project. All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\"
11.\" 1. Redistributions of source code must retain the above copyright
12.\" notice, this list of conditions and the following disclaimer.
13.\"
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\" notice, this list of conditions and the following disclaimer in
16.\" the documentation and/or other materials provided with the
17.\" distribution.
18.\"
19.\" 3. All advertising materials mentioning features or use of this
20.\" software must display the following acknowledgment:
21.\" "This product includes software developed by the OpenSSL Project
22.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
23.\"
24.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25.\" endorse or promote products derived from this software without
26.\" prior written permission. For written permission, please contact
27.\" openssl-core@openssl.org.
28.\"
29.\" 5. Products derived from this software may not be called "OpenSSL"
30.\" nor may "OpenSSL" appear in their names without prior written
31.\" permission of the OpenSSL Project.
32.\"
33.\" 6. Redistributions of any form whatsoever must retain the following
34.\" acknowledgment:
35.\" "This product includes software developed by the OpenSSL Project
36.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)"
37.\"
38.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
42.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49.\" OF THE POSSIBILITY OF SUCH DAMAGE.
50.\"
51.Dd $Mdocdate: November 27 2016 $
52.Dt OCSP_RESPONSE_STATUS 3
53.Os
54.Sh NAME
55.Nm OCSP_response_status ,
56.Nm OCSP_response_get1_basic ,
57.Nm OCSP_response_create ,
58.Nm OCSP_RESPONSE_free
59.Nd OCSP response functions
60.Sh SYNOPSIS
61.In openssl/ocsp.h
62.Ft int
63.Fo OCSP_response_status
64.Fa "OCSP_RESPONSE *resp"
65.Fc
66.Ft OCSP_BASICRESP *
67.Fo OCSP_response_get1_basic
68.Fa "OCSP_RESPONSE *resp"
69.Fc
70.Ft OCSP_RESPONSE *
71.Fo OCSP_response_create
72.Fa "int status"
73.Fa "OCSP_BASICRESP *bs"
74.Fc
75.Ft void
76.Fo OCSP_RESPONSE_free
77.Fa "OCSP_RESPONSE *resp"
78.Fc
79.Sh DESCRIPTION
80.Fn OCSP_response_status
81returns the OCSP response status of
82.Fa resp .
83It returns one of the values:
84.Dv OCSP_RESPONSE_STATUS_SUCCESSFUL ,
85.Dv OCSP_RESPONSE_STATUS_MALFORMEDREQUEST ,
86.Dv OCSP_RESPONSE_STATUS_INTERNALERROR ,
87.Dv OCSP_RESPONSE_STATUS_TRYLATER ,
88.Dv OCSP_RESPONSE_STATUS_SIGREQUIRED ,
89or
90.Dv OCSP_RESPONSE_STATUS_UNAUTHORIZED .
91.Pp
92.Fn OCSP_response_get1_basic
93decodes and returns the
94.Vt OCSP_BASICRESP
95structure contained in
96.Fa resp .
97It is only called if the status of a response is
98.Dv OCSP_RESPONSE_STATUS_SUCCESSFUL .
99.Pp
100.Fn OCSP_response_create
101creates and returns an
102.Vt OCSP_RESPONSE
103structure for
104.Fa status
105and optionally including basic response
106.Fa bs .
107.Pp
108.Fn OCSP_RESPONSE_free
109frees up OCSP response
110.Fa resp .
111.Sh RETURN VALUES
112.Fn OCSP_response_status
113returns a status value.
114.Pp
115.Fn OCSP_response_get1_basic
116returns an
117.Vt OCSP_BASICRESP
118structure pointer or
119.Dv NULL
120if an error occurred.
121.Pp
122.Fn OCSP_response_create
123returns an
124.Vt OCSP_RESPONSE
125structure pointer or
126.Dv NULL
127if an error occurred.
128.Sh SEE ALSO
129.Xr crypto 3 ,
130.Xr OCSP_cert_to_id 3 ,
131.Xr OCSP_request_add1_nonce 3 ,
132.Xr OCSP_REQUEST_new 3 ,
133.Xr OCSP_resp_find_status 3 ,
134.Xr OCSP_sendreq_new 3