doc/man3/OSSL_CMP_CTX_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 OSSL_CMP_CTX_new,
   6 OSSL_CMP_CTX_free,
   7 OSSL_CMP_CTX_reinit,
   8 OSSL_CMP_CTX_set_option,
   9 OSSL_CMP_CTX_get_option,
  10 OSSL_CMP_CTX_set_log_cb,
  11 OSSL_CMP_CTX_set_log_verbosity,
  12 OSSL_CMP_CTX_print_errors,
  13 OSSL_CMP_CTX_set1_serverPath,
  14 OSSL_CMP_CTX_set1_server,
  15 OSSL_CMP_CTX_set_serverPort,
  16 OSSL_CMP_CTX_set1_proxy,
  17 OSSL_CMP_CTX_set1_no_proxy,
  18 OSSL_CMP_CTX_set_http_cb,
  19 OSSL_CMP_CTX_set_http_cb_arg,
  20 OSSL_CMP_CTX_get_http_cb_arg,
  21 OSSL_CMP_transfer_cb_t,
  22 OSSL_CMP_CTX_set_transfer_cb,
  23 OSSL_CMP_CTX_set_transfer_cb_arg,
  24 OSSL_CMP_CTX_get_transfer_cb_arg,
  25 OSSL_CMP_CTX_set1_srvCert,
  26 OSSL_CMP_CTX_set1_expected_sender,
  27 OSSL_CMP_CTX_set0_trustedStore,
  28 OSSL_CMP_CTX_get0_trustedStore,
  29 OSSL_CMP_CTX_set1_untrusted_certs,
  30 OSSL_CMP_CTX_get0_untrusted_certs,
  31 OSSL_CMP_CTX_set1_cert,
  32 OSSL_CMP_CTX_set1_pkey,
  33 OSSL_CMP_CTX_set1_referenceValue,
  34 OSSL_CMP_CTX_set1_secretValue,
  35 OSSL_CMP_CTX_set1_recipient,
  36 OSSL_CMP_CTX_push0_geninfo_ITAV,
  37 OSSL_CMP_CTX_set1_extraCertsOut,
  38 OSSL_CMP_CTX_set0_newPkey,
  39 OSSL_CMP_CTX_get0_newPkey,
  40 OSSL_CMP_CTX_set1_issuer,
  41 OSSL_CMP_CTX_set1_subjectName,
  42 OSSL_CMP_CTX_push1_subjectAltName,
  43 OSSL_CMP_CTX_set0_reqExtensions,
  44 OSSL_CMP_CTX_reqExtensions_have_SAN,
  45 OSSL_CMP_CTX_push0_policy,
  46 OSSL_CMP_CTX_set1_oldCert,
  47 OSSL_CMP_CTX_set1_p10CSR,
  48 OSSL_CMP_CTX_push0_genm_ITAV,
  49 OSSL_CMP_certConf_cb_t,
  50 OSSL_CMP_CTX_set_certConf_cb,
  51 OSSL_CMP_CTX_set_certConf_cb_arg,
  52 OSSL_CMP_CTX_get_certConf_cb_arg,
  53 OSSL_CMP_CTX_get_status,
  54 OSSL_CMP_CTX_get0_statusString,
  55 OSSL_CMP_CTX_get_failInfoCode,
  56 OSSL_CMP_CTX_get0_newCert,
  57 OSSL_CMP_CTX_get1_caPubs,
  58 OSSL_CMP_CTX_get1_extraCertsIn,
  59 OSSL_CMP_CTX_set1_transactionID,
  60 OSSL_CMP_CTX_set1_senderNonce
  61 - functions for managing the CMP client context data structure
  62
  63 =head1 SYNOPSIS
  64
  65  #include <openssl/cmp.h>
  66
  67  OSSL_CMP_CTX *OSSL_CMP_CTX_new(OPENSSL_CTX *libctx, const char *propq);
  68  void OSSL_CMP_CTX_free(OSSL_CMP_CTX *ctx);
  69  int OSSL_CMP_CTX_reinit(OSSL_CMP_CTX *ctx);
  70  int OSSL_CMP_CTX_set_option(OSSL_CMP_CTX *ctx, int opt, int val);
  71  int OSSL_CMP_CTX_get_option(const OSSL_CMP_CTX *ctx, int opt);
  72
  73  /* logging and error reporting: */
  74  int OSSL_CMP_CTX_set_log_cb(OSSL_CMP_CTX *ctx, OSSL_CMP_log_cb_t cb);
  75  #define OSSL_CMP_CTX_set_log_verbosity(ctx, level)
  76  void OSSL_CMP_CTX_print_errors(const OSSL_CMP_CTX *ctx);
  77
  78  /* message transfer: */
  79  int OSSL_CMP_CTX_set1_serverPath(OSSL_CMP_CTX *ctx, const char *path);
  80  int OSSL_CMP_CTX_set1_server(OSSL_CMP_CTX *ctx, const char *address);
  81  int OSSL_CMP_CTX_set_serverPort(OSSL_CMP_CTX *ctx, int port);
  82  int OSSL_CMP_CTX_set1_proxy(OSSL_CMP_CTX *ctx, const char *name);
  83  int OSSL_CMP_CTX_set1_no_proxy(OSSL_CMP_CTX *ctx, const char *names);
  84  int OSSL_CMP_CTX_set_http_cb(OSSL_CMP_CTX *ctx, HTTP_bio_cb_t cb);
  85  int OSSL_CMP_CTX_set_http_cb_arg(OSSL_CMP_CTX *ctx, void *arg);
  86  void *OSSL_CMP_CTX_get_http_cb_arg(const OSSL_CMP_CTX *ctx);
  87  typedef OSSL_CMP_MSG *(*OSSL_CMP_transfer_cb_t)(OSSL_CMP_CTX *ctx,
  88                                                  const OSSL_CMP_MSG *req);
  89  int OSSL_CMP_CTX_set_transfer_cb(OSSL_CMP_CTX *ctx,
  90                                   OSSL_CMP_transfer_cb_t cb);
  91  int OSSL_CMP_CTX_set_transfer_cb_arg(OSSL_CMP_CTX *ctx, void *arg);
  92  void *OSSL_CMP_CTX_get_transfer_cb_arg(const OSSL_CMP_CTX *ctx);
  93
  94  /* server authentication: */
  95  int OSSL_CMP_CTX_set1_srvCert(OSSL_CMP_CTX *ctx, X509 *cert);
  96  int OSSL_CMP_CTX_set1_expected_sender(OSSL_CMP_CTX *ctx,
  97                                       const X509_NAME *name);
  98  int OSSL_CMP_CTX_set0_trustedStore(OSSL_CMP_CTX *ctx, X509_STORE *store);
  99  X509_STORE *OSSL_CMP_CTX_get0_trustedStore(const OSSL_CMP_CTX *ctx);
 100  int OSSL_CMP_CTX_set1_untrusted_certs(OSSL_CMP_CTX *ctx,
 101                                        STACK_OF(X509) *certs);
 102  STACK_OF(X509) *OSSL_CMP_CTX_get0_untrusted_certs(const OSSL_CMP_CTX *ctx);
 103
 104  /* client authentication: */
 105  int OSSL_CMP_CTX_set1_cert(OSSL_CMP_CTX *ctx, X509 *cert);
 106  int OSSL_CMP_CTX_set1_pkey(OSSL_CMP_CTX *ctx, EVP_PKEY *pkey);
 107  int OSSL_CMP_CTX_set1_referenceValue(OSSL_CMP_CTX *ctx,
 108                                       const unsigned char *ref, int len);
 109  int OSSL_CMP_CTX_set1_secretValue(OSSL_CMP_CTX *ctx, const unsigned char *sec,
 110                                    const int len);
 111
 112  /* CMP message header and extra certificates: */
 113  int OSSL_CMP_CTX_set1_recipient(OSSL_CMP_CTX *ctx, const X509_NAME *name);
 114  int OSSL_CMP_CTX_push0_geninfo_ITAV(OSSL_CMP_CTX *ctx, OSSL_CMP_ITAV *itav);
 115  int OSSL_CMP_CTX_set1_extraCertsOut(OSSL_CMP_CTX *ctx,
 116                                      STACK_OF(X509) *extraCertsOut);
 117
 118  /* certificate template: */
 119  int OSSL_CMP_CTX_set0_newPkey(OSSL_CMP_CTX *ctx, int priv, EVP_PKEY *pkey);
 120  EVP_PKEY *OSSL_CMP_CTX_get0_newPkey(const OSSL_CMP_CTX *ctx, int priv);
 121  int OSSL_CMP_CTX_set1_issuer(OSSL_CMP_CTX *ctx, const X509_NAME *name);
 122  int OSSL_CMP_CTX_set1_subjectName(OSSL_CMP_CTX *ctx, const X509_NAME *name);
 123  int OSSL_CMP_CTX_push1_subjectAltName(OSSL_CMP_CTX *ctx,
 124                                        const GENERAL_NAME *name);
 125  int OSSL_CMP_CTX_set0_reqExtensions(OSSL_CMP_CTX *ctx, X509_EXTENSIONS *exts);
 126  int OSSL_CMP_CTX_reqExtensions_have_SAN(OSSL_CMP_CTX *ctx);
 127  int OSSL_CMP_CTX_push0_policy(OSSL_CMP_CTX *ctx, POLICYINFO *pinfo);
 128  int OSSL_CMP_CTX_set1_oldCert(OSSL_CMP_CTX *ctx, X509 *cert);
 129  int OSSL_CMP_CTX_set1_p10CSR(OSSL_CMP_CTX *ctx, const X509_REQ *csr);
 130
 131  /* misc body contents: */
 132  int OSSL_CMP_CTX_push0_genm_ITAV(OSSL_CMP_CTX *ctx, OSSL_CMP_ITAV *itav);
 133
 134  /* certificate confirmation: */
 135  typedef int (*OSSL_CMP_certConf_cb_t)(OSSL_CMP_CTX *ctx, X509 *cert,
 136                                        int fail_info, const char **txt);
 137  int OSSL_CMP_CTX_set_certConf_cb(OSSL_CMP_CTX *ctx, OSSL_CMP_certConf_cb_t cb);
 138  int OSSL_CMP_CTX_set_certConf_cb_arg(OSSL_CMP_CTX *ctx, void *arg);
 139  void *OSSL_CMP_CTX_get_certConf_cb_arg(const OSSL_CMP_CTX *ctx);
 140
 141  /* result fetching: */
 142  int OSSL_CMP_CTX_get_status(const OSSL_CMP_CTX *ctx);
 143  OSSL_CMP_PKIFREETEXT *OSSL_CMP_CTX_get0_statusString(const OSSL_CMP_CTX *ctx);
 144  int OSSL_CMP_CTX_get_failInfoCode(const OSSL_CMP_CTX *ctx);
 145
 146  X509 *OSSL_CMP_CTX_get0_newCert(const OSSL_CMP_CTX *ctx);
 147  STACK_OF(X509) *OSSL_CMP_CTX_get1_caPubs(const OSSL_CMP_CTX *ctx);
 148  STACK_OF(X509) *OSSL_CMP_CTX_get1_extraCertsIn(const OSSL_CMP_CTX *ctx);
 149
 150  /* for testing and debugging purposes: */
 151  int OSSL_CMP_CTX_set1_transactionID(OSSL_CMP_CTX *ctx,
 152                                      const ASN1_OCTET_STRING *id);
 153  int OSSL_CMP_CTX_set1_senderNonce(OSSL_CMP_CTX *ctx,
 154                                    const ASN1_OCTET_STRING *nonce);
 155
 156 =head1 DESCRIPTION
 157
 158 This is the context API for using CMP (Certificate Management Protocol) with
 159 OpenSSL.
 160
 161 OSSL_CMP_CTX_new() allocates an B<OSSL_CMP_CTX> structure associated with
 162 the library context I<libctx> and property query string I<propq>,
 163 both of which may be NULL to select the defaults.
 164 It initializes the remaining fields to their default values - for instance,
 165 the logging verbosity is set to OSSL_CMP_LOG_INFO,
 166 the message timeout is set to 120 seconds,
 167 and the proof-of-possession method is set to OSSL_CRMF_POPO_SIGNATURE.
 168
 169 OSSL_CMP_CTX_free() deallocates an OSSL_CMP_CTX structure.
 170
 171 OSSL_CMP_CTX_reinit() prepares the given B<ctx> for a further transaction by
 172 clearing the internal CMP transaction (aka session) status, PKIStatusInfo,
 173 and any previous results (newCert, caPubs, and extraCertsIn)
 174 from the last executed transaction.
 175 All other field values (i.e., CMP options) are retained for potential re-use.
 176
 177 OSSL_CMP_CTX_set_option() sets the given value for the given option
 178 (e.g., OSSL_CMP_OPT_IMPLICIT_CONFIRM) in the given OSSL_CMP_CTX structure.
 179
 180 The following options can be set:
 181
 182 =over 4
 183
 184 =item B<OSSL_CMP_OPT_LOG_VERBOSITY>
 185
 186         The level of severity needed for actually outputting log messages
 187         due to errors, warnings, general info, debugging, etc.
 188         Default is OSSL_CMP_LOG_INFO. See also L<OSSL_CMP_log_open(3)>.
 189
 190 =item B<OSSL_CMP_OPT_MSG_TIMEOUT>
 191
 192         Number of seconds (or 0 for infinite) a CMP message round trip is
 193         allowed to take before a timeout error is returned. Default is 120.
 194
 195 =item B<OSSL_CMP_OPT_TOTAL_TIMEOUT>
 196
 197         Maximum total number of seconds an enrollment (including polling)
 198         may take. Default is 0 (infinite).
 199
 200 =item B<OSSL_CMP_OPT_VALIDITY_DAYS>
 201
 202         Number of days new certificates are asked to be valid for.
 203
 204 =item B<OSSL_CMP_OPT_SUBJECTALTNAME_NODEFAULT>
 205
 206         Do not take default Subject Alternative Names
 207         from the reference certificate.
 208
 209 =item B<OSSL_CMP_OPT_SUBJECTALTNAME_CRITICAL>
 210
 211         Demand that the given Subject Alternative Names are flagged as critical.
 212
 213 =item B<OSSL_CMP_OPT_POLICIES_CRITICAL>
 214
 215         Demand that the given policies are flagged as critical.
 216
 217 =item B<OSSL_CMP_OPT_POPO_METHOD>
 218
 219         Select the proof of possession method to use. Possible values are:
 220
 221             OSSL_CRMF_POPO_NONE       - ProofOfPossession field omitted
 222             OSSL_CRMF_POPO_RAVERIFIED - assert that the RA has already
 223                                         verified the PoPo
 224             OSSL_CRMF_POPO_SIGNATURE  - sign a value with private key,
 225                                         which is the default.
 226             OSSL_CRMF_POPO_KEYENC     - decrypt the encrypted certificate
 227                                         ("indirect method")
 228
 229         Note that a signature-based POPO can only be produced if a private key
 230         is provided as the newPkey or client pkey component of the CMP context.
 231
 232 =item B<OSSL_CMP_OPT_DIGEST_ALGNID>
 233
 234         The NID of the digest algorithm to be used in RFC 4210's MSG_SIG_ALG
 235         for signature-based message protection and Proof-of-Possession (POPO).
 236         Default is SHA256.
 237
 238 =item B<OSSL_CMP_OPT_OWF_ALGNID>
 239         The NID of the digest algorithm to be used as one-way function (OWF)
 240         in RFC 4210's MSG_MAC_ALG for PBM-based message protection.
 241         Default is SHA256.
 242
 243 =item B<OSSL_CMP_OPT_MAC_ALGNID>
 244         The NID of the MAC algorithm to be used in RFC 4210's MSG_MAC_ALG
 245         for PBM-based message protection.
 246         Default is HMAC-SHA1 as per RFC 4210.
 247
 248 =item B<OSSL_CMP_OPT_REVOCATION_REASON>
 249
 250         The reason code to be included in a Revocation Request (RR);
 251         values: 0..10 (RFC 5210, 5.3.1) or -1 for none, which is the default.
 252
 253 =item B<OSSL_CMP_OPT_IMPLICIT_CONFIRM>
 254
 255         Request server to enable implicit confirm mode, where the client
 256         does not need to send confirmation upon receiving the
 257         certificate. If the server does not enable implicit confirmation
 258         in the return message, then confirmation is sent anyway.
 259
 260 =item B<OSSL_CMP_OPT_DISABLE_CONFIRM>
 261
 262         Do not confirm enrolled certificates, to cope with broken servers
 263         not supporting implicit confirmation correctly.
 264 B<WARNING:> This setting leads to unspecified behavior and it is meant
 265 exclusively to allow interoperability with server implementations violating
 266 RFC 4210.
 267
 268 =item B<OSSL_CMP_OPT_UNPROTECTED_SEND>
 269
 270         Send messages without CMP-level protection.
 271
 272 =item B<OSSL_CMP_OPT_UNPROTECTED_ERRORS>
 273
 274         Accept unprotected error responses which are either explicitly
 275         unprotected or where protection verification failed. Applies to regular
 276         error messages as well as certificate responses (IP/CP/KUP) and
 277         revocation responses (RP) with rejection.
 278 B<WARNING:> This setting leads to unspecified behavior and it is meant
 279 exclusively to allow interoperability with server implementations violating
 280 RFC 4210.
 281
 282 =item B<OSSL_CMP_OPT_IGNORE_KEYUSAGE>
 283
 284         Ignore key usage restrictions in signer certificate when
 285         validating signature-based protection in received CMP messages.
 286         Else, 'digitalSignature' must be allowed by CMP signer certificates.
 287
 288 =item B<OSSL_CMP_OPT_PERMIT_TA_IN_EXTRACERTS_FOR_IR>
 289
 290         Allow retrieving a trust anchor from extraCerts and using that
 291         to validate the certificate chain of an IP message.
 292
 293 =back
 294
 295 OSSL_CMP_CTX_get_option() reads the current value of the given option
 296 (e.g., OSSL_CMP_OPT_IMPLICIT_CONFIRM) from the given OSSL_CMP_CTX structure.
 297
 298 OSSL_CMP_CTX_set_log_cb() sets in B<ctx> the callback function C<cb>
 299 for handling error queue entries and logging messages.
 300 When C<cb> is NULL errors are printed to STDERR (if available, else ignored)
 301 any log messages are ignored.
 302 Alternatively, L<OSSL_CMP_log_open(3)> may be used to direct logging to STDOUT.
 303
 304 OSSL_CMP_CTX_set_log_verbosity() is a macro setting the
 305 OSSL_CMP_OPT_LOG_VERBOSITY context option to the given level.
 306
 307 OSSL_CMP_CTX_print_errors() outputs any entries in the OpenSSL error queue.
 308 It is similar to B<ERR_print_errors_cb()> but uses the CMP log callback function
 309 if set in the C<ctx> for uniformity with CMP logging if given. Otherwise it uses
 310 B<ERR_print_errors(3)> to print to STDERR (unless OPENSSL_NO_STDIO is defined).
 311
 312 OSSL_CMP_CTX_set1_serverPath() sets the HTTP path of the CMP server on the host,
 313 also known as "CMP alias".
 314 The default is I</>.
 315
 316 OSSL_CMP_CTX_set1_server() sets the given server B<address>
 317 (which may be a hostname or IP address or NULL) in the given B<ctx>.
 318
 319 OSSL_CMP_CTX_set_serverPort() sets the port of the CMP server to connect to.
 320 If not used or the B<port> argument is 0
 321 the default port applies, which is 80 for HTTP and 443 for HTTPS.
 322
 323 OSSL_CMP_CTX_set1_proxy() sets the HTTP proxy to be used for connecting to
 324 the given CMP server unless overruled by any "no_proxy" settings (see below).
 325 If TLS is not used this defaults to the value of
 326 the environment variable B<http_proxy> if set, else B<HTTP_PROXY>.
 327 Otherwise defaults to the value of B<https_proxy> if set, else B<HTTPS_PROXY>.
 328 An empty proxy string specifies not to use a proxy.
 329 Else the format is I<[http[s]://]address[:port][/path]>,
 330 where any path given is ignored.
 331 The default port number is 80, or 443 in case I<https:> is given.
 332
 333 OSSL_CMP_CTX_set1_no_proxy() sets the list of server hostnames not to use
 334 an HTTP proxy for. The names may be separated by commas and/or whitespace.
 335 Defaults to the environment variable B<no_proxy> if set, else B<NO_PROXY>.
 336
 337 OSSL_CMP_CTX_set_http_cb() sets the optional BIO connect/disconnect callback
 338 function, which has the prototype
 339
 340  typedef BIO *(*HTTP_bio_cb_t) (BIO *bio, void *ctx, int connect, int detail);
 341
 342 The callback may modify the BIO B<bio> provided by OSSL_CMP_MSG_http_perform(),
 343 whereby it may make use of a custom defined argument B<ctx>
 344 stored in the OSSL_CMP_CTX by means of OSSL_CMP_CTX_set_http_cb_arg().
 345 During connection establishment, just after calling BIO_do_connect_retry(),
 346 the function is invoked with the B<connect> argument being 1 and the B<detail>
 347 argument being 1 if HTTPS is requested, i.e., SSL/TLS should be enabled. On
 348 disconnect B<connect> is 0 and B<detail> is 1 in case no error occurred, else 0.
 349 For instance, on connect the function may prepend a TLS BIO to implement HTTPS;
 350 after disconnect it may do some diagnostic output and/or specific cleanup.
 351 The function should return NULL to indicate failure.
 352 After disconnect the modified BIO will be deallocated using BIO_free_all().
 353
 354 OSSL_CMP_CTX_set_http_cb_arg() sets an argument, respectively a pointer to
 355 a structure containing arguments,
 356 optionally to be used by the http connect/disconnect callback function.
 357 B<arg> is not consumed, and it must therefore explicitly be freed when not
 358 needed any more. B<arg> may be NULL to clear the entry.
 359
 360 OSSL_CMP_CTX_get_http_cb_arg() gets the argument, respectively the pointer to a
 361 structure containing arguments, previously set by
 362 OSSL_CMP_CTX_set_http_cb_arg() or NULL if unset.
 363
 364 OSSL_CMP_CTX_set_transfer_cb() sets the message transfer callback function,
 365 which has the type
 366
 367  typedef OSSL_CMP_MSG *(*OSSL_CMP_transfer_cb_t) (OSSL_CMP_CTX *ctx,
 368                                                   const OSSL_CMP_MSG *req);
 369
 370 Returns 1 on success, 0 on error.
 371
 372 Default is NULL, which implies the use of L<OSSL_CMP_MSG_http_perform(3)>.
 373 The callback should send the CMP request message it obtains via the B<req>
 374 parameter and on success return the response, else it must return NULL.
 375 The transfer callback may make use of a custom defined argument stored in
 376 the ctx by means of OSSL_CMP_CTX_set_transfer_cb_arg(), which may be retrieved
 377 again through OSSL_CMP_CTX_get_transfer_cb_arg().
 378
 379 OSSL_CMP_CTX_set_transfer_cb_arg() sets an argument, respectively a pointer to a
 380 structure containing arguments, optionally to be used by the transfer callback.
 381 B<arg> is not consumed, and it must therefore explicitly be freed when not
 382 needed any more. B<arg> may be NULL to clear the entry.
 383
 384 OSSL_CMP_CTX_get_transfer_cb_arg() gets the argument, respectively the pointer
 385 to a structure containing arguments, previously set by
 386 OSSL_CMP_CTX_set_transfer_cb_arg() or NULL if unset.
 387
 388 OSSL_CMP_CTX_set1_srvCert() sets the expected server cert B<srvCert> and trusts
 389 it directly (even if it is expired) when verifying signed response messages.
 390 May be used alternatively to OSSL_CMP_CTX_set0_trustedStore()
 391 to pin the accepted server.
 392 Any previously set value is freed.
 393 The B<cert> argument may be NULL to clear the entry.
 394 If set, the subject of the certificate is also used
 395 as default value for the recipient of CMP requests
 396 and as default value for the expected sender of CMP responses.
 397
 398 OSSL_CMP_CTX_set1_expected_sender() sets the Distinguished Name (DN)
 399 expected in the sender field of CMP response messages.
 400 Defaults to the subject of the pinned server certificate B<-srvcert>, if any.
 401 This can be used to make sure that only a particular entity is accepted as
 402 CMP message signer, and attackers are not able to use arbitrary certificates
 403 of a trusted PKI hierarchy to fraudulently pose as CMP server.
 404 Note that this gives slightly more freedom than OSSL_CMP_CTX_set1_srvCert(),
 405 which pins the server to the holder of a particular certificate, while the
 406 expected sender name will continue to match after updates of the server cert.
 407
 408 OSSL_CMP_CTX_set0_trustedStore() sets the certificate store of type X509_STORE
 409 containing trusted (root) CA certificates.
 410 The store may also hold CRLs and
 411 a certificate verification callback function used for CMP server authentication.
 412 Any store entry already set before is freed.
 413 When given a NULL parameter the entry is cleared.
 414
 415 OSSL_CMP_CTX_get0_trustedStore() returns a pointer to the currently set
 416 certificate store containing trusted cert etc., or an empty store if unset.
 417
 418 OSSL_CMP_CTX_set1_untrusted_certs() sets up a list of non-trusted certificates
 419 of intermediate CAs that may be useful for path construction for the CMP client
 420 certificate, for the TLS client certificate (if any), when verifying
 421 the CMP server certificate, and when verifying newly enrolled certificates.
 422 The reference counts of those certificates handled successfully are increased.
 423
 424 OSSL_CMP_CTX_get0_untrusted_certs(OSSL_CMP_CTX *ctx) returns a pointer to the
 425 list of untrusted certs, which may be empty if unset.
 426
 427 OSSL_CMP_CTX_set1_cert() sets the certificate used for CMP message protection.
 428 The public key of this B<cert> must correspond to
 429 the private key set via B<OSSL_CMP_CTX_set1_pkey()>.
 430 When using signature-based protection of CMP request messages
 431 this "protection certificate" will be included first in the extraCerts field.
 432 The subject of this B<cert> will be used as the sender field of outgoing
 433 messages, while the subject of any cert set via B<OSSL_CMP_CTX_set1_oldCert()>
 434 and any value set via B<OSSL_CMP_CTX_set1_subjectName()> are used as fallback.
 435 The B<cert> argument may be NULL to clear the entry.
 436
 437 OSSL_CMP_CTX_set1_pkey() sets the private key corresponding to the
 438 protection certificate B<cert> set via B<OSSL_CMP_CTX_set1_cert()>.
 439 This key is used create signature-based protection (protectionAlg = MSG_SIG_ALG)
 440 of outgoing messages
 441 unless a PBM secret has been set via  B<OSSL_CMP_CTX_set1_secretValue()>.
 442 The B<pkey> argument may be NULL to clear the entry.
 443
 444 OSSL_CMP_CTX_set1_secretValue() sets the byte string B<sec> with length B<len>
 445 as PBM secret in the given B<ctx> or clears it if the B<sec> argument is NULL.
 446 If present, this secret is used to create PBM-based protection of outgoing
 447 messages and to verify any PBM-based protection of incoming messages
 448 (protectionAlg = MSG_MAC_ALG). PBM stands for Password-Based MAC.
 449 PBM-based protection takes precedence over signature-based protection.
 450
 451 OSSL_CMP_CTX_set1_referenceValue() sets the given referenceValue B<ref> with
 452 length B<len> in the given B<ctx> or clears it if the B<ref> argument is NULL.
 453 According to RFC 4210 section 5.1.1, if no value for the sender field in
 454 CMP message headers can be determined (i.e., no protection certificate B<cert>
 455 and no B<subjectName> is given) then the sender field will contain the NULL-DN
 456 and the senderKID field of the CMP message header must be set.
 457 When signature-based protection is used the senderKID will be set to
 458 the subjectKeyIdentifier of the protection B<cert> as far as present.
 459 If not present or when PBM-based protection is used
 460 the B<ref> value is taken as the fallback value for the senderKID.
 461
 462 OSSL_CMP_CTX_set1_recipient() sets the recipient name that will be used in the
 463 PKIHeader of CMP request messages, i.e. the X509 name of the (CA) server.
 464
 465 The recipient field in the header of a CMP message is mandatory.
 466 If not given explicitly the recipient is determined in the following order:
 467 the subject of the CMP server certificate set using OSSL_CMP_CTX_set1_srvCert(),
 468 the value set using OSSL_CMP_CTX_set1_issuer(),
 469 the issuer of the certificate set using OSSL_CMP_CTX_set1_oldCert(),
 470 the issuer of the protection certificate (B<cert>),
 471 as far as any of those is present, else the NULL-DN as last resort.
 472
 473 OSSL_CMP_CTX_push0_geninfo_ITAV() adds B<itav> to the stack in the B<ctx> to be
 474 added to the GeneralInfo field of the CMP PKIMessage header of a request
 475 message sent with this context.
 476
 477 OSSL_CMP_CTX_set1_extraCertsOut() sets the stack of extraCerts that will be
 478 sent to remote.
 479
 480 OSSL_CMP_CTX_set0_newPkey() can be used to explicitly set the given EVP_PKEY
 481 structure as the private or public key to be certified in the CMP context.
 482 The B<priv> parameter must be 0 if and only if the given key is a public key.
 483
 484 OSSL_CMP_CTX_get0_newPkey() gives the key to use for certificate enrollment
 485 dependent on fields of the CMP context structure:
 486 the newPkey (which may be a private or public key) if present,
 487 else the public key in the p10CSR if present, else the client private key.
 488 If the B<priv> parameter is not 0 and the selected key does not have a
 489 private component then NULL is returned.
 490
 491 OSSL_CMP_CTX_set1_issuer() sets the name of the intended issuer that
 492 will be set in the CertTemplate, i.e., the X509 name of the CA server.
 493
 494 OSSL_CMP_CTX_set1_subjectName() sets the subject DN that will be used in
 495 the CertTemplate structure when requesting a new cert. For Key Update Requests
 496 (KUR), it defaults to the subject DN of the B<reference certificate>,
 497 see B<OSSL_CMP_CTX_set1_oldCert()>. This default is used for Initialization
 498 Requests (IR) and Certification Requests (CR) only if no SANs are set.
 499 The B<subjectName> is also used as fallback for the sender field
 500 of outgoing CMP messages if no B<cert> and no B<oldcert> are available.
 501
 502 OSSL_CMP_CTX_push1_subjectAltName() adds the given X509 name to the list of
 503 alternate names on the certificate template request. This cannot be used if
 504 any Subject Alternative Name extension is set via
 505 OSSL_CMP_CTX_set0_reqExtensions().
 506 By default, unless OSSL_CMP_OPT_SUBJECTALTNAME_NODEFAULT has been set,
 507 the Subject Alternative Names are copied from the B<reference certificate>,
 508 see B<OSSL_CMP_CTX_set1_oldCert()>.
 509 If set and the subject DN is not set with OSSL_CMP_CTX_set1_subjectName(), then
 510 the certificate template of an IR and CR will not be filled with the default
 511 subject DN from the B<reference certificate>.
 512 If a subject DN is desired it needs to be set explicitly with
 513 OSSL_CMP_CTX_set1_subjectName().
 514
 515 OSSL_CMP_CTX_set0_reqExtensions() sets the X.509v3 extensions to be used in
 516 IR/CR/KUR.
 517
 518 OSSL_CMP_CTX_reqExtensions_have_SAN() returns 1 if the context contains
 519 a Subject Alternative Name extension, else 0 or -1 on error.
 520
 521 OSSL_CMP_CTX_push0_policy() adds the certificate policy info object
 522 to the X509_EXTENSIONS of the requested certificate template.
 523
 524 OSSL_CMP_CTX_set1_oldCert() sets the old certificate to be updated in
 525 Key Update Requests (KUR) or to be revoked in Revocation Requests (RR).
 526 It must be given for RR, else it defaults to the protection B<cert>.
 527 The B<reference certificate> determined in this way, if any, is also used for
 528 deriving default subject DN and Subject Alternative Names for IR, CR, and KUR.
 529 Its subject is used as sender in CMP message headers if no protection cert is given.
 530 Its issuer is used as default recipient in CMP message headers.
 531
 532 OSSL_CMP_CTX_set1_p10CSR() sets the PKCS#10 CSR to be used in P10CR.
 533
 534 OSSL_CMP_CTX_push0_genm_ITAV() adds B<itav> to the stack in the B<ctx> which
 535 will be the body of a General Message sent with this context.
 536
 537 OSSL_CMP_CTX_set_certConf_cb() sets the callback used for evaluating the newly
 538 enrolled certificate before the library sends, depending on its result,
 539 a positive or negative certConf message to the server. The callback has type
 540
 541  typedef int (*OSSL_CMP_certConf_cb_t) (OSSL_CMP_CTX *ctx, X509 *cert,
 542                                         int fail_info, const char **txt);
 543
 544 and should inspect the certificate it obtains via the B<cert> parameter and may
 545 overrule the pre-decision given in the B<fail_info> and B<*txt> parameters.
 546 If it accepts the certificate it must return 0, indicating success. Else it must
 547 return a bit field reflecting PKIFailureInfo with at least one failure bit and
 548 may set the B<*txt> output parameter to point to a string constant with more
 549 detail.  The transfer callback may make use of a custom defined argument stored
 550 in the B<ctx> by means of OSSL_CMP_CTX_set_certConf_cb_arg(), which may be
 551 retrieved again through OSSL_CMP_CTX_get_certConf_cb_arg().
 552 Typically, the callback will check at least that the certificate can be verified
 553 using a set of trusted certificates.
 554 It also could compare the subject DN and other fields of the newly
 555 enrolled certificate with the certificate template of the request.
 556
 557 OSSL_CMP_CTX_set_certConf_cb_arg() sets an argument, respectively a pointer to a
 558 structure containing arguments, optionally to be used by the certConf callback.
 559 B<arg> is not consumed, and it must therefore explicitly be freed when not
 560 needed any more. B<arg> may be NULL to clear the entry.
 561
 562 OSSL_CMP_CTX_get_certConf_cb_arg() gets the argument, respectively the pointer
 563 to a structure containing arguments, previously set by
 564 OSSL_CMP_CTX_set_certConf_cb_arg(), or NULL if unset.
 565
 566 OSSL_CMP_CTX_get_status() returns the PKIstatus from the last received
 567 CertRepMessage or Revocation Response or error message, or -1 if unset.
 568
 569 OSSL_CMP_CTX_get0_statusString() returns the statusString from the last received
 570 CertRepMessage or Revocation Response or error message, or NULL if unset.
 571
 572 OSSL_CMP_CTX_get_failInfoCode() returns the error code from the failInfo field
 573 of the last received CertRepMessage or Revocation Response or error message.
 574 This is a bit field and the flags for it are specified in the header file
 575 F<< <openssl/cmp.h> >>.
 576 The flags start with OSSL_CMP_CTX_FAILINFO, for example:
 577 OSSL_CMP_CTX_FAILINFO_badAlg. Returns -1 if the failInfoCode field is unset.
 578
 579 OSSL_CMP_CTX_get0_newCert() returns the pointer to the newly obtained
 580 certificate in case it is available, else NULL.
 581
 582 OSSL_CMP_CTX_get1_caPubs() returns a pointer to a duplicate of the stack of
 583 X.509 certificates received in the caPubs field of last received certificate
 584 response message IP/CP/KUP.
 585
 586 OSSL_CMP_CTX_get1_extraCertsIn() returns a pointer to a duplicate of the stack
 587 of X.509 certificates received in the last received nonempty extraCerts field.
 588 Returns an empty stack if no extraCerts have been received in the current
 589 transaction.
 590
 591 OSSL_CMP_CTX_set1_transactionID() sets the given transaction ID in the given
 592 OSSL_CMP_CTX structure.
 593
 594 OSSL_CMP_CTX_set1_senderNonce() stores the last sent sender B<nonce> in
 595 the B<ctx>. This will be used to validate the recipNonce in incoming messages.
 596
 597 =head1 NOTES
 598
 599 CMP is defined in RFC 4210 (and CRMF in RFC 4211).
 600
 601 =head1 RETURN VALUES
 602
 603 OSSL_CMP_CTX_free() and OSSL_CMP_CTX_print_errors() do not return anything.
 604
 605 OSSL_CMP_CTX_new(),
 606 OSSL_CMP_CTX_get_http_cb_arg(),
 607 OSSL_CMP_CTX_get_transfer_cb_arg(),
 608 OSSL_CMP_CTX_get0_trustedStore(),
 609 OSSL_CMP_CTX_get0_untrusted_certs(),
 610 OSSL_CMP_CTX_get0_newPkey(),
 611 OSSL_CMP_CTX_get_certConf_cb_arg(),
 612 OSSL_CMP_CTX_get0_statusString(),
 613 OSSL_CMP_CTX_get0_newCert(),
 614 OSSL_CMP_CTX_get1_caPubs(), and
 615 OSSL_CMP_CTX_get1_extraCertsIn()
 616 return the intended pointer value as described above or NULL on error.
 617
 618 OSSL_CMP_CTX_get_option(),
 619 OSSL_CMP_CTX_reqExtensions_have_SAN(),
 620 OSSL_CMP_CTX_get_status(), and
 621 OSSL_CMP_CTX_get_failInfoCode()
 622 return the intended value as described above or -1 on error.
 623
 624 All other functions return 1 on success, 0 on error.
 625
 626 =head1 EXAMPLES
 627
 628 The following code omits error handling.
 629
 630 Set up a CMP client context for sending requests and verifying responses:
 631
 632     cmp_ctx = OSSL_CMP_CTX_new();
 633     OSSL_CMP_CTX_set1_server(cmp_ctx, name_or_address);
 634     OSSL_CMP_CTX_set1_serverPort(cmp_ctx, port_string);
 635     OSSL_CMP_CTX_set1_serverPath(cmp_ctx, path_or_alias);
 636     OSSL_CMP_CTX_set0_trustedStore(cmp_ctx, ts);
 637
 638 Set up client credentials for password-based protection (PBM):
 639
 640     OSSL_CMP_CTX_set1_referenceValue(cmp_ctx, ref, ref_len);
 641     OSSL_CMP_CTX_set1_secretValue(cmp_ctx, sec, sec_len);
 642
 643 Set up the details for certificate requests:
 644
 645     OSSL_CMP_CTX_set1_subjectName(cmp_ctx, name);
 646     OSSL_CMP_CTX_set0_newPkey(cmp_ctx, 1, initialKey);
 647
 648 Perform an Initialization Request transaction:
 649
 650     initialCert = OSSL_CMP_exec_IR_ses(cmp_ctx);
 651
 652 Reset the transaction state of the CMP context and the credentials:
 653
 654     OSSL_CMP_CTX_reinit(cmp_ctx);
 655     OSSL_CMP_CTX_set1_referenceValue(cmp_ctx, NULL, 0);
 656     OSSL_CMP_CTX_set1_secretValue(cmp_ctx, NULL, 0);
 657
 658 Perform a Certification Request transaction, making use of the new credentials:
 659
 660     OSSL_CMP_CTX_set1_cert(cmp_ctx, initialCert);
 661     OSSL_CMP_CTX_set1_pkey(cmp_ctx, initialKey);
 662     OSSL_CMP_CTX_set0_newPkey(cmp_ctx, 1, curentKey);
 663     currentCert = OSSL_CMP_exec_CR_ses(cmp_ctx);
 664
 665 Perform a Key Update Request, signed using the cert (and key) to be updated:
 666
 667     OSSL_CMP_CTX_reinit(cmp_ctx);
 668     OSSL_CMP_CTX_set1_cert(cmp_ctx, currentCert);
 669     OSSL_CMP_CTX_set1_pkey(cmp_ctx, currentKey);
 670     OSSL_CMP_CTX_set0_newPkey(cmp_ctx, 1, updatedKey);
 671     currentCert = OSSL_CMP_exec_KUR_ses(cmp_ctx);
 672     currentKey = updatedKey;
 673
 674 Perform a General Message transaction including, as an example,
 675 the id-it-signKeyPairTypes OID and prints info on the General Response contents:
 676
 677     OSSL_CMP_CTX_reinit(cmp_ctx);
 678
 679     ASN1_OBJECT *type = OBJ_txt2obj("1.3.6.1.5.5.7.4.2", 1);
 680     OSSL_CMP_ITAV *itav = OSSL_CMP_ITAV_new(type, NULL);
 681     OSSL_CMP_CTX_push0_genm_ITAV(cmp_ctx, itav);
 682
 683     STACK_OF(OSSL_CMP_ITAV) *itavs;
 684     itavs = OSSL_CMP_exec_GENM_ses(cmp_ctx);
 685     print_itavs(itavs);
 686     sk_OSSL_CMP_ITAV_pop_free(itavs, OSSL_CMP_ITAV_free);
 687
 688 =head1 SEE ALSO
 689
 690 L<OSSL_CMP_exec_IR_ses(3)>, L<OSSL_CMP_exec_CR_ses(3)>,
 691 L<OSSL_CMP_exec_KUR_ses(3)>, L<OSSL_CMP_exec_GENM_ses(3)>,
 692 L<OSSL_CMP_exec_certreq(3)>
 693
 694 =head1 HISTORY
 695
 696 The OpenSSL CMP support was added in OpenSSL 3.0.
 697
 698 =head1 COPYRIGHT
 699
 700 Copyright 2007-2020 The OpenSSL Project Authors. All Rights Reserved.
 701
 702 Licensed under the Apache License 2.0 (the "License").  You may not use
 703 this file except in compliance with the License.  You can obtain a copy
 704 in the file LICENSE in the source distribution or at
 705 L<https://www.openssl.org/source/license.html>.
 706
 707 =cut