crypto/cmp/cmp_util.c

   1 /*
   2  * Copyright 2007-2020 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 DEFINE_STACK_OF(X509)
  20 DEFINE_STACK_OF(X509_OBJECT)
  21 DEFINE_STACK_OF(ASN1_UTF8STRING)
  22
  23 /*
  24  * use trace API for CMP-specific logging, prefixed by "CMP " and severity
  25  */
  26
  27 int 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
  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" */
  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 (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
  75 const char *ossl_cmp_log_parse_metadata(const char *buf,
  76                                         OSSL_CMP_severity *level,
  77                                         char **func, char **file, int *line)
  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
 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  */
 119 static const char *improve_location_name(const char *func, const char *fallback)
 120 {
 121     if (fallback == NULL)
 122         return func == NULL ? UNKNOWN_FUNC : func;
 123
 124     return func == NULL || *func == '\0' || strcmp(func, UNKNOWN_FUNC) == 0
 125         ? fallback : func;
 126 }
 127
 128 int OSSL_CMP_print_to_bio(BIO *bio, const char *component, const char *file,
 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 }
 149
 150 #define ERR_PRINT_BUF_SIZE 4096
 151 /* this is similar to ERR_print_errors_cb, but uses the CMP-specific cb type */
 152 void OSSL_CMP_print_errors_cb(OSSL_CMP_log_cb_t log_fn)
 153 {
 154     unsigned long err;
 155     char msg[ERR_PRINT_BUF_SIZE];
 156     const char *file = NULL, *func = NULL, *data = NULL;
 157     int line, flags;
 158
 159     while ((err = ERR_get_error_all(&file, &line, &func, &data, &flags)) != 0) {
 160         const char *component =
 161             improve_location_name(func, ERR_lib_error_string(err));
 162
 163         if (!(flags & ERR_TXT_STRING))
 164             data = NULL;
 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             }
 177 #else
 178             /* CMPerr(0, CMP_R_NO_STDIO) makes no sense during error printing */
 179 #endif
 180         } else {
 181             if (log_fn(component, file, line, OSSL_CMP_LOG_ERR, msg) <= 0)
 182                 break; /* abort outputting the error report */
 183         }
 184     }
 185 }
 186
 187 int ossl_cmp_X509_STORE_add1_certs(X509_STORE *store, STACK_OF(X509) *certs,
 188                                    int only_self_signed)
 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
 201         if (!only_self_signed || X509_self_signed(cert, 0) == 1)
 202             if (!X509_STORE_add_cert(store, cert)) /* ups cert ref counter */
 203                 return 0;
 204     }
 205     return 1;
 206 }
 207
 208 /*-
 209  * Builds a certificate chain starting from <cert>
 210  * using the optional list of intermediate CA certificates <certs>.
 211  * If <store> is NULL builds the chain as far down as possible, ignoring errors.
 212  * Else the chain must reach a trust anchor contained in <store>.
 213  *
 214  * Returns NULL on error, else a pointer to a stack of (up_ref'ed) certificates
 215  * starting with given EE certificate and followed by all available intermediate
 216  * certificates down towards any trust anchor but without including the latter.
 217  *
 218  * NOTE: If a non-NULL stack is returned the caller is responsible for freeing.
 219  * NOTE: In case there is more than one possibility for the chain,
 220  * OpenSSL seems to take the first one; check X509_verify_cert() for details.
 221  */
 222 /* TODO this should be of more general interest and thus be exported. */
 223 STACK_OF(X509)
 224     *ossl_cmp_build_cert_chain(OPENSSL_CTX *libctx, const char *propq,
 225                                X509_STORE *store,
 226                                STACK_OF(X509) *certs, X509 *cert)
 227 {
 228     STACK_OF(X509) *chain = NULL, *result = NULL;
 229     X509_STORE *ts = store == NULL ? X509_STORE_new() : store;
 230     X509_STORE_CTX *csc = NULL;
 231
 232     if (ts == NULL || cert == NULL) {
 233         CMPerr(0, CMP_R_NULL_ARGUMENT);
 234         goto err;
 235     }
 236
 237     if ((csc = X509_STORE_CTX_new_with_libctx(libctx, propq)) == NULL)
 238         goto err;
 239     if (store == NULL && certs != NULL
 240             && !ossl_cmp_X509_STORE_add1_certs(ts, certs, 0))
 241         goto err;
 242     if (!X509_STORE_CTX_init(csc, ts, cert,
 243                              store == NULL ? NULL : certs))
 244         goto err;
 245     /* disable any cert status/revocation checking etc. */
 246     X509_VERIFY_PARAM_clear_flags(X509_STORE_CTX_get0_param(csc),
 247                                   ~(X509_V_FLAG_USE_CHECK_TIME
 248                                     | X509_V_FLAG_NO_CHECK_TIME));
 249
 250     if (X509_verify_cert(csc) <= 0 && store != NULL)
 251         goto err;
 252     chain = X509_STORE_CTX_get0_chain(csc);
 253
 254     /* result list to store the up_ref'ed not self-signed certificates */
 255     if ((result = sk_X509_new_null()) == NULL)
 256         goto err;
 257     if (!X509_add_certs(result, chain,
 258                         X509_ADD_FLAG_UP_REF | X509_ADD_FLAG_NO_DUP
 259                         | X509_ADD_FLAG_NO_SS)) {
 260         sk_X509_free(result);
 261         result = NULL;
 262     }
 263
 264  err:
 265     if (store == NULL)
 266         X509_STORE_free(ts);
 267     X509_STORE_CTX_free(csc);
 268     return result;
 269 }
 270
 271 int ossl_cmp_sk_ASN1_UTF8STRING_push_str(STACK_OF(ASN1_UTF8STRING) *sk,
 272                                          const char *text)
 273 {
 274     ASN1_UTF8STRING *utf8string;
 275
 276     if (!ossl_assert(sk != NULL && text != NULL))
 277         return 0;
 278     if ((utf8string = ASN1_UTF8STRING_new()) == NULL)
 279         return 0;
 280     if (!ASN1_STRING_set(utf8string, text, -1))
 281         goto err;
 282     if (!sk_ASN1_UTF8STRING_push(sk, utf8string))
 283         goto err;
 284     return 1;
 285
 286  err:
 287     ASN1_UTF8STRING_free(utf8string);
 288     return 0;
 289 }
 290
 291 int ossl_cmp_asn1_octet_string_set1(ASN1_OCTET_STRING **tgt,
 292                                     const ASN1_OCTET_STRING *src)
 293 {
 294     ASN1_OCTET_STRING *new;
 295     if (tgt == NULL) {
 296         CMPerr(0, CMP_R_NULL_ARGUMENT);
 297         return 0;
 298     }
 299     if (*tgt == src) /* self-assignment */
 300         return 1;
 301
 302     if (src != NULL) {
 303         if ((new = ASN1_OCTET_STRING_dup(src)) == NULL)
 304             return 0;
 305     } else {
 306         new = NULL;
 307     }
 308
 309     ASN1_OCTET_STRING_free(*tgt);
 310     *tgt = new;
 311     return 1;
 312 }
 313
 314 int ossl_cmp_asn1_octet_string_set1_bytes(ASN1_OCTET_STRING **tgt,
 315                                           const unsigned char *bytes, int len)
 316 {
 317     ASN1_OCTET_STRING *new = NULL;
 318
 319     if (tgt == NULL) {
 320         CMPerr(0, CMP_R_NULL_ARGUMENT);
 321         return 0;
 322     }
 323     if (bytes != NULL) {
 324         if ((new = ASN1_OCTET_STRING_new()) == NULL
 325                 || !(ASN1_OCTET_STRING_set(new, bytes, len))) {
 326             ASN1_OCTET_STRING_free(new);
 327             return 0;
 328         }
 329     }
 330
 331     ASN1_OCTET_STRING_free(*tgt);
 332     *tgt = new;
 333     return 1;
 334 }