]> git.ipfire.org Git - thirdparty/openssl.git/blame - crypto/cmp/cmp_util.c
Use in CMP+CRMF libctx and propq param added to sign/verify/HMAC/decrypt
[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
852c2ed2
RS
19DEFINE_STACK_OF(X509)
20DEFINE_STACK_OF(X509_OBJECT)
21DEFINE_STACK_OF(ASN1_UTF8STRING)
22
7960dbec
DDO
23/*
24 * use trace API for CMP-specific logging, prefixed by "CMP " and severity
25 */
26
27int OSSL_CMP_log_open(void) /* is designed to be idempotent */
28{
29#ifndef OPENSSL_NO_STDIO
30 BIO *bio = BIO_new_fp(stdout, BIO_NOCLOSE);
31
32 if (bio != NULL && OSSL_trace_set_channel(OSSL_TRACE_CATEGORY_CMP, bio))
33 return 1;
34 BIO_free(bio);
35#endif
36 CMPerr(0, CMP_R_NO_STDIO);
37 return 0;
38}
39
40void OSSL_CMP_log_close(void) /* is designed to be idempotent */
41{
42 (void)OSSL_trace_set_channel(OSSL_TRACE_CATEGORY_CMP, NULL);
43}
44
45/* return >= 0 if level contains logging level, possibly preceded by "CMP " */
46#define max_level_len 5 /* = max length of the below strings, e.g., "EMERG" */
47static OSSL_CMP_severity parse_level(const char *level)
48{
49 const char *end_level = strchr(level, ':');
50 int len;
51 char level_copy[max_level_len + 1];
52
53 if (end_level == NULL)
54 return -1;
55
56 if (strncmp(level, OSSL_CMP_LOG_PREFIX,
57 strlen(OSSL_CMP_LOG_PREFIX)) == 0)
58 level += strlen(OSSL_CMP_LOG_PREFIX);
59 len = end_level - level;
60 if (len > max_level_len)
61 return -1;
62 OPENSSL_strlcpy(level_copy, level, len + 1);
63 return
64 strcmp(level_copy, "EMERG") == 0 ? OSSL_CMP_LOG_EMERG :
65 strcmp(level_copy, "ALERT") == 0 ? OSSL_CMP_LOG_ALERT :
66 strcmp(level_copy, "CRIT") == 0 ? OSSL_CMP_LOG_CRIT :
67 strcmp(level_copy, "ERROR") == 0 ? OSSL_CMP_LOG_ERR :
68 strcmp(level_copy, "WARN") == 0 ? OSSL_CMP_LOG_WARNING :
69 strcmp(level_copy, "NOTE") == 0 ? OSSL_CMP_LOG_NOTICE :
70 strcmp(level_copy, "INFO") == 0 ? OSSL_CMP_LOG_INFO :
71 strcmp(level_copy, "DEBUG") == 0 ? OSSL_CMP_LOG_DEBUG :
72 -1;
73}
74
75const char *ossl_cmp_log_parse_metadata(const char *buf,
ebf30069
DDO
76 OSSL_CMP_severity *level,
77 char **func, char **file, int *line)
7960dbec
DDO
78{
79 const char *p_func = buf;
80 const char *p_file = buf == NULL ? NULL : strchr(buf, ':');
81 const char *p_level = buf;
82 const char *msg = buf;
83
84 *level = -1;
85 *func = NULL;
86 *file = NULL;
87 *line = 0;
88
89 if (p_file != NULL) {
90 const char *p_line = strchr(++p_file, ':');
91
92 if ((*level = parse_level(buf)) < 0 && p_line != NULL) {
93 /* check if buf contains location info and logging level */
94 char *p_level_tmp = (char *)p_level;
95 const long line_number = strtol(++p_line, &p_level_tmp, 10);
96
97 p_level = p_level_tmp;
98 if (p_level > p_line && *(p_level++) == ':') {
99 if ((*level = parse_level(p_level)) >= 0) {
100 *func = OPENSSL_strndup(p_func, p_file - 1 - p_func);
101 *file = OPENSSL_strndup(p_file, p_line - 1 - p_file);
102 /* no real problem if OPENSSL_strndup() returns NULL */
103 *line = (int)line_number;
104 msg = strchr(p_level, ':') + 1;
105 if (*msg == ' ')
106 msg++;
107 }
108 }
109 }
110 }
111 return msg;
112}
113
ebf30069
DDO
114#define UNKNOWN_FUNC "(unknown function)" /* the default for OPENSSL_FUNC */
115/*
116 * substitute fallback if component/function name is NULL or empty or contains
117 * just pseudo-information "(unknown function)" due to -pedantic and macros.h
118 */
119static const char *improve_location_name(const char *func, const char *fallback)
120{
555ed968
MC
121 if (fallback == NULL)
122 return func == NULL ? UNKNOWN_FUNC : func;
123
ebf30069
DDO
124 return func == NULL || *func == '\0' || strcmp(func, UNKNOWN_FUNC) == 0
125 ? fallback : func;
126}
127
235595c4 128int OSSL_CMP_print_to_bio(BIO *bio, const char *component, const char *file,
ebf30069
DDO
129 int line, OSSL_CMP_severity level, const char *msg)
130{
131 const char *level_string =
132 level == OSSL_CMP_LOG_EMERG ? "EMERG" :
133 level == OSSL_CMP_LOG_ALERT ? "ALERT" :
134 level == OSSL_CMP_LOG_CRIT ? "CRIT" :
135 level == OSSL_CMP_LOG_ERR ? "error" :
136 level == OSSL_CMP_LOG_WARNING ? "warning" :
137 level == OSSL_CMP_LOG_NOTICE ? "NOTE" :
138 level == OSSL_CMP_LOG_INFO ? "info" :
139 level == OSSL_CMP_LOG_DEBUG ? "DEBUG" : "(unknown level)";
140
141#ifndef NDEBUG
142 if (BIO_printf(bio, "%s:%s:%d:", improve_location_name(component, "CMP"),
143 file, line) < 0)
144 return 0;
145#endif
146 return BIO_printf(bio, OSSL_CMP_LOG_PREFIX"%s: %s\n",
147 level_string, msg) >= 0;
148}
7960dbec 149
31b28ad9 150#define ERR_PRINT_BUF_SIZE 4096
7960dbec 151/* this is similar to ERR_print_errors_cb, but uses the CMP-specific cb type */
7e765f46 152void OSSL_CMP_print_errors_cb(OSSL_CMP_log_cb_t log_fn)
7960dbec
DDO
153{
154 unsigned long err;
31b28ad9 155 char msg[ERR_PRINT_BUF_SIZE];
7960dbec
DDO
156 const char *file = NULL, *func = NULL, *data = NULL;
157 int line, flags;
158
7960dbec 159 while ((err = ERR_get_error_all(&file, &line, &func, &data, &flags)) != 0) {
ebf30069
DDO
160 const char *component =
161 improve_location_name(func, ERR_lib_error_string(err));
7960dbec
DDO
162
163 if (!(flags & ERR_TXT_STRING))
164 data = NULL;
ebf30069
DDO
165 BIO_snprintf(msg, sizeof(msg), "%s%s%s", ERR_reason_error_string(err),
166 data == NULL || *data == '\0' ? "" : " : ",
167 data == NULL ? "" : data);
168 if (log_fn == NULL) {
169#ifndef OPENSSL_NO_STDIO
170 BIO *bio = BIO_new_fp(stderr, BIO_NOCLOSE);
171
172 if (bio != NULL) {
173 OSSL_CMP_print_to_bio(bio, component, file, line,
174 OSSL_CMP_LOG_ERR, msg);
175 BIO_free(bio);
176 }
7960dbec 177#else
ebf30069 178 /* CMPerr(0, CMP_R_NO_STDIO) makes no sense during error printing */
7960dbec 179#endif
ebf30069
DDO
180 } else {
181 if (log_fn(component, file, line, OSSL_CMP_LOG_ERR, msg) <= 0)
182 break; /* abort outputting the error report */
183 }
7960dbec
DDO
184 }
185}
186
7960dbec 187int ossl_cmp_X509_STORE_add1_certs(X509_STORE *store, STACK_OF(X509) *certs,
0d8dbb52 188 int only_self_signed)
7960dbec
DDO
189{
190 int i;
191
192 if (store == NULL) {
193 CMPerr(0, CMP_R_NULL_ARGUMENT);
194 return 0;
195 }
196 if (certs == NULL)
197 return 1;
198 for (i = 0; i < sk_X509_num(certs); i++) {
199 X509 *cert = sk_X509_value(certs, i);
200
0d8dbb52 201 if (!only_self_signed || X509_self_signed(cert, 0) == 1)
7960dbec
DDO
202 if (!X509_STORE_add_cert(store, cert)) /* ups cert ref counter */
203 return 0;
204 }
205 return 1;
206}
207
7960dbec 208/*-
28e9f62b 209 * Builds up the chain of intermediate CA certificates
6d1f50b5 210 * starting from the given certificate <cert> as high up as possible using
28e9f62b 211 * the given list of candidate certificates, similarly to ssl_add_cert_chain().
7960dbec
DDO
212 *
213 * Intended use of this function is to find all the certificates above the trust
214 * anchor needed to verify an EE's own certificate. Those are supposed to be
28e9f62b 215 * included in the ExtraCerts field of every first CMP message of a transaction
7960dbec
DDO
216 * when MSG_SIG_ALG is utilized.
217 *
218 * NOTE: This allocates a stack and increments the reference count of each cert,
219 * so when not needed any more the stack and all its elements should be freed.
28e9f62b
DDO
220 * NOTE: In case there is more than one possibility for the chain,
221 * OpenSSL seems to take the first one; check X509_verify_cert() for details.
7960dbec
DDO
222 *
223 * returns a pointer to a stack of (up_ref'ed) X509 certificates containing:
224 * - the EE certificate given in the function arguments (cert)
225 * - all intermediate certificates up the chain toward the trust anchor
226 * whereas the (self-signed) trust anchor is not included
227 * returns NULL on error
228 */
28e9f62b
DDO
229STACK_OF(X509)
230 *ossl_cmp_build_cert_chain(OPENSSL_CTX *libctx, const char *propq,
231 STACK_OF(X509) *certs, X509 *cert)
7960dbec
DDO
232{
233 STACK_OF(X509) *chain = NULL, *result = NULL;
234 X509_STORE *store = X509_STORE_new();
235 X509_STORE_CTX *csc = NULL;
236
237 if (certs == NULL || cert == NULL || store == NULL) {
238 CMPerr(0, CMP_R_NULL_ARGUMENT);
239 goto err;
240 }
241
28e9f62b 242 csc = X509_STORE_CTX_new_with_libctx(libctx, propq);
7960dbec
DDO
243 if (csc == NULL)
244 goto err;
245
246 if (!ossl_cmp_X509_STORE_add1_certs(store, certs, 0)
247 || !X509_STORE_CTX_init(csc, store, cert, NULL))
248 goto err;
249
250 (void)ERR_set_mark();
251 /*
252 * ignore return value as it would fail without trust anchor given in store
253 */
254 (void)X509_verify_cert(csc);
255
256 /* don't leave any new errors in the queue */
257 (void)ERR_pop_to_mark();
258
259 chain = X509_STORE_CTX_get0_chain(csc);
260
eeccc237 261 /* result list to store the up_ref'ed not self-signed certificates */
7960dbec
DDO
262 if ((result = sk_X509_new_null()) == NULL)
263 goto err;
eeccc237
DDO
264 if (!X509_add_certs(result, chain,
265 X509_ADD_FLAG_UP_REF | X509_ADD_FLAG_NO_DUP
266 | X509_ADD_FLAG_NO_SS)) {
7960dbec
DDO
267 sk_X509_free(result);
268 result = NULL;
269 }
270
271 err:
272 X509_STORE_free(store);
273 X509_STORE_CTX_free(csc);
274 return result;
275}
276
62dcd2aa
DDO
277int ossl_cmp_sk_ASN1_UTF8STRING_push_str(STACK_OF(ASN1_UTF8STRING) *sk,
278 const char *text)
279{
280 ASN1_UTF8STRING *utf8string;
281
282 if (!ossl_assert(sk != NULL && text != NULL))
283 return 0;
284 if ((utf8string = ASN1_UTF8STRING_new()) == NULL)
285 return 0;
286 if (!ASN1_STRING_set(utf8string, text, -1))
287 goto err;
288 if (!sk_ASN1_UTF8STRING_push(sk, utf8string))
289 goto err;
290 return 1;
291
292 err:
293 ASN1_UTF8STRING_free(utf8string);
294 return 0;
295}
296
7960dbec
DDO
297int ossl_cmp_asn1_octet_string_set1(ASN1_OCTET_STRING **tgt,
298 const ASN1_OCTET_STRING *src)
299{
59ae04d7 300 ASN1_OCTET_STRING *new;
7960dbec
DDO
301 if (tgt == NULL) {
302 CMPerr(0, CMP_R_NULL_ARGUMENT);
303 return 0;
304 }
305 if (*tgt == src) /* self-assignment */
306 return 1;
7960dbec
DDO
307
308 if (src != NULL) {
59ae04d7 309 if ((new = ASN1_OCTET_STRING_dup(src)) == NULL)
7960dbec
DDO
310 return 0;
311 } else {
59ae04d7 312 new = NULL;
7960dbec
DDO
313 }
314
59ae04d7 315 ASN1_OCTET_STRING_free(*tgt);
316 *tgt = new;
7960dbec
DDO
317 return 1;
318}
319
320int ossl_cmp_asn1_octet_string_set1_bytes(ASN1_OCTET_STRING **tgt,
321 const unsigned char *bytes, int len)
322{
323 ASN1_OCTET_STRING *new = NULL;
324
325 if (tgt == NULL) {
326 CMPerr(0, CMP_R_NULL_ARGUMENT);
327 return 0;
328 }
329 if (bytes != NULL) {
ebf30069 330 if ((new = ASN1_OCTET_STRING_new()) == NULL
7960dbec
DDO
331 || !(ASN1_OCTET_STRING_set(new, bytes, len))) {
332 ASN1_OCTET_STRING_free(new);
333 return 0;
334 }
335 }
336
337 ASN1_OCTET_STRING_free(*tgt);
338 *tgt = new;
339 return 1;
340}