diff options
| author | Rich Salz <rsalz@akamai.com> | 2020-12-11 14:18:46 -0500 |
|---|---|---|
| committer | Dr. David von Oheimb <dev@ddvo.net> | 2020-12-15 10:36:59 +0100 |
| commit | 2f06c34b0eb658e80d82be8f7f0b54305a9cf68b (patch) | |
| tree | 955ca745a6fa6bcf3f815e6e8851d67cf1a31563 /doc | |
| parent | ecef17c367a4d11cb08c6d255d857820df26aac0 (diff) | |
Document OCSP_REQ_CTX_i2d.
Based on comments from David von Oheimb.
Reviewed-by: David von Oheimb <david.von.oheimb@siemens.com>
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/13620)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man3/OCSP_sendreq_new.pod | 29 |
1 files changed, 23 insertions, 6 deletions
diff --git a/doc/man3/OCSP_sendreq_new.pod b/doc/man3/OCSP_sendreq_new.pod index 3988eb2c01..0f9d1339c9 100644 --- a/doc/man3/OCSP_sendreq_new.pod +++ b/doc/man3/OCSP_sendreq_new.pod @@ -2,9 +2,15 @@ =head1 NAME -OCSP_sendreq_new, OCSP_sendreq_nbio, OCSP_REQ_CTX_free, -OCSP_set_max_response_length, OCSP_REQ_CTX_add1_header, -OCSP_REQ_CTX_set1_req, OCSP_sendreq_bio - OCSP responder query functions +OCSP_sendreq_new, +OCSP_sendreq_nbio, +OCSP_REQ_CTX_free, +OCSP_set_max_response_length, +OCSP_REQ_CTX_add1_header, +OCSP_sendreq_bio, +OCSP_REQ_CTX_i2d, +OCSP_REQ_CTX_set1_req +- OCSP responder query functions =head1 SYNOPSIS @@ -25,6 +31,9 @@ OCSP_REQ_CTX_set1_req, OCSP_sendreq_bio - OCSP responder query functions OCSP_RESPONSE *OCSP_sendreq_bio(BIO *io, const char *path, OCSP_REQUEST *req); + int OCSP_REQ_CTX_i2d(OCSP_REQ_CTX *rctx, const char *content_type, + const ASN1_ITEM *it, ASN1_VALUE *req); + Deprecated since OpenSSL 3.0, can be hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value, see L<openssl_user_macros(7)>: @@ -58,15 +67,23 @@ OCSP_sendreq_bio() performs an OCSP request using the responder B<io>, the URL path B<path>, the OCSP request B<req> and with a response header maximum line length 4k. It waits indefinitely on a response. -OCSP_REQ_CTX_set1_req() sets the OCSP request in B<rctx> to B<req>. This -function should be called after any calls to OCSP_REQ_CTX_add1_header(). +OCSP_REQ_CTX_i2d() sets the request context B<rctx> to have the request +B<req>, which has the ASN.1 type B<it>. +The B<content_type>, if not NULL, will be included in the HTTP request. +The function should be called after all other headers have already been added. + +OCSP_REQ_CTX_set1_req(rctx, req) is equivalent to the following: + + OCSP_REQ_CTX_i2d(rctx, "application/ocsp-request", + ASN1_ITEM_rptr(OCSP_REQUEST), (ASN1_VALUE *)req) =head1 RETURN VALUES OCSP_sendreq_new() returns a valid B<OCSP_REQ_CTX> structure or B<NULL> if an error occurred. -OCSP_sendreq_nbio(), OCSP_REQ_CTX_add1_header() and OCSP_REQ_CTX_set1_req() +OCSP_sendreq_nbio(), OCSP_REQ_CTX_add1_header(), OCSP_REQ_CTX_i2d(), +and OCSP_REQ_CTX_set1_req() return B<1> for success and B<0> for failure. OCSP_sendreq_bio() returns the B<OCSP_RESPONSE> structure sent by the |