2
0

OCSP_sendreq_new.pod 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  1. =pod
  2. =head1 NAME
  3. OCSP_sendreq_new, OCSP_sendreq_nbio, OCSP_REQ_CTX_free,
  4. OCSP_set_max_response_length, OCSP_REQ_CTX_add1_header,
  5. OCSP_REQ_CTX_set1_req, OCSP_sendreq_bio - OCSP responder query functions
  6. =head1 SYNOPSIS
  7. #include <openssl/ocsp.h>
  8. OCSP_REQ_CTX *OCSP_sendreq_new(BIO *io, const char *path, OCSP_REQUEST *req,
  9. int maxline);
  10. int OCSP_sendreq_nbio(OCSP_RESPONSE **presp, OCSP_REQ_CTX *rctx);
  11. void OCSP_REQ_CTX_free(OCSP_REQ_CTX *rctx);
  12. void OCSP_set_max_response_length(OCSP_REQ_CTX *rctx, unsigned long len);
  13. int OCSP_REQ_CTX_add1_header(OCSP_REQ_CTX *rctx,
  14. const char *name, const char *value);
  15. int OCSP_REQ_CTX_set1_req(OCSP_REQ_CTX *rctx, OCSP_REQUEST *req);
  16. OCSP_RESPONSE *OCSP_sendreq_bio(BIO *io, const char *path, OCSP_REQUEST *req,
  17. int maxline);
  18. =head1 DESCRIPTION
  19. The function OCSP_sendreq_new() returns an B<OCSP_CTX> structure using the
  20. responder B<io>, the URL path B<path>, the OCSP request B<req> and with a
  21. response header maximum line length of B<maxline>. If B<maxline> is zero a
  22. default value of 4k is used. The OCSP request B<req> may be set to B<NULL>
  23. and provided later if required.
  24. OCSP_sendreq_nbio() performs non-blocking I/O on the OCSP request context
  25. B<rctx>. When the operation is complete it returns the response in B<*presp>.
  26. OCSP_REQ_CTX_free() frees up the OCSP context B<rctx>.
  27. OCSP_set_max_response_length() sets the maximum response length for B<rctx>
  28. to B<len>. If the response exceeds this length an error occurs. If not
  29. set a default value of 100k is used.
  30. OCSP_REQ_CTX_add1_header() adds header B<name> with value B<value> to the
  31. context B<rctx>. It can be called more than once to add multiple headers.
  32. It B<MUST> be called before any calls to OCSP_sendreq_nbio(). The B<req>
  33. parameter in the initial to OCSP_sendreq_new() call MUST be set to B<NULL> if
  34. additional headers are set.
  35. OCSP_REQ_CTX_set1_req() sets the OCSP request in B<rctx> to B<req>. This
  36. function should be called after any calls to OCSP_REQ_CTX_add1_header().
  37. OCSP_sendreq_bio() performs an OCSP request using the responder B<io>, the URL
  38. path B<path>, the OCSP request B<req> and with a response header maximum line
  39. length of B<maxline>. If B<maxline> is zero a default value of 4k is used.
  40. =head1 RETURN VALUES
  41. OCSP_sendreq_new() returns a valid B<OCSP_REQ_CTX> structure or B<NULL> if
  42. an error occurred.
  43. OCSP_sendreq_nbio() returns B<1> if the operation was completed successfully,
  44. B<-1> if the operation should be retried and B<0> if an error occurred.
  45. OCSP_REQ_CTX_add1_header() and OCSP_REQ_CTX_set1_req() return B<1> for success
  46. and B<0> for failure.
  47. OCSP_sendreq_bio() returns the B<OCSP_RESPONSE> structure sent by the
  48. responder or B<NULL> if an error occurred.
  49. OCSP_REQ_CTX_free() and OCSP_set_max_response_length() do not return values.
  50. =head1 NOTES
  51. These functions only perform a minimal HTTP query to a responder. If an
  52. application wishes to support more advanced features it should use an
  53. alternative more complete HTTP library.
  54. Currently only HTTP POST queries to responders are supported.
  55. The arguments to OCSP_sendreq_new() correspond to the components of the URL.
  56. For example if the responder URL is B<http://ocsp.com/ocspreq> the BIO
  57. B<io> should be connected to host B<ocsp.com> on port 80 and B<path>
  58. should be set to B<"/ocspreq">
  59. The headers added with OCSP_REQ_CTX_add1_header() are of the form
  60. "B<name>: B<value>" or just "B<name>" if B<value> is B<NULL>. So to add
  61. a Host header for B<ocsp.com> you would call:
  62. OCSP_REQ_CTX_add1_header(ctx, "Host", "ocsp.com");
  63. If OCSP_sendreq_nbio() indicates an operation should be retried the
  64. corresponding BIO can be examined to determine which operation (read or
  65. write) should be retried and appropriate action taken (for example a select()
  66. call on the underlying socket).
  67. OCSP_sendreq_bio() does not support retries and so cannot handle non-blocking
  68. I/O efficiently. It is retained for compatibility and its use in new
  69. applications is not recommended.
  70. =head1 SEE ALSO
  71. L<crypto(7)>,
  72. L<OCSP_cert_to_id(3)>,
  73. L<OCSP_request_add1_nonce(3)>,
  74. L<OCSP_REQUEST_new(3)>,
  75. L<OCSP_resp_find_status(3)>,
  76. L<OCSP_response_status(3)>
  77. =head1 COPYRIGHT
  78. Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
  79. Licensed under the OpenSSL license (the "License"). You may not use
  80. this file except in compliance with the License. You can obtain a copy
  81. in the file LICENSE in the source distribution or at
  82. L<https://www.openssl.org/source/license.html>.
  83. =cut