[thirdparty/openssl.git] / crypto / core_namemap.c

/*
 * Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#include "e_os.h"                /* strcasecmp */
#include "internal/namemap.h"
#include <openssl/lhash.h>
#include "crypto/lhash.h"      /* ossl_lh_strcasehash */
#include "internal/tsan_assist.h"
#include "internal/sizes.h"

/*-
 * The namenum entry
 * =================
 */
typedef struct {
    char *name;
    int number;
} NAMENUM_ENTRY;

DEFINE_LHASH_OF(NAMENUM_ENTRY);

/*-
 * The namemap itself
 * ==================
 */

struct ossl_namemap_st {
    /* Flags */
    unsigned int stored:1; /* If 1, it's stored in a library context */

    CRYPTO_RWLOCK *lock;
    LHASH_OF(NAMENUM_ENTRY) *namenum;  /* Name->number mapping */

    TSAN_QUALIFIER int max_number;     /* Current max number */
};

/* LHASH callbacks */

static unsigned long namenum_hash(const NAMENUM_ENTRY *n)
{
    return ossl_lh_strcasehash(n->name);
}

static int namenum_cmp(const NAMENUM_ENTRY *a, const NAMENUM_ENTRY *b)
{
    return strcasecmp(a->name, b->name);
}

static void namenum_free(NAMENUM_ENTRY *n)
{
    if (n != NULL)
        OPENSSL_free(n->name);
    OPENSSL_free(n);
}

/* OSSL_LIB_CTX_METHOD functions for a namemap stored in a library context */

static void *stored_namemap_new(OSSL_LIB_CTX *libctx)
{
    OSSL_NAMEMAP *namemap = ossl_namemap_new();

    if (namemap != NULL)
        namemap->stored = 1;

    return namemap;
}

static void stored_namemap_free(void *vnamemap)
{
    OSSL_NAMEMAP *namemap = vnamemap;

    if (namemap != NULL) {
        /* Pretend it isn't stored, or ossl_namemap_free() will do nothing */
        namemap->stored = 0;
        ossl_namemap_free(namemap);
    }
}

static const OSSL_LIB_CTX_METHOD stored_namemap_method = {
    OSSL_LIB_CTX_METHOD_DEFAULT_PRIORITY,
    stored_namemap_new,
    stored_namemap_free,
};

/*-
 * API functions
 * =============
 */

int ossl_namemap_empty(OSSL_NAMEMAP *namemap)
{
#ifdef TSAN_REQUIRES_LOCKING
    /* No TSAN support */
    int rv;

    if (namemap == NULL)
        return 1;

    if (!CRYPTO_THREAD_read_lock(namemap->lock))
        return -1;
    rv = namemap->max_number == 0;
    CRYPTO_THREAD_unlock(namemap->lock);
    return rv;
#else
    /* Have TSAN support */
    return namemap == NULL || tsan_load(&namemap->max_number) == 0;
#endif
}

typedef struct doall_names_data_st {
    int number;
    const char **names;
    int found;
} DOALL_NAMES_DATA;

static void do_name(const NAMENUM_ENTRY *namenum, DOALL_NAMES_DATA *data)
{
    if (namenum->number == data->number)
        data->names[data->found++] = namenum->name;
}

IMPLEMENT_LHASH_DOALL_ARG_CONST(NAMENUM_ENTRY, DOALL_NAMES_DATA);

/*
 * Call the callback for all names in the namemap with the given number.
 * A return value 1 means that the callback was called for all names. A
 * return value of 0 means that the callback was not called for any names.
 */
int ossl_namemap_doall_names(const OSSL_NAMEMAP *namemap, int number,
                             void (*fn)(const char *name, void *data),
                             void *data)
{
    DOALL_NAMES_DATA cbdata;
    size_t num_names;
    int i;

    cbdata.number = number;
    cbdata.found = 0;

    /*
     * We collect all the names first under a read lock. Subsequently we call
     * the user function, so that we're not holding the read lock when in user
     * code. This could lead to deadlocks.
     */
    if (!CRYPTO_THREAD_read_lock(namemap->lock))
        return 0;

    num_names = lh_NAMENUM_ENTRY_num_items(namemap->namenum);
    if (num_names == 0) {
        CRYPTO_THREAD_unlock(namemap->lock);
        return 0;
    }
    cbdata.names = OPENSSL_malloc(sizeof(*cbdata.names) * num_names);
    if (cbdata.names == NULL) {
        CRYPTO_THREAD_unlock(namemap->lock);
        return 0;
    }
    lh_NAMENUM_ENTRY_doall_DOALL_NAMES_DATA(namemap->namenum, do_name,
                                            &cbdata);
    CRYPTO_THREAD_unlock(namemap->lock);

    for (i = 0; i < cbdata.found; i++)
        fn(cbdata.names[i], data);

    OPENSSL_free(cbdata.names);
    return 1;
}

static int namemap_name2num_n(const OSSL_NAMEMAP *namemap,
                              const char *name, size_t name_len)
{
    NAMENUM_ENTRY *namenum_entry, namenum_tmpl;

    if ((namenum_tmpl.name = OPENSSL_strndup(name, name_len)) == NULL)
        return 0;
    namenum_tmpl.number = 0;
    namenum_entry =
        lh_NAMENUM_ENTRY_retrieve(namemap->namenum, &namenum_tmpl);
    OPENSSL_free(namenum_tmpl.name);
    return namenum_entry != NULL ? namenum_entry->number : 0;
}

int ossl_namemap_name2num_n(const OSSL_NAMEMAP *namemap,
                            const char *name, size_t name_len)
{
    int number;

#ifndef FIPS_MODULE
    if (namemap == NULL)
        namemap = ossl_namemap_stored(NULL);
#endif

    if (namemap == NULL)
        return 0;

    if (!CRYPTO_THREAD_read_lock(namemap->lock))
        return 0;
    number = namemap_name2num_n(namemap, name, name_len);
    CRYPTO_THREAD_unlock(namemap->lock);

    return number;
}

int ossl_namemap_name2num(const OSSL_NAMEMAP *namemap, const char *name)
{
    if (name == NULL)
        return 0;

    return ossl_namemap_name2num_n(namemap, name, strlen(name));
}

struct num2name_data_st {
    size_t idx;                  /* Countdown */
    const char *name;            /* Result */
};

static void do_num2name(const char *name, void *vdata)
{
    struct num2name_data_st *data = vdata;

    if (data->idx > 0)
        data->idx--;
    else if (data->name == NULL)
        data->name = name;
}

const char *ossl_namemap_num2name(const OSSL_NAMEMAP *namemap, int number,
                                  size_t idx)
{
    struct num2name_data_st data;

    data.idx = idx;
    data.name = NULL;
    if (!ossl_namemap_doall_names(namemap, number, do_num2name, &data))
        return NULL;
    return data.name;
}

static int namemap_add_name_n(OSSL_NAMEMAP *namemap, int number,
                              const char *name, size_t name_len)
{
    NAMENUM_ENTRY *namenum = NULL;
    int tmp_number;

    /* If it already exists, we don't add it */
    if ((tmp_number = namemap_name2num_n(namemap, name, name_len)) != 0)
        return tmp_number;

    if ((namenum = OPENSSL_zalloc(sizeof(*namenum))) == NULL
        || (namenum->name = OPENSSL_strndup(name, name_len)) == NULL)
        goto err;

    /* The tsan_counter use here is safe since we're under lock */
    namenum->number =
        number != 0 ? number : 1 + tsan_counter(&namemap->max_number);
    (void)lh_NAMENUM_ENTRY_insert(namemap->namenum, namenum);

    if (lh_NAMENUM_ENTRY_error(namemap->namenum))
        goto err;
    return namenum->number;

 err:
    namenum_free(namenum);
    return 0;
}

int ossl_namemap_add_name_n(OSSL_NAMEMAP *namemap, int number,
                            const char *name, size_t name_len)
{
    int tmp_number;

#ifndef FIPS_MODULE
    if (namemap == NULL)
        namemap = ossl_namemap_stored(NULL);
#endif

    if (name == NULL || name_len == 0 || namemap == NULL)
        return 0;

    if (!CRYPTO_THREAD_write_lock(namemap->lock))
        return 0;
    tmp_number = namemap_add_name_n(namemap, number, name, name_len);
    CRYPTO_THREAD_unlock(namemap->lock);
    return tmp_number;
}

int ossl_namemap_add_name(OSSL_NAMEMAP *namemap, int number, const char *name)
{
    if (name == NULL)
        return 0;

    return ossl_namemap_add_name_n(namemap, number, name, strlen(name));
}

int ossl_namemap_add_names(OSSL_NAMEMAP *namemap, int number,
                           const char *names, const char separator)
{
    const char *p, *q;
    size_t l;

    /* Check that we have a namemap */
    if (!ossl_assert(namemap != NULL)) {
        ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
        return 0;
    }

    if (!CRYPTO_THREAD_write_lock(namemap->lock))
        return 0;
    /*
     * Check that no name is an empty string, and that all names have at
     * most one numeric identity together.
     */
    for (p = names; *p != '\0'; p = (q == NULL ? p + l : q + 1)) {
        int this_number;

        if ((q = strchr(p, separator)) == NULL)
            l = strlen(p);       /* offset to \0 */
        else
            l = q - p;           /* offset to the next separator */

        this_number = namemap_name2num_n(namemap, p, l);

        if (*p == '\0' || *p == separator) {
            ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_BAD_ALGORITHM_NAME);
            goto err;
        }
        if (number == 0) {
            number = this_number;
        } else if (this_number != 0 && this_number != number) {
            ERR_raise_data(ERR_LIB_CRYPTO, CRYPTO_R_CONFLICTING_NAMES,
                           "\"%.*s\" has an existing different identity %d (from \"%s\")",
                           l, p, this_number, names);
            goto err;
        }
    }

    /* Now that we have checked, register all names */
    for (p = names; *p != '\0'; p = (q == NULL ? p + l : q + 1)) {
        int this_number;

        if ((q = strchr(p, separator)) == NULL)
            l = strlen(p);       /* offset to \0 */
        else
            l = q - p;           /* offset to the next separator */

        this_number = namemap_add_name_n(namemap, number, p, l);
        if (number == 0) {
            number = this_number;
        } else if (this_number != number) {
            ERR_raise_data(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR,
                           "Got number %d when expecting %d",
                           this_number, number);
            goto err;
        }
    }

    CRYPTO_THREAD_unlock(namemap->lock);
    return number;

 err:
    CRYPTO_THREAD_unlock(namemap->lock);
    return 0;
}

/*-
 * Pre-population
 * ==============
 */

#ifndef FIPS_MODULE
#include <openssl/evp.h>

/* Creates an initial namemap with names found in the legacy method db */
static void get_legacy_evp_names(int base_nid, int nid, const char *pem_name,
                                 void *arg)
{
    int num = 0;
    ASN1_OBJECT *obj;

    if (base_nid != NID_undef) {
        num = ossl_namemap_add_name(arg, num, OBJ_nid2sn(base_nid));
        num = ossl_namemap_add_name(arg, num, OBJ_nid2ln(base_nid));
    }

    if (nid != NID_undef) {
        num = ossl_namemap_add_name(arg, num, OBJ_nid2sn(nid));
        num = ossl_namemap_add_name(arg, num, OBJ_nid2ln(nid));
        if ((obj = OBJ_nid2obj(nid)) != NULL) {
            char txtoid[OSSL_MAX_NAME_SIZE];

            if (OBJ_obj2txt(txtoid, sizeof(txtoid), obj, 1) > 0)
                num = ossl_namemap_add_name(arg, num, txtoid);
        }
    }
    if (pem_name != NULL)
        num = ossl_namemap_add_name(arg, num, pem_name);
}

static void get_legacy_cipher_names(const OBJ_NAME *on, void *arg)
{
    const EVP_CIPHER *cipher = (void *)OBJ_NAME_get(on->name, on->type);

    if (cipher != NULL)
        get_legacy_evp_names(NID_undef, EVP_CIPHER_get_type(cipher), NULL, arg);
}

static void get_legacy_md_names(const OBJ_NAME *on, void *arg)
{
    const EVP_MD *md = (void *)OBJ_NAME_get(on->name, on->type);

    if (md != NULL)
        get_legacy_evp_names(0, EVP_MD_get_type(md), NULL, arg);
}

static void get_legacy_pkey_meth_names(const EVP_PKEY_ASN1_METHOD *ameth,
                                       void *arg)
{
    int nid = 0, base_nid = 0, flags = 0;
    const char *pem_name = NULL;

    EVP_PKEY_asn1_get0_info(&nid, &base_nid, &flags, NULL, &pem_name, ameth);
    if (nid != NID_undef) {
        if ((flags & ASN1_PKEY_ALIAS) == 0) {
            switch (nid) {
            case EVP_PKEY_DHX:
                /* We know that the name "DHX" is used too */
                get_legacy_evp_names(0, nid, "DHX", arg);
                /* FALLTHRU */
            default:
                get_legacy_evp_names(0, nid, pem_name, arg);
            }
        } else {
            /*
             * Treat aliases carefully, some of them are undesirable, or
             * should not be treated as such for providers.
             */

            switch (nid) {
            case EVP_PKEY_SM2:
                /*
                 * SM2 is a separate keytype with providers, not an alias for
                 * EC.
                 */
                get_legacy_evp_names(0, nid, pem_name, arg);
                break;
            default:
                /* Use the short name of the base nid as the common reference */
                get_legacy_evp_names(base_nid, nid, pem_name, arg);
            }
        }
    }
}
#endif

/*-
 * Constructors / destructors
 * ==========================
 */

OSSL_NAMEMAP *ossl_namemap_stored(OSSL_LIB_CTX *libctx)
{
#ifndef FIPS_MODULE
    int nms;
#endif
    OSSL_NAMEMAP *namemap =
        ossl_lib_ctx_get_data(libctx, OSSL_LIB_CTX_NAMEMAP_INDEX,
                              &stored_namemap_method);

    if (namemap == NULL)
        return NULL;

#ifndef FIPS_MODULE
    nms = ossl_namemap_empty(namemap);
    if (nms < 0) {
        /*
         * Could not get lock to make the count, so maybe internal objects
         * weren't added. This seems safest.
         */
        return NULL;
    }
    if (nms == 1) {
        int i, end;

        /* Before pilfering, we make sure the legacy database is populated */
        OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS
                            | OPENSSL_INIT_ADD_ALL_DIGESTS, NULL);

        OBJ_NAME_do_all(OBJ_NAME_TYPE_CIPHER_METH,
                        get_legacy_cipher_names, namemap);
        OBJ_NAME_do_all(OBJ_NAME_TYPE_MD_METH,
                        get_legacy_md_names, namemap);

        /* We also pilfer data from the legacy EVP_PKEY_ASN1_METHODs */
        for (i = 0, end = EVP_PKEY_asn1_get_count(); i < end; i++)
            get_legacy_pkey_meth_names(EVP_PKEY_asn1_get0(i), namemap);
    }
#endif

    return namemap;
}

OSSL_NAMEMAP *ossl_namemap_new(void)
{
    OSSL_NAMEMAP *namemap;

    if ((namemap = OPENSSL_zalloc(sizeof(*namemap))) != NULL
        && (namemap->lock = CRYPTO_THREAD_lock_new()) != NULL
        && (namemap->namenum =
            lh_NAMENUM_ENTRY_new(namenum_hash, namenum_cmp)) != NULL)
        return namemap;

    ossl_namemap_free(namemap);
    return NULL;
}

void ossl_namemap_free(OSSL_NAMEMAP *namemap)
{
    if (namemap == NULL || namemap->stored)
        return;

    lh_NAMENUM_ENTRY_doall(namemap->namenum, namenum_free);
    lh_NAMENUM_ENTRY_free(namemap->namenum);

    CRYPTO_THREAD_lock_free(namemap->lock);
    OPENSSL_free(namemap);
}
Commit	Line	Data
f2182a4e	1	/*
8020d79b	2	* Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
f2182a4e RL	3	*
	4	* Licensed under the Apache License 2.0 (the "License"). You may not use
	5	* this file except in compliance with the License. You can obtain a copy
	6	* in the file LICENSE in the source distribution or at
	7	* https://www.openssl.org/source/license.html
	8	*/
	9
a9550b74	10	#include "e_os.h" /* strcasecmp */
f2182a4e RL	11	#include "internal/namemap.h"
f2182a4e RL	12	#include <openssl/lhash.h>
285aa80e	13	#include "crypto/lhash.h" /* ossl_lh_strcasehash */
c720fc35	14	#include "internal/tsan_assist.h"
05aed12f	15	#include "internal/sizes.h"
f2182a4e	16
651d4418 RL	17	/*-
	18	* The namenum entry
	19	* =================
	20	*/
f2182a4e	21	typedef struct {
651d4418	22	char *name;
f2182a4e	23	int number;
651d4418	24	} NAMENUM_ENTRY;
f2182a4e	25
651d4418	26	DEFINE_LHASH_OF(NAMENUM_ENTRY);
f2182a4e	27
651d4418 RL	28	/*-
	29	* The namemap itself
	30	* ==================
	31	*/
f2182a4e RL	32
	33	struct ossl_namemap_st {
	34	/* Flags */
	35	unsigned int stored:1; /* If 1, it's stored in a library context */
	36
	37	CRYPTO_RWLOCK *lock;
651d4418	38	LHASH_OF(NAMENUM_ENTRY) namenum; / Name->number mapping */
c720fc35	39
d8ed9e4a	40	TSAN_QUALIFIER int max_number; /* Current max number */
f2182a4e RL	41	};
	42
	43	/* LHASH callbacks */
	44
651d4418	45	static unsigned long namenum_hash(const NAMENUM_ENTRY *n)
f2182a4e	46	{
285aa80e	47	return ossl_lh_strcasehash(n->name);
f2182a4e RL	48	}
f2182a4e RL	49
651d4418	50	static int namenum_cmp(const NAMENUM_ENTRY a, const NAMENUM_ENTRY b)
f2182a4e	51	{
a9550b74	52	return strcasecmp(a->name, b->name);
f2182a4e RL	53	}
f2182a4e RL	54
651d4418	55	static void namenum_free(NAMENUM_ENTRY *n)
f2182a4e	56	{
651d4418 RL	57	if (n != NULL)
651d4418 RL	58	OPENSSL_free(n->name);
f2182a4e RL	59	OPENSSL_free(n);
	60	}
	61
b4250010	62	/* OSSL_LIB_CTX_METHOD functions for a namemap stored in a library context */
f2182a4e	63
b4250010	64	static void stored_namemap_new(OSSL_LIB_CTX libctx)
f2182a4e RL	65	{
	66	OSSL_NAMEMAP *namemap = ossl_namemap_new();
	67
	68	if (namemap != NULL)
	69	namemap->stored = 1;
	70
	71	return namemap;
	72	}
	73
	74	static void stored_namemap_free(void *vnamemap)
	75	{
	76	OSSL_NAMEMAP *namemap = vnamemap;
	77
bd65afdb P	78	if (namemap != NULL) {
	79	/* Pretend it isn't stored, or ossl_namemap_free() will do nothing */
	80	namemap->stored = 0;
	81	ossl_namemap_free(namemap);
	82	}
f2182a4e RL	83	}
f2182a4e RL	84
b4250010	85	static const OSSL_LIB_CTX_METHOD stored_namemap_method = {
a16d2174	86	OSSL_LIB_CTX_METHOD_DEFAULT_PRIORITY,
f2182a4e RL	87	stored_namemap_new,
	88	stored_namemap_free,
	89	};
	90
651d4418 RL	91	/*-
	92	* API functions
	93	* =============
	94	*/
f2182a4e	95
6a835fcf RL	96	int ossl_namemap_empty(OSSL_NAMEMAP *namemap)
6a835fcf RL	97	{
d8ed9e4a	98	#ifdef TSAN_REQUIRES_LOCKING
c720fc35 P	99	/* No TSAN support */
	100	int rv;
	101
	102	if (namemap == NULL)
	103	return 1;
6a835fcf	104
cd3f8c1b RS	105	if (!CRYPTO_THREAD_read_lock(namemap->lock))
cd3f8c1b RS	106	return -1;
c720fc35	107	rv = namemap->max_number == 0;
6a835fcf	108	CRYPTO_THREAD_unlock(namemap->lock);
6a835fcf	109	return rv;
d8ed9e4a P	110	#else
	111	/* Have TSAN support */
	112	return namemap == NULL \|\| tsan_load(&namemap->max_number) == 0;
c720fc35	113	#endif
6a835fcf RL	114	}
6a835fcf RL	115
651d4418 RL	116	typedef struct doall_names_data_st {
651d4418 RL	117	int number;
d84f5515 MC	118	const char **names;
d84f5515 MC	119	int found;
651d4418	120	} DOALL_NAMES_DATA;
f2182a4e	121
651d4418	122	static void do_name(const NAMENUM_ENTRY namenum, DOALL_NAMES_DATA data)
f2182a4e	123	{
651d4418	124	if (namenum->number == data->number)
d84f5515	125	data->names[data->found++] = namenum->name;
651d4418	126	}
f2182a4e	127
651d4418	128	IMPLEMENT_LHASH_DOALL_ARG_CONST(NAMENUM_ENTRY, DOALL_NAMES_DATA);
f2182a4e	129
d84f5515 MC	130	/*
	131	* Call the callback for all names in the namemap with the given number.
	132	* A return value 1 means that the callback was called for all names. A
	133	* return value of 0 means that the callback was not called for any names.
	134	*/
	135	int ossl_namemap_doall_names(const OSSL_NAMEMAP *namemap, int number,
	136	void (fn)(const char name, void *data),
	137	void *data)
651d4418 RL	138	{
651d4418 RL	139	DOALL_NAMES_DATA cbdata;
d84f5515 MC	140	size_t num_names;
d84f5515 MC	141	int i;
f2182a4e	142
651d4418	143	cbdata.number = number;
d84f5515 MC	144	cbdata.found = 0;
	145
	146	/*
	147	* We collect all the names first under a read lock. Subsequently we call
	148	* the user function, so that we're not holding the read lock when in user
	149	* code. This could lead to deadlocks.
	150	*/
cd3f8c1b RS	151	if (!CRYPTO_THREAD_read_lock(namemap->lock))
cd3f8c1b RS	152	return 0;
d84f5515	153
cd3f8c1b	154	num_names = lh_NAMENUM_ENTRY_num_items(namemap->namenum);
d84f5515 MC	155	if (num_names == 0) {
	156	CRYPTO_THREAD_unlock(namemap->lock);
	157	return 0;
	158	}
	159	cbdata.names = OPENSSL_malloc(sizeof(cbdata.names) num_names);
	160	if (cbdata.names == NULL) {
	161	CRYPTO_THREAD_unlock(namemap->lock);
	162	return 0;
	163	}
651d4418 RL	164	lh_NAMENUM_ENTRY_doall_DOALL_NAMES_DATA(namemap->namenum, do_name,
651d4418 RL	165	&cbdata);
f2182a4e	166	CRYPTO_THREAD_unlock(namemap->lock);
d84f5515 MC	167
	168	for (i = 0; i < cbdata.found; i++)
	169	fn(cbdata.names[i], data);
	170
	171	OPENSSL_free(cbdata.names);
	172	return 1;
f2182a4e RL	173	}
f2182a4e RL	174
79410c5f P	175	static int namemap_name2num_n(const OSSL_NAMEMAP *namemap,
	176	const char *name, size_t name_len)
	177	{
	178	NAMENUM_ENTRY *namenum_entry, namenum_tmpl;
	179
	180	if ((namenum_tmpl.name = OPENSSL_strndup(name, name_len)) == NULL)
	181	return 0;
	182	namenum_tmpl.number = 0;
	183	namenum_entry =
	184	lh_NAMENUM_ENTRY_retrieve(namemap->namenum, &namenum_tmpl);
	185	OPENSSL_free(namenum_tmpl.name);
	186	return namenum_entry != NULL ? namenum_entry->number : 0;
	187	}
	188
695d195b RL	189	int ossl_namemap_name2num_n(const OSSL_NAMEMAP *namemap,
695d195b RL	190	const char *name, size_t name_len)
f2182a4e	191	{
79410c5f	192	int number;
f2182a4e	193
f844f9eb	194	#ifndef FIPS_MODULE
f2182a4e RL	195	if (namemap == NULL)
	196	namemap = ossl_namemap_stored(NULL);
	197	#endif
	198
	199	if (namemap == NULL)
	200	return 0;
	201
cd3f8c1b RS	202	if (!CRYPTO_THREAD_read_lock(namemap->lock))
cd3f8c1b RS	203	return 0;
79410c5f	204	number = namemap_name2num_n(namemap, name, name_len);
f2182a4e RL	205	CRYPTO_THREAD_unlock(namemap->lock);
f2182a4e RL	206
651d4418	207	return number;
f2182a4e RL	208	}
f2182a4e RL	209
695d195b RL	210	int ossl_namemap_name2num(const OSSL_NAMEMAP namemap, const char name)
	211	{
	212	if (name == NULL)
	213	return 0;
	214
	215	return ossl_namemap_name2num_n(namemap, name, strlen(name));
	216	}
	217
f7c16d48 RL	218	struct num2name_data_st {
	219	size_t idx; /* Countdown */
	220	const char name; / Result */
	221	};
	222
	223	static void do_num2name(const char name, void vdata)
	224	{
	225	struct num2name_data_st *data = vdata;
	226
	227	if (data->idx > 0)
	228	data->idx--;
	229	else if (data->name == NULL)
	230	data->name = name;
	231	}
	232
	233	const char ossl_namemap_num2name(const OSSL_NAMEMAP namemap, int number,
	234	size_t idx)
	235	{
	236	struct num2name_data_st data;
	237
	238	data.idx = idx;
	239	data.name = NULL;
d84f5515 MC	240	if (!ossl_namemap_doall_names(namemap, number, do_num2name, &data))
d84f5515 MC	241	return NULL;
f7c16d48 RL	242	return data.name;
	243	}
	244
79410c5f P	245	static int namemap_add_name_n(OSSL_NAMEMAP *namemap, int number,
79410c5f P	246	const char *name, size_t name_len)
f2182a4e	247	{
651d4418 RL	248	NAMENUM_ENTRY *namenum = NULL;
651d4418 RL	249	int tmp_number;
f2182a4e	250
79410c5f P	251	/* If it already exists, we don't add it */
	252	if ((tmp_number = namemap_name2num_n(namemap, name, name_len)) != 0)
	253	return tmp_number;
f2182a4e	254
651d4418	255	if ((namenum = OPENSSL_zalloc(sizeof(*namenum))) == NULL
695d195b	256	\|\| (namenum->name = OPENSSL_strndup(name, name_len)) == NULL)
f2182a4e RL	257	goto err;
f2182a4e RL	258
d8ed9e4a	259	/* The tsan_counter use here is safe since we're under lock */
79410c5f	260	namenum->number =
c720fc35	261	number != 0 ? number : 1 + tsan_counter(&namemap->max_number);
651d4418 RL	262	(void)lh_NAMENUM_ENTRY_insert(namemap->namenum, namenum);
	263
	264	if (lh_NAMENUM_ENTRY_error(namemap->namenum))
f2182a4e	265	goto err;
79410c5f	266	return namenum->number;
f2182a4e RL	267
f2182a4e RL	268	err:
651d4418	269	namenum_free(namenum);
79410c5f P	270	return 0;
79410c5f P	271	}
651d4418	272
79410c5f P	273	int ossl_namemap_add_name_n(OSSL_NAMEMAP *namemap, int number,
	274	const char *name, size_t name_len)
	275	{
	276	int tmp_number;
	277
	278	#ifndef FIPS_MODULE
	279	if (namemap == NULL)
	280	namemap = ossl_namemap_stored(NULL);
	281	#endif
	282
	283	if (name == NULL \|\| name_len == 0 \|\| namemap == NULL)
	284	return 0;
	285
cd3f8c1b RS	286	if (!CRYPTO_THREAD_write_lock(namemap->lock))
cd3f8c1b RS	287	return 0;
79410c5f	288	tmp_number = namemap_add_name_n(namemap, number, name, name_len);
651d4418	289	CRYPTO_THREAD_unlock(namemap->lock);
79410c5f	290	return tmp_number;
f2182a4e	291	}
695d195b	292
3d83c735	293	int ossl_namemap_add_name(OSSL_NAMEMAP namemap, int number, const char name)
695d195b RL	294	{
	295	if (name == NULL)
	296	return 0;
	297
3d83c735 RL	298	return ossl_namemap_add_name_n(namemap, number, name, strlen(name));
	299	}
	300
	301	int ossl_namemap_add_names(OSSL_NAMEMAP *namemap, int number,
	302	const char *names, const char separator)
	303	{
	304	const char p, q;
	305	size_t l;
	306
	307	/* Check that we have a namemap */
	308	if (!ossl_assert(namemap != NULL)) {
	309	ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
	310	return 0;
	311	}
	312
cd3f8c1b RS	313	if (!CRYPTO_THREAD_write_lock(namemap->lock))
cd3f8c1b RS	314	return 0;
3d83c735 RL	315	/*
	316	* Check that no name is an empty string, and that all names have at
	317	* most one numeric identity together.
	318	*/
	319	for (p = names; *p != '\0'; p = (q == NULL ? p + l : q + 1)) {
	320	int this_number;
	321
	322	if ((q = strchr(p, separator)) == NULL)
	323	l = strlen(p); /* offset to \0 */
	324	else
	325	l = q - p; /* offset to the next separator */
	326
79410c5f	327	this_number = namemap_name2num_n(namemap, p, l);
3d83c735 RL	328
	329	if (p == '\0' \|\| p == separator) {
	330	ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_BAD_ALGORITHM_NAME);
79410c5f	331	goto err;
3d83c735 RL	332	}
	333	if (number == 0) {
	334	number = this_number;
	335	} else if (this_number != 0 && this_number != number) {
	336	ERR_raise_data(ERR_LIB_CRYPTO, CRYPTO_R_CONFLICTING_NAMES,
	337	"\"%.*s\" has an existing different identity %d (from \"%s\")",
	338	l, p, this_number, names);
79410c5f	339	goto err;
3d83c735 RL	340	}
	341	}
	342
	343	/* Now that we have checked, register all names */
	344	for (p = names; *p != '\0'; p = (q == NULL ? p + l : q + 1)) {
	345	int this_number;
	346
	347	if ((q = strchr(p, separator)) == NULL)
	348	l = strlen(p); /* offset to \0 */
	349	else
	350	l = q - p; /* offset to the next separator */
	351
79410c5f	352	this_number = namemap_add_name_n(namemap, number, p, l);
3d83c735 RL	353	if (number == 0) {
	354	number = this_number;
	355	} else if (this_number != number) {
e4a1d023	356	ERR_raise_data(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR,
3d83c735 RL	357	"Got number %d when expecting %d",
3d83c735 RL	358	this_number, number);
79410c5f	359	goto err;
3d83c735 RL	360	}
	361	}
	362
79410c5f	363	CRYPTO_THREAD_unlock(namemap->lock);
3d83c735	364	return number;
79410c5f P	365
	366	err:
	367	CRYPTO_THREAD_unlock(namemap->lock);
	368	return 0;
695d195b	369	}
437ad983 RL	370
	371	/*-
	372	* Pre-population
	373	* ==============
	374	*/
	375
f844f9eb	376	#ifndef FIPS_MODULE
437ad983 RL	377	#include <openssl/evp.h>
	378
	379	/* Creates an initial namemap with names found in the legacy method db */
c230e938 RL	380	static void get_legacy_evp_names(int base_nid, int nid, const char *pem_name,
c230e938 RL	381	void *arg)
437ad983	382	{
c230e938 RL	383	int num = 0;
c230e938 RL	384	ASN1_OBJECT *obj;
437ad983	385
c230e938 RL	386	if (base_nid != NID_undef) {
	387	num = ossl_namemap_add_name(arg, num, OBJ_nid2sn(base_nid));
	388	num = ossl_namemap_add_name(arg, num, OBJ_nid2ln(base_nid));
437ad983	389	}
05aed12f	390
c230e938 RL	391	if (nid != NID_undef) {
	392	num = ossl_namemap_add_name(arg, num, OBJ_nid2sn(nid));
	393	num = ossl_namemap_add_name(arg, num, OBJ_nid2ln(nid));
	394	if ((obj = OBJ_nid2obj(nid)) != NULL) {
	395	char txtoid[OSSL_MAX_NAME_SIZE];
05aed12f	396
2349d7ba	397	if (OBJ_obj2txt(txtoid, sizeof(txtoid), obj, 1) > 0)
c230e938 RL	398	num = ossl_namemap_add_name(arg, num, txtoid);
c230e938 RL	399	}
05aed12f	400	}
c230e938 RL	401	if (pem_name != NULL)
c230e938 RL	402	num = ossl_namemap_add_name(arg, num, pem_name);
437ad983 RL	403	}
	404
	405	static void get_legacy_cipher_names(const OBJ_NAME on, void arg)
	406	{
	407	const EVP_CIPHER cipher = (void )OBJ_NAME_get(on->name, on->type);
	408
7a85dd46 P	409	if (cipher != NULL)
7a85dd46 P	410	get_legacy_evp_names(NID_undef, EVP_CIPHER_get_type(cipher), NULL, arg);
437ad983 RL	411	}
	412
	413	static void get_legacy_md_names(const OBJ_NAME on, void arg)
	414	{
	415	const EVP_MD md = (void )OBJ_NAME_get(on->name, on->type);
01ba6c8e	416
7a85dd46 P	417	if (md != NULL)
7a85dd46 P	418	get_legacy_evp_names(0, EVP_MD_get_type(md), NULL, arg);
05aed12f RL	419	}
	420
	421	static void get_legacy_pkey_meth_names(const EVP_PKEY_ASN1_METHOD *ameth,
	422	void *arg)
	423	{
	424	int nid = 0, base_nid = 0, flags = 0;
c230e938	425	const char *pem_name = NULL;
05aed12f	426
c230e938	427	EVP_PKEY_asn1_get0_info(&nid, &base_nid, &flags, NULL, &pem_name, ameth);
05aed12f RL	428	if (nid != NID_undef) {
05aed12f RL	429	if ((flags & ASN1_PKEY_ALIAS) == 0) {
c230e938 RL	430	switch (nid) {
	431	case EVP_PKEY_DHX:
	432	/* We know that the name "DHX" is used too */
	433	get_legacy_evp_names(0, nid, "DHX", arg);
	434	/* FALLTHRU */
	435	default:
	436	get_legacy_evp_names(0, nid, pem_name, arg);
	437	}
05aed12f RL	438	} else {
	439	/*
	440	* Treat aliases carefully, some of them are undesirable, or
	441	* should not be treated as such for providers.
	442	*/
	443
	444	switch (nid) {
	445	case EVP_PKEY_SM2:
05aed12f RL	446	/*
	447	* SM2 is a separate keytype with providers, not an alias for
	448	* EC.
05aed12f	449	*/
c230e938	450	get_legacy_evp_names(0, nid, pem_name, arg);
05aed12f RL	451	break;
	452	default:
	453	/* Use the short name of the base nid as the common reference */
c230e938	454	get_legacy_evp_names(base_nid, nid, pem_name, arg);
05aed12f RL	455	}
	456	}
	457	}
437ad983 RL	458	}
	459	#endif
	460
	461	/*-
	462	* Constructors / destructors
	463	* ==========================
	464	*/
	465
b4250010	466	OSSL_NAMEMAP ossl_namemap_stored(OSSL_LIB_CTX libctx)
437ad983	467	{
cd3f8c1b RS	468	#ifndef FIPS_MODULE
	469	int nms;
	470	#endif
437ad983	471	OSSL_NAMEMAP *namemap =
b4250010 DMSP	472	ossl_lib_ctx_get_data(libctx, OSSL_LIB_CTX_NAMEMAP_INDEX,
b4250010 DMSP	473	&stored_namemap_method);
437ad983	474
cd3f8c1b RS	475	if (namemap == NULL)
	476	return NULL;
	477
f844f9eb	478	#ifndef FIPS_MODULE
cd3f8c1b RS	479	nms = ossl_namemap_empty(namemap);
	480	if (nms < 0) {
	481	/*
	482	* Could not get lock to make the count, so maybe internal objects
	483	* weren't added. This seems safest.
	484	*/
	485	return NULL;
	486	}
	487	if (nms == 1) {
05aed12f RL	488	int i, end;
05aed12f RL	489
437ad983 RL	490	/* Before pilfering, we make sure the legacy database is populated */
	491	OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS
	492	\| OPENSSL_INIT_ADD_ALL_DIGESTS, NULL);
	493
	494	OBJ_NAME_do_all(OBJ_NAME_TYPE_CIPHER_METH,
	495	get_legacy_cipher_names, namemap);
	496	OBJ_NAME_do_all(OBJ_NAME_TYPE_MD_METH,
	497	get_legacy_md_names, namemap);
05aed12f RL	498
	499	/* We also pilfer data from the legacy EVP_PKEY_ASN1_METHODs */
	500	for (i = 0, end = EVP_PKEY_asn1_get_count(); i < end; i++)
	501	get_legacy_pkey_meth_names(EVP_PKEY_asn1_get0(i), namemap);
437ad983 RL	502	}
	503	#endif
	504
	505	return namemap;
	506	}
	507
	508	OSSL_NAMEMAP *ossl_namemap_new(void)
	509	{
	510	OSSL_NAMEMAP *namemap;
	511
	512	if ((namemap = OPENSSL_zalloc(sizeof(*namemap))) != NULL
	513	&& (namemap->lock = CRYPTO_THREAD_lock_new()) != NULL
	514	&& (namemap->namenum =
	515	lh_NAMENUM_ENTRY_new(namenum_hash, namenum_cmp)) != NULL)
	516	return namemap;
	517
	518	ossl_namemap_free(namemap);
	519	return NULL;
	520	}
	521
	522	void ossl_namemap_free(OSSL_NAMEMAP *namemap)
	523	{
	524	if (namemap == NULL \|\| namemap->stored)
	525	return;
	526
	527	lh_NAMENUM_ENTRY_doall(namemap->namenum, namenum_free);
	528	lh_NAMENUM_ENTRY_free(namemap->namenum);
	529
	530	CRYPTO_THREAD_lock_free(namemap->lock);
	531	OPENSSL_free(namemap);
	532	}