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 responder query
9       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

DESCRIPTION

31       The function OCSP_sendreq_new() returns an OCSP_CTX structure using the
32       responder io, the URL path path, the OCSP request req and with a
33       response header maximum line length of maxline. If maxline is zero a
34       default value of 4k is used. The OCSP request req may be set to NULL
35       and provided later if required.
36
37       OCSP_sendreq_nbio() performs nonblocking I/O on the OCSP request
38       context rctx. When the operation is complete it returns the response in
39       *presp.
40
41       OCSP_REQ_CTX_free() frees up the OCSP context rctx.
42
43       OCSP_set_max_response_length() sets the maximum response length for
44       rctx to len. If the response exceeds this length an error occurs. If
45       not set a default value of 100k is used.
46
47       OCSP_REQ_CTX_add1_header() adds header name with value value to the
48       context rctx. It can be called more than once to add multiple headers.
49       It MUST be called before any calls to OCSP_sendreq_nbio(). The req
50       parameter in the initial to OCSP_sendreq_new() call MUST be set to NULL
51       if additional headers are set.
52
53       OCSP_REQ_CTX_set1_req() sets the OCSP request in rctx to req. This
54       function should be called after any calls to
55       OCSP_REQ_CTX_add1_header().
56
57       OCSP_sendreq_bio() performs an OCSP request using the responder io, the
58       URL path path, and the OCSP request req with a response header maximum
59       line length 4k. It waits indefinitely on a response.
60

RETURN VALUES

62       OCSP_sendreq_new() returns a valid OCSP_REQ_CTX structure or NULL if an
63       error occurred.
64
65       OCSP_sendreq_nbio() returns 1 if the operation was completed
66       successfully, -1 if the operation should be retried and 0 if an error
67       occurred.
68
69       OCSP_REQ_CTX_add1_header() and OCSP_REQ_CTX_set1_req() return 1 for
70       success and 0 for failure.
71
72       OCSP_sendreq_bio() returns the OCSP_RESPONSE structure sent by the
73       responder or NULL if an error occurred.
74
75       OCSP_REQ_CTX_free() and OCSP_set_max_response_length() do not return
76       values.
77

NOTES

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

SEE ALSO

106       crypto(7), OCSP_cert_to_id(3), OCSP_request_add1_nonce(3),
107       OCSP_REQUEST_new(3), OCSP_resp_find_status(3), OCSP_response_status(3)
108

110       Copyright 2015-2020 The OpenSSL Project Authors. All Rights Reserved.
111
112       Licensed under the OpenSSL license (the "License").  You may not use
113       this file except in compliance with the License.  You can obtain a copy
114       in the file LICENSE in the source distribution or at
115       <https://www.openssl.org/source/license.html>.
116
117
118
1191.1.1i                            2021-01-26               OCSP_SENDREQ_NEW(3)
Impressum