2 * algif_skcipher: User-space interface for skcipher algorithms
4 * This file provides the user-space API for symmetric key ciphers.
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)
15 #include <crypto/scatterwalk.h>
16 #include <crypto/skcipher.h>
17 #include <crypto/if_alg.h>
18 #include <linux/init.h>
19 #include <linux/list.h>
20 #include <linux/kernel.h>
22 #include <linux/module.h>
23 #include <linux/net.h>
26 struct skcipher_sg_list {
27 struct list_head list;
31 struct scatterlist sg[0];
35 struct crypto_skcipher *skcipher;
40 struct list_head tsgl;
41 struct af_alg_sgl rsgl;
45 struct af_alg_completion completion;
55 struct skcipher_request req;
58 struct skcipher_async_rsgl {
59 struct af_alg_sgl sgl;
60 struct list_head list;
63 struct skcipher_async_req {
65 struct skcipher_async_rsgl first_sgl;
66 struct list_head list;
67 struct scatterlist *tsg;
69 struct skcipher_request req;
72 #define MAX_SGL_ENTS ((4096 - sizeof(struct skcipher_sg_list)) / \
73 sizeof(struct scatterlist) - 1)
75 static void skcipher_free_async_sgls(struct skcipher_async_req *sreq)
77 struct skcipher_async_rsgl *rsgl, *tmp;
78 struct scatterlist *sgl;
79 struct scatterlist *sg;
82 list_for_each_entry_safe(rsgl, tmp, &sreq->list, list) {
83 af_alg_free_sg(&rsgl->sgl);
84 if (rsgl != &sreq->first_sgl)
89 for_each_sg(sgl, sg, n, i)
90 put_page(sg_page(sg));
95 static void skcipher_async_cb(struct crypto_async_request *req, int err)
97 struct skcipher_async_req *sreq = req->data;
98 struct kiocb *iocb = sreq->iocb;
100 atomic_dec(sreq->inflight);
101 skcipher_free_async_sgls(sreq);
103 iocb->ki_complete(iocb, err, err);
106 static inline int skcipher_sndbuf(struct sock *sk)
108 struct alg_sock *ask = alg_sk(sk);
109 struct skcipher_ctx *ctx = ask->private;
111 return max_t(int, max_t(int, sk->sk_sndbuf & PAGE_MASK, PAGE_SIZE) -
115 static inline bool skcipher_writable(struct sock *sk)
117 return PAGE_SIZE <= skcipher_sndbuf(sk);
120 static int skcipher_alloc_sgl(struct sock *sk)
122 struct alg_sock *ask = alg_sk(sk);
123 struct skcipher_ctx *ctx = ask->private;
124 struct skcipher_sg_list *sgl;
125 struct scatterlist *sg = NULL;
127 sgl = list_entry(ctx->tsgl.prev, struct skcipher_sg_list, list);
128 if (!list_empty(&ctx->tsgl))
131 if (!sg || sgl->cur >= MAX_SGL_ENTS) {
132 sgl = sock_kmalloc(sk, sizeof(*sgl) +
133 sizeof(sgl->sg[0]) * (MAX_SGL_ENTS + 1),
138 sg_init_table(sgl->sg, MAX_SGL_ENTS + 1);
142 sg_chain(sg, MAX_SGL_ENTS + 1, sgl->sg);
144 list_add_tail(&sgl->list, &ctx->tsgl);
150 static void skcipher_pull_sgl(struct sock *sk, size_t used, int put)
152 struct alg_sock *ask = alg_sk(sk);
153 struct skcipher_ctx *ctx = ask->private;
154 struct skcipher_sg_list *sgl;
155 struct scatterlist *sg;
158 while (!list_empty(&ctx->tsgl)) {
159 sgl = list_first_entry(&ctx->tsgl, struct skcipher_sg_list,
163 for (i = 0; i < sgl->cur; i++) {
164 size_t plen = min_t(size_t, used, sg[i].length);
166 if (!sg_page(sg + i))
169 sg[i].length -= plen;
170 sg[i].offset += plen;
178 put_page(sg_page(sg + i));
179 sg_assign_page(sg + i, NULL);
182 list_del(&sgl->list);
183 sock_kfree_s(sk, sgl,
184 sizeof(*sgl) + sizeof(sgl->sg[0]) *
192 static void skcipher_free_sgl(struct sock *sk)
194 struct alg_sock *ask = alg_sk(sk);
195 struct skcipher_ctx *ctx = ask->private;
197 skcipher_pull_sgl(sk, ctx->used, 1);
200 static int skcipher_wait_for_wmem(struct sock *sk, unsigned flags)
202 DEFINE_WAIT_FUNC(wait, woken_wake_function);
203 int err = -ERESTARTSYS;
206 if (flags & MSG_DONTWAIT)
209 sk_set_bit(SOCKWQ_ASYNC_NOSPACE, sk);
211 add_wait_queue(sk_sleep(sk), &wait);
213 if (signal_pending(current))
215 timeout = MAX_SCHEDULE_TIMEOUT;
216 if (sk_wait_event(sk, &timeout, skcipher_writable(sk), &wait)) {
221 remove_wait_queue(sk_sleep(sk), &wait);
226 static void skcipher_wmem_wakeup(struct sock *sk)
228 struct socket_wq *wq;
230 if (!skcipher_writable(sk))
234 wq = rcu_dereference(sk->sk_wq);
235 if (skwq_has_sleeper(wq))
236 wake_up_interruptible_sync_poll(&wq->wait, POLLIN |
239 sk_wake_async(sk, SOCK_WAKE_WAITD, POLL_IN);
243 static int skcipher_wait_for_data(struct sock *sk, unsigned flags)
245 DEFINE_WAIT_FUNC(wait, woken_wake_function);
246 struct alg_sock *ask = alg_sk(sk);
247 struct skcipher_ctx *ctx = ask->private;
249 int err = -ERESTARTSYS;
251 if (flags & MSG_DONTWAIT) {
255 sk_set_bit(SOCKWQ_ASYNC_WAITDATA, sk);
257 add_wait_queue(sk_sleep(sk), &wait);
259 if (signal_pending(current))
261 timeout = MAX_SCHEDULE_TIMEOUT;
262 if (sk_wait_event(sk, &timeout, ctx->used, &wait)) {
267 remove_wait_queue(sk_sleep(sk), &wait);
269 sk_clear_bit(SOCKWQ_ASYNC_WAITDATA, sk);
274 static void skcipher_data_wakeup(struct sock *sk)
276 struct alg_sock *ask = alg_sk(sk);
277 struct skcipher_ctx *ctx = ask->private;
278 struct socket_wq *wq;
284 wq = rcu_dereference(sk->sk_wq);
285 if (skwq_has_sleeper(wq))
286 wake_up_interruptible_sync_poll(&wq->wait, POLLOUT |
289 sk_wake_async(sk, SOCK_WAKE_SPACE, POLL_OUT);
293 static int skcipher_sendmsg(struct socket *sock, struct msghdr *msg,
296 struct sock *sk = sock->sk;
297 struct alg_sock *ask = alg_sk(sk);
298 struct sock *psk = ask->parent;
299 struct alg_sock *pask = alg_sk(psk);
300 struct skcipher_ctx *ctx = ask->private;
301 struct skcipher_tfm *skc = pask->private;
302 struct crypto_skcipher *tfm = skc->skcipher;
303 unsigned ivsize = crypto_skcipher_ivsize(tfm);
304 struct skcipher_sg_list *sgl;
305 struct af_alg_control con = {};
312 if (msg->msg_controllen) {
313 err = af_alg_cmsg_send(msg, &con);
329 if (con.iv && con.iv->ivlen != ivsize)
336 if (!ctx->more && ctx->used)
342 memcpy(ctx->iv, con.iv->iv, ivsize);
346 struct scatterlist *sg;
347 unsigned long len = size;
351 sgl = list_entry(ctx->tsgl.prev,
352 struct skcipher_sg_list, list);
353 sg = sgl->sg + sgl->cur - 1;
354 len = min_t(unsigned long, len,
355 PAGE_SIZE - sg->offset - sg->length);
357 err = memcpy_from_msg(page_address(sg_page(sg)) +
358 sg->offset + sg->length,
364 ctx->merge = (sg->offset + sg->length) &
373 if (!skcipher_writable(sk)) {
374 err = skcipher_wait_for_wmem(sk, msg->msg_flags);
379 len = min_t(unsigned long, len, skcipher_sndbuf(sk));
381 err = skcipher_alloc_sgl(sk);
385 sgl = list_entry(ctx->tsgl.prev, struct skcipher_sg_list, list);
388 sg_unmark_end(sg + sgl->cur - 1);
391 plen = min_t(size_t, len, PAGE_SIZE);
393 sg_assign_page(sg + i, alloc_page(GFP_KERNEL));
395 if (!sg_page(sg + i))
398 err = memcpy_from_msg(page_address(sg_page(sg + i)),
401 __free_page(sg_page(sg + i));
402 sg_assign_page(sg + i, NULL);
412 } while (len && sgl->cur < MAX_SGL_ENTS);
415 sg_mark_end(sg + sgl->cur - 1);
417 ctx->merge = plen & (PAGE_SIZE - 1);
422 ctx->more = msg->msg_flags & MSG_MORE;
425 skcipher_data_wakeup(sk);
428 return copied ?: err;
431 static ssize_t skcipher_sendpage(struct socket *sock, struct page *page,
432 int offset, size_t size, int flags)
434 struct sock *sk = sock->sk;
435 struct alg_sock *ask = alg_sk(sk);
436 struct skcipher_ctx *ctx = ask->private;
437 struct skcipher_sg_list *sgl;
440 if (flags & MSG_SENDPAGE_NOTLAST)
444 if (!ctx->more && ctx->used)
450 if (!skcipher_writable(sk)) {
451 err = skcipher_wait_for_wmem(sk, flags);
456 err = skcipher_alloc_sgl(sk);
461 sgl = list_entry(ctx->tsgl.prev, struct skcipher_sg_list, list);
464 sg_unmark_end(sgl->sg + sgl->cur - 1);
466 sg_mark_end(sgl->sg + sgl->cur);
468 sg_set_page(sgl->sg + sgl->cur, page, size, offset);
473 ctx->more = flags & MSG_MORE;
476 skcipher_data_wakeup(sk);
482 static int skcipher_all_sg_nents(struct skcipher_ctx *ctx)
484 struct skcipher_sg_list *sgl;
485 struct scatterlist *sg;
488 list_for_each_entry(sgl, &ctx->tsgl, list) {
494 nents += sg_nents(sg);
499 static int skcipher_recvmsg_async(struct socket *sock, struct msghdr *msg,
502 struct sock *sk = sock->sk;
503 struct alg_sock *ask = alg_sk(sk);
504 struct sock *psk = ask->parent;
505 struct alg_sock *pask = alg_sk(psk);
506 struct skcipher_ctx *ctx = ask->private;
507 struct skcipher_tfm *skc = pask->private;
508 struct crypto_skcipher *tfm = skc->skcipher;
509 struct skcipher_sg_list *sgl;
510 struct scatterlist *sg;
511 struct skcipher_async_req *sreq;
512 struct skcipher_request *req;
513 struct skcipher_async_rsgl *last_rsgl = NULL;
514 unsigned int txbufs = 0, len = 0, tx_nents;
515 unsigned int reqsize = crypto_skcipher_reqsize(tfm);
516 unsigned int ivsize = crypto_skcipher_ivsize(tfm);
521 sreq = kzalloc(sizeof(*sreq) + reqsize + ivsize, GFP_KERNEL);
526 iv = (char *)(req + 1) + reqsize;
527 sreq->iocb = msg->msg_iocb;
528 INIT_LIST_HEAD(&sreq->list);
529 sreq->inflight = &ctx->inflight;
532 tx_nents = skcipher_all_sg_nents(ctx);
533 sreq->tsg = kcalloc(tx_nents, sizeof(*sg), GFP_KERNEL);
534 if (unlikely(!sreq->tsg))
536 sg_init_table(sreq->tsg, tx_nents);
537 memcpy(iv, ctx->iv, ivsize);
538 skcipher_request_set_tfm(req, tfm);
539 skcipher_request_set_callback(req, CRYPTO_TFM_REQ_MAY_SLEEP,
540 skcipher_async_cb, sreq);
542 while (iov_iter_count(&msg->msg_iter)) {
543 struct skcipher_async_rsgl *rsgl;
547 err = skcipher_wait_for_data(sk, flags);
551 sgl = list_first_entry(&ctx->tsgl,
552 struct skcipher_sg_list, list);
558 used = min_t(unsigned long, ctx->used,
559 iov_iter_count(&msg->msg_iter));
560 used = min_t(unsigned long, used, sg->length);
562 if (txbufs == tx_nents) {
563 struct scatterlist *tmp;
565 /* Ran out of tx slots in async request
567 tmp = kcalloc(tx_nents * 2, sizeof(*tmp),
572 sg_init_table(tmp, tx_nents * 2);
573 for (x = 0; x < tx_nents; x++)
574 sg_set_page(&tmp[x], sg_page(&sreq->tsg[x]),
576 sreq->tsg[x].offset);
582 /* Need to take over the tx sgl from ctx
583 * to the asynch req - these sgls will be freed later */
584 sg_set_page(sreq->tsg + txbufs++, sg_page(sg), sg->length,
587 if (list_empty(&sreq->list)) {
588 rsgl = &sreq->first_sgl;
589 list_add_tail(&rsgl->list, &sreq->list);
591 rsgl = kmalloc(sizeof(*rsgl), GFP_KERNEL);
596 list_add_tail(&rsgl->list, &sreq->list);
599 used = af_alg_make_sg(&rsgl->sgl, &msg->msg_iter, used);
604 af_alg_link_sg(&last_rsgl->sgl, &rsgl->sgl);
608 skcipher_pull_sgl(sk, used, 0);
609 iov_iter_advance(&msg->msg_iter, used);
613 sg_mark_end(sreq->tsg + txbufs - 1);
615 skcipher_request_set_crypt(req, sreq->tsg, sreq->first_sgl.sgl.sg,
617 err = ctx->enc ? crypto_skcipher_encrypt(req) :
618 crypto_skcipher_decrypt(req);
619 if (err == -EINPROGRESS) {
620 atomic_inc(&ctx->inflight);
626 skcipher_free_async_sgls(sreq);
628 skcipher_wmem_wakeup(sk);
635 static int skcipher_recvmsg_sync(struct socket *sock, struct msghdr *msg,
638 struct sock *sk = sock->sk;
639 struct alg_sock *ask = alg_sk(sk);
640 struct sock *psk = ask->parent;
641 struct alg_sock *pask = alg_sk(psk);
642 struct skcipher_ctx *ctx = ask->private;
643 struct skcipher_tfm *skc = pask->private;
644 struct crypto_skcipher *tfm = skc->skcipher;
645 unsigned bs = crypto_skcipher_blocksize(tfm);
646 struct skcipher_sg_list *sgl;
647 struct scatterlist *sg;
653 while (msg_data_left(msg)) {
655 err = skcipher_wait_for_data(sk, flags);
660 used = min_t(unsigned long, ctx->used, msg_data_left(msg));
662 used = af_alg_make_sg(&ctx->rsgl, &msg->msg_iter, used);
667 if (ctx->more || used < ctx->used)
674 sgl = list_first_entry(&ctx->tsgl,
675 struct skcipher_sg_list, list);
681 skcipher_request_set_crypt(&ctx->req, sg, ctx->rsgl.sg, used,
684 err = af_alg_wait_for_completion(
686 crypto_skcipher_encrypt(&ctx->req) :
687 crypto_skcipher_decrypt(&ctx->req),
691 af_alg_free_sg(&ctx->rsgl);
697 skcipher_pull_sgl(sk, used, 1);
698 iov_iter_advance(&msg->msg_iter, used);
704 skcipher_wmem_wakeup(sk);
707 return copied ?: err;
710 static int skcipher_recvmsg(struct socket *sock, struct msghdr *msg,
711 size_t ignored, int flags)
713 return (msg->msg_iocb && !is_sync_kiocb(msg->msg_iocb)) ?
714 skcipher_recvmsg_async(sock, msg, flags) :
715 skcipher_recvmsg_sync(sock, msg, flags);
718 static unsigned int skcipher_poll(struct file *file, struct socket *sock,
721 struct sock *sk = sock->sk;
722 struct alg_sock *ask = alg_sk(sk);
723 struct skcipher_ctx *ctx = ask->private;
726 sock_poll_wait(file, sk_sleep(sk), wait);
730 mask |= POLLIN | POLLRDNORM;
732 if (skcipher_writable(sk))
733 mask |= POLLOUT | POLLWRNORM | POLLWRBAND;
738 static struct proto_ops algif_skcipher_ops = {
741 .connect = sock_no_connect,
742 .socketpair = sock_no_socketpair,
743 .getname = sock_no_getname,
744 .ioctl = sock_no_ioctl,
745 .listen = sock_no_listen,
746 .shutdown = sock_no_shutdown,
747 .getsockopt = sock_no_getsockopt,
748 .mmap = sock_no_mmap,
749 .bind = sock_no_bind,
750 .accept = sock_no_accept,
751 .setsockopt = sock_no_setsockopt,
753 .release = af_alg_release,
754 .sendmsg = skcipher_sendmsg,
755 .sendpage = skcipher_sendpage,
756 .recvmsg = skcipher_recvmsg,
757 .poll = skcipher_poll,
760 static int skcipher_check_key(struct socket *sock)
764 struct alg_sock *pask;
765 struct skcipher_tfm *tfm;
766 struct sock *sk = sock->sk;
767 struct alg_sock *ask = alg_sk(sk);
774 pask = alg_sk(ask->parent);
778 lock_sock_nested(psk, SINGLE_DEPTH_NESTING);
798 static int skcipher_sendmsg_nokey(struct socket *sock, struct msghdr *msg,
803 err = skcipher_check_key(sock);
807 return skcipher_sendmsg(sock, msg, size);
810 static ssize_t skcipher_sendpage_nokey(struct socket *sock, struct page *page,
811 int offset, size_t size, int flags)
815 err = skcipher_check_key(sock);
819 return skcipher_sendpage(sock, page, offset, size, flags);
822 static int skcipher_recvmsg_nokey(struct socket *sock, struct msghdr *msg,
823 size_t ignored, int flags)
827 err = skcipher_check_key(sock);
831 return skcipher_recvmsg(sock, msg, ignored, flags);
834 static struct proto_ops algif_skcipher_ops_nokey = {
837 .connect = sock_no_connect,
838 .socketpair = sock_no_socketpair,
839 .getname = sock_no_getname,
840 .ioctl = sock_no_ioctl,
841 .listen = sock_no_listen,
842 .shutdown = sock_no_shutdown,
843 .getsockopt = sock_no_getsockopt,
844 .mmap = sock_no_mmap,
845 .bind = sock_no_bind,
846 .accept = sock_no_accept,
847 .setsockopt = sock_no_setsockopt,
849 .release = af_alg_release,
850 .sendmsg = skcipher_sendmsg_nokey,
851 .sendpage = skcipher_sendpage_nokey,
852 .recvmsg = skcipher_recvmsg_nokey,
853 .poll = skcipher_poll,
856 static void *skcipher_bind(const char *name, u32 type, u32 mask)
858 struct skcipher_tfm *tfm;
859 struct crypto_skcipher *skcipher;
861 tfm = kzalloc(sizeof(*tfm), GFP_KERNEL);
863 return ERR_PTR(-ENOMEM);
865 skcipher = crypto_alloc_skcipher(name, type, mask);
866 if (IS_ERR(skcipher)) {
868 return ERR_CAST(skcipher);
871 tfm->skcipher = skcipher;
876 static void skcipher_release(void *private)
878 struct skcipher_tfm *tfm = private;
880 crypto_free_skcipher(tfm->skcipher);
884 static int skcipher_setkey(void *private, const u8 *key, unsigned int keylen)
886 struct skcipher_tfm *tfm = private;
889 err = crypto_skcipher_setkey(tfm->skcipher, key, keylen);
895 static void skcipher_wait(struct sock *sk)
897 struct alg_sock *ask = alg_sk(sk);
898 struct skcipher_ctx *ctx = ask->private;
901 while (atomic_read(&ctx->inflight) && ctr++ < 100)
905 static void skcipher_sock_destruct(struct sock *sk)
907 struct alg_sock *ask = alg_sk(sk);
908 struct skcipher_ctx *ctx = ask->private;
909 struct crypto_skcipher *tfm = crypto_skcipher_reqtfm(&ctx->req);
911 if (atomic_read(&ctx->inflight))
914 skcipher_free_sgl(sk);
915 sock_kzfree_s(sk, ctx->iv, crypto_skcipher_ivsize(tfm));
916 sock_kfree_s(sk, ctx, ctx->len);
917 af_alg_release_parent(sk);
920 static int skcipher_accept_parent_nokey(void *private, struct sock *sk)
922 struct skcipher_ctx *ctx;
923 struct alg_sock *ask = alg_sk(sk);
924 struct skcipher_tfm *tfm = private;
925 struct crypto_skcipher *skcipher = tfm->skcipher;
926 unsigned int len = sizeof(*ctx) + crypto_skcipher_reqsize(skcipher);
928 ctx = sock_kmalloc(sk, len, GFP_KERNEL);
932 ctx->iv = sock_kmalloc(sk, crypto_skcipher_ivsize(skcipher),
935 sock_kfree_s(sk, ctx, len);
939 memset(ctx->iv, 0, crypto_skcipher_ivsize(skcipher));
941 INIT_LIST_HEAD(&ctx->tsgl);
947 atomic_set(&ctx->inflight, 0);
948 af_alg_init_completion(&ctx->completion);
952 skcipher_request_set_tfm(&ctx->req, skcipher);
953 skcipher_request_set_callback(&ctx->req, CRYPTO_TFM_REQ_MAY_SLEEP |
954 CRYPTO_TFM_REQ_MAY_BACKLOG,
955 af_alg_complete, &ctx->completion);
957 sk->sk_destruct = skcipher_sock_destruct;
962 static int skcipher_accept_parent(void *private, struct sock *sk)
964 struct skcipher_tfm *tfm = private;
966 if (!tfm->has_key && crypto_skcipher_has_setkey(tfm->skcipher))
969 return skcipher_accept_parent_nokey(private, sk);
972 static const struct af_alg_type algif_type_skcipher = {
973 .bind = skcipher_bind,
974 .release = skcipher_release,
975 .setkey = skcipher_setkey,
976 .accept = skcipher_accept_parent,
977 .accept_nokey = skcipher_accept_parent_nokey,
978 .ops = &algif_skcipher_ops,
979 .ops_nokey = &algif_skcipher_ops_nokey,
984 static int __init algif_skcipher_init(void)
986 return af_alg_register_type(&algif_type_skcipher);
989 static void __exit algif_skcipher_exit(void)
991 int err = af_alg_unregister_type(&algif_type_skcipher);
995 module_init(algif_skcipher_init);
996 module_exit(algif_skcipher_exit);
997 MODULE_LICENSE("GPL");