[mirror_ubuntu-jammy-kernel.git] / net / wireless / lib80211.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * lib80211 -- common bits for IEEE802.11 drivers
 *
 * Copyright(c) 2008 John W. Linville <linville@tuxdriver.com>
 *
 * Portions copied from old ieee80211 component, w/ original copyright
 * notices below:
 *
 * Host AP crypto routines
 *
 * Copyright (c) 2002-2003, Jouni Malinen <j@w1.fi>
 * Portions Copyright (C) 2004, Intel Corporation <jketreno@linux.intel.com>
 *
 */

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/module.h>
#include <linux/ctype.h>
#include <linux/ieee80211.h>
#include <linux/errno.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <linux/string.h>

#include <net/lib80211.h>

#define DRV_NAME        "lib80211"

#define DRV_DESCRIPTION	"common routines for IEEE802.11 drivers"

MODULE_DESCRIPTION(DRV_DESCRIPTION);
MODULE_AUTHOR("John W. Linville <linville@tuxdriver.com>");
MODULE_LICENSE("GPL");

struct lib80211_crypto_alg {
	struct list_head list;
	struct lib80211_crypto_ops *ops;
};

static LIST_HEAD(lib80211_crypto_algs);
static DEFINE_SPINLOCK(lib80211_crypto_lock);

static void lib80211_crypt_deinit_entries(struct lib80211_crypt_info *info,
					  int force);
static void lib80211_crypt_quiescing(struct lib80211_crypt_info *info);
static void lib80211_crypt_deinit_handler(struct timer_list *t);

int lib80211_crypt_info_init(struct lib80211_crypt_info *info, char *name,
				spinlock_t *lock)
{
	memset(info, 0, sizeof(*info));

	info->name = name;
	info->lock = lock;

	INIT_LIST_HEAD(&info->crypt_deinit_list);
	timer_setup(&info->crypt_deinit_timer, lib80211_crypt_deinit_handler,
		    0);

	return 0;
}
EXPORT_SYMBOL(lib80211_crypt_info_init);

void lib80211_crypt_info_free(struct lib80211_crypt_info *info)
{
	int i;

        lib80211_crypt_quiescing(info);
        del_timer_sync(&info->crypt_deinit_timer);
        lib80211_crypt_deinit_entries(info, 1);

        for (i = 0; i < NUM_WEP_KEYS; i++) {
                struct lib80211_crypt_data *crypt = info->crypt[i];
                if (crypt) {
                        if (crypt->ops) {
                                crypt->ops->deinit(crypt->priv);
                                module_put(crypt->ops->owner);
                        }
                        kfree(crypt);
                        info->crypt[i] = NULL;
                }
        }
}
EXPORT_SYMBOL(lib80211_crypt_info_free);

static void lib80211_crypt_deinit_entries(struct lib80211_crypt_info *info,
					  int force)
{
	struct lib80211_crypt_data *entry, *next;
	unsigned long flags;

	spin_lock_irqsave(info->lock, flags);
	list_for_each_entry_safe(entry, next, &info->crypt_deinit_list, list) {
		if (atomic_read(&entry->refcnt) != 0 && !force)
			continue;

		list_del(&entry->list);

		if (entry->ops) {
			entry->ops->deinit(entry->priv);
			module_put(entry->ops->owner);
		}
		kfree(entry);
	}
	spin_unlock_irqrestore(info->lock, flags);
}

/* After this, crypt_deinit_list won't accept new members */
static void lib80211_crypt_quiescing(struct lib80211_crypt_info *info)
{
	unsigned long flags;

	spin_lock_irqsave(info->lock, flags);
	info->crypt_quiesced = 1;
	spin_unlock_irqrestore(info->lock, flags);
}

static void lib80211_crypt_deinit_handler(struct timer_list *t)
{
	struct lib80211_crypt_info *info = from_timer(info, t,
						      crypt_deinit_timer);
	unsigned long flags;

	lib80211_crypt_deinit_entries(info, 0);

	spin_lock_irqsave(info->lock, flags);
	if (!list_empty(&info->crypt_deinit_list) && !info->crypt_quiesced) {
		printk(KERN_DEBUG "%s: entries remaining in delayed crypt "
		       "deletion list\n", info->name);
		info->crypt_deinit_timer.expires = jiffies + HZ;
		add_timer(&info->crypt_deinit_timer);
	}
	spin_unlock_irqrestore(info->lock, flags);
}

void lib80211_crypt_delayed_deinit(struct lib80211_crypt_info *info,
				    struct lib80211_crypt_data **crypt)
{
	struct lib80211_crypt_data *tmp;
	unsigned long flags;

	if (*crypt == NULL)
		return;

	tmp = *crypt;
	*crypt = NULL;

	/* must not run ops->deinit() while there may be pending encrypt or
	 * decrypt operations. Use a list of delayed deinits to avoid needing
	 * locking. */

	spin_lock_irqsave(info->lock, flags);
	if (!info->crypt_quiesced) {
		list_add(&tmp->list, &info->crypt_deinit_list);
		if (!timer_pending(&info->crypt_deinit_timer)) {
			info->crypt_deinit_timer.expires = jiffies + HZ;
			add_timer(&info->crypt_deinit_timer);
		}
	}
	spin_unlock_irqrestore(info->lock, flags);
}
EXPORT_SYMBOL(lib80211_crypt_delayed_deinit);

int lib80211_register_crypto_ops(struct lib80211_crypto_ops *ops)
{
	unsigned long flags;
	struct lib80211_crypto_alg *alg;

	alg = kzalloc(sizeof(*alg), GFP_KERNEL);
	if (alg == NULL)
		return -ENOMEM;

	alg->ops = ops;

	spin_lock_irqsave(&lib80211_crypto_lock, flags);
	list_add(&alg->list, &lib80211_crypto_algs);
	spin_unlock_irqrestore(&lib80211_crypto_lock, flags);

	printk(KERN_DEBUG "lib80211_crypt: registered algorithm '%s'\n",
	       ops->name);

	return 0;
}
EXPORT_SYMBOL(lib80211_register_crypto_ops);

int lib80211_unregister_crypto_ops(struct lib80211_crypto_ops *ops)
{
	struct lib80211_crypto_alg *alg;
	unsigned long flags;

	spin_lock_irqsave(&lib80211_crypto_lock, flags);
	list_for_each_entry(alg, &lib80211_crypto_algs, list) {
		if (alg->ops == ops)
			goto found;
	}
	spin_unlock_irqrestore(&lib80211_crypto_lock, flags);
	return -EINVAL;

      found:
	printk(KERN_DEBUG "lib80211_crypt: unregistered algorithm '%s'\n",
	       ops->name);
	list_del(&alg->list);
	spin_unlock_irqrestore(&lib80211_crypto_lock, flags);
	kfree(alg);
	return 0;
}
EXPORT_SYMBOL(lib80211_unregister_crypto_ops);

struct lib80211_crypto_ops *lib80211_get_crypto_ops(const char *name)
{
	struct lib80211_crypto_alg *alg;
	unsigned long flags;

	spin_lock_irqsave(&lib80211_crypto_lock, flags);
	list_for_each_entry(alg, &lib80211_crypto_algs, list) {
		if (strcmp(alg->ops->name, name) == 0)
			goto found;
	}
	spin_unlock_irqrestore(&lib80211_crypto_lock, flags);
	return NULL;

      found:
	spin_unlock_irqrestore(&lib80211_crypto_lock, flags);
	return alg->ops;
}
EXPORT_SYMBOL(lib80211_get_crypto_ops);

static void *lib80211_crypt_null_init(int keyidx)
{
	return (void *)1;
}

static void lib80211_crypt_null_deinit(void *priv)
{
}

static struct lib80211_crypto_ops lib80211_crypt_null = {
	.name = "NULL",
	.init = lib80211_crypt_null_init,
	.deinit = lib80211_crypt_null_deinit,
	.owner = THIS_MODULE,
};

static int __init lib80211_init(void)
{
	pr_info(DRV_DESCRIPTION "\n");
	return lib80211_register_crypto_ops(&lib80211_crypt_null);
}

static void __exit lib80211_exit(void)
{
	lib80211_unregister_crypto_ops(&lib80211_crypt_null);
	BUG_ON(!list_empty(&lib80211_crypto_algs));
}

module_init(lib80211_init);
module_exit(lib80211_exit);
Commit	Line	Data
09c434b8	1	// SPDX-License-Identifier: GPL-2.0-only
7e272fcf JL	2	/*
	3	* lib80211 -- common bits for IEEE802.11 drivers
	4	*
	5	* Copyright(c) 2008 John W. Linville <linville@tuxdriver.com>
	6	*
274bfb8d JL	7	* Portions copied from old ieee80211 component, w/ original copyright
	8	* notices below:
	9	*
	10	* Host AP crypto routines
	11	*
	12	* Copyright (c) 2002-2003, Jouni Malinen <j@w1.fi>
	13	* Portions Copyright (C) 2004, Intel Corporation <jketreno@linux.intel.com>
	14	*
7e272fcf JL	15	*/
7e272fcf JL	16
e9c0268f JP	17	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
e9c0268f JP	18
7e272fcf	19	#include <linux/module.h>
2819f8ad	20	#include <linux/ctype.h>
7e272fcf	21	#include <linux/ieee80211.h>
274bfb8d JL	22	#include <linux/errno.h>
	23	#include <linux/init.h>
	24	#include <linux/slab.h>
	25	#include <linux/string.h>
7e272fcf JL	26
	27	#include <net/lib80211.h>
	28
	29	#define DRV_NAME "lib80211"
	30
	31	#define DRV_DESCRIPTION "common routines for IEEE802.11 drivers"
	32
	33	MODULE_DESCRIPTION(DRV_DESCRIPTION);
	34	MODULE_AUTHOR("John W. Linville <linville@tuxdriver.com>");
	35	MODULE_LICENSE("GPL");
	36
274bfb8d JL	37	struct lib80211_crypto_alg {
	38	struct list_head list;
	39	struct lib80211_crypto_ops *ops;
	40	};
	41
	42	static LIST_HEAD(lib80211_crypto_algs);
	43	static DEFINE_SPINLOCK(lib80211_crypto_lock);
	44
9d630c77 PR	45	static void lib80211_crypt_deinit_entries(struct lib80211_crypt_info *info,
	46	int force);
	47	static void lib80211_crypt_quiescing(struct lib80211_crypt_info *info);
e99e88a9	48	static void lib80211_crypt_deinit_handler(struct timer_list *t);
9d630c77	49
2ba4b32e JL	50	int lib80211_crypt_info_init(struct lib80211_crypt_info info, char name,
	51	spinlock_t *lock)
	52	{
	53	memset(info, 0, sizeof(*info));
	54
	55	info->name = name;
	56	info->lock = lock;
	57
	58	INIT_LIST_HEAD(&info->crypt_deinit_list);
e99e88a9 KC	59	timer_setup(&info->crypt_deinit_timer, lib80211_crypt_deinit_handler,
e99e88a9 KC	60	0);
2ba4b32e JL	61
	62	return 0;
	63	}
	64	EXPORT_SYMBOL(lib80211_crypt_info_init);
	65
	66	void lib80211_crypt_info_free(struct lib80211_crypt_info *info)
	67	{
	68	int i;
	69
	70	lib80211_crypt_quiescing(info);
	71	del_timer_sync(&info->crypt_deinit_timer);
	72	lib80211_crypt_deinit_entries(info, 1);
	73
	74	for (i = 0; i < NUM_WEP_KEYS; i++) {
	75	struct lib80211_crypt_data *crypt = info->crypt[i];
	76	if (crypt) {
	77	if (crypt->ops) {
	78	crypt->ops->deinit(crypt->priv);
	79	module_put(crypt->ops->owner);
	80	}
	81	kfree(crypt);
	82	info->crypt[i] = NULL;
	83	}
	84	}
	85	}
	86	EXPORT_SYMBOL(lib80211_crypt_info_free);
	87
9d630c77 PR	88	static void lib80211_crypt_deinit_entries(struct lib80211_crypt_info *info,
9d630c77 PR	89	int force)
7e272fcf	90	{
274bfb8d JL	91	struct lib80211_crypt_data entry, next;
	92	unsigned long flags;
	93
	94	spin_lock_irqsave(info->lock, flags);
	95	list_for_each_entry_safe(entry, next, &info->crypt_deinit_list, list) {
	96	if (atomic_read(&entry->refcnt) != 0 && !force)
	97	continue;
	98
	99	list_del(&entry->list);
	100
	101	if (entry->ops) {
	102	entry->ops->deinit(entry->priv);
	103	module_put(entry->ops->owner);
	104	}
	105	kfree(entry);
	106	}
	107	spin_unlock_irqrestore(info->lock, flags);
	108	}
274bfb8d JL	109
274bfb8d JL	110	/* After this, crypt_deinit_list won't accept new members */
9d630c77	111	static void lib80211_crypt_quiescing(struct lib80211_crypt_info *info)
274bfb8d JL	112	{
	113	unsigned long flags;
	114
	115	spin_lock_irqsave(info->lock, flags);
	116	info->crypt_quiesced = 1;
	117	spin_unlock_irqrestore(info->lock, flags);
	118	}
274bfb8d	119
e99e88a9	120	static void lib80211_crypt_deinit_handler(struct timer_list *t)
274bfb8d	121	{
e99e88a9 KC	122	struct lib80211_crypt_info *info = from_timer(info, t,
e99e88a9 KC	123	crypt_deinit_timer);
274bfb8d JL	124	unsigned long flags;
	125
	126	lib80211_crypt_deinit_entries(info, 0);
	127
	128	spin_lock_irqsave(info->lock, flags);
	129	if (!list_empty(&info->crypt_deinit_list) && !info->crypt_quiesced) {
	130	printk(KERN_DEBUG "%s: entries remaining in delayed crypt "
	131	"deletion list\n", info->name);
	132	info->crypt_deinit_timer.expires = jiffies + HZ;
	133	add_timer(&info->crypt_deinit_timer);
	134	}
	135	spin_unlock_irqrestore(info->lock, flags);
	136	}
274bfb8d JL	137
	138	void lib80211_crypt_delayed_deinit(struct lib80211_crypt_info *info,
	139	struct lib80211_crypt_data **crypt)
	140	{
	141	struct lib80211_crypt_data *tmp;
	142	unsigned long flags;
	143
	144	if (*crypt == NULL)
	145	return;
	146
	147	tmp = *crypt;
	148	*crypt = NULL;
	149
	150	/* must not run ops->deinit() while there may be pending encrypt or
	151	* decrypt operations. Use a list of delayed deinits to avoid needing
	152	* locking. */
	153
	154	spin_lock_irqsave(info->lock, flags);
	155	if (!info->crypt_quiesced) {
	156	list_add(&tmp->list, &info->crypt_deinit_list);
	157	if (!timer_pending(&info->crypt_deinit_timer)) {
	158	info->crypt_deinit_timer.expires = jiffies + HZ;
	159	add_timer(&info->crypt_deinit_timer);
	160	}
	161	}
	162	spin_unlock_irqrestore(info->lock, flags);
	163	}
	164	EXPORT_SYMBOL(lib80211_crypt_delayed_deinit);
	165
	166	int lib80211_register_crypto_ops(struct lib80211_crypto_ops *ops)
	167	{
	168	unsigned long flags;
	169	struct lib80211_crypto_alg *alg;
	170
	171	alg = kzalloc(sizeof(*alg), GFP_KERNEL);
	172	if (alg == NULL)
	173	return -ENOMEM;
	174
	175	alg->ops = ops;
	176
	177	spin_lock_irqsave(&lib80211_crypto_lock, flags);
	178	list_add(&alg->list, &lib80211_crypto_algs);
	179	spin_unlock_irqrestore(&lib80211_crypto_lock, flags);
	180
	181	printk(KERN_DEBUG "lib80211_crypt: registered algorithm '%s'\n",
	182	ops->name);
	183
	184	return 0;
	185	}
	186	EXPORT_SYMBOL(lib80211_register_crypto_ops);
	187
	188	int lib80211_unregister_crypto_ops(struct lib80211_crypto_ops *ops)
	189	{
	190	struct lib80211_crypto_alg *alg;
	191	unsigned long flags;
	192
	193	spin_lock_irqsave(&lib80211_crypto_lock, flags);
	194	list_for_each_entry(alg, &lib80211_crypto_algs, list) {
	195	if (alg->ops == ops)
	196	goto found;
	197	}
	198	spin_unlock_irqrestore(&lib80211_crypto_lock, flags);
	199	return -EINVAL;
	200
201	found:
e9c0268f JP	202	printk(KERN_DEBUG "lib80211_crypt: unregistered algorithm '%s'\n",
e9c0268f JP	203	ops->name);
274bfb8d JL	204	list_del(&alg->list);
	205	spin_unlock_irqrestore(&lib80211_crypto_lock, flags);
	206	kfree(alg);
7e272fcf JL	207	return 0;
7e272fcf JL	208	}
274bfb8d JL	209	EXPORT_SYMBOL(lib80211_unregister_crypto_ops);
	210
	211	struct lib80211_crypto_ops lib80211_get_crypto_ops(const char name)
	212	{
	213	struct lib80211_crypto_alg *alg;
	214	unsigned long flags;
	215
	216	spin_lock_irqsave(&lib80211_crypto_lock, flags);
	217	list_for_each_entry(alg, &lib80211_crypto_algs, list) {
	218	if (strcmp(alg->ops->name, name) == 0)
	219	goto found;
	220	}
	221	spin_unlock_irqrestore(&lib80211_crypto_lock, flags);
	222	return NULL;
	223
	224	found:
	225	spin_unlock_irqrestore(&lib80211_crypto_lock, flags);
	226	return alg->ops;
	227	}
	228	EXPORT_SYMBOL(lib80211_get_crypto_ops);
	229
	230	static void *lib80211_crypt_null_init(int keyidx)
	231	{
	232	return (void *)1;
	233	}
	234
	235	static void lib80211_crypt_null_deinit(void *priv)
	236	{
	237	}
	238
	239	static struct lib80211_crypto_ops lib80211_crypt_null = {
	240	.name = "NULL",
	241	.init = lib80211_crypt_null_init,
	242	.deinit = lib80211_crypt_null_deinit,
	243	.owner = THIS_MODULE,
	244	};
	245
	246	static int __init lib80211_init(void)
	247	{
e9c0268f	248	pr_info(DRV_DESCRIPTION "\n");
274bfb8d JL	249	return lib80211_register_crypto_ops(&lib80211_crypt_null);
274bfb8d JL	250	}
7e272fcf	251
274bfb8d	252	static void __exit lib80211_exit(void)
7e272fcf	253	{
274bfb8d JL	254	lib80211_unregister_crypto_ops(&lib80211_crypt_null);
274bfb8d JL	255	BUG_ON(!list_empty(&lib80211_crypto_algs));
7e272fcf JL	256	}
7e272fcf JL	257
274bfb8d JL	258	module_init(lib80211_init);
274bfb8d JL	259	module_exit(lib80211_exit);