doc/man3/OCSP_sendreq_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 OCSP_sendreq_new, OCSP_sendreq_nbio, OCSP_REQ_CTX_free,
   6 OCSP_set_max_response_length, OCSP_REQ_CTX_add1_header,
   7 OCSP_REQ_CTX_set1_req, OCSP_sendreq_bio - OCSP responder query functions
   8
   9 =head1 SYNOPSIS
  10
  11  #include <openssl/ocsp.h>
  12
  13  OCSP_REQ_CTX *OCSP_sendreq_new(BIO *io, const char *path,
  14                                 OCSP_REQUEST *req, int maxline);
  15
  16  int OCSP_sendreq_nbio(OCSP_RESPONSE **presp, OCSP_REQ_CTX *rctx);
  17
  18  void OCSP_REQ_CTX_free(OCSP_REQ_CTX *rctx);
  19
  20  void OCSP_set_max_response_length(OCSP_REQ_CTX *rctx,
  21                                    unsigned long len);
  22
  23  int OCSP_REQ_CTX_add1_header(OCSP_REQ_CTX *rctx,
  24                               const char *name, const char *value);
  25
  26  OCSP_RESPONSE *OCSP_sendreq_bio(BIO *io, const char *path, OCSP_REQUEST *req);
  27
  28 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
  29 B<OPENSSL_API_COMPAT> with a suitable version value, see
  30 L<openssl_user_macros(7)>:
  31
  32  int OCSP_REQ_CTX_set1_req(OCSP_REQ_CTX *rctx, const OCSP_REQUEST *req);
  33
  34 =head1 DESCRIPTION
  35
  36 The function OCSP_sendreq_new() returns an B<OCSP_CTX> structure using the
  37 responder B<io>, the URL path B<path>, the OCSP request B<req> and with a
  38 response header maximum line length of B<maxline>. If B<maxline> is zero a
  39 default value of 4k is used. The OCSP request B<req> may be set to B<NULL>
  40 and provided later if required.
  41
  42 OCSP_sendreq_nbio() performs I/O on the OCSP request context B<rctx>.
  43 When the operation is complete it returns the response in B<*presp>.
  44
  45 OCSP_REQ_CTX_free() frees up the OCSP context B<rctx>.
  46
  47 OCSP_set_max_response_length() sets the maximum response length
  48 for B<rctx> to B<len>. If the response exceeds this length an error occurs.
  49 If not set a default value of 100k is used.
  50
  51 OCSP_REQ_CTX_add1_header() adds header B<name> with value B<value> to the
  52 context B<rctx>. It can be called more than once to add multiple headers.
  53 It B<MUST> be called before any calls to OCSP_sendreq_nbio(). The B<req>
  54 parameter in the initial to OCSP_sendreq_new() call MUST be set to B<NULL> if
  55 additional headers are set.
  56
  57 OCSP_sendreq_bio() performs an OCSP request using the responder B<io>, the URL
  58 path B<path>, the OCSP request B<req> and with a response header maximum line
  59 length 4k. It waits indefinitely on a response.
  60
  61 OCSP_REQ_CTX_set1_req() sets the OCSP request in B<rctx> to B<req>. This
  62 function should be called after any calls to OCSP_REQ_CTX_add1_header().
  63
  64 =head1 RETURN VALUES
  65
  66 OCSP_sendreq_new() returns a valid B<OCSP_REQ_CTX> structure or B<NULL>
  67 if an error occurred.
  68
  69 OCSP_sendreq_nbio(), OCSP_REQ_CTX_add1_header() and OCSP_REQ_CTX_set1_req()
  70 return B<1> for success and B<0> for failure.
  71
  72 OCSP_sendreq_bio() returns the B<OCSP_RESPONSE> structure sent by the
  73 responder or B<NULL> if an error occurred.
  74
  75 OCSP_REQ_CTX_free() and OCSP_set_max_response_length()
  76 do not return values.
  77
  78 =head1 NOTES
  79
  80 These functions only perform a minimal HTTP query to a responder. If an
  81 application wishes to support more advanced features it should use an
  82 alternative more complete HTTP library.
  83
  84 Currently only HTTP POST queries to responders are supported.
  85
  86 The arguments to OCSP_sendreq_new() correspond to the components of the URL.
  87 For example if the responder URL is B<http://ocsp.com/ocspreq> the BIO
  88 B<io> should be connected to host B<ocsp.com> on port 80 and B<path>
  89 should be set to B<"/ocspreq">
  90
  91 The headers added with OCSP_REQ_CTX_add1_header() are of the form
  92 "B<name>: B<value>" or just "B<name>" if B<value> is B<NULL>. So to add
  93 a Host header for B<ocsp.com> you would call:
  94
  95  OCSP_REQ_CTX_add1_header(ctx, "Host", "ocsp.com");
  96
  97 OCSP_sendreq_bio() does not support timeout nor setting extra headers.
  98 It is retained for compatibility.
  99 Better use B<OCSP_sendreq_nbio()> instead.
 100
 101 =head1 SEE ALSO
 102
 103 L<crypto(7)>,
 104 L<OCSP_cert_to_id(3)>,
 105 L<OCSP_request_add1_nonce(3)>,
 106 L<OCSP_REQUEST_new(3)>,
 107 L<OCSP_resp_find_status(3)>,
 108 L<OCSP_response_status(3)>
 109
 110 =head1 HISTORY
 111
 112 The OCSP_REQ_CTX_set1_req() function was deprecated in OpenSSL 3.0.
 113
 114 =head1 COPYRIGHT
 115
 116 Copyright 2015-2020 The OpenSSL Project Authors. All Rights Reserved.
 117
 118 Licensed under the Apache License 2.0 (the "License").  You may not use
 119 this file except in compliance with the License.  You can obtain a copy
 120 in the file LICENSE in the source distribution or at
 121 L<https://www.openssl.org/source/license.html>.
 122
 123 =cut