xref: /linux/crypto/af_alg.c (revision 77ebdabe8de7c02f43c6de3357f79ff96f9f0579)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * af_alg: User-space algorithm interface
4  *
5  * This file provides the user-space API for algorithms.
6  *
7  * Copyright (c) 2010 Herbert Xu <herbert@gondor.apana.org.au>
8  */
9 
10 #include <linux/atomic.h>
11 #include <crypto/if_alg.h>
12 #include <linux/crypto.h>
13 #include <linux/init.h>
14 #include <linux/kernel.h>
15 #include <linux/list.h>
16 #include <linux/module.h>
17 #include <linux/net.h>
18 #include <linux/rwsem.h>
19 #include <linux/sched/signal.h>
20 #include <linux/security.h>
21 
22 struct alg_type_list {
23 	const struct af_alg_type *type;
24 	struct list_head list;
25 };
26 
27 static atomic_long_t alg_memory_allocated;
28 
29 static struct proto alg_proto = {
30 	.name			= "ALG",
31 	.owner			= THIS_MODULE,
32 	.memory_allocated	= &alg_memory_allocated,
33 	.obj_size		= sizeof(struct alg_sock),
34 };
35 
36 static LIST_HEAD(alg_types);
37 static DECLARE_RWSEM(alg_types_sem);
38 
39 static const struct af_alg_type *alg_get_type(const char *name)
40 {
41 	const struct af_alg_type *type = ERR_PTR(-ENOENT);
42 	struct alg_type_list *node;
43 
44 	down_read(&alg_types_sem);
45 	list_for_each_entry(node, &alg_types, list) {
46 		if (strcmp(node->type->name, name))
47 			continue;
48 
49 		if (try_module_get(node->type->owner))
50 			type = node->type;
51 		break;
52 	}
53 	up_read(&alg_types_sem);
54 
55 	return type;
56 }
57 
58 int af_alg_register_type(const struct af_alg_type *type)
59 {
60 	struct alg_type_list *node;
61 	int err = -EEXIST;
62 
63 	down_write(&alg_types_sem);
64 	list_for_each_entry(node, &alg_types, list) {
65 		if (!strcmp(node->type->name, type->name))
66 			goto unlock;
67 	}
68 
69 	node = kmalloc(sizeof(*node), GFP_KERNEL);
70 	err = -ENOMEM;
71 	if (!node)
72 		goto unlock;
73 
74 	type->ops->owner = THIS_MODULE;
75 	if (type->ops_nokey)
76 		type->ops_nokey->owner = THIS_MODULE;
77 	node->type = type;
78 	list_add(&node->list, &alg_types);
79 	err = 0;
80 
81 unlock:
82 	up_write(&alg_types_sem);
83 
84 	return err;
85 }
86 EXPORT_SYMBOL_GPL(af_alg_register_type);
87 
88 int af_alg_unregister_type(const struct af_alg_type *type)
89 {
90 	struct alg_type_list *node;
91 	int err = -ENOENT;
92 
93 	down_write(&alg_types_sem);
94 	list_for_each_entry(node, &alg_types, list) {
95 		if (strcmp(node->type->name, type->name))
96 			continue;
97 
98 		list_del(&node->list);
99 		kfree(node);
100 		err = 0;
101 		break;
102 	}
103 	up_write(&alg_types_sem);
104 
105 	return err;
106 }
107 EXPORT_SYMBOL_GPL(af_alg_unregister_type);
108 
109 static void alg_do_release(const struct af_alg_type *type, void *private)
110 {
111 	if (!type)
112 		return;
113 
114 	type->release(private);
115 	module_put(type->owner);
116 }
117 
118 int af_alg_release(struct socket *sock)
119 {
120 	if (sock->sk) {
121 		sock_put(sock->sk);
122 		sock->sk = NULL;
123 	}
124 	return 0;
125 }
126 EXPORT_SYMBOL_GPL(af_alg_release);
127 
128 void af_alg_release_parent(struct sock *sk)
129 {
130 	struct alg_sock *ask = alg_sk(sk);
131 	unsigned int nokey = atomic_read(&ask->nokey_refcnt);
132 
133 	sk = ask->parent;
134 	ask = alg_sk(sk);
135 
136 	if (nokey)
137 		atomic_dec(&ask->nokey_refcnt);
138 
139 	if (atomic_dec_and_test(&ask->refcnt))
140 		sock_put(sk);
141 }
142 EXPORT_SYMBOL_GPL(af_alg_release_parent);
143 
144 static int alg_bind(struct socket *sock, struct sockaddr *uaddr, int addr_len)
145 {
146 	const u32 allowed = CRYPTO_ALG_KERN_DRIVER_ONLY;
147 	struct sock *sk = sock->sk;
148 	struct alg_sock *ask = alg_sk(sk);
149 	struct sockaddr_alg *sa = (void *)uaddr;
150 	const struct af_alg_type *type;
151 	void *private;
152 	int err;
153 
154 	if (sock->state == SS_CONNECTED)
155 		return -EINVAL;
156 
157 	if (addr_len < sizeof(*sa))
158 		return -EINVAL;
159 
160 	/* If caller uses non-allowed flag, return error. */
161 	if ((sa->salg_feat & ~allowed) || (sa->salg_mask & ~allowed))
162 		return -EINVAL;
163 
164 	sa->salg_type[sizeof(sa->salg_type) - 1] = 0;
165 	sa->salg_name[sizeof(sa->salg_name) + addr_len - sizeof(*sa) - 1] = 0;
166 
167 	type = alg_get_type(sa->salg_type);
168 	if (PTR_ERR(type) == -ENOENT) {
169 		request_module("algif-%s", sa->salg_type);
170 		type = alg_get_type(sa->salg_type);
171 	}
172 
173 	if (IS_ERR(type))
174 		return PTR_ERR(type);
175 
176 	private = type->bind(sa->salg_name, sa->salg_feat, sa->salg_mask);
177 	if (IS_ERR(private)) {
178 		module_put(type->owner);
179 		return PTR_ERR(private);
180 	}
181 
182 	err = -EBUSY;
183 	lock_sock(sk);
184 	if (atomic_read(&ask->refcnt))
185 		goto unlock;
186 
187 	swap(ask->type, type);
188 	swap(ask->private, private);
189 
190 	err = 0;
191 
192 unlock:
193 	release_sock(sk);
194 
195 	alg_do_release(type, private);
196 
197 	return err;
198 }
199 
200 static int alg_setkey(struct sock *sk, sockptr_t ukey, unsigned int keylen)
201 {
202 	struct alg_sock *ask = alg_sk(sk);
203 	const struct af_alg_type *type = ask->type;
204 	u8 *key;
205 	int err;
206 
207 	key = sock_kmalloc(sk, keylen, GFP_KERNEL);
208 	if (!key)
209 		return -ENOMEM;
210 
211 	err = -EFAULT;
212 	if (copy_from_sockptr(key, ukey, keylen))
213 		goto out;
214 
215 	err = type->setkey(ask->private, key, keylen);
216 
217 out:
218 	sock_kzfree_s(sk, key, keylen);
219 
220 	return err;
221 }
222 
223 static int alg_setsockopt(struct socket *sock, int level, int optname,
224 			  sockptr_t optval, unsigned int optlen)
225 {
226 	struct sock *sk = sock->sk;
227 	struct alg_sock *ask = alg_sk(sk);
228 	const struct af_alg_type *type;
229 	int err = -EBUSY;
230 
231 	lock_sock(sk);
232 	if (atomic_read(&ask->refcnt) != atomic_read(&ask->nokey_refcnt))
233 		goto unlock;
234 
235 	type = ask->type;
236 
237 	err = -ENOPROTOOPT;
238 	if (level != SOL_ALG || !type)
239 		goto unlock;
240 
241 	switch (optname) {
242 	case ALG_SET_KEY:
243 		if (sock->state == SS_CONNECTED)
244 			goto unlock;
245 		if (!type->setkey)
246 			goto unlock;
247 
248 		err = alg_setkey(sk, optval, optlen);
249 		break;
250 	case ALG_SET_AEAD_AUTHSIZE:
251 		if (sock->state == SS_CONNECTED)
252 			goto unlock;
253 		if (!type->setauthsize)
254 			goto unlock;
255 		err = type->setauthsize(ask->private, optlen);
256 		break;
257 	case ALG_SET_DRBG_ENTROPY:
258 		if (sock->state == SS_CONNECTED)
259 			goto unlock;
260 		if (!type->setentropy)
261 			goto unlock;
262 
263 		err = type->setentropy(ask->private, optval, optlen);
264 	}
265 
266 unlock:
267 	release_sock(sk);
268 
269 	return err;
270 }
271 
272 int af_alg_accept(struct sock *sk, struct socket *newsock, bool kern)
273 {
274 	struct alg_sock *ask = alg_sk(sk);
275 	const struct af_alg_type *type;
276 	struct sock *sk2;
277 	unsigned int nokey;
278 	int err;
279 
280 	lock_sock(sk);
281 	type = ask->type;
282 
283 	err = -EINVAL;
284 	if (!type)
285 		goto unlock;
286 
287 	sk2 = sk_alloc(sock_net(sk), PF_ALG, GFP_KERNEL, &alg_proto, kern);
288 	err = -ENOMEM;
289 	if (!sk2)
290 		goto unlock;
291 
292 	sock_init_data(newsock, sk2);
293 	security_sock_graft(sk2, newsock);
294 	security_sk_clone(sk, sk2);
295 
296 	/*
297 	 * newsock->ops assigned here to allow type->accept call to override
298 	 * them when required.
299 	 */
300 	newsock->ops = type->ops;
301 	err = type->accept(ask->private, sk2);
302 
303 	nokey = err == -ENOKEY;
304 	if (nokey && type->accept_nokey)
305 		err = type->accept_nokey(ask->private, sk2);
306 
307 	if (err)
308 		goto unlock;
309 
310 	if (atomic_inc_return_relaxed(&ask->refcnt) == 1)
311 		sock_hold(sk);
312 	if (nokey) {
313 		atomic_inc(&ask->nokey_refcnt);
314 		atomic_set(&alg_sk(sk2)->nokey_refcnt, 1);
315 	}
316 	alg_sk(sk2)->parent = sk;
317 	alg_sk(sk2)->type = type;
318 
319 	newsock->state = SS_CONNECTED;
320 
321 	if (nokey)
322 		newsock->ops = type->ops_nokey;
323 
324 	err = 0;
325 
326 unlock:
327 	release_sock(sk);
328 
329 	return err;
330 }
331 EXPORT_SYMBOL_GPL(af_alg_accept);
332 
333 static int alg_accept(struct socket *sock, struct socket *newsock, int flags,
334 		      bool kern)
335 {
336 	return af_alg_accept(sock->sk, newsock, kern);
337 }
338 
339 static const struct proto_ops alg_proto_ops = {
340 	.family		=	PF_ALG,
341 	.owner		=	THIS_MODULE,
342 
343 	.connect	=	sock_no_connect,
344 	.socketpair	=	sock_no_socketpair,
345 	.getname	=	sock_no_getname,
346 	.ioctl		=	sock_no_ioctl,
347 	.listen		=	sock_no_listen,
348 	.shutdown	=	sock_no_shutdown,
349 	.mmap		=	sock_no_mmap,
350 	.sendpage	=	sock_no_sendpage,
351 	.sendmsg	=	sock_no_sendmsg,
352 	.recvmsg	=	sock_no_recvmsg,
353 
354 	.bind		=	alg_bind,
355 	.release	=	af_alg_release,
356 	.setsockopt	=	alg_setsockopt,
357 	.accept		=	alg_accept,
358 };
359 
360 static void alg_sock_destruct(struct sock *sk)
361 {
362 	struct alg_sock *ask = alg_sk(sk);
363 
364 	alg_do_release(ask->type, ask->private);
365 }
366 
367 static int alg_create(struct net *net, struct socket *sock, int protocol,
368 		      int kern)
369 {
370 	struct sock *sk;
371 	int err;
372 
373 	if (sock->type != SOCK_SEQPACKET)
374 		return -ESOCKTNOSUPPORT;
375 	if (protocol != 0)
376 		return -EPROTONOSUPPORT;
377 
378 	err = -ENOMEM;
379 	sk = sk_alloc(net, PF_ALG, GFP_KERNEL, &alg_proto, kern);
380 	if (!sk)
381 		goto out;
382 
383 	sock->ops = &alg_proto_ops;
384 	sock_init_data(sock, sk);
385 
386 	sk->sk_destruct = alg_sock_destruct;
387 
388 	return 0;
389 out:
390 	return err;
391 }
392 
393 static const struct net_proto_family alg_family = {
394 	.family	=	PF_ALG,
395 	.create	=	alg_create,
396 	.owner	=	THIS_MODULE,
397 };
398 
399 int af_alg_make_sg(struct af_alg_sgl *sgl, struct iov_iter *iter, int len)
400 {
401 	size_t off;
402 	ssize_t n;
403 	int npages, i;
404 
405 	n = iov_iter_get_pages(iter, sgl->pages, len, ALG_MAX_PAGES, &off);
406 	if (n < 0)
407 		return n;
408 
409 	npages = (off + n + PAGE_SIZE - 1) >> PAGE_SHIFT;
410 	if (WARN_ON(npages == 0))
411 		return -EINVAL;
412 	/* Add one extra for linking */
413 	sg_init_table(sgl->sg, npages + 1);
414 
415 	for (i = 0, len = n; i < npages; i++) {
416 		int plen = min_t(int, len, PAGE_SIZE - off);
417 
418 		sg_set_page(sgl->sg + i, sgl->pages[i], plen, off);
419 
420 		off = 0;
421 		len -= plen;
422 	}
423 	sg_mark_end(sgl->sg + npages - 1);
424 	sgl->npages = npages;
425 
426 	return n;
427 }
428 EXPORT_SYMBOL_GPL(af_alg_make_sg);
429 
430 static void af_alg_link_sg(struct af_alg_sgl *sgl_prev,
431 			   struct af_alg_sgl *sgl_new)
432 {
433 	sg_unmark_end(sgl_prev->sg + sgl_prev->npages - 1);
434 	sg_chain(sgl_prev->sg, sgl_prev->npages + 1, sgl_new->sg);
435 }
436 
437 void af_alg_free_sg(struct af_alg_sgl *sgl)
438 {
439 	int i;
440 
441 	for (i = 0; i < sgl->npages; i++)
442 		put_page(sgl->pages[i]);
443 }
444 EXPORT_SYMBOL_GPL(af_alg_free_sg);
445 
446 static int af_alg_cmsg_send(struct msghdr *msg, struct af_alg_control *con)
447 {
448 	struct cmsghdr *cmsg;
449 
450 	for_each_cmsghdr(cmsg, msg) {
451 		if (!CMSG_OK(msg, cmsg))
452 			return -EINVAL;
453 		if (cmsg->cmsg_level != SOL_ALG)
454 			continue;
455 
456 		switch (cmsg->cmsg_type) {
457 		case ALG_SET_IV:
458 			if (cmsg->cmsg_len < CMSG_LEN(sizeof(*con->iv)))
459 				return -EINVAL;
460 			con->iv = (void *)CMSG_DATA(cmsg);
461 			if (cmsg->cmsg_len < CMSG_LEN(con->iv->ivlen +
462 						      sizeof(*con->iv)))
463 				return -EINVAL;
464 			break;
465 
466 		case ALG_SET_OP:
467 			if (cmsg->cmsg_len < CMSG_LEN(sizeof(u32)))
468 				return -EINVAL;
469 			con->op = *(u32 *)CMSG_DATA(cmsg);
470 			break;
471 
472 		case ALG_SET_AEAD_ASSOCLEN:
473 			if (cmsg->cmsg_len < CMSG_LEN(sizeof(u32)))
474 				return -EINVAL;
475 			con->aead_assoclen = *(u32 *)CMSG_DATA(cmsg);
476 			break;
477 
478 		default:
479 			return -EINVAL;
480 		}
481 	}
482 
483 	return 0;
484 }
485 
486 /**
487  * af_alg_alloc_tsgl - allocate the TX SGL
488  *
489  * @sk socket of connection to user space
490  * @return: 0 upon success, < 0 upon error
491  */
492 static int af_alg_alloc_tsgl(struct sock *sk)
493 {
494 	struct alg_sock *ask = alg_sk(sk);
495 	struct af_alg_ctx *ctx = ask->private;
496 	struct af_alg_tsgl *sgl;
497 	struct scatterlist *sg = NULL;
498 
499 	sgl = list_entry(ctx->tsgl_list.prev, struct af_alg_tsgl, list);
500 	if (!list_empty(&ctx->tsgl_list))
501 		sg = sgl->sg;
502 
503 	if (!sg || sgl->cur >= MAX_SGL_ENTS) {
504 		sgl = sock_kmalloc(sk,
505 				   struct_size(sgl, sg, (MAX_SGL_ENTS + 1)),
506 				   GFP_KERNEL);
507 		if (!sgl)
508 			return -ENOMEM;
509 
510 		sg_init_table(sgl->sg, MAX_SGL_ENTS + 1);
511 		sgl->cur = 0;
512 
513 		if (sg)
514 			sg_chain(sg, MAX_SGL_ENTS + 1, sgl->sg);
515 
516 		list_add_tail(&sgl->list, &ctx->tsgl_list);
517 	}
518 
519 	return 0;
520 }
521 
522 /**
523  * aead_count_tsgl - Count number of TX SG entries
524  *
525  * The counting starts from the beginning of the SGL to @bytes. If
526  * an offset is provided, the counting of the SG entries starts at the offset.
527  *
528  * @sk socket of connection to user space
529  * @bytes Count the number of SG entries holding given number of bytes.
530  * @offset Start the counting of SG entries from the given offset.
531  * @return Number of TX SG entries found given the constraints
532  */
533 unsigned int af_alg_count_tsgl(struct sock *sk, size_t bytes, size_t offset)
534 {
535 	const struct alg_sock *ask = alg_sk(sk);
536 	const struct af_alg_ctx *ctx = ask->private;
537 	const struct af_alg_tsgl *sgl;
538 	unsigned int i;
539 	unsigned int sgl_count = 0;
540 
541 	if (!bytes)
542 		return 0;
543 
544 	list_for_each_entry(sgl, &ctx->tsgl_list, list) {
545 		const struct scatterlist *sg = sgl->sg;
546 
547 		for (i = 0; i < sgl->cur; i++) {
548 			size_t bytes_count;
549 
550 			/* Skip offset */
551 			if (offset >= sg[i].length) {
552 				offset -= sg[i].length;
553 				bytes -= sg[i].length;
554 				continue;
555 			}
556 
557 			bytes_count = sg[i].length - offset;
558 
559 			offset = 0;
560 			sgl_count++;
561 
562 			/* If we have seen requested number of bytes, stop */
563 			if (bytes_count >= bytes)
564 				return sgl_count;
565 
566 			bytes -= bytes_count;
567 		}
568 	}
569 
570 	return sgl_count;
571 }
572 EXPORT_SYMBOL_GPL(af_alg_count_tsgl);
573 
574 /**
575  * aead_pull_tsgl - Release the specified buffers from TX SGL
576  *
577  * If @dst is non-null, reassign the pages to dst. The caller must release
578  * the pages. If @dst_offset is given only reassign the pages to @dst starting
579  * at the @dst_offset (byte). The caller must ensure that @dst is large
580  * enough (e.g. by using af_alg_count_tsgl with the same offset).
581  *
582  * @sk socket of connection to user space
583  * @used Number of bytes to pull from TX SGL
584  * @dst If non-NULL, buffer is reassigned to dst SGL instead of releasing. The
585  *	caller must release the buffers in dst.
586  * @dst_offset Reassign the TX SGL from given offset. All buffers before
587  *	       reaching the offset is released.
588  */
589 void af_alg_pull_tsgl(struct sock *sk, size_t used, struct scatterlist *dst,
590 		      size_t dst_offset)
591 {
592 	struct alg_sock *ask = alg_sk(sk);
593 	struct af_alg_ctx *ctx = ask->private;
594 	struct af_alg_tsgl *sgl;
595 	struct scatterlist *sg;
596 	unsigned int i, j = 0;
597 
598 	while (!list_empty(&ctx->tsgl_list)) {
599 		sgl = list_first_entry(&ctx->tsgl_list, struct af_alg_tsgl,
600 				       list);
601 		sg = sgl->sg;
602 
603 		for (i = 0; i < sgl->cur; i++) {
604 			size_t plen = min_t(size_t, used, sg[i].length);
605 			struct page *page = sg_page(sg + i);
606 
607 			if (!page)
608 				continue;
609 
610 			/*
611 			 * Assumption: caller created af_alg_count_tsgl(len)
612 			 * SG entries in dst.
613 			 */
614 			if (dst) {
615 				if (dst_offset >= plen) {
616 					/* discard page before offset */
617 					dst_offset -= plen;
618 				} else {
619 					/* reassign page to dst after offset */
620 					get_page(page);
621 					sg_set_page(dst + j, page,
622 						    plen - dst_offset,
623 						    sg[i].offset + dst_offset);
624 					dst_offset = 0;
625 					j++;
626 				}
627 			}
628 
629 			sg[i].length -= plen;
630 			sg[i].offset += plen;
631 
632 			used -= plen;
633 			ctx->used -= plen;
634 
635 			if (sg[i].length)
636 				return;
637 
638 			put_page(page);
639 			sg_assign_page(sg + i, NULL);
640 		}
641 
642 		list_del(&sgl->list);
643 		sock_kfree_s(sk, sgl, struct_size(sgl, sg, MAX_SGL_ENTS + 1));
644 	}
645 
646 	if (!ctx->used)
647 		ctx->merge = 0;
648 	ctx->init = ctx->more;
649 }
650 EXPORT_SYMBOL_GPL(af_alg_pull_tsgl);
651 
652 /**
653  * af_alg_free_areq_sgls - Release TX and RX SGLs of the request
654  *
655  * @areq Request holding the TX and RX SGL
656  */
657 static void af_alg_free_areq_sgls(struct af_alg_async_req *areq)
658 {
659 	struct sock *sk = areq->sk;
660 	struct alg_sock *ask = alg_sk(sk);
661 	struct af_alg_ctx *ctx = ask->private;
662 	struct af_alg_rsgl *rsgl, *tmp;
663 	struct scatterlist *tsgl;
664 	struct scatterlist *sg;
665 	unsigned int i;
666 
667 	list_for_each_entry_safe(rsgl, tmp, &areq->rsgl_list, list) {
668 		atomic_sub(rsgl->sg_num_bytes, &ctx->rcvused);
669 		af_alg_free_sg(&rsgl->sgl);
670 		list_del(&rsgl->list);
671 		if (rsgl != &areq->first_rsgl)
672 			sock_kfree_s(sk, rsgl, sizeof(*rsgl));
673 	}
674 
675 	tsgl = areq->tsgl;
676 	if (tsgl) {
677 		for_each_sg(tsgl, sg, areq->tsgl_entries, i) {
678 			if (!sg_page(sg))
679 				continue;
680 			put_page(sg_page(sg));
681 		}
682 
683 		sock_kfree_s(sk, tsgl, areq->tsgl_entries * sizeof(*tsgl));
684 	}
685 }
686 
687 /**
688  * af_alg_wait_for_wmem - wait for availability of writable memory
689  *
690  * @sk socket of connection to user space
691  * @flags If MSG_DONTWAIT is set, then only report if function would sleep
692  * @return 0 when writable memory is available, < 0 upon error
693  */
694 static int af_alg_wait_for_wmem(struct sock *sk, unsigned int flags)
695 {
696 	DEFINE_WAIT_FUNC(wait, woken_wake_function);
697 	int err = -ERESTARTSYS;
698 	long timeout;
699 
700 	if (flags & MSG_DONTWAIT)
701 		return -EAGAIN;
702 
703 	sk_set_bit(SOCKWQ_ASYNC_NOSPACE, sk);
704 
705 	add_wait_queue(sk_sleep(sk), &wait);
706 	for (;;) {
707 		if (signal_pending(current))
708 			break;
709 		timeout = MAX_SCHEDULE_TIMEOUT;
710 		if (sk_wait_event(sk, &timeout, af_alg_writable(sk), &wait)) {
711 			err = 0;
712 			break;
713 		}
714 	}
715 	remove_wait_queue(sk_sleep(sk), &wait);
716 
717 	return err;
718 }
719 
720 /**
721  * af_alg_wmem_wakeup - wakeup caller when writable memory is available
722  *
723  * @sk socket of connection to user space
724  */
725 void af_alg_wmem_wakeup(struct sock *sk)
726 {
727 	struct socket_wq *wq;
728 
729 	if (!af_alg_writable(sk))
730 		return;
731 
732 	rcu_read_lock();
733 	wq = rcu_dereference(sk->sk_wq);
734 	if (skwq_has_sleeper(wq))
735 		wake_up_interruptible_sync_poll(&wq->wait, EPOLLIN |
736 							   EPOLLRDNORM |
737 							   EPOLLRDBAND);
738 	sk_wake_async(sk, SOCK_WAKE_WAITD, POLL_IN);
739 	rcu_read_unlock();
740 }
741 EXPORT_SYMBOL_GPL(af_alg_wmem_wakeup);
742 
743 /**
744  * af_alg_wait_for_data - wait for availability of TX data
745  *
746  * @sk socket of connection to user space
747  * @flags If MSG_DONTWAIT is set, then only report if function would sleep
748  * @min Set to minimum request size if partial requests are allowed.
749  * @return 0 when writable memory is available, < 0 upon error
750  */
751 int af_alg_wait_for_data(struct sock *sk, unsigned flags, unsigned min)
752 {
753 	DEFINE_WAIT_FUNC(wait, woken_wake_function);
754 	struct alg_sock *ask = alg_sk(sk);
755 	struct af_alg_ctx *ctx = ask->private;
756 	long timeout;
757 	int err = -ERESTARTSYS;
758 
759 	if (flags & MSG_DONTWAIT)
760 		return -EAGAIN;
761 
762 	sk_set_bit(SOCKWQ_ASYNC_WAITDATA, sk);
763 
764 	add_wait_queue(sk_sleep(sk), &wait);
765 	for (;;) {
766 		if (signal_pending(current))
767 			break;
768 		timeout = MAX_SCHEDULE_TIMEOUT;
769 		if (sk_wait_event(sk, &timeout,
770 				  ctx->init && (!ctx->more ||
771 						(min && ctx->used >= min)),
772 				  &wait)) {
773 			err = 0;
774 			break;
775 		}
776 	}
777 	remove_wait_queue(sk_sleep(sk), &wait);
778 
779 	sk_clear_bit(SOCKWQ_ASYNC_WAITDATA, sk);
780 
781 	return err;
782 }
783 EXPORT_SYMBOL_GPL(af_alg_wait_for_data);
784 
785 /**
786  * af_alg_data_wakeup - wakeup caller when new data can be sent to kernel
787  *
788  * @sk socket of connection to user space
789  */
790 static void af_alg_data_wakeup(struct sock *sk)
791 {
792 	struct alg_sock *ask = alg_sk(sk);
793 	struct af_alg_ctx *ctx = ask->private;
794 	struct socket_wq *wq;
795 
796 	if (!ctx->used)
797 		return;
798 
799 	rcu_read_lock();
800 	wq = rcu_dereference(sk->sk_wq);
801 	if (skwq_has_sleeper(wq))
802 		wake_up_interruptible_sync_poll(&wq->wait, EPOLLOUT |
803 							   EPOLLRDNORM |
804 							   EPOLLRDBAND);
805 	sk_wake_async(sk, SOCK_WAKE_SPACE, POLL_OUT);
806 	rcu_read_unlock();
807 }
808 
809 /**
810  * af_alg_sendmsg - implementation of sendmsg system call handler
811  *
812  * The sendmsg system call handler obtains the user data and stores it
813  * in ctx->tsgl_list. This implies allocation of the required numbers of
814  * struct af_alg_tsgl.
815  *
816  * In addition, the ctx is filled with the information sent via CMSG.
817  *
818  * @sock socket of connection to user space
819  * @msg message from user space
820  * @size size of message from user space
821  * @ivsize the size of the IV for the cipher operation to verify that the
822  *	   user-space-provided IV has the right size
823  * @return the number of copied data upon success, < 0 upon error
824  */
825 int af_alg_sendmsg(struct socket *sock, struct msghdr *msg, size_t size,
826 		   unsigned int ivsize)
827 {
828 	struct sock *sk = sock->sk;
829 	struct alg_sock *ask = alg_sk(sk);
830 	struct af_alg_ctx *ctx = ask->private;
831 	struct af_alg_tsgl *sgl;
832 	struct af_alg_control con = {};
833 	long copied = 0;
834 	bool enc = false;
835 	bool init = false;
836 	int err = 0;
837 
838 	if (msg->msg_controllen) {
839 		err = af_alg_cmsg_send(msg, &con);
840 		if (err)
841 			return err;
842 
843 		init = true;
844 		switch (con.op) {
845 		case ALG_OP_ENCRYPT:
846 			enc = true;
847 			break;
848 		case ALG_OP_DECRYPT:
849 			enc = false;
850 			break;
851 		default:
852 			return -EINVAL;
853 		}
854 
855 		if (con.iv && con.iv->ivlen != ivsize)
856 			return -EINVAL;
857 	}
858 
859 	lock_sock(sk);
860 	if (ctx->init && (init || !ctx->more)) {
861 		err = -EINVAL;
862 		goto unlock;
863 	}
864 	ctx->init = true;
865 
866 	if (init) {
867 		ctx->enc = enc;
868 		if (con.iv)
869 			memcpy(ctx->iv, con.iv->iv, ivsize);
870 
871 		ctx->aead_assoclen = con.aead_assoclen;
872 	}
873 
874 	while (size) {
875 		struct scatterlist *sg;
876 		size_t len = size;
877 		size_t plen;
878 
879 		/* use the existing memory in an allocated page */
880 		if (ctx->merge) {
881 			sgl = list_entry(ctx->tsgl_list.prev,
882 					 struct af_alg_tsgl, list);
883 			sg = sgl->sg + sgl->cur - 1;
884 			len = min_t(size_t, len,
885 				    PAGE_SIZE - sg->offset - sg->length);
886 
887 			err = memcpy_from_msg(page_address(sg_page(sg)) +
888 					      sg->offset + sg->length,
889 					      msg, len);
890 			if (err)
891 				goto unlock;
892 
893 			sg->length += len;
894 			ctx->merge = (sg->offset + sg->length) &
895 				     (PAGE_SIZE - 1);
896 
897 			ctx->used += len;
898 			copied += len;
899 			size -= len;
900 			continue;
901 		}
902 
903 		if (!af_alg_writable(sk)) {
904 			err = af_alg_wait_for_wmem(sk, msg->msg_flags);
905 			if (err)
906 				goto unlock;
907 		}
908 
909 		/* allocate a new page */
910 		len = min_t(unsigned long, len, af_alg_sndbuf(sk));
911 
912 		err = af_alg_alloc_tsgl(sk);
913 		if (err)
914 			goto unlock;
915 
916 		sgl = list_entry(ctx->tsgl_list.prev, struct af_alg_tsgl,
917 				 list);
918 		sg = sgl->sg;
919 		if (sgl->cur)
920 			sg_unmark_end(sg + sgl->cur - 1);
921 
922 		do {
923 			unsigned int i = sgl->cur;
924 
925 			plen = min_t(size_t, len, PAGE_SIZE);
926 
927 			sg_assign_page(sg + i, alloc_page(GFP_KERNEL));
928 			if (!sg_page(sg + i)) {
929 				err = -ENOMEM;
930 				goto unlock;
931 			}
932 
933 			err = memcpy_from_msg(page_address(sg_page(sg + i)),
934 					      msg, plen);
935 			if (err) {
936 				__free_page(sg_page(sg + i));
937 				sg_assign_page(sg + i, NULL);
938 				goto unlock;
939 			}
940 
941 			sg[i].length = plen;
942 			len -= plen;
943 			ctx->used += plen;
944 			copied += plen;
945 			size -= plen;
946 			sgl->cur++;
947 		} while (len && sgl->cur < MAX_SGL_ENTS);
948 
949 		if (!size)
950 			sg_mark_end(sg + sgl->cur - 1);
951 
952 		ctx->merge = plen & (PAGE_SIZE - 1);
953 	}
954 
955 	err = 0;
956 
957 	ctx->more = msg->msg_flags & MSG_MORE;
958 
959 unlock:
960 	af_alg_data_wakeup(sk);
961 	release_sock(sk);
962 
963 	return copied ?: err;
964 }
965 EXPORT_SYMBOL_GPL(af_alg_sendmsg);
966 
967 /**
968  * af_alg_sendpage - sendpage system call handler
969  *
970  * This is a generic implementation of sendpage to fill ctx->tsgl_list.
971  */
972 ssize_t af_alg_sendpage(struct socket *sock, struct page *page,
973 			int offset, size_t size, int flags)
974 {
975 	struct sock *sk = sock->sk;
976 	struct alg_sock *ask = alg_sk(sk);
977 	struct af_alg_ctx *ctx = ask->private;
978 	struct af_alg_tsgl *sgl;
979 	int err = -EINVAL;
980 
981 	if (flags & MSG_SENDPAGE_NOTLAST)
982 		flags |= MSG_MORE;
983 
984 	lock_sock(sk);
985 	if (!ctx->more && ctx->used)
986 		goto unlock;
987 
988 	if (!size)
989 		goto done;
990 
991 	if (!af_alg_writable(sk)) {
992 		err = af_alg_wait_for_wmem(sk, flags);
993 		if (err)
994 			goto unlock;
995 	}
996 
997 	err = af_alg_alloc_tsgl(sk);
998 	if (err)
999 		goto unlock;
1000 
1001 	ctx->merge = 0;
1002 	sgl = list_entry(ctx->tsgl_list.prev, struct af_alg_tsgl, list);
1003 
1004 	if (sgl->cur)
1005 		sg_unmark_end(sgl->sg + sgl->cur - 1);
1006 
1007 	sg_mark_end(sgl->sg + sgl->cur);
1008 
1009 	get_page(page);
1010 	sg_set_page(sgl->sg + sgl->cur, page, size, offset);
1011 	sgl->cur++;
1012 	ctx->used += size;
1013 
1014 done:
1015 	ctx->more = flags & MSG_MORE;
1016 
1017 unlock:
1018 	af_alg_data_wakeup(sk);
1019 	release_sock(sk);
1020 
1021 	return err ?: size;
1022 }
1023 EXPORT_SYMBOL_GPL(af_alg_sendpage);
1024 
1025 /**
1026  * af_alg_free_resources - release resources required for crypto request
1027  */
1028 void af_alg_free_resources(struct af_alg_async_req *areq)
1029 {
1030 	struct sock *sk = areq->sk;
1031 
1032 	af_alg_free_areq_sgls(areq);
1033 	sock_kfree_s(sk, areq, areq->areqlen);
1034 }
1035 EXPORT_SYMBOL_GPL(af_alg_free_resources);
1036 
1037 /**
1038  * af_alg_async_cb - AIO callback handler
1039  *
1040  * This handler cleans up the struct af_alg_async_req upon completion of the
1041  * AIO operation.
1042  *
1043  * The number of bytes to be generated with the AIO operation must be set
1044  * in areq->outlen before the AIO callback handler is invoked.
1045  */
1046 void af_alg_async_cb(struct crypto_async_request *_req, int err)
1047 {
1048 	struct af_alg_async_req *areq = _req->data;
1049 	struct sock *sk = areq->sk;
1050 	struct kiocb *iocb = areq->iocb;
1051 	unsigned int resultlen;
1052 
1053 	/* Buffer size written by crypto operation. */
1054 	resultlen = areq->outlen;
1055 
1056 	af_alg_free_resources(areq);
1057 	sock_put(sk);
1058 
1059 	iocb->ki_complete(iocb, err ? err : (int)resultlen, 0);
1060 }
1061 EXPORT_SYMBOL_GPL(af_alg_async_cb);
1062 
1063 /**
1064  * af_alg_poll - poll system call handler
1065  */
1066 __poll_t af_alg_poll(struct file *file, struct socket *sock,
1067 			 poll_table *wait)
1068 {
1069 	struct sock *sk = sock->sk;
1070 	struct alg_sock *ask = alg_sk(sk);
1071 	struct af_alg_ctx *ctx = ask->private;
1072 	__poll_t mask;
1073 
1074 	sock_poll_wait(file, sock, wait);
1075 	mask = 0;
1076 
1077 	if (!ctx->more || ctx->used)
1078 		mask |= EPOLLIN | EPOLLRDNORM;
1079 
1080 	if (af_alg_writable(sk))
1081 		mask |= EPOLLOUT | EPOLLWRNORM | EPOLLWRBAND;
1082 
1083 	return mask;
1084 }
1085 EXPORT_SYMBOL_GPL(af_alg_poll);
1086 
1087 /**
1088  * af_alg_alloc_areq - allocate struct af_alg_async_req
1089  *
1090  * @sk socket of connection to user space
1091  * @areqlen size of struct af_alg_async_req + crypto_*_reqsize
1092  * @return allocated data structure or ERR_PTR upon error
1093  */
1094 struct af_alg_async_req *af_alg_alloc_areq(struct sock *sk,
1095 					   unsigned int areqlen)
1096 {
1097 	struct af_alg_async_req *areq = sock_kmalloc(sk, areqlen, GFP_KERNEL);
1098 
1099 	if (unlikely(!areq))
1100 		return ERR_PTR(-ENOMEM);
1101 
1102 	areq->areqlen = areqlen;
1103 	areq->sk = sk;
1104 	areq->last_rsgl = NULL;
1105 	INIT_LIST_HEAD(&areq->rsgl_list);
1106 	areq->tsgl = NULL;
1107 	areq->tsgl_entries = 0;
1108 
1109 	return areq;
1110 }
1111 EXPORT_SYMBOL_GPL(af_alg_alloc_areq);
1112 
1113 /**
1114  * af_alg_get_rsgl - create the RX SGL for the output data from the crypto
1115  *		     operation
1116  *
1117  * @sk socket of connection to user space
1118  * @msg user space message
1119  * @flags flags used to invoke recvmsg with
1120  * @areq instance of the cryptographic request that will hold the RX SGL
1121  * @maxsize maximum number of bytes to be pulled from user space
1122  * @outlen number of bytes in the RX SGL
1123  * @return 0 on success, < 0 upon error
1124  */
1125 int af_alg_get_rsgl(struct sock *sk, struct msghdr *msg, int flags,
1126 		    struct af_alg_async_req *areq, size_t maxsize,
1127 		    size_t *outlen)
1128 {
1129 	struct alg_sock *ask = alg_sk(sk);
1130 	struct af_alg_ctx *ctx = ask->private;
1131 	size_t len = 0;
1132 
1133 	while (maxsize > len && msg_data_left(msg)) {
1134 		struct af_alg_rsgl *rsgl;
1135 		size_t seglen;
1136 		int err;
1137 
1138 		/* limit the amount of readable buffers */
1139 		if (!af_alg_readable(sk))
1140 			break;
1141 
1142 		seglen = min_t(size_t, (maxsize - len),
1143 			       msg_data_left(msg));
1144 
1145 		if (list_empty(&areq->rsgl_list)) {
1146 			rsgl = &areq->first_rsgl;
1147 		} else {
1148 			rsgl = sock_kmalloc(sk, sizeof(*rsgl), GFP_KERNEL);
1149 			if (unlikely(!rsgl))
1150 				return -ENOMEM;
1151 		}
1152 
1153 		rsgl->sgl.npages = 0;
1154 		list_add_tail(&rsgl->list, &areq->rsgl_list);
1155 
1156 		/* make one iovec available as scatterlist */
1157 		err = af_alg_make_sg(&rsgl->sgl, &msg->msg_iter, seglen);
1158 		if (err < 0) {
1159 			rsgl->sg_num_bytes = 0;
1160 			return err;
1161 		}
1162 
1163 		/* chain the new scatterlist with previous one */
1164 		if (areq->last_rsgl)
1165 			af_alg_link_sg(&areq->last_rsgl->sgl, &rsgl->sgl);
1166 
1167 		areq->last_rsgl = rsgl;
1168 		len += err;
1169 		atomic_add(err, &ctx->rcvused);
1170 		rsgl->sg_num_bytes = err;
1171 		iov_iter_advance(&msg->msg_iter, err);
1172 	}
1173 
1174 	*outlen = len;
1175 	return 0;
1176 }
1177 EXPORT_SYMBOL_GPL(af_alg_get_rsgl);
1178 
1179 static int __init af_alg_init(void)
1180 {
1181 	int err = proto_register(&alg_proto, 0);
1182 
1183 	if (err)
1184 		goto out;
1185 
1186 	err = sock_register(&alg_family);
1187 	if (err != 0)
1188 		goto out_unregister_proto;
1189 
1190 out:
1191 	return err;
1192 
1193 out_unregister_proto:
1194 	proto_unregister(&alg_proto);
1195 	goto out;
1196 }
1197 
1198 static void __exit af_alg_exit(void)
1199 {
1200 	sock_unregister(PF_ALG);
1201 	proto_unregister(&alg_proto);
1202 }
1203 
1204 module_init(af_alg_init);
1205 module_exit(af_alg_exit);
1206 MODULE_LICENSE("GPL");
1207 MODULE_ALIAS_NETPROTO(AF_ALG);
1208