Merge tag 'mips_fixes_4.19_1' of git://git.kernel.org/pub/scm/linux/kernel/git/mips...
[linux-2.6/btrfs-unstable.git] / crypto / af_alg.c
blobb053179e0bc532e019b249eb0b96ba76fc3bb103
1 /*
2 * af_alg: User-space algorithm interface
4 * This file provides the user-space API for algorithms.
6 * Copyright (c) 2010 Herbert Xu <herbert@gondor.apana.org.au>
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the Free
10 * Software Foundation; either version 2 of the License, or (at your option)
11 * any later version.
15 #include <linux/atomic.h>
16 #include <crypto/if_alg.h>
17 #include <linux/crypto.h>
18 #include <linux/init.h>
19 #include <linux/kernel.h>
20 #include <linux/list.h>
21 #include <linux/module.h>
22 #include <linux/net.h>
23 #include <linux/rwsem.h>
24 #include <linux/sched/signal.h>
25 #include <linux/security.h>
27 struct alg_type_list {
28 const struct af_alg_type *type;
29 struct list_head list;
32 static atomic_long_t alg_memory_allocated;
34 static struct proto alg_proto = {
35 .name = "ALG",
36 .owner = THIS_MODULE,
37 .memory_allocated = &alg_memory_allocated,
38 .obj_size = sizeof(struct alg_sock),
41 static LIST_HEAD(alg_types);
42 static DECLARE_RWSEM(alg_types_sem);
44 static const struct af_alg_type *alg_get_type(const char *name)
46 const struct af_alg_type *type = ERR_PTR(-ENOENT);
47 struct alg_type_list *node;
49 down_read(&alg_types_sem);
50 list_for_each_entry(node, &alg_types, list) {
51 if (strcmp(node->type->name, name))
52 continue;
54 if (try_module_get(node->type->owner))
55 type = node->type;
56 break;
58 up_read(&alg_types_sem);
60 return type;
63 int af_alg_register_type(const struct af_alg_type *type)
65 struct alg_type_list *node;
66 int err = -EEXIST;
68 down_write(&alg_types_sem);
69 list_for_each_entry(node, &alg_types, list) {
70 if (!strcmp(node->type->name, type->name))
71 goto unlock;
74 node = kmalloc(sizeof(*node), GFP_KERNEL);
75 err = -ENOMEM;
76 if (!node)
77 goto unlock;
79 type->ops->owner = THIS_MODULE;
80 if (type->ops_nokey)
81 type->ops_nokey->owner = THIS_MODULE;
82 node->type = type;
83 list_add(&node->list, &alg_types);
84 err = 0;
86 unlock:
87 up_write(&alg_types_sem);
89 return err;
91 EXPORT_SYMBOL_GPL(af_alg_register_type);
93 int af_alg_unregister_type(const struct af_alg_type *type)
95 struct alg_type_list *node;
96 int err = -ENOENT;
98 down_write(&alg_types_sem);
99 list_for_each_entry(node, &alg_types, list) {
100 if (strcmp(node->type->name, type->name))
101 continue;
103 list_del(&node->list);
104 kfree(node);
105 err = 0;
106 break;
108 up_write(&alg_types_sem);
110 return err;
112 EXPORT_SYMBOL_GPL(af_alg_unregister_type);
114 static void alg_do_release(const struct af_alg_type *type, void *private)
116 if (!type)
117 return;
119 type->release(private);
120 module_put(type->owner);
123 int af_alg_release(struct socket *sock)
125 if (sock->sk)
126 sock_put(sock->sk);
127 return 0;
129 EXPORT_SYMBOL_GPL(af_alg_release);
131 void af_alg_release_parent(struct sock *sk)
133 struct alg_sock *ask = alg_sk(sk);
134 unsigned int nokey = ask->nokey_refcnt;
135 bool last = nokey && !ask->refcnt;
137 sk = ask->parent;
138 ask = alg_sk(sk);
140 lock_sock(sk);
141 ask->nokey_refcnt -= nokey;
142 if (!last)
143 last = !--ask->refcnt;
144 release_sock(sk);
146 if (last)
147 sock_put(sk);
149 EXPORT_SYMBOL_GPL(af_alg_release_parent);
151 static int alg_bind(struct socket *sock, struct sockaddr *uaddr, int addr_len)
153 const u32 allowed = CRYPTO_ALG_KERN_DRIVER_ONLY;
154 struct sock *sk = sock->sk;
155 struct alg_sock *ask = alg_sk(sk);
156 struct sockaddr_alg *sa = (void *)uaddr;
157 const struct af_alg_type *type;
158 void *private;
159 int err;
161 if (sock->state == SS_CONNECTED)
162 return -EINVAL;
164 if (addr_len < sizeof(*sa))
165 return -EINVAL;
167 /* If caller uses non-allowed flag, return error. */
168 if ((sa->salg_feat & ~allowed) || (sa->salg_mask & ~allowed))
169 return -EINVAL;
171 sa->salg_type[sizeof(sa->salg_type) - 1] = 0;
172 sa->salg_name[sizeof(sa->salg_name) + addr_len - sizeof(*sa) - 1] = 0;
174 type = alg_get_type(sa->salg_type);
175 if (IS_ERR(type) && PTR_ERR(type) == -ENOENT) {
176 request_module("algif-%s", sa->salg_type);
177 type = alg_get_type(sa->salg_type);
180 if (IS_ERR(type))
181 return PTR_ERR(type);
183 private = type->bind(sa->salg_name, sa->salg_feat, sa->salg_mask);
184 if (IS_ERR(private)) {
185 module_put(type->owner);
186 return PTR_ERR(private);
189 err = -EBUSY;
190 lock_sock(sk);
191 if (ask->refcnt | ask->nokey_refcnt)
192 goto unlock;
194 swap(ask->type, type);
195 swap(ask->private, private);
197 err = 0;
199 unlock:
200 release_sock(sk);
202 alg_do_release(type, private);
204 return err;
207 static int alg_setkey(struct sock *sk, char __user *ukey,
208 unsigned int keylen)
210 struct alg_sock *ask = alg_sk(sk);
211 const struct af_alg_type *type = ask->type;
212 u8 *key;
213 int err;
215 key = sock_kmalloc(sk, keylen, GFP_KERNEL);
216 if (!key)
217 return -ENOMEM;
219 err = -EFAULT;
220 if (copy_from_user(key, ukey, keylen))
221 goto out;
223 err = type->setkey(ask->private, key, keylen);
225 out:
226 sock_kzfree_s(sk, key, keylen);
228 return err;
231 static int alg_setsockopt(struct socket *sock, int level, int optname,
232 char __user *optval, unsigned int optlen)
234 struct sock *sk = sock->sk;
235 struct alg_sock *ask = alg_sk(sk);
236 const struct af_alg_type *type;
237 int err = -EBUSY;
239 lock_sock(sk);
240 if (ask->refcnt)
241 goto unlock;
243 type = ask->type;
245 err = -ENOPROTOOPT;
246 if (level != SOL_ALG || !type)
247 goto unlock;
249 switch (optname) {
250 case ALG_SET_KEY:
251 if (sock->state == SS_CONNECTED)
252 goto unlock;
253 if (!type->setkey)
254 goto unlock;
256 err = alg_setkey(sk, optval, optlen);
257 break;
258 case ALG_SET_AEAD_AUTHSIZE:
259 if (sock->state == SS_CONNECTED)
260 goto unlock;
261 if (!type->setauthsize)
262 goto unlock;
263 err = type->setauthsize(ask->private, optlen);
266 unlock:
267 release_sock(sk);
269 return err;
272 int af_alg_accept(struct sock *sk, struct socket *newsock, bool kern)
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;
280 lock_sock(sk);
281 type = ask->type;
283 err = -EINVAL;
284 if (!type)
285 goto unlock;
287 sk2 = sk_alloc(sock_net(sk), PF_ALG, GFP_KERNEL, &alg_proto, kern);
288 err = -ENOMEM;
289 if (!sk2)
290 goto unlock;
292 sock_init_data(newsock, sk2);
293 security_sock_graft(sk2, newsock);
294 security_sk_clone(sk, sk2);
296 err = type->accept(ask->private, sk2);
298 nokey = err == -ENOKEY;
299 if (nokey && type->accept_nokey)
300 err = type->accept_nokey(ask->private, sk2);
302 if (err)
303 goto unlock;
305 sk2->sk_family = PF_ALG;
307 if (nokey || !ask->refcnt++)
308 sock_hold(sk);
309 ask->nokey_refcnt += nokey;
310 alg_sk(sk2)->parent = sk;
311 alg_sk(sk2)->type = type;
312 alg_sk(sk2)->nokey_refcnt = nokey;
314 newsock->ops = type->ops;
315 newsock->state = SS_CONNECTED;
317 if (nokey)
318 newsock->ops = type->ops_nokey;
320 err = 0;
322 unlock:
323 release_sock(sk);
325 return err;
327 EXPORT_SYMBOL_GPL(af_alg_accept);
329 static int alg_accept(struct socket *sock, struct socket *newsock, int flags,
330 bool kern)
332 return af_alg_accept(sock->sk, newsock, kern);
335 static const struct proto_ops alg_proto_ops = {
336 .family = PF_ALG,
337 .owner = THIS_MODULE,
339 .connect = sock_no_connect,
340 .socketpair = sock_no_socketpair,
341 .getname = sock_no_getname,
342 .ioctl = sock_no_ioctl,
343 .listen = sock_no_listen,
344 .shutdown = sock_no_shutdown,
345 .getsockopt = sock_no_getsockopt,
346 .mmap = sock_no_mmap,
347 .sendpage = sock_no_sendpage,
348 .sendmsg = sock_no_sendmsg,
349 .recvmsg = sock_no_recvmsg,
351 .bind = alg_bind,
352 .release = af_alg_release,
353 .setsockopt = alg_setsockopt,
354 .accept = alg_accept,
357 static void alg_sock_destruct(struct sock *sk)
359 struct alg_sock *ask = alg_sk(sk);
361 alg_do_release(ask->type, ask->private);
364 static int alg_create(struct net *net, struct socket *sock, int protocol,
365 int kern)
367 struct sock *sk;
368 int err;
370 if (sock->type != SOCK_SEQPACKET)
371 return -ESOCKTNOSUPPORT;
372 if (protocol != 0)
373 return -EPROTONOSUPPORT;
375 err = -ENOMEM;
376 sk = sk_alloc(net, PF_ALG, GFP_KERNEL, &alg_proto, kern);
377 if (!sk)
378 goto out;
380 sock->ops = &alg_proto_ops;
381 sock_init_data(sock, sk);
383 sk->sk_family = PF_ALG;
384 sk->sk_destruct = alg_sock_destruct;
386 return 0;
387 out:
388 return err;
391 static const struct net_proto_family alg_family = {
392 .family = PF_ALG,
393 .create = alg_create,
394 .owner = THIS_MODULE,
397 int af_alg_make_sg(struct af_alg_sgl *sgl, struct iov_iter *iter, int len)
399 size_t off;
400 ssize_t n;
401 int npages, i;
403 n = iov_iter_get_pages(iter, sgl->pages, len, ALG_MAX_PAGES, &off);
404 if (n < 0)
405 return n;
407 npages = (off + n + PAGE_SIZE - 1) >> PAGE_SHIFT;
408 if (WARN_ON(npages == 0))
409 return -EINVAL;
410 /* Add one extra for linking */
411 sg_init_table(sgl->sg, npages + 1);
413 for (i = 0, len = n; i < npages; i++) {
414 int plen = min_t(int, len, PAGE_SIZE - off);
416 sg_set_page(sgl->sg + i, sgl->pages[i], plen, off);
418 off = 0;
419 len -= plen;
421 sg_mark_end(sgl->sg + npages - 1);
422 sgl->npages = npages;
424 return n;
426 EXPORT_SYMBOL_GPL(af_alg_make_sg);
428 void af_alg_link_sg(struct af_alg_sgl *sgl_prev, struct af_alg_sgl *sgl_new)
430 sg_unmark_end(sgl_prev->sg + sgl_prev->npages - 1);
431 sg_chain(sgl_prev->sg, sgl_prev->npages + 1, sgl_new->sg);
433 EXPORT_SYMBOL_GPL(af_alg_link_sg);
435 void af_alg_free_sg(struct af_alg_sgl *sgl)
437 int i;
439 for (i = 0; i < sgl->npages; i++)
440 put_page(sgl->pages[i]);
442 EXPORT_SYMBOL_GPL(af_alg_free_sg);
444 int af_alg_cmsg_send(struct msghdr *msg, struct af_alg_control *con)
446 struct cmsghdr *cmsg;
448 for_each_cmsghdr(cmsg, msg) {
449 if (!CMSG_OK(msg, cmsg))
450 return -EINVAL;
451 if (cmsg->cmsg_level != SOL_ALG)
452 continue;
454 switch (cmsg->cmsg_type) {
455 case ALG_SET_IV:
456 if (cmsg->cmsg_len < CMSG_LEN(sizeof(*con->iv)))
457 return -EINVAL;
458 con->iv = (void *)CMSG_DATA(cmsg);
459 if (cmsg->cmsg_len < CMSG_LEN(con->iv->ivlen +
460 sizeof(*con->iv)))
461 return -EINVAL;
462 break;
464 case ALG_SET_OP:
465 if (cmsg->cmsg_len < CMSG_LEN(sizeof(u32)))
466 return -EINVAL;
467 con->op = *(u32 *)CMSG_DATA(cmsg);
468 break;
470 case ALG_SET_AEAD_ASSOCLEN:
471 if (cmsg->cmsg_len < CMSG_LEN(sizeof(u32)))
472 return -EINVAL;
473 con->aead_assoclen = *(u32 *)CMSG_DATA(cmsg);
474 break;
476 default:
477 return -EINVAL;
481 return 0;
483 EXPORT_SYMBOL_GPL(af_alg_cmsg_send);
486 * af_alg_alloc_tsgl - allocate the TX SGL
488 * @sk socket of connection to user space
489 * @return: 0 upon success, < 0 upon error
491 int af_alg_alloc_tsgl(struct sock *sk)
493 struct alg_sock *ask = alg_sk(sk);
494 struct af_alg_ctx *ctx = ask->private;
495 struct af_alg_tsgl *sgl;
496 struct scatterlist *sg = NULL;
498 sgl = list_entry(ctx->tsgl_list.prev, struct af_alg_tsgl, list);
499 if (!list_empty(&ctx->tsgl_list))
500 sg = sgl->sg;
502 if (!sg || sgl->cur >= MAX_SGL_ENTS) {
503 sgl = sock_kmalloc(sk,
504 struct_size(sgl, sg, (MAX_SGL_ENTS + 1)),
505 GFP_KERNEL);
506 if (!sgl)
507 return -ENOMEM;
509 sg_init_table(sgl->sg, MAX_SGL_ENTS + 1);
510 sgl->cur = 0;
512 if (sg)
513 sg_chain(sg, MAX_SGL_ENTS + 1, sgl->sg);
515 list_add_tail(&sgl->list, &ctx->tsgl_list);
518 return 0;
520 EXPORT_SYMBOL_GPL(af_alg_alloc_tsgl);
523 * aead_count_tsgl - Count number of TX SG entries
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.
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
533 unsigned int af_alg_count_tsgl(struct sock *sk, size_t bytes, size_t offset)
535 struct alg_sock *ask = alg_sk(sk);
536 struct af_alg_ctx *ctx = ask->private;
537 struct af_alg_tsgl *sgl, *tmp;
538 unsigned int i;
539 unsigned int sgl_count = 0;
541 if (!bytes)
542 return 0;
544 list_for_each_entry_safe(sgl, tmp, &ctx->tsgl_list, list) {
545 struct scatterlist *sg = sgl->sg;
547 for (i = 0; i < sgl->cur; i++) {
548 size_t bytes_count;
550 /* Skip offset */
551 if (offset >= sg[i].length) {
552 offset -= sg[i].length;
553 bytes -= sg[i].length;
554 continue;
557 bytes_count = sg[i].length - offset;
559 offset = 0;
560 sgl_count++;
562 /* If we have seen requested number of bytes, stop */
563 if (bytes_count >= bytes)
564 return sgl_count;
566 bytes -= bytes_count;
570 return sgl_count;
572 EXPORT_SYMBOL_GPL(af_alg_count_tsgl);
575 * aead_pull_tsgl - Release the specified buffers from TX SGL
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).
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.
589 void af_alg_pull_tsgl(struct sock *sk, size_t used, struct scatterlist *dst,
590 size_t dst_offset)
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;
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;
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);
607 if (!page)
608 continue;
611 * Assumption: caller created af_alg_count_tsgl(len)
612 * SG entries in dst.
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++;
629 sg[i].length -= plen;
630 sg[i].offset += plen;
632 used -= plen;
633 ctx->used -= plen;
635 if (sg[i].length)
636 return;
638 put_page(page);
639 sg_assign_page(sg + i, NULL);
642 list_del(&sgl->list);
643 sock_kfree_s(sk, sgl, sizeof(*sgl) + sizeof(sgl->sg[0]) *
644 (MAX_SGL_ENTS + 1));
647 if (!ctx->used)
648 ctx->merge = 0;
650 EXPORT_SYMBOL_GPL(af_alg_pull_tsgl);
653 * af_alg_free_areq_sgls - Release TX and RX SGLs of the request
655 * @areq Request holding the TX and RX SGL
657 void af_alg_free_areq_sgls(struct af_alg_async_req *areq)
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;
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));
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));
683 sock_kfree_s(sk, tsgl, areq->tsgl_entries * sizeof(*tsgl));
686 EXPORT_SYMBOL_GPL(af_alg_free_areq_sgls);
689 * af_alg_wait_for_wmem - wait for availability of writable memory
691 * @sk socket of connection to user space
692 * @flags If MSG_DONTWAIT is set, then only report if function would sleep
693 * @return 0 when writable memory is available, < 0 upon error
695 int af_alg_wait_for_wmem(struct sock *sk, unsigned int flags)
697 DEFINE_WAIT_FUNC(wait, woken_wake_function);
698 int err = -ERESTARTSYS;
699 long timeout;
701 if (flags & MSG_DONTWAIT)
702 return -EAGAIN;
704 sk_set_bit(SOCKWQ_ASYNC_NOSPACE, sk);
706 add_wait_queue(sk_sleep(sk), &wait);
707 for (;;) {
708 if (signal_pending(current))
709 break;
710 timeout = MAX_SCHEDULE_TIMEOUT;
711 if (sk_wait_event(sk, &timeout, af_alg_writable(sk), &wait)) {
712 err = 0;
713 break;
716 remove_wait_queue(sk_sleep(sk), &wait);
718 return err;
720 EXPORT_SYMBOL_GPL(af_alg_wait_for_wmem);
723 * af_alg_wmem_wakeup - wakeup caller when writable memory is available
725 * @sk socket of connection to user space
727 void af_alg_wmem_wakeup(struct sock *sk)
729 struct socket_wq *wq;
731 if (!af_alg_writable(sk))
732 return;
734 rcu_read_lock();
735 wq = rcu_dereference(sk->sk_wq);
736 if (skwq_has_sleeper(wq))
737 wake_up_interruptible_sync_poll(&wq->wait, EPOLLIN |
738 EPOLLRDNORM |
739 EPOLLRDBAND);
740 sk_wake_async(sk, SOCK_WAKE_WAITD, POLL_IN);
741 rcu_read_unlock();
743 EXPORT_SYMBOL_GPL(af_alg_wmem_wakeup);
746 * af_alg_wait_for_data - wait for availability of TX data
748 * @sk socket of connection to user space
749 * @flags If MSG_DONTWAIT is set, then only report if function would sleep
750 * @return 0 when writable memory is available, < 0 upon error
752 int af_alg_wait_for_data(struct sock *sk, unsigned flags)
754 DEFINE_WAIT_FUNC(wait, woken_wake_function);
755 struct alg_sock *ask = alg_sk(sk);
756 struct af_alg_ctx *ctx = ask->private;
757 long timeout;
758 int err = -ERESTARTSYS;
760 if (flags & MSG_DONTWAIT)
761 return -EAGAIN;
763 sk_set_bit(SOCKWQ_ASYNC_WAITDATA, sk);
765 add_wait_queue(sk_sleep(sk), &wait);
766 for (;;) {
767 if (signal_pending(current))
768 break;
769 timeout = MAX_SCHEDULE_TIMEOUT;
770 if (sk_wait_event(sk, &timeout, (ctx->used || !ctx->more),
771 &wait)) {
772 err = 0;
773 break;
776 remove_wait_queue(sk_sleep(sk), &wait);
778 sk_clear_bit(SOCKWQ_ASYNC_WAITDATA, sk);
780 return err;
782 EXPORT_SYMBOL_GPL(af_alg_wait_for_data);
785 * af_alg_data_wakeup - wakeup caller when new data can be sent to kernel
787 * @sk socket of connection to user space
790 void af_alg_data_wakeup(struct sock *sk)
792 struct alg_sock *ask = alg_sk(sk);
793 struct af_alg_ctx *ctx = ask->private;
794 struct socket_wq *wq;
796 if (!ctx->used)
797 return;
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();
808 EXPORT_SYMBOL_GPL(af_alg_data_wakeup);
811 * af_alg_sendmsg - implementation of sendmsg system call handler
813 * The sendmsg system call handler obtains the user data and stores it
814 * in ctx->tsgl_list. This implies allocation of the required numbers of
815 * struct af_alg_tsgl.
817 * In addition, the ctx is filled with the information sent via CMSG.
819 * @sock socket of connection to user space
820 * @msg message from user space
821 * @size size of message from user space
822 * @ivsize the size of the IV for the cipher operation to verify that the
823 * user-space-provided IV has the right size
824 * @return the number of copied data upon success, < 0 upon error
826 int af_alg_sendmsg(struct socket *sock, struct msghdr *msg, size_t size,
827 unsigned int ivsize)
829 struct sock *sk = sock->sk;
830 struct alg_sock *ask = alg_sk(sk);
831 struct af_alg_ctx *ctx = ask->private;
832 struct af_alg_tsgl *sgl;
833 struct af_alg_control con = {};
834 long copied = 0;
835 bool enc = 0;
836 bool init = 0;
837 int err = 0;
839 if (msg->msg_controllen) {
840 err = af_alg_cmsg_send(msg, &con);
841 if (err)
842 return err;
844 init = 1;
845 switch (con.op) {
846 case ALG_OP_ENCRYPT:
847 enc = 1;
848 break;
849 case ALG_OP_DECRYPT:
850 enc = 0;
851 break;
852 default:
853 return -EINVAL;
856 if (con.iv && con.iv->ivlen != ivsize)
857 return -EINVAL;
860 lock_sock(sk);
861 if (!ctx->more && ctx->used) {
862 err = -EINVAL;
863 goto unlock;
866 if (init) {
867 ctx->enc = enc;
868 if (con.iv)
869 memcpy(ctx->iv, con.iv->iv, ivsize);
871 ctx->aead_assoclen = con.aead_assoclen;
874 while (size) {
875 struct scatterlist *sg;
876 size_t len = size;
877 size_t plen;
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);
887 err = memcpy_from_msg(page_address(sg_page(sg)) +
888 sg->offset + sg->length,
889 msg, len);
890 if (err)
891 goto unlock;
893 sg->length += len;
894 ctx->merge = (sg->offset + sg->length) &
895 (PAGE_SIZE - 1);
897 ctx->used += len;
898 copied += len;
899 size -= len;
900 continue;
903 if (!af_alg_writable(sk)) {
904 err = af_alg_wait_for_wmem(sk, msg->msg_flags);
905 if (err)
906 goto unlock;
909 /* allocate a new page */
910 len = min_t(unsigned long, len, af_alg_sndbuf(sk));
912 err = af_alg_alloc_tsgl(sk);
913 if (err)
914 goto unlock;
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);
922 do {
923 unsigned int i = sgl->cur;
925 plen = min_t(size_t, len, PAGE_SIZE);
927 sg_assign_page(sg + i, alloc_page(GFP_KERNEL));
928 if (!sg_page(sg + i)) {
929 err = -ENOMEM;
930 goto unlock;
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;
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);
949 if (!size)
950 sg_mark_end(sg + sgl->cur - 1);
952 ctx->merge = plen & (PAGE_SIZE - 1);
955 err = 0;
957 ctx->more = msg->msg_flags & MSG_MORE;
959 unlock:
960 af_alg_data_wakeup(sk);
961 release_sock(sk);
963 return copied ?: err;
965 EXPORT_SYMBOL_GPL(af_alg_sendmsg);
968 * af_alg_sendpage - sendpage system call handler
970 * This is a generic implementation of sendpage to fill ctx->tsgl_list.
972 ssize_t af_alg_sendpage(struct socket *sock, struct page *page,
973 int offset, size_t size, int flags)
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;
981 if (flags & MSG_SENDPAGE_NOTLAST)
982 flags |= MSG_MORE;
984 lock_sock(sk);
985 if (!ctx->more && ctx->used)
986 goto unlock;
988 if (!size)
989 goto done;
991 if (!af_alg_writable(sk)) {
992 err = af_alg_wait_for_wmem(sk, flags);
993 if (err)
994 goto unlock;
997 err = af_alg_alloc_tsgl(sk);
998 if (err)
999 goto unlock;
1001 ctx->merge = 0;
1002 sgl = list_entry(ctx->tsgl_list.prev, struct af_alg_tsgl, list);
1004 if (sgl->cur)
1005 sg_unmark_end(sgl->sg + sgl->cur - 1);
1007 sg_mark_end(sgl->sg + sgl->cur);
1009 get_page(page);
1010 sg_set_page(sgl->sg + sgl->cur, page, size, offset);
1011 sgl->cur++;
1012 ctx->used += size;
1014 done:
1015 ctx->more = flags & MSG_MORE;
1017 unlock:
1018 af_alg_data_wakeup(sk);
1019 release_sock(sk);
1021 return err ?: size;
1023 EXPORT_SYMBOL_GPL(af_alg_sendpage);
1026 * af_alg_free_resources - release resources required for crypto request
1028 void af_alg_free_resources(struct af_alg_async_req *areq)
1030 struct sock *sk = areq->sk;
1032 af_alg_free_areq_sgls(areq);
1033 sock_kfree_s(sk, areq, areq->areqlen);
1035 EXPORT_SYMBOL_GPL(af_alg_free_resources);
1038 * af_alg_async_cb - AIO callback handler
1040 * This handler cleans up the struct af_alg_async_req upon completion of the
1041 * AIO operation.
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.
1046 void af_alg_async_cb(struct crypto_async_request *_req, int err)
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;
1053 /* Buffer size written by crypto operation. */
1054 resultlen = areq->outlen;
1056 af_alg_free_resources(areq);
1057 sock_put(sk);
1059 iocb->ki_complete(iocb, err ? err : resultlen, 0);
1061 EXPORT_SYMBOL_GPL(af_alg_async_cb);
1064 * af_alg_poll - poll system call handler
1066 __poll_t af_alg_poll(struct file *file, struct socket *sock,
1067 poll_table *wait)
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;
1074 sock_poll_wait(file, wait);
1075 mask = 0;
1077 if (!ctx->more || ctx->used)
1078 mask |= EPOLLIN | EPOLLRDNORM;
1080 if (af_alg_writable(sk))
1081 mask |= EPOLLOUT | EPOLLWRNORM | EPOLLWRBAND;
1083 return mask;
1085 EXPORT_SYMBOL_GPL(af_alg_poll);
1088 * af_alg_alloc_areq - allocate struct af_alg_async_req
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
1094 struct af_alg_async_req *af_alg_alloc_areq(struct sock *sk,
1095 unsigned int areqlen)
1097 struct af_alg_async_req *areq = sock_kmalloc(sk, areqlen, GFP_KERNEL);
1099 if (unlikely(!areq))
1100 return ERR_PTR(-ENOMEM);
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;
1109 return areq;
1111 EXPORT_SYMBOL_GPL(af_alg_alloc_areq);
1114 * af_alg_get_rsgl - create the RX SGL for the output data from the crypto
1115 * operation
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
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)
1129 struct alg_sock *ask = alg_sk(sk);
1130 struct af_alg_ctx *ctx = ask->private;
1131 size_t len = 0;
1133 while (maxsize > len && msg_data_left(msg)) {
1134 struct af_alg_rsgl *rsgl;
1135 size_t seglen;
1136 int err;
1138 /* limit the amount of readable buffers */
1139 if (!af_alg_readable(sk))
1140 break;
1142 seglen = min_t(size_t, (maxsize - len),
1143 msg_data_left(msg));
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;
1153 rsgl->sgl.npages = 0;
1154 list_add_tail(&rsgl->list, &areq->rsgl_list);
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;
1163 /* chain the new scatterlist with previous one */
1164 if (areq->last_rsgl)
1165 af_alg_link_sg(&areq->last_rsgl->sgl, &rsgl->sgl);
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);
1174 *outlen = len;
1175 return 0;
1177 EXPORT_SYMBOL_GPL(af_alg_get_rsgl);
1179 static int __init af_alg_init(void)
1181 int err = proto_register(&alg_proto, 0);
1183 if (err)
1184 goto out;
1186 err = sock_register(&alg_family);
1187 if (err != 0)
1188 goto out_unregister_proto;
1190 out:
1191 return err;
1193 out_unregister_proto:
1194 proto_unregister(&alg_proto);
1195 goto out;
1198 static void __exit af_alg_exit(void)
1200 sock_unregister(PF_ALG);
1201 proto_unregister(&alg_proto);
1204 module_init(af_alg_init);
1205 module_exit(af_alg_exit);
1206 MODULE_LICENSE("GPL");
1207 MODULE_ALIAS_NETPROTO(AF_ALG);