CT_POLICY_EVAL_CTX_new.pod 3.8 KB

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