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