1OCSP_SENDREQ_NEW(3)                 OpenSSL                OCSP_SENDREQ_NEW(3)
2
3
4

NAME

6       OCSP_sendreq_new, OCSP_sendreq_nbio, OCSP_REQ_CTX_free,
7       OCSP_set_max_response_length, OCSP_REQ_CTX_add1_header,
8       OCSP_REQ_CTX_set1_req, OCSP_sendreq_bio, OCSP_REQ_CTX_i2d - OCSP
9       responder query functions
10

SYNOPSIS

12        #include <openssl/ocsp.h>
13
14        OCSP_REQ_CTX *OCSP_sendreq_new(BIO *io, const char *path, OCSP_REQUEST *req,
15                                       int maxline);
16
17        int OCSP_sendreq_nbio(OCSP_RESPONSE **presp, OCSP_REQ_CTX *rctx);
18
19        void OCSP_REQ_CTX_free(OCSP_REQ_CTX *rctx);
20
21        void OCSP_set_max_response_length(OCSP_REQ_CTX *rctx, unsigned long len);
22
23        int OCSP_REQ_CTX_add1_header(OCSP_REQ_CTX *rctx,
24                                     const char *name, const char *value);
25
26        int OCSP_REQ_CTX_set1_req(OCSP_REQ_CTX *rctx, OCSP_REQUEST *req);
27
28        OCSP_RESPONSE *OCSP_sendreq_bio(BIO *io, const char *path, OCSP_REQUEST *req);
29
30        int OCSP_REQ_CTX_i2d(OCSP_REQ_CTX *rctx, const char *content_type,
31                             const ASN1_ITEM *it, ASN1_VALUE *req);
32

DESCRIPTION

34       The function OCSP_sendreq_new() returns an OCSP_CTX structure using the
35       responder io, the URL path path, the OCSP request req and with a
36       response header maximum line length of maxline. If maxline is zero a
37       default value of 4k is used. The OCSP request req may be set to NULL
38       and provided later if required.
39
40       OCSP_sendreq_nbio() performs nonblocking I/O on the OCSP request
41       context rctx. When the operation is complete it returns the response in
42       *presp.
43
44       OCSP_REQ_CTX_free() frees up the OCSP context rctx.
45
46       OCSP_set_max_response_length() sets the maximum response length for
47       rctx to len. If the response exceeds this length an error occurs. If
48       not set a default value of 100k is used.
49
50       OCSP_REQ_CTX_add1_header() adds header name with value value to the
51       context rctx. It can be called more than once to add multiple headers.
52       It MUST be called before any calls to OCSP_sendreq_nbio(). The req
53       parameter in the initial to OCSP_sendreq_new() call MUST be set to NULL
54       if additional headers are set.
55
56       OCSP_REQ_CTX_set1_req() sets the OCSP request in rctx to req. This
57       function should be called after any calls to
58       OCSP_REQ_CTX_add1_header().  OCSP_REQ_CTX_set1_req(rctx, req) is
59       equivalent to the following:
60
61        OCSP_REQ_CTX_i2d(rctx, "application/ocsp-request",
62                               ASN1_ITEM_rptr(OCSP_REQUEST), (ASN1_VALUE *)req)
63
64       OCSP_REQ_CTX_i2d() sets the request context rctx to have the request
65       req, which has the ASN.1 type it.  The content_type, if not NULL, will
66       be included in the HTTP request.  The function should be called after
67       all other headers have already been added.
68
69       OCSP_sendreq_bio() performs an OCSP request using the responder io, the
70       URL path path, and the OCSP request req with a response header maximum
71       line length 4k. It waits indefinitely on a response.
72

RETURN VALUES

74       OCSP_sendreq_new() returns a valid OCSP_REQ_CTX structure or NULL if an
75       error occurred.
76
77       OCSP_sendreq_nbio() returns 1 if the operation was completed
78       successfully, -1 if the operation should be retried and 0 if an error
79       occurred.
80
81       OCSP_REQ_CTX_add1_header(), OCSP_REQ_CTX_set1_req(), and
82       OCSP_REQ_CTX_i2d() return 1 for success and 0 for failure.
83
84       OCSP_sendreq_bio() returns the OCSP_RESPONSE structure sent by the
85       responder or NULL if an error occurred.
86
87       OCSP_REQ_CTX_free() and OCSP_set_max_response_length() do not return
88       values.
89

NOTES

91       These functions only perform a minimal HTTP query to a responder. If an
92       application wishes to support more advanced features it should use an
93       alternative more complete HTTP library.
94
95       Currently only HTTP POST queries to responders are supported.
96
97       The arguments to OCSP_sendreq_new() correspond to the components of the
98       URL.  For example if the responder URL is http://ocsp.com/ocspreq the
99       BIO io should be connected to host ocsp.com on port 80 and path should
100       be set to "/ocspreq"
101
102       The headers added with OCSP_REQ_CTX_add1_header() are of the form
103       "name: value" or just "name" if value is NULL. So to add a Host header
104       for ocsp.com you would call:
105
106        OCSP_REQ_CTX_add1_header(ctx, "Host", "ocsp.com");
107
108       If OCSP_sendreq_nbio() indicates an operation should be retried the
109       corresponding BIO can be examined to determine which operation (read or
110       write) should be retried and appropriate action taken (for example a
111       select() call on the underlying socket).
112
113       OCSP_sendreq_bio() does not support retries and so cannot handle
114       nonblocking I/O efficiently. It is retained for compatibility and its
115       use in new applications is not recommended.
116

SEE ALSO

118       crypto(7), OCSP_cert_to_id(3), OCSP_request_add1_nonce(3),
119       OCSP_REQUEST_new(3), OCSP_resp_find_status(3), OCSP_response_status(3)
120

COPYRIGHT

122       Copyright 2015-2020 The OpenSSL Project Authors. All Rights Reserved.
123
124       Licensed under the OpenSSL license (the "License").  You may not use
125       this file except in compliance with the License.  You can obtain a copy
126       in the file LICENSE in the source distribution or at
127       <https://www.openssl.org/source/license.html>.
128
129
130
1311.1.1q                            2022-07-21               OCSP_SENDREQ_NEW(3)