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