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