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                                        int maxline);
30

DESCRIPTION

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

RETURN VALUES

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

NOTES

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

SEE ALSO

108       crypto(7), OCSP_cert_to_id(3), OCSP_request_add1_nonce(3),
109       OCSP_REQUEST_new(3), OCSP_resp_find_status(3), OCSP_response_status(3)
110

112       Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
113
114       Licensed under the OpenSSL license (the "License").  You may not use
115       this file except in compliance with the License.  You can obtain a copy
116       in the file LICENSE in the source distribution or at
117       <https://www.openssl.org/source/license.html>.
118
119
120
1211.1.1                             2018-09-11               OCSP_SENDREQ_NEW(3)
Impressum