/src/openssl/crypto/cmp/cmp_util.c

Source
/*
 * Copyright 2007-2025 The OpenSSL Project Authors. All Rights Reserved.
 * Copyright Nokia 2007-2019
 * Copyright Siemens AG 2015-2019
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#include <string.h>
#include <openssl/cmp_util.h>
#include "cmp_local.h" /* just for decls of internal functions defined here */
#include <openssl/cmperr.h>
#include <openssl/err.h> /* should be implied by cmperr.h */
#include <openssl/x509v3.h>

/*
 * use trace API for CMP-specific logging, prefixed by "CMP " and severity
 */

int OSSL_CMP_log_open(void) /* is designed to be idempotent */
{
#ifdef OPENSSL_NO_TRACE
    return 1;
#else
#ifndef OPENSSL_NO_STDIO
    BIO *bio = BIO_new_fp(stdout, BIO_NOCLOSE);

    if (bio != NULL && OSSL_trace_set_channel(OSSL_TRACE_CATEGORY_CMP, bio))
        return 1;
    BIO_free(bio);
#endif
    ERR_raise(ERR_LIB_CMP, CMP_R_NO_STDIO);
    return 0;
#endif
}

void OSSL_CMP_log_close(void) /* is designed to be idempotent */
{
    (void)OSSL_trace_set_channel(OSSL_TRACE_CATEGORY_CMP, NULL);
}

/* return >= 0 if level contains logging level, possibly preceded by "CMP " */
#define max_level_len 5 /* = max length of the below strings, e.g., "EMERG" */
static OSSL_CMP_severity parse_level(const char *level)
{
    const char *end_level = strchr(level, ':');
    int len;
    char level_copy[max_level_len + 1];

    if (end_level == NULL)
        return -1;

    if (HAS_PREFIX(level, OSSL_CMP_LOG_PREFIX))
        level += strlen(OSSL_CMP_LOG_PREFIX);
    len = (int)(end_level - level);
    if (len > max_level_len)
        return -1;
    OPENSSL_strlcpy(level_copy, level, len + 1);
    return strcmp(level_copy, "EMERG") == 0 ? OSSL_CMP_LOG_EMERG : strcmp(level_copy, "ALERT") == 0 ? OSSL_CMP_LOG_ALERT
        : strcmp(level_copy, "CRIT") == 0                                                           ? OSSL_CMP_LOG_CRIT
        : strcmp(level_copy, "ERROR") == 0                                                          ? OSSL_CMP_LOG_ERR
        : strcmp(level_copy, "WARN") == 0                                                           ? OSSL_CMP_LOG_WARNING
        : strcmp(level_copy, "NOTE") == 0                                                           ? OSSL_CMP_LOG_NOTICE
        : strcmp(level_copy, "INFO") == 0                                                           ? OSSL_CMP_LOG_INFO
        : strcmp(level_copy, "DEBUG") == 0                                                          ? OSSL_CMP_LOG_DEBUG
                                                                                                    : -1;
}

const char *ossl_cmp_log_parse_metadata(const char *buf,
    OSSL_CMP_severity *level,
    char **func, char **file, int *line)
{
    const char *p_func = buf;
    const char *p_file = buf == NULL ? NULL : strchr(buf, ':');
    const char *p_level = buf;
    const char *msg = buf;

    *level = -1;
    *func = NULL;
    *file = NULL;
    *line = 0;

    if (p_file != NULL) {
        const char *p_line = strchr(++p_file, ':');

        if ((*level = parse_level(buf)) < 0 && p_line != NULL) {
            /* check if buf contains location info and logging level */
            char *p_level_tmp = (char *)p_level;
            const long line_number = strtol(++p_line, &p_level_tmp, 10);

            p_level = p_level_tmp;
            if (p_level > p_line && *(p_level++) == ':') {
                if ((*level = parse_level(p_level)) >= 0) {
                    *func = OPENSSL_strndup(p_func, p_file - 1 - p_func);
                    *file = OPENSSL_strndup(p_file, p_line - 1 - p_file);
                    /* no real problem if OPENSSL_strndup() returns NULL */
                    *line = (int)line_number;
                    msg = strchr(p_level, ':');
                    if (msg != NULL && *++msg == ' ')
                        msg++;
                }
            }
        }
    }
    return msg;
}

#define UNKNOWN_FUNC "(unknown function)" /* the default for OPENSSL_FUNC */
/*
 * substitute fallback if component/function name is NULL or empty or contains
 * just pseudo-information "(unknown function)" due to -pedantic and macros.h
 */
static const char *improve_location_name(const char *func, const char *fallback)
{
    if (fallback == NULL)
        return func == NULL ? UNKNOWN_FUNC : func;

    return func == NULL || *func == '\0' || strcmp(func, UNKNOWN_FUNC) == 0
        ? fallback
        : func;
}

int OSSL_CMP_print_to_bio(BIO *bio, const char *component, const char *file,
    int line, OSSL_CMP_severity level, const char *msg)
{
    const char *level_string = level == OSSL_CMP_LOG_EMERG ? "EMERG" : level == OSSL_CMP_LOG_ALERT ? "ALERT"
        : level == OSSL_CMP_LOG_CRIT                                                               ? "CRIT"
        : level == OSSL_CMP_LOG_ERR                                                                ? "error"
        : level == OSSL_CMP_LOG_WARNING                                                            ? "warning"
        : level == OSSL_CMP_LOG_NOTICE                                                             ? "NOTE"
        : level == OSSL_CMP_LOG_INFO                                                               ? "info"
        : level == OSSL_CMP_LOG_DEBUG                                                              ? "DEBUG"
                                                                                                   : "(unknown level)";

#ifndef NDEBUG
    if (BIO_printf(bio, "%s:%s:%d:", improve_location_name(component, "CMP"),
            file, line)
        < 0)
        return 0;
#endif
    return BIO_printf(bio, OSSL_CMP_LOG_PREFIX "%s: %s\n",
               level_string, msg)
        >= 0;
}

#define ERR_PRINT_BUF_SIZE 4096
/* this is similar to ERR_print_errors_cb, but uses the CMP-specific cb type */
void OSSL_CMP_print_errors_cb(OSSL_CMP_log_cb_t log_fn)
{
    unsigned long err;
    char msg[ERR_PRINT_BUF_SIZE];
    const char *file = NULL, *func = NULL, *data = NULL;
    int line, flags;

    while ((err = ERR_get_error_all(&file, &line, &func, &data, &flags)) != 0) {
        const char *component = improve_location_name(func, ERR_lib_error_string(err));
        unsigned long reason = ERR_GET_REASON(err);
        const char *rs = NULL;
        char rsbuf[256];

#ifndef OPENSSL_NO_ERR
        if (ERR_SYSTEM_ERROR(err)) {
            if (openssl_strerror_r(reason, rsbuf, sizeof(rsbuf)))
                rs = rsbuf;
        } else {
            rs = ERR_reason_error_string(err);
        }
#endif
        if (rs == NULL) {
            BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", reason);
            rs = rsbuf;
        }
        if (data != NULL && (flags & ERR_TXT_STRING) != 0)
            BIO_snprintf(msg, sizeof(msg), "%s:%s", rs, data);
        else
            BIO_snprintf(msg, sizeof(msg), "%s", rs);

        if (log_fn == NULL) {
#ifndef OPENSSL_NO_STDIO
            BIO *bio = BIO_new_fp(stderr, BIO_NOCLOSE);

            if (bio != NULL) {
                OSSL_CMP_print_to_bio(bio, component, file, line,
                    OSSL_CMP_LOG_ERR, msg);
                BIO_free(bio);
            }
#else
            /* ERR_raise(..., CMP_R_NO_STDIO) would make no sense here */
#endif
        } else {
            if (log_fn(component, file, line, OSSL_CMP_LOG_ERR, msg) <= 0)
                break; /* abort outputting the error report */
        }
    }
}

int ossl_cmp_X509_STORE_add1_certs(X509_STORE *store, STACK_OF(X509) *certs,
    int only_self_signed)
{
    int i;

    if (store == NULL) {
        ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
        return 0;
    }
    if (certs == NULL)
        return 1;
    for (i = 0; i < sk_X509_num(certs); i++) {
        X509 *cert = sk_X509_value(certs, i);

        if (!only_self_signed || X509_self_signed(cert, 0) == 1)
            if (!X509_STORE_add_cert(store, cert)) /* ups cert ref counter */
                return 0;
    }
    return 1;
}

int ossl_cmp_sk_ASN1_UTF8STRING_push_str(STACK_OF(ASN1_UTF8STRING) *sk,
    const char *text, int len)
{
    ASN1_UTF8STRING *utf8string;

    if (!ossl_assert(sk != NULL && text != NULL))
        return 0;
    if ((utf8string = ASN1_UTF8STRING_new()) == NULL)
        return 0;
    if (!ASN1_STRING_set(utf8string, text, len))
        goto err;
    if (!sk_ASN1_UTF8STRING_push(sk, utf8string))
        goto err;
    return 1;

err:
    ASN1_UTF8STRING_free(utf8string);
    return 0;
}

int ossl_cmp_asn1_octet_string_set1(ASN1_OCTET_STRING **tgt,
    const ASN1_OCTET_STRING *src)
{
    ASN1_OCTET_STRING *new;

    if (tgt == NULL) {
        ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
        return 0;
    }
    if (*tgt == src) /* self-assignment */
        return 1;

    if (src != NULL) {
        if ((new = ASN1_OCTET_STRING_dup(src)) == NULL)
            return 0;
    } else {
        new = NULL;
    }

    ASN1_OCTET_STRING_free(*tgt);
    *tgt = new;
    return 1;
}

int ossl_cmp_asn1_octet_string_set1_bytes(ASN1_OCTET_STRING **tgt,
    const unsigned char *bytes, int len)
{
    ASN1_OCTET_STRING *new = NULL;

    if (tgt == NULL) {
        ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
        return 0;
    }
    if (bytes != NULL) {
        if ((new = ASN1_OCTET_STRING_new()) == NULL
            || !(ASN1_OCTET_STRING_set(new, bytes, len))) {
            ASN1_OCTET_STRING_free(new);
            return 0;
        }
    }

    ASN1_OCTET_STRING_free(*tgt);
    *tgt = new;
    return 1;
}

Coverage Report

Created: 2025-12-10 06:24

Line	Count	Source
1		/*
2		* Copyright 2007-2025 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
23		int OSSL_CMP_log_open(void) /* is designed to be idempotent */
24	0	{
25	0	#ifdef OPENSSL_NO_TRACE
26	0	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	0	}
39
40		void OSSL_CMP_log_close(void) /* is designed to be idempotent */
41	3	{
42	3	(void)OSSL_trace_set_channel(OSSL_TRACE_CATEGORY_CMP, NULL);
43	3	}
44
45		/* return >= 0 if level contains logging level, possibly preceded by "CMP " */
46	0	#define max_level_len 5 /* = max length of the below strings, e.g., "EMERG" */
47		static OSSL_CMP_severity parse_level(const char *level)
48	0	{
49	0	const char *end_level = strchr(level, ':');
50	0	int len;
51	0	char level_copy[max_level_len + 1];
52
53	0	if (end_level == NULL)
54	0	return -1;
55
56	0	if (HAS_PREFIX(level, OSSL_CMP_LOG_PREFIX))
57	0	level += strlen(OSSL_CMP_LOG_PREFIX);
58	0	len = (int)(end_level - level);
59	0	if (len > max_level_len)
60	0	return -1;
61	0	OPENSSL_strlcpy(level_copy, level, len + 1);
62	0	return strcmp(level_copy, "EMERG") == 0 ? OSSL_CMP_LOG_EMERG : strcmp(level_copy, "ALERT") == 0 ? OSSL_CMP_LOG_ALERT
63	0	: strcmp(level_copy, "CRIT") == 0 ? OSSL_CMP_LOG_CRIT
64	0	: strcmp(level_copy, "ERROR") == 0 ? OSSL_CMP_LOG_ERR
65	0	: strcmp(level_copy, "WARN") == 0 ? OSSL_CMP_LOG_WARNING
66	0	: strcmp(level_copy, "NOTE") == 0 ? OSSL_CMP_LOG_NOTICE
67	0	: strcmp(level_copy, "INFO") == 0 ? OSSL_CMP_LOG_INFO
68	0	: strcmp(level_copy, "DEBUG") == 0 ? OSSL_CMP_LOG_DEBUG
69	0	: -1;
70	0	}
71
72		const char ossl_cmp_log_parse_metadata(const char buf,
73		OSSL_CMP_severity *level,
74		char func, char file, int *line)
75	0	{
76	0	const char *p_func = buf;
77	0	const char *p_file = buf == NULL ? NULL : strchr(buf, ':');
78	0	const char *p_level = buf;
79	0	const char *msg = buf;
80
81	0	*level = -1;
82	0	*func = NULL;
83	0	*file = NULL;
84	0	*line = 0;
85
86	0	if (p_file != NULL) {
87	0	const char *p_line = strchr(++p_file, ':');
88
89	0	if ((*level = parse_level(buf)) < 0 && p_line != NULL) {
90		/* check if buf contains location info and logging level */
91	0	char p_level_tmp = (char )p_level;
92	0	const long line_number = strtol(++p_line, &p_level_tmp, 10);
93
94	0	p_level = p_level_tmp;
95	0	if (p_level > p_line && *(p_level++) == ':') {
96	0	if ((*level = parse_level(p_level)) >= 0) {
97	0	*func = OPENSSL_strndup(p_func, p_file - 1 - p_func);
98	0	*file = OPENSSL_strndup(p_file, p_line - 1 - p_file);
99		/* no real problem if OPENSSL_strndup() returns NULL */
100	0	*line = (int)line_number;
101	0	msg = strchr(p_level, ':');
102	0	if (msg != NULL && *++msg == ' ')
103	0	msg++;
104	0	}
105	0	}
106	0	}
107	0	}
108	0	return msg;
109	0	}
110
111	0	#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		*/
116		static const char improve_location_name(const char func, const char *fallback)
117	0	{
118	0	if (fallback == NULL)
119	0	return func == NULL ? UNKNOWN_FUNC : func;
120
121	0	return func == NULL \|\| *func == '\0' \|\| strcmp(func, UNKNOWN_FUNC) == 0
122	0	? fallback
123	0	: func;
124	0	}
125
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	0	{
129	0	const char *level_string = level == OSSL_CMP_LOG_EMERG ? "EMERG" : level == OSSL_CMP_LOG_ALERT ? "ALERT"
130	0	: level == OSSL_CMP_LOG_CRIT ? "CRIT"
131	0	: level == OSSL_CMP_LOG_ERR ? "error"
132	0	: level == OSSL_CMP_LOG_WARNING ? "warning"
133	0	: level == OSSL_CMP_LOG_NOTICE ? "NOTE"
134	0	: level == OSSL_CMP_LOG_INFO ? "info"
135	0	: level == OSSL_CMP_LOG_DEBUG ? "DEBUG"
136	0	: "(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	0	return BIO_printf(bio, OSSL_CMP_LOG_PREFIX "%s: %s\n",
145	0	level_string, msg)
146	0	>= 0;
147	0	}
148
149		#define ERR_PRINT_BUF_SIZE 4096
150		/* this is similar to ERR_print_errors_cb, but uses the CMP-specific cb type */
151		void OSSL_CMP_print_errors_cb(OSSL_CMP_log_cb_t log_fn)
152	0	{
153	0	unsigned long err;
154	0	char msg[ERR_PRINT_BUF_SIZE];
155	0	const char file = NULL, func = NULL, *data = NULL;
156	0	int line, flags;
157
158	0	while ((err = ERR_get_error_all(&file, &line, &func, &data, &flags)) != 0) {
159	0	const char *component = improve_location_name(func, ERR_lib_error_string(err));
160	0	unsigned long reason = ERR_GET_REASON(err);
161	0	const char *rs = NULL;
162	0	char rsbuf[256];
163
164	0	#ifndef OPENSSL_NO_ERR
165	0	if (ERR_SYSTEM_ERROR(err)) {
166	0	if (openssl_strerror_r(reason, rsbuf, sizeof(rsbuf)))
167	0	rs = rsbuf;
168	0	} else {
169	0	rs = ERR_reason_error_string(err);
170	0	}
171	0	#endif
172	0	if (rs == NULL) {
173	0	BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", reason);
174	0	rs = rsbuf;
175	0	}
176	0	if (data != NULL && (flags & ERR_TXT_STRING) != 0)
177	0	BIO_snprintf(msg, sizeof(msg), "%s:%s", rs, data);
178	0	else
179	0	BIO_snprintf(msg, sizeof(msg), "%s", rs);
180
181	0	if (log_fn == NULL) {
182	0	#ifndef OPENSSL_NO_STDIO
183	0	BIO *bio = BIO_new_fp(stderr, BIO_NOCLOSE);
184
185	0	if (bio != NULL) {
186	0	OSSL_CMP_print_to_bio(bio, component, file, line,
187	0	OSSL_CMP_LOG_ERR, msg);
188	0	BIO_free(bio);
189	0	}
190		#else
191		/* ERR_raise(..., CMP_R_NO_STDIO) would make no sense here */
192		#endif
193	0	} else {
194	0	if (log_fn(component, file, line, OSSL_CMP_LOG_ERR, msg) <= 0)
195	0	break; /* abort outputting the error report */
196	0	}
197	0	}
198	0	}
199
200		int ossl_cmp_X509_STORE_add1_certs(X509_STORE store, STACK_OF(X509) certs,
201		int only_self_signed)
202	0	{
203	0	int i;
204
205	0	if (store == NULL) {
206	0	ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
207	0	return 0;
208	0	}
209	0	if (certs == NULL)
210	0	return 1;
211	0	for (i = 0; i < sk_X509_num(certs); i++) {
212	0	X509 *cert = sk_X509_value(certs, i);
213
214	0	if (!only_self_signed \|\| X509_self_signed(cert, 0) == 1)
215	0	if (!X509_STORE_add_cert(store, cert)) /* ups cert ref counter */
216	0	return 0;
217	0	}
218	0	return 1;
219	0	}
220
221		int ossl_cmp_sk_ASN1_UTF8STRING_push_str(STACK_OF(ASN1_UTF8STRING) *sk,
222		const char *text, int len)
223	0	{
224	0	ASN1_UTF8STRING *utf8string;
225
226	0	if (!ossl_assert(sk != NULL && text != NULL))
227	0	return 0;
228	0	if ((utf8string = ASN1_UTF8STRING_new()) == NULL)
229	0	return 0;
230	0	if (!ASN1_STRING_set(utf8string, text, len))
231	0	goto err;
232	0	if (!sk_ASN1_UTF8STRING_push(sk, utf8string))
233	0	goto err;
234	0	return 1;
235
236	0	err:
237	0	ASN1_UTF8STRING_free(utf8string);
238	0	return 0;
239	0	}
240
241		int ossl_cmp_asn1_octet_string_set1(ASN1_OCTET_STRING **tgt,
242		const ASN1_OCTET_STRING *src)
243	0	{
244	0	ASN1_OCTET_STRING *new;
245
246	0	if (tgt == NULL) {
247	0	ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
248	0	return 0;
249	0	}
250	0	if (tgt == src) / self-assignment */
251	0	return 1;
252
253	0	if (src != NULL) {
254	0	if ((new = ASN1_OCTET_STRING_dup(src)) == NULL)
255	0	return 0;
256	0	} else {
257	0	new = NULL;
258	0	}
259
260	0	ASN1_OCTET_STRING_free(*tgt);
261	0	*tgt = new;
262	0	return 1;
263	0	}
264
265		int ossl_cmp_asn1_octet_string_set1_bytes(ASN1_OCTET_STRING **tgt,
266		const unsigned char *bytes, int len)
267	0	{
268	0	ASN1_OCTET_STRING *new = NULL;
269
270	0	if (tgt == NULL) {
271	0	ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
272	0	return 0;
273	0	}
274	0	if (bytes != NULL) {
275	0	if ((new = ASN1_OCTET_STRING_new()) == NULL
276	0	\|\| !(ASN1_OCTET_STRING_set(new, bytes, len))) {
277	0	ASN1_OCTET_STRING_free(new);
278	0	return 0;
279	0	}
280	0	}
281
282	0	ASN1_OCTET_STRING_free(*tgt);
283	0	*tgt = new;
284	0	return 1;
285	0	}