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)
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/security.h>
26 struct alg_type_list {
27 const struct af_alg_type *type;
28 struct list_head list;
31 static atomic_long_t alg_memory_allocated;
33 static struct proto alg_proto = {
36 .memory_allocated = &alg_memory_allocated,
37 .obj_size = sizeof(struct alg_sock),
40 static LIST_HEAD(alg_types);
41 static DECLARE_RWSEM(alg_types_sem);
43 static const struct af_alg_type *alg_get_type(const char *name)
45 const struct af_alg_type *type = ERR_PTR(-ENOENT);
46 struct alg_type_list *node;
48 down_read(&alg_types_sem);
49 list_for_each_entry(node, &alg_types, list) {
50 if (strcmp(node->type->name, name))
53 if (try_module_get(node->type->owner))
57 up_read(&alg_types_sem);
62 int af_alg_register_type(const struct af_alg_type *type)
64 struct alg_type_list *node;
67 down_write(&alg_types_sem);
68 list_for_each_entry(node, &alg_types, list) {
69 if (!strcmp(node->type->name, type->name))
73 node = kmalloc(sizeof(*node), GFP_KERNEL);
78 type->ops->owner = THIS_MODULE;
80 type->ops_nokey->owner = THIS_MODULE;
82 list_add(&node->list, &alg_types);
86 up_write(&alg_types_sem);
90 EXPORT_SYMBOL_GPL(af_alg_register_type);
92 int af_alg_unregister_type(const struct af_alg_type *type)
94 struct alg_type_list *node;
97 down_write(&alg_types_sem);
98 list_for_each_entry(node, &alg_types, list) {
99 if (strcmp(node->type->name, type->name))
102 list_del(&node->list);
107 up_write(&alg_types_sem);
111 EXPORT_SYMBOL_GPL(af_alg_unregister_type);
113 static void alg_do_release(const struct af_alg_type *type, void *private)
118 type->release(private);
119 module_put(type->owner);
122 int af_alg_release(struct socket *sock)
128 EXPORT_SYMBOL_GPL(af_alg_release);
130 void af_alg_release_parent(struct sock *sk)
132 struct alg_sock *ask = alg_sk(sk);
133 unsigned int nokey = ask->nokey_refcnt;
134 bool last = nokey && !ask->refcnt;
140 ask->nokey_refcnt -= nokey;
142 last = !--ask->refcnt;
148 EXPORT_SYMBOL_GPL(af_alg_release_parent);
150 static int alg_bind(struct socket *sock, struct sockaddr *uaddr, int addr_len)
152 const u32 forbidden = CRYPTO_ALG_INTERNAL;
153 struct sock *sk = sock->sk;
154 struct alg_sock *ask = alg_sk(sk);
155 struct sockaddr_alg *sa = (void *)uaddr;
156 const struct af_alg_type *type;
160 if (sock->state == SS_CONNECTED)
163 if (addr_len != sizeof(*sa))
166 sa->salg_type[sizeof(sa->salg_type) - 1] = 0;
167 sa->salg_name[sizeof(sa->salg_name) - 1] = 0;
169 type = alg_get_type(sa->salg_type);
170 if (IS_ERR(type) && PTR_ERR(type) == -ENOENT) {
171 request_module("algif-%s", sa->salg_type);
172 type = alg_get_type(sa->salg_type);
176 return PTR_ERR(type);
178 private = type->bind(sa->salg_name,
179 sa->salg_feat & ~forbidden,
180 sa->salg_mask & ~forbidden);
181 if (IS_ERR(private)) {
182 module_put(type->owner);
183 return PTR_ERR(private);
188 if (ask->refcnt | ask->nokey_refcnt)
191 swap(ask->type, type);
192 swap(ask->private, private);
199 alg_do_release(type, private);
204 static int alg_setkey(struct sock *sk, char __user *ukey,
207 struct alg_sock *ask = alg_sk(sk);
208 const struct af_alg_type *type = ask->type;
212 key = sock_kmalloc(sk, keylen, GFP_KERNEL);
217 if (copy_from_user(key, ukey, keylen))
220 err = type->setkey(ask->private, key, keylen);
223 sock_kzfree_s(sk, key, keylen);
228 static int alg_setsockopt(struct socket *sock, int level, int optname,
229 char __user *optval, unsigned int optlen)
231 struct sock *sk = sock->sk;
232 struct alg_sock *ask = alg_sk(sk);
233 const struct af_alg_type *type;
243 if (level != SOL_ALG || !type)
248 if (sock->state == SS_CONNECTED)
253 err = alg_setkey(sk, optval, optlen);
255 case ALG_SET_AEAD_AUTHSIZE:
256 if (sock->state == SS_CONNECTED)
258 if (!type->setauthsize)
260 err = type->setauthsize(ask->private, optlen);
269 int af_alg_accept(struct sock *sk, struct socket *newsock)
271 struct alg_sock *ask = alg_sk(sk);
272 const struct af_alg_type *type;
284 sk2 = sk_alloc(sock_net(sk), PF_ALG, GFP_KERNEL, &alg_proto, 0);
289 sock_init_data(newsock, sk2);
290 sock_graft(sk2, newsock);
291 security_sk_clone(sk, sk2);
293 err = type->accept(ask->private, sk2);
295 nokey = err == -ENOKEY;
296 if (nokey && type->accept_nokey)
297 err = type->accept_nokey(ask->private, sk2);
302 sk2->sk_family = PF_ALG;
304 if (nokey || !ask->refcnt++)
306 ask->nokey_refcnt += nokey;
307 alg_sk(sk2)->parent = sk;
308 alg_sk(sk2)->type = type;
309 alg_sk(sk2)->nokey_refcnt = nokey;
311 newsock->ops = type->ops;
312 newsock->state = SS_CONNECTED;
315 newsock->ops = type->ops_nokey;
324 EXPORT_SYMBOL_GPL(af_alg_accept);
326 static int alg_accept(struct socket *sock, struct socket *newsock, int flags)
328 return af_alg_accept(sock->sk, newsock);
331 static const struct proto_ops alg_proto_ops = {
333 .owner = THIS_MODULE,
335 .connect = sock_no_connect,
336 .socketpair = sock_no_socketpair,
337 .getname = sock_no_getname,
338 .ioctl = sock_no_ioctl,
339 .listen = sock_no_listen,
340 .shutdown = sock_no_shutdown,
341 .getsockopt = sock_no_getsockopt,
342 .mmap = sock_no_mmap,
343 .sendpage = sock_no_sendpage,
344 .sendmsg = sock_no_sendmsg,
345 .recvmsg = sock_no_recvmsg,
346 .poll = sock_no_poll,
349 .release = af_alg_release,
350 .setsockopt = alg_setsockopt,
351 .accept = alg_accept,
354 static void alg_sock_destruct(struct sock *sk)
356 struct alg_sock *ask = alg_sk(sk);
358 alg_do_release(ask->type, ask->private);
361 static int alg_create(struct net *net, struct socket *sock, int protocol,
367 if (sock->type != SOCK_SEQPACKET)
368 return -ESOCKTNOSUPPORT;
370 return -EPROTONOSUPPORT;
373 sk = sk_alloc(net, PF_ALG, GFP_KERNEL, &alg_proto, kern);
377 sock->ops = &alg_proto_ops;
378 sock_init_data(sock, sk);
380 sk->sk_family = PF_ALG;
381 sk->sk_destruct = alg_sock_destruct;
388 static const struct net_proto_family alg_family = {
390 .create = alg_create,
391 .owner = THIS_MODULE,
394 int af_alg_make_sg(struct af_alg_sgl *sgl, struct iov_iter *iter, int len)
400 n = iov_iter_get_pages(iter, sgl->pages, len, ALG_MAX_PAGES, &off);
404 npages = (off + n + PAGE_SIZE - 1) >> PAGE_SHIFT;
405 if (WARN_ON(npages == 0))
407 /* Add one extra for linking */
408 sg_init_table(sgl->sg, npages + 1);
410 for (i = 0, len = n; i < npages; i++) {
411 int plen = min_t(int, len, PAGE_SIZE - off);
413 sg_set_page(sgl->sg + i, sgl->pages[i], plen, off);
418 sg_mark_end(sgl->sg + npages - 1);
419 sgl->npages = npages;
423 EXPORT_SYMBOL_GPL(af_alg_make_sg);
425 void af_alg_link_sg(struct af_alg_sgl *sgl_prev, struct af_alg_sgl *sgl_new)
427 sg_unmark_end(sgl_prev->sg + sgl_prev->npages - 1);
428 sg_chain(sgl_prev->sg, sgl_prev->npages + 1, sgl_new->sg);
430 EXPORT_SYMBOL_GPL(af_alg_link_sg);
432 void af_alg_free_sg(struct af_alg_sgl *sgl)
436 for (i = 0; i < sgl->npages; i++)
437 put_page(sgl->pages[i]);
439 EXPORT_SYMBOL_GPL(af_alg_free_sg);
441 int af_alg_cmsg_send(struct msghdr *msg, struct af_alg_control *con)
443 struct cmsghdr *cmsg;
445 for_each_cmsghdr(cmsg, msg) {
446 if (!CMSG_OK(msg, cmsg))
448 if (cmsg->cmsg_level != SOL_ALG)
451 switch (cmsg->cmsg_type) {
453 if (cmsg->cmsg_len < CMSG_LEN(sizeof(*con->iv)))
455 con->iv = (void *)CMSG_DATA(cmsg);
456 if (cmsg->cmsg_len < CMSG_LEN(con->iv->ivlen +
462 if (cmsg->cmsg_len < CMSG_LEN(sizeof(u32)))
464 con->op = *(u32 *)CMSG_DATA(cmsg);
467 case ALG_SET_AEAD_ASSOCLEN:
468 if (cmsg->cmsg_len < CMSG_LEN(sizeof(u32)))
470 con->aead_assoclen = *(u32 *)CMSG_DATA(cmsg);
480 EXPORT_SYMBOL_GPL(af_alg_cmsg_send);
482 int af_alg_wait_for_completion(int err, struct af_alg_completion *completion)
487 wait_for_completion(&completion->completion);
488 reinit_completion(&completion->completion);
489 err = completion->err;
495 EXPORT_SYMBOL_GPL(af_alg_wait_for_completion);
497 void af_alg_complete(struct crypto_async_request *req, int err)
499 struct af_alg_completion *completion = req->data;
501 if (err == -EINPROGRESS)
504 completion->err = err;
505 complete(&completion->completion);
507 EXPORT_SYMBOL_GPL(af_alg_complete);
509 static int __init af_alg_init(void)
511 int err = proto_register(&alg_proto, 0);
516 err = sock_register(&alg_family);
518 goto out_unregister_proto;
523 out_unregister_proto:
524 proto_unregister(&alg_proto);
528 static void __exit af_alg_exit(void)
530 sock_unregister(PF_ALG);
531 proto_unregister(&alg_proto);
534 module_init(af_alg_init);
535 module_exit(af_alg_exit);
536 MODULE_LICENSE("GPL");
537 MODULE_ALIAS_NETPROTO(AF_ALG);