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 /*
  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 {
  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
  36 void 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" */
  43 static 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
  71 const char *ossl_cmp_log_parse_metadata(const char *buf,
  72                                         OSSL_CMP_severity *level,
  73                                         char **func, char **file, int *line)
  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
 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  */
 115 static const char *improve_location_name(const char *func, const char *fallback)
 116 {
 117     if (fallback == NULL)
 118         return func == NULL ? UNKNOWN_FUNC : func;
 119
 120     return func == NULL || *func == '\0' || strcmp(func, UNKNOWN_FUNC) == 0
 121         ? fallback : func;
 122 }
 123
 124 int OSSL_CMP_print_to_bio(BIO *bio, const char *component, const char *file,
 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 }
 145
 146 #define ERR_PRINT_BUF_SIZE 4096
 147 /* this is similar to ERR_print_errors_cb, but uses the CMP-specific cb type */
 148 void OSSL_CMP_print_errors_cb(OSSL_CMP_log_cb_t log_fn)
 149 {
 150     unsigned long err;
 151     char msg[ERR_PRINT_BUF_SIZE];
 152     const char *file = NULL, *func = NULL, *data = NULL;
 153     int line, flags;
 154
 155     while ((err = ERR_get_error_all(&file, &line, &func, &data, &flags)) != 0) {
 156         const char *component =
 157             improve_location_name(func, ERR_lib_error_string(err));
 158
 159         if (!(flags & ERR_TXT_STRING))
 160             data = NULL;
 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             }
 173 #else
 174             /* CMPerr(0, CMP_R_NO_STDIO) makes no sense during error printing */
 175 #endif
 176         } else {
 177             if (log_fn(component, file, line, OSSL_CMP_LOG_ERR, msg) <= 0)
 178                 break; /* abort outputting the error report */
 179         }
 180     }
 181 }
 182
 183 /*
 184  * functions manipulating lists of certificates etc.
 185  * these functions could be generally useful.
 186  */
 187
 188 int ossl_cmp_sk_X509_add1_cert(STACK_OF(X509) *sk, X509 *cert,
 189                                int no_dup, int prepend)
 190 {
 191     if (sk == NULL) {
 192         CMPerr(0, CMP_R_NULL_ARGUMENT);
 193         return 0;
 194     }
 195     if (no_dup) {
 196         /*
 197          * not using sk_X509_set_cmp_func() and sk_X509_find()
 198          * because this re-orders the certs on the stack
 199          */
 200         int i;
 201
 202         for (i = 0; i < sk_X509_num(sk); i++) {
 203             if (X509_cmp(sk_X509_value(sk, i), cert) == 0)
 204                 return 1;
 205         }
 206     }
 207     if (!X509_up_ref(cert))
 208         return 0;
 209     if (!sk_X509_insert(sk, cert, prepend ? 0 : -1)) {
 210         X509_free(cert);
 211         return 0;
 212     }
 213     return 1;
 214 }
 215
 216 int ossl_cmp_sk_X509_add1_certs(STACK_OF(X509) *sk, STACK_OF(X509) *certs,
 217                                 int no_self_issued, int no_dups, int prepend)
 218 /* compiler would allow 'const' for the list of certs, yet they are up-ref'ed */
 219 {
 220     int i;
 221
 222     if (sk == NULL) {
 223         CMPerr(0, CMP_R_NULL_ARGUMENT);
 224         return 0;
 225     }
 226     for (i = 0; i < sk_X509_num(certs); i++) { /* certs may be NULL */
 227         X509 *cert = sk_X509_value(certs, i);
 228
 229         if (!no_self_issued || X509_check_issued(cert, cert) != X509_V_OK) {
 230             if (!ossl_cmp_sk_X509_add1_cert(sk, cert, no_dups, prepend))
 231                 return 0;
 232         }
 233     }
 234     return 1;
 235 }
 236
 237 int ossl_cmp_X509_STORE_add1_certs(X509_STORE *store, STACK_OF(X509) *certs,
 238                                    int only_self_issued)
 239 {
 240     int i;
 241
 242     if (store == NULL) {
 243         CMPerr(0, CMP_R_NULL_ARGUMENT);
 244         return 0;
 245     }
 246     if (certs == NULL)
 247         return 1;
 248     for (i = 0; i < sk_X509_num(certs); i++) {
 249         X509 *cert = sk_X509_value(certs, i);
 250
 251         if (!only_self_issued || X509_check_issued(cert, cert) == X509_V_OK)
 252             if (!X509_STORE_add_cert(store, cert)) /* ups cert ref counter */
 253                 return 0;
 254     }
 255     return 1;
 256 }
 257
 258 /*-
 259  * Builds up the certificate chain of certs as high up as possible using
 260  * the given list of certs containing all possible intermediate certificates and
 261  * optionally the (possible) trust anchor(s). See also ssl_add_cert_chain().
 262  *
 263  * Intended use of this function is to find all the certificates above the trust
 264  * anchor needed to verify an EE's own certificate.  Those are supposed to be
 265  * included in the ExtraCerts field of every first sent message of a transaction
 266  * when MSG_SIG_ALG is utilized.
 267  *
 268  * NOTE: This allocates a stack and increments the reference count of each cert,
 269  * so when not needed any more the stack and all its elements should be freed.
 270  * NOTE: in case there is more than one possibility for the chain,
 271  * OpenSSL seems to take the first one, check X509_verify_cert() for details.
 272  *
 273  * returns a pointer to a stack of (up_ref'ed) X509 certificates containing:
 274  *      - the EE certificate given in the function arguments (cert)
 275  *      - all intermediate certificates up the chain toward the trust anchor
 276  *        whereas the (self-signed) trust anchor is not included
 277  * returns NULL on error
 278  */
 279 STACK_OF(X509) *ossl_cmp_build_cert_chain(STACK_OF(X509) *certs, X509 *cert)
 280 {
 281     STACK_OF(X509) *chain = NULL, *result = NULL;
 282     X509_STORE *store = X509_STORE_new();
 283     X509_STORE_CTX *csc = NULL;
 284
 285     if (certs == NULL || cert == NULL || store == NULL) {
 286         CMPerr(0, CMP_R_NULL_ARGUMENT);
 287         goto err;
 288     }
 289
 290     csc = X509_STORE_CTX_new();
 291     if (csc == NULL)
 292         goto err;
 293
 294     if (!ossl_cmp_X509_STORE_add1_certs(store, certs, 0)
 295             || !X509_STORE_CTX_init(csc, store, cert, NULL))
 296         goto err;
 297
 298     (void)ERR_set_mark();
 299     /*
 300      * ignore return value as it would fail without trust anchor given in store
 301      */
 302     (void)X509_verify_cert(csc);
 303
 304     /* don't leave any new errors in the queue */
 305     (void)ERR_pop_to_mark();
 306
 307     chain = X509_STORE_CTX_get0_chain(csc);
 308
 309     /* result list to store the up_ref'ed not self-issued certificates */
 310     if ((result = sk_X509_new_null()) == NULL)
 311         goto err;
 312     if (!ossl_cmp_sk_X509_add1_certs(result, chain, 1 /* no self-issued */,
 313                                      1 /* no duplicates */, 0)) {
 314         sk_X509_free(result);
 315         result = NULL;
 316     }
 317
 318  err:
 319     X509_STORE_free(store);
 320     X509_STORE_CTX_free(csc);
 321     return result;
 322 }
 323
 324 int ossl_cmp_sk_ASN1_UTF8STRING_push_str(STACK_OF(ASN1_UTF8STRING) *sk,
 325                                          const char *text)
 326 {
 327     ASN1_UTF8STRING *utf8string;
 328
 329     if (!ossl_assert(sk != NULL && text != NULL))
 330         return 0;
 331     if ((utf8string = ASN1_UTF8STRING_new()) == NULL)
 332         return 0;
 333     if (!ASN1_STRING_set(utf8string, text, -1))
 334         goto err;
 335     if (!sk_ASN1_UTF8STRING_push(sk, utf8string))
 336         goto err;
 337     return 1;
 338
 339  err:
 340     ASN1_UTF8STRING_free(utf8string);
 341     return 0;
 342 }
 343
 344 int ossl_cmp_asn1_octet_string_set1(ASN1_OCTET_STRING **tgt,
 345                                     const ASN1_OCTET_STRING *src)
 346 {
 347     ASN1_OCTET_STRING *new;
 348     if (tgt == NULL) {
 349         CMPerr(0, CMP_R_NULL_ARGUMENT);
 350         return 0;
 351     }
 352     if (*tgt == src) /* self-assignment */
 353         return 1;
 354
 355     if (src != NULL) {
 356         if ((new = ASN1_OCTET_STRING_dup(src)) == NULL)
 357             return 0;
 358     } else {
 359         new = NULL;
 360     }
 361
 362     ASN1_OCTET_STRING_free(*tgt);
 363     *tgt = new;
 364     return 1;
 365 }
 366
 367 int ossl_cmp_asn1_octet_string_set1_bytes(ASN1_OCTET_STRING **tgt,
 368                                           const unsigned char *bytes, int len)
 369 {
 370     ASN1_OCTET_STRING *new = NULL;
 371
 372     if (tgt == NULL) {
 373         CMPerr(0, CMP_R_NULL_ARGUMENT);
 374         return 0;
 375     }
 376     if (bytes != NULL) {
 377         if ((new = ASN1_OCTET_STRING_new()) == NULL
 378                 || !(ASN1_OCTET_STRING_set(new, bytes, len))) {
 379             ASN1_OCTET_STRING_free(new);
 380             return 0;
 381         }
 382     }
 383
 384     ASN1_OCTET_STRING_free(*tgt);
 385     *tgt = new;
 386     return 1;
 387 }