2 * Copyright 2007-2019 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright Nokia 2007-2019
4 * Copyright Siemens AG 2015-2019
6 * Licensed under the Apache License 2.0 (the "License"). You may not use
7 * this file except in compliance with the License. You can obtain a copy
8 * in the file LICENSE in the source distribution or at
9 * https://www.openssl.org/source/license.html
13 #include <openssl/cmp_util.h>
14 #include "cmp_local.h" /* just for decls of internal functions defined here */
15 #include <openssl/cmperr.h>
16 #include <openssl/err.h> /* should be implied by cmperr.h */
17 #include <openssl/x509v3.h>
20 * use trace API for CMP-specific logging, prefixed by "CMP " and severity
23 int OSSL_CMP_log_open(void) /* is designed to be idempotent */
25 #ifndef OPENSSL_NO_STDIO
26 BIO *bio = BIO_new_fp(stdout, BIO_NOCLOSE);
28 if (bio != NULL && OSSL_trace_set_channel(OSSL_TRACE_CATEGORY_CMP, bio))
32 CMPerr(0, CMP_R_NO_STDIO);
36 void OSSL_CMP_log_close(void) /* is designed to be idempotent */
38 (void)OSSL_trace_set_channel(OSSL_TRACE_CATEGORY_CMP, NULL);
41 /* return >= 0 if level contains logging level, possibly preceded by "CMP " */
42 #define max_level_len 5 /* = max length of the below strings, e.g., "EMERG" */
43 static OSSL_CMP_severity parse_level(const char *level)
45 const char *end_level = strchr(level, ':');
47 char level_copy[max_level_len + 1];
49 if (end_level == NULL)
52 if (strncmp(level, OSSL_CMP_LOG_PREFIX,
53 strlen(OSSL_CMP_LOG_PREFIX)) == 0)
54 level += strlen(OSSL_CMP_LOG_PREFIX);
55 len = end_level - level;
56 if (len > max_level_len)
58 OPENSSL_strlcpy(level_copy, level, len + 1);
60 strcmp(level_copy, "EMERG") == 0 ? OSSL_CMP_LOG_EMERG :
61 strcmp(level_copy, "ALERT") == 0 ? OSSL_CMP_LOG_ALERT :
62 strcmp(level_copy, "CRIT") == 0 ? OSSL_CMP_LOG_CRIT :
63 strcmp(level_copy, "ERROR") == 0 ? OSSL_CMP_LOG_ERR :
64 strcmp(level_copy, "WARN") == 0 ? OSSL_CMP_LOG_WARNING :
65 strcmp(level_copy, "NOTE") == 0 ? OSSL_CMP_LOG_NOTICE :
66 strcmp(level_copy, "INFO") == 0 ? OSSL_CMP_LOG_INFO :
67 strcmp(level_copy, "DEBUG") == 0 ? OSSL_CMP_LOG_DEBUG :
71 const char *ossl_cmp_log_parse_metadata(const char *buf,
72 OSSL_CMP_severity *level,
73 char **func, char **file, int *line)
75 const char *p_func = buf;
76 const char *p_file = buf == NULL ? NULL : strchr(buf, ':');
77 const char *p_level = buf;
78 const char *msg = buf;
86 const char *p_line = strchr(++p_file, ':');
88 if ((*level = parse_level(buf)) < 0 && p_line != NULL) {
89 /* check if buf contains location info and logging level */
90 char *p_level_tmp = (char *)p_level;
91 const long line_number = strtol(++p_line, &p_level_tmp, 10);
93 p_level = p_level_tmp;
94 if (p_level > p_line && *(p_level++) == ':') {
95 if ((*level = parse_level(p_level)) >= 0) {
96 *func = OPENSSL_strndup(p_func, p_file - 1 - p_func);
97 *file = OPENSSL_strndup(p_file, p_line - 1 - p_file);
98 /* no real problem if OPENSSL_strndup() returns NULL */
99 *line = (int)line_number;
100 msg = strchr(p_level, ':') + 1;
110 #define UNKNOWN_FUNC "(unknown function)" /* the default for OPENSSL_FUNC */
112 * substitute fallback if component/function name is NULL or empty or contains
113 * just pseudo-information "(unknown function)" due to -pedantic and macros.h
115 static const char *improve_location_name(const char *func, const char *fallback)
117 if (!ossl_assert(fallback != NULL))
119 return func == NULL || *func == '\0' || strcmp(func, UNKNOWN_FUNC) == 0
123 int OSSL_CMP_print_to_bio(BIO *bio, const char *component, const char *file,
124 int line, OSSL_CMP_severity level, const char *msg)
126 const char *level_string =
127 level == OSSL_CMP_LOG_EMERG ? "EMERG" :
128 level == OSSL_CMP_LOG_ALERT ? "ALERT" :
129 level == OSSL_CMP_LOG_CRIT ? "CRIT" :
130 level == OSSL_CMP_LOG_ERR ? "error" :
131 level == OSSL_CMP_LOG_WARNING ? "warning" :
132 level == OSSL_CMP_LOG_NOTICE ? "NOTE" :
133 level == OSSL_CMP_LOG_INFO ? "info" :
134 level == OSSL_CMP_LOG_DEBUG ? "DEBUG" : "(unknown level)";
137 if (BIO_printf(bio, "%s:%s:%d:", improve_location_name(component, "CMP"),
141 return BIO_printf(bio, OSSL_CMP_LOG_PREFIX"%s: %s\n",
142 level_string, msg) >= 0;
146 * auxiliary function for incrementally reporting texts via the error queue
148 static void put_error(int lib, const char *func, int reason,
149 const char *file, int line)
152 ERR_set_debug(file, line, func);
153 ERR_set_error(lib, reason, NULL /* no data here, so fmt is NULL */);
156 #define ERR_print_errors_cb_LIMIT 4096 /* size of char buf[] variable there */
157 #define TYPICAL_MAX_OUTPUT_BEFORE_DATA 100
158 #define MAX_DATA_LEN (ERR_print_errors_cb_LIMIT-TYPICAL_MAX_OUTPUT_BEFORE_DATA)
159 void ossl_cmp_add_error_txt(const char *separator, const char *txt)
161 const char *file = NULL;
163 const char *func = NULL;
164 const char *data = NULL;
166 unsigned long err = ERR_peek_last_error();
168 if (separator == NULL)
171 put_error(ERR_LIB_CMP, NULL, 0, "", 0);
174 size_t available_len, data_len;
175 const char *curr = txt, *next = txt;
178 ERR_peek_last_error_all(&file, &line, &func, &data, &flags);
179 if ((flags & ERR_TXT_STRING) == 0) {
183 data_len = strlen(data);
185 /* workaround for limit of ERR_print_errors_cb() */
186 if (data_len >= MAX_DATA_LEN
187 || strlen(separator) >= (size_t)(MAX_DATA_LEN - data_len))
190 available_len = MAX_DATA_LEN - data_len - strlen(separator) - 1;
191 /* MAX_DATA_LEN > available_len >= 0 */
193 if (separator[0] == '\0') {
194 const size_t len_next = strlen(next);
196 if (len_next <= available_len) {
198 curr = NULL; /* no need to split */
201 next += available_len;
202 curr = next; /* will split at this point */
205 while (*next != '\0' && (size_t)(next - txt) <= available_len) {
207 next = strstr(curr, separator);
209 next += strlen(separator);
211 next = curr + strlen(curr);
213 if ((size_t)(next - txt) <= available_len)
214 curr = NULL; /* the above loop implies *next == '\0' */
217 /* split error msg at curr since error data would get too long */
219 tmp = OPENSSL_strndup(txt, curr - txt);
222 ERR_add_error_data(2, separator, tmp);
225 put_error(ERR_LIB_CMP, func, err, file, line);
228 ERR_add_error_data(2, separator, txt);
229 txt = next; /* finished */
231 } while (*txt != '\0');
234 /* this is similar to ERR_print_errors_cb, but uses the CMP-specific cb type */
235 void OSSL_CMP_print_errors_cb(OSSL_cmp_log_cb_t log_fn)
238 char msg[ERR_print_errors_cb_LIMIT];
239 const char *file = NULL, *func = NULL, *data = NULL;
242 while ((err = ERR_get_error_all(&file, &line, &func, &data, &flags)) != 0) {
243 const char *component =
244 improve_location_name(func, ERR_lib_error_string(err));
246 if (!(flags & ERR_TXT_STRING))
248 BIO_snprintf(msg, sizeof(msg), "%s%s%s", ERR_reason_error_string(err),
249 data == NULL || *data == '\0' ? "" : " : ",
250 data == NULL ? "" : data);
251 if (log_fn == NULL) {
252 #ifndef OPENSSL_NO_STDIO
253 BIO *bio = BIO_new_fp(stderr, BIO_NOCLOSE);
256 OSSL_CMP_print_to_bio(bio, component, file, line,
257 OSSL_CMP_LOG_ERR, msg);
261 /* CMPerr(0, CMP_R_NO_STDIO) makes no sense during error printing */
264 if (log_fn(component, file, line, OSSL_CMP_LOG_ERR, msg) <= 0)
265 break; /* abort outputting the error report */
271 * functions manipulating lists of certificates etc.
272 * these functions could be generally useful.
275 int ossl_cmp_sk_X509_add1_cert(STACK_OF(X509) *sk, X509 *cert,
276 int no_dup, int prepend)
279 CMPerr(0, CMP_R_NULL_ARGUMENT);
284 * not using sk_X509_set_cmp_func() and sk_X509_find()
285 * because this re-orders the certs on the stack
289 for (i = 0; i < sk_X509_num(sk); i++) {
290 if (X509_cmp(sk_X509_value(sk, i), cert) == 0)
294 if (!X509_up_ref(cert))
296 if (!sk_X509_insert(sk, cert, prepend ? 0 : -1)) {
303 int ossl_cmp_sk_X509_add1_certs(STACK_OF(X509) *sk, STACK_OF(X509) *certs,
304 int no_self_issued, int no_dups, int prepend)
305 /* compiler would allow 'const' for the list of certs, yet they are up-ref'ed */
310 CMPerr(0, CMP_R_NULL_ARGUMENT);
313 for (i = 0; i < sk_X509_num(certs); i++) { /* certs may be NULL */
314 X509 *cert = sk_X509_value(certs, i);
316 if (!no_self_issued || X509_check_issued(cert, cert) != X509_V_OK) {
317 if (!ossl_cmp_sk_X509_add1_cert(sk, cert, no_dups, prepend))
324 int ossl_cmp_X509_STORE_add1_certs(X509_STORE *store, STACK_OF(X509) *certs,
325 int only_self_issued)
330 CMPerr(0, CMP_R_NULL_ARGUMENT);
335 for (i = 0; i < sk_X509_num(certs); i++) {
336 X509 *cert = sk_X509_value(certs, i);
338 if (!only_self_issued || X509_check_issued(cert, cert) == X509_V_OK)
339 if (!X509_STORE_add_cert(store, cert)) /* ups cert ref counter */
345 STACK_OF(X509) *ossl_cmp_X509_STORE_get1_certs(X509_STORE *store)
349 STACK_OF(X509_OBJECT) *objs;
352 CMPerr(0, CMP_R_NULL_ARGUMENT);
355 if ((sk = sk_X509_new_null()) == NULL)
357 objs = X509_STORE_get0_objects(store);
358 for (i = 0; i < sk_X509_OBJECT_num(objs); i++) {
359 X509 *cert = X509_OBJECT_get0_X509(sk_X509_OBJECT_value(objs, i));
362 if (!sk_X509_push(sk, cert))
364 if (!X509_up_ref(cert)) {
365 (void)sk_X509_pop(sk);
373 sk_X509_pop_free(sk, X509_free);
378 * Builds up the certificate chain of certs as high up as possible using
379 * the given list of certs containing all possible intermediate certificates and
380 * optionally the (possible) trust anchor(s). See also ssl_add_cert_chain().
382 * Intended use of this function is to find all the certificates above the trust
383 * anchor needed to verify an EE's own certificate. Those are supposed to be
384 * included in the ExtraCerts field of every first sent message of a transaction
385 * when MSG_SIG_ALG is utilized.
387 * NOTE: This allocates a stack and increments the reference count of each cert,
388 * so when not needed any more the stack and all its elements should be freed.
389 * NOTE: in case there is more than one possibility for the chain,
390 * OpenSSL seems to take the first one, check X509_verify_cert() for details.
392 * returns a pointer to a stack of (up_ref'ed) X509 certificates containing:
393 * - the EE certificate given in the function arguments (cert)
394 * - all intermediate certificates up the chain toward the trust anchor
395 * whereas the (self-signed) trust anchor is not included
396 * returns NULL on error
398 STACK_OF(X509) *ossl_cmp_build_cert_chain(STACK_OF(X509) *certs, X509 *cert)
400 STACK_OF(X509) *chain = NULL, *result = NULL;
401 X509_STORE *store = X509_STORE_new();
402 X509_STORE_CTX *csc = NULL;
404 if (certs == NULL || cert == NULL || store == NULL) {
405 CMPerr(0, CMP_R_NULL_ARGUMENT);
409 csc = X509_STORE_CTX_new();
413 if (!ossl_cmp_X509_STORE_add1_certs(store, certs, 0)
414 || !X509_STORE_CTX_init(csc, store, cert, NULL))
417 (void)ERR_set_mark();
419 * ignore return value as it would fail without trust anchor given in store
421 (void)X509_verify_cert(csc);
423 /* don't leave any new errors in the queue */
424 (void)ERR_pop_to_mark();
426 chain = X509_STORE_CTX_get0_chain(csc);
428 /* result list to store the up_ref'ed not self-issued certificates */
429 if ((result = sk_X509_new_null()) == NULL)
431 if (!ossl_cmp_sk_X509_add1_certs(result, chain, 1 /* no self-issued */,
432 1 /* no duplicates */, 0)) {
433 sk_X509_free(result);
438 X509_STORE_free(store);
439 X509_STORE_CTX_free(csc);
443 int ossl_cmp_asn1_octet_string_set1(ASN1_OCTET_STRING **tgt,
444 const ASN1_OCTET_STRING *src)
446 ASN1_OCTET_STRING *new;
448 CMPerr(0, CMP_R_NULL_ARGUMENT);
451 if (*tgt == src) /* self-assignment */
455 if ((new = ASN1_OCTET_STRING_dup(src)) == NULL)
461 ASN1_OCTET_STRING_free(*tgt);
466 int ossl_cmp_asn1_octet_string_set1_bytes(ASN1_OCTET_STRING **tgt,
467 const unsigned char *bytes, int len)
469 ASN1_OCTET_STRING *new = NULL;
472 CMPerr(0, CMP_R_NULL_ARGUMENT);
476 if ((new = ASN1_OCTET_STRING_new()) == NULL
477 || !(ASN1_OCTET_STRING_set(new, bytes, len))) {
478 ASN1_OCTET_STRING_free(new);
483 ASN1_OCTET_STRING_free(*tgt);