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)
78 char* buffer =
nullptr;
79 BIO* outBIO = BIO_new(BIO_s_mem());
83 if (X509_NAME_print_ex(outBIO, name, 0, XN_FLAG_ONELINE) > 0)
84 buffer = x509_utils_bio_read(outBIO,
nullptr);
90char* x509_utils_get_subject(
const X509* xcert)
92 char* subject =
nullptr;
95 WLog_ERR(TAG,
"Invalid certificate nullptr");
98 subject = crypto_print_name(X509_get_subject_name(xcert));
100 WLog_WARN(TAG,
"certificate does not have a subject!");
106static const char* general_name_type_labels[] = {
"OTHERNAME",
"EMAIL ",
"DNS ",
107 "X400 ",
"DIRNAME ",
"EDIPARTY ",
108 "URI ",
"IPADD ",
"RID " };
110static const char* general_name_type_label(
int general_name_type)
112 if ((0 <= general_name_type) &&
113 ((
size_t)general_name_type < ARRAYSIZE(general_name_type_labels)))
115 return general_name_type_labels[general_name_type];
119 static char buffer[80] = WINPR_C_ARRAY_INIT;
120 (void)snprintf(buffer,
sizeof(buffer),
"Unknown general name type (%d)", general_name_type);
170typedef int (*general_name_mapper_pr)(GENERAL_NAME* name,
void* data,
int index,
int count);
172static void map_subject_alt_name(
const X509* x509,
int general_name_type,
173 general_name_mapper_pr mapper,
void* data)
176 STACK_OF(GENERAL_NAME)* gens =
nullptr;
177 gens = X509_get_ext_d2i(x509, NID_subject_alt_name,
nullptr,
nullptr);
184 num = sk_GENERAL_NAME_num(gens);
186 for (
int i = 0; (i < num); i++)
188 GENERAL_NAME* name = sk_GENERAL_NAME_value(gens, i);
192 if ((general_name_type == GEN_ALL) || (general_name_type == name->type))
194 if (!mapper(name, data, i, num))
202 sk_GENERAL_NAME_pop_free(gens, GENERAL_NAME_free);
224typedef struct string_list
232static void string_list_initialize(string_list* list)
234 list->strings =
nullptr;
237 list->maximum = INT_MAX;
240static void string_list_allocate(string_list* list,
size_t allocate_count)
242 if (!list->strings && list->allocated == 0)
244 list->strings = (
char**)calloc(allocate_count,
sizeof(
char*));
245 list->allocated = list->strings ? allocate_count : 0;
250static void string_list_free(string_list* list)
255 free((
void*)list->strings);
258static int extract_string(GENERAL_NAME* name,
void* data,
int index,
int count)
260 string_list* list = data;
261 unsigned char* cstring =
nullptr;
262 ASN1_STRING* str =
nullptr;
269 str = name->d.uniformResourceIdentifier;
273 str = name->d.dNSName;
277 str = name->d.rfc822Name;
284 if ((ASN1_STRING_to_UTF8(&cstring, str)) < 0)
286 WLog_ERR(TAG,
"ASN1_STRING_to_UTF8() failed for %s: %s",
287 general_name_type_label(name->type), ERR_error_string(ERR_get_error(),
nullptr));
291 string_list_allocate(list, WINPR_ASSERTING_INT_CAST(WINPR_CIPHER_TYPE, count));
293 if (list->allocated <= 0)
295 OPENSSL_free(cstring);
299 list->strings[list->count] = (
char*)cstring;
302 if (list->count >= list->maximum)
328typedef struct object_list
330 ASN1_OBJECT* type_id;
337static void object_list_initialize(object_list* list)
339 list->type_id =
nullptr;
340 list->strings =
nullptr;
343 list->maximum = INT_MAX;
346static void object_list_allocate(object_list* list,
size_t allocate_count)
348 if (!list->strings && (list->allocated == 0) && (allocate_count > 0))
350 list->strings = (
char**)calloc(allocate_count,
sizeof(list->strings[0]));
351 list->allocated = list->strings ? allocate_count : 0;
356static char* object_string(ASN1_TYPE*
object)
358 char* result =
nullptr;
359 unsigned char* utf8String =
nullptr;
362 const int length = ASN1_STRING_to_UTF8(&utf8String, object->value.asn1_string);
369 result = strndup((
char*)utf8String, WINPR_ASSERTING_INT_CAST(
size_t, length));
370 OPENSSL_free(utf8String);
374static void object_list_free(object_list* list)
377 free((
void*)list->strings);
380static int extract_othername_object_as_string(GENERAL_NAME* name,
void* data,
int index,
int count)
382 object_list* list = data;
388 if (name->type != GEN_OTHERNAME)
393 if (0 != OBJ_cmp(name->d.otherName->type_id, list->type_id))
398 object_list_allocate(list, WINPR_ASSERTING_INT_CAST(
size_t, count));
400 if (list->allocated <= 0)
405 list->strings[list->count] = object_string(name->d.otherName->value);
407 if (list->strings[list->count])
412 if (list->count >= list->maximum)
420char* x509_utils_get_email(
const X509* x509)
422 char* result =
nullptr;
424 string_list_initialize(&list);
426 map_subject_alt_name(x509, GEN_EMAIL, extract_string, &list);
430 string_list_free(&list);
434 result = _strdup(list.strings[0]);
435 OPENSSL_free(list.strings[0]);
436 string_list_free(&list);
440char* x509_utils_get_upn(
const X509* x509)
442 char* result =
nullptr;
443 object_list list = WINPR_C_ARRAY_INIT;
444 object_list_initialize(&list);
445 list.type_id = OBJ_nid2obj(NID_ms_upn);
447 map_subject_alt_name(x509, GEN_OTHERNAME, extract_othername_object_as_string, &list);
451 object_list_free(&list);
455 result = list.strings[0];
456 object_list_free(&list);
460char* x509_utils_get_date(
const X509* x509, BOOL startDate)
464 const ASN1_TIME* date = startDate ? X509_get0_notBefore(x509) : X509_get0_notAfter(x509);
468 BIO* bmem = BIO_new(BIO_s_mem());
473 if (ASN1_TIME_print(bmem, date))
475 BUF_MEM* bptr =
nullptr;
477 BIO_get_mem_ptr(bmem, &bptr);
478 str = strndup(bptr->data, bptr->length);
487void x509_utils_dns_names_free(
size_t count,
size_t* lengths,
char** dns_names)
493 for (
size_t i = 0; i < count; i++)
497 OPENSSL_free(dns_names[i]);
501 free((
void*)dns_names);
505char** x509_utils_get_dns_names(
const X509* xcert,
size_t* count,
size_t** lengths)
507 char** result =
nullptr;
508 string_list list = WINPR_C_ARRAY_INIT;
509 string_list_initialize(&list);
510 map_subject_alt_name(xcert, GEN_DNS, extract_string, &list);
511 (*count) = list.count;
515 string_list_free(&list);
521 result = (
char**)calloc(list.count,
sizeof(*result));
522 (*lengths) = calloc(list.count,
sizeof(**lengths));
524 if (!result || !(*lengths))
526 string_list_free(&list);
529 (*lengths) =
nullptr;
534 for (
size_t i = 0; i < list.count; i++)
536 result[i] = list.strings[i];
537 (*lengths)[i] = strlen(result[i]);
540 string_list_free(&list);
544char* x509_utils_get_issuer(
const X509* xcert)
546 char* issuer =
nullptr;
549 WLog_ERR(TAG,
"Invalid certificate nullptr");
552 issuer = crypto_print_name(X509_get_issuer_name(xcert));
554 WLog_WARN(TAG,
"certificate does not have an issuer!");
558static int asn1_object_cmp(
const ASN1_OBJECT*
const* a,
const ASN1_OBJECT*
const* b)
561 return (a == b) ? 0 : (a ? 1 : -1);
564 return (*a == *b) ? 0 : (*a ? 1 : -1);
566 return OBJ_cmp(*a, *b);
569BOOL x509_utils_check_eku(
const X509* xcert,
int nid)
572 STACK_OF(ASN1_OBJECT)* oid_stack =
nullptr;
573 ASN1_OBJECT* oid =
nullptr;
578 oid = OBJ_nid2obj(nid);
582 oid_stack = X509_get_ext_d2i(xcert, NID_ext_key_usage,
nullptr,
nullptr);
586 sk_ASN1_OBJECT_set_cmp_func(oid_stack, asn1_object_cmp);
587 if (sk_ASN1_OBJECT_find(oid_stack, oid) >= 0)
590 sk_ASN1_OBJECT_pop_free(oid_stack, ASN1_OBJECT_free);
594void x509_utils_print_info(
const X509* xcert)
597 char* issuer =
nullptr;
598 char* subject =
nullptr;
599 subject = x509_utils_get_subject(xcert);
600 issuer = x509_utils_get_issuer(xcert);
601 fp = (
char*)x509_utils_get_hash(xcert,
"sha256",
nullptr);
605 WLog_ERR(TAG,
"error computing fingerprint");
606 goto out_free_issuer;
609 WLog_INFO(TAG,
"Certificate details:");
610 WLog_INFO(TAG,
"\tSubject: %s", subject);
611 WLog_INFO(TAG,
"\tIssuer: %s", issuer);
612 WLog_INFO(TAG,
"\tThumbprint: %s", fp);
614 "The above X.509 certificate could not be verified, possibly because you do not have "
615 "the CA certificate in your certificate store, or the certificate has expired. "
616 "Please look at the OpenSSL documentation on how to add a private CA to the store.");
623X509* x509_utils_from_pem(
const char* data,
size_t len, BOOL fromFile)
625 X509* x509 =
nullptr;
628 bio = BIO_new_file(data,
"rb");
634 bio = BIO_new_mem_buf(data, (
int)len);
639 WLog_ERR(TAG,
"BIO_new failed for certificate");
643 x509 = PEM_read_bio_X509(bio,
nullptr,
nullptr,
nullptr);
646 WLog_ERR(TAG,
"PEM_read_bio_X509 returned nullptr [input length %" PRIuz
"]", len);
651static WINPR_MD_TYPE hash_nid_to_winpr(
int hash_nid)
662 return WINPR_MD_SHA1;
664 return WINPR_MD_SHA224;
666 return WINPR_MD_SHA256;
668 return WINPR_MD_SHA384;
670 return WINPR_MD_SHA512;
672 return WINPR_MD_RIPEMD160;
673#if (OPENSSL_VERSION_NUMBER >= 0x1010101fL) && !defined(LIBRESSL_VERSION_NUMBER)
675 return WINPR_MD_SHA3_224;
677 return WINPR_MD_SHA3_256;
679 return WINPR_MD_SHA3_384;
681 return WINPR_MD_SHA3_512;
683 return WINPR_MD_SHAKE128;
685 return WINPR_MD_SHAKE256;
689 return WINPR_MD_NONE;
693static WINPR_MD_TYPE get_rsa_pss_digest(
const X509_ALGOR* alg)
695 WINPR_MD_TYPE ret = WINPR_MD_NONE;
696 WINPR_MD_TYPE message_digest = WINPR_MD_NONE;
697 WINPR_MD_TYPE mgf1_digest = WINPR_MD_NONE;
699 const void* param_value =
nullptr;
700 const ASN1_STRING* sequence =
nullptr;
701 const unsigned char* inp =
nullptr;
702 RSA_PSS_PARAMS* params =
nullptr;
703 X509_ALGOR* mgf1_digest_alg =
nullptr;
707 X509_ALGOR_get0(
nullptr, ¶m_type, ¶m_value, alg);
712 if (param_type != V_ASN1_SEQUENCE)
714 sequence = param_value;
717 inp = ASN1_STRING_get0_data(sequence);
718 params = d2i_RSA_PSS_PARAMS(
nullptr, &inp, ASN1_STRING_length(sequence));
719 if (params ==
nullptr)
725 message_digest = WINPR_MD_SHA1;
726 if (params->hashAlgorithm !=
nullptr)
728 const ASN1_OBJECT* obj =
nullptr;
729 X509_ALGOR_get0(&obj,
nullptr,
nullptr, params->hashAlgorithm);
730 message_digest = hash_nid_to_winpr(OBJ_obj2nid(obj));
731 if (message_digest == WINPR_MD_NONE)
735 mgf1_digest = WINPR_MD_SHA1;
736 if (params->maskGenAlgorithm !=
nullptr)
738 const ASN1_OBJECT* obj =
nullptr;
739 int mgf_param_type = 0;
740 const void* mgf_param_value =
nullptr;
741 const ASN1_STRING* mgf_param_sequence =
nullptr;
743 X509_ALGOR_get0(&obj, &mgf_param_type, &mgf_param_value, params->maskGenAlgorithm);
744 if (OBJ_obj2nid(obj) != NID_mgf1)
748 if (mgf_param_type != V_ASN1_SEQUENCE)
750 mgf_param_sequence = mgf_param_value;
751 inp = ASN1_STRING_get0_data(mgf_param_sequence);
752 mgf1_digest_alg = d2i_X509_ALGOR(
nullptr, &inp, ASN1_STRING_length(mgf_param_sequence));
753 if (mgf1_digest_alg ==
nullptr)
757 X509_ALGOR_get0(&obj,
nullptr,
nullptr, mgf1_digest_alg);
758 mgf1_digest = hash_nid_to_winpr(OBJ_obj2nid(obj));
759 if (mgf1_digest == WINPR_MD_NONE)
766 if (message_digest != mgf1_digest)
768 ret = message_digest;
771 RSA_PSS_PARAMS_free(params);
772 X509_ALGOR_free(mgf1_digest_alg);
776WINPR_MD_TYPE x509_utils_get_signature_alg(
const X509* xcert)
780 const int nid = X509_get_signature_nid(xcert);
782 if (nid == NID_rsassaPss)
784 const X509_ALGOR* alg =
nullptr;
785 X509_get0_signature(
nullptr, &alg, xcert);
786 return get_rsa_pss_digest(alg);
790 if (OBJ_find_sigid_algs(nid, &hash_nid,
nullptr) != 1)
791 return WINPR_MD_NONE;
793 return hash_nid_to_winpr(hash_nid);
796char* x509_utils_get_common_name(
const X509* xcert,
size_t* plength)
798 X509_NAME* subject_name = X509_get_subject_name(xcert);
799 if (subject_name ==
nullptr)
802 const int index = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
806 const X509_NAME_ENTRY* entry = X509_NAME_get_entry(subject_name, index);
807 if (entry ==
nullptr)
810 const ASN1_STRING* entry_data = X509_NAME_ENTRY_get_data(entry);
811 if (entry_data ==
nullptr)
814 BYTE* common_name_raw =
nullptr;
815 const int length = ASN1_STRING_to_UTF8(&common_name_raw, entry_data);
820 *plength = (size_t)length;
822 char* common_name = _strdup((
char*)common_name_raw);
823 OPENSSL_free(common_name_raw);
827static int verify_cb(
int ok, X509_STORE_CTX* csc)
832 int err = X509_STORE_CTX_get_error(csc);
833 int derr = X509_STORE_CTX_get_error_depth(csc);
834 X509* where = X509_STORE_CTX_get_current_cert(csc);
835 const char* what = X509_verify_cert_error_string(err);
836 char* name = x509_utils_get_subject(where);
838 WLog_WARN(TAG,
"Certificate verification failure '%s (%d)' at stack position %d", what, err,
840 WLog_WARN(TAG,
"%s", name);
847BOOL x509_utils_verify(X509* xcert, STACK_OF(X509) * chain,
const char* certificate_store_path)
849 const int purposes[3] = { X509_PURPOSE_SSL_SERVER, X509_PURPOSE_SSL_CLIENT, X509_PURPOSE_ANY };
850 X509_STORE_CTX* csc =
nullptr;
852 X509_LOOKUP* lookup =
nullptr;
857 X509_STORE* cert_ctx = X509_STORE_new();
859 if (cert_ctx ==
nullptr)
862#if OPENSSL_VERSION_NUMBER < 0x10100000L || defined(LIBRESSL_VERSION_NUMBER)
863 OpenSSL_add_all_algorithms();
865 OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS | OPENSSL_INIT_ADD_ALL_DIGESTS |
866 OPENSSL_INIT_LOAD_CONFIG,
870 if (X509_STORE_set_default_paths(cert_ctx) != 1)
873 lookup = X509_STORE_add_lookup(cert_ctx, X509_LOOKUP_hash_dir());
875 if (lookup ==
nullptr)
878 X509_LOOKUP_add_dir(lookup,
nullptr, X509_FILETYPE_DEFAULT);
880 if (certificate_store_path !=
nullptr)
882 X509_LOOKUP_add_dir(lookup, certificate_store_path, X509_FILETYPE_PEM);
885 X509_STORE_set_flags(cert_ctx, 0);
887 for (
size_t i = 0; i < ARRAYSIZE(purposes); i++)
891 int purpose = purposes[i];
892 csc = X509_STORE_CTX_new();
896 if (!X509_STORE_CTX_init(csc, cert_ctx, xcert, chain))
899 X509_STORE_CTX_set_purpose(csc, purpose);
900 X509_STORE_CTX_set_verify_cb(csc, verify_cb);
902 rc = X509_verify_cert(csc);
903 err = X509_STORE_CTX_get_error(csc);
905 X509_STORE_CTX_free(csc);
911 else if (err != X509_V_ERR_INVALID_PURPOSE)
915 X509_STORE_free(cert_ctx);
920char* x509_utils_bio_read(BIO* bio,
size_t* plen)
922 char* buffer =
nullptr;
930 const UINT64 size = BIO_number_written(bio);
934 buffer = calloc(1, (
size_t)size + 1ull);
940 const int rc = BIO_read(bio, buffer, (
int)size);