api.c 13.4 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5
/*
 * Scatterlist Cryptographic API.
 *
 * Copyright (c) 2002 James Morris <jmorris@intercode.com.au>
 * Copyright (c) 2002 David S. Miller (davem@redhat.com)
6
 * Copyright (c) 2005 Herbert Xu <herbert@gondor.apana.org.au>
Linus Torvalds's avatar
Linus Torvalds committed
7 8
 *
 * Portions derived from Cryptoapi, by Alexander Kjeldaas <astor@fast.no>
9
 * and Nettle, by Niels Möller.
Linus Torvalds's avatar
Linus Torvalds committed
10 11 12
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
13
 * Software Foundation; either version 2 of the License, or (at your option)
Linus Torvalds's avatar
Linus Torvalds committed
14 15 16
 * any later version.
 *
 */
17

Herbert Xu's avatar
Herbert Xu committed
18
#include <linux/err.h>
Linus Torvalds's avatar
Linus Torvalds committed
19
#include <linux/errno.h>
20
#include <linux/kernel.h>
21
#include <linux/kmod.h>
Herbert Xu's avatar
Herbert Xu committed
22
#include <linux/module.h>
23
#include <linux/param.h>
Herbert Xu's avatar
Herbert Xu committed
24
#include <linux/sched.h>
Linus Torvalds's avatar
Linus Torvalds committed
25
#include <linux/slab.h>
26
#include <linux/string.h>
Linus Torvalds's avatar
Linus Torvalds committed
27 28 29
#include "internal.h"

LIST_HEAD(crypto_alg_list);
30
EXPORT_SYMBOL_GPL(crypto_alg_list);
Linus Torvalds's avatar
Linus Torvalds committed
31
DECLARE_RWSEM(crypto_alg_sem);
32
EXPORT_SYMBOL_GPL(crypto_alg_sem);
Linus Torvalds's avatar
Linus Torvalds committed
33

34 35 36
BLOCKING_NOTIFIER_HEAD(crypto_chain);
EXPORT_SYMBOL_GPL(crypto_chain);

37
static inline struct crypto_alg *crypto_alg_get(struct crypto_alg *alg)
Linus Torvalds's avatar
Linus Torvalds committed
38
{
39 40 41 42
	atomic_inc(&alg->cra_refcnt);
	return alg;
}

43
struct crypto_alg *crypto_mod_get(struct crypto_alg *alg)
44 45
{
	return try_module_get(alg->cra_module) ? crypto_alg_get(alg) : NULL;
Linus Torvalds's avatar
Linus Torvalds committed
46
}
47
EXPORT_SYMBOL_GPL(crypto_mod_get);
Linus Torvalds's avatar
Linus Torvalds committed
48

49
void crypto_mod_put(struct crypto_alg *alg)
Linus Torvalds's avatar
Linus Torvalds committed
50
{
51 52
	struct module *module = alg->cra_module;

53
	crypto_alg_put(alg);
54
	module_put(module);
Linus Torvalds's avatar
Linus Torvalds committed
55
}
56
EXPORT_SYMBOL_GPL(crypto_mod_put);
Linus Torvalds's avatar
Linus Torvalds committed
57

58 59 60 61 62
static inline int crypto_is_test_larval(struct crypto_larval *larval)
{
	return larval->alg.cra_driver_name[0];
}

63 64
static struct crypto_alg *__crypto_alg_lookup(const char *name, u32 type,
					      u32 mask)
Linus Torvalds's avatar
Linus Torvalds committed
65 66
{
	struct crypto_alg *q, *alg = NULL;
67
	int best = -2;
Linus Torvalds's avatar
Linus Torvalds committed
68 69

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

Herbert Xu's avatar
Herbert Xu committed
72 73 74
		if (crypto_is_moribund(q))
			continue;

75 76 77 78
		if ((q->cra_flags ^ type) & mask)
			continue;

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

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

88
		if (unlikely(!crypto_mod_get(q)))
89 90 91 92
			continue;

		best = q->cra_priority;
		if (alg)
93
			crypto_mod_put(alg);
94 95 96
		alg = q;

		if (exact)
Linus Torvalds's avatar
Linus Torvalds committed
97 98
			break;
	}
99 100 101 102 103 104 105 106 107 108 109 110 111 112

	return alg;
}

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

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

113
struct crypto_larval *crypto_larval_alloc(const char *name, u32 type, u32 mask)
114 115 116 117 118
{
	struct crypto_larval *larval;

	larval = kzalloc(sizeof(*larval), GFP_KERNEL);
	if (!larval)
Herbert Xu's avatar
Herbert Xu committed
119
		return ERR_PTR(-ENOMEM);
120

121 122
	larval->mask = mask;
	larval->alg.cra_flags = CRYPTO_ALG_LARVAL | type;
123 124 125 126 127 128
	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);

129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
	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);

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

145
	down_write(&crypto_alg_sem);
146
	alg = __crypto_alg_lookup(name, type, mask);
147 148 149 150 151 152 153 154 155 156 157 158
	if (!alg) {
		alg = &larval->alg;
		list_add(&alg->cra_list, &crypto_alg_list);
	}
	up_write(&crypto_alg_sem);

	if (alg != &larval->alg)
		kfree(larval);

	return alg;
}

159
void crypto_larval_kill(struct crypto_alg *alg)
160 161 162 163 164 165
{
	struct crypto_larval *larval = (void *)alg;

	down_write(&crypto_alg_sem);
	list_del(&alg->cra_list);
	up_write(&crypto_alg_sem);
166
	complete_all(&larval->completion);
167 168
	crypto_alg_put(alg);
}
169
EXPORT_SYMBOL_GPL(crypto_larval_kill);
170 171 172 173

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

	timeout = wait_for_completion_interruptible_timeout(
		&larval->completion, 60 * HZ);
178 179

	alg = larval->adult;
180 181 182 183 184
	if (timeout < 0)
		alg = ERR_PTR(-EINTR);
	else if (!timeout)
		alg = ERR_PTR(-ETIMEDOUT);
	else if (!alg)
Herbert Xu's avatar
Herbert Xu committed
185
		alg = ERR_PTR(-ENOENT);
186 187 188 189 190
	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);
191 192 193 194 195
	crypto_mod_put(&larval->alg);

	return alg;
}

196
struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask)
197 198 199 200
{
	struct crypto_alg *alg;

	down_read(&crypto_alg_sem);
201
	alg = __crypto_alg_lookup(name, type, mask);
Linus Torvalds's avatar
Linus Torvalds committed
202
	up_read(&crypto_alg_sem);
203

Linus Torvalds's avatar
Linus Torvalds committed
204 205
	return alg;
}
206
EXPORT_SYMBOL_GPL(crypto_alg_lookup);
Linus Torvalds's avatar
Linus Torvalds committed
207

208
struct crypto_alg *crypto_larval_lookup(const char *name, u32 type, u32 mask)
209
{
210 211
	struct crypto_alg *alg;

Herbert Xu's avatar
Herbert Xu committed
212 213 214 215
	if (!name)
		return ERR_PTR(-ENOENT);

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

218 219
	alg = crypto_alg_lookup(name, type, mask);
	if (!alg) {
220
		request_module("%s", name);
221

222
		if (!((type ^ CRYPTO_ALG_NEED_FALLBACK) & mask &
223 224
		      CRYPTO_ALG_NEED_FALLBACK))
			request_module("%s-all", name);
225 226 227 228

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

229 230 231
	if (alg)
		return crypto_is_larval(alg) ? crypto_larval_wait(alg) : alg;

232
	return crypto_larval_add(name, type, mask);
233 234 235
}
EXPORT_SYMBOL_GPL(crypto_larval_lookup);

236 237 238 239 240 241 242 243 244 245 246 247 248 249
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);

250 251 252 253 254 255
struct crypto_alg *crypto_alg_mod_lookup(const char *name, u32 type, u32 mask)
{
	struct crypto_alg *alg;
	struct crypto_alg *larval;
	int ok;

256
	if (!((type | mask) & CRYPTO_ALG_TESTED)) {
257 258 259 260
		type |= CRYPTO_ALG_TESTED;
		mask |= CRYPTO_ALG_TESTED;
	}

261
	larval = crypto_larval_lookup(name, type, mask);
Herbert Xu's avatar
Herbert Xu committed
262
	if (IS_ERR(larval) || !crypto_is_larval(larval))
263 264
		return larval;

265
	ok = crypto_probing_notify(CRYPTO_MSG_ALG_REQUEST, larval);
Herbert Xu's avatar
Herbert Xu committed
266 267

	if (ok == NOTIFY_STOP)
268 269 270
		alg = crypto_larval_wait(larval);
	else {
		crypto_mod_put(larval);
Herbert Xu's avatar
Herbert Xu committed
271
		alg = ERR_PTR(-ENOENT);
272 273 274
	}
	crypto_larval_kill(larval);
	return alg;
275
}
276
EXPORT_SYMBOL_GPL(crypto_alg_mod_lookup);
277

278
static int crypto_init_ops(struct crypto_tfm *tfm, u32 type, u32 mask)
Linus Torvalds's avatar
Linus Torvalds committed
279
{
280
	const struct crypto_type *type_obj = tfm->__crt_alg->cra_type;
281

282 283
	if (type_obj)
		return type_obj->init(tfm, type, mask);
284

Linus Torvalds's avatar
Linus Torvalds committed
285 286 287
	switch (crypto_tfm_alg_type(tfm)) {
	case CRYPTO_ALG_TYPE_CIPHER:
		return crypto_init_cipher_ops(tfm);
288

Linus Torvalds's avatar
Linus Torvalds committed
289 290
	case CRYPTO_ALG_TYPE_COMPRESS:
		return crypto_init_compress_ops(tfm);
291

Linus Torvalds's avatar
Linus Torvalds committed
292 293 294
	default:
		break;
	}
295

Linus Torvalds's avatar
Linus Torvalds committed
296 297 298 299 300 301
	BUG();
	return -EINVAL;
}

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

	if (type) {
305 306
		if (tfm->exit)
			tfm->exit(tfm);
307 308 309
		return;
	}

Linus Torvalds's avatar
Linus Torvalds committed
310 311 312 313
	switch (crypto_tfm_alg_type(tfm)) {
	case CRYPTO_ALG_TYPE_CIPHER:
		crypto_exit_cipher_ops(tfm);
		break;
314

Linus Torvalds's avatar
Linus Torvalds committed
315 316 317
	case CRYPTO_ALG_TYPE_COMPRESS:
		crypto_exit_compress_ops(tfm);
		break;
318

Linus Torvalds's avatar
Linus Torvalds committed
319 320 321 322 323
	default:
		BUG();
	}
}

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

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

333 334 335 336 337
	switch (alg->cra_flags & CRYPTO_ALG_TYPE_MASK) {
	default:
		BUG();

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

341
	case CRYPTO_ALG_TYPE_COMPRESS:
342
		len += crypto_compress_ctxsize(alg);
343 344 345
		break;
	}

346
	return len;
347 348
}

Herbert Xu's avatar
Herbert Xu committed
349 350 351 352 353 354 355 356
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);

357 358
struct crypto_tfm *__crypto_alloc_tfm(struct crypto_alg *alg, u32 type,
				      u32 mask)
Linus Torvalds's avatar
Linus Torvalds committed
359 360
{
	struct crypto_tfm *tfm = NULL;
361
	unsigned int tfm_size;
Herbert Xu's avatar
Herbert Xu committed
362
	int err = -ENOMEM;
363

364
	tfm_size = sizeof(*tfm) + crypto_ctxsize(alg, type, mask);
365
	tfm = kzalloc(tfm_size, GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
366
	if (tfm == NULL)
367
		goto out_err;
Linus Torvalds's avatar
Linus Torvalds committed
368 369

	tfm->__crt_alg = alg;
Herbert Xu's avatar
Herbert Xu committed
370

371
	err = crypto_init_ops(tfm, type, mask);
Herbert Xu's avatar
Herbert Xu committed
372
	if (err)
Linus Torvalds's avatar
Linus Torvalds committed
373
		goto out_free_tfm;
374

375
	if (!tfm->exit && alg->cra_init && (err = alg->cra_init(tfm)))
376
		goto cra_init_failed;
Linus Torvalds's avatar
Linus Torvalds committed
377 378 379

	goto out;

380 381
cra_init_failed:
	crypto_exit_ops(tfm);
Linus Torvalds's avatar
Linus Torvalds committed
382
out_free_tfm:
383 384
	if (err == -EAGAIN)
		crypto_shoot_alg(alg);
Linus Torvalds's avatar
Linus Torvalds committed
385
	kfree(tfm);
386
out_err:
Herbert Xu's avatar
Herbert Xu committed
387
	tfm = ERR_PTR(err);
Linus Torvalds's avatar
Linus Torvalds committed
388 389 390
out:
	return tfm;
}
Herbert Xu's avatar
Herbert Xu committed
391 392
EXPORT_SYMBOL_GPL(__crypto_alloc_tfm);

393 394 395 396 397 398
/*
 *	crypto_alloc_base - Locate algorithm and allocate transform
 *	@alg_name: Name of algorithm
 *	@type: Type of algorithm
 *	@mask: Mask for type comparison
 *
399 400 401
 *	This function should not be used by new algorithm types.
 *	Plesae use crypto_alloc_tfm instead.
 *
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
 *	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_blkcipher.
 *
 *	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);
424 425
		if (IS_ERR(alg)) {
			err = PTR_ERR(alg);
426
			goto err;
427
		}
428

429
		tfm = __crypto_alloc_tfm(alg, type, mask);
430
		if (!IS_ERR(tfm))
431
			return tfm;
432 433 434 435 436 437 438 439 440 441 442

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

err:
		if (err != -EAGAIN)
			break;
		if (signal_pending(current)) {
			err = -EINTR;
			break;
		}
443
	}
444

445
	return ERR_PTR(err);
446 447
}
EXPORT_SYMBOL_GPL(crypto_alloc_base);
448

449 450
void *crypto_create_tfm(struct crypto_alg *alg,
			const struct crypto_type *frontend)
451 452 453 454 455 456 457 458
{
	char *mem;
	struct crypto_tfm *tfm = NULL;
	unsigned int tfmsize;
	unsigned int total;
	int err = -ENOMEM;

	tfmsize = frontend->tfmsize;
459
	total = tfmsize + sizeof(*tfm) + frontend->extsize(alg);
460 461 462 463 464 465 466 467

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

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

468
	err = frontend->init_tfm(tfm);
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
	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:
484
	mem = ERR_PTR(err);
485
out:
486
	return mem;
487 488 489
}
EXPORT_SYMBOL_GPL(crypto_create_tfm);

490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
struct crypto_alg *crypto_find_alg(const char *alg_name,
				   const struct crypto_type *frontend,
				   u32 type, u32 mask)
{
	struct crypto_alg *(*lookup)(const char *name, u32 type, u32 mask) =
		crypto_alg_mod_lookup;

	if (frontend) {
		type &= frontend->maskclear;
		mask &= frontend->maskclear;
		type |= frontend->type;
		mask |= frontend->maskset;

		if (frontend->lookup)
			lookup = frontend->lookup;
	}

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

511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
/*
 *	crypto_alloc_tfm - Locate algorithm and allocate transform
 *	@alg_name: Name of algorithm
 *	@frontend: Frontend algorithm type
 *	@type: Type of algorithm
 *	@mask: Mask for type comparison
 *
 *	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_blkcipher.
 *
 *	In case of error the return value is an error pointer.
 */
531 532
void *crypto_alloc_tfm(const char *alg_name,
		       const struct crypto_type *frontend, u32 type, u32 mask)
533
{
534
	void *tfm;
535 536 537 538 539
	int err;

	for (;;) {
		struct crypto_alg *alg;

540
		alg = crypto_find_alg(alg_name, frontend, type, mask);
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
		if (IS_ERR(alg)) {
			err = PTR_ERR(alg);
			goto err;
		}

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

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

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

	return ERR_PTR(err);
}
EXPORT_SYMBOL_GPL(crypto_alloc_tfm);
565

566
/*
567 568
 *	crypto_destroy_tfm - Free crypto transform
 *	@mem: Start of tfm slab
569 570
 *	@tfm: Transform to free
 *
571
 *	This function frees up the transform and any associated resources,
572 573
 *	then drops the refcount on the associated algorithm.
 */
574
void crypto_destroy_tfm(void *mem, struct crypto_tfm *tfm)
Linus Torvalds's avatar
Linus Torvalds committed
575
{
576 577
	struct crypto_alg *alg;

578
	if (unlikely(!mem))
579 580 581
		return;

	alg = tfm->__crt_alg;
Linus Torvalds's avatar
Linus Torvalds committed
582

583
	if (!tfm->exit && alg->cra_exit)
584
		alg->cra_exit(tfm);
Linus Torvalds's avatar
Linus Torvalds committed
585
	crypto_exit_ops(tfm);
586
	crypto_mod_put(alg);
Johannes Weiner's avatar
Johannes Weiner committed
587
	kzfree(mem);
Linus Torvalds's avatar
Linus Torvalds committed
588
}
589
EXPORT_SYMBOL_GPL(crypto_destroy_tfm);
590 591 592 593 594

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

596 597 598 599
	if (!IS_ERR(alg)) {
		crypto_mod_put(alg);
		ret = 1;
	}
600

601 602 603
	return ret;
}
EXPORT_SYMBOL_GPL(crypto_has_alg);
604 605 606

MODULE_DESCRIPTION("Cryptographic core API");
MODULE_LICENSE("GPL");