[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/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);

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 inline int crypto_is_test_larval(struct crypto_larval *larval)
{
	return larval->alg.cra_driver_name[0];
}

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);

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

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