Reword documentation for {SCT_CTX/CT_POLICY_EVAL_CTX}_set_time
[openssl.git] / 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
36
37 =item * the public key of the log that issued the SCT
38
39 =item * the certificate that the SCT was issued for
40
41 =item * the issuer certificate (if the SCT was issued for a pre-certificate)
42
43 =item * the current time
44
45 =back
46
47 The above requirements are met using the setters described below.
48
49 CT_POLICY_EVAL_CTX_new() creates an empty policy evaluation context. This
50 should then be populated using:
51
52 =over
53
54 =item * CT_POLICY_EVAL_CTX_set1_cert() to provide the certificate the SCTs were issued for
55
56 Increments the reference count of the certificate.
57
58 =item * CT_POLICY_EVAL_CTX_set1_issuer() to provide the issuer certificate
59
60 Increments the reference count of the certificate.
61
62 =item * CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE() to provide a list of logs that are trusted as sources of SCTs
63
64 Holds a pointer to the CTLOG_STORE, so the CTLOG_STORE must outlive the
65 CT_POLICY_EVAL_CTX.
66
67 =item * CT_POLICY_EVAL_CTX_set_time() to set the time SCTs should be compared with to determine if they are valid
68
69 The SCT timestamp will be compared to this time to check whether the SCT was
70 issued in the future. RFC6962 states that "TLS clients MUST reject SCTs whose
71 timestamp is in the future". Typically, the time provided to this function will
72 be the current time.
73
74 The time should be in milliseconds since the Unix epoch.
75
76 =back
77
78 Each setter has a matching getter for accessing the current value.
79
80 When no longer required, the B<CT_POLICY_EVAL_CTX> should be passed to
81 CT_POLICY_EVAL_CTX_free() to delete it.
82
83 =head1 NOTES
84
85 The issuer certificate only needs to be provided if at least one of the SCTs
86 was issued for a pre-certificate. This will be the case for SCTs embedded in a
87 certificate (i.e. those in an X.509 extension), but may not be the case for SCTs
88 found in the TLS SCT extension or OCSP response.
89
90 =head1 RETURN VALUES
91
92 CT_POLICY_EVAL_CTX_new() will return NULL if malloc fails.
93
94 =head1 SEE ALSO
95
96 L<ct(7)>
97
98 =head1 HISTORY
99
100 These functions were added in OpenSSL 1.1.0.
101
102 =head1 COPYRIGHT
103
104 Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
105
106 Licensed under the OpenSSL license (the "License").  You may not use
107 this file except in compliance with the License.  You can obtain a copy
108 in the file LICENSE in the source distribution or at
109 L<https://www.openssl.org/source/license.html>.
110
111 =cut