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