Current Path :
/
opt
/
cpanel
/
ea-openssl11
/
share
/
man
/
man3
/
Or
Select Your Path :
Upload File :
New :
File
Dir
//opt/cpanel/ea-openssl11/share/man/man3/OCSP_sendreq_bio.3
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "OCSP_SENDREQ_NEW 3" .TH OCSP_SENDREQ_NEW 3 "2023-09-11" "1.1.1w" "OpenSSL" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "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_REQ_CTX_i2d \&\- OCSP responder query functions .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/ocsp.h> \& \& OCSP_REQ_CTX *OCSP_sendreq_new(BIO *io, const char *path, OCSP_REQUEST *req, \& int maxline); \& \& int OCSP_sendreq_nbio(OCSP_RESPONSE **presp, OCSP_REQ_CTX *rctx); \& \& void OCSP_REQ_CTX_free(OCSP_REQ_CTX *rctx); \& \& void OCSP_set_max_response_length(OCSP_REQ_CTX *rctx, unsigned long len); \& \& int OCSP_REQ_CTX_add1_header(OCSP_REQ_CTX *rctx, \& const char *name, const char *value); \& \& int OCSP_REQ_CTX_set1_req(OCSP_REQ_CTX *rctx, OCSP_REQUEST *req); \& \& 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); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The function \fIOCSP_sendreq_new()\fR returns an \fB\s-1OCSP_CTX\s0\fR structure using the responder \fBio\fR, the \s-1URL\s0 path \fBpath\fR, the \s-1OCSP\s0 request \fBreq\fR and with a response header maximum line length of \fBmaxline\fR. If \fBmaxline\fR is zero a default value of 4k is used. The \s-1OCSP\s0 request \fBreq\fR may be set to \fB\s-1NULL\s0\fR and provided later if required. .PP \&\fIOCSP_sendreq_nbio()\fR performs nonblocking I/O on the \s-1OCSP\s0 request context \&\fBrctx\fR. When the operation is complete it returns the response in \fB*presp\fR. .PP \&\fIOCSP_REQ_CTX_free()\fR frees up the \s-1OCSP\s0 context \fBrctx\fR. .PP \&\fIOCSP_set_max_response_length()\fR sets the maximum response length for \fBrctx\fR to \fBlen\fR. If the response exceeds this length an error occurs. If not set a default value of 100k is used. .PP \&\fIOCSP_REQ_CTX_add1_header()\fR adds header \fBname\fR with value \fBvalue\fR to the context \fBrctx\fR. It can be called more than once to add multiple headers. It \fB\s-1MUST\s0\fR be called before any calls to \fIOCSP_sendreq_nbio()\fR. The \fBreq\fR parameter in the initial to \fIOCSP_sendreq_new()\fR call \s-1MUST\s0 be set to \fB\s-1NULL\s0\fR if additional headers are set. .PP \&\fIOCSP_REQ_CTX_set1_req()\fR sets the \s-1OCSP\s0 request in \fBrctx\fR to \fBreq\fR. This function should be called after any calls to \fIOCSP_REQ_CTX_add1_header()\fR. OCSP_REQ_CTX_set1_req(rctx, req) is equivalent to the following: .PP .Vb 2 \& OCSP_REQ_CTX_i2d(rctx, "application/ocsp\-request", \& ASN1_ITEM_rptr(OCSP_REQUEST), (ASN1_VALUE *)req) .Ve .PP \&\fIOCSP_REQ_CTX_i2d()\fR sets the request context \fBrctx\fR to have the request \&\fBreq\fR, which has the \s-1ASN.1\s0 type \fBit\fR. The \fBcontent_type\fR, if not \s-1NULL,\s0 will be included in the \s-1HTTP\s0 request. The function should be called after all other headers have already been added. .PP \&\fIOCSP_sendreq_bio()\fR performs an \s-1OCSP\s0 request using the responder \fBio\fR, the \s-1URL\s0 path \fBpath\fR, and the \s-1OCSP\s0 request \fBreq\fR with a response header maximum line length 4k. It waits indefinitely on a response. .SH "RETURN VALUES" .IX Header "RETURN VALUES" \&\fIOCSP_sendreq_new()\fR returns a valid \fB\s-1OCSP_REQ_CTX\s0\fR structure or \fB\s-1NULL\s0\fR if an error occurred. .PP \&\fIOCSP_sendreq_nbio()\fR returns \fB1\fR if the operation was completed successfully, \&\fB\-1\fR if the operation should be retried and \fB0\fR if an error occurred. .PP \&\fIOCSP_REQ_CTX_add1_header()\fR, \fIOCSP_REQ_CTX_set1_req()\fR, and \fIOCSP_REQ_CTX_i2d()\fR return \fB1\fR for success and \fB0\fR for failure. .PP \&\fIOCSP_sendreq_bio()\fR returns the \fB\s-1OCSP_RESPONSE\s0\fR structure sent by the responder or \fB\s-1NULL\s0\fR if an error occurred. .PP \&\fIOCSP_REQ_CTX_free()\fR and \fIOCSP_set_max_response_length()\fR do not return values. .SH "NOTES" .IX Header "NOTES" These functions only perform a minimal \s-1HTTP\s0 query to a responder. If an application wishes to support more advanced features it should use an alternative more complete \s-1HTTP\s0 library. .PP Currently only \s-1HTTP POST\s0 queries to responders are supported. .PP The arguments to \fIOCSP_sendreq_new()\fR correspond to the components of the \s-1URL.\s0 For example if the responder \s-1URL\s0 is \fBhttp://ocsp.com/ocspreq\fR the \s-1BIO \&\s0\fBio\fR should be connected to host \fBocsp.com\fR on port 80 and \fBpath\fR should be set to \fB\*(L"/ocspreq\*(R"\fR .PP The headers added with \fIOCSP_REQ_CTX_add1_header()\fR are of the form "\fBname\fR: \fBvalue\fR\*(L" or just \*(R"\fBname\fR" if \fBvalue\fR is \fB\s-1NULL\s0\fR. So to add a Host header for \fBocsp.com\fR you would call: .PP .Vb 1 \& OCSP_REQ_CTX_add1_header(ctx, "Host", "ocsp.com"); .Ve .PP If \fIOCSP_sendreq_nbio()\fR indicates an operation should be retried the corresponding \s-1BIO\s0 can be examined to determine which operation (read or write) should be retried and appropriate action taken (for example a \fIselect()\fR call on the underlying socket). .PP \&\fIOCSP_sendreq_bio()\fR does not support retries and so cannot handle nonblocking I/O efficiently. It is retained for compatibility and its use in new applications is not recommended. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fIcrypto\fR\|(7), \&\fIOCSP_cert_to_id\fR\|(3), \&\fIOCSP_request_add1_nonce\fR\|(3), \&\fIOCSP_REQUEST_new\fR\|(3), \&\fIOCSP_resp_find_status\fR\|(3), \&\fIOCSP_response_status\fR\|(3) .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2015\-2020 The OpenSSL Project Authors. All Rights Reserved. .PP Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.
