.\" $NetBSD: OSSL_CMP_CTX_new.3,v 1.2 2023/05/31 19:42:43 christos Exp $
.\"
.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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 >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'.
.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 "OSSL_CMP_CTX_new 3"
.TH OSSL_CMP_CTX_new 3 "2023-05-31" "3.0.9" "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"
OSSL_CMP_CTX_new,
OSSL_CMP_CTX_free,
OSSL_CMP_CTX_reinit,
OSSL_CMP_CTX_set_option,
OSSL_CMP_CTX_get_option,
OSSL_CMP_CTX_set_log_cb,
OSSL_CMP_CTX_set_log_verbosity,
OSSL_CMP_CTX_print_errors,
OSSL_CMP_CTX_set1_serverPath,
OSSL_CMP_CTX_set1_server,
OSSL_CMP_CTX_set_serverPort,
OSSL_CMP_CTX_set1_proxy,
OSSL_CMP_CTX_set1_no_proxy,
OSSL_CMP_CTX_set_http_cb,
OSSL_CMP_CTX_set_http_cb_arg,
OSSL_CMP_CTX_get_http_cb_arg,
OSSL_CMP_transfer_cb_t,
OSSL_CMP_CTX_set_transfer_cb,
OSSL_CMP_CTX_set_transfer_cb_arg,
OSSL_CMP_CTX_get_transfer_cb_arg,
OSSL_CMP_CTX_set1_srvCert,
OSSL_CMP_CTX_set1_expected_sender,
OSSL_CMP_CTX_set0_trustedStore,
OSSL_CMP_CTX_get0_trustedStore,
OSSL_CMP_CTX_set1_untrusted,
OSSL_CMP_CTX_get0_untrusted,
OSSL_CMP_CTX_set1_cert,
OSSL_CMP_CTX_build_cert_chain,
OSSL_CMP_CTX_set1_pkey,
OSSL_CMP_CTX_set1_referenceValue,
OSSL_CMP_CTX_set1_secretValue,
OSSL_CMP_CTX_set1_recipient,
OSSL_CMP_CTX_push0_geninfo_ITAV,
OSSL_CMP_CTX_reset_geninfo_ITAVs,
OSSL_CMP_CTX_set1_extraCertsOut,
OSSL_CMP_CTX_set0_newPkey,
OSSL_CMP_CTX_get0_newPkey,
OSSL_CMP_CTX_set1_issuer,
OSSL_CMP_CTX_set1_subjectName,
OSSL_CMP_CTX_push1_subjectAltName,
OSSL_CMP_CTX_set0_reqExtensions,
OSSL_CMP_CTX_reqExtensions_have_SAN,
OSSL_CMP_CTX_push0_policy,
OSSL_CMP_CTX_set1_oldCert,
OSSL_CMP_CTX_set1_p10CSR,
OSSL_CMP_CTX_push0_genm_ITAV,
OSSL_CMP_certConf_cb_t,
OSSL_CMP_certConf_cb,
OSSL_CMP_CTX_set_certConf_cb,
OSSL_CMP_CTX_set_certConf_cb_arg,
OSSL_CMP_CTX_get_certConf_cb_arg,
OSSL_CMP_CTX_get_status,
OSSL_CMP_CTX_get0_statusString,
OSSL_CMP_CTX_get_failInfoCode,
OSSL_CMP_CTX_get0_newCert,
OSSL_CMP_CTX_get1_newChain,
OSSL_CMP_CTX_get1_caPubs,
OSSL_CMP_CTX_get1_extraCertsIn,
OSSL_CMP_CTX_set1_transactionID,
OSSL_CMP_CTX_set1_senderNonce
\&\- functions for managing the CMP client context data structure
.SH "LIBRARY"
libcrypto, -lcrypto
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& #include <openssl/cmp.h>
\&
\& OSSL_CMP_CTX *OSSL_CMP_CTX_new(OSSL_LIB_CTX *libctx, const char *propq);
\& void OSSL_CMP_CTX_free(OSSL_CMP_CTX *ctx);
\& int OSSL_CMP_CTX_reinit(OSSL_CMP_CTX *ctx);
\& int OSSL_CMP_CTX_set_option(OSSL_CMP_CTX *ctx, int opt, int val);
\& int OSSL_CMP_CTX_get_option(const OSSL_CMP_CTX *ctx, int opt);
\&
\& /* logging and error reporting: */
\& int OSSL_CMP_CTX_set_log_cb(OSSL_CMP_CTX *ctx, OSSL_CMP_log_cb_t cb);
\& #define OSSL_CMP_CTX_set_log_verbosity(ctx, level)
\& void OSSL_CMP_CTX_print_errors(const OSSL_CMP_CTX *ctx);
\&
\& /* message transfer: */
\& int OSSL_CMP_CTX_set1_serverPath(OSSL_CMP_CTX *ctx, const char *path);
\& int OSSL_CMP_CTX_set1_server(OSSL_CMP_CTX *ctx, const char *address);
\& int OSSL_CMP_CTX_set_serverPort(OSSL_CMP_CTX *ctx, int port);
\& int OSSL_CMP_CTX_set1_proxy(OSSL_CMP_CTX *ctx, const char *name);
\& int OSSL_CMP_CTX_set1_no_proxy(OSSL_CMP_CTX *ctx, const char *names);
\& int OSSL_CMP_CTX_set_http_cb(OSSL_CMP_CTX *ctx, HTTP_bio_cb_t cb);
\& int OSSL_CMP_CTX_set_http_cb_arg(OSSL_CMP_CTX *ctx, void *arg);
\& void *OSSL_CMP_CTX_get_http_cb_arg(const OSSL_CMP_CTX *ctx);
\& typedef OSSL_CMP_MSG *(*OSSL_CMP_transfer_cb_t)(OSSL_CMP_CTX *ctx,
\& const OSSL_CMP_MSG *req);
\& int OSSL_CMP_CTX_set_transfer_cb(OSSL_CMP_CTX *ctx,
\& OSSL_CMP_transfer_cb_t cb);
\& int OSSL_CMP_CTX_set_transfer_cb_arg(OSSL_CMP_CTX *ctx, void *arg);
\& void *OSSL_CMP_CTX_get_transfer_cb_arg(const OSSL_CMP_CTX *ctx);
\&
\& /* server authentication: */
\& int OSSL_CMP_CTX_set1_srvCert(OSSL_CMP_CTX *ctx, X509 *cert);
\& int OSSL_CMP_CTX_set1_expected_sender(OSSL_CMP_CTX *ctx,
\& const X509_NAME *name);
\& int OSSL_CMP_CTX_set0_trustedStore(OSSL_CMP_CTX *ctx, X509_STORE *store);
\& X509_STORE *OSSL_CMP_CTX_get0_trustedStore(const OSSL_CMP_CTX *ctx);
\& int OSSL_CMP_CTX_set1_untrusted(OSSL_CMP_CTX *ctx, STACK_OF(X509) *certs);
\& STACK_OF(X509) *OSSL_CMP_CTX_get0_untrusted(const OSSL_CMP_CTX *ctx);
\&
\& /* client authentication: */
\& int OSSL_CMP_CTX_set1_cert(OSSL_CMP_CTX *ctx, X509 *cert);
\& int OSSL_CMP_CTX_build_cert_chain(OSSL_CMP_CTX *ctx, X509_STORE *own_trusted,
\& STACK_OF(X509) *candidates);
\& int OSSL_CMP_CTX_set1_pkey(OSSL_CMP_CTX *ctx, EVP_PKEY *pkey);
\& int OSSL_CMP_CTX_set1_referenceValue(OSSL_CMP_CTX *ctx,
\& const unsigned char *ref, int len);
\& int OSSL_CMP_CTX_set1_secretValue(OSSL_CMP_CTX *ctx,
\& const unsigned char *sec, int len);
\&
\& /* CMP message header and extra certificates: */
\& int OSSL_CMP_CTX_set1_recipient(OSSL_CMP_CTX *ctx, const X509_NAME *name);
\& int OSSL_CMP_CTX_push0_geninfo_ITAV(OSSL_CMP_CTX *ctx, OSSL_CMP_ITAV *itav);
\& int OSSL_CMP_CTX_reset_geninfo_ITAVs(OSSL_CMP_CTX *ctx);
\& int OSSL_CMP_CTX_set1_extraCertsOut(OSSL_CMP_CTX *ctx,
\& STACK_OF(X509) *extraCertsOut);
\&
\& /* certificate template: */
\& int OSSL_CMP_CTX_set0_newPkey(OSSL_CMP_CTX *ctx, int priv, EVP_PKEY *pkey);
\& EVP_PKEY *OSSL_CMP_CTX_get0_newPkey(const OSSL_CMP_CTX *ctx, int priv);
\& int OSSL_CMP_CTX_set1_issuer(OSSL_CMP_CTX *ctx, const X509_NAME *name);
\& int OSSL_CMP_CTX_set1_subjectName(OSSL_CMP_CTX *ctx, const X509_NAME *name);
\& int OSSL_CMP_CTX_push1_subjectAltName(OSSL_CMP_CTX *ctx,
\& const GENERAL_NAME *name);
\& int OSSL_CMP_CTX_set0_reqExtensions(OSSL_CMP_CTX *ctx, X509_EXTENSIONS *exts);
\& int OSSL_CMP_CTX_reqExtensions_have_SAN(OSSL_CMP_CTX *ctx);
\& int OSSL_CMP_CTX_push0_policy(OSSL_CMP_CTX *ctx, POLICYINFO *pinfo);
\& int OSSL_CMP_CTX_set1_oldCert(OSSL_CMP_CTX *ctx, X509 *cert);
\& int OSSL_CMP_CTX_set1_p10CSR(OSSL_CMP_CTX *ctx, const X509_REQ *csr);
\&
\& /* misc body contents: */
\& int OSSL_CMP_CTX_push0_genm_ITAV(OSSL_CMP_CTX *ctx, OSSL_CMP_ITAV *itav);
\&
\& /* certificate confirmation: */
\& typedef int (*OSSL_CMP_certConf_cb_t)(OSSL_CMP_CTX *ctx, X509 *cert,
\& int fail_info, const char **txt);
\& int OSSL_CMP_certConf_cb(OSSL_CMP_CTX *ctx, X509 *cert, int fail_info,
\& const char **text);
\& int OSSL_CMP_CTX_set_certConf_cb(OSSL_CMP_CTX *ctx, OSSL_CMP_certConf_cb_t cb);
\& int OSSL_CMP_CTX_set_certConf_cb_arg(OSSL_CMP_CTX *ctx, void *arg);
\& void *OSSL_CMP_CTX_get_certConf_cb_arg(const OSSL_CMP_CTX *ctx);
\&
\& /* result fetching: */
\& int OSSL_CMP_CTX_get_status(const OSSL_CMP_CTX *ctx);
\& OSSL_CMP_PKIFREETEXT *OSSL_CMP_CTX_get0_statusString(const OSSL_CMP_CTX *ctx);
\& int OSSL_CMP_CTX_get_failInfoCode(const OSSL_CMP_CTX *ctx);
\&
\& X509 *OSSL_CMP_CTX_get0_newCert(const OSSL_CMP_CTX *ctx);
\& STACK_OF(X509) *OSSL_CMP_CTX_get1_newChain(const OSSL_CMP_CTX *ctx);
\& STACK_OF(X509) *OSSL_CMP_CTX_get1_caPubs(const OSSL_CMP_CTX *ctx);
\& STACK_OF(X509) *OSSL_CMP_CTX_get1_extraCertsIn(const OSSL_CMP_CTX *ctx);
\&
\& /* for testing and debugging purposes: */
\& int OSSL_CMP_CTX_set1_transactionID(OSSL_CMP_CTX *ctx,
\& const ASN1_OCTET_STRING *id);
\& int OSSL_CMP_CTX_set1_senderNonce(OSSL_CMP_CTX *ctx,
\& const ASN1_OCTET_STRING *nonce);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is the context \s-1API\s0 for using \s-1CMP\s0 (Certificate Management Protocol) with
OpenSSL.
.PP
\&\fBOSSL_CMP_CTX_new()\fR allocates an \fB\s-1OSSL_CMP_CTX\s0\fR structure associated with
the library context \fIlibctx\fR and property query string \fIpropq\fR,
both of which may be \s-1NULL\s0 to select the defaults.
It initializes the remaining fields to their default values \- for instance,
the logging verbosity is set to \s-1OSSL_CMP_LOG_INFO,\s0
the message timeout is set to 120 seconds,
and the proof-of-possession method is set to \s-1OSSL_CRMF_POPO_SIGNATURE.\s0
.PP
\&\fBOSSL_CMP_CTX_free()\fR deallocates an \s-1OSSL_CMP_CTX\s0 structure.
.PP
\&\fBOSSL_CMP_CTX_reinit()\fR prepares the given \fIctx\fR for a further transaction by
clearing the internal \s-1CMP\s0 transaction (aka session) status, PKIStatusInfo,
and any previous results (newCert, newChain, caPubs, and extraCertsIn)
from the last executed transaction.
It also clears any ITAVs that were added by \fBOSSL_CMP_CTX_push0_genm_ITAV()\fR.
All other field values (i.e., \s-1CMP\s0 options) are retained for potential re-use.
.PP
\&\fBOSSL_CMP_CTX_set_option()\fR sets the given value for the given option
(e.g., \s-1OSSL_CMP_OPT_IMPLICIT_CONFIRM\s0) in the given \s-1OSSL_CMP_CTX\s0 structure.
.PP
The following options can be set:
.IP "\fB\s-1OSSL_CMP_OPT_LOG_VERBOSITY\s0\fR" 4
.IX Item "OSSL_CMP_OPT_LOG_VERBOSITY"
.Vb 3
\& The level of severity needed for actually outputting log messages
\& due to errors, warnings, general info, debugging, etc.
\& Default is OSSL_CMP_LOG_INFO. See also L<OSSL_CMP_log_open(3)>.
.Ve
.IP "\fB\s-1OSSL_CMP_OPT_KEEP_ALIVE\s0\fR" 4
.IX Item "OSSL_CMP_OPT_KEEP_ALIVE"
.Vb 6
\& If the given value is 0 then HTTP connections are not kept open
\& after receiving a response, which is the default behavior for HTTP 1.0.
\& If the value is 1 or 2 then persistent connections are requested.
\& If the value is 2 then persistent connections are required,
\& i.e., in case the server does not grant them an error occurs.
\& The default value is 1: prefer to keep the connection open.
.Ve
.IP "\fB\s-1OSSL_CMP_OPT_MSG_TIMEOUT\s0\fR" 4
.IX Item "OSSL_CMP_OPT_MSG_TIMEOUT"
.Vb 4
\& Number of seconds a CMP request\-response message round trip
\& is allowed to take before a timeout error is returned.
\& A value <= 0 means no limitation (waiting indefinitely).
\& Default is to use the B<OSSL_CMP_OPT_TOTAL_TIMEOUT> setting.
.Ve
.IP "\fB\s-1OSSL_CMP_OPT_TOTAL_TIMEOUT\s0\fR" 4
.IX Item "OSSL_CMP_OPT_TOTAL_TIMEOUT"
.Vb 4
\& Maximum total number of seconds a transaction may take,
\& including polling etc.
\& A value <= 0 means no limitation (waiting indefinitely).
\& Default is 0.
.Ve
.IP "\fB\s-1OSSL_CMP_OPT_VALIDITY_DAYS\s0\fR" 4
.IX Item "OSSL_CMP_OPT_VALIDITY_DAYS"
.Vb 1
\& Number of days new certificates are asked to be valid for.
.Ve
.IP "\fB\s-1OSSL_CMP_OPT_SUBJECTALTNAME_NODEFAULT\s0\fR" 4
.IX Item "OSSL_CMP_OPT_SUBJECTALTNAME_NODEFAULT"
.Vb 2
\& Do not take default Subject Alternative Names
\& from the reference certificate.
.Ve
.IP "\fB\s-1OSSL_CMP_OPT_SUBJECTALTNAME_CRITICAL\s0\fR" 4
.IX Item "OSSL_CMP_OPT_SUBJECTALTNAME_CRITICAL"
.Vb 1
\& Demand that the given Subject Alternative Names are flagged as critical.
.Ve
.IP "\fB\s-1OSSL_CMP_OPT_POLICIES_CRITICAL\s0\fR" 4
.IX Item "OSSL_CMP_OPT_POLICIES_CRITICAL"
.Vb 1
\& Demand that the given policies are flagged as critical.
.Ve
.IP "\fB\s-1OSSL_CMP_OPT_POPO_METHOD\s0\fR" 4
.IX Item "OSSL_CMP_OPT_POPO_METHOD"
.Vb 1
\& Select the proof of possession method to use. Possible values are:
\&
\& OSSL_CRMF_POPO_NONE \- ProofOfPossession field omitted
\& OSSL_CRMF_POPO_RAVERIFIED \- assert that the RA has already
\& verified the PoPo
\& OSSL_CRMF_POPO_SIGNATURE \- sign a value with private key,
\& which is the default.
\& OSSL_CRMF_POPO_KEYENC \- decrypt the encrypted certificate
\& ("indirect method")
\&
\& Note that a signature\-based POPO can only be produced if a private key
\& is provided as the newPkey or client\*(Aqs pkey component of the CMP context.
.Ve
.IP "\fB\s-1OSSL_CMP_OPT_DIGEST_ALGNID\s0\fR" 4
.IX Item "OSSL_CMP_OPT_DIGEST_ALGNID"
.Vb 3
\& The NID of the digest algorithm to be used in RFC 4210\*(Aqs MSG_SIG_ALG
\& for signature\-based message protection and Proof\-of\-Possession (POPO).
\& Default is SHA256.
.Ve
.IP "\fB\s-1OSSL_CMP_OPT_OWF_ALGNID\s0\fR The \s-1NID\s0 of the digest algorithm to be used as one-way function (\s-1OWF\s0) in \s-1RFC 4210\s0's \s-1MSG_MAC_ALG\s0 for PBM-based message protection. Default is \s-1SHA256.\s0" 4
.IX Item "OSSL_CMP_OPT_OWF_ALGNID The NID of the digest algorithm to be used as one-way function (OWF) in RFC 4210's MSG_MAC_ALG for PBM-based message protection. Default is SHA256."
.PD 0
.IP "\fB\s-1OSSL_CMP_OPT_MAC_ALGNID\s0\fR The \s-1NID\s0 of the \s-1MAC\s0 algorithm to be used in \s-1RFC 4210\s0's \s-1MSG_MAC_ALG\s0 for PBM-based message protection. Default is \s-1HMAC\-SHA1\s0 as per \s-1RFC 4210.\s0" 4
.IX Item "OSSL_CMP_OPT_MAC_ALGNID The NID of the MAC algorithm to be used in RFC 4210's MSG_MAC_ALG for PBM-based message protection. Default is HMAC-SHA1 as per RFC 4210."
.IP "\fB\s-1OSSL_CMP_OPT_REVOCATION_REASON\s0\fR" 4
.IX Item "OSSL_CMP_OPT_REVOCATION_REASON"
.PD
.Vb 2
\& The reason code to be included in a Revocation Request (RR);
\& values: 0..10 (RFC 5210, 5.3.1) or \-1 for none, which is the default.
.Ve
.IP "\fB\s-1OSSL_CMP_OPT_IMPLICIT_CONFIRM\s0\fR" 4
.IX Item "OSSL_CMP_OPT_IMPLICIT_CONFIRM"
.Vb 4
\& Request server to enable implicit confirm mode, where the client
\& does not need to send confirmation upon receiving the
\& certificate. If the server does not enable implicit confirmation
\& in the return message, then confirmation is sent anyway.
.Ve
.IP "\fB\s-1OSSL_CMP_OPT_DISABLE_CONFIRM\s0\fR" 4
.IX Item "OSSL_CMP_OPT_DISABLE_CONFIRM"
.Vb 5
\& Do not confirm enrolled certificates, to cope with broken servers
\& not supporting implicit confirmation correctly.
\&B<WARNING:> This setting leads to unspecified behavior and it is meant
\&exclusively to allow interoperability with server implementations violating
\&RFC 4210.
.Ve
.IP "\fB\s-1OSSL_CMP_OPT_UNPROTECTED_SEND\s0\fR" 4
.IX Item "OSSL_CMP_OPT_UNPROTECTED_SEND"
.Vb 1
\& Send request or response messages without CMP\-level protection.
.Ve
.IP "\fB\s-1OSSL_CMP_OPT_UNPROTECTED_ERRORS\s0\fR" 4
.IX Item "OSSL_CMP_OPT_UNPROTECTED_ERRORS"
.Vb 7
\& Accept unprotected error responses which are either explicitly
\& unprotected or where protection verification failed. Applies to regular
\& error messages as well as certificate responses (IP/CP/KUP) and
\& revocation responses (RP) with rejection.
\&B<WARNING:> This setting leads to unspecified behavior and it is meant
\&exclusively to allow interoperability with server implementations violating
\&RFC 4210.
.Ve
.IP "\fB\s-1OSSL_CMP_OPT_IGNORE_KEYUSAGE\s0\fR" 4
.IX Item "OSSL_CMP_OPT_IGNORE_KEYUSAGE"
.Vb 3
\& Ignore key usage restrictions in the signer\*(Aqs certificate when
\& validating signature\-based protection in received CMP messages.
\& Else, \*(AqdigitalSignature\*(Aq must be allowed by CMP signer certificates.
.Ve
.IP "\fB\s-1OSSL_CMP_OPT_PERMIT_TA_IN_EXTRACERTS_FOR_IR\s0\fR" 4
.IX Item "OSSL_CMP_OPT_PERMIT_TA_IN_EXTRACERTS_FOR_IR"
.Vb 2
\& Allow retrieving a trust anchor from extraCerts and using that
\& to validate the certificate chain of an IP message.
.Ve
.PP
\&\fBOSSL_CMP_CTX_get_option()\fR reads the current value of the given option
(e.g., \s-1OSSL_CMP_OPT_IMPLICIT_CONFIRM\s0) from the given \s-1OSSL_CMP_CTX\s0 structure.
.PP
\&\fBOSSL_CMP_CTX_set_log_cb()\fR sets in \fIctx\fR the callback function \fIcb\fR
for handling error queue entries and logging messages.
When \fIcb\fR is \s-1NULL\s0 errors are printed to \s-1STDERR\s0 (if available, else ignored)
any log messages are ignored.
Alternatively, \fBOSSL_CMP_log_open\fR\|(3) may be used to direct logging to \s-1STDOUT.\s0
.PP
\&\fBOSSL_CMP_CTX_set_log_verbosity()\fR is a macro setting the
\&\s-1OSSL_CMP_OPT_LOG_VERBOSITY\s0 context option to the given level.
.PP
\&\fBOSSL_CMP_CTX_print_errors()\fR outputs any entries in the OpenSSL error queue. It
is similar to \fBERR_print_errors_cb\fR\|(3) but uses the \s-1CMP\s0 log callback function
if set in the \fIctx\fR for uniformity with \s-1CMP\s0 logging if given. Otherwise it uses
\&\fBERR_print_errors\fR\|(3) to print to \s-1STDERR\s0 (unless \s-1OPENSSL_NO_STDIO\s0 is defined).
.PP
\&\fBOSSL_CMP_CTX_set1_serverPath()\fR sets the \s-1HTTP\s0 path of the \s-1CMP\s0 server on the host,
also known as \*(L"\s-1CMP\s0 alias\*(R".
The default is \f(CW\*(C`/\*(C'\fR.
.PP
\&\fBOSSL_CMP_CTX_set1_server()\fR sets the given server \fIaddress\fR
(which may be a hostname or \s-1IP\s0 address or \s-1NULL\s0) in the given \fIctx\fR.
.PP
\&\fBOSSL_CMP_CTX_set_serverPort()\fR sets the port of the \s-1CMP\s0 server to connect to.
If not used or the \fIport\fR argument is 0
the default port applies, which is 80 for \s-1HTTP\s0 and 443 for \s-1HTTPS.\s0
.PP
\&\fBOSSL_CMP_CTX_set1_proxy()\fR sets the \s-1HTTP\s0 proxy to be used for connecting to
the given \s-1CMP\s0 server unless overruled by any \*(L"no_proxy\*(R" settings (see below).
If \s-1TLS\s0 is not used this defaults to the value of
the environment variable \f(CW\*(C`http_proxy\*(C'\fR if set, else \f(CW\*(C`HTTP_PROXY\*(C'\fR.
Otherwise defaults to the value of \f(CW\*(C`https_proxy\*(C'\fR if set, else \f(CW\*(C`HTTPS_PROXY\*(C'\fR.
An empty proxy string specifies not to use a proxy.
Else the format is \f(CW\*(C`[http[s]://]address[:port][/path]\*(C'\fR,
where any path given is ignored.
The default port number is 80, or 443 in case \f(CW\*(C`https:\*(C'\fR is given.
.PP
\&\fBOSSL_CMP_CTX_set1_no_proxy()\fR sets the list of server hostnames not to use
an \s-1HTTP\s0 proxy for. The names may be separated by commas and/or whitespace.
Defaults to the environment variable \f(CW\*(C`no_proxy\*(C'\fR if set, else \f(CW\*(C`NO_PROXY\*(C'\fR.
.PP
\&\fBOSSL_CMP_CTX_set_http_cb()\fR sets the optional \s-1BIO\s0 connect/disconnect callback
function, which has the prototype
.PP
.Vb 1
\& typedef BIO *(*HTTP_bio_cb_t) (BIO *bio, void *ctx, int connect, int detail);
.Ve
.PP
The callback may modify the \fIbio\fR provided by \fBOSSL_CMP_MSG_http_perform\fR\|(3),
whereby it may make use of a custom defined argument \fIctx\fR
stored in the \s-1OSSL_CMP_CTX\s0 by means of \fBOSSL_CMP_CTX_set_http_cb_arg()\fR.
During connection establishment, just after calling \fBBIO_do_connect_retry()\fR,
the function is invoked with the \fIconnect\fR argument being 1 and the \fIdetail\fR
argument being 1 if \s-1HTTPS\s0 is requested, i.e., \s-1SSL/TLS\s0 should be enabled. On
disconnect \fIconnect\fR is 0 and \fIdetail\fR is 1 in case no error occurred, else 0.
For instance, on connect the function may prepend a \s-1TLS BIO\s0 to implement \s-1HTTPS\s0;
after disconnect it may do some diagnostic output and/or specific cleanup.
The function should return \s-1NULL\s0 to indicate failure.
After disconnect the modified \s-1BIO\s0 will be deallocated using \fBBIO_free_all()\fR.
.PP
\&\fBOSSL_CMP_CTX_set_http_cb_arg()\fR sets an argument, respectively a pointer to
a structure containing arguments,
optionally to be used by the http connect/disconnect callback function.
\&\fIarg\fR is not consumed, and it must therefore explicitly be freed when not
needed any more. \fIarg\fR may be \s-1NULL\s0 to clear the entry.
.PP
\&\fBOSSL_CMP_CTX_get_http_cb_arg()\fR gets the argument, respectively the pointer to a
structure containing arguments, previously set by
\&\fBOSSL_CMP_CTX_set_http_cb_arg()\fR or \s-1NULL\s0 if unset.
.PP
\&\fBOSSL_CMP_CTX_set_transfer_cb()\fR sets the message transfer callback function,
which has the type
.PP
.Vb 2
\& typedef OSSL_CMP_MSG *(*OSSL_CMP_transfer_cb_t) (OSSL_CMP_CTX *ctx,
\& const OSSL_CMP_MSG *req);
.Ve
.PP
Returns 1 on success, 0 on error.
.PP
Default is \s-1NULL,\s0 which implies the use of \fBOSSL_CMP_MSG_http_perform\fR\|(3).
The callback should send the \s-1CMP\s0 request message it obtains via the \fIreq\fR
parameter and on success return the response, else it must return \s-1NULL.\s0
The transfer callback may make use of a custom defined argument stored in
the ctx by means of \fBOSSL_CMP_CTX_set_transfer_cb_arg()\fR, which may be retrieved
again through \fBOSSL_CMP_CTX_get_transfer_cb_arg()\fR.
.PP
\&\fBOSSL_CMP_CTX_set_transfer_cb_arg()\fR sets an argument, respectively a pointer to a
structure containing arguments, optionally to be used by the transfer callback.
\&\fIarg\fR is not consumed, and it must therefore explicitly be freed when not
needed any more. \fIarg\fR may be \s-1NULL\s0 to clear the entry.
.PP
\&\fBOSSL_CMP_CTX_get_transfer_cb_arg()\fR gets the argument, respectively the pointer
to a structure containing arguments, previously set by
\&\fBOSSL_CMP_CTX_set_transfer_cb_arg()\fR or \s-1NULL\s0 if unset.
.PP
\&\fBOSSL_CMP_CTX_set1_srvCert()\fR sets the expected server cert in \fIctx\fR and trusts
it directly (even if it is expired) when verifying signed response messages.
This pins the accepted \s-1CMP\s0 server and
results in ignoring whatever may be set using \fBOSSL_CMP_CTX_set0_trustedStore()\fR.
Any previously set value is freed.
The \fIcert\fR argument may be \s-1NULL\s0 to clear the entry.
If set, the subject of the certificate is also used
as default value for the recipient of \s-1CMP\s0 requests
and as default value for the expected sender of \s-1CMP\s0 responses.
.PP
\&\fBOSSL_CMP_CTX_set1_expected_sender()\fR sets the Distinguished Name (\s-1DN\s0)
expected in the sender field of incoming \s-1CMP\s0 messages.
Defaults to the subject of the pinned server certificate, if any.
This can be used to make sure that only a particular entity is accepted as
\&\s-1CMP\s0 message signer, and attackers are not able to use arbitrary certificates
of a trusted \s-1PKI\s0 hierarchy to fraudulently pose as \s-1CMP\s0 server.
Note that this gives slightly more freedom than \fBOSSL_CMP_CTX_set1_srvCert()\fR,
which pins the server to the holder of a particular certificate, while the
expected sender name will continue to match after updates of the server cert.
.PP
\&\fBOSSL_CMP_CTX_set0_trustedStore()\fR
sets in the \s-1CMP\s0 context \fIctx\fR the certificate store of type X509_STORE
containing trusted certificates, typically of root CAs.
This is ignored when a certificate is pinned using \fBOSSL_CMP_CTX_set1_srvCert()\fR.
The store may also hold CRLs and a certificate verification callback function
used for signature-based peer authentication.
Any store entry already set before is freed.
When given a \s-1NULL\s0 parameter the entry is cleared.
.PP
\&\fBOSSL_CMP_CTX_get0_trustedStore()\fR
extracts from the \s-1CMP\s0 context \fIctx\fR the pointer to the currently set
certificate store containing trust anchors etc., or an empty store if unset.
.PP
\&\fBOSSL_CMP_CTX_set1_untrusted()\fR sets up a list of non-trusted certificates
of intermediate CAs that may be useful for path construction for the own \s-1CMP\s0
signer certificate, for the own \s-1TLS\s0 certificate (if any), when verifying peer
\&\s-1CMP\s0 protection certificates, and when verifying newly enrolled certificates.
The reference counts of those certificates handled successfully are increased.
.PP
OSSL_CMP_CTX_get0_untrusted(\s-1OSSL_CMP_CTX\s0 *ctx) returns a pointer to the
list of untrusted certs, which may be empty if unset.
.PP
\&\fBOSSL_CMP_CTX_set1_cert()\fR sets the \s-1CMP\s0 signer certificate
related to the private key used for \s-1CMP\s0 message protection.
Therefore the public key of this \fIcert\fR must correspond to
the private key set before or thereafter via \fBOSSL_CMP_CTX_set1_pkey()\fR.
When using signature-based protection of \s-1CMP\s0 request messages
this \s-1CMP\s0 signer certificate will be included first in the extraCerts field.
It serves as fallback reference certificate, see \fBOSSL_CMP_CTX_set1_oldCert()\fR.
The subject of this \fIcert\fR will be used as the sender field of outgoing
messages, while the subject of any cert set via \fBOSSL_CMP_CTX_set1_oldCert()\fR
and any value set via \fBOSSL_CMP_CTX_set1_subjectName()\fR are used as fallback.
.PP
The \fIcert\fR argument may be \s-1NULL\s0 to clear the entry.
.PP
\&\fBOSSL_CMP_CTX_build_cert_chain()\fR builds a certificate chain for the \s-1CMP\s0 signer
certificate previously set in the \fIctx\fR. It adds the optional \fIcandidates\fR,
a list of intermediate \s-1CA\s0 certs that may already constitute the targeted chain,
to the untrusted certs that may already exist in the \fIctx\fR.
Then the function uses this augmented set of certs for chain construction.
If \fIown_trusted\fR is \s-1NULL\s0 it builds the chain as far down as possible and
ignores any verification errors. Else the \s-1CMP\s0 signer certificate must be
verifiable where the chain reaches a trust anchor contained in \fIown_trusted\fR.
On success the function stores the resulting chain in \fIctx\fR
for inclusion in the extraCerts field of signature-protected messages.
Calling this function is optional; by default a chain construction
is performed on demand that is equivalent to calling this function
with the \fIcandidates\fR and \fIown_trusted\fR arguments being \s-1NULL.\s0
.PP
\&\fBOSSL_CMP_CTX_set1_pkey()\fR sets the client's private key corresponding to the
\&\s-1CMP\s0 signer certificate set via \fBOSSL_CMP_CTX_set1_cert()\fR.
This key is used create signature-based protection (protectionAlg = \s-1MSG_SIG_ALG\s0)
of outgoing messages
unless a \s-1PBM\s0 secret has been set via \fBOSSL_CMP_CTX_set1_secretValue()\fR.
The \fIpkey\fR argument may be \s-1NULL\s0 to clear the entry.
.PP
\&\fBOSSL_CMP_CTX_set1_secretValue()\fR sets the byte string \fIsec\fR with length \fIlen\fR
as \s-1PBM\s0 secret in the given \fIctx\fR or clears it if the \fIsec\fR argument is \s-1NULL.\s0
If present, this secret is used to create PBM-based protection of outgoing
messages and to verify any PBM-based protection of incoming messages
(protectionAlg = \s-1MSG_MAC_ALG\s0). \s-1PBM\s0 stands for Password-Based \s-1MAC.\s0
PBM-based protection takes precedence over signature-based protection.
.PP
\&\fBOSSL_CMP_CTX_set1_referenceValue()\fR sets the given referenceValue \fIref\fR with
length \fIlen\fR in the given \fIctx\fR or clears it if the \fIref\fR argument is \s-1NULL.\s0
According to \s-1RFC 4210\s0 section 5.1.1, if no value for the sender field in
\&\s-1CMP\s0 message headers can be determined (i.e., no \s-1CMP\s0 signer certificate
and no subject \s-1DN\s0 is set via \fBOSSL_CMP_CTX_set1_subjectName()\fR
then the sender field will contain the NULL-DN
and the senderKID field of the \s-1CMP\s0 message header must be set.
When signature-based protection is used the senderKID will be set to
the subjectKeyIdentifier of the \s-1CMP\s0 signer certificate as far as present.
If not present or when PBM-based protection is used
the \fIref\fR value is taken as the fallback value for the senderKID.
.PP
\&\fBOSSL_CMP_CTX_set1_recipient()\fR sets the recipient name that will be used in the
PKIHeader of \s-1CMP\s0 request messages, i.e. the X509 name of the (\s-1CA\s0) server.
.PP
The recipient field in the header of a \s-1CMP\s0 message is mandatory.
If not given explicitly the recipient is determined in the following order:
the subject of the \s-1CMP\s0 server certificate set using \fBOSSL_CMP_CTX_set1_srvCert()\fR,
the value set using \fBOSSL_CMP_CTX_set1_issuer()\fR,
the issuer of the certificate set using \fBOSSL_CMP_CTX_set1_oldCert()\fR,
the issuer of the \s-1CMP\s0 signer certificate,
as far as any of those is present, else the NULL-DN as last resort.
.PP
\&\fBOSSL_CMP_CTX_push0_geninfo_ITAV()\fR adds \fIitav\fR to the stack in the \fIctx\fR to be
added to the GeneralInfo field of the \s-1CMP\s0 PKIMessage header of a request
message sent with this context.
.PP
\&\fBOSSL_CMP_CTX_reset_geninfo_ITAVs()\fR
clears any ITAVs that were added by \fBOSSL_CMP_CTX_push0_geninfo_ITAV()\fR.
.PP
\&\fBOSSL_CMP_CTX_set1_extraCertsOut()\fR sets the stack of extraCerts that will be
sent to remote.
.PP
\&\fBOSSL_CMP_CTX_set0_newPkey()\fR can be used to explicitly set the given \s-1EVP_PKEY\s0
structure as the private or public key to be certified in the \s-1CMP\s0 context.
The \fIpriv\fR parameter must be 0 if and only if the given key is a public key.
.PP
\&\fBOSSL_CMP_CTX_get0_newPkey()\fR gives the key to use for certificate enrollment
dependent on fields of the \s-1CMP\s0 context structure:
the newPkey (which may be a private or public key) if present,
else the public key in the p10CSR if present, else the client's private key.
If the \fIpriv\fR parameter is not 0 and the selected key does not have a
private component then \s-1NULL\s0 is returned.
.PP
\&\fBOSSL_CMP_CTX_set1_issuer()\fR sets the name of the intended issuer that
will be set in the CertTemplate, i.e., the X509 name of the \s-1CA\s0 server.
.PP
\&\fBOSSL_CMP_CTX_set1_subjectName()\fR sets the subject \s-1DN\s0 that will be used in
the CertTemplate structure when requesting a new cert. For Key Update Requests
(\s-1KUR\s0), it defaults to the subject \s-1DN\s0 of the reference certificate,
see \fBOSSL_CMP_CTX_set1_oldCert()\fR. This default is used for Initialization
Requests (\s-1IR\s0) and Certification Requests (\s-1CR\s0) only if no SANs are set.
The \fIsubjectName\fR is also used as fallback for the sender field
of outgoing \s-1CMP\s0 messages if no reference certificate is available.
.PP
\&\fBOSSL_CMP_CTX_push1_subjectAltName()\fR adds the given X509 name to the list of
alternate names on the certificate template request. This cannot be used if
any Subject Alternative Name extension is set via
\&\fBOSSL_CMP_CTX_set0_reqExtensions()\fR.
By default, unless \fB\s-1OSSL_CMP_OPT_SUBJECTALTNAME_NODEFAULT\s0\fR has been set,
the Subject Alternative Names are copied from the reference certificate,
see \fBOSSL_CMP_CTX_set1_oldCert()\fR.
If set and the subject \s-1DN\s0 is not set with \fBOSSL_CMP_CTX_set1_subjectName()\fR then
the certificate template of an \s-1IR\s0 and \s-1CR\s0 will not be filled with the default
subject \s-1DN\s0 from the reference certificate.
If a subject \s-1DN\s0 is desired it needs to be set explicitly with
\&\fBOSSL_CMP_CTX_set1_subjectName()\fR.
.PP
\&\fBOSSL_CMP_CTX_set0_reqExtensions()\fR sets the X.509v3 extensions to be used in
\&\s-1IR/CR/KUR.\s0
.PP
\&\fBOSSL_CMP_CTX_reqExtensions_have_SAN()\fR returns 1 if the context contains
a Subject Alternative Name extension, else 0 or \-1 on error.
.PP
\&\fBOSSL_CMP_CTX_push0_policy()\fR adds the certificate policy info object
to the X509_EXTENSIONS of the requested certificate template.
.PP
\&\fBOSSL_CMP_CTX_set1_oldCert()\fR sets the old certificate to be updated in
Key Update Requests (\s-1KUR\s0) or to be revoked in Revocation Requests (\s-1RR\s0).
It must be given for \s-1RR,\s0 else it defaults to the \s-1CMP\s0 signer certificate.
The \fIreference certificate\fR determined in this way, if any, is also used for
deriving default subject \s-1DN,\s0 public key, Subject Alternative Names, and the
default issuer entry in the requested certificate template of \s-1IR/CR/KUR.\s0
The subject of the reference certificate is used as the sender field value
in \s-1CMP\s0 message headers.
Its issuer is used as default recipient in \s-1CMP\s0 message headers.
.PP
\&\fBOSSL_CMP_CTX_set1_p10CSR()\fR sets the PKCS#10 \s-1CSR\s0 to use in P10CR messages.
If such a \s-1CSR\s0 is provided, its subject, public key, and extension fields are
also used as fallback values for the certificate template of \s-1IR/CR/KUR\s0 messages.
.PP
\&\fBOSSL_CMP_CTX_push0_genm_ITAV()\fR adds \fIitav\fR to the stack in the \fIctx\fR which
will be the body of a General Message sent with this context.
.PP
\&\fBOSSL_CMP_certConf_cb()\fR is the default certificate confirmation callback function.
If the callback argument is not \s-1NULL\s0 it must point to a trust store.
In this case the function checks that the newly enrolled certificate can be
verified using this trust store and untrusted certificates from the \fIctx\fR,
which have been augmented by the list of extraCerts received.
During this verification, any certificate status checking is disabled.
If the callback argument is \s-1NULL\s0 the function tries building an approximate
chain as far as possible using the same untrusted certificates from the \fIctx\fR,
and if this fails it takes the received extraCerts as fallback.
The resulting cert chain can be retrieved using \fBOSSL_CMP_CTX_get1_newChain()\fR.
.PP
\&\fBOSSL_CMP_CTX_set_certConf_cb()\fR sets the callback used for evaluating the newly
enrolled certificate before the library sends, depending on its result,
a positive or negative certConf message to the server. The callback has type
.PP
.Vb 2
\& typedef int (*OSSL_CMP_certConf_cb_t) (OSSL_CMP_CTX *ctx, X509 *cert,
\& int fail_info, const char **txt);
.Ve
.PP
and should inspect the certificate it obtains via the \fIcert\fR parameter and may
overrule the pre-decision given in the \fIfail_info\fR and \fI*txt\fR parameters.
If it accepts the certificate it must return 0, indicating success. Else it must
return a bit field reflecting PKIFailureInfo with at least one failure bit and
may set the \fI*txt\fR output parameter to point to a string constant with more
detail. The transfer callback may make use of a custom defined argument stored
in the \fIctx\fR by means of \fBOSSL_CMP_CTX_set_certConf_cb_arg()\fR, which may be
retrieved again through \fBOSSL_CMP_CTX_get_certConf_cb_arg()\fR.
Typically, the callback will check at least that the certificate can be verified
using a set of trusted certificates.
It also could compare the subject \s-1DN\s0 and other fields of the newly
enrolled certificate with the certificate template of the request.
.PP
\&\fBOSSL_CMP_CTX_set_certConf_cb_arg()\fR sets an argument, respectively a pointer to a
structure containing arguments, optionally to be used by the certConf callback.
\&\fIarg\fR is not consumed, and it must therefore explicitly be freed when not
needed any more. \fIarg\fR may be \s-1NULL\s0 to clear the entry.
.PP
\&\fBOSSL_CMP_CTX_get_certConf_cb_arg()\fR gets the argument, respectively the pointer
to a structure containing arguments, previously set by
\&\fBOSSL_CMP_CTX_set_certConf_cb_arg()\fR, or \s-1NULL\s0 if unset.
.PP
\&\fBOSSL_CMP_CTX_get_status()\fR returns for client contexts the PKIstatus from
the last received CertRepMessage or Revocation Response or error message:
=item \fBOSSL_CMP_PKISTATUS_accepted\fR on sucessful receipt of a \s-1GENP\s0 message:
.IP "\fBOSSL_CMP_PKISTATUS_request\fR" 4
.IX Item "OSSL_CMP_PKISTATUS_request"
if an \s-1IR/CR/KUR/RR/GENM\s0 request message could not be produced,
.IP "\fBOSSL_CMP_PKISTATUS_trans\fR" 4
.IX Item "OSSL_CMP_PKISTATUS_trans"
on a transmission error or transaction error for this type of request, and
.IP "\fBOSSL_CMP_PKISTATUS_unspecified\fR" 4
.IX Item "OSSL_CMP_PKISTATUS_unspecified"
if no such request was attempted or \fBOSSL_CMP_CTX_reinit()\fR has been called.
.PP
For server contexts it returns
\&\fBOSSL_CMP_PKISTATUS_trans\fR if a transaction is open,
otherwise \fBOSSL_CMP_PKISTATUS_unspecified\fR.
.PP
\&\fBOSSL_CMP_CTX_get0_statusString()\fR returns the statusString from the last received
CertRepMessage or Revocation Response or error message, or \s-1NULL\s0 if unset.
.PP
\&\fBOSSL_CMP_CTX_get_failInfoCode()\fR returns the error code from the failInfo field
of the last received CertRepMessage or Revocation Response or error message,
or \-1 if no such response was received or \fBOSSL_CMP_CTX_reinit()\fR has been called.
This is a bit field and the flags for it are specified in the header file
\&\fI<openssl/cmp.h>\fR.
The flags start with \s-1OSSL_CMP_CTX_FAILINFO,\s0 for example:
OSSL_CMP_CTX_FAILINFO_badAlg. Returns \-1 if the failInfoCode field is unset.
.PP
\&\fBOSSL_CMP_CTX_get0_newCert()\fR returns the pointer to the newly obtained
certificate in case it is available, else \s-1NULL.\s0
.PP
\&\fBOSSL_CMP_CTX_get1_newChain()\fR returns a pointer to a duplicate of the stack of
X.509 certificates computed by \fBOSSL_CMP_certConf_cb()\fR (if this function has
been called) on the last received certificate response message \s-1IP/CP/KUP.\s0
.PP
\&\fBOSSL_CMP_CTX_get1_caPubs()\fR returns a pointer to a duplicate of the list of
X.509 certificates in the caPubs field of the last received certificate
response message (of type \s-1IP, CP,\s0 or \s-1KUP\s0),
or an empty stack if no caPubs have been received in the current transaction.
.PP
\&\fBOSSL_CMP_CTX_get1_extraCertsIn()\fR returns a pointer to a duplicate of the list
of X.509 certificates contained in the extraCerts field of the last received
response message (except for pollRep and PKIConf), or
an empty stack if no extraCerts have been received in the current transaction.
.PP
\&\fBOSSL_CMP_CTX_set1_transactionID()\fR sets the given transaction \s-1ID\s0 in the given
\&\s-1OSSL_CMP_CTX\s0 structure.
.PP
\&\fBOSSL_CMP_CTX_set1_senderNonce()\fR stores the last sent sender \fInonce\fR in
the \fIctx\fR. This will be used to validate the recipNonce in incoming messages.
.SH "NOTES"
.IX Header "NOTES"
\&\s-1CMP\s0 is defined in \s-1RFC 4210\s0 (and \s-1CRMF\s0 in \s-1RFC 4211\s0).
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
\&\fBOSSL_CMP_CTX_free()\fR and \fBOSSL_CMP_CTX_print_errors()\fR do not return anything.
.PP
\&\fBOSSL_CMP_CTX_new()\fR,
\&\fBOSSL_CMP_CTX_get_http_cb_arg()\fR,
\&\fBOSSL_CMP_CTX_get_transfer_cb_arg()\fR,
\&\fBOSSL_CMP_CTX_get0_trustedStore()\fR,
\&\fBOSSL_CMP_CTX_get0_untrusted()\fR,
\&\fBOSSL_CMP_CTX_get0_newPkey()\fR,
\&\fBOSSL_CMP_CTX_get_certConf_cb_arg()\fR,
\&\fBOSSL_CMP_CTX_get0_statusString()\fR,
\&\fBOSSL_CMP_CTX_get0_newCert()\fR,
\&\fBOSSL_CMP_CTX_get0_newChain()\fR,
\&\fBOSSL_CMP_CTX_get1_caPubs()\fR, and
\&\fBOSSL_CMP_CTX_get1_extraCertsIn()\fR
return the intended pointer value as described above or \s-1NULL\s0 on error.
.PP
\&\fBOSSL_CMP_CTX_get_option()\fR,
\&\fBOSSL_CMP_CTX_reqExtensions_have_SAN()\fR,
\&\fBOSSL_CMP_CTX_get_status()\fR, and
\&\fBOSSL_CMP_CTX_get_failInfoCode()\fR
return the intended value as described above or \-1 on error.
.PP
\&\fBOSSL_CMP_certConf_cb()\fR returns \fIfail_info\fR if it is not equal to 0,
else 0 on successful validation,
or else a bit field with the \fBOSSL_CMP_PKIFAILUREINFO_incorrectData\fR bit set.
.PP
All other functions, including \fBOSSL_CMP_CTX_reinit()\fR
and \fBOSSL_CMP_CTX_reset_geninfo_ITAVs()\fR,
return 1 on success, 0 on error.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
The following code omits error handling.
.PP
Set up a \s-1CMP\s0 client context for sending requests and verifying responses:
.PP
.Vb 5
\& cmp_ctx = OSSL_CMP_CTX_new();
\& OSSL_CMP_CTX_set1_server(cmp_ctx, name_or_address);
\& OSSL_CMP_CTX_set1_serverPort(cmp_ctx, port_string);
\& OSSL_CMP_CTX_set1_serverPath(cmp_ctx, path_or_alias);
\& OSSL_CMP_CTX_set0_trustedStore(cmp_ctx, ts);
.Ve
.PP
Set up client credentials for password-based protection (\s-1PBM\s0):
.PP
.Vb 2
\& OSSL_CMP_CTX_set1_referenceValue(cmp_ctx, ref, ref_len);
\& OSSL_CMP_CTX_set1_secretValue(cmp_ctx, sec, sec_len);
.Ve
.PP
Set up the details for certificate requests:
.PP
.Vb 2
\& OSSL_CMP_CTX_set1_subjectName(cmp_ctx, name);
\& OSSL_CMP_CTX_set0_newPkey(cmp_ctx, 1, initialKey);
.Ve
.PP
Perform an Initialization Request transaction:
.PP
.Vb 1
\& initialCert = OSSL_CMP_exec_IR_ses(cmp_ctx);
.Ve
.PP
Reset the transaction state of the \s-1CMP\s0 context and the credentials:
.PP
.Vb 3
\& OSSL_CMP_CTX_reinit(cmp_ctx);
\& OSSL_CMP_CTX_set1_referenceValue(cmp_ctx, NULL, 0);
\& OSSL_CMP_CTX_set1_secretValue(cmp_ctx, NULL, 0);
.Ve
.PP
Perform a Certification Request transaction, making use of the new credentials:
.PP
.Vb 4
\& OSSL_CMP_CTX_set1_cert(cmp_ctx, initialCert);
\& OSSL_CMP_CTX_set1_pkey(cmp_ctx, initialKey);
\& OSSL_CMP_CTX_set0_newPkey(cmp_ctx, 1, curentKey);
\& currentCert = OSSL_CMP_exec_CR_ses(cmp_ctx);
.Ve
.PP
Perform a Key Update Request, signed using the cert (and key) to be updated:
.PP
.Vb 6
\& OSSL_CMP_CTX_reinit(cmp_ctx);
\& OSSL_CMP_CTX_set1_cert(cmp_ctx, currentCert);
\& OSSL_CMP_CTX_set1_pkey(cmp_ctx, currentKey);
\& OSSL_CMP_CTX_set0_newPkey(cmp_ctx, 1, updatedKey);
\& currentCert = OSSL_CMP_exec_KUR_ses(cmp_ctx);
\& currentKey = updatedKey;
.Ve
.PP
Perform a General Message transaction including, as an example,
the id-it-signKeyPairTypes \s-1OID\s0 and prints info on the General Response contents:
.PP
.Vb 1
\& OSSL_CMP_CTX_reinit(cmp_ctx);
\&
\& ASN1_OBJECT *type = OBJ_txt2obj("1.3.6.1.5.5.7.4.2", 1);
\& OSSL_CMP_ITAV *itav = OSSL_CMP_ITAV_create(type, NULL);
\& OSSL_CMP_CTX_push0_genm_ITAV(cmp_ctx, itav);
\&
\& STACK_OF(OSSL_CMP_ITAV) *itavs;
\& itavs = OSSL_CMP_exec_GENM_ses(cmp_ctx);
\& print_itavs(itavs);
\& sk_OSSL_CMP_ITAV_pop_free(itavs, OSSL_CMP_ITAV_free);
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBOSSL_CMP_exec_IR_ses\fR\|(3), \fBOSSL_CMP_exec_CR_ses\fR\|(3),
\&\fBOSSL_CMP_exec_KUR_ses\fR\|(3), \fBOSSL_CMP_exec_GENM_ses\fR\|(3),
\&\fBOSSL_CMP_exec_certreq\fR\|(3), \fBOSSL_CMP_MSG_http_perform\fR\|(3),
\&\fBERR_print_errors_cb\fR\|(3)
.SH "HISTORY"
.IX Header "HISTORY"
The OpenSSL \s-1CMP\s0 support was added in OpenSSL 3.0.
.PP
\&\fBOSSL_CMP_CTX_reset_geninfo_ITAVs()\fR was added in OpenSSL 3.0.8.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2007\-2023 The OpenSSL Project Authors. All Rights Reserved.
.PP
Licensed under the Apache License 2.0 (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>.