]> git.ipfire.org Git - thirdparty/openssl.git/blame - crypto/cmp/cmp_util.c
Rename OPENSSL_CTX prefix to OSSL_LIB_CTX
[thirdparty/openssl.git] / crypto / cmp / cmp_util.c
CommitLineData
7960dbec 1/*
33388b44 2 * Copyright 2007-2020 The OpenSSL Project Authors. All Rights Reserved.
7960dbec
DDO
3 * Copyright Nokia 2007-2019
4 * Copyright Siemens AG 2015-2019
5 *
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
10 */
11
12#include <string.h>
13#include <openssl/cmp_util.h>
706457b7 14#include "cmp_local.h" /* just for decls of internal functions defined here */
7960dbec
DDO
15#include <openssl/cmperr.h>
16#include <openssl/err.h> /* should be implied by cmperr.h */
17#include <openssl/x509v3.h>
18
19/*
20 * use trace API for CMP-specific logging, prefixed by "CMP " and severity
21 */
22
23int OSSL_CMP_log_open(void) /* is designed to be idempotent */
24{
25#ifndef OPENSSL_NO_STDIO
26 BIO *bio = BIO_new_fp(stdout, BIO_NOCLOSE);
27
28 if (bio != NULL && OSSL_trace_set_channel(OSSL_TRACE_CATEGORY_CMP, bio))
29 return 1;
30 BIO_free(bio);
31#endif
32 CMPerr(0, CMP_R_NO_STDIO);
33 return 0;
34}
35
36void OSSL_CMP_log_close(void) /* is designed to be idempotent */
37{
38 (void)OSSL_trace_set_channel(OSSL_TRACE_CATEGORY_CMP, NULL);
39}
40
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" */
43static OSSL_CMP_severity parse_level(const char *level)
44{
45 const char *end_level = strchr(level, ':');
46 int len;
47 char level_copy[max_level_len + 1];
48
49 if (end_level == NULL)
50 return -1;
51
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)
57 return -1;
58 OPENSSL_strlcpy(level_copy, level, len + 1);
59 return
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 :
68 -1;
69}
70
71const char *ossl_cmp_log_parse_metadata(const char *buf,
ebf30069
DDO
72 OSSL_CMP_severity *level,
73 char **func, char **file, int *line)
7960dbec
DDO
74{
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;
79
80 *level = -1;
81 *func = NULL;
82 *file = NULL;
83 *line = 0;
84
85 if (p_file != NULL) {
86 const char *p_line = strchr(++p_file, ':');
87
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);
92
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;
101 if (*msg == ' ')
102 msg++;
103 }
104 }
105 }
106 }
107 return msg;
108}
109
ebf30069
DDO
110#define UNKNOWN_FUNC "(unknown function)" /* the default for OPENSSL_FUNC */
111/*
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
114 */
115static const char *improve_location_name(const char *func, const char *fallback)
116{
555ed968
MC
117 if (fallback == NULL)
118 return func == NULL ? UNKNOWN_FUNC : func;
119
ebf30069
DDO
120 return func == NULL || *func == '\0' || strcmp(func, UNKNOWN_FUNC) == 0
121 ? fallback : func;
122}
123
235595c4 124int OSSL_CMP_print_to_bio(BIO *bio, const char *component, const char *file,
ebf30069
DDO
125 int line, OSSL_CMP_severity level, const char *msg)
126{
127 const char *level_string =
128 level == OSSL_CMP_LOG_EMERG ? "EMERG" :
129 level == OSSL_CMP_LOG_ALERT ? "ALERT" :
130 level == OSSL_CMP_LOG_CRIT ? "CRIT" :
131 level == OSSL_CMP_LOG_ERR ? "error" :
132 level == OSSL_CMP_LOG_WARNING ? "warning" :
133 level == OSSL_CMP_LOG_NOTICE ? "NOTE" :
134 level == OSSL_CMP_LOG_INFO ? "info" :
135 level == OSSL_CMP_LOG_DEBUG ? "DEBUG" : "(unknown level)";
136
137#ifndef NDEBUG
138 if (BIO_printf(bio, "%s:%s:%d:", improve_location_name(component, "CMP"),
139 file, line) < 0)
140 return 0;
141#endif
142 return BIO_printf(bio, OSSL_CMP_LOG_PREFIX"%s: %s\n",
143 level_string, msg) >= 0;
144}
7960dbec 145
31b28ad9 146#define ERR_PRINT_BUF_SIZE 4096
7960dbec 147/* this is similar to ERR_print_errors_cb, but uses the CMP-specific cb type */
7e765f46 148void OSSL_CMP_print_errors_cb(OSSL_CMP_log_cb_t log_fn)
7960dbec
DDO
149{
150 unsigned long err;
31b28ad9 151 char msg[ERR_PRINT_BUF_SIZE];
7960dbec
DDO
152 const char *file = NULL, *func = NULL, *data = NULL;
153 int line, flags;
154
7960dbec 155 while ((err = ERR_get_error_all(&file, &line, &func, &data, &flags)) != 0) {
ebf30069
DDO
156 const char *component =
157 improve_location_name(func, ERR_lib_error_string(err));
7960dbec
DDO
158
159 if (!(flags & ERR_TXT_STRING))
160 data = NULL;
ebf30069
DDO
161 BIO_snprintf(msg, sizeof(msg), "%s%s%s", ERR_reason_error_string(err),
162 data == NULL || *data == '\0' ? "" : " : ",
163 data == NULL ? "" : data);
164 if (log_fn == NULL) {
165#ifndef OPENSSL_NO_STDIO
166 BIO *bio = BIO_new_fp(stderr, BIO_NOCLOSE);
167
168 if (bio != NULL) {
169 OSSL_CMP_print_to_bio(bio, component, file, line,
170 OSSL_CMP_LOG_ERR, msg);
171 BIO_free(bio);
172 }
7960dbec 173#else
ebf30069 174 /* CMPerr(0, CMP_R_NO_STDIO) makes no sense during error printing */
7960dbec 175#endif
ebf30069
DDO
176 } else {
177 if (log_fn(component, file, line, OSSL_CMP_LOG_ERR, msg) <= 0)
178 break; /* abort outputting the error report */
179 }
7960dbec
DDO
180 }
181}
182
7960dbec 183int ossl_cmp_X509_STORE_add1_certs(X509_STORE *store, STACK_OF(X509) *certs,
0d8dbb52 184 int only_self_signed)
7960dbec
DDO
185{
186 int i;
187
188 if (store == NULL) {
189 CMPerr(0, CMP_R_NULL_ARGUMENT);
190 return 0;
191 }
192 if (certs == NULL)
193 return 1;
194 for (i = 0; i < sk_X509_num(certs); i++) {
195 X509 *cert = sk_X509_value(certs, i);
196
0d8dbb52 197 if (!only_self_signed || X509_self_signed(cert, 0) == 1)
7960dbec
DDO
198 if (!X509_STORE_add_cert(store, cert)) /* ups cert ref counter */
199 return 0;
200 }
201 return 1;
202}
203
7960dbec 204/*-
15076c26
DDO
205 * Builds a certificate chain starting from <cert>
206 * using the optional list of intermediate CA certificates <certs>.
207 * If <store> is NULL builds the chain as far down as possible, ignoring errors.
208 * Else the chain must reach a trust anchor contained in <store>.
7960dbec 209 *
15076c26
DDO
210 * Returns NULL on error, else a pointer to a stack of (up_ref'ed) certificates
211 * starting with given EE certificate and followed by all available intermediate
212 * certificates down towards any trust anchor but without including the latter.
7960dbec 213 *
15076c26 214 * NOTE: If a non-NULL stack is returned the caller is responsible for freeing.
28e9f62b
DDO
215 * NOTE: In case there is more than one possibility for the chain,
216 * OpenSSL seems to take the first one; check X509_verify_cert() for details.
7960dbec 217 */
15076c26 218/* TODO this should be of more general interest and thus be exported. */
28e9f62b 219STACK_OF(X509)
b4250010 220 *ossl_cmp_build_cert_chain(OSSL_LIB_CTX *libctx, const char *propq,
15076c26 221 X509_STORE *store,
28e9f62b 222 STACK_OF(X509) *certs, X509 *cert)
7960dbec
DDO
223{
224 STACK_OF(X509) *chain = NULL, *result = NULL;
15076c26 225 X509_STORE *ts = store == NULL ? X509_STORE_new() : store;
7960dbec
DDO
226 X509_STORE_CTX *csc = NULL;
227
15076c26 228 if (ts == NULL || cert == NULL) {
7960dbec
DDO
229 CMPerr(0, CMP_R_NULL_ARGUMENT);
230 goto err;
231 }
232
d8652be0 233 if ((csc = X509_STORE_CTX_new_ex(libctx, propq)) == NULL)
7960dbec 234 goto err;
15076c26
DDO
235 if (store == NULL && certs != NULL
236 && !ossl_cmp_X509_STORE_add1_certs(ts, certs, 0))
7960dbec 237 goto err;
15076c26
DDO
238 if (!X509_STORE_CTX_init(csc, ts, cert,
239 store == NULL ? NULL : certs))
240 goto err;
241 /* disable any cert status/revocation checking etc. */
242 X509_VERIFY_PARAM_clear_flags(X509_STORE_CTX_get0_param(csc),
243 ~(X509_V_FLAG_USE_CHECK_TIME
244 | X509_V_FLAG_NO_CHECK_TIME));
7960dbec 245
15076c26
DDO
246 if (X509_verify_cert(csc) <= 0 && store != NULL)
247 goto err;
7960dbec
DDO
248 chain = X509_STORE_CTX_get0_chain(csc);
249
eeccc237 250 /* result list to store the up_ref'ed not self-signed certificates */
7960dbec
DDO
251 if ((result = sk_X509_new_null()) == NULL)
252 goto err;
eeccc237
DDO
253 if (!X509_add_certs(result, chain,
254 X509_ADD_FLAG_UP_REF | X509_ADD_FLAG_NO_DUP
255 | X509_ADD_FLAG_NO_SS)) {
7960dbec
DDO
256 sk_X509_free(result);
257 result = NULL;
258 }
259
260 err:
15076c26
DDO
261 if (store == NULL)
262 X509_STORE_free(ts);
7960dbec
DDO
263 X509_STORE_CTX_free(csc);
264 return result;
265}
266
62dcd2aa
DDO
267int ossl_cmp_sk_ASN1_UTF8STRING_push_str(STACK_OF(ASN1_UTF8STRING) *sk,
268 const char *text)
269{
270 ASN1_UTF8STRING *utf8string;
271
272 if (!ossl_assert(sk != NULL && text != NULL))
273 return 0;
274 if ((utf8string = ASN1_UTF8STRING_new()) == NULL)
275 return 0;
276 if (!ASN1_STRING_set(utf8string, text, -1))
277 goto err;
278 if (!sk_ASN1_UTF8STRING_push(sk, utf8string))
279 goto err;
280 return 1;
281
282 err:
283 ASN1_UTF8STRING_free(utf8string);
284 return 0;
285}
286
7960dbec
DDO
287int ossl_cmp_asn1_octet_string_set1(ASN1_OCTET_STRING **tgt,
288 const ASN1_OCTET_STRING *src)
289{
59ae04d7 290 ASN1_OCTET_STRING *new;
7960dbec
DDO
291 if (tgt == NULL) {
292 CMPerr(0, CMP_R_NULL_ARGUMENT);
293 return 0;
294 }
295 if (*tgt == src) /* self-assignment */
296 return 1;
7960dbec
DDO
297
298 if (src != NULL) {
59ae04d7 299 if ((new = ASN1_OCTET_STRING_dup(src)) == NULL)
7960dbec
DDO
300 return 0;
301 } else {
59ae04d7 302 new = NULL;
7960dbec
DDO
303 }
304
59ae04d7 305 ASN1_OCTET_STRING_free(*tgt);
306 *tgt = new;
7960dbec
DDO
307 return 1;
308}
309
310int ossl_cmp_asn1_octet_string_set1_bytes(ASN1_OCTET_STRING **tgt,
311 const unsigned char *bytes, int len)
312{
313 ASN1_OCTET_STRING *new = NULL;
314
315 if (tgt == NULL) {
316 CMPerr(0, CMP_R_NULL_ARGUMENT);
317 return 0;
318 }
319 if (bytes != NULL) {
ebf30069 320 if ((new = ASN1_OCTET_STRING_new()) == NULL
7960dbec
DDO
321 || !(ASN1_OCTET_STRING_set(new, bytes, len))) {
322 ASN1_OCTET_STRING_free(new);
323 return 0;
324 }
325 }
326
327 ASN1_OCTET_STRING_free(*tgt);
328 *tgt = new;
329 return 1;
330}