22#include <openssl/objects.h>
23#include <openssl/x509v3.h>
24#include <openssl/pem.h>
25#include <openssl/rsa.h>
26#include <openssl/err.h>
28#include <freerdp/config.h>
31#include <winpr/string.h>
32#include <winpr/assert.h>
34#include <freerdp/log.h>
36#include "x509_utils.h"
38#define TAG FREERDP_TAG("crypto")
40BYTE* x509_utils_get_hash(
const X509* xcert,
const char* hash,
size_t* length)
42 UINT32 fp_len = EVP_MAX_MD_SIZE;
44 const EVP_MD* md = EVP_get_digestbyname(hash);
47 WLog_ERR(TAG,
"System does not support %s hash!", hash);
50 if (!xcert || !length)
52 WLog_ERR(TAG,
"Invalid arguments: xcert=%p, length=%p",
53 WINPR_CXX_COMPAT_CAST(
const void*, xcert),
54 WINPR_CXX_COMPAT_CAST(
const void*, length));
58 fp = calloc(fp_len + 1,
sizeof(BYTE));
61 WLog_ERR(TAG,
"could not allocate %" PRIu32
" bytes", fp_len);
65 if (X509_digest(xcert, md, fp, &fp_len) != 1)
68 WLog_ERR(TAG,
"certificate does not have a %s hash!", hash);
76static char* crypto_print_name(
const X509_NAME* name)
79 BIO* outBIO = BIO_new(BIO_s_mem());
81 if (X509_NAME_print_ex(outBIO, name, 0, XN_FLAG_ONELINE) > 0)
83 UINT64 size = BIO_number_written(outBIO);
86 buffer = calloc(1, (
size_t)size + 1);
92 const int rc = BIO_read(outBIO, buffer, (
int)size);
102 BIO_free_all(outBIO);
106char* x509_utils_get_subject(
const X509* xcert)
108 char* subject = NULL;
111 WLog_ERR(TAG,
"Invalid certificate NULL");
114 subject = crypto_print_name(X509_get_subject_name(xcert));
116 WLog_WARN(TAG,
"certificate does not have a subject!");
122static const char* general_name_type_labels[] = {
"OTHERNAME",
"EMAIL ",
"DNS ",
123 "X400 ",
"DIRNAME ",
"EDIPARTY ",
124 "URI ",
"IPADD ",
"RID " };
126static const char* general_name_type_label(
int general_name_type)
128 if ((0 <= general_name_type) &&
129 ((
size_t)general_name_type < ARRAYSIZE(general_name_type_labels)))
131 return general_name_type_labels[general_name_type];
135 static char buffer[80] = { 0 };
136 (void)snprintf(buffer,
sizeof(buffer),
"Unknown general name type (%d)", general_name_type);
186typedef int (*general_name_mapper_pr)(GENERAL_NAME* name,
void* data,
int index,
int count);
188static void map_subject_alt_name(
const X509* x509,
int general_name_type,
189 general_name_mapper_pr mapper,
void* data)
192 STACK_OF(GENERAL_NAME)* gens = NULL;
193 gens = X509_get_ext_d2i(x509, NID_subject_alt_name, NULL, NULL);
200 num = sk_GENERAL_NAME_num(gens);
202 for (
int i = 0; (i < num); i++)
204 GENERAL_NAME* name = sk_GENERAL_NAME_value(gens, i);
208 if ((general_name_type == GEN_ALL) || (general_name_type == name->type))
210 if (!mapper(name, data, i, num))
218 sk_GENERAL_NAME_pop_free(gens, GENERAL_NAME_free);
240typedef struct string_list
248static void string_list_initialize(string_list* list)
253 list->maximum = INT_MAX;
256static void string_list_allocate(string_list* list,
size_t allocate_count)
258 if (!list->strings && list->allocated == 0)
260 list->strings = (
char**)calloc(allocate_count,
sizeof(
char*));
261 list->allocated = list->strings ? allocate_count : 0;
266static void string_list_free(string_list* list)
271 free((
void*)list->strings);
274static int extract_string(GENERAL_NAME* name,
void* data,
int index,
int count)
276 string_list* list = data;
277 unsigned char* cstring = 0;
278 ASN1_STRING* str = NULL;
285 str = name->d.uniformResourceIdentifier;
289 str = name->d.dNSName;
293 str = name->d.rfc822Name;
300 if ((ASN1_STRING_to_UTF8(&cstring, str)) < 0)
302 WLog_ERR(TAG,
"ASN1_STRING_to_UTF8() failed for %s: %s",
303 general_name_type_label(name->type), ERR_error_string(ERR_get_error(), NULL));
307 string_list_allocate(list, WINPR_ASSERTING_INT_CAST(WINPR_CIPHER_TYPE, count));
309 if (list->allocated <= 0)
311 OPENSSL_free(cstring);
315 list->strings[list->count] = (
char*)cstring;
318 if (list->count >= list->maximum)
344typedef struct object_list
346 ASN1_OBJECT* type_id;
353static void object_list_initialize(object_list* list)
359 list->maximum = INT_MAX;
362static void object_list_allocate(object_list* list,
size_t allocate_count)
364 if (!list->strings && (list->allocated == 0) && (allocate_count > 0))
366 list->strings = (
char**)calloc(allocate_count,
sizeof(list->strings[0]));
367 list->allocated = list->strings ? allocate_count : 0;
372static char* object_string(ASN1_TYPE*
object)
375 unsigned char* utf8String = NULL;
378 const int length = ASN1_STRING_to_UTF8(&utf8String, object->value.asn1_string);
385 result = strndup((
char*)utf8String, WINPR_ASSERTING_INT_CAST(
size_t, length));
386 OPENSSL_free(utf8String);
390static void object_list_free(object_list* list)
393 free((
void*)list->strings);
396static int extract_othername_object_as_string(GENERAL_NAME* name,
void* data,
int index,
int count)
398 object_list* list = data;
404 if (name->type != GEN_OTHERNAME)
409 if (0 != OBJ_cmp(name->d.otherName->type_id, list->type_id))
414 object_list_allocate(list, WINPR_ASSERTING_INT_CAST(
size_t, count));
416 if (list->allocated <= 0)
421 list->strings[list->count] = object_string(name->d.otherName->value);
423 if (list->strings[list->count])
428 if (list->count >= list->maximum)
436char* x509_utils_get_email(
const X509* x509)
440 string_list_initialize(&list);
442 map_subject_alt_name(x509, GEN_EMAIL, extract_string, &list);
446 string_list_free(&list);
450 result = _strdup(list.strings[0]);
451 OPENSSL_free(list.strings[0]);
452 string_list_free(&list);
456char* x509_utils_get_upn(
const X509* x509)
459 object_list list = { 0 };
460 object_list_initialize(&list);
461 list.type_id = OBJ_nid2obj(NID_ms_upn);
463 map_subject_alt_name(x509, GEN_OTHERNAME, extract_othername_object_as_string, &list);
467 object_list_free(&list);
471 result = list.strings[0];
472 object_list_free(&list);
476char* x509_utils_get_date(
const X509* x509, BOOL startDate)
480 const ASN1_TIME* date = startDate ? X509_get0_notBefore(x509) : X509_get0_notAfter(x509);
484 BIO* bmem = BIO_new(BIO_s_mem());
489 if (ASN1_TIME_print(bmem, date))
491 BUF_MEM* bptr = NULL;
493 BIO_get_mem_ptr(bmem, &bptr);
494 str = strndup(bptr->data, bptr->length);
503void x509_utils_dns_names_free(
size_t count,
size_t* lengths,
char** dns_names)
509 for (
size_t i = 0; i < count; i++)
513 OPENSSL_free(dns_names[i]);
517 free((
void*)dns_names);
521char** x509_utils_get_dns_names(
const X509* x509,
size_t* count,
size_t** lengths)
524 string_list list = { 0 };
525 string_list_initialize(&list);
526 map_subject_alt_name(x509, GEN_DNS, extract_string, &list);
527 (*count) = list.count;
531 string_list_free(&list);
537 result = (
char**)calloc(list.count,
sizeof(*result));
538 (*lengths) = calloc(list.count,
sizeof(**lengths));
540 if (!result || !(*lengths))
542 string_list_free(&list);
550 for (
size_t i = 0; i < list.count; i++)
552 result[i] = list.strings[i];
553 (*lengths)[i] = strlen(result[i]);
556 string_list_free(&list);
560char* x509_utils_get_issuer(
const X509* xcert)
565 WLog_ERR(TAG,
"Invalid certificate NULL");
568 issuer = crypto_print_name(X509_get_issuer_name(xcert));
570 WLog_WARN(TAG,
"certificate does not have an issuer!");
574static int asn1_object_cmp(
const ASN1_OBJECT*
const* a,
const ASN1_OBJECT*
const* b)
577 return (a == b) ? 0 : (a ? 1 : -1);
580 return (*a == *b) ? 0 : (*a ? 1 : -1);
582 return OBJ_cmp(*a, *b);
585BOOL x509_utils_check_eku(
const X509* xcert,
int nid)
588 STACK_OF(ASN1_OBJECT)* oid_stack = NULL;
589 ASN1_OBJECT* oid = NULL;
594 oid = OBJ_nid2obj(nid);
598 oid_stack = X509_get_ext_d2i(xcert, NID_ext_key_usage, NULL, NULL);
602 sk_ASN1_OBJECT_set_cmp_func(oid_stack, asn1_object_cmp);
603 if (sk_ASN1_OBJECT_find(oid_stack, oid) >= 0)
606 sk_ASN1_OBJECT_pop_free(oid_stack, ASN1_OBJECT_free);
610void x509_utils_print_info(
const X509* xcert)
614 char* subject = NULL;
615 subject = x509_utils_get_subject(xcert);
616 issuer = x509_utils_get_issuer(xcert);
617 fp = (
char*)x509_utils_get_hash(xcert,
"sha256", NULL);
621 WLog_ERR(TAG,
"error computing fingerprint");
622 goto out_free_issuer;
625 WLog_INFO(TAG,
"Certificate details:");
626 WLog_INFO(TAG,
"\tSubject: %s", subject);
627 WLog_INFO(TAG,
"\tIssuer: %s", issuer);
628 WLog_INFO(TAG,
"\tThumbprint: %s", fp);
630 "The above X.509 certificate could not be verified, possibly because you do not have "
631 "the CA certificate in your certificate store, or the certificate has expired. "
632 "Please look at the OpenSSL documentation on how to add a private CA to the store.");
639X509* x509_utils_from_pem(
const char* data,
size_t len, BOOL fromFile)
644 bio = BIO_new_file(data,
"rb");
650 bio = BIO_new_mem_buf(data, (
int)len);
655 WLog_ERR(TAG,
"BIO_new failed for certificate");
659 x509 = PEM_read_bio_X509(bio, NULL, NULL, 0);
662 WLog_ERR(TAG,
"PEM_read_bio_X509 returned NULL [input length %" PRIuz
"]", len);
667static WINPR_MD_TYPE hash_nid_to_winpr(
int hash_nid)
678 return WINPR_MD_SHA1;
680 return WINPR_MD_SHA224;
682 return WINPR_MD_SHA256;
684 return WINPR_MD_SHA384;
686 return WINPR_MD_SHA512;
688 return WINPR_MD_RIPEMD160;
689#if (OPENSSL_VERSION_NUMBER >= 0x1010101fL) && !defined(LIBRESSL_VERSION_NUMBER)
691 return WINPR_MD_SHA3_224;
693 return WINPR_MD_SHA3_256;
695 return WINPR_MD_SHA3_384;
697 return WINPR_MD_SHA3_512;
699 return WINPR_MD_SHAKE128;
701 return WINPR_MD_SHAKE256;
705 return WINPR_MD_NONE;
709static WINPR_MD_TYPE get_rsa_pss_digest(
const X509_ALGOR* alg)
711 WINPR_MD_TYPE ret = WINPR_MD_NONE;
712 WINPR_MD_TYPE message_digest = WINPR_MD_NONE;
713 WINPR_MD_TYPE mgf1_digest = WINPR_MD_NONE;
715 const void* param_value = NULL;
716 const ASN1_STRING* sequence = NULL;
717 const unsigned char* inp = NULL;
718 RSA_PSS_PARAMS* params = NULL;
719 X509_ALGOR* mgf1_digest_alg = NULL;
723 X509_ALGOR_get0(NULL, ¶m_type, ¶m_value, alg);
728 if (param_type != V_ASN1_SEQUENCE)
730 sequence = param_value;
733 inp = ASN1_STRING_get0_data(sequence);
734 params = d2i_RSA_PSS_PARAMS(NULL, &inp, ASN1_STRING_length(sequence));
741 message_digest = WINPR_MD_SHA1;
742 if (params->hashAlgorithm != NULL)
744 const ASN1_OBJECT* obj = NULL;
745 X509_ALGOR_get0(&obj, NULL, NULL, params->hashAlgorithm);
746 message_digest = hash_nid_to_winpr(OBJ_obj2nid(obj));
747 if (message_digest == WINPR_MD_NONE)
751 mgf1_digest = WINPR_MD_SHA1;
752 if (params->maskGenAlgorithm != NULL)
754 const ASN1_OBJECT* obj = NULL;
755 int mgf_param_type = 0;
756 const void* mgf_param_value = NULL;
757 const ASN1_STRING* mgf_param_sequence = NULL;
759 X509_ALGOR_get0(&obj, &mgf_param_type, &mgf_param_value, params->maskGenAlgorithm);
760 if (OBJ_obj2nid(obj) != NID_mgf1)
764 if (mgf_param_type != V_ASN1_SEQUENCE)
766 mgf_param_sequence = mgf_param_value;
767 inp = ASN1_STRING_get0_data(mgf_param_sequence);
768 mgf1_digest_alg = d2i_X509_ALGOR(NULL, &inp, ASN1_STRING_length(mgf_param_sequence));
769 if (mgf1_digest_alg == NULL)
773 X509_ALGOR_get0(&obj, NULL, NULL, mgf1_digest_alg);
774 mgf1_digest = hash_nid_to_winpr(OBJ_obj2nid(obj));
775 if (mgf1_digest == WINPR_MD_NONE)
782 if (message_digest != mgf1_digest)
784 ret = message_digest;
787 RSA_PSS_PARAMS_free(params);
788 X509_ALGOR_free(mgf1_digest_alg);
792WINPR_MD_TYPE x509_utils_get_signature_alg(
const X509* xcert)
796 const int nid = X509_get_signature_nid(xcert);
798 if (nid == NID_rsassaPss)
800 const X509_ALGOR* alg = NULL;
801 X509_get0_signature(NULL, &alg, xcert);
802 return get_rsa_pss_digest(alg);
806 if (OBJ_find_sigid_algs(nid, &hash_nid, NULL) != 1)
807 return WINPR_MD_NONE;
809 return hash_nid_to_winpr(hash_nid);
812char* x509_utils_get_common_name(
const X509* xcert,
size_t* plength)
814 X509_NAME* subject_name = X509_get_subject_name(xcert);
815 if (subject_name == NULL)
818 const int index = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
822 const X509_NAME_ENTRY* entry = X509_NAME_get_entry(subject_name, index);
826 const ASN1_STRING* entry_data = X509_NAME_ENTRY_get_data(entry);
827 if (entry_data == NULL)
830 BYTE* common_name_raw = NULL;
831 const int length = ASN1_STRING_to_UTF8(&common_name_raw, entry_data);
836 *plength = (size_t)length;
838 char* common_name = _strdup((
char*)common_name_raw);
839 OPENSSL_free(common_name_raw);
843static int verify_cb(
int ok, X509_STORE_CTX* csc)
848 int err = X509_STORE_CTX_get_error(csc);
849 int derr = X509_STORE_CTX_get_error_depth(csc);
850 X509* where = X509_STORE_CTX_get_current_cert(csc);
851 const char* what = X509_verify_cert_error_string(err);
852 char* name = x509_utils_get_subject(where);
854 WLog_WARN(TAG,
"Certificate verification failure '%s (%d)' at stack position %d", what, err,
856 WLog_WARN(TAG,
"%s", name);
863BOOL x509_utils_verify(X509* xcert, STACK_OF(X509) * chain,
const char* certificate_store_path)
865 const int purposes[3] = { X509_PURPOSE_SSL_SERVER, X509_PURPOSE_SSL_CLIENT, X509_PURPOSE_ANY };
866 X509_STORE_CTX* csc = NULL;
868 X509_LOOKUP* lookup = NULL;
873 X509_STORE* cert_ctx = X509_STORE_new();
875 if (cert_ctx == NULL)
878#if OPENSSL_VERSION_NUMBER < 0x10100000L || defined(LIBRESSL_VERSION_NUMBER)
879 OpenSSL_add_all_algorithms();
881 OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS | OPENSSL_INIT_ADD_ALL_DIGESTS |
882 OPENSSL_INIT_LOAD_CONFIG,
886 if (X509_STORE_set_default_paths(cert_ctx) != 1)
889 lookup = X509_STORE_add_lookup(cert_ctx, X509_LOOKUP_hash_dir());
894 X509_LOOKUP_add_dir(lookup, NULL, X509_FILETYPE_DEFAULT);
896 if (certificate_store_path != NULL)
898 X509_LOOKUP_add_dir(lookup, certificate_store_path, X509_FILETYPE_PEM);
901 X509_STORE_set_flags(cert_ctx, 0);
903 for (
size_t i = 0; i < ARRAYSIZE(purposes); i++)
907 int purpose = purposes[i];
908 csc = X509_STORE_CTX_new();
912 if (!X509_STORE_CTX_init(csc, cert_ctx, xcert, chain))
915 X509_STORE_CTX_set_purpose(csc, purpose);
916 X509_STORE_CTX_set_verify_cb(csc, verify_cb);
918 rc = X509_verify_cert(csc);
919 err = X509_STORE_CTX_get_error(csc);
921 X509_STORE_CTX_free(csc);
927 else if (err != X509_V_ERR_INVALID_PURPOSE)
931 X509_STORE_free(cert_ctx);