libcrypto/man/OCSP_REQUEST_new.3

 $NetBSD: OCSP_REQUEST_new.3,v 1.10 2025/04/16 15:23:15 christos Exp $

 -*- mode: troff; coding: utf-8 -*-
 Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

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

..
 \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` ""
. ds C' ""
'br\}
. 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
 ========================================================================

 Title "OCSP_REQUEST_new 3"  OCSP_REQUEST_new 3 2025-02-11 3.0.16 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
 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 OCSP_REQUEST structure.

\fBOCSP_REQUEST_free() frees up the request structure req.
If the argument is NULL, nothing is done.

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

\fBOCSP_request_sign() signs OCSP request req using certificate
\fBsigner, private key key, digest dgst and additional certificates
\fBcerts. If the flags option OCSP_NOCERTS 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 OCSP_ONEREQ
structures in req.

\fBOCSP_request_onereq_get0() returns an internal pointer to the OCSP_ONEREQ
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 OCSP_REQUEST structure or NULL if
an error occurred.

\fBOCSP_request_add0_id() returns the OCSP_ONEREQ structure containing cid
or NULL 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 OCSP_ONEREQ
structures in req and -1 on error.

\fBOCSP_request_onereq_get0() returns a pointer to an OCSP_ONEREQ structure
or NULL if the index value is out or range.
 NOTES
 Header "NOTES" An OCSP request structure contains one or more OCSP_ONEREQ structures
corresponding to each certificate.

\fBOCSP_request_onereq_count() and OCSP_request_onereq_get0() are mainly used by
OCSP responders.
 EXAMPLES
 Header "EXAMPLES" Create an OCSP_REQUEST 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-2024 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
<https://www.openssl.org/source/license.html>.