[linux.git] / crypto / api.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * Scatterlist Cryptographic API.
 *
 * Copyright (c) 2002 James Morris <[email protected]>
 * Copyright (c) 2002 David S. Miller ([email protected])
 * Copyright (c) 2005 Herbert Xu <[email protected]>
 *
 * Portions derived from Cryptoapi, by Alexander Kjeldaas <[email protected]>
 * and Nettle, by Niels Möller.
 */

#include <linux/err.h>
#include <linux/errno.h>
#include <linux/jump_label.h>
#include <linux/kernel.h>
#include <linux/kmod.h>
#include <linux/module.h>
#include <linux/param.h>
#include <linux/sched/signal.h>
#include <linux/slab.h>
#include <linux/string.h>
#include <linux/completion.h>
#include "internal.h"

LIST_HEAD(crypto_alg_list);
EXPORT_SYMBOL_GPL(crypto_alg_list);
DECLARE_RWSEM(crypto_alg_sem);
EXPORT_SYMBOL_GPL(crypto_alg_sem);

BLOCKING_NOTIFIER_HEAD(crypto_chain);
EXPORT_SYMBOL_GPL(crypto_chain);

DEFINE_STATIC_KEY_FALSE(crypto_boot_test_finished);
EXPORT_SYMBOL_GPL(crypto_boot_test_finished);

static struct crypto_alg *crypto_larval_wait(struct crypto_alg *alg);

struct crypto_alg *crypto_mod_get(struct crypto_alg *alg)
{
	return try_module_get(alg->cra_module) ? crypto_alg_get(alg) : NULL;
}
EXPORT_SYMBOL_GPL(crypto_mod_get);

void crypto_mod_put(struct crypto_alg *alg)
{
	struct module *module = alg->cra_module;

	crypto_alg_put(alg);
	module_put(module);
}
EXPORT_SYMBOL_GPL(crypto_mod_put);

static struct crypto_alg *__crypto_alg_lookup(const char *name, u32 type,
					      u32 mask)
{
	struct crypto_alg *q, *alg = NULL;
	int best = -2;

	list_for_each_entry(q, &crypto_alg_list, cra_list) {
		int exact, fuzzy;

		if (crypto_is_moribund(q))
			continue;

		if ((q->cra_flags ^ type) & mask)
			continue;

		if (crypto_is_larval(q) &&
		    !crypto_is_test_larval((struct crypto_larval *)q) &&
		    ((struct crypto_larval *)q)->mask != mask)
			continue;

		exact = !strcmp(q->cra_driver_name, name);
		fuzzy = !strcmp(q->cra_name, name);
		if (!exact && !(fuzzy && q->cra_priority > best))
			continue;

		if (unlikely(!crypto_mod_get(q)))
			continue;

		best = q->cra_priority;
		if (alg)
			crypto_mod_put(alg);
		alg = q;

		if (exact)
			break;
	}

	return alg;
}

static void crypto_larval_destroy(struct crypto_alg *alg)
{
	struct crypto_larval *larval = (void *)alg;

	BUG_ON(!crypto_is_larval(alg));
	if (!IS_ERR_OR_NULL(larval->adult))
		crypto_mod_put(larval->adult);
	kfree(larval);
}

struct crypto_larval *crypto_larval_alloc(const char *name, u32 type, u32 mask)
{
	struct crypto_larval *larval;

	larval = kzalloc(sizeof(*larval), GFP_KERNEL);
	if (!larval)
		return ERR_PTR(-ENOMEM);

	larval->mask = mask;
	larval->alg.cra_flags = CRYPTO_ALG_LARVAL | type;
	larval->alg.cra_priority = -1;
	larval->alg.cra_destroy = crypto_larval_destroy;

	strlcpy(larval->alg.cra_name, name, CRYPTO_MAX_ALG_NAME);
	init_completion(&larval->completion);

	return larval;
}
EXPORT_SYMBOL_GPL(crypto_larval_alloc);

static struct crypto_alg *crypto_larval_add(const char *name, u32 type,
					    u32 mask)
{
	struct crypto_alg *alg;
	struct crypto_larval *larval;

	larval = crypto_larval_alloc(name, type, mask);
	if (IS_ERR(larval))
		return ERR_CAST(larval);

	refcount_set(&larval->alg.cra_refcnt, 2);

	down_write(&crypto_alg_sem);
	alg = __crypto_alg_lookup(name, type, mask);
	if (!alg) {
		alg = &larval->alg;
		list_add(&alg->cra_list, &crypto_alg_list);
	}
	up_write(&crypto_alg_sem);

	if (alg != &larval->alg) {
		kfree(larval);
		if (crypto_is_larval(alg))
			alg = crypto_larval_wait(alg);
	}

	return alg;
}

void crypto_larval_kill(struct crypto_alg *alg)
{
	struct crypto_larval *larval = (void *)alg;

	down_write(&crypto_alg_sem);
	list_del(&alg->cra_list);
	up_write(&crypto_alg_sem);
	complete_all(&larval->completion);
	crypto_alg_put(alg);
}
EXPORT_SYMBOL_GPL(crypto_larval_kill);

void crypto_wait_for_test(struct crypto_larval *larval)
{
	int err;

	err = crypto_probing_notify(CRYPTO_MSG_ALG_REGISTER, larval->adult);
	if (WARN_ON_ONCE(err != NOTIFY_STOP))
		goto out;

	err = wait_for_completion_killable(&larval->completion);
	WARN_ON(err);
	if (!err)
		crypto_notify(CRYPTO_MSG_ALG_LOADED, larval);

out:
	crypto_larval_kill(&larval->alg);
}
EXPORT_SYMBOL_GPL(crypto_wait_for_test);

static void crypto_start_test(struct crypto_larval *larval)
{
	if (!crypto_is_test_larval(larval))
		return;

	if (larval->test_started)
		return;

	down_write(&crypto_alg_sem);
	if (larval->test_started) {
		up_write(&crypto_alg_sem);
		return;
	}

	larval->test_started = true;
	up_write(&crypto_alg_sem);

	crypto_wait_for_test(larval);
}

static struct crypto_alg *crypto_larval_wait(struct crypto_alg *alg)
{
	struct crypto_larval *larval = (void *)alg;
	long timeout;

	if (!static_branch_likely(&crypto_boot_test_finished))
		crypto_start_test(larval);

	timeout = wait_for_completion_killable_timeout(
		&larval->completion, 60 * HZ);

	alg = larval->adult;
	if (timeout < 0)
		alg = ERR_PTR(-EINTR);
	else if (!timeout)
		alg = ERR_PTR(-ETIMEDOUT);
	else if (!alg)
		alg = ERR_PTR(-ENOENT);
	else if (IS_ERR(alg))
		;
	else if (crypto_is_test_larval(larval) &&
		 !(alg->cra_flags & CRYPTO_ALG_TESTED))
		alg = ERR_PTR(-EAGAIN);
	else if (!crypto_mod_get(alg))
		alg = ERR_PTR(-EAGAIN);
	crypto_mod_put(&larval->alg);

	return alg;
}

static struct crypto_alg *crypto_alg_lookup(const char *name, u32 type,
					    u32 mask)
{
	struct crypto_alg *alg;
	u32 test = 0;

	if (!((type | mask) & CRYPTO_ALG_TESTED))
		test |= CRYPTO_ALG_TESTED;

	down_read(&crypto_alg_sem);
	alg = __crypto_alg_lookup(name, type | test, mask | test);
	if (!alg && test) {
		alg = __crypto_alg_lookup(name, type, mask);
		if (alg && !crypto_is_larval(alg)) {
			/* Test failed */
			crypto_mod_put(alg);
			alg = ERR_PTR(-ELIBBAD);
		}
	}
	up_read(&crypto_alg_sem);

	return alg;
}

static struct crypto_alg *crypto_larval_lookup(const char *name, u32 type,
					       u32 mask)
{
	struct crypto_alg *alg;

	if (!name)
		return ERR_PTR(-ENOENT);

	type &= ~(CRYPTO_ALG_LARVAL | CRYPTO_ALG_DEAD);
	mask &= ~(CRYPTO_ALG_LARVAL | CRYPTO_ALG_DEAD);

	alg = crypto_alg_lookup(name, type, mask);
	if (!alg && !(mask & CRYPTO_NOLOAD)) {
		request_module("crypto-%s", name);

		if (!((type ^ CRYPTO_ALG_NEED_FALLBACK) & mask &
		      CRYPTO_ALG_NEED_FALLBACK))
			request_module("crypto-%s-all", name);

		alg = crypto_alg_lookup(name, type, mask);
	}

	if (!IS_ERR_OR_NULL(alg) && crypto_is_larval(alg))
		alg = crypto_larval_wait(alg);
	else if (!alg)
		alg = crypto_larval_add(name, type, mask);

	return alg;
}

int crypto_probing_notify(unsigned long val, void *v)
{
	int ok;

	ok = blocking_notifier_call_chain(&crypto_chain, val, v);
	if (ok == NOTIFY_DONE) {
		request_module("cryptomgr");
		ok = blocking_notifier_call_chain(&crypto_chain, val, v);
	}

	return ok;
}
EXPORT_SYMBOL_GPL(crypto_probing_notify);

struct crypto_alg *crypto_alg_mod_lookup(const char *name, u32 type, u32 mask)
{
	struct crypto_alg *alg;
	struct crypto_alg *larval;
	int ok;

	/*
	 * If the internal flag is set for a cipher, require a caller to
	 * to invoke the cipher with the internal flag to use that cipher.
	 * Also, if a caller wants to allocate a cipher that may or may
	 * not be an internal cipher, use type | CRYPTO_ALG_INTERNAL and
	 * !(mask & CRYPTO_ALG_INTERNAL).
	 */
	if (!((type | mask) & CRYPTO_ALG_INTERNAL))
		mask |= CRYPTO_ALG_INTERNAL;

	larval = crypto_larval_lookup(name, type, mask);
	if (IS_ERR(larval) || !crypto_is_larval(larval))
		return larval;

	ok = crypto_probing_notify(CRYPTO_MSG_ALG_REQUEST, larval);

	if (ok == NOTIFY_STOP)
		alg = crypto_larval_wait(larval);
	else {
		crypto_mod_put(larval);
		alg = ERR_PTR(-ENOENT);
	}
	crypto_larval_kill(larval);
	return alg;
}
EXPORT_SYMBOL_GPL(crypto_alg_mod_lookup);

static int crypto_init_ops(struct crypto_tfm *tfm, u32 type, u32 mask)
{
	const struct crypto_type *type_obj = tfm->__crt_alg->cra_type;

	if (type_obj)
		return type_obj->init(tfm, type, mask);
	return 0;
}

static void crypto_exit_ops(struct crypto_tfm *tfm)
{
	const struct crypto_type *type = tfm->__crt_alg->cra_type;

	if (type && tfm->exit)
		tfm->exit(tfm);
}

static unsigned int crypto_ctxsize(struct crypto_alg *alg, u32 type, u32 mask)
{
	const struct crypto_type *type_obj = alg->cra_type;
	unsigned int len;

	len = alg->cra_alignmask & ~(crypto_tfm_ctx_alignment() - 1);
	if (type_obj)
		return len + type_obj->ctxsize(alg, type, mask);

	switch (alg->cra_flags & CRYPTO_ALG_TYPE_MASK) {
	default:
		BUG();

	case CRYPTO_ALG_TYPE_CIPHER:
		len += crypto_cipher_ctxsize(alg);
		break;

	case CRYPTO_ALG_TYPE_COMPRESS:
		len += crypto_compress_ctxsize(alg);
		break;
	}

	return len;
}

void crypto_shoot_alg(struct crypto_alg *alg)
{
	down_write(&crypto_alg_sem);
	alg->cra_flags |= CRYPTO_ALG_DYING;
	up_write(&crypto_alg_sem);
}
EXPORT_SYMBOL_GPL(crypto_shoot_alg);

struct crypto_tfm *__crypto_alloc_tfm(struct crypto_alg *alg, u32 type,
				      u32 mask)
{
	struct crypto_tfm *tfm = NULL;
	unsigned int tfm_size;
	int err = -ENOMEM;

	tfm_size = sizeof(*tfm) + crypto_ctxsize(alg, type, mask);
	tfm = kzalloc(tfm_size, GFP_KERNEL);
	if (tfm == NULL)
		goto out_err;

	tfm->__crt_alg = alg;

	err = crypto_init_ops(tfm, type, mask);
	if (err)
		goto out_free_tfm;

	if (!tfm->exit && alg->cra_init && (err = alg->cra_init(tfm)))
		goto cra_init_failed;

	goto out;

cra_init_failed:
	crypto_exit_ops(tfm);
out_free_tfm:
	if (err == -EAGAIN)
		crypto_shoot_alg(alg);
	kfree(tfm);
out_err:
	tfm = ERR_PTR(err);
out:
	return tfm;
}
EXPORT_SYMBOL_GPL(__crypto_alloc_tfm);

/*
 *	crypto_alloc_base - Locate algorithm and allocate transform
 *	@alg_name: Name of algorithm
 *	@type: Type of algorithm
 *	@mask: Mask for type comparison
 *
 *	This function should not be used by new algorithm types.
 *	Please use crypto_alloc_tfm instead.
 *
 *	crypto_alloc_base() will first attempt to locate an already loaded
 *	algorithm.  If that fails and the kernel supports dynamically loadable
 *	modules, it will then attempt to load a module of the same name or
 *	alias.  If that fails it will send a query to any loaded crypto manager
 *	to construct an algorithm on the fly.  A refcount is grabbed on the
 *	algorithm which is then associated with the new transform.
 *
 *	The returned transform is of a non-determinate type.  Most people
 *	should use one of the more specific allocation functions such as
 *	crypto_alloc_skcipher().
 *
 *	In case of error the return value is an error pointer.
 */
struct crypto_tfm *crypto_alloc_base(const char *alg_name, u32 type, u32 mask)
{
	struct crypto_tfm *tfm;
	int err;

	for (;;) {
		struct crypto_alg *alg;

		alg = crypto_alg_mod_lookup(alg_name, type, mask);
		if (IS_ERR(alg)) {
			err = PTR_ERR(alg);
			goto err;
		}

		tfm = __crypto_alloc_tfm(alg, type, mask);
		if (!IS_ERR(tfm))
			return tfm;

		crypto_mod_put(alg);
		err = PTR_ERR(tfm);

err:
		if (err != -EAGAIN)
			break;
		if (fatal_signal_pending(current)) {
			err = -EINTR;
			break;
		}
	}

	return ERR_PTR(err);
}
EXPORT_SYMBOL_GPL(crypto_alloc_base);

void *crypto_create_tfm_node(struct crypto_alg *alg,
			const struct crypto_type *frontend,
			int node)
{
	char *mem;
	struct crypto_tfm *tfm = NULL;
	unsigned int tfmsize;
	unsigned int total;
	int err = -ENOMEM;

	tfmsize = frontend->tfmsize;
	total = tfmsize + sizeof(*tfm) + frontend->extsize(alg);

	mem = kzalloc_node(total, GFP_KERNEL, node);
	if (mem == NULL)
		goto out_err;

	tfm = (struct crypto_tfm *)(mem + tfmsize);
	tfm->__crt_alg = alg;
	tfm->node = node;

	err = frontend->init_tfm(tfm);
	if (err)
		goto out_free_tfm;

	if (!tfm->exit && alg->cra_init && (err = alg->cra_init(tfm)))
		goto cra_init_failed;

	goto out;

cra_init_failed:
	crypto_exit_ops(tfm);
out_free_tfm:
	if (err == -EAGAIN)
		crypto_shoot_alg(alg);
	kfree(mem);
out_err:
	mem = ERR_PTR(err);
out:
	return mem;
}
EXPORT_SYMBOL_GPL(crypto_create_tfm_node);

struct crypto_alg *crypto_find_alg(const char *alg_name,
				   const struct crypto_type *frontend,
				   u32 type, u32 mask)
{
	if (frontend) {
		type &= frontend->maskclear;
		mask &= frontend->maskclear;
		type |= frontend->type;
		mask |= frontend->maskset;
	}

	return crypto_alg_mod_lookup(alg_name, type, mask);
}
EXPORT_SYMBOL_GPL(crypto_find_alg);

/*
 *	crypto_alloc_tfm_node - Locate algorithm and allocate transform
 *	@alg_name: Name of algorithm
 *	@frontend: Frontend algorithm type
 *	@type: Type of algorithm
 *	@mask: Mask for type comparison
 *	@node: NUMA node in which users desire to put requests, if node is
 *		NUMA_NO_NODE, it means users have no special requirement.
 *
 *	crypto_alloc_tfm() will first attempt to locate an already loaded
 *	algorithm.  If that fails and the kernel supports dynamically loadable
 *	modules, it will then attempt to load a module of the same name or
 *	alias.  If that fails it will send a query to any loaded crypto manager
 *	to construct an algorithm on the fly.  A refcount is grabbed on the
 *	algorithm which is then associated with the new transform.
 *
 *	The returned transform is of a non-determinate type.  Most people
 *	should use one of the more specific allocation functions such as
 *	crypto_alloc_skcipher().
 *
 *	In case of error the return value is an error pointer.
 */

void *crypto_alloc_tfm_node(const char *alg_name,
		       const struct crypto_type *frontend, u32 type, u32 mask,
		       int node)
{
	void *tfm;
	int err;

	for (;;) {
		struct crypto_alg *alg;

		alg = crypto_find_alg(alg_name, frontend, type, mask);
		if (IS_ERR(alg)) {
			err = PTR_ERR(alg);
			goto err;
		}

		tfm = crypto_create_tfm_node(alg, frontend, node);
		if (!IS_ERR(tfm))
			return tfm;

		crypto_mod_put(alg);
		err = PTR_ERR(tfm);

err:
		if (err != -EAGAIN)
			break;
		if (fatal_signal_pending(current)) {
			err = -EINTR;
			break;
		}
	}

	return ERR_PTR(err);
}
EXPORT_SYMBOL_GPL(crypto_alloc_tfm_node);

/*
 *	crypto_destroy_tfm - Free crypto transform
 *	@mem: Start of tfm slab
 *	@tfm: Transform to free
 *
 *	This function frees up the transform and any associated resources,
 *	then drops the refcount on the associated algorithm.
 */
void crypto_destroy_tfm(void *mem, struct crypto_tfm *tfm)
{
	struct crypto_alg *alg;

	if (IS_ERR_OR_NULL(mem))
		return;

	alg = tfm->__crt_alg;

	if (!tfm->exit && alg->cra_exit)
		alg->cra_exit(tfm);
	crypto_exit_ops(tfm);
	crypto_mod_put(alg);
	kfree_sensitive(mem);
}
EXPORT_SYMBOL_GPL(crypto_destroy_tfm);

int crypto_has_alg(const char *name, u32 type, u32 mask)
{
	int ret = 0;
	struct crypto_alg *alg = crypto_alg_mod_lookup(name, type, mask);

	if (!IS_ERR(alg)) {
		crypto_mod_put(alg);
		ret = 1;
	}

	return ret;
}
EXPORT_SYMBOL_GPL(crypto_has_alg);

void crypto_req_done(struct crypto_async_request *req, int err)
{
	struct crypto_wait *wait = req->data;

	if (err == -EINPROGRESS)
		return;

	wait->err = err;
	complete(&wait->completion);
}
EXPORT_SYMBOL_GPL(crypto_req_done);

MODULE_DESCRIPTION("Cryptographic core API");
MODULE_LICENSE("GPL");
MODULE_SOFTDEP("pre: cryptomgr");
Commit	Line	Data
2874c5fd	1	// SPDX-License-Identifier: GPL-2.0-or-later
1da177e4 LT	2	/*
	3	* Scatterlist Cryptographic API.
	4	*
	5	* Copyright (c) 2002 James Morris <[email protected]>
	6	* Copyright (c) 2002 David S. Miller ([email protected])
5cb1454b	7	* Copyright (c) 2005 Herbert Xu <[email protected]>
1da177e4 LT	8	*
1da177e4 LT	9	* Portions derived from Cryptoapi, by Alexander Kjeldaas <[email protected]>
991d1740	10	* and Nettle, by Niels Möller.
1da177e4	11	*/
a61cc448	12
6bfd4809	13	#include <linux/err.h>
1da177e4	14	#include <linux/errno.h>
adad556e	15	#include <linux/jump_label.h>
5cb1454b	16	#include <linux/kernel.h>
176c3652	17	#include <linux/kmod.h>
2b8c19db	18	#include <linux/module.h>
2825982d	19	#include <linux/param.h>
174cd4b1	20	#include <linux/sched/signal.h>
1da177e4	21	#include <linux/slab.h>
5cb1454b	22	#include <linux/string.h>
ada69a16	23	#include <linux/completion.h>
1da177e4 LT	24	#include "internal.h"
	25
	26	LIST_HEAD(crypto_alg_list);
cce9e06d	27	EXPORT_SYMBOL_GPL(crypto_alg_list);
1da177e4	28	DECLARE_RWSEM(crypto_alg_sem);
cce9e06d	29	EXPORT_SYMBOL_GPL(crypto_alg_sem);
1da177e4	30
2825982d HX	31	BLOCKING_NOTIFIER_HEAD(crypto_chain);
	32	EXPORT_SYMBOL_GPL(crypto_chain);
	33
adad556e	34	DEFINE_STATIC_KEY_FALSE(crypto_boot_test_finished);
e42dff46	35	EXPORT_SYMBOL_GPL(crypto_boot_test_finished);
adad556e	36
77dbd7a9 HX	37	static struct crypto_alg crypto_larval_wait(struct crypto_alg alg);
77dbd7a9 HX	38
2825982d	39	struct crypto_alg crypto_mod_get(struct crypto_alg alg)
6521f302 HX	40	{
6521f302 HX	41	return try_module_get(alg->cra_module) ? crypto_alg_get(alg) : NULL;
1da177e4	42	}
2825982d	43	EXPORT_SYMBOL_GPL(crypto_mod_get);
1da177e4	44
2825982d	45	void crypto_mod_put(struct crypto_alg *alg)
1da177e4	46	{
da7cd59a HX	47	struct module *module = alg->cra_module;
da7cd59a HX	48
6521f302	49	crypto_alg_put(alg);
da7cd59a	50	module_put(module);
1da177e4	51	}
2825982d	52	EXPORT_SYMBOL_GPL(crypto_mod_put);
1da177e4	53
c51b6c81 HX	54	static struct crypto_alg __crypto_alg_lookup(const char name, u32 type,
c51b6c81 HX	55	u32 mask)
1da177e4 LT	56	{
1da177e4 LT	57	struct crypto_alg q, alg = NULL;
2825982d	58	int best = -2;
1da177e4	59
1da177e4	60	list_for_each_entry(q, &crypto_alg_list, cra_list) {
5cb1454b HX	61	int exact, fuzzy;
5cb1454b HX	62
6bfd4809 HX	63	if (crypto_is_moribund(q))
	64	continue;
	65
492e2b63 HX	66	if ((q->cra_flags ^ type) & mask)
	67	continue;
	68
	69	if (crypto_is_larval(q) &&
73d3864a	70	!crypto_is_test_larval((struct crypto_larval *)q) &&
492e2b63 HX	71	((struct crypto_larval *)q)->mask != mask)
	72	continue;
	73
5cb1454b HX	74	exact = !strcmp(q->cra_driver_name, name);
	75	fuzzy = !strcmp(q->cra_name, name);
	76	if (!exact && !(fuzzy && q->cra_priority > best))
	77	continue;
	78
72fa4919	79	if (unlikely(!crypto_mod_get(q)))
5cb1454b HX	80	continue;
	81
	82	best = q->cra_priority;
	83	if (alg)
72fa4919	84	crypto_mod_put(alg);
5cb1454b HX	85	alg = q;
	86
	87	if (exact)
1da177e4	88	break;
1da177e4	89	}
2825982d HX	90
	91	return alg;
	92	}
2825982d HX	93
	94	static void crypto_larval_destroy(struct crypto_alg *alg)
	95	{
	96	struct crypto_larval larval = (void )alg;
	97
	98	BUG_ON(!crypto_is_larval(alg));
2bbb3375	99	if (!IS_ERR_OR_NULL(larval->adult))
2825982d HX	100	crypto_mod_put(larval->adult);
	101	kfree(larval);
	102	}
	103
73d3864a	104	struct crypto_larval crypto_larval_alloc(const char name, u32 type, u32 mask)
2825982d	105	{
2825982d HX	106	struct crypto_larval *larval;
	107
	108	larval = kzalloc(sizeof(*larval), GFP_KERNEL);
	109	if (!larval)
6bfd4809	110	return ERR_PTR(-ENOMEM);
2825982d	111
492e2b63 HX	112	larval->mask = mask;
492e2b63 HX	113	larval->alg.cra_flags = CRYPTO_ALG_LARVAL \| type;
2825982d HX	114	larval->alg.cra_priority = -1;
	115	larval->alg.cra_destroy = crypto_larval_destroy;
	116
2825982d HX	117	strlcpy(larval->alg.cra_name, name, CRYPTO_MAX_ALG_NAME);
	118	init_completion(&larval->completion);
	119
73d3864a HX	120	return larval;
	121	}
	122	EXPORT_SYMBOL_GPL(crypto_larval_alloc);
	123
	124	static struct crypto_alg crypto_larval_add(const char name, u32 type,
	125	u32 mask)
	126	{
	127	struct crypto_alg *alg;
	128	struct crypto_larval *larval;
	129
	130	larval = crypto_larval_alloc(name, type, mask);
	131	if (IS_ERR(larval))
	132	return ERR_CAST(larval);
	133
ce8614a3	134	refcount_set(&larval->alg.cra_refcnt, 2);
73d3864a	135
2825982d	136	down_write(&crypto_alg_sem);
492e2b63	137	alg = __crypto_alg_lookup(name, type, mask);
2825982d HX	138	if (!alg) {
	139	alg = &larval->alg;
	140	list_add(&alg->cra_list, &crypto_alg_list);
	141	}
	142	up_write(&crypto_alg_sem);
	143
77dbd7a9	144	if (alg != &larval->alg) {
2825982d	145	kfree(larval);
77dbd7a9 HX	146	if (crypto_is_larval(alg))
	147	alg = crypto_larval_wait(alg);
	148	}
2825982d HX	149
	150	return alg;
	151	}
	152
b9c55aa4	153	void crypto_larval_kill(struct crypto_alg *alg)
2825982d HX	154	{
	155	struct crypto_larval larval = (void )alg;
	156
	157	down_write(&crypto_alg_sem);
	158	list_del(&alg->cra_list);
	159	up_write(&crypto_alg_sem);
fe3c5206	160	complete_all(&larval->completion);
2825982d HX	161	crypto_alg_put(alg);
2825982d HX	162	}
b9c55aa4	163	EXPORT_SYMBOL_GPL(crypto_larval_kill);
2825982d	164
adad556e HX	165	void crypto_wait_for_test(struct crypto_larval *larval)
	166	{
	167	int err;
	168
	169	err = crypto_probing_notify(CRYPTO_MSG_ALG_REGISTER, larval->adult);
cad439fc HX	170	if (WARN_ON_ONCE(err != NOTIFY_STOP))
cad439fc HX	171	goto out;
adad556e HX	172
	173	err = wait_for_completion_killable(&larval->completion);
	174	WARN_ON(err);
	175	if (!err)
	176	crypto_notify(CRYPTO_MSG_ALG_LOADED, larval);
	177
	178	out:
	179	crypto_larval_kill(&larval->alg);
	180	}
	181	EXPORT_SYMBOL_GPL(crypto_wait_for_test);
	182
	183	static void crypto_start_test(struct crypto_larval *larval)
	184	{
	185	if (!crypto_is_test_larval(larval))
	186	return;
	187
	188	if (larval->test_started)
	189	return;
	190
	191	down_write(&crypto_alg_sem);
	192	if (larval->test_started) {
	193	up_write(&crypto_alg_sem);
	194	return;
	195	}
	196
	197	larval->test_started = true;
	198	up_write(&crypto_alg_sem);
	199
	200	crypto_wait_for_test(larval);
	201	}
	202
2825982d HX	203	static struct crypto_alg crypto_larval_wait(struct crypto_alg alg)
	204	{
	205	struct crypto_larval larval = (void )alg;
73d3864a HX	206	long timeout;
73d3864a HX	207
adad556e HX	208	if (!static_branch_likely(&crypto_boot_test_finished))
	209	crypto_start_test(larval);
	210
3fc89adb	211	timeout = wait_for_completion_killable_timeout(
73d3864a	212	&larval->completion, 60 * HZ);
2825982d	213
2825982d	214	alg = larval->adult;
73d3864a HX	215	if (timeout < 0)
	216	alg = ERR_PTR(-EINTR);
	217	else if (!timeout)
	218	alg = ERR_PTR(-ETIMEDOUT);
	219	else if (!alg)
6bfd4809	220	alg = ERR_PTR(-ENOENT);
2bbb3375 HX	221	else if (IS_ERR(alg))
2bbb3375 HX	222	;
73d3864a HX	223	else if (crypto_is_test_larval(larval) &&
	224	!(alg->cra_flags & CRYPTO_ALG_TESTED))
	225	alg = ERR_PTR(-EAGAIN);
	226	else if (!crypto_mod_get(alg))
	227	alg = ERR_PTR(-EAGAIN);
2825982d HX	228	crypto_mod_put(&larval->alg);
	229
	230	return alg;
	231	}
	232
3ca1e994 HX	233	static struct crypto_alg crypto_alg_lookup(const char name, u32 type,
3ca1e994 HX	234	u32 mask)
2825982d HX	235	{
2825982d HX	236	struct crypto_alg *alg;
eb02c38f HX	237	u32 test = 0;
	238
	239	if (!((type \| mask) & CRYPTO_ALG_TESTED))
	240	test \|= CRYPTO_ALG_TESTED;
2825982d	241
2825982d	242	down_read(&crypto_alg_sem);
eb02c38f	243	alg = __crypto_alg_lookup(name, type \| test, mask \| test);
b346e492 EB	244	if (!alg && test) {
	245	alg = __crypto_alg_lookup(name, type, mask);
	246	if (alg && !crypto_is_larval(alg)) {
	247	/* Test failed */
	248	crypto_mod_put(alg);
	249	alg = ERR_PTR(-ELIBBAD);
	250	}
	251	}
1da177e4	252	up_read(&crypto_alg_sem);
2825982d	253
1da177e4 LT	254	return alg;
	255	}
	256
cadc9ab5 EB	257	static struct crypto_alg crypto_larval_lookup(const char name, u32 type,
cadc9ab5 EB	258	u32 mask)
176c3652	259	{
2825982d	260	struct crypto_alg *alg;
2825982d	261
6bfd4809 HX	262	if (!name)
	263	return ERR_PTR(-ENOENT);
	264
430b441c	265	type &= ~(CRYPTO_ALG_LARVAL \| CRYPTO_ALG_DEAD);
6bfd4809	266	mask &= ~(CRYPTO_ALG_LARVAL \| CRYPTO_ALG_DEAD);
492e2b63	267
a760a665	268	alg = crypto_alg_lookup(name, type, mask);
e2861fa7	269	if (!alg && !(mask & CRYPTO_NOLOAD)) {
5d26a105	270	request_module("crypto-%s", name);
a760a665	271
37fc334c	272	if (!((type ^ CRYPTO_ALG_NEED_FALLBACK) & mask &
aa07a699	273	CRYPTO_ALG_NEED_FALLBACK))
5d26a105	274	request_module("crypto-%s-all", name);
a760a665 HX	275
	276	alg = crypto_alg_lookup(name, type, mask);
	277	}
	278
eb02c38f HX	279	if (!IS_ERR_OR_NULL(alg) && crypto_is_larval(alg))
	280	alg = crypto_larval_wait(alg);
	281	else if (!alg)
	282	alg = crypto_larval_add(name, type, mask);
2825982d	283
eb02c38f	284	return alg;
b9c55aa4	285	}
b9c55aa4	286
73d3864a HX	287	int crypto_probing_notify(unsigned long val, void *v)
	288	{
	289	int ok;
	290
	291	ok = blocking_notifier_call_chain(&crypto_chain, val, v);
	292	if (ok == NOTIFY_DONE) {
	293	request_module("cryptomgr");
	294	ok = blocking_notifier_call_chain(&crypto_chain, val, v);
	295	}
	296
	297	return ok;
	298	}
	299	EXPORT_SYMBOL_GPL(crypto_probing_notify);
	300
b9c55aa4 HX	301	struct crypto_alg crypto_alg_mod_lookup(const char name, u32 type, u32 mask)
	302	{
	303	struct crypto_alg *alg;
	304	struct crypto_alg *larval;
	305	int ok;
	306
06ca7f68 SM	307	/*
	308	* If the internal flag is set for a cipher, require a caller to
	309	* to invoke the cipher with the internal flag to use that cipher.
	310	* Also, if a caller wants to allocate a cipher that may or may
	311	* not be an internal cipher, use type \| CRYPTO_ALG_INTERNAL and
	312	* !(mask & CRYPTO_ALG_INTERNAL).
	313	*/
	314	if (!((type \| mask) & CRYPTO_ALG_INTERNAL))
	315	mask \|= CRYPTO_ALG_INTERNAL;
	316
b9c55aa4	317	larval = crypto_larval_lookup(name, type, mask);
6bfd4809	318	if (IS_ERR(larval) \|\| !crypto_is_larval(larval))
2825982d HX	319	return larval;
2825982d HX	320
73d3864a	321	ok = crypto_probing_notify(CRYPTO_MSG_ALG_REQUEST, larval);
2b8c19db HX	322
2b8c19db HX	323	if (ok == NOTIFY_STOP)
2825982d HX	324	alg = crypto_larval_wait(larval);
	325	else {
	326	crypto_mod_put(larval);
6bfd4809	327	alg = ERR_PTR(-ENOENT);
2825982d HX	328	}
	329	crypto_larval_kill(larval);
	330	return alg;
176c3652	331	}
492e2b63	332	EXPORT_SYMBOL_GPL(crypto_alg_mod_lookup);
176c3652	333
27d2a330	334	static int crypto_init_ops(struct crypto_tfm *tfm, u32 type, u32 mask)
1da177e4	335	{
27d2a330	336	const struct crypto_type *type_obj = tfm->__crt_alg->cra_type;
e853c3cf	337
27d2a330 HX	338	if (type_obj)
27d2a330 HX	339	return type_obj->init(tfm, type, mask);
e8cfed5e	340	return 0;
1da177e4 LT	341	}
	342
	343	static void crypto_exit_ops(struct crypto_tfm *tfm)
	344	{
e853c3cf HX	345	const struct crypto_type *type = tfm->__crt_alg->cra_type;
e853c3cf HX	346
9c8ae17b EB	347	if (type && tfm->exit)
9c8ae17b EB	348	tfm->exit(tfm);
1da177e4 LT	349	}
1da177e4 LT	350
27d2a330	351	static unsigned int crypto_ctxsize(struct crypto_alg *alg, u32 type, u32 mask)
fbdae9f3	352	{
27d2a330	353	const struct crypto_type *type_obj = alg->cra_type;
fbdae9f3 HX	354	unsigned int len;
fbdae9f3 HX	355
e853c3cf	356	len = alg->cra_alignmask & ~(crypto_tfm_ctx_alignment() - 1);
27d2a330 HX	357	if (type_obj)
27d2a330 HX	358	return len + type_obj->ctxsize(alg, type, mask);
e853c3cf	359
fbdae9f3 HX	360	switch (alg->cra_flags & CRYPTO_ALG_TYPE_MASK) {
	361	default:
	362	BUG();
	363
	364	case CRYPTO_ALG_TYPE_CIPHER:
f1ddcaf3	365	len += crypto_cipher_ctxsize(alg);
fbdae9f3	366	break;
6941c3a0	367
fbdae9f3	368	case CRYPTO_ALG_TYPE_COMPRESS:
f1ddcaf3	369	len += crypto_compress_ctxsize(alg);
fbdae9f3 HX	370	break;
	371	}
	372
e853c3cf	373	return len;
fbdae9f3 HX	374	}
fbdae9f3 HX	375
6603523b	376	void crypto_shoot_alg(struct crypto_alg *alg)
6bfd4809 HX	377	{
	378	down_write(&crypto_alg_sem);
	379	alg->cra_flags \|= CRYPTO_ALG_DYING;
	380	up_write(&crypto_alg_sem);
	381	}
6603523b	382	EXPORT_SYMBOL_GPL(crypto_shoot_alg);
6bfd4809	383
27d2a330 HX	384	struct crypto_tfm __crypto_alloc_tfm(struct crypto_alg alg, u32 type,
27d2a330 HX	385	u32 mask)
1da177e4 LT	386	{
1da177e4 LT	387	struct crypto_tfm *tfm = NULL;
fbdae9f3	388	unsigned int tfm_size;
6bfd4809	389	int err = -ENOMEM;
fbdae9f3	390
27d2a330	391	tfm_size = sizeof(*tfm) + crypto_ctxsize(alg, type, mask);
bbeb563f	392	tfm = kzalloc(tfm_size, GFP_KERNEL);
1da177e4	393	if (tfm == NULL)
9765d262	394	goto out_err;
1da177e4	395
1da177e4	396	tfm->__crt_alg = alg;
6bfd4809	397
27d2a330	398	err = crypto_init_ops(tfm, type, mask);
6bfd4809	399	if (err)
1da177e4	400	goto out_free_tfm;
c7fc0599	401
4a779486	402	if (!tfm->exit && alg->cra_init && (err = alg->cra_init(tfm)))
c7fc0599	403	goto cra_init_failed;
1da177e4 LT	404
	405	goto out;
	406
c7fc0599 HX	407	cra_init_failed:
c7fc0599 HX	408	crypto_exit_ops(tfm);
1da177e4	409	out_free_tfm:
4a779486 HX	410	if (err == -EAGAIN)
4a779486 HX	411	crypto_shoot_alg(alg);
1da177e4	412	kfree(tfm);
9765d262	413	out_err:
6bfd4809	414	tfm = ERR_PTR(err);
1da177e4 LT	415	out:
	416	return tfm;
	417	}
6bfd4809 HX	418	EXPORT_SYMBOL_GPL(__crypto_alloc_tfm);
6bfd4809 HX	419
6d7d684d HX	420	/*
	421	* crypto_alloc_base - Locate algorithm and allocate transform
	422	* @alg_name: Name of algorithm
	423	* @type: Type of algorithm
	424	* @mask: Mask for type comparison
	425	*
7b0bac64	426	* This function should not be used by new algorithm types.
fd1a1900	427	* Please use crypto_alloc_tfm instead.
7b0bac64	428	*
6d7d684d HX	429	* crypto_alloc_base() will first attempt to locate an already loaded
	430	* algorithm. If that fails and the kernel supports dynamically loadable
	431	* modules, it will then attempt to load a module of the same name or
	432	* alias. If that fails it will send a query to any loaded crypto manager
	433	* to construct an algorithm on the fly. A refcount is grabbed on the
	434	* algorithm which is then associated with the new transform.
	435	*
	436	* The returned transform is of a non-determinate type. Most people
	437	* should use one of the more specific allocation functions such as
c65058b7	438	* crypto_alloc_skcipher().
6d7d684d HX	439	*
	440	* In case of error the return value is an error pointer.
	441	*/
	442	struct crypto_tfm crypto_alloc_base(const char alg_name, u32 type, u32 mask)
	443	{
	444	struct crypto_tfm *tfm;
	445	int err;
	446
	447	for (;;) {
	448	struct crypto_alg *alg;
	449
	450	alg = crypto_alg_mod_lookup(alg_name, type, mask);
9765d262 AM	451	if (IS_ERR(alg)) {
9765d262 AM	452	err = PTR_ERR(alg);
6d7d684d	453	goto err;
9765d262	454	}
6d7d684d	455
27d2a330	456	tfm = __crypto_alloc_tfm(alg, type, mask);
6d7d684d	457	if (!IS_ERR(tfm))
9765d262	458	return tfm;
6d7d684d HX	459
	460	crypto_mod_put(alg);
	461	err = PTR_ERR(tfm);
	462
	463	err:
	464	if (err != -EAGAIN)
	465	break;
3fc89adb	466	if (fatal_signal_pending(current)) {
6d7d684d HX	467	err = -EINTR;
	468	break;
	469	}
9765d262	470	}
6d7d684d	471
9765d262	472	return ERR_PTR(err);
6d7d684d HX	473	}
6d7d684d HX	474	EXPORT_SYMBOL_GPL(crypto_alloc_base);
7b0bac64	475
7bc13b5b BS	476	void crypto_create_tfm_node(struct crypto_alg alg,
	477	const struct crypto_type *frontend,
	478	int node)
7b0bac64 HX	479	{
	480	char *mem;
	481	struct crypto_tfm *tfm = NULL;
	482	unsigned int tfmsize;
	483	unsigned int total;
	484	int err = -ENOMEM;
	485
	486	tfmsize = frontend->tfmsize;
2ca33da1	487	total = tfmsize + sizeof(*tfm) + frontend->extsize(alg);
7b0bac64	488
7bc13b5b	489	mem = kzalloc_node(total, GFP_KERNEL, node);
7b0bac64 HX	490	if (mem == NULL)
	491	goto out_err;
	492
	493	tfm = (struct crypto_tfm *)(mem + tfmsize);
	494	tfm->__crt_alg = alg;
7bc13b5b	495	tfm->node = node;
7b0bac64	496
2ca33da1	497	err = frontend->init_tfm(tfm);
7b0bac64 HX	498	if (err)
	499	goto out_free_tfm;
	500
	501	if (!tfm->exit && alg->cra_init && (err = alg->cra_init(tfm)))
	502	goto cra_init_failed;
	503
	504	goto out;
	505
	506	cra_init_failed:
	507	crypto_exit_ops(tfm);
	508	out_free_tfm:
	509	if (err == -EAGAIN)
	510	crypto_shoot_alg(alg);
	511	kfree(mem);
	512	out_err:
3f683d61	513	mem = ERR_PTR(err);
7b0bac64	514	out:
3f683d61	515	return mem;
7b0bac64	516	}
7bc13b5b	517	EXPORT_SYMBOL_GPL(crypto_create_tfm_node);
7b0bac64	518
d06854f0 HX	519	struct crypto_alg crypto_find_alg(const char alg_name,
	520	const struct crypto_type *frontend,
	521	u32 type, u32 mask)
	522	{
d06854f0 HX	523	if (frontend) {
	524	type &= frontend->maskclear;
	525	mask &= frontend->maskclear;
	526	type \|= frontend->type;
	527	mask \|= frontend->maskset;
d06854f0 HX	528	}
d06854f0 HX	529
4989d4f0	530	return crypto_alg_mod_lookup(alg_name, type, mask);
d06854f0 HX	531	}
	532	EXPORT_SYMBOL_GPL(crypto_find_alg);
	533
7b0bac64	534	/*
7bc13b5b	535	* crypto_alloc_tfm_node - Locate algorithm and allocate transform
7b0bac64 HX	536	* @alg_name: Name of algorithm
	537	* @frontend: Frontend algorithm type
	538	* @type: Type of algorithm
	539	* @mask: Mask for type comparison
7bc13b5b BS	540	* @node: NUMA node in which users desire to put requests, if node is
7bc13b5b BS	541	* NUMA_NO_NODE, it means users have no special requirement.
7b0bac64 HX	542	*
	543	* crypto_alloc_tfm() will first attempt to locate an already loaded
	544	* algorithm. If that fails and the kernel supports dynamically loadable
	545	* modules, it will then attempt to load a module of the same name or
	546	* alias. If that fails it will send a query to any loaded crypto manager
	547	* to construct an algorithm on the fly. A refcount is grabbed on the
	548	* algorithm which is then associated with the new transform.
	549	*
	550	* The returned transform is of a non-determinate type. Most people
	551	* should use one of the more specific allocation functions such as
0a940d4e	552	* crypto_alloc_skcipher().
7b0bac64 HX	553	*
	554	* In case of error the return value is an error pointer.
	555	*/
7bc13b5b BS	556
	557	void crypto_alloc_tfm_node(const char alg_name,
	558	const struct crypto_type *frontend, u32 type, u32 mask,
	559	int node)
7b0bac64	560	{
3f683d61	561	void *tfm;
7b0bac64 HX	562	int err;
7b0bac64 HX	563
7b0bac64 HX	564	for (;;) {
	565	struct crypto_alg *alg;
	566
d06854f0	567	alg = crypto_find_alg(alg_name, frontend, type, mask);
7b0bac64 HX	568	if (IS_ERR(alg)) {
	569	err = PTR_ERR(alg);
	570	goto err;
	571	}
	572
7bc13b5b	573	tfm = crypto_create_tfm_node(alg, frontend, node);
7b0bac64 HX	574	if (!IS_ERR(tfm))
	575	return tfm;
	576
	577	crypto_mod_put(alg);
	578	err = PTR_ERR(tfm);
	579
	580	err:
	581	if (err != -EAGAIN)
	582	break;
3fc89adb	583	if (fatal_signal_pending(current)) {
7b0bac64 HX	584	err = -EINTR;
	585	break;
	586	}
	587	}
	588
	589	return ERR_PTR(err);
	590	}
7bc13b5b	591	EXPORT_SYMBOL_GPL(crypto_alloc_tfm_node);
7b2cd92a	592
6d7d684d	593	/*
7b2cd92a HX	594	* crypto_destroy_tfm - Free crypto transform
7b2cd92a HX	595	* @mem: Start of tfm slab
6d7d684d HX	596	* @tfm: Transform to free
6d7d684d HX	597	*
7b2cd92a	598	* This function frees up the transform and any associated resources,
6d7d684d HX	599	* then drops the refcount on the associated algorithm.
6d7d684d HX	600	*/
7b2cd92a	601	void crypto_destroy_tfm(void mem, struct crypto_tfm tfm)
1da177e4	602	{
a61cc448	603	struct crypto_alg *alg;
a61cc448	604
83681f2b	605	if (IS_ERR_OR_NULL(mem))
a61cc448 JJ	606	return;
	607
	608	alg = tfm->__crt_alg;
1da177e4	609
4a779486	610	if (!tfm->exit && alg->cra_exit)
c7fc0599	611	alg->cra_exit(tfm);
1da177e4	612	crypto_exit_ops(tfm);
72fa4919	613	crypto_mod_put(alg);
453431a5	614	kfree_sensitive(mem);
1da177e4	615	}
7b2cd92a	616	EXPORT_SYMBOL_GPL(crypto_destroy_tfm);
fce32d70 HX	617
	618	int crypto_has_alg(const char *name, u32 type, u32 mask)
	619	{
	620	int ret = 0;
	621	struct crypto_alg *alg = crypto_alg_mod_lookup(name, type, mask);
3d01a33b	622
fce32d70 HX	623	if (!IS_ERR(alg)) {
	624	crypto_mod_put(alg);
	625	ret = 1;
	626	}
3d01a33b	627
fce32d70 HX	628	return ret;
	629	}
	630	EXPORT_SYMBOL_GPL(crypto_has_alg);
c3715cb9	631
ada69a16 GBY	632	void crypto_req_done(struct crypto_async_request *req, int err)
	633	{
	634	struct crypto_wait *wait = req->data;
	635
	636	if (err == -EINPROGRESS)
	637	return;
	638
	639	wait->err = err;
	640	complete(&wait->completion);
	641	}
	642	EXPORT_SYMBOL_GPL(crypto_req_done);
	643
c3715cb9 SS	644	MODULE_DESCRIPTION("Cryptographic core API");
c3715cb9 SS	645	MODULE_LICENSE("GPL");
8ab23d54	646	MODULE_SOFTDEP("pre: cryptomgr");