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 Encapsulates the data required to evaluate whether SCTs meet a Certificate Transparency policy
  10
  11 =head1 SYNOPSIS
  12
  13  #include <openssl/ct.h>
  14
  15  CT_POLICY_EVAL_CTX *CT_POLICY_EVAL_CTX_new(void);
  16  void CT_POLICY_EVAL_CTX_free(CT_POLICY_EVAL_CTX *ctx);
  17  X509* CT_POLICY_EVAL_CTX_get0_cert(const CT_POLICY_EVAL_CTX *ctx);
  18  int CT_POLICY_EVAL_CTX_set1_cert(CT_POLICY_EVAL_CTX *ctx, X509 *cert);
  19  X509* CT_POLICY_EVAL_CTX_get0_issuer(const CT_POLICY_EVAL_CTX *ctx);
  20  int CT_POLICY_EVAL_CTX_set1_issuer(CT_POLICY_EVAL_CTX *ctx, X509 *issuer);
  21  const CTLOG_STORE *CT_POLICY_EVAL_CTX_get0_log_store(const CT_POLICY_EVAL_CTX *ctx);
  22  void CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(CT_POLICY_EVAL_CTX *ctx, CTLOG_STORE *log_store);
  23
  24 =head1 DESCRIPTION
  25
  26 A B<CT_POLICY_EVAL_CTX> is used by functions that evaluate whether Signed
  27 Certificate Timestamps (SCTs) fulfil a Certificate Transparency (CT) policy.
  28 This policy may be, for example, that at least one valid SCT is available. To
  29 determine this, an SCT's signature must be verified. This requires:
  30
  31 =over
  32
  33 =item * the public key of the log that issued the SCT
  34
  35 =item * the certificate that the SCT was issued for
  36
  37 =item * the issuer certificate (if the SCT was issued for a pre-certificate)
  38
  39 =back
  40
  41 The above requirements are met using the setters described below.
  42
  43 CT_POLICY_EVAL_CTX_new() creates an empty policy evaluation context. This
  44 should then be populated using:
  45
  46 =over
  47
  48 =item * CT_POLICY_EVAL_CTX_set1_cert() to provide the certificate the SCTs were issued for
  49
  50 Increments the reference count of the certificate.
  51
  52 =item * CT_POLICY_EVAL_CTX_set1_issuer() to provide the issuer certificate
  53
  54 Increments the reference count of the certificate.
  55
  56 =item * CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE() to provide a list of logs that are trusted as sources of SCTs
  57
  58 Holds a pointer to the CTLOG_STORE, so the CTLOG_STORE must outlive the
  59 CT_POLICY_EVAL_CTX.
  60
  61 =back
  62
  63 Each setter has a matching getter for accessing the current value.
  64
  65 When no longer required, the B<CT_POLICY_EVAL_CTX> should be passed to
  66 CT_POLICY_EVAL_CTX_free() to delete it.
  67
  68 =head1 NOTES
  69
  70 The issuer certificate only needs to be provided if at least one of the SCTs
  71 was issued for a pre-certificate. This will be the case for SCTs embedded in a
  72 certificate (i.e. those in an X.509 extension), but may not be the case for SCTs
  73 found in the TLS SCT extension or OCSP response.
  74
  75 =head1 RETURN VALUES
  76
  77 CT_POLICY_EVAL_CTX_new() will return NULL if malloc fails.
  78
  79 =head1 SEE ALSO
  80
  81 L<ct(3)>
  82
  83 =head1 HISTORY
  84
  85 These functions were added in OpenSSL 1.1.0.
  86
  87 =head1 COPYRIGHT
  88
  89 Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
  90
  91 Licensed under the OpenSSL license (the "License").  You may not use
  92 this file except in compliance with the License.  You can obtain a copy
  93 in the file LICENSE in the source distribution or at
  94 L<https://www.openssl.org/source/license.html>.
  95
  96 =cut