[linux.git] / net / wireless / lib80211.c

/*
 * lib80211 -- common bits for IEEE802.11 drivers
 *
 * Copyright(c) 2008 John W. Linville <[email protected]>
 *
 * Portions copied from old ieee80211 component, w/ original copyright
 * notices below:
 *
 * Host AP crypto routines
 *
 * Copyright (c) 2002-2003, Jouni Malinen <[email protected]>
 * Portions Copyright (C) 2004, Intel Corporation <[email protected]>
 *
 */

#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 <[email protected]>");
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(unsigned long data);

const char *print_ssid(char *buf, const char *ssid, u8 ssid_len)
{
	const char *s = ssid;
	char *d = buf;

	ssid_len = min_t(u8, ssid_len, IEEE80211_MAX_SSID_LEN);
	while (ssid_len--) {
		if (isprint(*s)) {
			*d++ = *s++;
			continue;
		}

		*d++ = '\\';
		if (*s == '\0')
			*d++ = '0';
		else if (*s == '\n')
			*d++ = 'n';
		else if (*s == '\r')
			*d++ = 'r';
		else if (*s == '\t')
			*d++ = 't';
		else if (*s == '\\')
			*d++ = '\\';
		else
			d += snprintf(d, 3, "%03o", *s);
		s++;
	}
	*d = '\0';
	return buf;
}
EXPORT_SYMBOL(print_ssid);

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);
	setup_timer(&info->crypt_deinit_timer, lib80211_crypt_deinit_handler,
			(unsigned long)info);

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