security/keys/keyctl.c

   1 /* Userspace key control operations
   2  *
   3  * Copyright (C) 2004-5 Red Hat, Inc. All Rights Reserved.
   4  * Written by David Howells (dhowells@redhat.com)
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version
   9  * 2 of the License, or (at your option) any later version.
  10  */
  11
  12 #include <linux/module.h>
  13 #include <linux/init.h>
  14 #include <linux/sched.h>
  15 #include <linux/sched/task.h>
  16 #include <linux/slab.h>
  17 #include <linux/syscalls.h>
  18 #include <linux/key.h>
  19 #include <linux/keyctl.h>
  20 #include <linux/fs.h>
  21 #include <linux/capability.h>
  22 #include <linux/cred.h>
  23 #include <linux/string.h>
  24 #include <linux/err.h>
  25 #include <linux/vmalloc.h>
  26 #include <linux/security.h>
  27 #include <linux/uio.h>
  28 #include <linux/uaccess.h>
  29 #include <keys/request_key_auth-type.h>
  30 #include "internal.h"
  31
  32 #define KEY_MAX_DESC_SIZE 4096
  33
  34 static int key_get_type_from_user(char *type,
  35                                   const char __user *_type,
  36                                   unsigned len)
  37 {
  38         int ret;
  39
  40         ret = strncpy_from_user(type, _type, len);
  41         if (ret < 0)
  42                 return ret;
  43         if (ret == 0 || ret >= len)
  44                 return -EINVAL;
  45         if (type[0] == '.')
  46                 return -EPERM;
  47         type[len - 1] = '\0';
  48         return 0;
  49 }
  50
  51 /*
  52  * Extract the description of a new key from userspace and either add it as a
  53  * new key to the specified keyring or update a matching key in that keyring.
  54  *
  55  * If the description is NULL or an empty string, the key type is asked to
  56  * generate one from the payload.
  57  *
  58  * The keyring must be writable so that we can attach the key to it.
  59  *
  60  * If successful, the new key's serial number is returned, otherwise an error
  61  * code is returned.
  62  */
  63 SYSCALL_DEFINE5(add_key, const char __user *, _type,
  64                 const char __user *, _description,
  65                 const void __user *, _payload,
  66                 size_t, plen,
  67                 key_serial_t, ringid)
  68 {
  69         key_ref_t keyring_ref, key_ref;
  70         char type[32], *description;
  71         void *payload;
  72         long ret;
  73
  74         ret = -EINVAL;
  75         if (plen > 1024 * 1024 - 1)
  76                 goto error;
  77
  78         /* draw all the data into kernel space */
  79         ret = key_get_type_from_user(type, _type, sizeof(type));
  80         if (ret < 0)
  81                 goto error;
  82
  83         description = NULL;
  84         if (_description) {
  85                 description = strndup_user(_description, KEY_MAX_DESC_SIZE);
  86                 if (IS_ERR(description)) {
  87                         ret = PTR_ERR(description);
  88                         goto error;
  89                 }
  90                 if (!*description) {
  91                         kfree(description);
  92                         description = NULL;
  93                 } else if ((description[0] == '.') &&
  94                            (strncmp(type, "keyring", 7) == 0)) {
  95                         ret = -EPERM;
  96                         goto error2;
  97                 }
  98         }
  99
 100         /* pull the payload in if one was supplied */
 101         payload = NULL;
 102
 103         if (plen) {
 104                 ret = -ENOMEM;
 105                 payload = kvmalloc(plen, GFP_KERNEL);
 106                 if (!payload)
 107                         goto error2;
 108
 109                 ret = -EFAULT;
 110                 if (copy_from_user(payload, _payload, plen) != 0)
 111                         goto error3;
 112         }
 113
 114         /* find the target keyring (which must be writable) */
 115         keyring_ref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE);
 116         if (IS_ERR(keyring_ref)) {
 117                 ret = PTR_ERR(keyring_ref);
 118                 goto error3;
 119         }
 120
 121         /* create or update the requested key and add it to the target
 122          * keyring */
 123         key_ref = key_create_or_update(keyring_ref, type, description,
 124                                        payload, plen, KEY_PERM_UNDEF,
 125                                        KEY_ALLOC_IN_QUOTA);
 126         if (!IS_ERR(key_ref)) {
 127                 ret = key_ref_to_ptr(key_ref)->serial;
 128                 key_ref_put(key_ref);
 129         }
 130         else {
 131                 ret = PTR_ERR(key_ref);
 132         }
 133
 134         key_ref_put(keyring_ref);
 135  error3:
 136         kvfree_sensitive(payload, plen);
 137  error2:
 138         kfree(description);
 139  error:
 140         return ret;
 141 }
 142
 143 /*
 144  * Search the process keyrings and keyring trees linked from those for a
 145  * matching key.  Keyrings must have appropriate Search permission to be
 146  * searched.
 147  *
 148  * If a key is found, it will be attached to the destination keyring if there's
 149  * one specified and the serial number of the key will be returned.
 150  *
 151  * If no key is found, /sbin/request-key will be invoked if _callout_info is
 152  * non-NULL in an attempt to create a key.  The _callout_info string will be
 153  * passed to /sbin/request-key to aid with completing the request.  If the
 154  * _callout_info string is "" then it will be changed to "-".
 155  */
 156 SYSCALL_DEFINE4(request_key, const char __user *, _type,
 157                 const char __user *, _description,
 158                 const char __user *, _callout_info,
 159                 key_serial_t, destringid)
 160 {
 161         struct key_type *ktype;
 162         struct key *key;
 163         key_ref_t dest_ref;
 164         size_t callout_len;
 165         char type[32], *description, *callout_info;
 166         long ret;
 167
 168         /* pull the type into kernel space */
 169         ret = key_get_type_from_user(type, _type, sizeof(type));
 170         if (ret < 0)
 171                 goto error;
 172
 173         /* pull the description into kernel space */
 174         description = strndup_user(_description, KEY_MAX_DESC_SIZE);
 175         if (IS_ERR(description)) {
 176                 ret = PTR_ERR(description);
 177                 goto error;
 178         }
 179
 180         /* pull the callout info into kernel space */
 181         callout_info = NULL;
 182         callout_len = 0;
 183         if (_callout_info) {
 184                 callout_info = strndup_user(_callout_info, PAGE_SIZE);
 185                 if (IS_ERR(callout_info)) {
 186                         ret = PTR_ERR(callout_info);
 187                         goto error2;
 188                 }
 189                 callout_len = strlen(callout_info);
 190         }
 191
 192         /* get the destination keyring if specified */
 193         dest_ref = NULL;
 194         if (destringid) {
 195                 dest_ref = lookup_user_key(destringid, KEY_LOOKUP_CREATE,
 196                                            KEY_NEED_WRITE);
 197                 if (IS_ERR(dest_ref)) {
 198                         ret = PTR_ERR(dest_ref);
 199                         goto error3;
 200                 }
 201         }
 202
 203         /* find the key type */
 204         ktype = key_type_lookup(type);
 205         if (IS_ERR(ktype)) {
 206                 ret = PTR_ERR(ktype);
 207                 goto error4;
 208         }
 209
 210         /* do the search */
 211         key = request_key_and_link(ktype, description, callout_info,
 212                                    callout_len, NULL, key_ref_to_ptr(dest_ref),
 213                                    KEY_ALLOC_IN_QUOTA);
 214         if (IS_ERR(key)) {
 215                 ret = PTR_ERR(key);
 216                 goto error5;
 217         }
 218
 219         /* wait for the key to finish being constructed */
 220         ret = wait_for_key_construction(key, 1);
 221         if (ret < 0)
 222                 goto error6;
 223
 224         ret = key->serial;
 225
 226 error6:
 227         key_put(key);
 228 error5:
 229         key_type_put(ktype);
 230 error4:
 231         key_ref_put(dest_ref);
 232 error3:
 233         kfree(callout_info);
 234 error2:
 235         kfree(description);
 236 error:
 237         return ret;
 238 }
 239
 240 /*
 241  * Get the ID of the specified process keyring.
 242  *
 243  * The requested keyring must have search permission to be found.
 244  *
 245  * If successful, the ID of the requested keyring will be returned.
 246  */
 247 long keyctl_get_keyring_ID(key_serial_t id, int create)
 248 {
 249         key_ref_t key_ref;
 250         unsigned long lflags;
 251         long ret;
 252
 253         lflags = create ? KEY_LOOKUP_CREATE : 0;
 254         key_ref = lookup_user_key(id, lflags, KEY_NEED_SEARCH);
 255         if (IS_ERR(key_ref)) {
 256                 ret = PTR_ERR(key_ref);
 257                 goto error;
 258         }
 259
 260         ret = key_ref_to_ptr(key_ref)->serial;
 261         key_ref_put(key_ref);
 262 error:
 263         return ret;
 264 }
 265
 266 /*
 267  * Join a (named) session keyring.
 268  *
 269  * Create and join an anonymous session keyring or join a named session
 270  * keyring, creating it if necessary.  A named session keyring must have Search
 271  * permission for it to be joined.  Session keyrings without this permit will
 272  * be skipped over.  It is not permitted for userspace to create or join
 273  * keyrings whose name begin with a dot.
 274  *
 275  * If successful, the ID of the joined session keyring will be returned.
 276  */
 277 long keyctl_join_session_keyring(const char __user *_name)
 278 {
 279         char *name;
 280         long ret;
 281
 282         /* fetch the name from userspace */
 283         name = NULL;
 284         if (_name) {
 285                 name = strndup_user(_name, KEY_MAX_DESC_SIZE);
 286                 if (IS_ERR(name)) {
 287                         ret = PTR_ERR(name);
 288                         goto error;
 289                 }
 290
 291                 ret = -EPERM;
 292                 if (name[0] == '.')
 293                         goto error_name;
 294         }
 295
 296         /* join the session */
 297         ret = join_session_keyring(name);
 298 error_name:
 299         kfree(name);
 300 error:
 301         return ret;
 302 }
 303
 304 /*
 305  * Update a key's data payload from the given data.
 306  *
 307  * The key must grant the caller Write permission and the key type must support
 308  * updating for this to work.  A negative key can be positively instantiated
 309  * with this call.
 310  *
 311  * If successful, 0 will be returned.  If the key type does not support
 312  * updating, then -EOPNOTSUPP will be returned.
 313  */
 314 long keyctl_update_key(key_serial_t id,
 315                        const void __user *_payload,
 316                        size_t plen)
 317 {
 318         key_ref_t key_ref;
 319         void *payload;
 320         long ret;
 321
 322         ret = -EINVAL;
 323         if (plen > PAGE_SIZE)
 324                 goto error;
 325
 326         /* pull the payload in if one was supplied */
 327         payload = NULL;
 328         if (plen) {
 329                 ret = -ENOMEM;
 330                 payload = kvmalloc(plen, GFP_KERNEL);
 331                 if (!payload)
 332                         goto error;
 333
 334                 ret = -EFAULT;
 335                 if (copy_from_user(payload, _payload, plen) != 0)
 336                         goto error2;
 337         }
 338
 339         /* find the target key (which must be writable) */
 340         key_ref = lookup_user_key(id, 0, KEY_NEED_WRITE);
 341         if (IS_ERR(key_ref)) {
 342                 ret = PTR_ERR(key_ref);
 343                 goto error2;
 344         }
 345
 346         /* update the key */
 347         ret = key_update(key_ref, payload, plen);
 348
 349         key_ref_put(key_ref);
 350 error2:
 351         kvfree_sensitive(payload, plen);
 352 error:
 353         return ret;
 354 }
 355
 356 /*
 357  * Revoke a key.
 358  *
 359  * The key must be grant the caller Write or Setattr permission for this to
 360  * work.  The key type should give up its quota claim when revoked.  The key
 361  * and any links to the key will be automatically garbage collected after a
 362  * certain amount of time (/proc/sys/kernel/keys/gc_delay).
 363  *
 364  * Keys with KEY_FLAG_KEEP set should not be revoked.
 365  *
 366  * If successful, 0 is returned.
 367  */
 368 long keyctl_revoke_key(key_serial_t id)
 369 {
 370         key_ref_t key_ref;
 371         struct key *key;
 372         long ret;
 373
 374         key_ref = lookup_user_key(id, 0, KEY_NEED_WRITE);
 375         if (IS_ERR(key_ref)) {
 376                 ret = PTR_ERR(key_ref);
 377                 if (ret != -EACCES)
 378                         goto error;
 379                 key_ref = lookup_user_key(id, 0, KEY_NEED_SETATTR);
 380                 if (IS_ERR(key_ref)) {
 381                         ret = PTR_ERR(key_ref);
 382                         goto error;
 383                 }
 384         }
 385
 386         key = key_ref_to_ptr(key_ref);
 387         ret = 0;
 388         if (test_bit(KEY_FLAG_KEEP, &key->flags))
 389                 ret = -EPERM;
 390         else
 391                 key_revoke(key);
 392
 393         key_ref_put(key_ref);
 394 error:
 395         return ret;
 396 }
 397
 398 /*
 399  * Invalidate a key.
 400  *
 401  * The key must be grant the caller Invalidate permission for this to work.
 402  * The key and any links to the key will be automatically garbage collected
 403  * immediately.
 404  *
 405  * Keys with KEY_FLAG_KEEP set should not be invalidated.
 406  *
 407  * If successful, 0 is returned.
 408  */
 409 long keyctl_invalidate_key(key_serial_t id)
 410 {
 411         key_ref_t key_ref;
 412         struct key *key;
 413         long ret;
 414
 415         kenter("%d", id);
 416
 417         key_ref = lookup_user_key(id, 0, KEY_NEED_SEARCH);
 418         if (IS_ERR(key_ref)) {
 419                 ret = PTR_ERR(key_ref);
 420
 421                 /* Root is permitted to invalidate certain special keys */
 422                 if (capable(CAP_SYS_ADMIN)) {
 423                         key_ref = lookup_user_key(id, 0, 0);
 424                         if (IS_ERR(key_ref))
 425                                 goto error;
 426                         if (test_bit(KEY_FLAG_ROOT_CAN_INVAL,
 427                                      &key_ref_to_ptr(key_ref)->flags))
 428                                 goto invalidate;
 429                         goto error_put;
 430                 }
 431
 432                 goto error;
 433         }
 434
 435 invalidate:
 436         key = key_ref_to_ptr(key_ref);
 437         ret = 0;
 438         if (test_bit(KEY_FLAG_KEEP, &key->flags))
 439                 ret = -EPERM;
 440         else
 441                 key_invalidate(key);
 442 error_put:
 443         key_ref_put(key_ref);
 444 error:
 445         kleave(" = %ld", ret);
 446         return ret;
 447 }
 448
 449 /*
 450  * Clear the specified keyring, creating an empty process keyring if one of the
 451  * special keyring IDs is used.
 452  *
 453  * The keyring must grant the caller Write permission and not have
 454  * KEY_FLAG_KEEP set for this to work.  If successful, 0 will be returned.
 455  */
 456 long keyctl_keyring_clear(key_serial_t ringid)
 457 {
 458         key_ref_t keyring_ref;
 459         struct key *keyring;
 460         long ret;
 461
 462         keyring_ref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE);
 463         if (IS_ERR(keyring_ref)) {
 464                 ret = PTR_ERR(keyring_ref);
 465
 466                 /* Root is permitted to invalidate certain special keyrings */
 467                 if (capable(CAP_SYS_ADMIN)) {
 468                         keyring_ref = lookup_user_key(ringid, 0, 0);
 469                         if (IS_ERR(keyring_ref))
 470                                 goto error;
 471                         if (test_bit(KEY_FLAG_ROOT_CAN_CLEAR,
 472                                      &key_ref_to_ptr(keyring_ref)->flags))
 473                                 goto clear;
 474                         goto error_put;
 475                 }
 476
 477                 goto error;
 478         }
 479
 480 clear:
 481         keyring = key_ref_to_ptr(keyring_ref);
 482         if (test_bit(KEY_FLAG_KEEP, &keyring->flags))
 483                 ret = -EPERM;
 484         else
 485                 ret = keyring_clear(keyring);
 486 error_put:
 487         key_ref_put(keyring_ref);
 488 error:
 489         return ret;
 490 }
 491
 492 /*
 493  * Create a link from a keyring to a key if there's no matching key in the
 494  * keyring, otherwise replace the link to the matching key with a link to the
 495  * new key.
 496  *
 497  * The key must grant the caller Link permission and the the keyring must grant
 498  * the caller Write permission.  Furthermore, if an additional link is created,
 499  * the keyring's quota will be extended.
 500  *
 501  * If successful, 0 will be returned.
 502  */
 503 long keyctl_keyring_link(key_serial_t id, key_serial_t ringid)
 504 {
 505         key_ref_t keyring_ref, key_ref;
 506         long ret;
 507
 508         keyring_ref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE);
 509         if (IS_ERR(keyring_ref)) {
 510                 ret = PTR_ERR(keyring_ref);
 511                 goto error;
 512         }
 513
 514         key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE, KEY_NEED_LINK);
 515         if (IS_ERR(key_ref)) {
 516                 ret = PTR_ERR(key_ref);
 517                 goto error2;
 518         }
 519
 520         ret = key_link(key_ref_to_ptr(keyring_ref), key_ref_to_ptr(key_ref));
 521
 522         key_ref_put(key_ref);
 523 error2:
 524         key_ref_put(keyring_ref);
 525 error:
 526         return ret;
 527 }
 528
 529 /*
 530  * Unlink a key from a keyring.
 531  *
 532  * The keyring must grant the caller Write permission for this to work; the key
 533  * itself need not grant the caller anything.  If the last link to a key is
 534  * removed then that key will be scheduled for destruction.
 535  *
 536  * Keys or keyrings with KEY_FLAG_KEEP set should not be unlinked.
 537  *
 538  * If successful, 0 will be returned.
 539  */
 540 long keyctl_keyring_unlink(key_serial_t id, key_serial_t ringid)
 541 {
 542         key_ref_t keyring_ref, key_ref;
 543         struct key *keyring, *key;
 544         long ret;
 545
 546         keyring_ref = lookup_user_key(ringid, 0, KEY_NEED_WRITE);
 547         if (IS_ERR(keyring_ref)) {
 548                 ret = PTR_ERR(keyring_ref);
 549                 goto error;
 550         }
 551
 552         key_ref = lookup_user_key(id, KEY_LOOKUP_FOR_UNLINK, 0);
 553         if (IS_ERR(key_ref)) {
 554                 ret = PTR_ERR(key_ref);
 555                 goto error2;
 556         }
 557
 558         keyring = key_ref_to_ptr(keyring_ref);
 559         key = key_ref_to_ptr(key_ref);
 560         if (test_bit(KEY_FLAG_KEEP, &keyring->flags) &&
 561             test_bit(KEY_FLAG_KEEP, &key->flags))
 562                 ret = -EPERM;
 563         else
 564                 ret = key_unlink(keyring, key);
 565
 566         key_ref_put(key_ref);
 567 error2:
 568         key_ref_put(keyring_ref);
 569 error:
 570         return ret;
 571 }
 572
 573 /*
 574  * Return a description of a key to userspace.
 575  *
 576  * The key must grant the caller View permission for this to work.
 577  *
 578  * If there's a buffer, we place up to buflen bytes of data into it formatted
 579  * in the following way:
 580  *
 581  *      type;uid;gid;perm;description<NUL>
 582  *
 583  * If successful, we return the amount of description available, irrespective
 584  * of how much we may have copied into the buffer.
 585  */
 586 long keyctl_describe_key(key_serial_t keyid,
 587                          char __user *buffer,
 588                          size_t buflen)
 589 {
 590         struct key *key, *instkey;
 591         key_ref_t key_ref;
 592         char *infobuf;
 593         long ret;
 594         int desclen, infolen;
 595
 596         key_ref = lookup_user_key(keyid, KEY_LOOKUP_PARTIAL, KEY_NEED_VIEW);
 597         if (IS_ERR(key_ref)) {
 598                 /* viewing a key under construction is permitted if we have the
 599                  * authorisation token handy */
 600                 if (PTR_ERR(key_ref) == -EACCES) {
 601                         instkey = key_get_instantiation_authkey(keyid);
 602                         if (!IS_ERR(instkey)) {
 603                                 key_put(instkey);
 604                                 key_ref = lookup_user_key(keyid,
 605                                                           KEY_LOOKUP_PARTIAL,
 606                                                           0);
 607                                 if (!IS_ERR(key_ref))
 608                                         goto okay;
 609                         }
 610                 }
 611
 612                 ret = PTR_ERR(key_ref);
 613                 goto error;
 614         }
 615
 616 okay:
 617         key = key_ref_to_ptr(key_ref);
 618         desclen = strlen(key->description);
 619
 620         /* calculate how much information we're going to return */
 621         ret = -ENOMEM;
 622         infobuf = kasprintf(GFP_KERNEL,
 623                             "%s;%d;%d;%08x;",
 624                             key->type->name,
 625                             from_kuid_munged(current_user_ns(), key->uid),
 626                             from_kgid_munged(current_user_ns(), key->gid),
 627                             key->perm);
 628         if (!infobuf)
 629                 goto error2;
 630         infolen = strlen(infobuf);
 631         ret = infolen + desclen + 1;
 632
 633         /* consider returning the data */
 634         if (buffer && buflen >= ret) {
 635                 if (copy_to_user(buffer, infobuf, infolen) != 0 ||
 636                     copy_to_user(buffer + infolen, key->description,
 637                                  desclen + 1) != 0)
 638                         ret = -EFAULT;
 639         }
 640
 641         kfree(infobuf);
 642 error2:
 643         key_ref_put(key_ref);
 644 error:
 645         return ret;
 646 }
 647
 648 /*
 649  * Search the specified keyring and any keyrings it links to for a matching
 650  * key.  Only keyrings that grant the caller Search permission will be searched
 651  * (this includes the starting keyring).  Only keys with Search permission can
 652  * be found.
 653  *
 654  * If successful, the found key will be linked to the destination keyring if
 655  * supplied and the key has Link permission, and the found key ID will be
 656  * returned.
 657  */
 658 long keyctl_keyring_search(key_serial_t ringid,
 659                            const char __user *_type,
 660                            const char __user *_description,
 661                            key_serial_t destringid)
 662 {
 663         struct key_type *ktype;
 664         key_ref_t keyring_ref, key_ref, dest_ref;
 665         char type[32], *description;
 666         long ret;
 667
 668         /* pull the type and description into kernel space */
 669         ret = key_get_type_from_user(type, _type, sizeof(type));
 670         if (ret < 0)
 671                 goto error;
 672
 673         description = strndup_user(_description, KEY_MAX_DESC_SIZE);
 674         if (IS_ERR(description)) {
 675                 ret = PTR_ERR(description);
 676                 goto error;
 677         }
 678
 679         /* get the keyring at which to begin the search */
 680         keyring_ref = lookup_user_key(ringid, 0, KEY_NEED_SEARCH);
 681         if (IS_ERR(keyring_ref)) {
 682                 ret = PTR_ERR(keyring_ref);
 683                 goto error2;
 684         }
 685
 686         /* get the destination keyring if specified */
 687         dest_ref = NULL;
 688         if (destringid) {
 689                 dest_ref = lookup_user_key(destringid, KEY_LOOKUP_CREATE,
 690                                            KEY_NEED_WRITE);
 691                 if (IS_ERR(dest_ref)) {
 692                         ret = PTR_ERR(dest_ref);
 693                         goto error3;
 694                 }
 695         }
 696
 697         /* find the key type */
 698         ktype = key_type_lookup(type);
 699         if (IS_ERR(ktype)) {
 700                 ret = PTR_ERR(ktype);
 701                 goto error4;
 702         }
 703
 704         /* do the search */
 705         key_ref = keyring_search(keyring_ref, ktype, description);
 706         if (IS_ERR(key_ref)) {
 707                 ret = PTR_ERR(key_ref);
 708
 709                 /* treat lack or presence of a negative key the same */
 710                 if (ret == -EAGAIN)
 711                         ret = -ENOKEY;
 712                 goto error5;
 713         }
 714
 715         /* link the resulting key to the destination keyring if we can */
 716         if (dest_ref) {
 717                 ret = key_permission(key_ref, KEY_NEED_LINK);
 718                 if (ret < 0)
 719                         goto error6;
 720
 721                 ret = key_link(key_ref_to_ptr(dest_ref), key_ref_to_ptr(key_ref));
 722                 if (ret < 0)
 723                         goto error6;
 724         }
 725
 726         ret = key_ref_to_ptr(key_ref)->serial;
 727
 728 error6:
 729         key_ref_put(key_ref);
 730 error5:
 731         key_type_put(ktype);
 732 error4:
 733         key_ref_put(dest_ref);
 734 error3:
 735         key_ref_put(keyring_ref);
 736 error2:
 737         kfree(description);
 738 error:
 739         return ret;
 740 }
 741
 742 /*
 743  * Call the read method
 744  */
 745 static long __keyctl_read_key(struct key *key, char *buffer, size_t buflen)
 746 {
 747         long ret;
 748
 749         down_read(&key->sem);
 750         ret = key_validate(key);
 751         if (ret == 0)
 752                 ret = key->type->read(key, buffer, buflen);
 753         up_read(&key->sem);
 754         return ret;
 755 }
 756
 757 /*
 758  * Read a key's payload.
 759  *
 760  * The key must either grant the caller Read permission, or it must grant the
 761  * caller Search permission when searched for from the process keyrings.
 762  *
 763  * If successful, we place up to buflen bytes of data into the buffer, if one
 764  * is provided, and return the amount of data that is available in the key,
 765  * irrespective of how much we copied into the buffer.
 766  */
 767 long keyctl_read_key(key_serial_t keyid, char __user *buffer, size_t buflen)
 768 {
 769         struct key *key;
 770         key_ref_t key_ref;
 771         long ret;
 772         char *key_data = NULL;
 773         size_t key_data_len;
 774
 775         /* find the key first */
 776         key_ref = lookup_user_key(keyid, 0, 0);
 777         if (IS_ERR(key_ref)) {
 778                 ret = -ENOKEY;
 779                 goto out;
 780         }
 781
 782         key = key_ref_to_ptr(key_ref);
 783
 784         ret = key_read_state(key);
 785         if (ret < 0)
 786                 goto key_put_out; /* Negatively instantiated */
 787
 788         /* see if we can read it directly */
 789         ret = key_permission(key_ref, KEY_NEED_READ);
 790         if (ret == 0)
 791                 goto can_read_key;
 792         if (ret != -EACCES)
 793                 goto key_put_out;
 794
 795         /* we can't; see if it's searchable from this process's keyrings
 796          * - we automatically take account of the fact that it may be
 797          *   dangling off an instantiation key
 798          */
 799         if (!is_key_possessed(key_ref)) {
 800                 ret = -EACCES;
 801                 goto key_put_out;
 802         }
 803
 804         /* the key is probably readable - now try to read it */
 805 can_read_key:
 806         if (!key->type->read) {
 807                 ret = -EOPNOTSUPP;
 808                 goto key_put_out;
 809         }
 810
 811         if (!buffer || !buflen) {
 812                 /* Get the key length from the read method */
 813                 ret = __keyctl_read_key(key, NULL, 0);
 814                 goto key_put_out;
 815         }
 816
 817         /*
 818          * Read the data with the semaphore held (since we might sleep)
 819          * to protect against the key being updated or revoked.
 820          *
 821          * Allocating a temporary buffer to hold the keys before
 822          * transferring them to user buffer to avoid potential
 823          * deadlock involving page fault and mmap_sem.
 824          *
 825          * key_data_len = (buflen <= PAGE_SIZE)
 826          *              ? buflen : actual length of key data
 827          *
 828          * This prevents allocating arbitrary large buffer which can
 829          * be much larger than the actual key length. In the latter case,
 830          * at least 2 passes of this loop is required.
 831          */
 832         key_data_len = (buflen <= PAGE_SIZE) ? buflen : 0;
 833         for (;;) {
 834                 if (key_data_len) {
 835                         key_data = kvmalloc(key_data_len, GFP_KERNEL);
 836                         if (!key_data) {
 837                                 ret = -ENOMEM;
 838                                 goto key_put_out;
 839                         }
 840                 }
 841
 842                 ret = __keyctl_read_key(key, key_data, key_data_len);
 843
 844                 /*
 845                  * Read methods will just return the required length without
 846                  * any copying if the provided length isn't large enough.
 847                  */
 848                 if (ret <= 0 || ret > buflen)
 849                         break;
 850
 851                 /*
 852                  * The key may change (unlikely) in between 2 consecutive
 853                  * __keyctl_read_key() calls. In this case, we reallocate
 854                  * a larger buffer and redo the key read when
 855                  * key_data_len < ret <= buflen.
 856                  */
 857                 if (ret > key_data_len) {
 858                         if (unlikely(key_data))
 859                                 kvfree_sensitive(key_data, key_data_len);
 860                         key_data_len = ret;
 861                         continue;       /* Allocate buffer */
 862                 }
 863
 864                 if (copy_to_user(buffer, key_data, ret))
 865                         ret = -EFAULT;
 866                 break;
 867         }
 868         kvfree_sensitive(key_data, key_data_len);
 869
 870 key_put_out:
 871         key_put(key);
 872 out:
 873         return ret;
 874 }
 875
 876 /*
 877  * Change the ownership of a key
 878  *
 879  * The key must grant the caller Setattr permission for this to work, though
 880  * the key need not be fully instantiated yet.  For the UID to be changed, or
 881  * for the GID to be changed to a group the caller is not a member of, the
 882  * caller must have sysadmin capability.  If either uid or gid is -1 then that
 883  * attribute is not changed.
 884  *
 885  * If the UID is to be changed, the new user must have sufficient quota to
 886  * accept the key.  The quota deduction will be removed from the old user to
 887  * the new user should the attribute be changed.
 888  *
 889  * If successful, 0 will be returned.
 890  */
 891 long keyctl_chown_key(key_serial_t id, uid_t user, gid_t group)
 892 {
 893         struct key_user *newowner, *zapowner = NULL;
 894         struct key *key;
 895         key_ref_t key_ref;
 896         long ret;
 897         kuid_t uid;
 898         kgid_t gid;
 899
 900         uid = make_kuid(current_user_ns(), user);
 901         gid = make_kgid(current_user_ns(), group);
 902         ret = -EINVAL;
 903         if ((user != (uid_t) -1) && !uid_valid(uid))
 904                 goto error;
 905         if ((group != (gid_t) -1) && !gid_valid(gid))
 906                 goto error;
 907
 908         ret = 0;
 909         if (user == (uid_t) -1 && group == (gid_t) -1)
 910                 goto error;
 911
 912         key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE | KEY_LOOKUP_PARTIAL,
 913                                   KEY_NEED_SETATTR);
 914         if (IS_ERR(key_ref)) {
 915                 ret = PTR_ERR(key_ref);
 916                 goto error;
 917         }
 918
 919         key = key_ref_to_ptr(key_ref);
 920
 921         /* make the changes with the locks held to prevent chown/chown races */
 922         ret = -EACCES;
 923         down_write(&key->sem);
 924
 925         {
 926                 bool is_privileged_op = false;
 927
 928                 /* only the sysadmin can chown a key to some other UID */
 929                 if (user != (uid_t) -1 && !uid_eq(key->uid, uid))
 930                         is_privileged_op = true;
 931
 932                 /* only the sysadmin can set the key's GID to a group other
 933                  * than one of those that the current process subscribes to */
 934                 if (group != (gid_t) -1 && !gid_eq(gid, key->gid) && !in_group_p(gid))
 935                         is_privileged_op = true;
 936
 937                 if (is_privileged_op && !capable(CAP_SYS_ADMIN))
 938                         goto error_put;
 939         }
 940
 941         /* change the UID */
 942         if (user != (uid_t) -1 && !uid_eq(uid, key->uid)) {
 943                 ret = -ENOMEM;
 944                 newowner = key_user_lookup(uid);
 945                 if (!newowner)
 946                         goto error_put;
 947
 948                 /* transfer the quota burden to the new user */
 949                 if (test_bit(KEY_FLAG_IN_QUOTA, &key->flags)) {
 950                         unsigned maxkeys = uid_eq(uid, GLOBAL_ROOT_UID) ?
 951                                 key_quota_root_maxkeys : key_quota_maxkeys;
 952                         unsigned maxbytes = uid_eq(uid, GLOBAL_ROOT_UID) ?
 953                                 key_quota_root_maxbytes : key_quota_maxbytes;
 954
 955                         spin_lock(&newowner->lock);
 956                         if (newowner->qnkeys + 1 > maxkeys ||
 957                             newowner->qnbytes + key->quotalen > maxbytes ||
 958                             newowner->qnbytes + key->quotalen <
 959                             newowner->qnbytes)
 960                                 goto quota_overrun;
 961
 962                         newowner->qnkeys++;
 963                         newowner->qnbytes += key->quotalen;
 964                         spin_unlock(&newowner->lock);
 965
 966                         spin_lock(&key->user->lock);
 967                         key->user->qnkeys--;
 968                         key->user->qnbytes -= key->quotalen;
 969                         spin_unlock(&key->user->lock);
 970                 }
 971
 972                 atomic_dec(&key->user->nkeys);
 973                 atomic_inc(&newowner->nkeys);
 974
 975                 if (key->state != KEY_IS_UNINSTANTIATED) {
 976                         atomic_dec(&key->user->nikeys);
 977                         atomic_inc(&newowner->nikeys);
 978                 }
 979
 980                 zapowner = key->user;
 981                 key->user = newowner;
 982                 key->uid = uid;
 983         }
 984
 985         /* change the GID */
 986         if (group != (gid_t) -1)
 987                 key->gid = gid;
 988
 989         ret = 0;
 990
 991 error_put:
 992         up_write(&key->sem);
 993         key_put(key);
 994         if (zapowner)
 995                 key_user_put(zapowner);
 996 error:
 997         return ret;
 998
 999 quota_overrun:
1000         spin_unlock(&newowner->lock);
1001         zapowner = newowner;
1002         ret = -EDQUOT;
1003         goto error_put;
1004 }
1005
1006 /*
1007  * Change the permission mask on a key.
1008  *
1009  * The key must grant the caller Setattr permission for this to work, though
1010  * the key need not be fully instantiated yet.  If the caller does not have
1011  * sysadmin capability, it may only change the permission on keys that it owns.
1012  */
1013 long keyctl_setperm_key(key_serial_t id, key_perm_t perm)
1014 {
1015         struct key *key;
1016         key_ref_t key_ref;
1017         long ret;
1018
1019         ret = -EINVAL;
1020         if (perm & ~(KEY_POS_ALL | KEY_USR_ALL | KEY_GRP_ALL | KEY_OTH_ALL))
1021                 goto error;
1022
1023         key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE | KEY_LOOKUP_PARTIAL,
1024                                   KEY_NEED_SETATTR);
1025         if (IS_ERR(key_ref)) {
1026                 ret = PTR_ERR(key_ref);
1027                 goto error;
1028         }
1029
1030         key = key_ref_to_ptr(key_ref);
1031
1032         /* make the changes with the locks held to prevent chown/chmod races */
1033         ret = -EACCES;
1034         down_write(&key->sem);
1035
1036         /* if we're not the sysadmin, we can only change a key that we own */
1037         if (uid_eq(key->uid, current_fsuid()) || capable(CAP_SYS_ADMIN)) {
1038                 key->perm = perm;
1039                 ret = 0;
1040         }
1041
1042         up_write(&key->sem);
1043         key_put(key);
1044 error:
1045         return ret;
1046 }
1047
1048 /*
1049  * Get the destination keyring for instantiation and check that the caller has
1050  * Write permission on it.
1051  */
1052 static long get_instantiation_keyring(key_serial_t ringid,
1053                                       struct request_key_auth *rka,
1054                                       struct key **_dest_keyring)
1055 {
1056         key_ref_t dkref;
1057
1058         *_dest_keyring = NULL;
1059
1060         /* just return a NULL pointer if we weren't asked to make a link */
1061         if (ringid == 0)
1062                 return 0;
1063
1064         /* if a specific keyring is nominated by ID, then use that */
1065         if (ringid > 0) {
1066                 dkref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE);
1067                 if (IS_ERR(dkref))
1068                         return PTR_ERR(dkref);
1069                 *_dest_keyring = key_ref_to_ptr(dkref);
1070                 return 0;
1071         }
1072
1073         if (ringid == KEY_SPEC_REQKEY_AUTH_KEY)
1074                 return -EINVAL;
1075
1076         /* otherwise specify the destination keyring recorded in the
1077          * authorisation key (any KEY_SPEC_*_KEYRING) */
1078         if (ringid >= KEY_SPEC_REQUESTOR_KEYRING) {
1079                 *_dest_keyring = key_get(rka->dest_keyring);
1080                 return 0;
1081         }
1082
1083         return -ENOKEY;
1084 }
1085
1086 /*
1087  * Change the request_key authorisation key on the current process.
1088  */
1089 static int keyctl_change_reqkey_auth(struct key *key)
1090 {
1091         struct cred *new;
1092
1093         new = prepare_creds();
1094         if (!new)
1095                 return -ENOMEM;
1096
1097         key_put(new->request_key_auth);
1098         new->request_key_auth = key_get(key);
1099
1100         return commit_creds(new);
1101 }
1102
1103 /*
1104  * Instantiate a key with the specified payload and link the key into the
1105  * destination keyring if one is given.
1106  *
1107  * The caller must have the appropriate instantiation permit set for this to
1108  * work (see keyctl_assume_authority).  No other permissions are required.
1109  *
1110  * If successful, 0 will be returned.
1111  */
1112 long keyctl_instantiate_key_common(key_serial_t id,
1113                                    struct iov_iter *from,
1114                                    key_serial_t ringid)
1115 {
1116         const struct cred *cred = current_cred();
1117         struct request_key_auth *rka;
1118         struct key *instkey, *dest_keyring;
1119         size_t plen = from ? iov_iter_count(from) : 0;
1120         void *payload;
1121         long ret;
1122
1123         kenter("%d,,%zu,%d", id, plen, ringid);
1124
1125         if (!plen)
1126                 from = NULL;
1127
1128         ret = -EINVAL;
1129         if (plen > 1024 * 1024 - 1)
1130                 goto error;
1131
1132         /* the appropriate instantiation authorisation key must have been
1133          * assumed before calling this */
1134         ret = -EPERM;
1135         instkey = cred->request_key_auth;
1136         if (!instkey)
1137                 goto error;
1138
1139         rka = instkey->payload.data[0];
1140         if (rka->target_key->serial != id)
1141                 goto error;
1142
1143         /* pull the payload in if one was supplied */
1144         payload = NULL;
1145
1146         if (from) {
1147                 ret = -ENOMEM;
1148                 payload = kvmalloc(plen, GFP_KERNEL);
1149                 if (!payload)
1150                         goto error;
1151
1152                 ret = -EFAULT;
1153                 if (!copy_from_iter_full(payload, plen, from))
1154                         goto error2;
1155         }
1156
1157         /* find the destination keyring amongst those belonging to the
1158          * requesting task */
1159         ret = get_instantiation_keyring(ringid, rka, &dest_keyring);
1160         if (ret < 0)
1161                 goto error2;
1162
1163         /* instantiate the key and link it into a keyring */
1164         ret = key_instantiate_and_link(rka->target_key, payload, plen,
1165                                        dest_keyring, instkey);
1166
1167         key_put(dest_keyring);
1168
1169         /* discard the assumed authority if it's just been disabled by
1170          * instantiation of the key */
1171         if (ret == 0)
1172                 keyctl_change_reqkey_auth(NULL);
1173
1174 error2:
1175         kvfree_sensitive(payload, plen);
1176 error:
1177         return ret;
1178 }
1179
1180 /*
1181  * Instantiate a key with the specified payload and link the key into the
1182  * destination keyring if one is given.
1183  *
1184  * The caller must have the appropriate instantiation permit set for this to
1185  * work (see keyctl_assume_authority).  No other permissions are required.
1186  *
1187  * If successful, 0 will be returned.
1188  */
1189 long keyctl_instantiate_key(key_serial_t id,
1190                             const void __user *_payload,
1191                             size_t plen,
1192                             key_serial_t ringid)
1193 {
1194         if (_payload && plen) {
1195                 struct iovec iov;
1196                 struct iov_iter from;
1197                 int ret;
1198
1199                 ret = import_single_range(WRITE, (void __user *)_payload, plen,
1200                                           &iov, &from);
1201                 if (unlikely(ret))
1202                         return ret;
1203
1204                 return keyctl_instantiate_key_common(id, &from, ringid);
1205         }
1206
1207         return keyctl_instantiate_key_common(id, NULL, ringid);
1208 }
1209
1210 /*
1211  * Instantiate a key with the specified multipart payload and link the key into
1212  * the destination keyring if one is given.
1213  *
1214  * The caller must have the appropriate instantiation permit set for this to
1215  * work (see keyctl_assume_authority).  No other permissions are required.
1216  *
1217  * If successful, 0 will be returned.
1218  */
1219 long keyctl_instantiate_key_iov(key_serial_t id,
1220                                 const struct iovec __user *_payload_iov,
1221                                 unsigned ioc,
1222                                 key_serial_t ringid)
1223 {
1224         struct iovec iovstack[UIO_FASTIOV], *iov = iovstack;
1225         struct iov_iter from;
1226         long ret;
1227
1228         if (!_payload_iov)
1229                 ioc = 0;
1230
1231         ret = import_iovec(WRITE, _payload_iov, ioc,
1232                                     ARRAY_SIZE(iovstack), &iov, &from);
1233         if (ret < 0)
1234                 return ret;
1235         ret = keyctl_instantiate_key_common(id, &from, ringid);
1236         kfree(iov);
1237         return ret;
1238 }
1239
1240 /*
1241  * Negatively instantiate the key with the given timeout (in seconds) and link
1242  * the key into the destination keyring if one is given.
1243  *
1244  * The caller must have the appropriate instantiation permit set for this to
1245  * work (see keyctl_assume_authority).  No other permissions are required.
1246  *
1247  * The key and any links to the key will be automatically garbage collected
1248  * after the timeout expires.
1249  *
1250  * Negative keys are used to rate limit repeated request_key() calls by causing
1251  * them to return -ENOKEY until the negative key expires.
1252  *
1253  * If successful, 0 will be returned.
1254  */
1255 long keyctl_negate_key(key_serial_t id, unsigned timeout, key_serial_t ringid)
1256 {
1257         return keyctl_reject_key(id, timeout, ENOKEY, ringid);
1258 }
1259
1260 /*
1261  * Negatively instantiate the key with the given timeout (in seconds) and error
1262  * code and link the key into the destination keyring if one is given.
1263  *
1264  * The caller must have the appropriate instantiation permit set for this to
1265  * work (see keyctl_assume_authority).  No other permissions are required.
1266  *
1267  * The key and any links to the key will be automatically garbage collected
1268  * after the timeout expires.
1269  *
1270  * Negative keys are used to rate limit repeated request_key() calls by causing
1271  * them to return the specified error code until the negative key expires.
1272  *
1273  * If successful, 0 will be returned.
1274  */
1275 long keyctl_reject_key(key_serial_t id, unsigned timeout, unsigned error,
1276                        key_serial_t ringid)
1277 {
1278         const struct cred *cred = current_cred();
1279         struct request_key_auth *rka;
1280         struct key *instkey, *dest_keyring;
1281         long ret;
1282
1283         kenter("%d,%u,%u,%d", id, timeout, error, ringid);
1284
1285         /* must be a valid error code and mustn't be a kernel special */
1286         if (error <= 0 ||
1287             error >= MAX_ERRNO ||
1288             error == ERESTARTSYS ||
1289             error == ERESTARTNOINTR ||
1290             error == ERESTARTNOHAND ||
1291             error == ERESTART_RESTARTBLOCK)
1292                 return -EINVAL;
1293
1294         /* the appropriate instantiation authorisation key must have been
1295          * assumed before calling this */
1296         ret = -EPERM;
1297         instkey = cred->request_key_auth;
1298         if (!instkey)
1299                 goto error;
1300
1301         rka = instkey->payload.data[0];
1302         if (rka->target_key->serial != id)
1303                 goto error;
1304
1305         /* find the destination keyring if present (which must also be
1306          * writable) */
1307         ret = get_instantiation_keyring(ringid, rka, &dest_keyring);
1308         if (ret < 0)
1309                 goto error;
1310
1311         /* instantiate the key and link it into a keyring */
1312         ret = key_reject_and_link(rka->target_key, timeout, error,
1313                                   dest_keyring, instkey);
1314
1315         key_put(dest_keyring);
1316
1317         /* discard the assumed authority if it's just been disabled by
1318          * instantiation of the key */
1319         if (ret == 0)
1320                 keyctl_change_reqkey_auth(NULL);
1321
1322 error:
1323         return ret;
1324 }
1325
1326 /*
1327  * Read or set the default keyring in which request_key() will cache keys and
1328  * return the old setting.
1329  *
1330  * If a thread or process keyring is specified then it will be created if it
1331  * doesn't yet exist.  The old setting will be returned if successful.
1332  */
1333 long keyctl_set_reqkey_keyring(int reqkey_defl)
1334 {
1335         struct cred *new;
1336         int ret, old_setting;
1337
1338         old_setting = current_cred_xxx(jit_keyring);
1339
1340         if (reqkey_defl == KEY_REQKEY_DEFL_NO_CHANGE)
1341                 return old_setting;
1342
1343         new = prepare_creds();
1344         if (!new)
1345                 return -ENOMEM;
1346
1347         switch (reqkey_defl) {
1348         case KEY_REQKEY_DEFL_THREAD_KEYRING:
1349                 ret = install_thread_keyring_to_cred(new);
1350                 if (ret < 0)
1351                         goto error;
1352                 goto set;
1353
1354         case KEY_REQKEY_DEFL_PROCESS_KEYRING:
1355                 ret = install_process_keyring_to_cred(new);
1356                 if (ret < 0)
1357                         goto error;
1358                 goto set;
1359
1360         case KEY_REQKEY_DEFL_DEFAULT:
1361         case KEY_REQKEY_DEFL_SESSION_KEYRING:
1362         case KEY_REQKEY_DEFL_USER_KEYRING:
1363         case KEY_REQKEY_DEFL_USER_SESSION_KEYRING:
1364         case KEY_REQKEY_DEFL_REQUESTOR_KEYRING:
1365                 goto set;
1366
1367         case KEY_REQKEY_DEFL_NO_CHANGE:
1368         case KEY_REQKEY_DEFL_GROUP_KEYRING:
1369         default:
1370                 ret = -EINVAL;
1371                 goto error;
1372         }
1373
1374 set:
1375         new->jit_keyring = reqkey_defl;
1376         commit_creds(new);
1377         return old_setting;
1378 error:
1379         abort_creds(new);
1380         return ret;
1381 }
1382
1383 /*
1384  * Set or clear the timeout on a key.
1385  *
1386  * Either the key must grant the caller Setattr permission or else the caller
1387  * must hold an instantiation authorisation token for the key.
1388  *
1389  * The timeout is either 0 to clear the timeout, or a number of seconds from
1390  * the current time.  The key and any links to the key will be automatically
1391  * garbage collected after the timeout expires.
1392  *
1393  * Keys with KEY_FLAG_KEEP set should not be timed out.
1394  *
1395  * If successful, 0 is returned.
1396  */
1397 long keyctl_set_timeout(key_serial_t id, unsigned timeout)
1398 {
1399         struct key *key, *instkey;
1400         key_ref_t key_ref;
1401         long ret;
1402
1403         key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE | KEY_LOOKUP_PARTIAL,
1404                                   KEY_NEED_SETATTR);
1405         if (IS_ERR(key_ref)) {
1406                 /* setting the timeout on a key under construction is permitted
1407                  * if we have the authorisation token handy */
1408                 if (PTR_ERR(key_ref) == -EACCES) {
1409                         instkey = key_get_instantiation_authkey(id);
1410                         if (!IS_ERR(instkey)) {
1411                                 key_put(instkey);
1412                                 key_ref = lookup_user_key(id,
1413                                                           KEY_LOOKUP_PARTIAL,
1414                                                           0);
1415                                 if (!IS_ERR(key_ref))
1416                                         goto okay;
1417                         }
1418                 }
1419
1420                 ret = PTR_ERR(key_ref);
1421                 goto error;
1422         }
1423
1424 okay:
1425         key = key_ref_to_ptr(key_ref);
1426         ret = 0;
1427         if (test_bit(KEY_FLAG_KEEP, &key->flags))
1428                 ret = -EPERM;
1429         else
1430                 key_set_timeout(key, timeout);
1431         key_put(key);
1432
1433 error:
1434         return ret;
1435 }
1436
1437 /*
1438  * Assume (or clear) the authority to instantiate the specified key.
1439  *
1440  * This sets the authoritative token currently in force for key instantiation.
1441  * This must be done for a key to be instantiated.  It has the effect of making
1442  * available all the keys from the caller of the request_key() that created a
1443  * key to request_key() calls made by the caller of this function.
1444  *
1445  * The caller must have the instantiation key in their process keyrings with a
1446  * Search permission grant available to the caller.
1447  *
1448  * If the ID given is 0, then the setting will be cleared and 0 returned.
1449  *
1450  * If the ID given has a matching an authorisation key, then that key will be
1451  * set and its ID will be returned.  The authorisation key can be read to get
1452  * the callout information passed to request_key().
1453  */
1454 long keyctl_assume_authority(key_serial_t id)
1455 {
1456         struct key *authkey;
1457         long ret;
1458
1459         /* special key IDs aren't permitted */
1460         ret = -EINVAL;
1461         if (id < 0)
1462                 goto error;
1463
1464         /* we divest ourselves of authority if given an ID of 0 */
1465         if (id == 0) {
1466                 ret = keyctl_change_reqkey_auth(NULL);
1467                 goto error;
1468         }
1469
1470         /* attempt to assume the authority temporarily granted to us whilst we
1471          * instantiate the specified key
1472          * - the authorisation key must be in the current task's keyrings
1473          *   somewhere
1474          */
1475         authkey = key_get_instantiation_authkey(id);
1476         if (IS_ERR(authkey)) {
1477                 ret = PTR_ERR(authkey);
1478                 goto error;
1479         }
1480
1481         ret = keyctl_change_reqkey_auth(authkey);
1482         if (ret == 0)
1483                 ret = authkey->serial;
1484         key_put(authkey);
1485 error:
1486         return ret;
1487 }
1488
1489 /*
1490  * Get a key's the LSM security label.
1491  *
1492  * The key must grant the caller View permission for this to work.
1493  *
1494  * If there's a buffer, then up to buflen bytes of data will be placed into it.
1495  *
1496  * If successful, the amount of information available will be returned,
1497  * irrespective of how much was copied (including the terminal NUL).
1498  */
1499 long keyctl_get_security(key_serial_t keyid,
1500                          char __user *buffer,
1501                          size_t buflen)
1502 {
1503         struct key *key, *instkey;
1504         key_ref_t key_ref;
1505         char *context;
1506         long ret;
1507
1508         key_ref = lookup_user_key(keyid, KEY_LOOKUP_PARTIAL, KEY_NEED_VIEW);
1509         if (IS_ERR(key_ref)) {
1510                 if (PTR_ERR(key_ref) != -EACCES)
1511                         return PTR_ERR(key_ref);
1512
1513                 /* viewing a key under construction is also permitted if we
1514                  * have the authorisation token handy */
1515                 instkey = key_get_instantiation_authkey(keyid);
1516                 if (IS_ERR(instkey))
1517                         return PTR_ERR(instkey);
1518                 key_put(instkey);
1519
1520                 key_ref = lookup_user_key(keyid, KEY_LOOKUP_PARTIAL, 0);
1521                 if (IS_ERR(key_ref))
1522                         return PTR_ERR(key_ref);
1523         }
1524
1525         key = key_ref_to_ptr(key_ref);
1526         ret = security_key_getsecurity(key, &context);
1527         if (ret == 0) {
1528                 /* if no information was returned, give userspace an empty
1529                  * string */
1530                 ret = 1;
1531                 if (buffer && buflen > 0 &&
1532                     copy_to_user(buffer, "", 1) != 0)
1533                         ret = -EFAULT;
1534         } else if (ret > 0) {
1535                 /* return as much data as there's room for */
1536                 if (buffer && buflen > 0) {
1537                         if (buflen > ret)
1538                                 buflen = ret;
1539
1540                         if (copy_to_user(buffer, context, buflen) != 0)
1541                                 ret = -EFAULT;
1542                 }
1543
1544                 kfree(context);
1545         }
1546
1547         key_ref_put(key_ref);
1548         return ret;
1549 }
1550
1551 /*
1552  * Attempt to install the calling process's session keyring on the process's
1553  * parent process.
1554  *
1555  * The keyring must exist and must grant the caller LINK permission, and the
1556  * parent process must be single-threaded and must have the same effective
1557  * ownership as this process and mustn't be SUID/SGID.
1558  *
1559  * The keyring will be emplaced on the parent when it next resumes userspace.
1560  *
1561  * If successful, 0 will be returned.
1562  */
1563 long keyctl_session_to_parent(void)
1564 {
1565         struct task_struct *me, *parent;
1566         const struct cred *mycred, *pcred;
1567         struct callback_head *newwork, *oldwork;
1568         key_ref_t keyring_r;
1569         struct cred *cred;
1570         int ret;
1571
1572         keyring_r = lookup_user_key(KEY_SPEC_SESSION_KEYRING, 0, KEY_NEED_LINK);
1573         if (IS_ERR(keyring_r))
1574                 return PTR_ERR(keyring_r);
1575
1576         ret = -ENOMEM;
1577
1578         /* our parent is going to need a new cred struct, a new tgcred struct
1579          * and new security data, so we allocate them here to prevent ENOMEM in
1580          * our parent */
1581         cred = cred_alloc_blank();
1582         if (!cred)
1583                 goto error_keyring;
1584         newwork = &cred->rcu;
1585
1586         cred->session_keyring = key_ref_to_ptr(keyring_r);
1587         keyring_r = NULL;
1588         init_task_work(newwork, key_change_session_keyring);
1589
1590         me = current;
1591         rcu_read_lock();
1592         write_lock_irq(&tasklist_lock);
1593
1594         ret = -EPERM;
1595         oldwork = NULL;
1596         parent = me->real_parent;
1597
1598         /* the parent mustn't be init and mustn't be a kernel thread */
1599         if (parent->pid <= 1 || !parent->mm)
1600                 goto unlock;
1601
1602         /* the parent must be single threaded */
1603         if (!thread_group_empty(parent))
1604                 goto unlock;
1605
1606         /* the parent and the child must have different session keyrings or
1607          * there's no point */
1608         mycred = current_cred();
1609         pcred = __task_cred(parent);
1610         if (mycred == pcred ||
1611             mycred->session_keyring == pcred->session_keyring) {
1612                 ret = 0;
1613                 goto unlock;
1614         }
1615
1616         /* the parent must have the same effective ownership and mustn't be
1617          * SUID/SGID */
1618         if (!uid_eq(pcred->uid,  mycred->euid) ||
1619             !uid_eq(pcred->euid, mycred->euid) ||
1620             !uid_eq(pcred->suid, mycred->euid) ||
1621             !gid_eq(pcred->gid,  mycred->egid) ||
1622             !gid_eq(pcred->egid, mycred->egid) ||
1623             !gid_eq(pcred->sgid, mycred->egid))
1624                 goto unlock;
1625
1626         /* the keyrings must have the same UID */
1627         if ((pcred->session_keyring &&
1628              !uid_eq(pcred->session_keyring->uid, mycred->euid)) ||
1629             !uid_eq(mycred->session_keyring->uid, mycred->euid))
1630                 goto unlock;
1631
1632         /* cancel an already pending keyring replacement */
1633         oldwork = task_work_cancel(parent, key_change_session_keyring);
1634
1635         /* the replacement session keyring is applied just prior to userspace
1636          * restarting */
1637         ret = task_work_add(parent, newwork, true);
1638         if (!ret)
1639                 newwork = NULL;
1640 unlock:
1641         write_unlock_irq(&tasklist_lock);
1642         rcu_read_unlock();
1643         if (oldwork)
1644                 put_cred(container_of(oldwork, struct cred, rcu));
1645         if (newwork)
1646                 put_cred(cred);
1647         return ret;
1648
1649 error_keyring:
1650         key_ref_put(keyring_r);
1651         return ret;
1652 }
1653
1654 /*
1655  * Apply a restriction to a given keyring.
1656  *
1657  * The caller must have Setattr permission to change keyring restrictions.
1658  *
1659  * The requested type name may be a NULL pointer to reject all attempts
1660  * to link to the keyring.  In this case, _restriction must also be NULL.
1661  * Otherwise, both _type and _restriction must be non-NULL.
1662  *
1663  * Returns 0 if successful.
1664  */
1665 long keyctl_restrict_keyring(key_serial_t id, const char __user *_type,
1666                              const char __user *_restriction)
1667 {
1668         key_ref_t key_ref;
1669         char type[32];
1670         char *restriction = NULL;
1671         long ret;
1672
1673         key_ref = lookup_user_key(id, 0, KEY_NEED_SETATTR);
1674         if (IS_ERR(key_ref))
1675                 return PTR_ERR(key_ref);
1676
1677         ret = -EINVAL;
1678         if (_type) {
1679                 if (!_restriction)
1680                         goto error;
1681
1682                 ret = key_get_type_from_user(type, _type, sizeof(type));
1683                 if (ret < 0)
1684                         goto error;
1685
1686                 restriction = strndup_user(_restriction, PAGE_SIZE);
1687                 if (IS_ERR(restriction)) {
1688                         ret = PTR_ERR(restriction);
1689                         goto error;
1690                 }
1691         } else {
1692                 if (_restriction)
1693                         goto error;
1694         }
1695
1696         ret = keyring_restrict(key_ref, _type ? type : NULL, restriction);
1697         kfree(restriction);
1698 error:
1699         key_ref_put(key_ref);
1700         return ret;
1701 }
1702
1703 /*
1704  * The key control system call
1705  */
1706 SYSCALL_DEFINE5(keyctl, int, option, unsigned long, arg2, unsigned long, arg3,
1707                 unsigned long, arg4, unsigned long, arg5)
1708 {
1709         switch (option) {
1710         case KEYCTL_GET_KEYRING_ID:
1711                 return keyctl_get_keyring_ID((key_serial_t) arg2,
1712                                              (int) arg3);
1713
1714         case KEYCTL_JOIN_SESSION_KEYRING:
1715                 return keyctl_join_session_keyring((const char __user *) arg2);
1716
1717         case KEYCTL_UPDATE:
1718                 return keyctl_update_key((key_serial_t) arg2,
1719                                          (const void __user *) arg3,
1720                                          (size_t) arg4);
1721
1722         case KEYCTL_REVOKE:
1723                 return keyctl_revoke_key((key_serial_t) arg2);
1724
1725         case KEYCTL_DESCRIBE:
1726                 return keyctl_describe_key((key_serial_t) arg2,
1727                                            (char __user *) arg3,
1728                                            (unsigned) arg4);
1729
1730         case KEYCTL_CLEAR:
1731                 return keyctl_keyring_clear((key_serial_t) arg2);
1732
1733         case KEYCTL_LINK:
1734                 return keyctl_keyring_link((key_serial_t) arg2,
1735                                            (key_serial_t) arg3);
1736
1737         case KEYCTL_UNLINK:
1738                 return keyctl_keyring_unlink((key_serial_t) arg2,
1739                                              (key_serial_t) arg3);
1740
1741         case KEYCTL_SEARCH:
1742                 return keyctl_keyring_search((key_serial_t) arg2,
1743                                              (const char __user *) arg3,
1744                                              (const char __user *) arg4,
1745                                              (key_serial_t) arg5);
1746
1747         case KEYCTL_READ:
1748                 return keyctl_read_key((key_serial_t) arg2,
1749                                        (char __user *) arg3,
1750                                        (size_t) arg4);
1751
1752         case KEYCTL_CHOWN:
1753                 return keyctl_chown_key((key_serial_t) arg2,
1754                                         (uid_t) arg3,
1755                                         (gid_t) arg4);
1756
1757         case KEYCTL_SETPERM:
1758                 return keyctl_setperm_key((key_serial_t) arg2,
1759                                           (key_perm_t) arg3);
1760
1761         case KEYCTL_INSTANTIATE:
1762                 return keyctl_instantiate_key((key_serial_t) arg2,
1763                                               (const void __user *) arg3,
1764                                               (size_t) arg4,
1765                                               (key_serial_t) arg5);
1766
1767         case KEYCTL_NEGATE:
1768                 return keyctl_negate_key((key_serial_t) arg2,
1769                                          (unsigned) arg3,
1770                                          (key_serial_t) arg4);
1771
1772         case KEYCTL_SET_REQKEY_KEYRING:
1773                 return keyctl_set_reqkey_keyring(arg2);
1774
1775         case KEYCTL_SET_TIMEOUT:
1776                 return keyctl_set_timeout((key_serial_t) arg2,
1777                                           (unsigned) arg3);
1778
1779         case KEYCTL_ASSUME_AUTHORITY:
1780                 return keyctl_assume_authority((key_serial_t) arg2);
1781
1782         case KEYCTL_GET_SECURITY:
1783                 return keyctl_get_security((key_serial_t) arg2,
1784                                            (char __user *) arg3,
1785                                            (size_t) arg4);
1786
1787         case KEYCTL_SESSION_TO_PARENT:
1788                 return keyctl_session_to_parent();
1789
1790         case KEYCTL_REJECT:
1791                 return keyctl_reject_key((key_serial_t) arg2,
1792                                          (unsigned) arg3,
1793                                          (unsigned) arg4,
1794                                          (key_serial_t) arg5);
1795
1796         case KEYCTL_INSTANTIATE_IOV:
1797                 return keyctl_instantiate_key_iov(
1798                         (key_serial_t) arg2,
1799                         (const struct iovec __user *) arg3,
1800                         (unsigned) arg4,
1801                         (key_serial_t) arg5);
1802
1803         case KEYCTL_INVALIDATE:
1804                 return keyctl_invalidate_key((key_serial_t) arg2);
1805
1806         case KEYCTL_GET_PERSISTENT:
1807                 return keyctl_get_persistent((uid_t)arg2, (key_serial_t)arg3);
1808
1809         case KEYCTL_DH_COMPUTE:
1810                 return keyctl_dh_compute((struct keyctl_dh_params __user *) arg2,
1811                                          (char __user *) arg3, (size_t) arg4,
1812                                          (struct keyctl_kdf_params __user *) arg5);
1813
1814         case KEYCTL_RESTRICT_KEYRING:
1815                 return keyctl_restrict_keyring((key_serial_t) arg2,
1816                                                (const char __user *) arg3,
1817                                                (const char __user *) arg4);
1818
1819         default:
1820                 return -EOPNOTSUPP;
1821         }
1822 }