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