doc/man3/CT_POLICY_EVAL_CTX_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 CT_POLICY_EVAL_CTX_new, CT_POLICY_EVAL_CTX_free,
   6 CT_POLICY_EVAL_CTX_get0_cert, CT_POLICY_EVAL_CTX_set1_cert,
   7 CT_POLICY_EVAL_CTX_get0_issuer, CT_POLICY_EVAL_CTX_set1_issuer,
   8 CT_POLICY_EVAL_CTX_get0_log_store, CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE,
   9 CT_POLICY_EVAL_CTX_get_time, CT_POLICY_EVAL_CTX_set_time -
  10 Encapsulates the data required to evaluate whether SCTs meet a Certificate Transparency policy
  11
  12 =head1 SYNOPSIS
  13
  14  #include <openssl/ct.h>
  15
  16  CT_POLICY_EVAL_CTX *CT_POLICY_EVAL_CTX_new(void);
  17  void CT_POLICY_EVAL_CTX_free(CT_POLICY_EVAL_CTX *ctx);
  18  X509* CT_POLICY_EVAL_CTX_get0_cert(const CT_POLICY_EVAL_CTX *ctx);
  19  int CT_POLICY_EVAL_CTX_set1_cert(CT_POLICY_EVAL_CTX *ctx, X509 *cert);
  20  X509* CT_POLICY_EVAL_CTX_get0_issuer(const CT_POLICY_EVAL_CTX *ctx);
  21  int CT_POLICY_EVAL_CTX_set1_issuer(CT_POLICY_EVAL_CTX *ctx, X509 *issuer);
  22  const CTLOG_STORE *CT_POLICY_EVAL_CTX_get0_log_store(const CT_POLICY_EVAL_CTX *ctx);
  23  void CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(CT_POLICY_EVAL_CTX *ctx, CTLOG_STORE *log_store);
  24  uint64_t CT_POLICY_EVAL_CTX_get_time(const CT_POLICY_EVAL_CTX *ctx);
  25  void CT_POLICY_EVAL_CTX_set_time(CT_POLICY_EVAL_CTX *ctx, uint64_t time_in_ms);
  26
  27 =head1 DESCRIPTION
  28
  29 A B<CT_POLICY_EVAL_CTX> is used by functions that evaluate whether Signed
  30 Certificate Timestamps (SCTs) fulfil a Certificate Transparency (CT) policy.
  31 This policy may be, for example, that at least one valid SCT is available. To
  32 determine this, an SCT's timestamp and signature must be verified.
  33 This requires:
  34
  35 =over 2
  36
  37 =item *
  38
  39 the public key of the log that issued the SCT
  40
  41 =item *
  42
  43 the certificate that the SCT was issued for
  44
  45 =item *
  46
  47 the issuer certificate (if the SCT was issued for a pre-certificate)
  48
  49 =item *
  50
  51 the current time
  52
  53 =back
  54
  55 The above requirements are met using the setters described below.
  56
  57 CT_POLICY_EVAL_CTX_new() creates an empty policy evaluation context. This
  58 should then be populated using:
  59
  60 =over 2
  61
  62 =item *
  63
  64 CT_POLICY_EVAL_CTX_set1_cert() to provide the certificate the SCTs were issued for
  65
  66 Increments the reference count of the certificate.
  67
  68 =item *
  69
  70 CT_POLICY_EVAL_CTX_set1_issuer() to provide the issuer certificate
  71
  72 Increments the reference count of the certificate.
  73
  74 =item *
  75
  76 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE() to provide a list of logs that are trusted as sources of SCTs
  77
  78 Holds a pointer to the CTLOG_STORE, so the CTLOG_STORE must outlive the
  79 CT_POLICY_EVAL_CTX.
  80
  81 =item *
  82
  83 CT_POLICY_EVAL_CTX_set_time() to set the time SCTs should be compared with to determine if they are valid
  84
  85 The SCT timestamp will be compared to this time to check whether the SCT was
  86 issued in the future. RFC6962 states that "TLS clients MUST reject SCTs whose
  87 timestamp is in the future". By default, this will be set to 5 minutes in the
  88 future (e.g. (time() + 300) * 1000), to allow for clock drift.
  89
  90 The time should be in milliseconds since the Unix epoch.
  91
  92 =back
  93
  94 Each setter has a matching getter for accessing the current value.
  95
  96 When no longer required, the B<CT_POLICY_EVAL_CTX> should be passed to
  97 CT_POLICY_EVAL_CTX_free() to delete it.
  98
  99 =head1 NOTES
 100
 101 The issuer certificate only needs to be provided if at least one of the SCTs
 102 was issued for a pre-certificate. This will be the case for SCTs embedded in a
 103 certificate (i.e. those in an X.509 extension), but may not be the case for SCTs
 104 found in the TLS SCT extension or OCSP response.
 105
 106 =head1 RETURN VALUES
 107
 108 CT_POLICY_EVAL_CTX_new() will return NULL if malloc fails.
 109
 110 =head1 SEE ALSO
 111
 112 L<ct(7)>
 113
 114 =head1 HISTORY
 115
 116 These functions were added in OpenSSL 1.1.0.
 117
 118 =head1 COPYRIGHT
 119
 120 Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
 121
 122 Licensed under the OpenSSL license (the "License").  You may not use
 123 this file except in compliance with the License.  You can obtain a copy
 124 in the file LICENSE in the source distribution or at
 125 L<https://www.openssl.org/source/license.html>.
 126
 127 =cut