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