xref: /freebsd/crypto/openssl/crypto/cmp/cmp_util.c (revision f25b8c9fb4f58cf61adb47d7570abe7caa6d385d)
1 /*
2  * Copyright 2007-2021 The OpenSSL Project Authors. All Rights Reserved.
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>
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>
18 
19 /*
20  * use trace API for CMP-specific logging, prefixed by "CMP " and severity
21  */
22 
OSSL_CMP_log_open(void)23 int OSSL_CMP_log_open(void) /* is designed to be idempotent */
24 {
25 #ifdef OPENSSL_NO_TRACE
26     return 1;
27 #else
28 #ifndef OPENSSL_NO_STDIO
29     BIO *bio = BIO_new_fp(stdout, BIO_NOCLOSE);
30 
31     if (bio != NULL && OSSL_trace_set_channel(OSSL_TRACE_CATEGORY_CMP, bio))
32         return 1;
33     BIO_free(bio);
34 #endif
35     ERR_raise(ERR_LIB_CMP, CMP_R_NO_STDIO);
36     return 0;
37 #endif
38 }
39 
OSSL_CMP_log_close(void)40 void 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" */
parse_level(const char * level)47 static 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 (HAS_PREFIX(level, OSSL_CMP_LOG_PREFIX))
57         level += strlen(OSSL_CMP_LOG_PREFIX);
58     len = end_level - level;
59     if (len > max_level_len)
60         return -1;
61     OPENSSL_strlcpy(level_copy, level, len + 1);
62     return strcmp(level_copy, "EMERG") == 0 ? OSSL_CMP_LOG_EMERG : strcmp(level_copy, "ALERT") == 0 ? OSSL_CMP_LOG_ALERT
63         : strcmp(level_copy, "CRIT") == 0                                                           ? OSSL_CMP_LOG_CRIT
64         : strcmp(level_copy, "ERROR") == 0                                                          ? OSSL_CMP_LOG_ERR
65         : strcmp(level_copy, "WARN") == 0                                                           ? OSSL_CMP_LOG_WARNING
66         : strcmp(level_copy, "NOTE") == 0                                                           ? OSSL_CMP_LOG_NOTICE
67         : strcmp(level_copy, "INFO") == 0                                                           ? OSSL_CMP_LOG_INFO
68         : strcmp(level_copy, "DEBUG") == 0                                                          ? OSSL_CMP_LOG_DEBUG
69                                                                                                     : -1;
70 }
71 
ossl_cmp_log_parse_metadata(const char * buf,OSSL_CMP_severity * level,char ** func,char ** file,int * line)72 const char *ossl_cmp_log_parse_metadata(const char *buf,
73     OSSL_CMP_severity *level,
74     char **func, char **file, int *line)
75 {
76     const char *p_func = buf;
77     const char *p_file = buf == NULL ? NULL : strchr(buf, ':');
78     const char *p_level = buf;
79     const char *msg = buf;
80 
81     *level = -1;
82     *func = NULL;
83     *file = NULL;
84     *line = 0;
85 
86     if (p_file != NULL) {
87         const char *p_line = strchr(++p_file, ':');
88 
89         if ((*level = parse_level(buf)) < 0 && p_line != NULL) {
90             /* check if buf contains location info and logging level */
91             char *p_level_tmp = (char *)p_level;
92             const long line_number = strtol(++p_line, &p_level_tmp, 10);
93 
94             p_level = p_level_tmp;
95             if (p_level > p_line && *(p_level++) == ':') {
96                 if ((*level = parse_level(p_level)) >= 0) {
97                     *func = OPENSSL_strndup(p_func, p_file - 1 - p_func);
98                     *file = OPENSSL_strndup(p_file, p_line - 1 - p_file);
99                     /* no real problem if OPENSSL_strndup() returns NULL */
100                     *line = (int)line_number;
101                     msg = strchr(p_level, ':');
102                     if (msg != NULL && *++msg == ' ')
103                         msg++;
104                 }
105             }
106         }
107     }
108     return msg;
109 }
110 
111 #define UNKNOWN_FUNC "(unknown function)" /* the default for OPENSSL_FUNC */
112 /*
113  * substitute fallback if component/function name is NULL or empty or contains
114  * just pseudo-information "(unknown function)" due to -pedantic and macros.h
115  */
improve_location_name(const char * func,const char * fallback)116 static const char *improve_location_name(const char *func, const char *fallback)
117 {
118     if (fallback == NULL)
119         return func == NULL ? UNKNOWN_FUNC : func;
120 
121     return func == NULL || *func == '\0' || strcmp(func, UNKNOWN_FUNC) == 0
122         ? fallback
123         : func;
124 }
125 
OSSL_CMP_print_to_bio(BIO * bio,const char * component,const char * file,int line,OSSL_CMP_severity level,const char * msg)126 int OSSL_CMP_print_to_bio(BIO *bio, const char *component, const char *file,
127     int line, OSSL_CMP_severity level, const char *msg)
128 {
129     const char *level_string = level == OSSL_CMP_LOG_EMERG ? "EMERG" : 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"
136                                                                                                    : "(unknown level)";
137 
138 #ifndef NDEBUG
139     if (BIO_printf(bio, "%s:%s:%d:", improve_location_name(component, "CMP"),
140             file, line)
141         < 0)
142         return 0;
143 #endif
144     return BIO_printf(bio, OSSL_CMP_LOG_PREFIX "%s: %s\n",
145                level_string, msg)
146         >= 0;
147 }
148 
149 #define ERR_PRINT_BUF_SIZE 4096
150 /* this is similar to ERR_print_errors_cb, but uses the CMP-specific cb type */
OSSL_CMP_print_errors_cb(OSSL_CMP_log_cb_t log_fn)151 void OSSL_CMP_print_errors_cb(OSSL_CMP_log_cb_t log_fn)
152 {
153     unsigned long err;
154     char msg[ERR_PRINT_BUF_SIZE];
155     const char *file = NULL, *func = NULL, *data = NULL;
156     int line, flags;
157 
158     while ((err = ERR_get_error_all(&file, &line, &func, &data, &flags)) != 0) {
159         const char *component = improve_location_name(func, ERR_lib_error_string(err));
160         unsigned long reason = ERR_GET_REASON(err);
161         const char *rs = NULL;
162         char rsbuf[256];
163 
164 #ifndef OPENSSL_NO_ERR
165         if (ERR_SYSTEM_ERROR(err)) {
166             if (openssl_strerror_r(reason, rsbuf, sizeof(rsbuf)))
167                 rs = rsbuf;
168         } else {
169             rs = ERR_reason_error_string(err);
170         }
171 #endif
172         if (rs == NULL) {
173             BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", reason);
174             rs = rsbuf;
175         }
176         if (data != NULL && (flags & ERR_TXT_STRING) != 0)
177             BIO_snprintf(msg, sizeof(msg), "%s:%s", rs, data);
178         else
179             BIO_snprintf(msg, sizeof(msg), "%s", rs);
180 
181         if (log_fn == NULL) {
182 #ifndef OPENSSL_NO_STDIO
183             BIO *bio = BIO_new_fp(stderr, BIO_NOCLOSE);
184 
185             if (bio != NULL) {
186                 OSSL_CMP_print_to_bio(bio, component, file, line,
187                     OSSL_CMP_LOG_ERR, msg);
188                 BIO_free(bio);
189             }
190 #else
191             /* ERR_raise(..., CMP_R_NO_STDIO) would make no sense here */
192 #endif
193         } else {
194             if (log_fn(component, file, line, OSSL_CMP_LOG_ERR, msg) <= 0)
195                 break; /* abort outputting the error report */
196         }
197     }
198 }
199 
ossl_cmp_X509_STORE_add1_certs(X509_STORE * store,STACK_OF (X509)* certs,int only_self_signed)200 int ossl_cmp_X509_STORE_add1_certs(X509_STORE *store, STACK_OF(X509) *certs,
201     int only_self_signed)
202 {
203     int i;
204 
205     if (store == NULL) {
206         ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
207         return 0;
208     }
209     if (certs == NULL)
210         return 1;
211     for (i = 0; i < sk_X509_num(certs); i++) {
212         X509 *cert = sk_X509_value(certs, i);
213 
214         if (!only_self_signed || X509_self_signed(cert, 0) == 1)
215             if (!X509_STORE_add_cert(store, cert)) /* ups cert ref counter */
216                 return 0;
217     }
218     return 1;
219 }
220 
ossl_cmp_sk_ASN1_UTF8STRING_push_str(STACK_OF (ASN1_UTF8STRING)* sk,const char * text,int len)221 int ossl_cmp_sk_ASN1_UTF8STRING_push_str(STACK_OF(ASN1_UTF8STRING) *sk,
222     const char *text, int len)
223 {
224     ASN1_UTF8STRING *utf8string;
225 
226     if (!ossl_assert(sk != NULL && text != NULL))
227         return 0;
228     if ((utf8string = ASN1_UTF8STRING_new()) == NULL)
229         return 0;
230     if (!ASN1_STRING_set(utf8string, text, len))
231         goto err;
232     if (!sk_ASN1_UTF8STRING_push(sk, utf8string))
233         goto err;
234     return 1;
235 
236 err:
237     ASN1_UTF8STRING_free(utf8string);
238     return 0;
239 }
240 
ossl_cmp_asn1_octet_string_set1(ASN1_OCTET_STRING ** tgt,const ASN1_OCTET_STRING * src)241 int ossl_cmp_asn1_octet_string_set1(ASN1_OCTET_STRING **tgt,
242     const ASN1_OCTET_STRING *src)
243 {
244     ASN1_OCTET_STRING *new;
245 
246     if (tgt == NULL) {
247         ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
248         return 0;
249     }
250     if (*tgt == src) /* self-assignment */
251         return 1;
252 
253     if (src != NULL) {
254         if ((new = ASN1_OCTET_STRING_dup(src)) == NULL)
255             return 0;
256     } else {
257         new = NULL;
258     }
259 
260     ASN1_OCTET_STRING_free(*tgt);
261     *tgt = new;
262     return 1;
263 }
264 
ossl_cmp_asn1_octet_string_set1_bytes(ASN1_OCTET_STRING ** tgt,const unsigned char * bytes,int len)265 int ossl_cmp_asn1_octet_string_set1_bytes(ASN1_OCTET_STRING **tgt,
266     const unsigned char *bytes, int len)
267 {
268     ASN1_OCTET_STRING *new = NULL;
269 
270     if (tgt == NULL) {
271         ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
272         return 0;
273     }
274     if (bytes != NULL) {
275         if ((new = ASN1_OCTET_STRING_new()) == NULL
276             || !(ASN1_OCTET_STRING_set(new, bytes, len))) {
277             ASN1_OCTET_STRING_free(new);
278             return 0;
279         }
280     }
281 
282     ASN1_OCTET_STRING_free(*tgt);
283     *tgt = new;
284     return 1;
285 }
286