2 * Copyright 2016-2018 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/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.
26 uint8_t log_id
[CT_V1_HASHLEN
];
31 * A store for multiple CTLOG instances.
32 * It takes ownership of any CTLOG instances added to it.
34 struct ctlog_store_st
{
35 STACK_OF(CTLOG
) *logs
;
38 /* The context when loading a CT log list from a CONF file. */
39 typedef struct ctlog_store_load_ctx_st
{
40 CTLOG_STORE
*log_store
;
42 size_t invalid_log_entries
;
43 } CTLOG_STORE_LOAD_CTX
;
46 * Creates an empty context for loading a CT log store.
47 * It should be populated before use.
49 static CTLOG_STORE_LOAD_CTX
*ctlog_store_load_ctx_new(void);
52 * Deletes a CT log store load context.
53 * Does not delete any of the fields.
55 static void ctlog_store_load_ctx_free(CTLOG_STORE_LOAD_CTX
* ctx
);
57 static CTLOG_STORE_LOAD_CTX
*ctlog_store_load_ctx_new(void)
59 CTLOG_STORE_LOAD_CTX
*ctx
= OPENSSL_zalloc(sizeof(*ctx
));
62 CTerr(CT_F_CTLOG_STORE_LOAD_CTX_NEW
, ERR_R_MALLOC_FAILURE
);
67 static void ctlog_store_load_ctx_free(CTLOG_STORE_LOAD_CTX
* ctx
)
72 /* Converts a log's public key into a SHA256 log ID */
73 static int ct_v1_log_id_from_pkey(EVP_PKEY
*pkey
,
74 unsigned char log_id
[CT_V1_HASHLEN
])
77 unsigned char *pkey_der
= NULL
;
78 int pkey_der_len
= i2d_PUBKEY(pkey
, &pkey_der
);
80 if (pkey_der_len
<= 0) {
81 CTerr(CT_F_CT_V1_LOG_ID_FROM_PKEY
, CT_R_LOG_KEY_INVALID
);
85 SHA256(pkey_der
, pkey_der_len
, log_id
);
88 OPENSSL_free(pkey_der
);
92 CTLOG_STORE
*CTLOG_STORE_new(void)
94 CTLOG_STORE
*ret
= OPENSSL_zalloc(sizeof(*ret
));
97 CTerr(CT_F_CTLOG_STORE_NEW
, ERR_R_MALLOC_FAILURE
);
101 ret
->logs
= sk_CTLOG_new_null();
102 if (ret
->logs
== NULL
)
111 void CTLOG_STORE_free(CTLOG_STORE
*store
)
114 sk_CTLOG_pop_free(store
->logs
, CTLOG_free
);
119 static int ctlog_new_from_conf(CTLOG
**ct_log
, const CONF
*conf
, const char *section
)
121 const char *description
= NCONF_get_string(conf
, section
, "description");
124 if (description
== NULL
) {
125 CTerr(CT_F_CTLOG_NEW_FROM_CONF
, CT_R_LOG_CONF_MISSING_DESCRIPTION
);
129 pkey_base64
= NCONF_get_string(conf
, section
, "key");
130 if (pkey_base64
== NULL
) {
131 CTerr(CT_F_CTLOG_NEW_FROM_CONF
, CT_R_LOG_CONF_MISSING_KEY
);
135 return CTLOG_new_from_base64(ct_log
, pkey_base64
, description
);
138 int CTLOG_STORE_load_default_file(CTLOG_STORE
*store
)
140 const char *fpath
= getenv(CTLOG_FILE_EVP
);
145 return CTLOG_STORE_load_file(store
, fpath
);
149 * Called by CONF_parse_list, which stops if this returns <= 0,
150 * Otherwise, one bad log entry would stop loading of any of
151 * the following log entries.
152 * It may stop parsing and returns -1 on any internal (malloc) error.
154 static int ctlog_store_load_log(const char *log_name
, int log_name_len
,
157 CTLOG_STORE_LOAD_CTX
*load_ctx
= arg
;
158 CTLOG
*ct_log
= NULL
;
159 /* log_name may not be null-terminated, so fix that before using it */
163 /* log_name will be NULL for empty list entries */
164 if (log_name
== NULL
)
167 tmp
= OPENSSL_strndup(log_name
, log_name_len
);
171 ret
= ctlog_new_from_conf(&ct_log
, load_ctx
->conf
, tmp
);
175 /* Propagate any internal error */
179 /* If we can't load this log, record that fact and skip it */
180 ++load_ctx
->invalid_log_entries
;
184 if (!sk_CTLOG_push(load_ctx
->log_store
->logs
, ct_log
)) {
191 CTerr(CT_F_CTLOG_STORE_LOAD_LOG
, ERR_R_MALLOC_FAILURE
);
195 int CTLOG_STORE_load_file(CTLOG_STORE
*store
, const char *file
)
199 CTLOG_STORE_LOAD_CTX
* load_ctx
= ctlog_store_load_ctx_new();
201 if (load_ctx
== NULL
)
203 load_ctx
->log_store
= store
;
204 load_ctx
->conf
= NCONF_new(NULL
);
205 if (load_ctx
->conf
== NULL
)
208 if (NCONF_load(load_ctx
->conf
, file
, NULL
) <= 0) {
209 CTerr(CT_F_CTLOG_STORE_LOAD_FILE
, CT_R_LOG_CONF_INVALID
);
213 enabled_logs
= NCONF_get_string(load_ctx
->conf
, NULL
, "enabled_logs");
214 if (enabled_logs
== NULL
) {
215 CTerr(CT_F_CTLOG_STORE_LOAD_FILE
, CT_R_LOG_CONF_INVALID
);
219 if (!CONF_parse_list(enabled_logs
, ',', 1, ctlog_store_load_log
, load_ctx
) ||
220 load_ctx
->invalid_log_entries
> 0) {
221 CTerr(CT_F_CTLOG_STORE_LOAD_FILE
, CT_R_LOG_CONF_INVALID
);
227 NCONF_free(load_ctx
->conf
);
228 ctlog_store_load_ctx_free(load_ctx
);
233 * Initialize a new CTLOG object.
234 * Takes ownership of the public key.
237 CTLOG
*CTLOG_new(EVP_PKEY
*public_key
, const char *name
)
239 CTLOG
*ret
= OPENSSL_zalloc(sizeof(*ret
));
242 CTerr(CT_F_CTLOG_NEW
, ERR_R_MALLOC_FAILURE
);
246 ret
->name
= OPENSSL_strdup(name
);
247 if (ret
->name
== NULL
) {
248 CTerr(CT_F_CTLOG_NEW
, ERR_R_MALLOC_FAILURE
);
252 if (ct_v1_log_id_from_pkey(public_key
, ret
->log_id
) != 1)
255 ret
->public_key
= public_key
;
262 /* Frees CT log and associated structures */
263 void CTLOG_free(CTLOG
*log
)
266 OPENSSL_free(log
->name
);
267 EVP_PKEY_free(log
->public_key
);
272 const char *CTLOG_get0_name(const CTLOG
*log
)
277 void CTLOG_get0_log_id(const CTLOG
*log
, const uint8_t **log_id
,
280 *log_id
= log
->log_id
;
281 *log_id_len
= CT_V1_HASHLEN
;
284 EVP_PKEY
*CTLOG_get0_public_key(const CTLOG
*log
)
286 return log
->public_key
;
290 * Given a log ID, finds the matching log.
291 * Returns NULL if no match found.
293 const CTLOG
*CTLOG_STORE_get0_log_by_id(const CTLOG_STORE
*store
,
294 const uint8_t *log_id
,
299 for (i
= 0; i
< sk_CTLOG_num(store
->logs
); ++i
) {
300 const CTLOG
*log
= sk_CTLOG_value(store
->logs
, i
);
301 if (memcmp(log
->log_id
, log_id
, log_id_len
) == 0)