Home | History | Annotate | Line # | Download | only in man 
 $NetBSD: OCSP_REQUEST_new.3,v 1.1.1.1 2023/04/18 14:19:14 christos Exp $

 Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)

 Standard preamble:
 ========================================================================
..

..


..
 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 -- \(*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\}
. 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.

 If the F register is >0, 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'.
..
.nr rF 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
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] 
.\}
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
. 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
. \" corrections for vroff
. \" for low resolution devices (crt and lpr)
\{\
. 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
.\}
 ========================================================================

 Title "OCSP_REQUEST_new 3" 
 OCSP_REQUEST_new 3 "2020-01-23" "1.1.1i" "OpenSSL"
 For nroff, turn off justification. Always turn off hyphenation; it makes
 way too many mistakes in technical documents.
.nh

 "NAME"
OCSP_REQUEST_new, OCSP_REQUEST_free, OCSP_request_add0_id, OCSP_request_sign,
OCSP_request_add1_cert, OCSP_request_onereq_count,
OCSP_request_onereq_get0 - OCSP request functions

 "LIBRARY"
libcrypto, -lcrypto

 "SYNOPSIS"
 Header "SYNOPSIS" .Vb 1
 #include <openssl/ocsp.h>
\&
 OCSP_REQUEST *OCSP_REQUEST_new(void);
 void OCSP_REQUEST_free(OCSP_REQUEST *req);
\&
 OCSP_ONEREQ *OCSP_request_add0_id(OCSP_REQUEST *req, OCSP_CERTID *cid);
\&
 int OCSP_request_sign(OCSP_REQUEST *req,
  X509 *signer, EVP_PKEY *key, const EVP_MD *dgst,
  STACK_OF(X509) *certs, unsigned long flags);
\&
 int OCSP_request_add1_cert(OCSP_REQUEST *req, X509 *cert);
\&
 int OCSP_request_onereq_count(OCSP_REQUEST *req);
 OCSP_ONEREQ *OCSP_request_onereq_get0(OCSP_REQUEST *req, int i);
.Ve

 "DESCRIPTION"
 Header "DESCRIPTION" \fBOCSP_REQUEST_new() allocates and returns an empty \s-1OCSP_REQUEST\s0 structure.


\fBOCSP_REQUEST_free() frees up the request structure req.


\fBOCSP_request_add0_id() adds certificate \s-1ID\s0 cid to req. It returns
the \s-1OCSP_ONEREQ\s0 structure added so an application can add additional
extensions to the request. The id parameter \s-1MUST NOT\s0 be freed up after
the operation.


\fBOCSP_request_sign() signs \s-1OCSP\s0 request req using certificate
\fBsigner, private key key, digest dgst and additional certificates
\fBcerts. If the flags option \s-1OCSP_NOCERTS\s0 is set then no certificates
will be included in the request.


\fBOCSP_request_add1_cert() adds certificate cert to request req. The
application is responsible for freeing up cert after use.


\fBOCSP_request_onereq_count() returns the total number of \s-1OCSP_ONEREQ\s0
structures in req.


\fBOCSP_request_onereq_get0() returns an internal pointer to the \s-1OCSP_ONEREQ\s0
contained in req of index i. The index value i runs from 0 to
OCSP_request_onereq_count(req) - 1.

 "RETURN VALUES"
 Header "RETURN VALUES" \fBOCSP_REQUEST_new() returns an empty \s-1OCSP_REQUEST\s0 structure or \s-1NULL\s0 if
an error occurred.


\fBOCSP_request_add0_id() returns the \s-1OCSP_ONEREQ\s0 structure containing cid
or \s-1NULL\s0 if an error occurred.


\fBOCSP_request_sign() and OCSP_request_add1_cert() return 1 for success and 0
for failure.


\fBOCSP_request_onereq_count() returns the total number of \s-1OCSP_ONEREQ\s0
structures in req.


\fBOCSP_request_onereq_get0() returns a pointer to an \s-1OCSP_ONEREQ\s0 structure
or \s-1NULL\s0 if the index value is out or range.

 "NOTES"
 Header "NOTES" An \s-1OCSP\s0 request structure contains one or more \s-1OCSP_ONEREQ\s0 structures
corresponding to each certificate.


\fBOCSP_request_onereq_count() and OCSP_request_onereq_get0() are mainly used by
\s-1OCSP\s0 responders.

 "EXAMPLES"
 Header "EXAMPLES" Create an \s-1OCSP_REQUEST\s0 structure for certificate cert with issuer
\fBissuer:


.Vb 2
 OCSP_REQUEST *req;
 OCSP_ID *cid;
\&
 req = OCSP_REQUEST_new();
 if (req == NULL)
  /* error */
 cid = OCSP_cert_to_id(EVP_sha1(), cert, issuer);
 if (cid == NULL)
  /* error */
\&
 if (OCSP_REQUEST_add0_id(req, cid) == NULL)
  /* error */
\&
 /* Do something with req, e.g. query responder */
\&
 OCSP_REQUEST_free(req);
.Ve

 "SEE ALSO"
 Header "SEE ALSO" \fBcrypto\|(7),
\fBOCSP_cert_to_id\|(3),
\fBOCSP_request_add1_nonce\|(3),
\fBOCSP_resp_find_status\|(3),
\fBOCSP_response_status\|(3),
\fBOCSP_sendreq_new\|(3)

 "COPYRIGHT"
 Header "COPYRIGHT" Copyright 2015-2019 The OpenSSL Project Authors. All Rights Reserved.


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>.