2 * Copyright 2016-2018 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
13 #include <openssl/conf.h>
14 #include <openssl/ct.h>
15 #include <openssl/err.h>
16 #include <openssl/evp.h>
17 #include <openssl/safestack.h>
19 #include "internal/cryptlib.h"
22 * Information about a CT log server.
28 uint8_t log_id[CT_V1_HASHLEN];
33 * A store for multiple CTLOG instances.
34 * It takes ownership of any CTLOG instances added to it.
36 struct ctlog_store_st {
39 STACK_OF(CTLOG) *logs;
42 /* The context when loading a CT log list from a CONF file. */
43 typedef struct ctlog_store_load_ctx_st {
44 CTLOG_STORE *log_store;
46 size_t invalid_log_entries;
47 } CTLOG_STORE_LOAD_CTX;
50 * Creates an empty context for loading a CT log store.
51 * It should be populated before use.
53 static CTLOG_STORE_LOAD_CTX *ctlog_store_load_ctx_new(void);
56 * Deletes a CT log store load context.
57 * Does not delete any of the fields.
59 static void ctlog_store_load_ctx_free(CTLOG_STORE_LOAD_CTX* ctx);
61 static CTLOG_STORE_LOAD_CTX *ctlog_store_load_ctx_new(void)
63 CTLOG_STORE_LOAD_CTX *ctx = OPENSSL_zalloc(sizeof(*ctx));
66 CTerr(CT_F_CTLOG_STORE_LOAD_CTX_NEW, ERR_R_MALLOC_FAILURE);
71 static void ctlog_store_load_ctx_free(CTLOG_STORE_LOAD_CTX* ctx)
76 /* Converts a log's public key into a SHA256 log ID */
77 static int ct_v1_log_id_from_pkey(CTLOG *log, EVP_PKEY *pkey)
80 unsigned char *pkey_der = NULL;
81 int pkey_der_len = i2d_PUBKEY(pkey, &pkey_der);
83 EVP_MD *sha256 = NULL;
85 if (pkey_der_len <= 0) {
86 CTerr(CT_F_CT_V1_LOG_ID_FROM_PKEY, CT_R_LOG_KEY_INVALID);
89 sha256 = EVP_MD_fetch(log->libctx, "SHA2-256", log->propq);
91 CTerr(CT_F_CT_V1_LOG_ID_FROM_PKEY, ERR_LIB_EVP);
95 ret = EVP_Digest(pkey_der, pkey_der_len, log->log_id, &len, sha256,
99 OPENSSL_free(pkey_der);
103 CTLOG_STORE *CTLOG_STORE_new_with_libctx(OPENSSL_CTX *libctx, const char *propq)
105 CTLOG_STORE *ret = OPENSSL_zalloc(sizeof(*ret));
108 CTerr(0, ERR_R_MALLOC_FAILURE);
112 ret->libctx = libctx;
114 ret->propq = OPENSSL_strdup(propq);
115 if (ret->propq == NULL) {
116 CTerr(0, ERR_R_MALLOC_FAILURE);
121 ret->logs = sk_CTLOG_new_null();
122 if (ret->logs == NULL) {
123 CTerr(0, ERR_R_MALLOC_FAILURE);
129 CTLOG_STORE_free(ret);
133 CTLOG_STORE *CTLOG_STORE_new(void)
135 return CTLOG_STORE_new_with_libctx(NULL, NULL);
138 void CTLOG_STORE_free(CTLOG_STORE *store)
141 OPENSSL_free(store->propq);
142 sk_CTLOG_pop_free(store->logs, CTLOG_free);
147 static int ctlog_new_from_conf(CTLOG_STORE *store, CTLOG **ct_log,
148 const CONF *conf, const char *section)
150 const char *description = NCONF_get_string(conf, section, "description");
153 if (description == NULL) {
154 CTerr(CT_F_CTLOG_NEW_FROM_CONF, CT_R_LOG_CONF_MISSING_DESCRIPTION);
158 pkey_base64 = NCONF_get_string(conf, section, "key");
159 if (pkey_base64 == NULL) {
160 CTerr(CT_F_CTLOG_NEW_FROM_CONF, CT_R_LOG_CONF_MISSING_KEY);
164 return CTLOG_new_from_base64_with_libctx(ct_log, pkey_base64, description,
165 store->libctx, store->propq);
168 int CTLOG_STORE_load_default_file(CTLOG_STORE *store)
170 const char *fpath = ossl_safe_getenv(CTLOG_FILE_EVP);
175 return CTLOG_STORE_load_file(store, fpath);
179 * Called by CONF_parse_list, which stops if this returns <= 0,
180 * Otherwise, one bad log entry would stop loading of any of
181 * the following log entries.
182 * It may stop parsing and returns -1 on any internal (malloc) error.
184 static int ctlog_store_load_log(const char *log_name, int log_name_len,
187 CTLOG_STORE_LOAD_CTX *load_ctx = arg;
188 CTLOG *ct_log = NULL;
189 /* log_name may not be null-terminated, so fix that before using it */
193 /* log_name will be NULL for empty list entries */
194 if (log_name == NULL)
197 tmp = OPENSSL_strndup(log_name, log_name_len);
201 ret = ctlog_new_from_conf(load_ctx->log_store, &ct_log, load_ctx->conf, tmp);
205 /* Propagate any internal error */
209 /* If we can't load this log, record that fact and skip it */
210 ++load_ctx->invalid_log_entries;
214 if (!sk_CTLOG_push(load_ctx->log_store->logs, ct_log)) {
221 CTerr(CT_F_CTLOG_STORE_LOAD_LOG, ERR_R_MALLOC_FAILURE);
225 int CTLOG_STORE_load_file(CTLOG_STORE *store, const char *file)
229 CTLOG_STORE_LOAD_CTX* load_ctx = ctlog_store_load_ctx_new();
231 if (load_ctx == NULL)
233 load_ctx->log_store = store;
234 load_ctx->conf = NCONF_new(NULL);
235 if (load_ctx->conf == NULL)
238 if (NCONF_load(load_ctx->conf, file, NULL) <= 0) {
239 CTerr(CT_F_CTLOG_STORE_LOAD_FILE, CT_R_LOG_CONF_INVALID);
243 enabled_logs = NCONF_get_string(load_ctx->conf, NULL, "enabled_logs");
244 if (enabled_logs == NULL) {
245 CTerr(CT_F_CTLOG_STORE_LOAD_FILE, CT_R_LOG_CONF_INVALID);
249 if (!CONF_parse_list(enabled_logs, ',', 1, ctlog_store_load_log, load_ctx) ||
250 load_ctx->invalid_log_entries > 0) {
251 CTerr(CT_F_CTLOG_STORE_LOAD_FILE, CT_R_LOG_CONF_INVALID);
257 NCONF_free(load_ctx->conf);
258 ctlog_store_load_ctx_free(load_ctx);
263 * Initialize a new CTLOG object.
264 * Takes ownership of the public key.
267 CTLOG *CTLOG_new_with_libctx(EVP_PKEY *public_key, const char *name,
268 OPENSSL_CTX *libctx, const char *propq)
270 CTLOG *ret = OPENSSL_zalloc(sizeof(*ret));
273 CTerr(0, ERR_R_MALLOC_FAILURE);
277 ret->libctx = libctx;
279 ret->name = OPENSSL_strdup(propq);
280 if (ret->propq == NULL) {
281 CTerr(0, ERR_R_MALLOC_FAILURE);
286 ret->name = OPENSSL_strdup(name);
287 if (ret->name == NULL) {
288 CTerr(0, ERR_R_MALLOC_FAILURE);
292 if (ct_v1_log_id_from_pkey(ret, public_key) != 1)
295 ret->public_key = public_key;
302 CTLOG *CTLOG_new(EVP_PKEY *public_key, const char *name)
304 return CTLOG_new_with_libctx(public_key, name, NULL, NULL);
307 /* Frees CT log and associated structures */
308 void CTLOG_free(CTLOG *log)
311 OPENSSL_free(log->name);
312 EVP_PKEY_free(log->public_key);
313 OPENSSL_free(log->propq);
318 const char *CTLOG_get0_name(const CTLOG *log)
323 void CTLOG_get0_log_id(const CTLOG *log, const uint8_t **log_id,
326 *log_id = log->log_id;
327 *log_id_len = CT_V1_HASHLEN;
330 EVP_PKEY *CTLOG_get0_public_key(const CTLOG *log)
332 return log->public_key;
336 * Given a log ID, finds the matching log.
337 * Returns NULL if no match found.
339 const CTLOG *CTLOG_STORE_get0_log_by_id(const CTLOG_STORE *store,
340 const uint8_t *log_id,
345 for (i = 0; i < sk_CTLOG_num(store->logs); ++i) {
346 const CTLOG *log = sk_CTLOG_value(store->logs, i);
347 if (memcmp(log->log_id, log_id, log_id_len) == 0)