crypto/af_alg.c

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