/src/FreeRDP/libfreerdp/crypto/x509_utils.c

Source
/**
 * FreeRDP: A Remote Desktop Protocol Implementation
 * Cryptographic Abstraction Layer
 *
 * Copyright 2011-2012 Marc-Andre Moreau <marcandre.moreau@gmail.com>
 * Copyright 2023 Armin Novak <anovak@thincast.com>
 * Copyright 2023 Thincast Technologies GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include <ctype.h>

#include <openssl/objects.h>
#include <openssl/x509v3.h>
#include <openssl/pem.h>
#include <openssl/rsa.h>
#include <openssl/err.h>

#include <freerdp/config.h>

#include <winpr/crt.h>
#include <winpr/string.h>
#include <winpr/assert.h>

#include <freerdp/log.h>

#include "x509_utils.h"

#define TAG FREERDP_TAG("crypto")

BYTE* x509_utils_get_hash(const X509* xcert, const char* hash, size_t* length)
{
  UINT32 fp_len = EVP_MAX_MD_SIZE;
  BYTE* fp = nullptr;
  const EVP_MD* md = EVP_get_digestbyname(hash);
  if (!md)
  {
    WLog_ERR(TAG, "System does not support %s hash!", hash);
    return nullptr;
  }
  if (!xcert || !length)
  {
    WLog_ERR(TAG, "Invalid arguments: xcert=%p, length=%p",
             WINPR_CXX_COMPAT_CAST(const void*, xcert),
             WINPR_CXX_COMPAT_CAST(const void*, length));
    return nullptr;
  }

  fp = calloc(fp_len + 1, sizeof(BYTE));
  if (!fp)
  {
    WLog_ERR(TAG, "could not allocate %" PRIu32 " bytes", fp_len);
    return nullptr;
  }

  if (X509_digest(xcert, md, fp, &fp_len) != 1)
  {
    free(fp);
    WLog_ERR(TAG, "certificate does not have a %s hash!", hash);
    return nullptr;
  }

  *length = fp_len;
  return fp;
}

WINPR_ATTR_NODISCARD
static char* crypto_print_name(const X509_NAME* name)
{
  char* buffer = nullptr;
  BIO* outBIO = BIO_new(BIO_s_mem());
  if (!outBIO)
    return nullptr;

  if (X509_NAME_print_ex(outBIO, name, 0, XN_FLAG_ONELINE) > 0)
    buffer = x509_utils_bio_read(outBIO, nullptr);

  BIO_free_all(outBIO);
  return buffer;
}

char* x509_utils_get_subject(const X509* xcert)
{
  char* subject = nullptr;
  if (!xcert)
  {
    WLog_ERR(TAG, "Invalid certificate nullptr");
    return nullptr;
  }
  subject = crypto_print_name(X509_get_subject_name(xcert));
  if (!subject)
    WLog_WARN(TAG, "certificate does not have a subject!");
  return subject;
}

/* GENERAL_NAME type labels */

static const char* general_name_type_labels[] = { "OTHERNAME", "EMAIL    ", "DNS      ",
                                                "X400     ", "DIRNAME  ", "EDIPARTY ",
                                                "URI      ", "IPADD    ", "RID      " };

WINPR_ATTR_NODISCARD
static const char* general_name_type_label(int general_name_type)
{
  if ((0 <= general_name_type) &&
      ((size_t)general_name_type < ARRAYSIZE(general_name_type_labels)))
  {
    return general_name_type_labels[general_name_type];
  }
  else
  {
    static char buffer[80] = WINPR_C_ARRAY_INIT;
    (void)snprintf(buffer, sizeof(buffer), "Unknown general name type (%d)", general_name_type);
    return buffer;
  }
}

/*

map_subject_alt_name(x509,  general_name_type, mapper, data)

Call the function mapper with subjectAltNames found in the x509
certificate and data.  if generate_name_type is GEN_ALL,  the the
mapper is called for all the names,  else it's called only for names
of the given type.


We implement two extractors:

 -  a string extractor that can be used to get the subjectAltNames of
    the following types: GEN_URI,  GEN_DNS,  GEN_EMAIL

 - a ASN1_OBJECT filter/extractor that can be used to get the
   subjectAltNames of OTHERNAME type.

   Note: usually, it's a string, but some type of otherNames can be
   associated with different classes of objects. eg. a KPN may be a
   sequence of realm and principal name, instead of a single string
   object.

Not implemented yet: extractors for the types: GEN_X400, GEN_DIRNAME,
GEN_EDIPARTY, GEN_RID, GEN_IPADD (the later can contain nul-bytes).


mapper(name, data, index, count)

The mapper is passed:
 - the GENERAL_NAME selected,
 - the data,
 - the index of the general name in the subjectAltNames,
 - the total number of names in the subjectAltNames.

The last parameter let's the mapper allocate arrays to collect objects.
Note: if names are filtered,  not all the indices from 0 to count-1 are
passed to mapper,  only the indices selected.

When the mapper returns 0, map_subject_alt_name stops the iteration immediately.

*/

#define GEN_ALL (-1)

typedef int (*general_name_mapper_pr)(const X509* x509, GENERAL_NAME* name, void* data, int index,
                                      int count);

static void map_subject_alt_name(const X509* x509, int general_name_type,
                                 general_name_mapper_pr mapper, void* data)
{
  STACK_OF(GENERAL_NAME)* gens = X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr);

  if (!gens)
    return;

  const int num = sk_GENERAL_NAME_num(gens);

  for (int i = 0; (i < num); i++)
  {
    GENERAL_NAME* name = sk_GENERAL_NAME_value(gens, i);

    if (name)
    {
      if ((general_name_type == GEN_ALL) || (general_name_type == name->type))
      {
        if (!mapper(x509, name, data, i, num))
        {
          break;
        }
      }
    }
  }

  sk_GENERAL_NAME_pop_free(gens, GENERAL_NAME_free);
}

/*
extract_string  --  string extractor

- the strings array is allocated lazily, when we first have to store a
  string.

- allocated contains the size of the strings array, or -1 if
  allocation failed.

- count contains the actual count of strings in the strings array.

- maximum limits the number of strings we can store in the strings
  array: beyond, the extractor returns 0 to short-cut the search.

extract_string stores in the string list OPENSSL strings,
that must be freed with OPENSSL_free.

*/

typedef struct string_list
{
  char** strings;
  size_t* lengths;
  size_t allocated;
  size_t count;
  size_t maximum;
} string_list;

static string_list string_list_initialize(void)
{
  const string_list empty = {
    .strings = nullptr, .lengths = nullptr, .allocated = 0, .count = 0, .maximum = INT_MAX
  };
  return empty;
}

static BOOL string_list_allocate(string_list* list, size_t allocate_count)
{
  WINPR_ASSERT(list);
  if (!list->strings && (list->allocated == 0) && (allocate_count > 0))
  {
    list->strings = (char**)calloc(allocate_count, sizeof(char*));
    list->lengths = calloc(allocate_count, sizeof(size_t));
    list->count = 0;
    if (!list->strings || !list->lengths)
    {
      free((void*)list->strings);
      free(list->lengths);
      list->strings = nullptr;
      list->lengths = nullptr;
      return FALSE;
    }
    list->allocated = allocate_count;
  }
  return TRUE;
}

static void string_list_free(string_list* list)
{
  /* Note: we don't free the contents of the strings array: this */
  /* is handled by the caller,  either by returning this */
  /* content,  or freeing it itself. */
  free((void*)list->strings);
  free(list->lengths);
}

WINPR_ATTR_NODISCARD
static BOOL check_string_is_email(WINPR_ATTR_UNUSED const X509* x509, const unsigned char* ustr,
                                  size_t length)
{
  const size_t MAX_EMAIL_LENGTH = 256;
  const size_t MIN_EMAIL_LENGTH = 5;

  if (ustr == nullptr)
    return FALSE;

  const char* email = (const char*)ustr;
  const size_t len = strnlen(email, length);
  if ((len < MIN_EMAIL_LENGTH) || (len > MAX_EMAIL_LENGTH))
    return FALSE;

  size_t at_pos = 0;
  size_t at_count = 0;

  for (size_t i = 0; i < len; i++)
  {
    char cur = email[i];
    if (cur == '@')
    {
      /* @ must not be first or last */
      if (i == 0)
        return FALSE;
      if (i == len - 1)
        return FALSE;
      at_pos = i;
      at_count++;
    }
    if (isspace(cur))
      return FALSE;
  }

  /* only one @ allowed */
  if (at_count != 1)
  {
    return FALSE;
  }

  /* local part */
  if ((email[0] == '.') || (email[at_pos - 1] == '.'))
    return FALSE;

  /* .. forbidden */
  for (size_t i = 0; i < at_pos - 1; i++)
  {
    if ((email[i] == '.') && (email[i + 1] == '.'))
      return FALSE;
  }

  // Validate the domain part (after '@')
  const char* domain = &email[at_pos + 1];
  size_t domain_len = strnlen(domain, len);

  if (!winpr_str_is_valid_hostnameN(domain, domain_len))
    return FALSE;

  /* local part */
  for (size_t i = 0; i < at_pos; i++)
  {
    if (!isalnum(email[i]) && email[i] != '.' && email[i] != '-' && email[i] != '_' &&
        email[i] != '+')
    {
      return FALSE;
    }
  }

  return TRUE;
}

WINPR_ATTR_NODISCARD
static BOOL check_string_is_host_or_ip(WINPR_ATTR_UNUSED const X509* x509,
                                       const unsigned char* ustr, size_t length)
{
  const char* str = (const char*)ustr;
  if (strnlen(str, length) != length)
    return FALSE;
  return winpr_str_is_valid_hostnameN(str, length);
}

WINPR_ATTR_NODISCARD
static BOOL check_string_is_dns_name(const X509* x509, const unsigned char* ustr, size_t length)
{
  /* RFC 6125 wildcard DNS names (e.g. *.example.com): validate the part after
   * the leading label; tls_match_hostname applies the single-label rule.
   * Like OpenSSL, require at least two non-empty labels after the wildcard,
   * so *.com, *..com and *.com. are rejected. */
  if ((length > 2) && (ustr[0] == '*') && (ustr[1] == '.'))
  {
    const unsigned char* suffix = &ustr[2];
    const size_t suffixLength = length - 2;
    size_t dots = 0;

    if ((suffix[0] == '.') || (suffix[suffixLength - 1] == '.'))
      return FALSE;

    for (size_t x = 1; x < suffixLength; x++)
    {
      if (suffix[x] == '.')
      {
        if (suffix[x - 1] == '.')
          return FALSE;
        dots++;
      }
    }

    if (dots == 0)
      return FALSE;
    return check_string_is_host_or_ip(x509, suffix, suffixLength);
  }
  return check_string_is_host_or_ip(x509, ustr, length);
}

WINPR_ATTR_NODISCARD
static BOOL check_string_is_host_or_ip_or_email(WINPR_ATTR_UNUSED const X509* x509,
                                                const unsigned char* ustr, size_t length)
{
  if (check_string_is_host_or_ip(x509, ustr, length))
    return TRUE;
  return check_string_is_email(x509, ustr, length);
}

WINPR_ATTR_NODISCARD
static int
extract_string_generic(const X509* x509, GENERAL_NAME* name, void* data, int index, int count,
                       BOOL (*fkt)(const X509* x509, const unsigned char* str, size_t length))
{
  string_list* list = data;
  WINPR_ASSERT(list);
  WINPR_ASSERT(fkt);

  WINPR_ASSERT(name);
  WINPR_UNUSED(index);

  const ASN1_STRING* str = nullptr;
  switch (name->type)
  {
    case GEN_URI:
      str = name->d.uniformResourceIdentifier;
      break;

    case GEN_DNS:
      str = name->d.dNSName;
      break;

    case GEN_EMAIL:
      str = name->d.rfc822Name;
      break;

    default:
      return 1;
  }

  unsigned char* cstring = nullptr;
  const int rc = ASN1_STRING_to_UTF8(&cstring, str);
  if (rc < 0)
  {
    WLog_ERR(TAG, "ASN1_STRING_to_UTF8() failed for %s: %s",
             general_name_type_label(name->type), ERR_error_string(ERR_get_error(), nullptr));
    return 1;
  }

  if (!fkt(x509, cstring, WINPR_ASSERTING_INT_CAST(size_t, rc)))
  {
    WLog_ERR(TAG, "ASN1_STRING_to_UTF8() does not conform to expected format %s: %s",
             general_name_type_label(name->type), (const char*)str);
    OPENSSL_free(cstring);
    return -1;
  }

  if (!string_list_allocate(list, WINPR_ASSERTING_INT_CAST(WINPR_CIPHER_TYPE, count)) ||
      (list->allocated <= 0))
  {
    WLog_ERR(TAG, "ASN1_STRING_to_UTF8() allocation failed: %s",
             general_name_type_label(name->type));
    OPENSSL_free(cstring);
    return 0;
  }

  list->strings[list->count] = (char*)cstring;
  list->lengths[list->count] = WINPR_ASSERTING_INT_CAST(size_t, rc);
  list->count++;

  if (list->count >= list->maximum)
  {
    WLog_ERR(TAG, "ASN1_STRING_to_UTF8() limit exceeded: %s",
             general_name_type_label(name->type));
    return 0;
  }

  return 1;
}

WINPR_ATTR_NODISCARD
static int extract_string(const X509* x509, GENERAL_NAME* name, void* data, int index, int count)
{
  return extract_string_generic(x509, name, data, index, count, check_string_is_dns_name);
}

static int extract_email(const X509* x509, GENERAL_NAME* name, void* data, int index, int count)
{
  return extract_string_generic(x509, name, data, index, count, check_string_is_email);
}

/*
extract_othername_object --  object extractor.

- the objects array is allocated lazily, when we first have to store a
  string.

- allocated contains the size of the objects array, or -1 if
  allocation failed.

- count contains the actual count of objects in the objects array.

- maximum limits the number of objects we can store in the objects
  array: beyond, the extractor returns 0 to short-cut the search.

extract_othername_objects stores in the objects array ASN1_TYPE *
pointers directly obtained from the GENERAL_NAME.
*/

typedef struct object_list
{
  ASN1_OBJECT* type_id;
  char** strings;
  size_t* lengths;

  size_t allocated;
  size_t count;
  size_t maximum;
} object_list;

static object_list object_list_initialize(void)
{
  const object_list empty = { .type_id = nullptr,
                            .strings = nullptr,
                            .lengths = nullptr,
                            .allocated = 0,
                            .count = 0,
                            .maximum = INT_MAX };
  return empty;
}

WINPR_ATTR_NODISCARD
static BOOL object_list_allocate(object_list* list, size_t allocate_count)
{
  if (!list->strings && (list->allocated == 0) && (allocate_count > 0))
  {
    list->strings = (char**)calloc(allocate_count, sizeof(list->strings[0]));
    list->lengths = calloc(allocate_count, sizeof(size_t));
    list->count = 0;
    if (!list->strings || !list->lengths)
    {
      free((void*)list->strings);
      free(list->lengths);
      list->strings = nullptr;
      list->lengths = nullptr;
      return FALSE;
    }
    list->allocated = allocate_count;
  }
  return TRUE;
}

WINPR_ATTR_MALLOC(free, 1)
static char* object_string(const X509* x509, ASN1_TYPE* object, size_t* pLength)
{
  unsigned char* utf8String = nullptr;

  WINPR_ASSERT(object);
  WINPR_ASSERT(pLength);

  *pLength = 0;

  /* TODO: check that object.type is a string type. */
  const int length = ASN1_STRING_to_UTF8(&utf8String, object->value.asn1_string);

  if (length < 0)
    return nullptr;

  char* result = nullptr;
  if (check_string_is_host_or_ip_or_email(x509, utf8String,
                                          WINPR_ASSERTING_INT_CAST(size_t, length)))
  {
    result = strndup((char*)utf8String, WINPR_ASSERTING_INT_CAST(size_t, length));
    if (result)
      *pLength = WINPR_ASSERTING_INT_CAST(size_t, length);
  }
  else
    WLog_ERR(TAG, "Found invalid object_string entry in certificate: '%s'", utf8String);
  OPENSSL_free(utf8String);
  return result;
}

static void object_list_free(object_list* list)
{
  WINPR_ASSERT(list);
  free((void*)list->strings);
  free(list->lengths);
}

WINPR_ATTR_NODISCARD
static int extract_othername_object_as_string(const X509* x509, GENERAL_NAME* name, void* data,
                                              int index, int count)
{
  object_list* list = data;
  WINPR_UNUSED(index);
  WINPR_ASSERT(x509);

  if (count < 0)
    return -1;

  if (name->type != GEN_OTHERNAME)
  {
    return 1;
  }

  if (0 != OBJ_cmp(name->d.otherName->type_id, list->type_id))
  {
    return 1;
  }

  if (!object_list_allocate(list, WINPR_ASSERTING_INT_CAST(size_t, count)) ||
      (list->allocated <= 0))
  {
    return 0;
  }

  list->strings[list->count] =
      object_string(x509, name->d.otherName->value, &list->lengths[list->count]);
  if (list->strings[list->count])
  {
    list->count++;
  }

  if (list->count >= list->maximum)
  {
    return 0;
  }

  return 1;
}

char* x509_utils_get_email(const X509* x509)
{
  string_list list = string_list_initialize();
  list.maximum = 1;
  map_subject_alt_name(x509, GEN_EMAIL, extract_email, &list);

  if (list.count == 0)
  {
    string_list_free(&list);
    return nullptr;
  }

  char* result = strndup(list.strings[0], list.lengths[0]);
  OPENSSL_free(list.strings[0]);
  string_list_free(&list);
  return result;
}

char* x509_utils_get_upn(const X509* x509)
{
  object_list list = object_list_initialize();

  list.type_id = OBJ_nid2obj(NID_ms_upn);
  list.maximum = 1;
  map_subject_alt_name(x509, GEN_OTHERNAME, extract_othername_object_as_string, &list);

  if (list.count == 0)
  {
    object_list_free(&list);
    return nullptr;
  }

  char* result = list.strings[0];
  object_list_free(&list);
  return result;
}

char* x509_utils_get_date(const X509* x509, BOOL startDate)
{
  WINPR_ASSERT(x509);

  const ASN1_TIME* date = startDate ? X509_get0_notBefore(x509) : X509_get0_notAfter(x509);
  if (!date)
    return nullptr;

  BIO* bmem = BIO_new(BIO_s_mem());
  if (!bmem)
    return nullptr;

  char* str = nullptr;
  if (ASN1_TIME_print(bmem, date))
  {
    BUF_MEM* bptr = nullptr;

    BIO_get_mem_ptr(bmem, &bptr);
    str = strndup(bptr->data, bptr->length);
  }
  else
  { // Log error
  }
  BIO_free_all(bmem);
  return str;
}

void x509_utils_dns_names_free(size_t count, size_t* lengths, char** dns_names)
{
  free(lengths);

  if (dns_names)
  {
    for (size_t i = 0; i < count; i++)
    {
      if (dns_names[i])
      {
        OPENSSL_free(dns_names[i]);
      }
    }

    free((void*)dns_names);
  }
}

WINPR_ATTR_NODISCARD
static char** x509_utils_get_names(const X509* xcert, int general_name_type, size_t* count,
                                   size_t** lengths)
{
  string_list list = string_list_initialize();
  map_subject_alt_name(xcert, general_name_type, extract_string, &list);
  (*count) = list.count;

  if (list.count <= 0)
  {
    string_list_free(&list);
    return nullptr;
  }

  /* lengths are not useful,  since we converted the
     strings to utf-8,  there cannot be nul-bytes in them. */
  char** result = (char**)calloc(list.count, sizeof(*result));
  (*lengths) = calloc(list.count, sizeof(**lengths));

  if (!result || !(*lengths))
  {
    string_list_free(&list);
    free((void*)result);
    free(*lengths);
    (*lengths) = nullptr;
    (*count) = 0;
    return nullptr;
  }

  for (size_t i = 0; i < list.count; i++)
  {
    result[i] = list.strings[i];
    (*lengths)[i] = list.lengths[i];
  }

  string_list_free(&list);
  return result;
}

char** x509_utils_get_dns_names(const X509* xcert, size_t* count, size_t** pplengths)
{
  return x509_utils_get_names(xcert, GEN_DNS, count, pplengths);
}

char** x509_utils_get_ip_names(const X509* xcert, size_t* count, size_t** pplengths)
{
  return x509_utils_get_names(xcert, GEN_IPADD, count, pplengths);
}

char* x509_utils_get_issuer(const X509* xcert)
{
  char* issuer = nullptr;
  if (!xcert)
  {
    WLog_ERR(TAG, "Invalid certificate nullptr");
    return nullptr;
  }
  issuer = crypto_print_name(X509_get_issuer_name(xcert));
  if (!issuer)
    WLog_WARN(TAG, "certificate does not have an issuer!");
  return issuer;
}

WINPR_ATTR_NODISCARD
static int asn1_object_cmp(const ASN1_OBJECT* const* a, const ASN1_OBJECT* const* b)
{
  if (!a || !b)
    return (a == b) ? 0 : (a ? 1 : -1);

  if (!*a || !*b)
    return (*a == *b) ? 0 : (*a ? 1 : -1);

  return OBJ_cmp(*a, *b);
}

BOOL x509_utils_check_eku(const X509* xcert, int nid)
{
  BOOL ret = FALSE;
  STACK_OF(ASN1_OBJECT)* oid_stack = nullptr;
  ASN1_OBJECT* oid = nullptr;

  if (!xcert)
    return FALSE;

  oid = OBJ_nid2obj(nid);
  if (!oid)
    return FALSE;

  oid_stack = X509_get_ext_d2i(xcert, NID_ext_key_usage, nullptr, nullptr);
  if (!oid_stack)
    return FALSE;

  /* sk_ASN1_OBJECT_set_cmp_func does some function pointer casting that produces a warning. We
   * can not fix upstream, so silence it here. */
  WINPR_PRAGMA_DIAG_PUSH
  WINPR_PRAGMA_DIAG_IGNORED_CAST_FUNCTION_TYPE
  sk_ASN1_OBJECT_set_cmp_func(oid_stack, asn1_object_cmp);
  WINPR_PRAGMA_DIAG_POP
  if (sk_ASN1_OBJECT_find(oid_stack, oid) >= 0)
    ret = TRUE;

  sk_ASN1_OBJECT_pop_free(oid_stack, ASN1_OBJECT_free);
  return ret;
}

void x509_utils_print_info(const X509* xcert)
{
  char* subject = x509_utils_get_subject(xcert);
  char* issuer = x509_utils_get_issuer(xcert);
  char* fp = (char*)x509_utils_get_hash(xcert, "sha256", nullptr);

  if (!fp)
  {
    WLog_ERR(TAG, "error computing fingerprint");
    goto out_free_issuer;
  }

  WLog_INFO(TAG, "Certificate details:");
  WLog_INFO(TAG, "\tSubject: %s", subject);
  WLog_INFO(TAG, "\tIssuer: %s", issuer);
  WLog_INFO(TAG, "\tThumbprint: %s", fp);
  WLog_INFO(TAG,
            "The above X.509 certificate could not be verified, possibly because you do not have "
            "the CA certificate in your certificate store, or the certificate has expired. "
            "Please look at the OpenSSL documentation on how to add a private CA to the store.");
  free(fp);
out_free_issuer:
  free(issuer);
  free(subject);
}

X509* x509_utils_from_pem(const char* data, size_t len, BOOL fromFile)
{
  BIO* bio = nullptr;
  if (fromFile)
    bio = BIO_new_file(data, "rb");
  else
  {
    if (len > INT_MAX)
      return nullptr;

    bio = BIO_new_mem_buf(data, (int)len);
  }

  if (!bio)
  {
    WLog_ERR(TAG, "BIO_new failed for certificate");
    return nullptr;
  }

  X509* x509 = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr);
  BIO_free_all(bio);
  if (!x509)
    WLog_ERR(TAG, "PEM_read_bio_X509 returned nullptr [input length %" PRIuz "]", len);

  return x509;
}

WINPR_ATTR_NODISCARD
static WINPR_MD_TYPE hash_nid_to_winpr(int hash_nid)
{
  switch (hash_nid)
  {
    case NID_md2:
      return WINPR_MD_MD2;
    case NID_md4:
      return WINPR_MD_MD4;
    case NID_md5:
      return WINPR_MD_MD5;
    case NID_sha1:
      return WINPR_MD_SHA1;
    case NID_sha224:
      return WINPR_MD_SHA224;
    case NID_sha256:
      return WINPR_MD_SHA256;
    case NID_sha384:
      return WINPR_MD_SHA384;
    case NID_sha512:
      return WINPR_MD_SHA512;
    case NID_ripemd160:
      return WINPR_MD_RIPEMD160;
#if (OPENSSL_VERSION_NUMBER >= 0x1010101fL) && !defined(LIBRESSL_VERSION_NUMBER)
    case NID_sha3_224:
      return WINPR_MD_SHA3_224;
    case NID_sha3_256:
      return WINPR_MD_SHA3_256;
    case NID_sha3_384:
      return WINPR_MD_SHA3_384;
    case NID_sha3_512:
      return WINPR_MD_SHA3_512;
    case NID_shake128:
      return WINPR_MD_SHAKE128;
    case NID_shake256:
      return WINPR_MD_SHAKE256;
#endif
    case NID_undef:
    default:
      return WINPR_MD_NONE;
  }
}

WINPR_ATTR_NODISCARD
static WINPR_MD_TYPE get_rsa_pss_digest(const X509_ALGOR* alg)
{
  WINPR_MD_TYPE ret = WINPR_MD_NONE;
  WINPR_MD_TYPE message_digest = WINPR_MD_NONE;
  WINPR_MD_TYPE mgf1_digest = WINPR_MD_NONE;
  int param_type = 0;
  const void* param_value = nullptr;
  const ASN1_STRING* sequence = nullptr;
  const unsigned char* inp = nullptr;
  RSA_PSS_PARAMS* params = nullptr;
  X509_ALGOR* mgf1_digest_alg = nullptr;

  /* The RSA-PSS digest is encoded in a complex structure, defined in
  https://www.rfc-editor.org/rfc/rfc4055.html. */
  X509_ALGOR_get0(nullptr, &param_type, &param_value, alg);

  /* param_type and param_value the parameter in ASN1_TYPE form, but split into two parameters. A
  SEQUENCE is has type V_ASN1_SEQUENCE, and the value is an ASN1_STRING with the encoded
  structure. */
  if (param_type != V_ASN1_SEQUENCE)
    goto end;
  sequence = param_value;

  /* Decode the structure. */
  inp = ASN1_STRING_get0_data(sequence);
  params = d2i_RSA_PSS_PARAMS(nullptr, &inp, ASN1_STRING_length(sequence));
  if (params == nullptr)
    goto end;

  /* RSA-PSS uses two hash algorithms, a message digest and also an MGF function which is, itself,
  parameterized by a hash function. Both fields default to SHA-1, so we must also check for the
  value being nullptr. */
  message_digest = WINPR_MD_SHA1;
  if (params->hashAlgorithm != nullptr)
  {
    const ASN1_OBJECT* obj = nullptr;
    X509_ALGOR_get0(&obj, nullptr, nullptr, params->hashAlgorithm);
    message_digest = hash_nid_to_winpr(OBJ_obj2nid(obj));
    if (message_digest == WINPR_MD_NONE)
      goto end;
  }

  mgf1_digest = WINPR_MD_SHA1;
  if (params->maskGenAlgorithm != nullptr)
  {
    const ASN1_OBJECT* obj = nullptr;
    int mgf_param_type = 0;
    const void* mgf_param_value = nullptr;
    const ASN1_STRING* mgf_param_sequence = nullptr;
    /* First, check this is MGF-1, the only one ever defined. */
    X509_ALGOR_get0(&obj, &mgf_param_type, &mgf_param_value, params->maskGenAlgorithm);
    if (OBJ_obj2nid(obj) != NID_mgf1)
      goto end;

    /* MGF-1 is, itself, parameterized by a hash function, encoded as an AlgorithmIdentifier. */
    if (mgf_param_type != V_ASN1_SEQUENCE)
      goto end;
    mgf_param_sequence = mgf_param_value;
    inp = ASN1_STRING_get0_data(mgf_param_sequence);
    mgf1_digest_alg = d2i_X509_ALGOR(nullptr, &inp, ASN1_STRING_length(mgf_param_sequence));
    if (mgf1_digest_alg == nullptr)
      goto end;

    /* Finally, extract the digest. */
    X509_ALGOR_get0(&obj, nullptr, nullptr, mgf1_digest_alg);
    mgf1_digest = hash_nid_to_winpr(OBJ_obj2nid(obj));
    if (mgf1_digest == WINPR_MD_NONE)
      goto end;
  }

  /* If the two digests do not match, it is ambiguous which to return. tls-server-end-point leaves
  it undefined, so return none.
  https://www.rfc-editor.org/rfc/rfc5929.html#section-4.1 */
  if (message_digest != mgf1_digest)
    goto end;
  ret = message_digest;

end:
  RSA_PSS_PARAMS_free(params);
  X509_ALGOR_free(mgf1_digest_alg);
  return ret;
}

WINPR_MD_TYPE x509_utils_get_signature_alg(const X509* xcert)
{
  WINPR_ASSERT(xcert);

  const int nid = X509_get_signature_nid(xcert);

  if (nid == NID_rsassaPss)
  {
    const X509_ALGOR* alg = nullptr;
    X509_get0_signature(nullptr, &alg, xcert);
    return get_rsa_pss_digest(alg);
  }

  int hash_nid = 0;
  if (OBJ_find_sigid_algs(nid, &hash_nid, nullptr) != 1)
    return WINPR_MD_NONE;

  return hash_nid_to_winpr(hash_nid);
}

char* x509_utils_get_common_name(const X509* xcert, size_t* plength)
{
  const X509_NAME* subject_name = X509_get_subject_name(xcert);
  if (subject_name == nullptr)
    return nullptr;

  const int index = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  if (index < 0)
    return nullptr;

  const X509_NAME_ENTRY* entry = X509_NAME_get_entry(subject_name, index);
  if (entry == nullptr)
    return nullptr;

  const ASN1_STRING* entry_data = X509_NAME_ENTRY_get_data(entry);
  if (entry_data == nullptr)
    return nullptr;

  BYTE* common_name_raw = nullptr;
  const int length = ASN1_STRING_to_UTF8(&common_name_raw, entry_data);
  if (length < 0)
    return nullptr;

  char* common_name = nullptr;
  if (check_string_is_dns_name(xcert, common_name_raw, WINPR_ASSERTING_INT_CAST(size_t, length)))
  {
    if (plength)
      *plength = (size_t)length;

    common_name = strndup((char*)common_name_raw, (size_t)length);
  }
  OPENSSL_free(common_name_raw);
  return common_name;
}

WINPR_ATTR_NODISCARD
static int verify_cb(int ok, X509_STORE_CTX* csc)
{
  if (ok != 1)
  {
    WINPR_ASSERT(csc);
    int err = X509_STORE_CTX_get_error(csc);
    int derr = X509_STORE_CTX_get_error_depth(csc);
    X509* where = X509_STORE_CTX_get_current_cert(csc);
    const char* what = X509_verify_cert_error_string(err);
    char* name = x509_utils_get_subject(where);

    WLog_WARN(TAG, "Certificate verification failure '%s (%d)' at stack position %d", what, err,
              derr);
    WLog_WARN(TAG, "%s", name);

    free(name);
  }
  return ok;
}

BOOL x509_utils_verify(X509* xcert, STACK_OF(X509) * chain, const char* certificate_store_path)
{
  const int purposes[] = { X509_PURPOSE_SSL_SERVER };
  BOOL status = FALSE;

  if (!xcert)
    return FALSE;

  X509_STORE* cert_ctx = X509_STORE_new();

  if (cert_ctx == nullptr)
    goto end;

#if OPENSSL_VERSION_NUMBER < 0x10100000L || defined(LIBRESSL_VERSION_NUMBER)
  OpenSSL_add_all_algorithms();
#else
  OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS | OPENSSL_INIT_ADD_ALL_DIGESTS |
                          OPENSSL_INIT_LOAD_CONFIG,
                      nullptr);
#endif

  if (X509_STORE_set_default_paths(cert_ctx) != 1)
    goto end;

  X509_LOOKUP* lookup = X509_STORE_add_lookup(cert_ctx, X509_LOOKUP_hash_dir());

  if (lookup == nullptr)
    goto end;

  X509_LOOKUP_add_dir(lookup, nullptr, X509_FILETYPE_DEFAULT);

  if (certificate_store_path != nullptr)
  {
    X509_LOOKUP_add_dir(lookup, certificate_store_path, X509_FILETYPE_PEM);
  }

  X509_STORE_set_flags(cert_ctx, 0);

  for (size_t i = 0; i < ARRAYSIZE(purposes); i++)
  {
    int err = -1;
    int rc = -1;
    int purpose = purposes[i];
    X509_STORE_CTX* csc = X509_STORE_CTX_new();

    if (csc == nullptr)
      goto skip;
    if (!X509_STORE_CTX_init(csc, cert_ctx, xcert, chain))
      goto skip;

    X509_STORE_CTX_set_purpose(csc, purpose);
    X509_STORE_CTX_set_verify_cb(csc, verify_cb);

    rc = X509_verify_cert(csc);
    err = X509_STORE_CTX_get_error(csc);
  skip:
    X509_STORE_CTX_free(csc);
    if (rc == 1)
    {
      status = TRUE;
      break;
    }
    else if (err != X509_V_ERR_INVALID_PURPOSE)
      break;
  }

  X509_STORE_free(cert_ctx);
end:
  return status;
}

char* x509_utils_bio_read(BIO* bio, size_t* plen)
{
  char* buffer = nullptr;
  WINPR_ASSERT(bio);

  if (plen)
    *plen = 0;

  BIO_flush(bio);

  const UINT64 size = BIO_number_written(bio);
  if (size > INT_MAX)
    return nullptr;

  buffer = calloc(1, (size_t)size + 1ull);

  if (!buffer)
    return nullptr;

  ERR_clear_error();
  const int rc = BIO_read(bio, buffer, (int)size);
  if (rc <= 0)
    goto fail;

  if (plen)
    *plen = size;
  return buffer;

fail:
  free(buffer);
  return nullptr;
}

void x509_utils_ip_names_free(size_t count, size_t* lengths, char** dns_names)
{
  x509_utils_dns_names_free(count, lengths, dns_names);
}

Coverage Report

Created: 2026-10-15 06:26