2 * Copyright 2016-2021 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
14 #include <openssl/ct.h>
15 #include <openssl/err.h>
16 #include <openssl/evp.h>
17 #include <openssl/tls1.h>
18 #include <openssl/x509.h>
24 SCT
*sct
= OPENSSL_zalloc(sizeof(*sct
));
29 sct
->entry_type
= CT_LOG_ENTRY_TYPE_NOT_SET
;
30 sct
->version
= SCT_VERSION_NOT_SET
;
34 void SCT_free(SCT
*sct
)
39 OPENSSL_free(sct
->log_id
);
40 OPENSSL_free(sct
->ext
);
41 OPENSSL_free(sct
->sig
);
42 OPENSSL_free(sct
->sct
);
46 void SCT_LIST_free(STACK_OF(SCT
) *a
)
48 sk_SCT_pop_free(a
, SCT_free
);
51 int SCT_set_version(SCT
*sct
, sct_version_t version
)
53 if (version
!= SCT_VERSION_V1
) {
54 ERR_raise(ERR_LIB_CT
, CT_R_UNSUPPORTED_VERSION
);
57 sct
->version
= version
;
58 sct
->validation_status
= SCT_VALIDATION_STATUS_NOT_SET
;
62 int SCT_set_log_entry_type(SCT
*sct
, ct_log_entry_type_t entry_type
)
64 sct
->validation_status
= SCT_VALIDATION_STATUS_NOT_SET
;
67 case CT_LOG_ENTRY_TYPE_X509
:
68 case CT_LOG_ENTRY_TYPE_PRECERT
:
69 sct
->entry_type
= entry_type
;
71 case CT_LOG_ENTRY_TYPE_NOT_SET
:
74 ERR_raise(ERR_LIB_CT
, CT_R_UNSUPPORTED_ENTRY_TYPE
);
78 int SCT_set0_log_id(SCT
*sct
, unsigned char *log_id
, size_t log_id_len
)
80 if (sct
->version
== SCT_VERSION_V1
&& log_id_len
!= CT_V1_HASHLEN
) {
81 ERR_raise(ERR_LIB_CT
, CT_R_INVALID_LOG_ID_LENGTH
);
85 OPENSSL_free(sct
->log_id
);
87 sct
->log_id_len
= log_id_len
;
88 sct
->validation_status
= SCT_VALIDATION_STATUS_NOT_SET
;
92 int SCT_set1_log_id(SCT
*sct
, const unsigned char *log_id
, size_t log_id_len
)
94 if (sct
->version
== SCT_VERSION_V1
&& log_id_len
!= CT_V1_HASHLEN
) {
95 ERR_raise(ERR_LIB_CT
, CT_R_INVALID_LOG_ID_LENGTH
);
99 OPENSSL_free(sct
->log_id
);
102 sct
->validation_status
= SCT_VALIDATION_STATUS_NOT_SET
;
104 if (log_id
!= NULL
&& log_id_len
> 0) {
105 sct
->log_id
= OPENSSL_memdup(log_id
, log_id_len
);
106 if (sct
->log_id
== NULL
)
108 sct
->log_id_len
= log_id_len
;
114 void SCT_set_timestamp(SCT
*sct
, uint64_t timestamp
)
116 sct
->timestamp
= timestamp
;
117 sct
->validation_status
= SCT_VALIDATION_STATUS_NOT_SET
;
120 int SCT_set_signature_nid(SCT
*sct
, int nid
)
123 case NID_sha256WithRSAEncryption
:
124 sct
->hash_alg
= TLSEXT_hash_sha256
;
125 sct
->sig_alg
= TLSEXT_signature_rsa
;
126 sct
->validation_status
= SCT_VALIDATION_STATUS_NOT_SET
;
128 case NID_ecdsa_with_SHA256
:
129 sct
->hash_alg
= TLSEXT_hash_sha256
;
130 sct
->sig_alg
= TLSEXT_signature_ecdsa
;
131 sct
->validation_status
= SCT_VALIDATION_STATUS_NOT_SET
;
134 ERR_raise(ERR_LIB_CT
, CT_R_UNRECOGNIZED_SIGNATURE_NID
);
139 void SCT_set0_extensions(SCT
*sct
, unsigned char *ext
, size_t ext_len
)
141 OPENSSL_free(sct
->ext
);
143 sct
->ext_len
= ext_len
;
144 sct
->validation_status
= SCT_VALIDATION_STATUS_NOT_SET
;
147 int SCT_set1_extensions(SCT
*sct
, const unsigned char *ext
, size_t ext_len
)
149 OPENSSL_free(sct
->ext
);
152 sct
->validation_status
= SCT_VALIDATION_STATUS_NOT_SET
;
154 if (ext
!= NULL
&& ext_len
> 0) {
155 sct
->ext
= OPENSSL_memdup(ext
, ext_len
);
156 if (sct
->ext
== NULL
)
158 sct
->ext_len
= ext_len
;
163 void SCT_set0_signature(SCT
*sct
, unsigned char *sig
, size_t sig_len
)
165 OPENSSL_free(sct
->sig
);
167 sct
->sig_len
= sig_len
;
168 sct
->validation_status
= SCT_VALIDATION_STATUS_NOT_SET
;
171 int SCT_set1_signature(SCT
*sct
, const unsigned char *sig
, size_t sig_len
)
173 OPENSSL_free(sct
->sig
);
176 sct
->validation_status
= SCT_VALIDATION_STATUS_NOT_SET
;
178 if (sig
!= NULL
&& sig_len
> 0) {
179 sct
->sig
= OPENSSL_memdup(sig
, sig_len
);
180 if (sct
->sig
== NULL
)
182 sct
->sig_len
= sig_len
;
187 sct_version_t
SCT_get_version(const SCT
*sct
)
192 ct_log_entry_type_t
SCT_get_log_entry_type(const SCT
*sct
)
194 return sct
->entry_type
;
197 size_t SCT_get0_log_id(const SCT
*sct
, unsigned char **log_id
)
199 *log_id
= sct
->log_id
;
200 return sct
->log_id_len
;
203 uint64_t SCT_get_timestamp(const SCT
*sct
)
205 return sct
->timestamp
;
208 int SCT_get_signature_nid(const SCT
*sct
)
210 if (sct
->version
== SCT_VERSION_V1
) {
211 if (sct
->hash_alg
== TLSEXT_hash_sha256
) {
212 switch (sct
->sig_alg
) {
213 case TLSEXT_signature_ecdsa
:
214 return NID_ecdsa_with_SHA256
;
215 case TLSEXT_signature_rsa
:
216 return NID_sha256WithRSAEncryption
;
225 size_t SCT_get0_extensions(const SCT
*sct
, unsigned char **ext
)
231 size_t SCT_get0_signature(const SCT
*sct
, unsigned char **sig
)
237 int SCT_is_complete(const SCT
*sct
)
239 switch (sct
->version
) {
240 case SCT_VERSION_NOT_SET
:
243 return sct
->log_id
!= NULL
&& SCT_signature_is_complete(sct
);
245 return sct
->sct
!= NULL
; /* Just need cached encoding */
249 int SCT_signature_is_complete(const SCT
*sct
)
251 return SCT_get_signature_nid(sct
) != NID_undef
&&
252 sct
->sig
!= NULL
&& sct
->sig_len
> 0;
255 sct_source_t
SCT_get_source(const SCT
*sct
)
260 int SCT_set_source(SCT
*sct
, sct_source_t source
)
262 sct
->source
= source
;
263 sct
->validation_status
= SCT_VALIDATION_STATUS_NOT_SET
;
265 case SCT_SOURCE_TLS_EXTENSION
:
266 case SCT_SOURCE_OCSP_STAPLED_RESPONSE
:
267 return SCT_set_log_entry_type(sct
, CT_LOG_ENTRY_TYPE_X509
);
268 case SCT_SOURCE_X509V3_EXTENSION
:
269 return SCT_set_log_entry_type(sct
, CT_LOG_ENTRY_TYPE_PRECERT
);
270 case SCT_SOURCE_UNKNOWN
:
273 /* if we aren't sure, leave the log entry type alone */
277 sct_validation_status_t
SCT_get_validation_status(const SCT
*sct
)
279 return sct
->validation_status
;
282 int SCT_validate(SCT
*sct
, const CT_POLICY_EVAL_CTX
*ctx
)
284 int is_sct_valid
= -1;
285 SCT_CTX
*sctx
= NULL
;
286 X509_PUBKEY
*pub
= NULL
, *log_pkey
= NULL
;
290 * With an unrecognized SCT version we don't know what such an SCT means,
291 * let alone validate one. So we return validation failure (0).
293 if (sct
->version
!= SCT_VERSION_V1
) {
294 sct
->validation_status
= SCT_VALIDATION_STATUS_UNKNOWN_VERSION
;
298 log
= CTLOG_STORE_get0_log_by_id(ctx
->log_store
,
299 sct
->log_id
, sct
->log_id_len
);
301 /* Similarly, an SCT from an unknown log also cannot be validated. */
303 sct
->validation_status
= SCT_VALIDATION_STATUS_UNKNOWN_LOG
;
307 sctx
= SCT_CTX_new(ctx
->libctx
, ctx
->propq
);
311 if (X509_PUBKEY_set(&log_pkey
, CTLOG_get0_public_key(log
)) != 1)
313 if (SCT_CTX_set1_pubkey(sctx
, log_pkey
) != 1)
316 if (SCT_get_log_entry_type(sct
) == CT_LOG_ENTRY_TYPE_PRECERT
) {
317 EVP_PKEY
*issuer_pkey
;
319 if (ctx
->issuer
== NULL
) {
320 sct
->validation_status
= SCT_VALIDATION_STATUS_UNVERIFIED
;
324 issuer_pkey
= X509_get0_pubkey(ctx
->issuer
);
326 if (X509_PUBKEY_set(&pub
, issuer_pkey
) != 1)
328 if (SCT_CTX_set1_issuer_pubkey(sctx
, pub
) != 1)
332 SCT_CTX_set_time(sctx
, ctx
->epoch_time_in_ms
);
335 * XXX: Potential for optimization. This repeats some idempotent heavy
336 * lifting on the certificate for each candidate SCT, and appears to not
337 * use any information in the SCT itself, only the certificate is
338 * processed. So it may make more sense to do this just once, perhaps
339 * associated with the shared (by all SCTs) policy eval ctx.
341 * XXX: Failure here is global (SCT independent) and represents either an
342 * issue with the certificate (e.g. duplicate extensions) or an out of
343 * memory condition. When the certificate is incompatible with CT, we just
344 * mark the SCTs invalid, rather than report a failure to determine the
345 * validation status. That way, callbacks that want to do "soft" SCT
346 * processing will not abort handshakes with false positive internal
347 * errors. Since the function does not distinguish between certificate
348 * issues (peer's fault) and internal problems (out fault) the safe thing
349 * to do is to report a validation failure and let the callback or
350 * application decide what to do.
352 if (SCT_CTX_set1_cert(sctx
, ctx
->cert
, NULL
) != 1)
353 sct
->validation_status
= SCT_VALIDATION_STATUS_UNVERIFIED
;
355 sct
->validation_status
= SCT_CTX_verify(sctx
, sct
) == 1 ?
356 SCT_VALIDATION_STATUS_VALID
: SCT_VALIDATION_STATUS_INVALID
;
359 is_sct_valid
= sct
->validation_status
== SCT_VALIDATION_STATUS_VALID
;
361 X509_PUBKEY_free(pub
);
362 X509_PUBKEY_free(log_pkey
);
368 int SCT_LIST_validate(const STACK_OF(SCT
) *scts
, CT_POLICY_EVAL_CTX
*ctx
)
370 int are_scts_valid
= 1;
371 int sct_count
= scts
!= NULL
? sk_SCT_num(scts
) : 0;
374 for (i
= 0; i
< sct_count
; ++i
) {
375 int is_sct_valid
= -1;
376 SCT
*sct
= sk_SCT_value(scts
, i
);
381 is_sct_valid
= SCT_validate(sct
, ctx
);
382 if (is_sct_valid
< 0)
384 are_scts_valid
&= is_sct_valid
;
387 return are_scts_valid
;