2 * Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (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
13 # include <openssl/opensslconf.h>
15 # ifndef OPENSSL_NO_CT
16 # include <openssl/ossl_typ.h>
17 # include <openssl/safestack.h>
18 # include <openssl/x509.h>
24 /* Minimum RSA key size, from RFC6962 */
25 # define SCT_MIN_RSA_BITS 2048
27 /* All hashes are SHA256 in v1 of Certificate Transparency */
28 # define CT_V1_HASHLEN SHA256_DIGEST_LENGTH
31 CT_LOG_ENTRY_TYPE_NOT_SET = -1,
32 CT_LOG_ENTRY_TYPE_X509 = 0,
33 CT_LOG_ENTRY_TYPE_PRECERT = 1
34 } ct_log_entry_type_t;
37 SCT_VERSION_NOT_SET = -1,
43 SCT_SOURCE_TLS_EXTENSION,
44 SCT_SOURCE_X509V3_EXTENSION,
45 SCT_SOURCE_OCSP_STAPLED_RESPONSE
49 SCT_VALIDATION_STATUS_NOT_SET,
50 SCT_VALIDATION_STATUS_UNKNOWN_LOG,
51 SCT_VALIDATION_STATUS_VALID,
52 SCT_VALIDATION_STATUS_INVALID,
53 SCT_VALIDATION_STATUS_UNVERIFIED,
54 SCT_VALIDATION_STATUS_UNKNOWN_VERSION
55 } sct_validation_status_t;
58 DEFINE_STACK_OF(CTLOG)
60 /******************************************
61 * CT policy evaluation context functions *
62 ******************************************/
64 /* Creates a new, empty policy evaluation context */
65 CT_POLICY_EVAL_CTX *CT_POLICY_EVAL_CTX_new(void);
67 /* Deletes a policy evaluation context and anything it owns. */
68 void CT_POLICY_EVAL_CTX_free(CT_POLICY_EVAL_CTX *ctx);
70 /* Gets the peer certificate that the SCTs are for */
71 X509* CT_POLICY_EVAL_CTX_get0_cert(const CT_POLICY_EVAL_CTX *ctx);
74 * Sets the certificate associated with the received SCTs.
75 * Incremenets the reference count of cert.
76 * Returns 1 on success, 0 otherwise.
78 int CT_POLICY_EVAL_CTX_set1_cert(CT_POLICY_EVAL_CTX *ctx, X509 *cert);
80 /* Gets the issuer of the aforementioned certificate */
81 X509* CT_POLICY_EVAL_CTX_get0_issuer(const CT_POLICY_EVAL_CTX *ctx);
84 * Sets the issuer of the certificate associated with the received SCTs.
85 * Increments the reference count of issuer.
86 * Returns 1 on success, 0 otherwise.
88 int CT_POLICY_EVAL_CTX_set1_issuer(CT_POLICY_EVAL_CTX *ctx, X509 *issuer);
90 /* Gets the CT logs that are trusted sources of SCTs */
91 const CTLOG_STORE *CT_POLICY_EVAL_CTX_get0_log_store(const CT_POLICY_EVAL_CTX *ctx);
93 /* Sets the log store that is in use. It must outlive the CT_POLICY_EVAL_CTX. */
94 void CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(CT_POLICY_EVAL_CTX *ctx,
95 CTLOG_STORE *log_store);
102 * Creates a new, blank SCT.
103 * The caller is responsible for calling SCT_free when finished with the SCT.
108 * Creates a new SCT from some base64-encoded strings.
109 * The caller is responsible for calling SCT_free when finished with the SCT.
111 SCT *SCT_new_from_base64(unsigned char version,
112 const char *logid_base64,
113 ct_log_entry_type_t entry_type,
115 const char *extensions_base64,
116 const char *signature_base64);
119 * Frees the SCT and the underlying data structures.
121 void SCT_free(SCT *sct);
124 * Free a stack of SCTs, and the underlying SCTs themselves.
125 * Intended to be compatible with X509V3_EXT_FREE.
127 void SCT_LIST_free(STACK_OF(SCT) *a);
130 * Returns the version of the SCT.
132 sct_version_t SCT_get_version(const SCT *sct);
135 * Set the version of an SCT.
136 * Returns 1 on success, 0 if the version is unrecognized.
138 __owur int SCT_set_version(SCT *sct, sct_version_t version);
141 * Returns the log entry type of the SCT.
143 ct_log_entry_type_t SCT_get_log_entry_type(const SCT *sct);
146 * Set the log entry type of an SCT.
147 * Returns 1 on success, 0 otherwise.
149 __owur int SCT_set_log_entry_type(SCT *sct, ct_log_entry_type_t entry_type);
152 * Gets the ID of the log that an SCT came from.
153 * Ownership of the log ID remains with the SCT.
154 * Returns the length of the log ID.
156 size_t SCT_get0_log_id(const SCT *sct, unsigned char **log_id);
159 * Set the log ID of an SCT to point directly to the *log_id specified.
160 * The SCT takes ownership of the specified pointer.
161 * Returns 1 on success, 0 otherwise.
163 __owur int SCT_set0_log_id(SCT *sct, unsigned char *log_id, size_t log_id_len);
166 * Set the log ID of an SCT.
167 * This makes a copy of the log_id.
168 * Returns 1 on success, 0 otherwise.
170 __owur int SCT_set1_log_id(SCT *sct, const unsigned char *log_id,
174 * Returns the timestamp for the SCT (epoch time in milliseconds).
176 uint64_t SCT_get_timestamp(const SCT *sct);
179 * Set the timestamp of an SCT (epoch time in milliseconds).
181 void SCT_set_timestamp(SCT *sct, uint64_t timestamp);
184 * Return the NID for the signature used by the SCT.
185 * For CT v1, this will be either NID_sha256WithRSAEncryption or
186 * NID_ecdsa_with_SHA256 (or NID_undef if incorrect/unset).
188 int SCT_get_signature_nid(const SCT *sct);
191 * Set the signature type of an SCT
192 * For CT v1, this should be either NID_sha256WithRSAEncryption or
193 * NID_ecdsa_with_SHA256.
194 * Returns 1 on success, 0 otherwise.
196 __owur int SCT_set_signature_nid(SCT *sct, int nid);
199 * Set *ext to point to the extension data for the SCT. ext must not be NULL.
200 * The SCT retains ownership of this pointer.
201 * Returns length of the data pointed to.
203 size_t SCT_get0_extensions(const SCT *sct, unsigned char **ext);
206 * Set the extensions of an SCT to point directly to the *ext specified.
207 * The SCT takes ownership of the specified pointer.
209 void SCT_set0_extensions(SCT *sct, unsigned char *ext, size_t ext_len);
212 * Set the extensions of an SCT.
213 * This takes a copy of the ext.
214 * Returns 1 on success, 0 otherwise.
216 __owur int SCT_set1_extensions(SCT *sct, const unsigned char *ext,
220 * Set *sig to point to the signature for the SCT. sig must not be NULL.
221 * The SCT retains ownership of this pointer.
222 * Returns length of the data pointed to.
224 size_t SCT_get0_signature(const SCT *sct, unsigned char **sig);
227 * Set the signature of an SCT to point directly to the *sig specified.
228 * The SCT takes ownership of the specified pointer.
230 void SCT_set0_signature(SCT *sct, unsigned char *sig, size_t sig_len);
233 * Set the signature of an SCT to be a copy of the *sig specified.
234 * Returns 1 on success, 0 otherwise.
236 __owur int SCT_set1_signature(SCT *sct, const unsigned char *sig,
240 * The origin of this SCT, e.g. TLS extension, OCSP response, etc.
242 sct_source_t SCT_get_source(const SCT *sct);
245 * Set the origin of this SCT, e.g. TLS extension, OCSP response, etc.
246 * Returns 1 on success, 0 otherwise.
248 __owur int SCT_set_source(SCT *sct, sct_source_t source);
251 * Returns a text string describing the validation status of |sct|.
253 const char *SCT_validation_status_string(const SCT *sct);
256 * Pretty-prints an |sct| to |out|.
257 * It will be indented by the number of spaces specified by |indent|.
258 * If |logs| is not NULL, it will be used to lookup the CT log that the SCT came
259 * from, so that the log name can be printed.
261 void SCT_print(const SCT *sct, BIO *out, int indent, const CTLOG_STORE *logs);
264 * Pretty-prints an |sct_list| to |out|.
265 * It will be indented by the number of spaces specified by |indent|.
266 * SCTs will be delimited by |separator|.
267 * If |logs| is not NULL, it will be used to lookup the CT log that each SCT
268 * came from, so that the log names can be printed.
270 void SCT_LIST_print(const STACK_OF(SCT) *sct_list, BIO *out, int indent,
271 const char *separator, const CTLOG_STORE *logs);
274 * Verifies an SCT with the given context.
275 * Returns 1 if the SCT verifies successfully, 0 otherwise.
277 __owur int SCT_verify(const SCT_CTX *sctx, const SCT *sct);
280 * Verifies an SCT against the provided data.
281 * Returns 1 if the SCT verifies successfully, 0 otherwise.
283 __owur int SCT_verify_v1(SCT *sct, X509 *cert, X509 *preissuer,
284 X509_PUBKEY *log_pubkey, X509 *issuer_cert);
287 * Gets the last result of validating this SCT.
288 * If it has not been validated yet, returns SCT_VALIDATION_STATUS_NOT_SET.
290 sct_validation_status_t SCT_get_validation_status(const SCT *sct);
293 * Validates the given SCT with the provided context.
294 * Sets the "validation_status" field of the SCT.
295 * Returns 1 if the SCT is valid and the signature verifies.
296 * Returns 0 if the SCT is invalid or could not be verified.
297 * Returns -1 if an error occurs.
299 __owur int SCT_validate(SCT *sct, const CT_POLICY_EVAL_CTX *ctx);
302 * Validates the given list of SCTs with the provided context.
303 * Populates the "good_scts" and "bad_scts" of the evaluation context.
304 * Returns 1 if there are no invalid SCTs and all signatures verify.
305 * Returns 0 if at least one SCT is invalid or could not be verified.
306 * Returns a negative integer if an error occurs.
308 __owur int SCT_LIST_validate(const STACK_OF(SCT) *scts,
309 CT_POLICY_EVAL_CTX *ctx);
312 /*********************************
313 * SCT parsing and serialisation *
314 *********************************/
317 * Serialize (to TLS format) a stack of SCTs and return the length.
318 * "a" must not be NULL.
319 * If "pp" is NULL, just return the length of what would have been serialized.
320 * If "pp" is not NULL and "*pp" is null, function will allocate a new pointer
321 * for data that caller is responsible for freeing (only if function returns
323 * If "pp" is NULL and "*pp" is not NULL, caller is responsible for ensuring
324 * that "*pp" is large enough to accept all of the serialized data.
325 * Returns < 0 on error, >= 0 indicating bytes written (or would have been)
328 __owur int i2o_SCT_LIST(const STACK_OF(SCT) *a, unsigned char **pp);
331 * Convert TLS format SCT list to a stack of SCTs.
332 * If "a" or "*a" is NULL, a new stack will be created that the caller is
333 * responsible for freeing (by calling SCT_LIST_free).
334 * "**pp" and "*pp" must not be NULL.
335 * Upon success, "*pp" will point to after the last bytes read, and a stack
337 * Upon failure, a NULL pointer will be returned, and the position of "*pp" is
340 STACK_OF(SCT) *o2i_SCT_LIST(STACK_OF(SCT) **a, const unsigned char **pp,
344 * Serialize (to DER format) a stack of SCTs and return the length.
345 * "a" must not be NULL.
346 * If "pp" is NULL, just returns the length of what would have been serialized.
347 * If "pp" is not NULL and "*pp" is null, function will allocate a new pointer
348 * for data that caller is responsible for freeing (only if function returns
350 * If "pp" is NULL and "*pp" is not NULL, caller is responsible for ensuring
351 * that "*pp" is large enough to accept all of the serialized data.
352 * Returns < 0 on error, >= 0 indicating bytes written (or would have been)
355 __owur int i2d_SCT_LIST(const STACK_OF(SCT) *a, unsigned char **pp);
358 * Parses an SCT list in DER format and returns it.
359 * If "a" or "*a" is NULL, a new stack will be created that the caller is
360 * responsible for freeing (by calling SCT_LIST_free).
361 * "**pp" and "*pp" must not be NULL.
362 * Upon success, "*pp" will point to after the last bytes read, and a stack
364 * Upon failure, a NULL pointer will be returned, and the position of "*pp" is
367 STACK_OF(SCT) *d2i_SCT_LIST(STACK_OF(SCT) **a, const unsigned char **pp,
371 * Serialize (to TLS format) an |sct| and write it to |out|.
372 * If |out| is null, no SCT will be output but the length will still be returned.
373 * If |out| points to a null pointer, a string will be allocated to hold the
374 * TLS-format SCT. It is the responsibility of the caller to free it.
375 * If |out| points to an allocated string, the TLS-format SCT will be written
377 * The length of the SCT in TLS format will be returned.
379 __owur int i2o_SCT(const SCT *sct, unsigned char **out);
382 * Parses an SCT in TLS format and returns it.
383 * If |psct| is not null, it will end up pointing to the parsed SCT. If it
384 * already points to a non-null pointer, the pointer will be free'd.
385 * |in| should be a pointer to a string containing the TLS-format SCT.
386 * |in| will be advanced to the end of the SCT if parsing succeeds.
387 * |len| should be the length of the SCT in |in|.
388 * Returns NULL if an error occurs.
389 * If the SCT is an unsupported version, only the SCT's 'sct' and 'sct_len'
390 * fields will be populated (with |in| and |len| respectively).
392 SCT *o2i_SCT(SCT **psct, const unsigned char **in, size_t len);
395 * Serialize (to TLS format) an |sct| signature and write it to |out|.
396 * If |out| is null, no signature will be output but the length will be returned.
397 * If |out| points to a null pointer, a string will be allocated to hold the
398 * TLS-format signature. It is the responsibility of the caller to free it.
399 * If |out| points to an allocated string, the signature will be written to it.
400 * The length of the signature in TLS format will be returned.
402 __owur int i2o_SCT_signature(const SCT *sct, unsigned char **out);
405 * Parses an SCT signature in TLS format and populates the |sct| with it.
406 * |in| should be a pointer to a string containing the TLS-format signature.
407 * |in| will be advanced to the end of the signature if parsing succeeds.
408 * |len| should be the length of the signature in |in|.
409 * Returns the number of bytes parsed, or a negative integer if an error occurs.
411 __owur int o2i_SCT_signature(SCT *sct, const unsigned char **in, size_t len);
413 /********************
415 ********************/
418 * Creates a new CT log instance with the given |public_key| and |name|.
419 * Returns NULL if malloc fails or if |public_key| cannot be converted to DER.
420 * Should be deleted by the caller using CTLOG_free when no longer needed.
422 CTLOG *CTLOG_new(EVP_PKEY *public_key, const char *name);
425 * Creates a new CTLOG instance with the base64-encoded SubjectPublicKeyInfo DER
426 * in |pkey_base64|. The |name| is a string to help users identify this log.
427 * Returns 1 on success, 0 on failure.
428 * Should be deleted by the caller using CTLOG_free when no longer needed.
430 int CTLOG_new_from_base64(CTLOG ** ct_log,
431 const char *pkey_base64, const char *name);
434 * Deletes a CT log instance and its fields.
436 void CTLOG_free(CTLOG *log);
438 /* Gets the name of the CT log */
439 const char *CTLOG_get0_name(const CTLOG *log);
440 /* Gets the ID of the CT log */
441 void CTLOG_get0_log_id(const CTLOG *log, const uint8_t **log_id,
443 /* Gets the public key of the CT log */
444 EVP_PKEY *CTLOG_get0_public_key(const CTLOG *log);
446 /**************************
447 * CT log store functions *
448 **************************/
451 * Creates a new CT log store.
452 * Should be deleted by the caller using CTLOG_STORE_free when no longer needed.
454 CTLOG_STORE *CTLOG_STORE_new(void);
457 * Deletes a CT log store and all of the CT log instances held within.
459 void CTLOG_STORE_free(CTLOG_STORE *store);
462 * Finds a CT log in the store based on its log ID.
463 * Returns the CT log, or NULL if no match is found.
465 const CTLOG *CTLOG_STORE_get0_log_by_id(const CTLOG_STORE *store,
466 const uint8_t *log_id,
470 * Loads a CT log list into a |store| from a |file|.
471 * Returns 1 if loading is successful, or 0 otherwise.
473 __owur int CTLOG_STORE_load_file(CTLOG_STORE *store, const char *file);
476 * Loads the default CT log list into a |store|.
477 * See internal/cryptlib.h for the environment variable and file path that are
478 * consulted to find the default file.
479 * Returns 1 if loading is successful, or 0 otherwise.
481 __owur int CTLOG_STORE_load_default_file(CTLOG_STORE *store);
483 /* BEGIN ERROR CODES */
485 * The following lines are auto generated by the script mkerr.pl. Any changes
486 * made after this point may be overwritten when the script is next run.
489 int ERR_load_CT_strings(void);
491 /* Error codes for the CT functions. */
493 /* Function codes. */
494 # define CT_F_CTLOG_NEW 117
495 # define CT_F_CTLOG_NEW_FROM_BASE64 118
496 # define CT_F_CTLOG_NEW_FROM_CONF 119
497 # define CT_F_CTLOG_NEW_NULL 120
498 # define CT_F_CTLOG_STORE_LOAD_CTX_NEW 122
499 # define CT_F_CTLOG_STORE_LOAD_FILE 123
500 # define CT_F_CTLOG_STORE_LOAD_LOG 130
501 # define CT_F_CTLOG_STORE_NEW 131
502 # define CT_F_CT_BASE64_DECODE 124
503 # define CT_F_CT_POLICY_EVAL_CTX_NEW 133
504 # define CT_F_CT_V1_LOG_ID_FROM_PKEY 125
505 # define CT_F_I2O_SCT 107
506 # define CT_F_I2O_SCT_LIST 108
507 # define CT_F_I2O_SCT_SIGNATURE 109
508 # define CT_F_O2I_SCT 110
509 # define CT_F_O2I_SCT_LIST 111
510 # define CT_F_O2I_SCT_SIGNATURE 112
511 # define CT_F_SCT_CTX_NEW 126
512 # define CT_F_SCT_NEW 100
513 # define CT_F_SCT_NEW_FROM_BASE64 127
514 # define CT_F_SCT_SET0_LOG_ID 101
515 # define CT_F_SCT_SET1_EXTENSIONS 114
516 # define CT_F_SCT_SET1_LOG_ID 115
517 # define CT_F_SCT_SET1_SIGNATURE 116
518 # define CT_F_SCT_SET_LOG_ENTRY_TYPE 102
519 # define CT_F_SCT_SET_SIGNATURE_NID 103
520 # define CT_F_SCT_SET_VERSION 104
521 # define CT_F_SCT_VERIFY 128
522 # define CT_F_SCT_VERIFY_V1 129
525 # define CT_R_BASE64_DECODE_ERROR 108
526 # define CT_R_INVALID_LOG_ID_LENGTH 100
527 # define CT_R_LOG_CONF_INVALID 109
528 # define CT_R_LOG_CONF_INVALID_KEY 110
529 # define CT_R_LOG_CONF_MISSING_DESCRIPTION 111
530 # define CT_R_LOG_CONF_MISSING_KEY 112
531 # define CT_R_LOG_KEY_INVALID 113
532 # define CT_R_SCT_INVALID 104
533 # define CT_R_SCT_INVALID_SIGNATURE 107
534 # define CT_R_SCT_LIST_INVALID 105
535 # define CT_R_SCT_LOG_ID_MISMATCH 114
536 # define CT_R_SCT_NOT_SET 106
537 # define CT_R_SCT_UNSUPPORTED_VERSION 115
538 # define CT_R_UNRECOGNIZED_SIGNATURE_NID 101
539 # define CT_R_UNSUPPORTED_ENTRY_TYPE 102
540 # define CT_R_UNSUPPORTED_VERSION 103