[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"      /* openssl_lh_strcasehash */
#include "internal/tsan_assist.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 */

#ifdef tsan_ld_acq
    TSAN_QUALIFIER int max_number;     /* Current max number TSAN version */
#else
    int max_number;                    /* Current max number plain version */
#endif
};

/* LHASH callbacks */

static unsigned long namenum_hash(const NAMENUM_ENTRY *n)
{
    return openssl_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 = {
    stored_namemap_new,
    stored_namemap_free,
};

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

int ossl_namemap_empty(OSSL_NAMEMAP *namemap)
{
#ifdef tsan_ld_acq
    /* Have TSAN support */
    return namemap == NULL || tsan_load(&namemap->max_number) == 0;
#else
    /* 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;
#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;

    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(const char *main_name, const char *alias,
                                 void *arg)
{
    int main_id = ossl_namemap_add_name(arg, 0, main_name);

    /*
     * We could check that the returned value is the same as main_id,
     * but since this is a void function, there's no sane way to report
     * the error.  The best we can do is trust ourselve to keep the legacy
     * method database conflict free.
     *
     * This registers any alias with the same number as the main name.
     * Should it be that the current |on| *has* the main name, this is
     * simply a no-op.
     */
    if (alias != NULL) {
        (void)ossl_namemap_add_name(arg, main_id, alias);
    }
}

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

    get_legacy_evp_names(EVP_CIPHER_name(cipher), on->name, 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);
    /* We don't want the pkey_type names, so we need some extra care */
    int snid, lnid;

    snid = OBJ_sn2nid(on->name);
    lnid = OBJ_ln2nid(on->name);
    if (snid != EVP_MD_pkey_type(md) && lnid != EVP_MD_pkey_type(md))
        get_legacy_evp_names(EVP_MD_name(md), on->name, arg);
    else
        get_legacy_evp_names(EVP_MD_name(md), NULL, 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) {
        /* 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);
    }
#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>
25f2138b	13	#include "crypto/lhash.h" /* openssl_lh_strcasehash */
c720fc35	14	#include "internal/tsan_assist.h"
f2182a4e	15
651d4418 RL	16	/*-
	17	* The namenum entry
	18	* =================
	19	*/
f2182a4e	20	typedef struct {
651d4418	21	char *name;
f2182a4e	22	int number;
651d4418	23	} NAMENUM_ENTRY;
f2182a4e	24
651d4418	25	DEFINE_LHASH_OF(NAMENUM_ENTRY);
f2182a4e	26
651d4418 RL	27	/*-
	28	* The namemap itself
	29	* ==================
	30	*/
f2182a4e RL	31
	32	struct ossl_namemap_st {
	33	/* Flags */
	34	unsigned int stored:1; /* If 1, it's stored in a library context */
	35
	36	CRYPTO_RWLOCK *lock;
651d4418	37	LHASH_OF(NAMENUM_ENTRY) namenum; / Name->number mapping */
c720fc35 P	38
	39	#ifdef tsan_ld_acq
	40	TSAN_QUALIFIER int max_number; /* Current max number TSAN version */
	41	#else
	42	int max_number; /* Current max number plain version */
	43	#endif
f2182a4e RL	44	};
	45
	46	/* LHASH callbacks */
	47
651d4418	48	static unsigned long namenum_hash(const NAMENUM_ENTRY *n)
f2182a4e	49	{
a9550b74	50	return openssl_lh_strcasehash(n->name);
f2182a4e RL	51	}
f2182a4e RL	52
651d4418	53	static int namenum_cmp(const NAMENUM_ENTRY a, const NAMENUM_ENTRY b)
f2182a4e	54	{
a9550b74	55	return strcasecmp(a->name, b->name);
f2182a4e RL	56	}
f2182a4e RL	57
651d4418	58	static void namenum_free(NAMENUM_ENTRY *n)
f2182a4e	59	{
651d4418 RL	60	if (n != NULL)
651d4418 RL	61	OPENSSL_free(n->name);
f2182a4e RL	62	OPENSSL_free(n);
	63	}
	64
b4250010	65	/* OSSL_LIB_CTX_METHOD functions for a namemap stored in a library context */
f2182a4e	66
b4250010	67	static void stored_namemap_new(OSSL_LIB_CTX libctx)
f2182a4e RL	68	{
	69	OSSL_NAMEMAP *namemap = ossl_namemap_new();
	70
	71	if (namemap != NULL)
	72	namemap->stored = 1;
	73
	74	return namemap;
	75	}
	76
	77	static void stored_namemap_free(void *vnamemap)
	78	{
	79	OSSL_NAMEMAP *namemap = vnamemap;
	80
bd65afdb P	81	if (namemap != NULL) {
	82	/* Pretend it isn't stored, or ossl_namemap_free() will do nothing */
	83	namemap->stored = 0;
	84	ossl_namemap_free(namemap);
	85	}
f2182a4e RL	86	}
f2182a4e RL	87
b4250010	88	static const OSSL_LIB_CTX_METHOD stored_namemap_method = {
f2182a4e RL	89	stored_namemap_new,
	90	stored_namemap_free,
	91	};
	92
651d4418 RL	93	/*-
	94	* API functions
	95	* =============
	96	*/
f2182a4e	97
6a835fcf RL	98	int ossl_namemap_empty(OSSL_NAMEMAP *namemap)
6a835fcf RL	99	{
c720fc35 P	100	#ifdef tsan_ld_acq
	101	/* Have TSAN support */
	102	return namemap == NULL \|\| tsan_load(&namemap->max_number) == 0;
	103	#else
	104	/* No TSAN support */
	105	int rv;
	106
	107	if (namemap == NULL)
	108	return 1;
6a835fcf	109
cd3f8c1b RS	110	if (!CRYPTO_THREAD_read_lock(namemap->lock))
cd3f8c1b RS	111	return -1;
c720fc35	112	rv = namemap->max_number == 0;
6a835fcf	113	CRYPTO_THREAD_unlock(namemap->lock);
6a835fcf	114	return rv;
c720fc35	115	#endif
6a835fcf RL	116	}
6a835fcf RL	117
651d4418 RL	118	typedef struct doall_names_data_st {
651d4418 RL	119	int number;
d84f5515 MC	120	const char **names;
d84f5515 MC	121	int found;
651d4418	122	} DOALL_NAMES_DATA;
f2182a4e	123
651d4418	124	static void do_name(const NAMENUM_ENTRY namenum, DOALL_NAMES_DATA data)
f2182a4e	125	{
651d4418	126	if (namenum->number == data->number)
d84f5515	127	data->names[data->found++] = namenum->name;
651d4418	128	}
f2182a4e	129
651d4418	130	IMPLEMENT_LHASH_DOALL_ARG_CONST(NAMENUM_ENTRY, DOALL_NAMES_DATA);
f2182a4e	131
d84f5515 MC	132	/*
	133	* Call the callback for all names in the namemap with the given number.
	134	* A return value 1 means that the callback was called for all names. A
	135	* return value of 0 means that the callback was not called for any names.
	136	*/
	137	int ossl_namemap_doall_names(const OSSL_NAMEMAP *namemap, int number,
	138	void (fn)(const char name, void *data),
	139	void *data)
651d4418 RL	140	{
651d4418 RL	141	DOALL_NAMES_DATA cbdata;
d84f5515 MC	142	size_t num_names;
d84f5515 MC	143	int i;
f2182a4e	144
651d4418	145	cbdata.number = number;
d84f5515 MC	146	cbdata.found = 0;
	147
	148	/*
	149	* We collect all the names first under a read lock. Subsequently we call
	150	* the user function, so that we're not holding the read lock when in user
	151	* code. This could lead to deadlocks.
	152	*/
cd3f8c1b RS	153	if (!CRYPTO_THREAD_read_lock(namemap->lock))
cd3f8c1b RS	154	return 0;
d84f5515	155
cd3f8c1b	156	num_names = lh_NAMENUM_ENTRY_num_items(namemap->namenum);
d84f5515 MC	157	if (num_names == 0) {
	158	CRYPTO_THREAD_unlock(namemap->lock);
	159	return 0;
	160	}
	161	cbdata.names = OPENSSL_malloc(sizeof(cbdata.names) num_names);
	162	if (cbdata.names == NULL) {
	163	CRYPTO_THREAD_unlock(namemap->lock);
	164	return 0;
	165	}
651d4418 RL	166	lh_NAMENUM_ENTRY_doall_DOALL_NAMES_DATA(namemap->namenum, do_name,
651d4418 RL	167	&cbdata);
f2182a4e	168	CRYPTO_THREAD_unlock(namemap->lock);
d84f5515 MC	169
	170	for (i = 0; i < cbdata.found; i++)
	171	fn(cbdata.names[i], data);
	172
	173	OPENSSL_free(cbdata.names);
	174	return 1;
f2182a4e RL	175	}
f2182a4e RL	176
79410c5f P	177	static int namemap_name2num_n(const OSSL_NAMEMAP *namemap,
	178	const char *name, size_t name_len)
	179	{
	180	NAMENUM_ENTRY *namenum_entry, namenum_tmpl;
	181
	182	if ((namenum_tmpl.name = OPENSSL_strndup(name, name_len)) == NULL)
	183	return 0;
	184	namenum_tmpl.number = 0;
	185	namenum_entry =
	186	lh_NAMENUM_ENTRY_retrieve(namemap->namenum, &namenum_tmpl);
	187	OPENSSL_free(namenum_tmpl.name);
	188	return namenum_entry != NULL ? namenum_entry->number : 0;
	189	}
	190
695d195b RL	191	int ossl_namemap_name2num_n(const OSSL_NAMEMAP *namemap,
695d195b RL	192	const char *name, size_t name_len)
f2182a4e	193	{
79410c5f	194	int number;
f2182a4e	195
f844f9eb	196	#ifndef FIPS_MODULE
f2182a4e RL	197	if (namemap == NULL)
	198	namemap = ossl_namemap_stored(NULL);
	199	#endif
	200
	201	if (namemap == NULL)
	202	return 0;
	203
cd3f8c1b RS	204	if (!CRYPTO_THREAD_read_lock(namemap->lock))
cd3f8c1b RS	205	return 0;
79410c5f	206	number = namemap_name2num_n(namemap, name, name_len);
f2182a4e RL	207	CRYPTO_THREAD_unlock(namemap->lock);
f2182a4e RL	208
651d4418	209	return number;
f2182a4e RL	210	}
f2182a4e RL	211
695d195b RL	212	int ossl_namemap_name2num(const OSSL_NAMEMAP namemap, const char name)
	213	{
	214	if (name == NULL)
	215	return 0;
	216
	217	return ossl_namemap_name2num_n(namemap, name, strlen(name));
	218	}
	219
f7c16d48 RL	220	struct num2name_data_st {
	221	size_t idx; /* Countdown */
	222	const char name; / Result */
	223	};
	224
	225	static void do_num2name(const char name, void vdata)
	226	{
	227	struct num2name_data_st *data = vdata;
	228
	229	if (data->idx > 0)
	230	data->idx--;
	231	else if (data->name == NULL)
	232	data->name = name;
	233	}
	234
	235	const char ossl_namemap_num2name(const OSSL_NAMEMAP namemap, int number,
	236	size_t idx)
	237	{
	238	struct num2name_data_st data;
	239
	240	data.idx = idx;
	241	data.name = NULL;
d84f5515 MC	242	if (!ossl_namemap_doall_names(namemap, number, do_num2name, &data))
d84f5515 MC	243	return NULL;
f7c16d48 RL	244	return data.name;
	245	}
	246
79410c5f P	247	static int namemap_add_name_n(OSSL_NAMEMAP *namemap, int number,
79410c5f P	248	const char *name, size_t name_len)
f2182a4e	249	{
651d4418 RL	250	NAMENUM_ENTRY *namenum = NULL;
651d4418 RL	251	int tmp_number;
f2182a4e	252
79410c5f P	253	/* If it already exists, we don't add it */
	254	if ((tmp_number = namemap_name2num_n(namemap, name, name_len)) != 0)
	255	return tmp_number;
f2182a4e	256
651d4418	257	if ((namenum = OPENSSL_zalloc(sizeof(*namenum))) == NULL
695d195b	258	\|\| (namenum->name = OPENSSL_strndup(name, name_len)) == NULL)
f2182a4e RL	259	goto err;
f2182a4e RL	260
79410c5f	261	namenum->number =
c720fc35	262	number != 0 ? number : 1 + tsan_counter(&namemap->max_number);
651d4418 RL	263	(void)lh_NAMENUM_ENTRY_insert(namemap->namenum, namenum);
	264
	265	if (lh_NAMENUM_ENTRY_error(namemap->namenum))
f2182a4e	266	goto err;
79410c5f	267	return namenum->number;
f2182a4e RL	268
f2182a4e RL	269	err:
651d4418	270	namenum_free(namenum);
79410c5f P	271	return 0;
79410c5f P	272	}
651d4418	273
79410c5f P	274	int ossl_namemap_add_name_n(OSSL_NAMEMAP *namemap, int number,
	275	const char *name, size_t name_len)
	276	{
	277	int tmp_number;
	278
	279	#ifndef FIPS_MODULE
	280	if (namemap == NULL)
	281	namemap = ossl_namemap_stored(NULL);
	282	#endif
	283
	284	if (name == NULL \|\| name_len == 0 \|\| namemap == NULL)
	285	return 0;
	286
cd3f8c1b RS	287	if (!CRYPTO_THREAD_write_lock(namemap->lock))
cd3f8c1b RS	288	return 0;
79410c5f	289	tmp_number = namemap_add_name_n(namemap, number, name, name_len);
651d4418	290	CRYPTO_THREAD_unlock(namemap->lock);
79410c5f	291	return tmp_number;
f2182a4e	292	}
695d195b	293
3d83c735	294	int ossl_namemap_add_name(OSSL_NAMEMAP namemap, int number, const char name)
695d195b RL	295	{
	296	if (name == NULL)
	297	return 0;
	298
3d83c735 RL	299	return ossl_namemap_add_name_n(namemap, number, name, strlen(name));
	300	}
	301
	302	int ossl_namemap_add_names(OSSL_NAMEMAP *namemap, int number,
	303	const char *names, const char separator)
	304	{
	305	const char p, q;
	306	size_t l;
	307
	308	/* Check that we have a namemap */
	309	if (!ossl_assert(namemap != NULL)) {
	310	ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
	311	return 0;
	312	}
	313
cd3f8c1b RS	314	if (!CRYPTO_THREAD_write_lock(namemap->lock))
cd3f8c1b RS	315	return 0;
3d83c735 RL	316	/*
	317	* Check that no name is an empty string, and that all names have at
	318	* most one numeric identity together.
	319	*/
	320	for (p = names; *p != '\0'; p = (q == NULL ? p + l : q + 1)) {
	321	int this_number;
	322
	323	if ((q = strchr(p, separator)) == NULL)
	324	l = strlen(p); /* offset to \0 */
	325	else
	326	l = q - p; /* offset to the next separator */
	327
79410c5f	328	this_number = namemap_name2num_n(namemap, p, l);
3d83c735 RL	329
	330	if (p == '\0' \|\| p == separator) {
	331	ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_BAD_ALGORITHM_NAME);
79410c5f	332	goto err;
3d83c735 RL	333	}
	334	if (number == 0) {
	335	number = this_number;
	336	} else if (this_number != 0 && this_number != number) {
	337	ERR_raise_data(ERR_LIB_CRYPTO, CRYPTO_R_CONFLICTING_NAMES,
	338	"\"%.*s\" has an existing different identity %d (from \"%s\")",
	339	l, p, this_number, names);
79410c5f	340	goto err;
3d83c735 RL	341	}
	342	}
	343
	344	/* Now that we have checked, register all names */
	345	for (p = names; *p != '\0'; p = (q == NULL ? p + l : q + 1)) {
	346	int this_number;
	347
	348	if ((q = strchr(p, separator)) == NULL)
	349	l = strlen(p); /* offset to \0 */
	350	else
	351	l = q - p; /* offset to the next separator */
	352
79410c5f	353	this_number = namemap_add_name_n(namemap, number, p, l);
3d83c735 RL	354	if (number == 0) {
	355	number = this_number;
	356	} else if (this_number != number) {
e4a1d023	357	ERR_raise_data(ERR_LIB_CRYPTO, ERR_R_INTERNAL_ERROR,
3d83c735 RL	358	"Got number %d when expecting %d",
3d83c735 RL	359	this_number, number);
79410c5f	360	goto err;
3d83c735 RL	361	}
	362	}
	363
79410c5f	364	CRYPTO_THREAD_unlock(namemap->lock);
3d83c735	365	return number;
79410c5f P	366
	367	err:
	368	CRYPTO_THREAD_unlock(namemap->lock);
	369	return 0;
695d195b	370	}
437ad983 RL	371
	372	/*-
	373	* Pre-population
	374	* ==============
	375	*/
	376
f844f9eb	377	#ifndef FIPS_MODULE
437ad983 RL	378	#include <openssl/evp.h>
	379
	380	/* Creates an initial namemap with names found in the legacy method db */
	381	static void get_legacy_evp_names(const char main_name, const char alias,
	382	void *arg)
	383	{
	384	int main_id = ossl_namemap_add_name(arg, 0, main_name);
	385
	386	/*
	387	* We could check that the returned value is the same as main_id,
	388	* but since this is a void function, there's no sane way to report
	389	* the error. The best we can do is trust ourselve to keep the legacy
	390	* method database conflict free.
	391	*
	392	* This registers any alias with the same number as the main name.
	393	* Should it be that the current \|on\| has the main name, this is
	394	* simply a no-op.
	395	*/
	396	if (alias != NULL) {
	397	(void)ossl_namemap_add_name(arg, main_id, alias);
	398	}
	399	}
	400
	401	static void get_legacy_cipher_names(const OBJ_NAME on, void arg)
	402	{
	403	const EVP_CIPHER cipher = (void )OBJ_NAME_get(on->name, on->type);
	404
	405	get_legacy_evp_names(EVP_CIPHER_name(cipher), on->name, arg);
	406	}
	407
	408	static void get_legacy_md_names(const OBJ_NAME on, void arg)
	409	{
	410	const EVP_MD md = (void )OBJ_NAME_get(on->name, on->type);
	411	/* We don't want the pkey_type names, so we need some extra care */
	412	int snid, lnid;
	413
	414	snid = OBJ_sn2nid(on->name);
	415	lnid = OBJ_ln2nid(on->name);
	416	if (snid != EVP_MD_pkey_type(md) && lnid != EVP_MD_pkey_type(md))
	417	get_legacy_evp_names(EVP_MD_name(md), on->name, arg);
	418	else
	419	get_legacy_evp_names(EVP_MD_name(md), NULL, arg);
	420	}
	421	#endif
	422
	423	/*-
	424	* Constructors / destructors
	425	* ==========================
	426	*/
	427
b4250010	428	OSSL_NAMEMAP ossl_namemap_stored(OSSL_LIB_CTX libctx)
437ad983	429	{
cd3f8c1b RS	430	#ifndef FIPS_MODULE
	431	int nms;
	432	#endif
437ad983	433	OSSL_NAMEMAP *namemap =
b4250010 DMSP	434	ossl_lib_ctx_get_data(libctx, OSSL_LIB_CTX_NAMEMAP_INDEX,
b4250010 DMSP	435	&stored_namemap_method);
437ad983	436
cd3f8c1b RS	437	if (namemap == NULL)
	438	return NULL;
	439
f844f9eb	440	#ifndef FIPS_MODULE
cd3f8c1b RS	441	nms = ossl_namemap_empty(namemap);
	442	if (nms < 0) {
	443	/*
	444	* Could not get lock to make the count, so maybe internal objects
	445	* weren't added. This seems safest.
	446	*/
	447	return NULL;
	448	}
	449	if (nms == 1) {
437ad983 RL	450	/* Before pilfering, we make sure the legacy database is populated */
	451	OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS
	452	\| OPENSSL_INIT_ADD_ALL_DIGESTS, NULL);
	453
	454	OBJ_NAME_do_all(OBJ_NAME_TYPE_CIPHER_METH,
	455	get_legacy_cipher_names, namemap);
	456	OBJ_NAME_do_all(OBJ_NAME_TYPE_MD_METH,
	457	get_legacy_md_names, namemap);
	458	}
	459	#endif
	460
	461	return namemap;
	462	}
	463
	464	OSSL_NAMEMAP *ossl_namemap_new(void)
	465	{
	466	OSSL_NAMEMAP *namemap;
	467
	468	if ((namemap = OPENSSL_zalloc(sizeof(*namemap))) != NULL
	469	&& (namemap->lock = CRYPTO_THREAD_lock_new()) != NULL
	470	&& (namemap->namenum =
	471	lh_NAMENUM_ENTRY_new(namenum_hash, namenum_cmp)) != NULL)
	472	return namemap;
	473
	474	ossl_namemap_free(namemap);
	475	return NULL;
	476	}
	477
	478	void ossl_namemap_free(OSSL_NAMEMAP *namemap)
	479	{
	480	if (namemap == NULL \|\| namemap->stored)
	481	return;
	482
	483	lh_NAMENUM_ENTRY_doall(namemap->namenum, namenum_free);
	484	lh_NAMENUM_ENTRY_free(namemap->namenum);
	485
	486	CRYPTO_THREAD_lock_free(namemap->lock);
	487	OPENSSL_free(namemap);
	488	}