X-Git-Url: https://git.openssl.org/gitweb/?p=openssl.git;a=blobdiff_plain;f=include%2Fopenssl%2Fct.h;h=ccbb8053041f56869ab7283dcaa01f0ceb5912c4;hp=520174ff9acbeda9488a07f23238d0baab7339a1;hb=12d2d2818566561cbdda82a6ad1b3aab687fc020;hpb=a8d177acf0bbb4da4d7c2d9dd4c645d447f8da75 diff --git a/include/openssl/ct.h b/include/openssl/ct.h index 520174ff9a..ccbb805304 100644 --- a/include/openssl/ct.h +++ b/include/openssl/ct.h @@ -83,7 +83,68 @@ typedef enum { SCT_VERSION_V1 = 0 } sct_version_t; +typedef enum { + SCT_SOURCE_UNKNOWN, + SCT_SOURCE_TLS_EXTENSION, + SCT_SOURCE_X509V3_EXTENSION, + SCT_SOURCE_OCSP_STAPLED_RESPONSE +} sct_source_t; + +typedef enum { + SCT_VALIDATION_STATUS_NOT_SET, + SCT_VALIDATION_STATUS_UNKNOWN_LOG, + SCT_VALIDATION_STATUS_VALID, + SCT_VALIDATION_STATUS_INVALID, + SCT_VALIDATION_STATUS_UNVERIFIED, + SCT_VALIDATION_STATUS_UNKNOWN_VERSION +} sct_validation_status_t; + DEFINE_STACK_OF(SCT) +DEFINE_STACK_OF(CTLOG) + +/****************************************** + * CT policy evaluation context functions * + ******************************************/ + +/* Creates a new, empty policy evaluation context */ +CT_POLICY_EVAL_CTX *CT_POLICY_EVAL_CTX_new(void); + +/* Deletes a policy evaluation context */ +void CT_POLICY_EVAL_CTX_free(CT_POLICY_EVAL_CTX *ctx); + +/* Gets the peer certificate that the SCTs are for */ +X509* CT_POLICY_EVAL_CTX_get0_cert(CT_POLICY_EVAL_CTX *ctx); + +/* Sets the certificate associated with the received SCTs */ +void CT_POLICY_EVAL_CTX_set0_cert(CT_POLICY_EVAL_CTX *ctx, X509 *cert); + +/* Gets the issuer of the aforementioned certificate */ +X509* CT_POLICY_EVAL_CTX_get0_issuer(CT_POLICY_EVAL_CTX *ctx); + +/* Sets the issuer of the certificate associated with the received SCTs */ +void CT_POLICY_EVAL_CTX_set0_issuer(CT_POLICY_EVAL_CTX *ctx, X509 *issuer); + +/* Gets the CT logs that are trusted sources of SCTs */ +CTLOG_STORE *CT_POLICY_EVAL_CTX_get0_log_store(CT_POLICY_EVAL_CTX *ctx); + +/* Sets the log store that is in use */ +void CT_POLICY_EVAL_CTX_set0_log_store(CT_POLICY_EVAL_CTX *ctx, + CTLOG_STORE *log_store); + +/* + * A callback for verifying that the received SCTs are sufficient. + * Expected to return 1 if they are sufficient, otherwise 0. + * May return a negative integer if an error occurs. + * A connection should be aborted if the SCTs are deemed insufficient. + */ +typedef int(*ct_validation_cb)(const CT_POLICY_EVAL_CTX *ctx, + const STACK_OF(SCT) *scts, void *arg); +/* Returns 0 if there are invalid SCTs */ +int CT_verify_no_bad_scts(const CT_POLICY_EVAL_CTX *ctx, + const STACK_OF(SCT) *scts, void *arg); +/* Returns 0 if there are invalid SCTS or fewer than one valid SCT */ +int CT_verify_at_least_one_good_sct(const CT_POLICY_EVAL_CTX *ctx, + const STACK_OF(SCT) *scts, void *arg); /***************** * SCT functions * @@ -95,6 +156,17 @@ DEFINE_STACK_OF(SCT) */ SCT *SCT_new(void); +/* + * Creates a new SCT from some base64-encoded strings. + * The caller is responsible for calling SCT_free when finished with the SCT. + */ +SCT *SCT_new_from_base64(unsigned char version, + const char *logid_base64, + ct_log_entry_type_t entry_type, + uint64_t timestamp, + const char *extensions_base64, + const char *signature_base64); + /* * Frees the SCT and the underlying data structures. */ @@ -115,7 +187,7 @@ sct_version_t SCT_get_version(const SCT *sct); * Set the version of an SCT. * Returns 1 on success, 0 if the version is unrecognized. */ -int SCT_set_version(SCT *sct, sct_version_t version); +__owur int SCT_set_version(SCT *sct, sct_version_t version); /* * Returns the log entry type of the SCT. @@ -124,9 +196,9 @@ ct_log_entry_type_t SCT_get_log_entry_type(const SCT *sct); /* * Set the log entry type of an SCT. - * Returns 1 on success. + * Returns 1 on success, 0 otherwise. */ -int SCT_set_log_entry_type(SCT *sct, ct_log_entry_type_t entry_type); +__owur int SCT_set_log_entry_type(SCT *sct, ct_log_entry_type_t entry_type); /* * Gets the ID of the log that an SCT came from. @@ -138,16 +210,24 @@ size_t SCT_get0_log_id(const SCT *sct, unsigned char **log_id); /* * Set the log ID of an SCT to point directly to the *log_id specified. * The SCT takes ownership of the specified pointer. - * Returns 1 on success. + * Returns 1 on success, 0 otherwise. */ -int SCT_set0_log_id(SCT *sct, unsigned char *log_id, size_t log_id_len); +__owur int SCT_set0_log_id(SCT *sct, unsigned char *log_id, size_t log_id_len); /* * Set the log ID of an SCT. * This makes a copy of the log_id. - * Returns 1 on success. + * Returns 1 on success, 0 otherwise. + */ +__owur int SCT_set1_log_id(SCT *sct, const unsigned char *log_id, + size_t log_id_len); + +/* + * Gets the name of the log that an SCT came from. + * Ownership of the log name remains with the SCT. + * Returns the log name, or NULL if it is not known. */ -int SCT_set1_log_id(SCT *sct, const unsigned char *log_id, size_t log_id_len); +const char *SCT_get0_log_name(const SCT *sct); /* * Returns the timestamp for the SCT (epoch time in milliseconds). @@ -170,9 +250,9 @@ int SCT_get_signature_nid(const SCT *sct); * Set the signature type of an SCT * For CT v1, this should be either NID_sha256WithRSAEncryption or * NID_ecdsa_with_SHA256. - * Returns 1 on success. + * Returns 1 on success, 0 otherwise. */ -int SCT_set_signature_nid(SCT *sct, int nid); +__owur int SCT_set_signature_nid(SCT *sct, int nid); /* * Set *ext to point to the extension data for the SCT. ext must not be NULL. @@ -190,9 +270,10 @@ void SCT_set0_extensions(SCT *sct, unsigned char *ext, size_t ext_len); /* * Set the extensions of an SCT. * This takes a copy of the ext. - * Returns 1 on success. + * Returns 1 on success, 0 otherwise. */ -int SCT_set1_extensions(SCT *sct, const unsigned char *ext, size_t ext_len); +__owur int SCT_set1_extensions(SCT *sct, const unsigned char *ext, + size_t ext_len); /* * Set *sig to point to the signature for the SCT. sig must not be NULL. @@ -209,9 +290,46 @@ void SCT_set0_signature(SCT *sct, unsigned char *sig, size_t sig_len); /* * Set the signature of an SCT to be a copy of the *sig specified. - * Returns 1 on success. + * Returns 1 on success, 0 otherwise. + */ +__owur int SCT_set1_signature(SCT *sct, const unsigned char *sig, + size_t sig_len); + +/* + * The origin of this SCT, e.g. TLS extension, OCSP response, etc. + */ +sct_source_t SCT_get_source(const SCT *sct); + +/* + * Set the origin of this SCT, e.g. TLS extension, OCSP response, etc. + * Returns 1 on success, 0 otherwise. + */ +__owur int SCT_set_source(SCT *sct, sct_source_t source); + +/* + * Sets the source of all of the SCTs to the same value. + * Returns the number of SCTs whose source was set successfully. + */ +__owur int SCT_LIST_set_source(const STACK_OF(SCT) *scts, sct_source_t source); + +/* + * Gets information about the log the SCT came from, if set. + */ +CTLOG *SCT_get0_log(const SCT *sct); + +/* + * Looks up information about the log the SCT came from using a CT log store. + * Returns 1 if information about the log is found, 0 otherwise. + * The information can be accessed via SCT_get0_log. */ -int SCT_set1_signature(SCT *sct, const unsigned char *sig, size_t sig_len); +int SCT_set0_log(SCT *sct, const CTLOG_STORE* ct_logs); + +/* + * Looks up information about the logs the SCTs came from using a CT log store. + * Returns the number of SCTs that now have a log set. + * If any SCTs already have a log set, they will be skipped. + */ +int SCT_LIST_set0_logs(STACK_OF(SCT) *sct_list, const CTLOG_STORE *ct_logs); /* * Pretty-prints an |sct| to |out|. @@ -227,6 +345,45 @@ void SCT_print(const SCT *sct, BIO *out, int indent); void SCT_LIST_print(const STACK_OF(SCT) *sct_list, BIO *out, int indent, const char *separator); +/* + * Verifies an SCT with the given context. + * Returns 1 if the SCT verifies successfully, 0 otherwise. + */ +__owur int SCT_verify(const SCT_CTX *sctx, const SCT *sct); + +/* + * Verifies an SCT against the provided data. + * Returns 1 if the SCT verifies successfully, 0 otherwise. + */ +__owur int SCT_verify_v1(SCT *sct, X509 *cert, X509 *preissuer, + X509_PUBKEY *log_pubkey, X509 *issuer_cert); + +/* + * Gets the last result of validating this SCT. + * If it has not been validated yet, returns SCT_VALIDATION_STATUS_NOT_SET. + */ +sct_validation_status_t SCT_get_validation_status(const SCT *sct); + +/* + * Validates the given SCT with the provided context. + * Sets the "validation_status" field of the SCT. + * Returns 1 if the SCT is valid and the signature verifies. + * Returns 0 if the SCT is invalid or could not be verified. + * Returns -1 if an error occurs. + */ +__owur int SCT_validate(SCT *sct, const CT_POLICY_EVAL_CTX *ctx); + +/* + * Validates the given list of SCTs with the provided context. + * Populates the "good_scts" and "bad_scts" of the evaluation context. + * Returns 1 if there are no invalid SCTs and all signatures verify. + * Returns 0 if at least one SCT is invalid or could not be verified. + * Returns a negative integer if an error occurs. + */ +__owur int SCT_LIST_validate(const STACK_OF(SCT) *scts, + CT_POLICY_EVAL_CTX *ctx); + + /********************************* * SCT parsing and serialisation * *********************************/ @@ -243,7 +400,7 @@ void SCT_LIST_print(const STACK_OF(SCT) *sct_list, BIO *out, int indent, * Returns < 0 on error, >= 0 indicating bytes written (or would have been) * on success. */ -int i2o_SCT_LIST(const STACK_OF(SCT) *a, unsigned char **pp); +__owur int i2o_SCT_LIST(const STACK_OF(SCT) *a, unsigned char **pp); /* * Convert TLS format SCT list to a stack of SCTs. @@ -270,7 +427,7 @@ STACK_OF(SCT) *o2i_SCT_LIST(STACK_OF(SCT) **a, const unsigned char **pp, * Returns < 0 on error, >= 0 indicating bytes written (or would have been) * on success. */ -int i2d_SCT_LIST(STACK_OF(SCT) *a, unsigned char **pp); +__owur int i2d_SCT_LIST(STACK_OF(SCT) *a, unsigned char **pp); /* * Parses an SCT list in DER format and returns it. @@ -294,7 +451,7 @@ STACK_OF(SCT) *d2i_SCT_LIST(STACK_OF(SCT) **a, const unsigned char **pp, * to it. * The length of the SCT in TLS format will be returned. */ -int i2o_SCT(const SCT *sct, unsigned char **out); +__owur int i2o_SCT(const SCT *sct, unsigned char **out); /* * Parses an SCT in TLS format and returns it. @@ -317,7 +474,7 @@ SCT *o2i_SCT(SCT **psct, const unsigned char **in, size_t len); * If |out| points to an allocated string, the signature will be written to it. * The length of the signature in TLS format will be returned. */ -int i2o_SCT_signature(const SCT *sct, unsigned char **out); +__owur int i2o_SCT_signature(const SCT *sct, unsigned char **out); /* * Parses an SCT signature in TLS format and populates the |sct| with it. @@ -326,7 +483,79 @@ int i2o_SCT_signature(const SCT *sct, unsigned char **out); * |len| should be the length of the signature in |in|. * Returns the number of bytes parsed, or a negative integer if an error occurs. */ -int o2i_SCT_signature(SCT *sct, const unsigned char **in, size_t len); +__owur int o2i_SCT_signature(SCT *sct, const unsigned char **in, size_t len); + +/******************** + * CT log functions * + ********************/ + +/* + * Creates a new CT log instance with the given |public_key| and |name|. + * Should be deleted by the caller using CTLOG_free when no longer needed. + */ +CTLOG *CTLOG_new(EVP_PKEY *public_key, const char *name); + +/* + * Creates a new, blank CT log instance. + * Should be deleted by the caller using CTLOG_free when no longer needed. + */ +CTLOG *CTLOG_new_null(void); + +/* + * Creates a new CT log instance with the given base64 public_key and |name|. + * Should be deleted by the caller using CTLOG_free when no longer needed. + */ +CTLOG *CTLOG_new_from_base64(const char *pkey_base64, const char *name); + +/* + * Deletes a CT log instance and its fields. + */ +void CTLOG_free(CTLOG *log); + +/* Gets the name of the CT log */ +const char *CTLOG_get0_name(const CTLOG *log); +/* Gets the ID of the CT log */ +void CTLOG_get0_log_id(const CTLOG *log, const uint8_t **log_id, + size_t *log_id_len); +/* Gets the public key of the CT log */ +EVP_PKEY *CTLOG_get0_public_key(const CTLOG *log); + +/************************** + * CT log store functions * + **************************/ + +/* + * Creates a new CT log store. + * Should be deleted by the caller using CTLOG_STORE_free when no longer needed. + */ +CTLOG_STORE *CTLOG_STORE_new(void); + +/* + * Deletes a CT log store and all of the CT log instances held within. + */ +void CTLOG_STORE_free(CTLOG_STORE *store); + +/* + * Finds a CT log in the store based on its log ID. + * Returns the CT log, or NULL if no match is found. + */ +const CTLOG *CTLOG_STORE_get0_log_by_id(const CTLOG_STORE *store, + const uint8_t *log_id, + size_t log_id_len); + +/* + * Loads a CT log list into a |store| from a |file|. + * Returns 1 if loading is successful, or 0 otherwise. + */ +__owur int CTLOG_STORE_load_file(CTLOG_STORE *store, const char *file); + +/* + * Loads the default CT log list into a |store|. + * See internal/cryptlib.h for the environment variable and file path that are + * consulted to find the default file. + * Returns 1 if loading is successful, or 0 otherwise. + */ +__owur int CTLOG_STORE_load_default_file(CTLOG_STORE *store); /* BEGIN ERROR CODES */ /* @@ -338,6 +567,24 @@ void ERR_load_CT_strings(void); /* Error codes for the CT functions. */ /* Function codes. */ +# define CT_F_CTLOG_NEW 117 +# define CT_F_CTLOG_NEW_FROM_BASE64 118 +# define CT_F_CTLOG_NEW_FROM_CONF 119 +# define CT_F_CTLOG_NEW_NULL 120 +# define CT_F_CTLOG_STORE_GET0_LOG_BY_ID 121 +# define CT_F_CTLOG_STORE_LOAD_CTX_NEW 122 +# define CT_F_CTLOG_STORE_LOAD_FILE 123 +# define CT_F_CT_BASE64_DECODE 124 +# define CT_F_CT_POLICY_EVAL_CTX_GET0_CERT 130 +# define CT_F_CT_POLICY_EVAL_CTX_GET0_ISSUER 131 +# define CT_F_CT_POLICY_EVAL_CTX_GET0_LOG_STORE 132 +# define CT_F_CT_POLICY_EVAL_CTX_NEW 133 +# define CT_F_CT_POLICY_EVAL_CTX_SET0_CERT 134 +# define CT_F_CT_POLICY_EVAL_CTX_SET0_ISSUER 135 +# define CT_F_CT_POLICY_EVAL_CTX_SET0_LOG_STORE 136 +# define CT_F_CT_V1_LOG_ID_FROM_PKEY 125 +# define CT_F_CT_VERIFY_AT_LEAST_ONE_GOOD_SCT 137 +# define CT_F_CT_VERIFY_NO_BAD_SCTS 138 # define CT_F_D2I_SCT_LIST 105 # define CT_F_I2D_SCT_LIST 106 # define CT_F_I2O_SCT 107 @@ -346,7 +593,10 @@ void ERR_load_CT_strings(void); # define CT_F_O2I_SCT 110 # define CT_F_O2I_SCT_LIST 111 # define CT_F_O2I_SCT_SIGNATURE 112 +# define CT_F_SCT_CTX_NEW 126 +# define CT_F_SCT_LIST_VALIDATE 139 # define CT_F_SCT_NEW 100 +# define CT_F_SCT_NEW_FROM_BASE64 127 # define CT_F_SCT_SET0_LOG_ID 101 # define CT_F_SCT_SET1_EXTENSIONS 114 # define CT_F_SCT_SET1_LOG_ID 115 @@ -355,13 +605,26 @@ void ERR_load_CT_strings(void); # define CT_F_SCT_SET_SIGNATURE_NID 103 # define CT_F_SCT_SET_VERSION 104 # define CT_F_SCT_SIGNATURE_IS_VALID 113 +# define CT_F_SCT_VALIDATE 140 +# define CT_F_SCT_VERIFY 128 +# define CT_F_SCT_VERIFY_V1 129 /* Reason codes. */ +# define CT_R_BASE64_DECODE_ERROR 108 # define CT_R_INVALID_LOG_ID_LENGTH 100 +# define CT_R_LOG_CONF_INVALID 109 +# define CT_R_LOG_CONF_INVALID_KEY 110 +# define CT_R_LOG_CONF_MISSING_DESCRIPTION 111 +# define CT_R_LOG_CONF_MISSING_KEY 112 +# define CT_R_LOG_KEY_INVALID 113 +# define CT_R_NOT_ENOUGH_SCTS 116 # define CT_R_SCT_INVALID 104 # define CT_R_SCT_INVALID_SIGNATURE 107 # define CT_R_SCT_LIST_INVALID 105 +# define CT_R_SCT_LOG_ID_MISMATCH 114 # define CT_R_SCT_NOT_SET 106 +# define CT_R_SCT_UNSUPPORTED_VERSION 115 +# define CT_R_SCT_VALIDATION_STATUS_NOT_SET 117 # define CT_R_UNRECOGNIZED_SIGNATURE_NID 101 # define CT_R_UNSUPPORTED_ENTRY_TYPE 102 # define CT_R_UNSUPPORTED_VERSION 103