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 "OSSL_CMP_CTX_NEW 3ossl"
way too many mistakes in technical documents.
\fBOSSL_CMP_CTX_new() allocates an \s-1OSSL_CMP_CTX\s0 structure associated with the library context libctx and property query string propq, 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
\fBOSSL_CMP_CTX_free() deallocates an \s-1OSSL_CMP_CTX\s0 structure.
\fBOSSL_CMP_CTX_reinit() prepares the given ctx 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 OSSL_CMP_CTX_push0_genm_ITAV(). All other field values (i.e., \s-1CMP\s0 options) are retained for potential reuse.
\fBOSSL_CMP_CTX_set_option() 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.
The following options can be set:
0
.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
\fBOSSL_CMP_CTX_get_option() 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.
\fBOSSL_CMP_CTX_set_log_cb() sets in ctx the callback function cb for handling error queue entries and logging messages. When cb is \s-1NULL\s0 errors are printed to \s-1STDERR\s0 (if available, else ignored) any log messages are ignored. Alternatively, OSSL_CMP_log_open\|(3) may be used to direct logging to \s-1STDOUT.\s0
\fBOSSL_CMP_CTX_set_log_verbosity() is a macro setting the \s-1OSSL_CMP_OPT_LOG_VERBOSITY\s0 context option to the given level.
\fBOSSL_CMP_CTX_print_errors() outputs any entries in the OpenSSL error queue. It is similar to ERR_print_errors_cb\|(3) but uses the \s-1CMP\s0 log callback function if set in the ctx for uniformity with \s-1CMP\s0 logging if given. Otherwise it uses \fBERR_print_errors\|(3) to print to \s-1STDERR\s0 (unless \s-1OPENSSL_NO_STDIO\s0 is defined).
\fBOSSL_CMP_CTX_set1_serverPath() 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 \*(C`/\*(C'.
\fBOSSL_CMP_CTX_set1_server() sets the given server address (which may be a hostname or \s-1IP\s0 address or \s-1NULL\s0) in the given ctx.
\fBOSSL_CMP_CTX_set_serverPort() sets the port of the \s-1CMP\s0 server to connect to. If not used or the port argument is 0 the default port applies, which is 80 for \s-1HTTP\s0 and 443 for \s-1HTTPS.\s0
\fBOSSL_CMP_CTX_set1_proxy() 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 \*(C`http_proxy\*(C' if set, else \*(C`HTTP_PROXY\*(C'. Otherwise defaults to the value of \*(C`https_proxy\*(C' if set, else \*(C`HTTPS_PROXY\*(C'. An empty proxy string specifies not to use a proxy. Else the format is \*(C`[http[s]://]address[:port][/path]\*(C', where any path given is ignored. The default port number is 80, or 443 in case \*(C`https:\*(C' is given.
\fBOSSL_CMP_CTX_set1_no_proxy() 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 \*(C`no_proxy\*(C' if set, else \*(C`NO_PROXY\*(C'.
\fBOSSL_CMP_CTX_set_http_cb() sets the optional \s-1BIO\s0 connect/disconnect callback function, which has the prototype
.Vb 1 typedef BIO *(*HTTP_bio_cb_t) (BIO *bio, void *ctx, int connect, int detail); .Ve
The callback may modify the bio provided by OSSL_CMP_MSG_http_perform\|(3), whereby it may make use of a custom defined argument ctx stored in the \s-1OSSL_CMP_CTX\s0 by means of OSSL_CMP_CTX_set_http_cb_arg(). During connection establishment, just after calling BIO_do_connect_retry(), the function is invoked with the connect argument being 1 and the detail argument being 1 if \s-1HTTPS\s0 is requested, i.e., \s-1SSL/TLS\s0 should be enabled. On disconnect connect is 0 and detail 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 BIO_free_all().
\fBOSSL_CMP_CTX_set_http_cb_arg() sets an argument, respectively a pointer to a structure containing arguments, optionally to be used by the http connect/disconnect callback function. \fIarg is not consumed, and it must therefore explicitly be freed when not needed any more. arg may be \s-1NULL\s0 to clear the entry.
\fBOSSL_CMP_CTX_get_http_cb_arg() gets the argument, respectively the pointer to a structure containing arguments, previously set by \fBOSSL_CMP_CTX_set_http_cb_arg() or \s-1NULL\s0 if unset.
\fBOSSL_CMP_CTX_set_transfer_cb() sets the message transfer callback function, which has the type
.Vb 2 typedef OSSL_CMP_MSG *(*OSSL_CMP_transfer_cb_t) (OSSL_CMP_CTX *ctx, const OSSL_CMP_MSG *req); .Ve
Returns 1 on success, 0 on error.
Default is \s-1NULL,\s0 which implies the use of OSSL_CMP_MSG_http_perform\|(3). The callback should send the \s-1CMP\s0 request message it obtains via the req 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 OSSL_CMP_CTX_set_transfer_cb_arg(), which may be retrieved again through OSSL_CMP_CTX_get_transfer_cb_arg().
\fBOSSL_CMP_CTX_set_transfer_cb_arg() sets an argument, respectively a pointer to a structure containing arguments, optionally to be used by the transfer callback. \fIarg is not consumed, and it must therefore explicitly be freed when not needed any more. arg may be \s-1NULL\s0 to clear the entry.
\fBOSSL_CMP_CTX_get_transfer_cb_arg() gets the argument, respectively the pointer to a structure containing arguments, previously set by \fBOSSL_CMP_CTX_set_transfer_cb_arg() or \s-1NULL\s0 if unset.
\fBOSSL_CMP_CTX_set1_srvCert() sets the expected server cert in ctx 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 OSSL_CMP_CTX_set0_trustedStore(). Any previously set value is freed. The cert 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.
\fBOSSL_CMP_CTX_set1_expected_sender() 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 OSSL_CMP_CTX_set1_srvCert(), 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.
\fBOSSL_CMP_CTX_set0_trustedStore() sets in the \s-1CMP\s0 context ctx the certificate store of type X509_STORE containing trusted certificates, typically of root CAs. This is ignored when a certificate is pinned using OSSL_CMP_CTX_set1_srvCert(). 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.
\fBOSSL_CMP_CTX_get0_trustedStore() extracts from the \s-1CMP\s0 context ctx the pointer to the currently set certificate store containing trust anchors etc., or an empty store if unset.
\fBOSSL_CMP_CTX_set1_untrusted() 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.
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.
\fBOSSL_CMP_CTX_set1_cert() sets the \s-1CMP\s0 signer certificate, also called protection certificate, related to the private key for signature-based message protection. Therefore the public key of this cert must correspond to the private key set before or thereafter via OSSL_CMP_CTX_set1_pkey(). 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 OSSL_CMP_CTX_set1_oldCert(). The subject of this cert will be used as the sender field of outgoing messages, while the subject of any cert set via OSSL_CMP_CTX_set1_oldCert() and any value set via OSSL_CMP_CTX_set1_subjectName() are used as fallback.
The cert argument may be \s-1NULL\s0 to clear the entry.
\fBOSSL_CMP_CTX_build_cert_chain() builds a certificate chain for the \s-1CMP\s0 signer certificate previously set in the ctx. It adds the optional candidates, 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 ctx. Then the function uses this augmented set of certs for chain construction. If own_trusted 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 own_trusted. On success the function stores the resulting chain in ctx 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 candidates and own_trusted arguments being \s-1NULL.\s0
\fBOSSL_CMP_CTX_set1_pkey() sets the client's private key corresponding to the \s-1CMP\s0 signer certificate set via OSSL_CMP_CTX_set1_cert(). This key is used create signature-based protection (protectionAlg = \s-1MSG_SIG_ALG\s0) of outgoing messages unless a symmetric secret has been set via OSSL_CMP_CTX_set1_secretValue(). The pkey argument may be \s-1NULL\s0 to clear the entry.
\fBOSSL_CMP_CTX_set1_secretValue() sets in ctx the byte string sec of length \fIlen to use as pre-shared secret, or clears it if the sec argument is \s-1NULL.\s0 If present, this secret is used to create MAC-based authentication and integrity protection (rather than applying signature-based protection) of outgoing messages and to verify authenticity and integrity of incoming messages that have MAC-based protection (protectionAlg = \*(C`MSG_MAC_ALG\*(C').
\fBOSSL_CMP_CTX_set1_referenceValue() sets the given referenceValue ref with length len in the given ctx or clears it if the ref 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 OSSL_CMP_CTX_set1_subjectName() 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 MAC-based protection is used the ref value is taken as the fallback value for the senderKID.
\fBOSSL_CMP_CTX_set1_recipient() 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.
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 OSSL_CMP_CTX_set1_srvCert(), the value set using OSSL_CMP_CTX_set1_issuer(), the issuer of the certificate set using OSSL_CMP_CTX_set1_oldCert(), the issuer of the \s-1CMP\s0 signer certificate, as far as any of those is present, else the NULL-DN as last resort.
\fBOSSL_CMP_CTX_push0_geninfo_ITAV() adds itav to the stack in the ctx to be added to the GeneralInfo field of the \s-1CMP\s0 PKIMessage header of a request message sent with this context.
\fBOSSL_CMP_CTX_reset_geninfo_ITAVs() clears any ITAVs that were added by OSSL_CMP_CTX_push0_geninfo_ITAV().
\fBOSSL_CMP_CTX_set1_extraCertsOut() sets the stack of extraCerts that will be sent to remote.
\fBOSSL_CMP_CTX_set0_newPkey() 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 priv parameter must be 0 if and only if the given key is a public key.
\fBOSSL_CMP_CTX_get0_newPkey() 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 priv parameter is not 0 and the selected key does not have a private component then \s-1NULL\s0 is returned.
\fBOSSL_CMP_CTX_set1_issuer() 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.
\fBOSSL_CMP_CTX_set1_subjectName() 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 OSSL_CMP_CTX_set1_oldCert(). This default is used for Initialization Requests (\s-1IR\s0) and Certification Requests (\s-1CR\s0) only if no SANs are set. The subjectName is also used as fallback for the sender field of outgoing \s-1CMP\s0 messages if no reference certificate is available.
\fBOSSL_CMP_CTX_push1_subjectAltName() 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(). By default, unless \s-1OSSL_CMP_OPT_SUBJECTALTNAME_NODEFAULT\s0 has been set, the Subject Alternative Names are copied from the reference certificate, see OSSL_CMP_CTX_set1_oldCert(). If set and the subject \s-1DN\s0 is not set with OSSL_CMP_CTX_set1_subjectName() 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().
\fBOSSL_CMP_CTX_set0_reqExtensions() sets the X.509v3 extensions to be used in \s-1IR/CR/KUR.\s0
\fBOSSL_CMP_CTX_reqExtensions_have_SAN() returns 1 if the context contains a Subject Alternative Name extension, else 0 or -1 on error.
\fBOSSL_CMP_CTX_push0_policy() adds the certificate policy info object to the X509_EXTENSIONS of the requested certificate template.
\fBOSSL_CMP_CTX_set1_oldCert() 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 reference certificate 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.
\fBOSSL_CMP_CTX_set1_p10CSR() 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.
\fBOSSL_CMP_CTX_push0_genm_ITAV() adds itav to the stack in the ctx which will be the body of a General Message sent with this context.
\fBOSSL_CMP_certConf_cb() 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 ctx, 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 ctx, and if this fails it takes the received extraCerts as fallback. The resulting cert chain can be retrieved using OSSL_CMP_CTX_get1_newChain().
\fBOSSL_CMP_CTX_set_certConf_cb() 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
.Vb 2 typedef int (*OSSL_CMP_certConf_cb_t) (OSSL_CMP_CTX *ctx, X509 *cert, int fail_info, const char **txt); .Ve
and should inspect the certificate it obtains via the cert parameter and may overrule the pre-decision given in the fail_info and *txt 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 *txt 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 ctx by means of OSSL_CMP_CTX_set_certConf_cb_arg(), which may be retrieved again through OSSL_CMP_CTX_get_certConf_cb_arg(). 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.
\fBOSSL_CMP_CTX_set_certConf_cb_arg() sets an argument, respectively a pointer to a structure containing arguments, optionally to be used by the certConf callback. \fIarg is not consumed, and it must therefore explicitly be freed when not needed any more. arg may be \s-1NULL\s0 to clear the entry.
\fBOSSL_CMP_CTX_get_certConf_cb_arg() gets the argument, respectively the pointer to a structure containing arguments, previously set by \fBOSSL_CMP_CTX_set_certConf_cb_arg(), or \s-1NULL\s0 if unset.
\fBOSSL_CMP_CTX_get_status() returns for client contexts the PKIstatus from the last received CertRepMessage or Revocation Response or error message: =item OSSL_CMP_PKISTATUS_accepted on successful receipt of a \s-1GENP\s0 message:
For server contexts it returns \fBOSSL_CMP_PKISTATUS_trans if a transaction is open, otherwise OSSL_CMP_PKISTATUS_unspecified.
\fBOSSL_CMP_CTX_get0_statusString() returns the statusString from the last received CertRepMessage or Revocation Response or error message, or \s-1NULL\s0 if unset.
\fBOSSL_CMP_CTX_get_failInfoCode() 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 OSSL_CMP_CTX_reinit() has been called. This is a bit field and the flags for it are specified in the header file \fI<openssl/cmp.h>. 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.
\fBOSSL_CMP_CTX_get0_newCert() returns the pointer to the newly obtained certificate in case it is available, else \s-1NULL.\s0
\fBOSSL_CMP_CTX_get1_newChain() returns a pointer to a duplicate of the stack of X.509 certificates computed by OSSL_CMP_certConf_cb() (if this function has been called) on the last received certificate response message \s-1IP/CP/KUP.\s0
\fBOSSL_CMP_CTX_get1_caPubs() 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.
\fBOSSL_CMP_CTX_get1_extraCertsIn() 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.
\fBOSSL_CMP_CTX_set1_transactionID() sets the given transaction \s-1ID\s0 in the given \s-1OSSL_CMP_CTX\s0 structure.
\fBOSSL_CMP_CTX_set1_senderNonce() stores the last sent sender nonce in the ctx. This will be used to validate the recipNonce in incoming messages.
\fBOSSL_CMP_CTX_new(), \fBOSSL_CMP_CTX_get_http_cb_arg(), \fBOSSL_CMP_CTX_get_transfer_cb_arg(), \fBOSSL_CMP_CTX_get0_trustedStore(), \fBOSSL_CMP_CTX_get0_untrusted(), \fBOSSL_CMP_CTX_get0_newPkey(), \fBOSSL_CMP_CTX_get_certConf_cb_arg(), \fBOSSL_CMP_CTX_get0_statusString(), \fBOSSL_CMP_CTX_get0_newCert(), \fBOSSL_CMP_CTX_get0_newChain(), \fBOSSL_CMP_CTX_get1_caPubs(), and \fBOSSL_CMP_CTX_get1_extraCertsIn() return the intended pointer value as described above or \s-1NULL\s0 on error.
\fBOSSL_CMP_CTX_get_option(), \fBOSSL_CMP_CTX_reqExtensions_have_SAN(), \fBOSSL_CMP_CTX_get_status(), and \fBOSSL_CMP_CTX_get_failInfoCode() return the intended value as described above or -1 on error.
\fBOSSL_CMP_certConf_cb() returns fail_info if it is not equal to 0, else 0 on successful validation, or else a bit field with the OSSL_CMP_PKIFAILUREINFO_incorrectData bit set.
All other functions, including OSSL_CMP_CTX_reinit() and OSSL_CMP_CTX_reset_geninfo_ITAVs(), return 1 on success, 0 on error.
Set up a \s-1CMP\s0 client context for sending requests and verifying responses:
.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
Set up symmetric credentials for MAC-based message protection such as \s-1PBM:\s0
.Vb 2 OSSL_CMP_CTX_set1_referenceValue(cmp_ctx, ref, ref_len); OSSL_CMP_CTX_set1_secretValue(cmp_ctx, sec, sec_len); .Ve
Set up the details for certificate requests:
.Vb 2 OSSL_CMP_CTX_set1_subjectName(cmp_ctx, name); OSSL_CMP_CTX_set0_newPkey(cmp_ctx, 1, initialKey); .Ve
Perform an Initialization Request transaction:
.Vb 1 initialCert = OSSL_CMP_exec_IR_ses(cmp_ctx); .Ve
Reset the transaction state of the \s-1CMP\s0 context and the credentials:
.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
Perform a Certification Request transaction, making use of the new credentials:
.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
Perform a Key Update Request, signed using the cert (and key) to be updated:
.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
Perform a General Message transaction including, as an example, the id-it-signKeyPairTypes \s-1OID\s0 and prints info on the General Response contents:
.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
\fBOSSL_CMP_CTX_reset_geninfo_ITAVs() was added in OpenSSL 3.0.8.
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>.