[thirdparty/openssl.git] / providers / default / defltprov.c

/*
 * Copyright 2019 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 <string.h>
#include <stdio.h>
#include <openssl/opensslconf.h>
#include <openssl/core.h>
#include <openssl/core_numbers.h>
#include <openssl/core_names.h>
#include <openssl/params.h>
#include "internal/provider_algs.h"

/* Functions provided by the core */
static OSSL_core_gettable_params_fn *c_gettable_params = NULL;
static OSSL_core_get_params_fn *c_get_params = NULL;

/* Parameters we provide to the core */
static const OSSL_PARAM deflt_param_types[] = {
    OSSL_PARAM_DEFN(OSSL_PROV_PARAM_NAME, OSSL_PARAM_UTF8_PTR, NULL, 0),
    OSSL_PARAM_DEFN(OSSL_PROV_PARAM_VERSION, OSSL_PARAM_UTF8_PTR, NULL, 0),
    OSSL_PARAM_DEFN(OSSL_PROV_PARAM_BUILDINFO, OSSL_PARAM_UTF8_PTR, NULL, 0),
    OSSL_PARAM_END
};

static const OSSL_PARAM *deflt_gettable_params(const OSSL_PROVIDER *prov)
{
    return deflt_param_types;
}

static int deflt_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[])
{
    OSSL_PARAM *p;

    p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_NAME);
    if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, "OpenSSL Default Provider"))
        return 0;
    p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_VERSION);
    if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_VERSION_STR))
        return 0;
    p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_BUILDINFO);
    if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_FULL_VERSION_STR))
        return 0;

    return 1;
}

static const OSSL_ALGORITHM deflt_digests[] = {
    { "SHA1", "default=yes", sha1_functions },

    { "SHA224", "default=yes", sha224_functions },
    { "SHA256", "default=yes", sha256_functions },
    { "SHA384", "default=yes", sha384_functions },
    { "SHA512", "default=yes", sha512_functions },
    { "SHA512-224", "default=yes", sha512_224_functions },
    { "SHA512-256", "default=yes", sha512_256_functions },

    { "SHA3-224", "default=yes", sha3_224_functions },
    { "SHA3-256", "default=yes", sha3_256_functions },
    { "SHA3-384", "default=yes", sha3_384_functions },
    { "SHA3-512", "default=yes", sha3_512_functions },

    /*
     * KMAC128 and KMAC256 as hashes are mostly useful for the MACs with the
     * same names
     */
    { "KMAC128", "default=yes", keccak_kmac_128_functions },
    { "KMAC256", "default=yes", keccak_kmac_256_functions },

    { "SHAKE128", "default=yes", shake_128_functions },
    { "SHAKE256", "default=yes", shake_256_functions },

#ifndef OPENSSL_NO_BLAKE2
    { "BLAKE2s256", "default=yes", blake2s256_functions },
    { "BLAKE2b512", "default=yes", blake2b512_functions },
#endif /* OPENSSL_NO_BLAKE2 */

#ifndef OPENSSL_NO_SM3
    { "SM3", "default=yes", sm3_functions },
#endif /* OPENSSL_NO_SM3 */

#ifndef OPENSSL_NO_MD5
    { "MD5", "default=yes", md5_functions },
    { "MD5-SHA1", "default=yes", md5_sha1_functions },
#endif /* OPENSSL_NO_MD5 */

    /*{ "UNDEF", "default=yes", nullmd_functions }, */

    { NULL, NULL, NULL }
};

static const OSSL_ALGORITHM deflt_ciphers[] = {
    { "AES-256-ECB", "default=yes", aes256ecb_functions },
    { "AES-192-ECB", "default=yes", aes192ecb_functions },
    { "AES-128-ECB", "default=yes", aes128ecb_functions },
    { "AES-256-CBC", "default=yes", aes256cbc_functions },
    { "AES-192-CBC", "default=yes", aes192cbc_functions },
    { "AES-128-CBC", "default=yes", aes128cbc_functions },
    { "AES-256-OFB", "default=yes", aes256ofb_functions },
    { "AES-192-OFB", "default=yes", aes192ofb_functions },
    { "AES-128-OFB", "default=yes", aes128ofb_functions },
    { "AES-256-CFB", "default=yes", aes256cfb_functions },
    { "AES-192-CFB", "default=yes", aes192cfb_functions },
    { "AES-128-CFB", "default=yes", aes128cfb_functions },
    { "AES-256-CFB1", "default=yes", aes256cfb1_functions },
    { "AES-192-CFB1", "default=yes", aes192cfb1_functions },
    { "AES-128-CFB1", "default=yes", aes128cfb1_functions },
    { "AES-256-CFB8", "default=yes", aes256cfb8_functions },
    { "AES-192-CFB8", "default=yes", aes192cfb8_functions },
    { "AES-128-CFB8", "default=yes", aes128cfb8_functions },
    { "AES-256-CTR", "default=yes", aes256ctr_functions },
    { "AES-192-CTR", "default=yes", aes192ctr_functions },
    { "AES-128-CTR", "default=yes", aes128ctr_functions },
    { "id-aes256-GCM", "default=yes", aes256gcm_functions },
    { "id-aes192-GCM", "default=yes", aes192gcm_functions },
    { "id-aes128-GCM", "default=yes", aes128gcm_functions },
#ifndef OPENSSL_NO_ARIA
    { "ARIA-256-GCM", "default=yes", aria256gcm_functions },
    { "ARIA-192-GCM", "default=yes", aria192gcm_functions },
    { "ARIA-128-GCM", "default=yes", aria128gcm_functions },
#endif /* OPENSSL_NO_ARIA */
    { NULL, NULL, NULL }
};

static const OSSL_ALGORITHM deflt_macs[] = {
#ifndef OPENSSL_NO_BLAKE2
    { "BLAKE2BMAC", "default=yes", blake2bmac_functions },
    { "BLAKE2SMAC", "default=yes", blake2smac_functions },
#endif
#ifndef OPENSSL_NO_CMAC
    { "CMAC", "default=yes", cmac_functions },
#endif
    { "GMAC", "default=yes", gmac_functions },
    { "HMAC", "default=yes", hmac_functions },
    { "KMAC128", "default=yes", kmac128_functions },
    { "KMAC256", "default=yes", kmac256_functions },
    { NULL, NULL, NULL }
};

static const OSSL_ALGORITHM deflt_keyexch[] = {
#ifndef OPENSSL_NO_DH
    { "dhKeyAgreement", "default=yes", dh_keyexch_functions },
#endif
    { NULL, NULL, NULL }
};

static const OSSL_ALGORITHM deflt_keymgmt[] = {
#ifndef OPENSSL_NO_DH
    { "dhKeyAgreement", "default=yes", dh_keymgmt_functions },
#endif
    { NULL, NULL, NULL }
};

static const OSSL_ALGORITHM *deflt_query(OSSL_PROVIDER *prov,
                                         int operation_id,
                                         int *no_cache)
{
    *no_cache = 0;
    switch (operation_id) {
    case OSSL_OP_DIGEST:
        return deflt_digests;
    case OSSL_OP_CIPHER:
        return deflt_ciphers;
    case OSSL_OP_MAC:
        return deflt_macs;
    case OSSL_OP_KEYMGMT:
        return deflt_keymgmt;
    case OSSL_OP_KEYEXCH:
        return deflt_keyexch;
    }
    return NULL;
}

/* Functions we provide to the core */
static const OSSL_DISPATCH deflt_dispatch_table[] = {
    { OSSL_FUNC_PROVIDER_GETTABLE_PARAMS, (void (*)(void))deflt_gettable_params },
    { OSSL_FUNC_PROVIDER_GET_PARAMS, (void (*)(void))deflt_get_params },
    { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))deflt_query },
    { 0, NULL }
};

OSSL_provider_init_fn ossl_default_provider_init;

int ossl_default_provider_init(const OSSL_PROVIDER *provider,
                               const OSSL_DISPATCH *in,
                               const OSSL_DISPATCH **out,
                               void **provctx)
{
    OSSL_core_get_library_context_fn *c_get_libctx = NULL;

    for (; in->function_id != 0; in++) {
        switch (in->function_id) {
        case OSSL_FUNC_CORE_GETTABLE_PARAMS:
            c_gettable_params = OSSL_get_core_gettable_params(in);
            break;
        case OSSL_FUNC_CORE_GET_PARAMS:
            c_get_params = OSSL_get_core_get_params(in);
            break;
        case OSSL_FUNC_CORE_GET_LIBRARY_CONTEXT:
            c_get_libctx = OSSL_get_core_get_library_context(in);
            break;
        default:
            /* Just ignore anything we don't understand */
            break;
        }
    }

    if (c_get_libctx == NULL)
        return 0;

    *out = deflt_dispatch_table;

    /*
     * We want to make sure that all calls from this provider that requires
     * a library context use the same context as the one used to call our
     * functions.  We do that by passing it along as the provider context.
     */
    *provctx = c_get_libctx(provider);
    return 1;
}
Commit	Line	Data
8a73348b MC	1	/*
	2	* Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
	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
	10	#include <string.h>
	11	#include <stdio.h>
55a0a117	12	#include <openssl/opensslconf.h>
8a73348b MC	13	#include <openssl/core.h>
	14	#include <openssl/core_numbers.h>
	15	#include <openssl/core_names.h>
	16	#include <openssl/params.h>
861b8f87	17	#include "internal/provider_algs.h"
8a73348b MC	18
8a73348b MC	19	/* Functions provided by the core */
dca97d00	20	static OSSL_core_gettable_params_fn *c_gettable_params = NULL;
8a73348b MC	21	static OSSL_core_get_params_fn *c_get_params = NULL;
	22
	23	/* Parameters we provide to the core */
26175013 RL	24	static const OSSL_PARAM deflt_param_types[] = {
	25	OSSL_PARAM_DEFN(OSSL_PROV_PARAM_NAME, OSSL_PARAM_UTF8_PTR, NULL, 0),
	26	OSSL_PARAM_DEFN(OSSL_PROV_PARAM_VERSION, OSSL_PARAM_UTF8_PTR, NULL, 0),
	27	OSSL_PARAM_DEFN(OSSL_PROV_PARAM_BUILDINFO, OSSL_PARAM_UTF8_PTR, NULL, 0),
	28	OSSL_PARAM_END
8a73348b MC	29	};
8a73348b MC	30
dca97d00	31	static const OSSL_PARAM deflt_gettable_params(const OSSL_PROVIDER prov)
8a73348b MC	32	{
	33	return deflt_param_types;
	34	}
	35
4e7991b4	36	static int deflt_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[])
8a73348b	37	{
4e7991b4	38	OSSL_PARAM *p;
8a73348b MC	39
	40	p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_NAME);
	41	if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, "OpenSSL Default Provider"))
	42	return 0;
	43	p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_VERSION);
	44	if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_VERSION_STR))
	45	return 0;
	46	p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_BUILDINFO);
	47	if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_FULL_VERSION_STR))
	48	return 0;
	49
	50	return 1;
	51	}
	52
de29ff17	53	static const OSSL_ALGORITHM deflt_digests[] = {
d5e5e2ff SL	54	{ "SHA1", "default=yes", sha1_functions },
	55
	56	{ "SHA224", "default=yes", sha224_functions },
de29ff17	57	{ "SHA256", "default=yes", sha256_functions },
d5e5e2ff SL	58	{ "SHA384", "default=yes", sha384_functions },
	59	{ "SHA512", "default=yes", sha512_functions },
	60	{ "SHA512-224", "default=yes", sha512_224_functions },
	61	{ "SHA512-256", "default=yes", sha512_256_functions },
	62
	63	{ "SHA3-224", "default=yes", sha3_224_functions },
	64	{ "SHA3-256", "default=yes", sha3_256_functions },
	65	{ "SHA3-384", "default=yes", sha3_384_functions },
	66	{ "SHA3-512", "default=yes", sha3_512_functions },
	67
e23cda00 RL	68	/*
	69	* KMAC128 and KMAC256 as hashes are mostly useful for the MACs with the
	70	* same names
	71	*/
d5e5e2ff SL	72	{ "KMAC128", "default=yes", keccak_kmac_128_functions },
	73	{ "KMAC256", "default=yes", keccak_kmac_256_functions },
	74
	75	{ "SHAKE128", "default=yes", shake_128_functions },
	76	{ "SHAKE256", "default=yes", shake_256_functions },
	77
	78	#ifndef OPENSSL_NO_BLAKE2
	79	{ "BLAKE2s256", "default=yes", blake2s256_functions },
	80	{ "BLAKE2b512", "default=yes", blake2b512_functions },
	81	#endif /* OPENSSL_NO_BLAKE2 */
	82
	83	#ifndef OPENSSL_NO_SM3
	84	{ "SM3", "default=yes", sm3_functions },
	85	#endif /* OPENSSL_NO_SM3 */
	86
	87	#ifndef OPENSSL_NO_MD5
	88	{ "MD5", "default=yes", md5_functions },
	89	{ "MD5-SHA1", "default=yes", md5_sha1_functions },
	90	#endif /* OPENSSL_NO_MD5 */
	91
	92	/{ "UNDEF", "default=yes", nullmd_functions }, /
	93
de29ff17 MC	94	{ NULL, NULL, NULL }
	95	};
	96
aab26e6f MC	97	static const OSSL_ALGORITHM deflt_ciphers[] = {
aab26e6f MC	98	{ "AES-256-ECB", "default=yes", aes256ecb_functions },
f4a129bb MC	99	{ "AES-192-ECB", "default=yes", aes192ecb_functions },
f4a129bb MC	100	{ "AES-128-ECB", "default=yes", aes128ecb_functions },
718b133a MC	101	{ "AES-256-CBC", "default=yes", aes256cbc_functions },
	102	{ "AES-192-CBC", "default=yes", aes192cbc_functions },
	103	{ "AES-128-CBC", "default=yes", aes128cbc_functions },
ed98df51 MC	104	{ "AES-256-OFB", "default=yes", aes256ofb_functions },
	105	{ "AES-192-OFB", "default=yes", aes192ofb_functions },
	106	{ "AES-128-OFB", "default=yes", aes128ofb_functions },
75dd6d64 MC	107	{ "AES-256-CFB", "default=yes", aes256cfb_functions },
	108	{ "AES-192-CFB", "default=yes", aes192cfb_functions },
	109	{ "AES-128-CFB", "default=yes", aes128cfb_functions },
	110	{ "AES-256-CFB1", "default=yes", aes256cfb1_functions },
	111	{ "AES-192-CFB1", "default=yes", aes192cfb1_functions },
	112	{ "AES-128-CFB1", "default=yes", aes128cfb1_functions },
	113	{ "AES-256-CFB8", "default=yes", aes256cfb8_functions },
	114	{ "AES-192-CFB8", "default=yes", aes192cfb8_functions },
	115	{ "AES-128-CFB8", "default=yes", aes128cfb8_functions },
819a7ae9 MC	116	{ "AES-256-CTR", "default=yes", aes256ctr_functions },
	117	{ "AES-192-CTR", "default=yes", aes192ctr_functions },
	118	{ "AES-128-CTR", "default=yes", aes128ctr_functions },
a672a02a SL	119	{ "id-aes256-GCM", "default=yes", aes256gcm_functions },
	120	{ "id-aes192-GCM", "default=yes", aes192gcm_functions },
	121	{ "id-aes128-GCM", "default=yes", aes128gcm_functions },
	122	#ifndef OPENSSL_NO_ARIA
	123	{ "ARIA-256-GCM", "default=yes", aria256gcm_functions },
	124	{ "ARIA-192-GCM", "default=yes", aria192gcm_functions },
	125	{ "ARIA-128-GCM", "default=yes", aria128gcm_functions },
	126	#endif /* OPENSSL_NO_ARIA */
aab26e6f MC	127	{ NULL, NULL, NULL }
	128	};
	129
55a0a117 RL	130	static const OSSL_ALGORITHM deflt_macs[] = {
	131	#ifndef OPENSSL_NO_BLAKE2
	132	{ "BLAKE2BMAC", "default=yes", blake2bmac_functions },
	133	{ "BLAKE2SMAC", "default=yes", blake2smac_functions },
2e5db6ad RL	134	#endif
	135	#ifndef OPENSSL_NO_CMAC
	136	{ "CMAC", "default=yes", cmac_functions },
55a0a117	137	#endif
d33313be	138	{ "GMAC", "default=yes", gmac_functions },
5183ebdc	139	{ "HMAC", "default=yes", hmac_functions },
e23cda00 RL	140	{ "KMAC128", "default=yes", kmac128_functions },
e23cda00 RL	141	{ "KMAC256", "default=yes", kmac256_functions },
55a0a117 RL	142	{ NULL, NULL, NULL }
	143	};
	144
89e29174	145	static const OSSL_ALGORITHM deflt_keyexch[] = {
76ca35e7	146	#ifndef OPENSSL_NO_DH
8b84b075 RL	147	{ "dhKeyAgreement", "default=yes", dh_keyexch_functions },
	148	#endif
	149	{ NULL, NULL, NULL }
	150	};
	151
	152	static const OSSL_ALGORITHM deflt_keymgmt[] = {
	153	#ifndef OPENSSL_NO_DH
	154	{ "dhKeyAgreement", "default=yes", dh_keymgmt_functions },
76ca35e7	155	#endif
89e29174 MC	156	{ NULL, NULL, NULL }
	157	};
	158
de29ff17 MC	159	static const OSSL_ALGORITHM deflt_query(OSSL_PROVIDER prov,
	160	int operation_id,
	161	int *no_cache)
	162	{
	163	*no_cache = 0;
	164	switch (operation_id) {
	165	case OSSL_OP_DIGEST:
	166	return deflt_digests;
aab26e6f MC	167	case OSSL_OP_CIPHER:
aab26e6f MC	168	return deflt_ciphers;
55a0a117 RL	169	case OSSL_OP_MAC:
55a0a117 RL	170	return deflt_macs;
8b84b075 RL	171	case OSSL_OP_KEYMGMT:
8b84b075 RL	172	return deflt_keymgmt;
89e29174 MC	173	case OSSL_OP_KEYEXCH:
89e29174 MC	174	return deflt_keyexch;
de29ff17 MC	175	}
	176	return NULL;
	177	}
	178
8a73348b MC	179	/* Functions we provide to the core */
8a73348b MC	180	static const OSSL_DISPATCH deflt_dispatch_table[] = {
dca97d00	181	{ OSSL_FUNC_PROVIDER_GETTABLE_PARAMS, (void (*)(void))deflt_gettable_params },
8a73348b	182	{ OSSL_FUNC_PROVIDER_GET_PARAMS, (void (*)(void))deflt_get_params },
de29ff17	183	{ OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))deflt_query },
8a73348b MC	184	{ 0, NULL }
	185	};
	186
	187	OSSL_provider_init_fn ossl_default_provider_init;
	188
	189	int ossl_default_provider_init(const OSSL_PROVIDER *provider,
	190	const OSSL_DISPATCH *in,
a39eb840 RL	191	const OSSL_DISPATCH **out,
a39eb840 RL	192	void **provctx)
8a73348b	193	{
8013a933 RL	194	OSSL_core_get_library_context_fn *c_get_libctx = NULL;
8013a933 RL	195
8a73348b MC	196	for (; in->function_id != 0; in++) {
8a73348b MC	197	switch (in->function_id) {
dca97d00 RL	198	case OSSL_FUNC_CORE_GETTABLE_PARAMS:
dca97d00 RL	199	c_gettable_params = OSSL_get_core_gettable_params(in);
8a73348b MC	200	break;
	201	case OSSL_FUNC_CORE_GET_PARAMS:
	202	c_get_params = OSSL_get_core_get_params(in);
	203	break;
8013a933 RL	204	case OSSL_FUNC_CORE_GET_LIBRARY_CONTEXT:
	205	c_get_libctx = OSSL_get_core_get_library_context(in);
	206	break;
8a73348b MC	207	default:
	208	/* Just ignore anything we don't understand */
	209	break;
	210	}
	211	}
	212
8013a933 RL	213	if (c_get_libctx == NULL)
	214	return 0;
	215
8a73348b	216	*out = deflt_dispatch_table;
8013a933 RL	217
	218	/*
	219	* We want to make sure that all calls from this provider that requires
	220	* a library context use the same context as the one used to call our
	221	* functions. We do that by passing it along as the provider context.
	222	*/
	223	*provctx = c_get_libctx(provider);
8a73348b MC	224	return 1;
8a73348b MC	225	}