12874c5fdSThomas Gleixner // SPDX-License-Identifier: GPL-2.0-or-later 2973c9f4fSDavid Howells /* Userspace key control operations 31da177e4SLinus Torvalds * 43e30148cSDavid Howells * Copyright (C) 2004-5 Red Hat, Inc. All Rights Reserved. 51da177e4SLinus Torvalds * Written by David Howells (dhowells@redhat.com) 61da177e4SLinus Torvalds */ 71da177e4SLinus Torvalds 81da177e4SLinus Torvalds #include <linux/init.h> 91da177e4SLinus Torvalds #include <linux/sched.h> 1029930025SIngo Molnar #include <linux/sched/task.h> 111da177e4SLinus Torvalds #include <linux/slab.h> 121da177e4SLinus Torvalds #include <linux/syscalls.h> 1359e6b9c1SBryan Schumaker #include <linux/key.h> 141da177e4SLinus Torvalds #include <linux/keyctl.h> 151da177e4SLinus Torvalds #include <linux/fs.h> 16c59ede7bSRandy.Dunlap #include <linux/capability.h> 175b825c3aSIngo Molnar #include <linux/cred.h> 180cb409d9SDavi Arnaut #include <linux/string.h> 191da177e4SLinus Torvalds #include <linux/err.h> 2038bbca6bSDavid Howells #include <linux/vmalloc.h> 2170a5bb72SDavid Howells #include <linux/security.h> 22a27bb332SKent Overstreet #include <linux/uio.h> 237c0f6ba6SLinus Torvalds #include <linux/uaccess.h> 24822ad64dSDavid Howells #include <keys/request_key_auth-type.h> 251da177e4SLinus Torvalds #include "internal.h" 261da177e4SLinus Torvalds 27aa9d4437SDavid Howells #define KEY_MAX_DESC_SIZE 4096 28aa9d4437SDavid Howells 29b206f281SDavid Howells static const unsigned char keyrings_capabilities[2] = { 3045e0f30cSDavid Howells [0] = (KEYCTL_CAPS0_CAPABILITIES | 3145e0f30cSDavid Howells (IS_ENABLED(CONFIG_PERSISTENT_KEYRINGS) ? KEYCTL_CAPS0_PERSISTENT_KEYRINGS : 0) | 3245e0f30cSDavid Howells (IS_ENABLED(CONFIG_KEY_DH_OPERATIONS) ? KEYCTL_CAPS0_DIFFIE_HELLMAN : 0) | 3345e0f30cSDavid Howells (IS_ENABLED(CONFIG_ASYMMETRIC_KEY_TYPE) ? KEYCTL_CAPS0_PUBLIC_KEY : 0) | 3445e0f30cSDavid Howells (IS_ENABLED(CONFIG_BIG_KEYS) ? KEYCTL_CAPS0_BIG_KEY : 0) | 3545e0f30cSDavid Howells KEYCTL_CAPS0_INVALIDATE | 3645e0f30cSDavid Howells KEYCTL_CAPS0_RESTRICT_KEYRING | 3745e0f30cSDavid Howells KEYCTL_CAPS0_MOVE 3845e0f30cSDavid Howells ), 393b6e4de0SDavid Howells [1] = (KEYCTL_CAPS1_NS_KEYRING_NAME | 40028db3e2SLinus Torvalds KEYCTL_CAPS1_NS_KEY_TAG), 4145e0f30cSDavid Howells }; 4245e0f30cSDavid Howells 430cb409d9SDavi Arnaut static int key_get_type_from_user(char *type, 440cb409d9SDavi Arnaut const char __user *_type, 450cb409d9SDavi Arnaut unsigned len) 460cb409d9SDavi Arnaut { 470cb409d9SDavi Arnaut int ret; 480cb409d9SDavi Arnaut 490cb409d9SDavi Arnaut ret = strncpy_from_user(type, _type, len); 500cb409d9SDavi Arnaut if (ret < 0) 514303ef19SDan Carpenter return ret; 520cb409d9SDavi Arnaut if (ret == 0 || ret >= len) 530cb409d9SDavi Arnaut return -EINVAL; 5454e2c2c1SDavid Howells if (type[0] == '.') 5554e2c2c1SDavid Howells return -EPERM; 560cb409d9SDavi Arnaut type[len - 1] = '\0'; 570cb409d9SDavi Arnaut return 0; 580cb409d9SDavi Arnaut } 590cb409d9SDavi Arnaut 601da177e4SLinus Torvalds /* 61973c9f4fSDavid Howells * Extract the description of a new key from userspace and either add it as a 62973c9f4fSDavid Howells * new key to the specified keyring or update a matching key in that keyring. 63973c9f4fSDavid Howells * 64cf7f601cSDavid Howells * If the description is NULL or an empty string, the key type is asked to 65cf7f601cSDavid Howells * generate one from the payload. 66cf7f601cSDavid Howells * 67973c9f4fSDavid Howells * The keyring must be writable so that we can attach the key to it. 68973c9f4fSDavid Howells * 69973c9f4fSDavid Howells * If successful, the new key's serial number is returned, otherwise an error 70973c9f4fSDavid Howells * code is returned. 711da177e4SLinus Torvalds */ 721e7bfb21SHeiko Carstens SYSCALL_DEFINE5(add_key, const char __user *, _type, 731e7bfb21SHeiko Carstens const char __user *, _description, 741e7bfb21SHeiko Carstens const void __user *, _payload, 751e7bfb21SHeiko Carstens size_t, plen, 761e7bfb21SHeiko Carstens key_serial_t, ringid) 771da177e4SLinus Torvalds { 78664cceb0SDavid Howells key_ref_t keyring_ref, key_ref; 791da177e4SLinus Torvalds char type[32], *description; 801da177e4SLinus Torvalds void *payload; 810cb409d9SDavi Arnaut long ret; 821da177e4SLinus Torvalds 831da177e4SLinus Torvalds ret = -EINVAL; 8438bbca6bSDavid Howells if (plen > 1024 * 1024 - 1) 851da177e4SLinus Torvalds goto error; 861da177e4SLinus Torvalds 871da177e4SLinus Torvalds /* draw all the data into kernel space */ 880cb409d9SDavi Arnaut ret = key_get_type_from_user(type, _type, sizeof(type)); 891da177e4SLinus Torvalds if (ret < 0) 901da177e4SLinus Torvalds goto error; 911da177e4SLinus Torvalds 92cf7f601cSDavid Howells description = NULL; 93cf7f601cSDavid Howells if (_description) { 94aa9d4437SDavid Howells description = strndup_user(_description, KEY_MAX_DESC_SIZE); 950cb409d9SDavi Arnaut if (IS_ERR(description)) { 960cb409d9SDavi Arnaut ret = PTR_ERR(description); 973e30148cSDavid Howells goto error; 980cb409d9SDavi Arnaut } 99cf7f601cSDavid Howells if (!*description) { 100cf7f601cSDavid Howells kfree(description); 101cf7f601cSDavid Howells description = NULL; 102a4e3b8d7SMimi Zohar } else if ((description[0] == '.') && 103a4e3b8d7SMimi Zohar (strncmp(type, "keyring", 7) == 0)) { 104a4e3b8d7SMimi Zohar ret = -EPERM; 105a4e3b8d7SMimi Zohar goto error2; 106cf7f601cSDavid Howells } 107cf7f601cSDavid Howells } 1081da177e4SLinus Torvalds 1091da177e4SLinus Torvalds /* pull the payload in if one was supplied */ 1101da177e4SLinus Torvalds payload = NULL; 1111da177e4SLinus Torvalds 1125649645dSEric Biggers if (plen) { 1131da177e4SLinus Torvalds ret = -ENOMEM; 114752ade68SMichal Hocko payload = kvmalloc(plen, GFP_KERNEL); 1151da177e4SLinus Torvalds if (!payload) 1161da177e4SLinus Torvalds goto error2; 1171da177e4SLinus Torvalds 1181da177e4SLinus Torvalds ret = -EFAULT; 1191da177e4SLinus Torvalds if (copy_from_user(payload, _payload, plen) != 0) 1201da177e4SLinus Torvalds goto error3; 1211da177e4SLinus Torvalds } 1221da177e4SLinus Torvalds 1231da177e4SLinus Torvalds /* find the target keyring (which must be writable) */ 124f5895943SDavid Howells keyring_ref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE); 125664cceb0SDavid Howells if (IS_ERR(keyring_ref)) { 126664cceb0SDavid Howells ret = PTR_ERR(keyring_ref); 1271da177e4SLinus Torvalds goto error3; 1281da177e4SLinus Torvalds } 1291da177e4SLinus Torvalds 1301da177e4SLinus Torvalds /* create or update the requested key and add it to the target 1311da177e4SLinus Torvalds * keyring */ 132664cceb0SDavid Howells key_ref = key_create_or_update(keyring_ref, type, description, 133028db3e2SLinus Torvalds payload, plen, KEY_PERM_UNDEF, 134028db3e2SLinus Torvalds KEY_ALLOC_IN_QUOTA); 135664cceb0SDavid Howells if (!IS_ERR(key_ref)) { 136664cceb0SDavid Howells ret = key_ref_to_ptr(key_ref)->serial; 137664cceb0SDavid Howells key_ref_put(key_ref); 1381da177e4SLinus Torvalds } 1391da177e4SLinus Torvalds else { 140664cceb0SDavid Howells ret = PTR_ERR(key_ref); 1411da177e4SLinus Torvalds } 1421da177e4SLinus Torvalds 143664cceb0SDavid Howells key_ref_put(keyring_ref); 1441da177e4SLinus Torvalds error3: 14557070c85SEric Biggers if (payload) { 14657070c85SEric Biggers memzero_explicit(payload, plen); 147d0e0eba0SGeliang Tang kvfree(payload); 14857070c85SEric Biggers } 1491da177e4SLinus Torvalds error2: 1501da177e4SLinus Torvalds kfree(description); 1511da177e4SLinus Torvalds error: 1521da177e4SLinus Torvalds return ret; 153a8b17ed0SDavid Howells } 1541da177e4SLinus Torvalds 1551da177e4SLinus Torvalds /* 156973c9f4fSDavid Howells * Search the process keyrings and keyring trees linked from those for a 157973c9f4fSDavid Howells * matching key. Keyrings must have appropriate Search permission to be 158973c9f4fSDavid Howells * searched. 159973c9f4fSDavid Howells * 160973c9f4fSDavid Howells * If a key is found, it will be attached to the destination keyring if there's 161973c9f4fSDavid Howells * one specified and the serial number of the key will be returned. 162973c9f4fSDavid Howells * 163973c9f4fSDavid Howells * If no key is found, /sbin/request-key will be invoked if _callout_info is 164973c9f4fSDavid Howells * non-NULL in an attempt to create a key. The _callout_info string will be 165973c9f4fSDavid Howells * passed to /sbin/request-key to aid with completing the request. If the 166973c9f4fSDavid Howells * _callout_info string is "" then it will be changed to "-". 1671da177e4SLinus Torvalds */ 1681e7bfb21SHeiko Carstens SYSCALL_DEFINE4(request_key, const char __user *, _type, 1691e7bfb21SHeiko Carstens const char __user *, _description, 1701e7bfb21SHeiko Carstens const char __user *, _callout_info, 1711e7bfb21SHeiko Carstens key_serial_t, destringid) 1721da177e4SLinus Torvalds { 1731da177e4SLinus Torvalds struct key_type *ktype; 174664cceb0SDavid Howells struct key *key; 175664cceb0SDavid Howells key_ref_t dest_ref; 1764a38e122SDavid Howells size_t callout_len; 1771da177e4SLinus Torvalds char type[32], *description, *callout_info; 1780cb409d9SDavi Arnaut long ret; 1791da177e4SLinus Torvalds 1801da177e4SLinus Torvalds /* pull the type into kernel space */ 1810cb409d9SDavi Arnaut ret = key_get_type_from_user(type, _type, sizeof(type)); 1821da177e4SLinus Torvalds if (ret < 0) 1831da177e4SLinus Torvalds goto error; 1841260f801SDavid Howells 1851da177e4SLinus Torvalds /* pull the description into kernel space */ 186aa9d4437SDavid Howells description = strndup_user(_description, KEY_MAX_DESC_SIZE); 1870cb409d9SDavi Arnaut if (IS_ERR(description)) { 1880cb409d9SDavi Arnaut ret = PTR_ERR(description); 1891da177e4SLinus Torvalds goto error; 1900cb409d9SDavi Arnaut } 1911da177e4SLinus Torvalds 1921da177e4SLinus Torvalds /* pull the callout info into kernel space */ 1931da177e4SLinus Torvalds callout_info = NULL; 1944a38e122SDavid Howells callout_len = 0; 1951da177e4SLinus Torvalds if (_callout_info) { 1960cb409d9SDavi Arnaut callout_info = strndup_user(_callout_info, PAGE_SIZE); 1970cb409d9SDavi Arnaut if (IS_ERR(callout_info)) { 1980cb409d9SDavi Arnaut ret = PTR_ERR(callout_info); 1991da177e4SLinus Torvalds goto error2; 2000cb409d9SDavi Arnaut } 2014a38e122SDavid Howells callout_len = strlen(callout_info); 2021da177e4SLinus Torvalds } 2031da177e4SLinus Torvalds 2041da177e4SLinus Torvalds /* get the destination keyring if specified */ 205664cceb0SDavid Howells dest_ref = NULL; 2061da177e4SLinus Torvalds if (destringid) { 2075593122eSDavid Howells dest_ref = lookup_user_key(destringid, KEY_LOOKUP_CREATE, 208f5895943SDavid Howells KEY_NEED_WRITE); 209664cceb0SDavid Howells if (IS_ERR(dest_ref)) { 210664cceb0SDavid Howells ret = PTR_ERR(dest_ref); 2111da177e4SLinus Torvalds goto error3; 2121da177e4SLinus Torvalds } 2131da177e4SLinus Torvalds } 2141da177e4SLinus Torvalds 2151da177e4SLinus Torvalds /* find the key type */ 2161da177e4SLinus Torvalds ktype = key_type_lookup(type); 2171da177e4SLinus Torvalds if (IS_ERR(ktype)) { 2181da177e4SLinus Torvalds ret = PTR_ERR(ktype); 2191da177e4SLinus Torvalds goto error4; 2201da177e4SLinus Torvalds } 2211da177e4SLinus Torvalds 2221da177e4SLinus Torvalds /* do the search */ 223a58946c1SDavid Howells key = request_key_and_link(ktype, description, NULL, callout_info, 224028db3e2SLinus Torvalds callout_len, NULL, key_ref_to_ptr(dest_ref), 2257e047ef5SDavid Howells KEY_ALLOC_IN_QUOTA); 2261da177e4SLinus Torvalds if (IS_ERR(key)) { 2271da177e4SLinus Torvalds ret = PTR_ERR(key); 2281da177e4SLinus Torvalds goto error5; 2291da177e4SLinus Torvalds } 2301da177e4SLinus Torvalds 2314aab1e89SDavid Howells /* wait for the key to finish being constructed */ 2324aab1e89SDavid Howells ret = wait_for_key_construction(key, 1); 2334aab1e89SDavid Howells if (ret < 0) 2344aab1e89SDavid Howells goto error6; 2354aab1e89SDavid Howells 2361da177e4SLinus Torvalds ret = key->serial; 2371da177e4SLinus Torvalds 2384aab1e89SDavid Howells error6: 2391da177e4SLinus Torvalds key_put(key); 2401da177e4SLinus Torvalds error5: 2411da177e4SLinus Torvalds key_type_put(ktype); 2421da177e4SLinus Torvalds error4: 243664cceb0SDavid Howells key_ref_put(dest_ref); 2441da177e4SLinus Torvalds error3: 2451da177e4SLinus Torvalds kfree(callout_info); 2461da177e4SLinus Torvalds error2: 2471da177e4SLinus Torvalds kfree(description); 2481da177e4SLinus Torvalds error: 2491da177e4SLinus Torvalds return ret; 250a8b17ed0SDavid Howells } 2511da177e4SLinus Torvalds 2521da177e4SLinus Torvalds /* 253973c9f4fSDavid Howells * Get the ID of the specified process keyring. 254973c9f4fSDavid Howells * 255973c9f4fSDavid Howells * The requested keyring must have search permission to be found. 256973c9f4fSDavid Howells * 257973c9f4fSDavid Howells * If successful, the ID of the requested keyring will be returned. 2581da177e4SLinus Torvalds */ 2591da177e4SLinus Torvalds long keyctl_get_keyring_ID(key_serial_t id, int create) 2601da177e4SLinus Torvalds { 261664cceb0SDavid Howells key_ref_t key_ref; 2625593122eSDavid Howells unsigned long lflags; 2631da177e4SLinus Torvalds long ret; 2641da177e4SLinus Torvalds 2655593122eSDavid Howells lflags = create ? KEY_LOOKUP_CREATE : 0; 266f5895943SDavid Howells key_ref = lookup_user_key(id, lflags, KEY_NEED_SEARCH); 267664cceb0SDavid Howells if (IS_ERR(key_ref)) { 268664cceb0SDavid Howells ret = PTR_ERR(key_ref); 2691da177e4SLinus Torvalds goto error; 2701da177e4SLinus Torvalds } 2711da177e4SLinus Torvalds 272664cceb0SDavid Howells ret = key_ref_to_ptr(key_ref)->serial; 273664cceb0SDavid Howells key_ref_put(key_ref); 2741da177e4SLinus Torvalds error: 2751da177e4SLinus Torvalds return ret; 276973c9f4fSDavid Howells } 2771da177e4SLinus Torvalds 2781da177e4SLinus Torvalds /* 279973c9f4fSDavid Howells * Join a (named) session keyring. 280973c9f4fSDavid Howells * 281973c9f4fSDavid Howells * Create and join an anonymous session keyring or join a named session 282973c9f4fSDavid Howells * keyring, creating it if necessary. A named session keyring must have Search 283973c9f4fSDavid Howells * permission for it to be joined. Session keyrings without this permit will 284ee8f844eSDavid Howells * be skipped over. It is not permitted for userspace to create or join 285ee8f844eSDavid Howells * keyrings whose name begin with a dot. 286973c9f4fSDavid Howells * 287973c9f4fSDavid Howells * If successful, the ID of the joined session keyring will be returned. 2881da177e4SLinus Torvalds */ 2891da177e4SLinus Torvalds long keyctl_join_session_keyring(const char __user *_name) 2901da177e4SLinus Torvalds { 2911da177e4SLinus Torvalds char *name; 2920cb409d9SDavi Arnaut long ret; 2931da177e4SLinus Torvalds 2941da177e4SLinus Torvalds /* fetch the name from userspace */ 2951da177e4SLinus Torvalds name = NULL; 2961da177e4SLinus Torvalds if (_name) { 297aa9d4437SDavid Howells name = strndup_user(_name, KEY_MAX_DESC_SIZE); 2980cb409d9SDavi Arnaut if (IS_ERR(name)) { 2990cb409d9SDavi Arnaut ret = PTR_ERR(name); 3001da177e4SLinus Torvalds goto error; 3010cb409d9SDavi Arnaut } 302ee8f844eSDavid Howells 303ee8f844eSDavid Howells ret = -EPERM; 304ee8f844eSDavid Howells if (name[0] == '.') 305ee8f844eSDavid Howells goto error_name; 3061da177e4SLinus Torvalds } 3071da177e4SLinus Torvalds 3081da177e4SLinus Torvalds /* join the session */ 3091da177e4SLinus Torvalds ret = join_session_keyring(name); 310ee8f844eSDavid Howells error_name: 3110d54ee1cSVegard Nossum kfree(name); 3121da177e4SLinus Torvalds error: 3131da177e4SLinus Torvalds return ret; 314a8b17ed0SDavid Howells } 3151da177e4SLinus Torvalds 3161da177e4SLinus Torvalds /* 317973c9f4fSDavid Howells * Update a key's data payload from the given data. 318973c9f4fSDavid Howells * 319973c9f4fSDavid Howells * The key must grant the caller Write permission and the key type must support 320973c9f4fSDavid Howells * updating for this to work. A negative key can be positively instantiated 321973c9f4fSDavid Howells * with this call. 322973c9f4fSDavid Howells * 323973c9f4fSDavid Howells * If successful, 0 will be returned. If the key type does not support 324973c9f4fSDavid Howells * updating, then -EOPNOTSUPP will be returned. 3251da177e4SLinus Torvalds */ 3261da177e4SLinus Torvalds long keyctl_update_key(key_serial_t id, 3271da177e4SLinus Torvalds const void __user *_payload, 3281da177e4SLinus Torvalds size_t plen) 3291da177e4SLinus Torvalds { 330664cceb0SDavid Howells key_ref_t key_ref; 3311da177e4SLinus Torvalds void *payload; 3321da177e4SLinus Torvalds long ret; 3331da177e4SLinus Torvalds 3341da177e4SLinus Torvalds ret = -EINVAL; 3351da177e4SLinus Torvalds if (plen > PAGE_SIZE) 3361da177e4SLinus Torvalds goto error; 3371da177e4SLinus Torvalds 3381da177e4SLinus Torvalds /* pull the payload in if one was supplied */ 3391da177e4SLinus Torvalds payload = NULL; 3405649645dSEric Biggers if (plen) { 3411da177e4SLinus Torvalds ret = -ENOMEM; 3421da177e4SLinus Torvalds payload = kmalloc(plen, GFP_KERNEL); 3431da177e4SLinus Torvalds if (!payload) 3441da177e4SLinus Torvalds goto error; 3451da177e4SLinus Torvalds 3461da177e4SLinus Torvalds ret = -EFAULT; 3471da177e4SLinus Torvalds if (copy_from_user(payload, _payload, plen) != 0) 3481da177e4SLinus Torvalds goto error2; 3491da177e4SLinus Torvalds } 3501da177e4SLinus Torvalds 3511da177e4SLinus Torvalds /* find the target key (which must be writable) */ 352f5895943SDavid Howells key_ref = lookup_user_key(id, 0, KEY_NEED_WRITE); 353664cceb0SDavid Howells if (IS_ERR(key_ref)) { 354664cceb0SDavid Howells ret = PTR_ERR(key_ref); 3551da177e4SLinus Torvalds goto error2; 3561da177e4SLinus Torvalds } 3571da177e4SLinus Torvalds 3581da177e4SLinus Torvalds /* update the key */ 359664cceb0SDavid Howells ret = key_update(key_ref, payload, plen); 3601da177e4SLinus Torvalds 361664cceb0SDavid Howells key_ref_put(key_ref); 3621da177e4SLinus Torvalds error2: 36357070c85SEric Biggers kzfree(payload); 3641da177e4SLinus Torvalds error: 3651da177e4SLinus Torvalds return ret; 366a8b17ed0SDavid Howells } 3671da177e4SLinus Torvalds 3681da177e4SLinus Torvalds /* 369973c9f4fSDavid Howells * Revoke a key. 370973c9f4fSDavid Howells * 371973c9f4fSDavid Howells * The key must be grant the caller Write or Setattr permission for this to 372973c9f4fSDavid Howells * work. The key type should give up its quota claim when revoked. The key 373973c9f4fSDavid Howells * and any links to the key will be automatically garbage collected after a 374973c9f4fSDavid Howells * certain amount of time (/proc/sys/kernel/keys/gc_delay). 375973c9f4fSDavid Howells * 376d3600bcfSMimi Zohar * Keys with KEY_FLAG_KEEP set should not be revoked. 377d3600bcfSMimi Zohar * 378973c9f4fSDavid Howells * If successful, 0 is returned. 3791da177e4SLinus Torvalds */ 3801da177e4SLinus Torvalds long keyctl_revoke_key(key_serial_t id) 3811da177e4SLinus Torvalds { 382664cceb0SDavid Howells key_ref_t key_ref; 383d3600bcfSMimi Zohar struct key *key; 3841da177e4SLinus Torvalds long ret; 3851da177e4SLinus Torvalds 386028db3e2SLinus Torvalds key_ref = lookup_user_key(id, 0, KEY_NEED_WRITE); 387028db3e2SLinus Torvalds if (IS_ERR(key_ref)) { 388028db3e2SLinus Torvalds ret = PTR_ERR(key_ref); 389028db3e2SLinus Torvalds if (ret != -EACCES) 390028db3e2SLinus Torvalds goto error; 391028db3e2SLinus Torvalds key_ref = lookup_user_key(id, 0, KEY_NEED_SETATTR); 3920c2c9a3fSDavid Howells if (IS_ERR(key_ref)) { 3930c2c9a3fSDavid Howells ret = PTR_ERR(key_ref); 3940c2c9a3fSDavid Howells goto error; 3950c2c9a3fSDavid Howells } 396028db3e2SLinus Torvalds } 3971da177e4SLinus Torvalds 398d3600bcfSMimi Zohar key = key_ref_to_ptr(key_ref); 3991da177e4SLinus Torvalds ret = 0; 4001d6d167cSMimi Zohar if (test_bit(KEY_FLAG_KEEP, &key->flags)) 4011d6d167cSMimi Zohar ret = -EPERM; 4021d6d167cSMimi Zohar else 4031d6d167cSMimi Zohar key_revoke(key); 4041da177e4SLinus Torvalds 405664cceb0SDavid Howells key_ref_put(key_ref); 4061da177e4SLinus Torvalds error: 4071260f801SDavid Howells return ret; 408a8b17ed0SDavid Howells } 4091da177e4SLinus Torvalds 4101da177e4SLinus Torvalds /* 411fd75815fSDavid Howells * Invalidate a key. 412fd75815fSDavid Howells * 413fd75815fSDavid Howells * The key must be grant the caller Invalidate permission for this to work. 414fd75815fSDavid Howells * The key and any links to the key will be automatically garbage collected 415fd75815fSDavid Howells * immediately. 416fd75815fSDavid Howells * 417d3600bcfSMimi Zohar * Keys with KEY_FLAG_KEEP set should not be invalidated. 418d3600bcfSMimi Zohar * 419fd75815fSDavid Howells * If successful, 0 is returned. 420fd75815fSDavid Howells */ 421fd75815fSDavid Howells long keyctl_invalidate_key(key_serial_t id) 422fd75815fSDavid Howells { 423fd75815fSDavid Howells key_ref_t key_ref; 424d3600bcfSMimi Zohar struct key *key; 425fd75815fSDavid Howells long ret; 426fd75815fSDavid Howells 427fd75815fSDavid Howells kenter("%d", id); 428fd75815fSDavid Howells 429028db3e2SLinus Torvalds key_ref = lookup_user_key(id, 0, KEY_NEED_SEARCH); 430fd75815fSDavid Howells if (IS_ERR(key_ref)) { 431fd75815fSDavid Howells ret = PTR_ERR(key_ref); 4320c7774abSDavid Howells 4330c7774abSDavid Howells /* Root is permitted to invalidate certain special keys */ 4340c7774abSDavid Howells if (capable(CAP_SYS_ADMIN)) { 4350c7774abSDavid Howells key_ref = lookup_user_key(id, 0, 0); 4360c7774abSDavid Howells if (IS_ERR(key_ref)) 4370c7774abSDavid Howells goto error; 4380c7774abSDavid Howells if (test_bit(KEY_FLAG_ROOT_CAN_INVAL, 4390c7774abSDavid Howells &key_ref_to_ptr(key_ref)->flags)) 4400c7774abSDavid Howells goto invalidate; 4410c7774abSDavid Howells goto error_put; 4420c7774abSDavid Howells } 4430c7774abSDavid Howells 444fd75815fSDavid Howells goto error; 445fd75815fSDavid Howells } 446fd75815fSDavid Howells 4470c7774abSDavid Howells invalidate: 448d3600bcfSMimi Zohar key = key_ref_to_ptr(key_ref); 449fd75815fSDavid Howells ret = 0; 450d3600bcfSMimi Zohar if (test_bit(KEY_FLAG_KEEP, &key->flags)) 451d3600bcfSMimi Zohar ret = -EPERM; 4521d6d167cSMimi Zohar else 453d3600bcfSMimi Zohar key_invalidate(key); 4540c7774abSDavid Howells error_put: 455fd75815fSDavid Howells key_ref_put(key_ref); 456fd75815fSDavid Howells error: 457fd75815fSDavid Howells kleave(" = %ld", ret); 458fd75815fSDavid Howells return ret; 459fd75815fSDavid Howells } 460fd75815fSDavid Howells 461fd75815fSDavid Howells /* 462973c9f4fSDavid Howells * Clear the specified keyring, creating an empty process keyring if one of the 463973c9f4fSDavid Howells * special keyring IDs is used. 464973c9f4fSDavid Howells * 465d3600bcfSMimi Zohar * The keyring must grant the caller Write permission and not have 466d3600bcfSMimi Zohar * KEY_FLAG_KEEP set for this to work. If successful, 0 will be returned. 4671da177e4SLinus Torvalds */ 4681da177e4SLinus Torvalds long keyctl_keyring_clear(key_serial_t ringid) 4691da177e4SLinus Torvalds { 470664cceb0SDavid Howells key_ref_t keyring_ref; 471d3600bcfSMimi Zohar struct key *keyring; 4721da177e4SLinus Torvalds long ret; 4731da177e4SLinus Torvalds 474028db3e2SLinus Torvalds keyring_ref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE); 475664cceb0SDavid Howells if (IS_ERR(keyring_ref)) { 476664cceb0SDavid Howells ret = PTR_ERR(keyring_ref); 477700920ebSDavid Howells 478700920ebSDavid Howells /* Root is permitted to invalidate certain special keyrings */ 479700920ebSDavid Howells if (capable(CAP_SYS_ADMIN)) { 480700920ebSDavid Howells keyring_ref = lookup_user_key(ringid, 0, 0); 481700920ebSDavid Howells if (IS_ERR(keyring_ref)) 482700920ebSDavid Howells goto error; 483700920ebSDavid Howells if (test_bit(KEY_FLAG_ROOT_CAN_CLEAR, 484700920ebSDavid Howells &key_ref_to_ptr(keyring_ref)->flags)) 485700920ebSDavid Howells goto clear; 486700920ebSDavid Howells goto error_put; 487700920ebSDavid Howells } 488700920ebSDavid Howells 4891da177e4SLinus Torvalds goto error; 4901da177e4SLinus Torvalds } 4911da177e4SLinus Torvalds 492700920ebSDavid Howells clear: 493d3600bcfSMimi Zohar keyring = key_ref_to_ptr(keyring_ref); 494d3600bcfSMimi Zohar if (test_bit(KEY_FLAG_KEEP, &keyring->flags)) 495d3600bcfSMimi Zohar ret = -EPERM; 496d3600bcfSMimi Zohar else 497d3600bcfSMimi Zohar ret = keyring_clear(keyring); 498700920ebSDavid Howells error_put: 499664cceb0SDavid Howells key_ref_put(keyring_ref); 5001da177e4SLinus Torvalds error: 5011da177e4SLinus Torvalds return ret; 502a8b17ed0SDavid Howells } 5031da177e4SLinus Torvalds 5041da177e4SLinus Torvalds /* 505973c9f4fSDavid Howells * Create a link from a keyring to a key if there's no matching key in the 506973c9f4fSDavid Howells * keyring, otherwise replace the link to the matching key with a link to the 507973c9f4fSDavid Howells * new key. 508973c9f4fSDavid Howells * 509973c9f4fSDavid Howells * The key must grant the caller Link permission and the the keyring must grant 510973c9f4fSDavid Howells * the caller Write permission. Furthermore, if an additional link is created, 511973c9f4fSDavid Howells * the keyring's quota will be extended. 512973c9f4fSDavid Howells * 513973c9f4fSDavid Howells * If successful, 0 will be returned. 5141da177e4SLinus Torvalds */ 5151da177e4SLinus Torvalds long keyctl_keyring_link(key_serial_t id, key_serial_t ringid) 5161da177e4SLinus Torvalds { 517664cceb0SDavid Howells key_ref_t keyring_ref, key_ref; 5181da177e4SLinus Torvalds long ret; 5191da177e4SLinus Torvalds 520f5895943SDavid Howells keyring_ref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE); 521664cceb0SDavid Howells if (IS_ERR(keyring_ref)) { 522664cceb0SDavid Howells ret = PTR_ERR(keyring_ref); 5231da177e4SLinus Torvalds goto error; 5241da177e4SLinus Torvalds } 5251da177e4SLinus Torvalds 526f5895943SDavid Howells key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE, KEY_NEED_LINK); 527664cceb0SDavid Howells if (IS_ERR(key_ref)) { 528664cceb0SDavid Howells ret = PTR_ERR(key_ref); 5291da177e4SLinus Torvalds goto error2; 5301da177e4SLinus Torvalds } 5311da177e4SLinus Torvalds 532664cceb0SDavid Howells ret = key_link(key_ref_to_ptr(keyring_ref), key_ref_to_ptr(key_ref)); 5331da177e4SLinus Torvalds 534664cceb0SDavid Howells key_ref_put(key_ref); 5351da177e4SLinus Torvalds error2: 536664cceb0SDavid Howells key_ref_put(keyring_ref); 5371da177e4SLinus Torvalds error: 5381da177e4SLinus Torvalds return ret; 539a8b17ed0SDavid Howells } 5401da177e4SLinus Torvalds 5411da177e4SLinus Torvalds /* 542973c9f4fSDavid Howells * Unlink a key from a keyring. 543973c9f4fSDavid Howells * 544973c9f4fSDavid Howells * The keyring must grant the caller Write permission for this to work; the key 545973c9f4fSDavid Howells * itself need not grant the caller anything. If the last link to a key is 546973c9f4fSDavid Howells * removed then that key will be scheduled for destruction. 547973c9f4fSDavid Howells * 548d3600bcfSMimi Zohar * Keys or keyrings with KEY_FLAG_KEEP set should not be unlinked. 549d3600bcfSMimi Zohar * 550973c9f4fSDavid Howells * If successful, 0 will be returned. 5511da177e4SLinus Torvalds */ 5521da177e4SLinus Torvalds long keyctl_keyring_unlink(key_serial_t id, key_serial_t ringid) 5531da177e4SLinus Torvalds { 554664cceb0SDavid Howells key_ref_t keyring_ref, key_ref; 555d3600bcfSMimi Zohar struct key *keyring, *key; 5561da177e4SLinus Torvalds long ret; 5571da177e4SLinus Torvalds 558f5895943SDavid Howells keyring_ref = lookup_user_key(ringid, 0, KEY_NEED_WRITE); 559664cceb0SDavid Howells if (IS_ERR(keyring_ref)) { 560664cceb0SDavid Howells ret = PTR_ERR(keyring_ref); 5611da177e4SLinus Torvalds goto error; 5621da177e4SLinus Torvalds } 5631da177e4SLinus Torvalds 5645593122eSDavid Howells key_ref = lookup_user_key(id, KEY_LOOKUP_FOR_UNLINK, 0); 565664cceb0SDavid Howells if (IS_ERR(key_ref)) { 566664cceb0SDavid Howells ret = PTR_ERR(key_ref); 5671da177e4SLinus Torvalds goto error2; 5681da177e4SLinus Torvalds } 5691da177e4SLinus Torvalds 570d3600bcfSMimi Zohar keyring = key_ref_to_ptr(keyring_ref); 571d3600bcfSMimi Zohar key = key_ref_to_ptr(key_ref); 572d3600bcfSMimi Zohar if (test_bit(KEY_FLAG_KEEP, &keyring->flags) && 573d3600bcfSMimi Zohar test_bit(KEY_FLAG_KEEP, &key->flags)) 574d3600bcfSMimi Zohar ret = -EPERM; 575d3600bcfSMimi Zohar else 576d3600bcfSMimi Zohar ret = key_unlink(keyring, key); 5771da177e4SLinus Torvalds 578664cceb0SDavid Howells key_ref_put(key_ref); 5791da177e4SLinus Torvalds error2: 580664cceb0SDavid Howells key_ref_put(keyring_ref); 5811da177e4SLinus Torvalds error: 5821da177e4SLinus Torvalds return ret; 583a8b17ed0SDavid Howells } 5841da177e4SLinus Torvalds 5851da177e4SLinus Torvalds /* 586ed0ac5c7SDavid Howells * Move a link to a key from one keyring to another, displacing any matching 587ed0ac5c7SDavid Howells * key from the destination keyring. 588ed0ac5c7SDavid Howells * 589ed0ac5c7SDavid Howells * The key must grant the caller Link permission and both keyrings must grant 590ed0ac5c7SDavid Howells * the caller Write permission. There must also be a link in the from keyring 591ed0ac5c7SDavid Howells * to the key. If both keyrings are the same, nothing is done. 592ed0ac5c7SDavid Howells * 593ed0ac5c7SDavid Howells * If successful, 0 will be returned. 594ed0ac5c7SDavid Howells */ 595ed0ac5c7SDavid Howells long keyctl_keyring_move(key_serial_t id, key_serial_t from_ringid, 596ed0ac5c7SDavid Howells key_serial_t to_ringid, unsigned int flags) 597ed0ac5c7SDavid Howells { 598ed0ac5c7SDavid Howells key_ref_t key_ref, from_ref, to_ref; 599ed0ac5c7SDavid Howells long ret; 600ed0ac5c7SDavid Howells 601ed0ac5c7SDavid Howells if (flags & ~KEYCTL_MOVE_EXCL) 602ed0ac5c7SDavid Howells return -EINVAL; 603ed0ac5c7SDavid Howells 604ed0ac5c7SDavid Howells key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE, KEY_NEED_LINK); 605ed0ac5c7SDavid Howells if (IS_ERR(key_ref)) 606ed0ac5c7SDavid Howells return PTR_ERR(key_ref); 607ed0ac5c7SDavid Howells 608ed0ac5c7SDavid Howells from_ref = lookup_user_key(from_ringid, 0, KEY_NEED_WRITE); 609ed0ac5c7SDavid Howells if (IS_ERR(from_ref)) { 610ed0ac5c7SDavid Howells ret = PTR_ERR(from_ref); 611ed0ac5c7SDavid Howells goto error2; 612ed0ac5c7SDavid Howells } 613ed0ac5c7SDavid Howells 614ed0ac5c7SDavid Howells to_ref = lookup_user_key(to_ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE); 615ed0ac5c7SDavid Howells if (IS_ERR(to_ref)) { 616ed0ac5c7SDavid Howells ret = PTR_ERR(to_ref); 617ed0ac5c7SDavid Howells goto error3; 618ed0ac5c7SDavid Howells } 619ed0ac5c7SDavid Howells 620ed0ac5c7SDavid Howells ret = key_move(key_ref_to_ptr(key_ref), key_ref_to_ptr(from_ref), 621ed0ac5c7SDavid Howells key_ref_to_ptr(to_ref), flags); 622ed0ac5c7SDavid Howells 623ed0ac5c7SDavid Howells key_ref_put(to_ref); 624ed0ac5c7SDavid Howells error3: 625ed0ac5c7SDavid Howells key_ref_put(from_ref); 626ed0ac5c7SDavid Howells error2: 627ed0ac5c7SDavid Howells key_ref_put(key_ref); 628ed0ac5c7SDavid Howells return ret; 629ed0ac5c7SDavid Howells } 630ed0ac5c7SDavid Howells 631ed0ac5c7SDavid Howells /* 632973c9f4fSDavid Howells * Return a description of a key to userspace. 633973c9f4fSDavid Howells * 634973c9f4fSDavid Howells * The key must grant the caller View permission for this to work. 635973c9f4fSDavid Howells * 636973c9f4fSDavid Howells * If there's a buffer, we place up to buflen bytes of data into it formatted 637973c9f4fSDavid Howells * in the following way: 638973c9f4fSDavid Howells * 6391da177e4SLinus Torvalds * type;uid;gid;perm;description<NUL> 640973c9f4fSDavid Howells * 641973c9f4fSDavid Howells * If successful, we return the amount of description available, irrespective 642973c9f4fSDavid Howells * of how much we may have copied into the buffer. 6431da177e4SLinus Torvalds */ 6441da177e4SLinus Torvalds long keyctl_describe_key(key_serial_t keyid, 6451da177e4SLinus Torvalds char __user *buffer, 6461da177e4SLinus Torvalds size_t buflen) 6471da177e4SLinus Torvalds { 6483e30148cSDavid Howells struct key *key, *instkey; 649664cceb0SDavid Howells key_ref_t key_ref; 650aa9d4437SDavid Howells char *infobuf; 6511da177e4SLinus Torvalds long ret; 652aa9d4437SDavid Howells int desclen, infolen; 6531da177e4SLinus Torvalds 654f5895943SDavid Howells key_ref = lookup_user_key(keyid, KEY_LOOKUP_PARTIAL, KEY_NEED_VIEW); 655664cceb0SDavid Howells if (IS_ERR(key_ref)) { 6563e30148cSDavid Howells /* viewing a key under construction is permitted if we have the 6573e30148cSDavid Howells * authorisation token handy */ 658664cceb0SDavid Howells if (PTR_ERR(key_ref) == -EACCES) { 6593e30148cSDavid Howells instkey = key_get_instantiation_authkey(keyid); 6603e30148cSDavid Howells if (!IS_ERR(instkey)) { 6613e30148cSDavid Howells key_put(instkey); 6628bbf4976SDavid Howells key_ref = lookup_user_key(keyid, 6635593122eSDavid Howells KEY_LOOKUP_PARTIAL, 6645593122eSDavid Howells 0); 665664cceb0SDavid Howells if (!IS_ERR(key_ref)) 6663e30148cSDavid Howells goto okay; 6673e30148cSDavid Howells } 6683e30148cSDavid Howells } 6693e30148cSDavid Howells 670664cceb0SDavid Howells ret = PTR_ERR(key_ref); 6711da177e4SLinus Torvalds goto error; 6721da177e4SLinus Torvalds } 6731da177e4SLinus Torvalds 6743e30148cSDavid Howells okay: 675664cceb0SDavid Howells key = key_ref_to_ptr(key_ref); 676aa9d4437SDavid Howells desclen = strlen(key->description); 677664cceb0SDavid Howells 678aa9d4437SDavid Howells /* calculate how much information we're going to return */ 679aa9d4437SDavid Howells ret = -ENOMEM; 680aa9d4437SDavid Howells infobuf = kasprintf(GFP_KERNEL, 681aa9d4437SDavid Howells "%s;%d;%d;%08x;", 68294fd8405SDavid Howells key->type->name, 6839a56c2dbSEric W. Biederman from_kuid_munged(current_user_ns(), key->uid), 6849a56c2dbSEric W. Biederman from_kgid_munged(current_user_ns(), key->gid), 685028db3e2SLinus Torvalds key->perm); 686aa9d4437SDavid Howells if (!infobuf) 687aa9d4437SDavid Howells goto error2; 688aa9d4437SDavid Howells infolen = strlen(infobuf); 689aa9d4437SDavid Howells ret = infolen + desclen + 1; 6901da177e4SLinus Torvalds 6911da177e4SLinus Torvalds /* consider returning the data */ 692aa9d4437SDavid Howells if (buffer && buflen >= ret) { 693aa9d4437SDavid Howells if (copy_to_user(buffer, infobuf, infolen) != 0 || 694aa9d4437SDavid Howells copy_to_user(buffer + infolen, key->description, 695aa9d4437SDavid Howells desclen + 1) != 0) 6961da177e4SLinus Torvalds ret = -EFAULT; 6971da177e4SLinus Torvalds } 6981da177e4SLinus Torvalds 699aa9d4437SDavid Howells kfree(infobuf); 7001da177e4SLinus Torvalds error2: 701664cceb0SDavid Howells key_ref_put(key_ref); 7021da177e4SLinus Torvalds error: 7031da177e4SLinus Torvalds return ret; 704a8b17ed0SDavid Howells } 7051da177e4SLinus Torvalds 7061da177e4SLinus Torvalds /* 707973c9f4fSDavid Howells * Search the specified keyring and any keyrings it links to for a matching 708973c9f4fSDavid Howells * key. Only keyrings that grant the caller Search permission will be searched 709973c9f4fSDavid Howells * (this includes the starting keyring). Only keys with Search permission can 710973c9f4fSDavid Howells * be found. 711973c9f4fSDavid Howells * 712973c9f4fSDavid Howells * If successful, the found key will be linked to the destination keyring if 713973c9f4fSDavid Howells * supplied and the key has Link permission, and the found key ID will be 714973c9f4fSDavid Howells * returned. 7151da177e4SLinus Torvalds */ 7161da177e4SLinus Torvalds long keyctl_keyring_search(key_serial_t ringid, 7171da177e4SLinus Torvalds const char __user *_type, 7181da177e4SLinus Torvalds const char __user *_description, 7191da177e4SLinus Torvalds key_serial_t destringid) 7201da177e4SLinus Torvalds { 7211da177e4SLinus Torvalds struct key_type *ktype; 722664cceb0SDavid Howells key_ref_t keyring_ref, key_ref, dest_ref; 7231da177e4SLinus Torvalds char type[32], *description; 7240cb409d9SDavi Arnaut long ret; 7251da177e4SLinus Torvalds 7261da177e4SLinus Torvalds /* pull the type and description into kernel space */ 7270cb409d9SDavi Arnaut ret = key_get_type_from_user(type, _type, sizeof(type)); 7281da177e4SLinus Torvalds if (ret < 0) 7291da177e4SLinus Torvalds goto error; 7301da177e4SLinus Torvalds 731aa9d4437SDavid Howells description = strndup_user(_description, KEY_MAX_DESC_SIZE); 7320cb409d9SDavi Arnaut if (IS_ERR(description)) { 7330cb409d9SDavi Arnaut ret = PTR_ERR(description); 7341da177e4SLinus Torvalds goto error; 7350cb409d9SDavi Arnaut } 7361da177e4SLinus Torvalds 7371da177e4SLinus Torvalds /* get the keyring at which to begin the search */ 738f5895943SDavid Howells keyring_ref = lookup_user_key(ringid, 0, KEY_NEED_SEARCH); 739664cceb0SDavid Howells if (IS_ERR(keyring_ref)) { 740664cceb0SDavid Howells ret = PTR_ERR(keyring_ref); 7411da177e4SLinus Torvalds goto error2; 7421da177e4SLinus Torvalds } 7431da177e4SLinus Torvalds 7441da177e4SLinus Torvalds /* get the destination keyring if specified */ 745664cceb0SDavid Howells dest_ref = NULL; 7461da177e4SLinus Torvalds if (destringid) { 7475593122eSDavid Howells dest_ref = lookup_user_key(destringid, KEY_LOOKUP_CREATE, 748f5895943SDavid Howells KEY_NEED_WRITE); 749664cceb0SDavid Howells if (IS_ERR(dest_ref)) { 750664cceb0SDavid Howells ret = PTR_ERR(dest_ref); 7511da177e4SLinus Torvalds goto error3; 7521da177e4SLinus Torvalds } 7531da177e4SLinus Torvalds } 7541da177e4SLinus Torvalds 7551da177e4SLinus Torvalds /* find the key type */ 7561da177e4SLinus Torvalds ktype = key_type_lookup(type); 7571da177e4SLinus Torvalds if (IS_ERR(ktype)) { 7581da177e4SLinus Torvalds ret = PTR_ERR(ktype); 7591da177e4SLinus Torvalds goto error4; 7601da177e4SLinus Torvalds } 7611da177e4SLinus Torvalds 7621da177e4SLinus Torvalds /* do the search */ 763dcf49dbcSDavid Howells key_ref = keyring_search(keyring_ref, ktype, description, true); 764664cceb0SDavid Howells if (IS_ERR(key_ref)) { 765664cceb0SDavid Howells ret = PTR_ERR(key_ref); 7661da177e4SLinus Torvalds 7671da177e4SLinus Torvalds /* treat lack or presence of a negative key the same */ 7681da177e4SLinus Torvalds if (ret == -EAGAIN) 7691da177e4SLinus Torvalds ret = -ENOKEY; 7701da177e4SLinus Torvalds goto error5; 7711da177e4SLinus Torvalds } 7721da177e4SLinus Torvalds 7731da177e4SLinus Torvalds /* link the resulting key to the destination keyring if we can */ 774664cceb0SDavid Howells if (dest_ref) { 775f5895943SDavid Howells ret = key_permission(key_ref, KEY_NEED_LINK); 77629db9190SDavid Howells if (ret < 0) 7771da177e4SLinus Torvalds goto error6; 7781da177e4SLinus Torvalds 779664cceb0SDavid Howells ret = key_link(key_ref_to_ptr(dest_ref), key_ref_to_ptr(key_ref)); 7801da177e4SLinus Torvalds if (ret < 0) 7811da177e4SLinus Torvalds goto error6; 7821da177e4SLinus Torvalds } 7831da177e4SLinus Torvalds 784664cceb0SDavid Howells ret = key_ref_to_ptr(key_ref)->serial; 7851da177e4SLinus Torvalds 7861da177e4SLinus Torvalds error6: 787664cceb0SDavid Howells key_ref_put(key_ref); 7881da177e4SLinus Torvalds error5: 7891da177e4SLinus Torvalds key_type_put(ktype); 7901da177e4SLinus Torvalds error4: 791664cceb0SDavid Howells key_ref_put(dest_ref); 7921da177e4SLinus Torvalds error3: 793664cceb0SDavid Howells key_ref_put(keyring_ref); 7941da177e4SLinus Torvalds error2: 7951da177e4SLinus Torvalds kfree(description); 7961da177e4SLinus Torvalds error: 7971da177e4SLinus Torvalds return ret; 798a8b17ed0SDavid Howells } 7991da177e4SLinus Torvalds 8001da177e4SLinus Torvalds /* 801*d3ec10aaSWaiman Long * Call the read method 802*d3ec10aaSWaiman Long */ 803*d3ec10aaSWaiman Long static long __keyctl_read_key(struct key *key, char *buffer, size_t buflen) 804*d3ec10aaSWaiman Long { 805*d3ec10aaSWaiman Long long ret; 806*d3ec10aaSWaiman Long 807*d3ec10aaSWaiman Long down_read(&key->sem); 808*d3ec10aaSWaiman Long ret = key_validate(key); 809*d3ec10aaSWaiman Long if (ret == 0) 810*d3ec10aaSWaiman Long ret = key->type->read(key, buffer, buflen); 811*d3ec10aaSWaiman Long up_read(&key->sem); 812*d3ec10aaSWaiman Long return ret; 813*d3ec10aaSWaiman Long } 814*d3ec10aaSWaiman Long 815*d3ec10aaSWaiman Long /* 816973c9f4fSDavid Howells * Read a key's payload. 817973c9f4fSDavid Howells * 818973c9f4fSDavid Howells * The key must either grant the caller Read permission, or it must grant the 819973c9f4fSDavid Howells * caller Search permission when searched for from the process keyrings. 820973c9f4fSDavid Howells * 821973c9f4fSDavid Howells * If successful, we place up to buflen bytes of data into the buffer, if one 822973c9f4fSDavid Howells * is provided, and return the amount of data that is available in the key, 823973c9f4fSDavid Howells * irrespective of how much we copied into the buffer. 8241da177e4SLinus Torvalds */ 8251da177e4SLinus Torvalds long keyctl_read_key(key_serial_t keyid, char __user *buffer, size_t buflen) 8261da177e4SLinus Torvalds { 827664cceb0SDavid Howells struct key *key; 828664cceb0SDavid Howells key_ref_t key_ref; 8291da177e4SLinus Torvalds long ret; 830*d3ec10aaSWaiman Long char *key_data; 8311da177e4SLinus Torvalds 8321da177e4SLinus Torvalds /* find the key first */ 8335593122eSDavid Howells key_ref = lookup_user_key(keyid, 0, 0); 834664cceb0SDavid Howells if (IS_ERR(key_ref)) { 835664cceb0SDavid Howells ret = -ENOKEY; 836*d3ec10aaSWaiman Long goto out; 837664cceb0SDavid Howells } 838664cceb0SDavid Howells 839664cceb0SDavid Howells key = key_ref_to_ptr(key_ref); 840664cceb0SDavid Howells 841363b02daSDavid Howells ret = key_read_state(key); 842363b02daSDavid Howells if (ret < 0) 843*d3ec10aaSWaiman Long goto key_put_out; /* Negatively instantiated */ 84437863c43SEric Biggers 8451da177e4SLinus Torvalds /* see if we can read it directly */ 846f5895943SDavid Howells ret = key_permission(key_ref, KEY_NEED_READ); 84729db9190SDavid Howells if (ret == 0) 8481da177e4SLinus Torvalds goto can_read_key; 84929db9190SDavid Howells if (ret != -EACCES) 850*d3ec10aaSWaiman Long goto key_put_out; 8511da177e4SLinus Torvalds 852664cceb0SDavid Howells /* we can't; see if it's searchable from this process's keyrings 8533e30148cSDavid Howells * - we automatically take account of the fact that it may be 8543e30148cSDavid Howells * dangling off an instantiation key 8553e30148cSDavid Howells */ 856664cceb0SDavid Howells if (!is_key_possessed(key_ref)) { 8571260f801SDavid Howells ret = -EACCES; 858*d3ec10aaSWaiman Long goto key_put_out; 8591da177e4SLinus Torvalds } 8601da177e4SLinus Torvalds 8611da177e4SLinus Torvalds /* the key is probably readable - now try to read it */ 8621da177e4SLinus Torvalds can_read_key: 863*d3ec10aaSWaiman Long if (!key->type->read) { 8641da177e4SLinus Torvalds ret = -EOPNOTSUPP; 865*d3ec10aaSWaiman Long goto key_put_out; 8661da177e4SLinus Torvalds } 8671da177e4SLinus Torvalds 868*d3ec10aaSWaiman Long if (!buffer || !buflen) { 869*d3ec10aaSWaiman Long /* Get the key length from the read method */ 870*d3ec10aaSWaiman Long ret = __keyctl_read_key(key, NULL, 0); 871*d3ec10aaSWaiman Long goto key_put_out; 872*d3ec10aaSWaiman Long } 873*d3ec10aaSWaiman Long 874*d3ec10aaSWaiman Long /* 875*d3ec10aaSWaiman Long * Read the data with the semaphore held (since we might sleep) 876*d3ec10aaSWaiman Long * to protect against the key being updated or revoked. 877*d3ec10aaSWaiman Long * 878*d3ec10aaSWaiman Long * Allocating a temporary buffer to hold the keys before 879*d3ec10aaSWaiman Long * transferring them to user buffer to avoid potential 880*d3ec10aaSWaiman Long * deadlock involving page fault and mmap_sem. 881*d3ec10aaSWaiman Long */ 882*d3ec10aaSWaiman Long key_data = kmalloc(buflen, GFP_KERNEL); 883*d3ec10aaSWaiman Long 884*d3ec10aaSWaiman Long if (!key_data) { 885*d3ec10aaSWaiman Long ret = -ENOMEM; 886*d3ec10aaSWaiman Long goto key_put_out; 887*d3ec10aaSWaiman Long } 888*d3ec10aaSWaiman Long ret = __keyctl_read_key(key, key_data, buflen); 889*d3ec10aaSWaiman Long 890*d3ec10aaSWaiman Long /* 891*d3ec10aaSWaiman Long * Read methods will just return the required length without 892*d3ec10aaSWaiman Long * any copying if the provided length isn't large enough. 893*d3ec10aaSWaiman Long */ 894*d3ec10aaSWaiman Long if (ret > 0 && ret <= buflen) { 895*d3ec10aaSWaiman Long if (copy_to_user(buffer, key_data, ret)) 896*d3ec10aaSWaiman Long ret = -EFAULT; 897*d3ec10aaSWaiman Long } 898*d3ec10aaSWaiman Long kzfree(key_data); 899*d3ec10aaSWaiman Long 900*d3ec10aaSWaiman Long key_put_out: 9011da177e4SLinus Torvalds key_put(key); 902*d3ec10aaSWaiman Long out: 9031da177e4SLinus Torvalds return ret; 904a8b17ed0SDavid Howells } 9051da177e4SLinus Torvalds 9061da177e4SLinus Torvalds /* 907973c9f4fSDavid Howells * Change the ownership of a key 908973c9f4fSDavid Howells * 909973c9f4fSDavid Howells * The key must grant the caller Setattr permission for this to work, though 910973c9f4fSDavid Howells * the key need not be fully instantiated yet. For the UID to be changed, or 911973c9f4fSDavid Howells * for the GID to be changed to a group the caller is not a member of, the 912973c9f4fSDavid Howells * caller must have sysadmin capability. If either uid or gid is -1 then that 913973c9f4fSDavid Howells * attribute is not changed. 914973c9f4fSDavid Howells * 915973c9f4fSDavid Howells * If the UID is to be changed, the new user must have sufficient quota to 916973c9f4fSDavid Howells * accept the key. The quota deduction will be removed from the old user to 917973c9f4fSDavid Howells * the new user should the attribute be changed. 918973c9f4fSDavid Howells * 919973c9f4fSDavid Howells * If successful, 0 will be returned. 9201da177e4SLinus Torvalds */ 9219a56c2dbSEric W. Biederman long keyctl_chown_key(key_serial_t id, uid_t user, gid_t group) 9221da177e4SLinus Torvalds { 9235801649dSFredrik Tolf struct key_user *newowner, *zapowner = NULL; 9241da177e4SLinus Torvalds struct key *key; 925664cceb0SDavid Howells key_ref_t key_ref; 9261da177e4SLinus Torvalds long ret; 9279a56c2dbSEric W. Biederman kuid_t uid; 9289a56c2dbSEric W. Biederman kgid_t gid; 9299a56c2dbSEric W. Biederman 9309a56c2dbSEric W. Biederman uid = make_kuid(current_user_ns(), user); 9319a56c2dbSEric W. Biederman gid = make_kgid(current_user_ns(), group); 9329a56c2dbSEric W. Biederman ret = -EINVAL; 9339a56c2dbSEric W. Biederman if ((user != (uid_t) -1) && !uid_valid(uid)) 9349a56c2dbSEric W. Biederman goto error; 9359a56c2dbSEric W. Biederman if ((group != (gid_t) -1) && !gid_valid(gid)) 9369a56c2dbSEric W. Biederman goto error; 9371da177e4SLinus Torvalds 9381da177e4SLinus Torvalds ret = 0; 9399a56c2dbSEric W. Biederman if (user == (uid_t) -1 && group == (gid_t) -1) 9401da177e4SLinus Torvalds goto error; 9411da177e4SLinus Torvalds 9425593122eSDavid Howells key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE | KEY_LOOKUP_PARTIAL, 943028db3e2SLinus Torvalds KEY_NEED_SETATTR); 944664cceb0SDavid Howells if (IS_ERR(key_ref)) { 945664cceb0SDavid Howells ret = PTR_ERR(key_ref); 9461da177e4SLinus Torvalds goto error; 9471da177e4SLinus Torvalds } 9481da177e4SLinus Torvalds 949664cceb0SDavid Howells key = key_ref_to_ptr(key_ref); 950664cceb0SDavid Howells 9511da177e4SLinus Torvalds /* make the changes with the locks held to prevent chown/chown races */ 9521da177e4SLinus Torvalds ret = -EACCES; 9531da177e4SLinus Torvalds down_write(&key->sem); 9541da177e4SLinus Torvalds 9551da177e4SLinus Torvalds if (!capable(CAP_SYS_ADMIN)) { 9561da177e4SLinus Torvalds /* only the sysadmin can chown a key to some other UID */ 9579a56c2dbSEric W. Biederman if (user != (uid_t) -1 && !uid_eq(key->uid, uid)) 9585801649dSFredrik Tolf goto error_put; 9591da177e4SLinus Torvalds 9601da177e4SLinus Torvalds /* only the sysadmin can set the key's GID to a group other 9611da177e4SLinus Torvalds * than one of those that the current process subscribes to */ 9629a56c2dbSEric W. Biederman if (group != (gid_t) -1 && !gid_eq(gid, key->gid) && !in_group_p(gid)) 9635801649dSFredrik Tolf goto error_put; 9641da177e4SLinus Torvalds } 9651da177e4SLinus Torvalds 9665801649dSFredrik Tolf /* change the UID */ 9679a56c2dbSEric W. Biederman if (user != (uid_t) -1 && !uid_eq(uid, key->uid)) { 9685801649dSFredrik Tolf ret = -ENOMEM; 9699a56c2dbSEric W. Biederman newowner = key_user_lookup(uid); 9705801649dSFredrik Tolf if (!newowner) 9715801649dSFredrik Tolf goto error_put; 9725801649dSFredrik Tolf 9735801649dSFredrik Tolf /* transfer the quota burden to the new user */ 9745801649dSFredrik Tolf if (test_bit(KEY_FLAG_IN_QUOTA, &key->flags)) { 9759a56c2dbSEric W. Biederman unsigned maxkeys = uid_eq(uid, GLOBAL_ROOT_UID) ? 9760b77f5bfSDavid Howells key_quota_root_maxkeys : key_quota_maxkeys; 9779a56c2dbSEric W. Biederman unsigned maxbytes = uid_eq(uid, GLOBAL_ROOT_UID) ? 9780b77f5bfSDavid Howells key_quota_root_maxbytes : key_quota_maxbytes; 9790b77f5bfSDavid Howells 9805801649dSFredrik Tolf spin_lock(&newowner->lock); 9810b77f5bfSDavid Howells if (newowner->qnkeys + 1 >= maxkeys || 9820b77f5bfSDavid Howells newowner->qnbytes + key->quotalen >= maxbytes || 9830b77f5bfSDavid Howells newowner->qnbytes + key->quotalen < 9840b77f5bfSDavid Howells newowner->qnbytes) 9855801649dSFredrik Tolf goto quota_overrun; 9865801649dSFredrik Tolf 9875801649dSFredrik Tolf newowner->qnkeys++; 9885801649dSFredrik Tolf newowner->qnbytes += key->quotalen; 9895801649dSFredrik Tolf spin_unlock(&newowner->lock); 9905801649dSFredrik Tolf 9915801649dSFredrik Tolf spin_lock(&key->user->lock); 9925801649dSFredrik Tolf key->user->qnkeys--; 9935801649dSFredrik Tolf key->user->qnbytes -= key->quotalen; 9945801649dSFredrik Tolf spin_unlock(&key->user->lock); 9955801649dSFredrik Tolf } 9965801649dSFredrik Tolf 9975801649dSFredrik Tolf atomic_dec(&key->user->nkeys); 9985801649dSFredrik Tolf atomic_inc(&newowner->nkeys); 9995801649dSFredrik Tolf 1000363b02daSDavid Howells if (key->state != KEY_IS_UNINSTANTIATED) { 10015801649dSFredrik Tolf atomic_dec(&key->user->nikeys); 10025801649dSFredrik Tolf atomic_inc(&newowner->nikeys); 10035801649dSFredrik Tolf } 10045801649dSFredrik Tolf 10055801649dSFredrik Tolf zapowner = key->user; 10065801649dSFredrik Tolf key->user = newowner; 10075801649dSFredrik Tolf key->uid = uid; 10081da177e4SLinus Torvalds } 10091da177e4SLinus Torvalds 10101da177e4SLinus Torvalds /* change the GID */ 10119a56c2dbSEric W. Biederman if (group != (gid_t) -1) 10121da177e4SLinus Torvalds key->gid = gid; 10131da177e4SLinus Torvalds 10141da177e4SLinus Torvalds ret = 0; 10151da177e4SLinus Torvalds 10165801649dSFredrik Tolf error_put: 10171da177e4SLinus Torvalds up_write(&key->sem); 10181da177e4SLinus Torvalds key_put(key); 10195801649dSFredrik Tolf if (zapowner) 10205801649dSFredrik Tolf key_user_put(zapowner); 10211da177e4SLinus Torvalds error: 10221da177e4SLinus Torvalds return ret; 10231da177e4SLinus Torvalds 10245801649dSFredrik Tolf quota_overrun: 10255801649dSFredrik Tolf spin_unlock(&newowner->lock); 10265801649dSFredrik Tolf zapowner = newowner; 10275801649dSFredrik Tolf ret = -EDQUOT; 10285801649dSFredrik Tolf goto error_put; 1029a8b17ed0SDavid Howells } 10305801649dSFredrik Tolf 10311da177e4SLinus Torvalds /* 1032973c9f4fSDavid Howells * Change the permission mask on a key. 1033973c9f4fSDavid Howells * 1034973c9f4fSDavid Howells * The key must grant the caller Setattr permission for this to work, though 1035973c9f4fSDavid Howells * the key need not be fully instantiated yet. If the caller does not have 1036973c9f4fSDavid Howells * sysadmin capability, it may only change the permission on keys that it owns. 10371da177e4SLinus Torvalds */ 1038028db3e2SLinus Torvalds long keyctl_setperm_key(key_serial_t id, key_perm_t perm) 10391da177e4SLinus Torvalds { 10401da177e4SLinus Torvalds struct key *key; 1041664cceb0SDavid Howells key_ref_t key_ref; 10421da177e4SLinus Torvalds long ret; 10431da177e4SLinus Torvalds 1044028db3e2SLinus Torvalds ret = -EINVAL; 1045664cceb0SDavid Howells if (perm & ~(KEY_POS_ALL | KEY_USR_ALL | KEY_GRP_ALL | KEY_OTH_ALL)) 1046028db3e2SLinus Torvalds goto error; 10471da177e4SLinus Torvalds 10485593122eSDavid Howells key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE | KEY_LOOKUP_PARTIAL, 1049028db3e2SLinus Torvalds KEY_NEED_SETATTR); 1050664cceb0SDavid Howells if (IS_ERR(key_ref)) { 1051664cceb0SDavid Howells ret = PTR_ERR(key_ref); 10521da177e4SLinus Torvalds goto error; 10531da177e4SLinus Torvalds } 10541da177e4SLinus Torvalds 1055664cceb0SDavid Howells key = key_ref_to_ptr(key_ref); 1056664cceb0SDavid Howells 10572e12256bSDavid Howells /* make the changes with the locks held to prevent chown/chmod races */ 1058028db3e2SLinus Torvalds ret = -EACCES; 10592e12256bSDavid Howells down_write(&key->sem); 1060028db3e2SLinus Torvalds 1061028db3e2SLinus Torvalds /* if we're not the sysadmin, we can only change a key that we own */ 1062028db3e2SLinus Torvalds if (capable(CAP_SYS_ADMIN) || uid_eq(key->uid, current_fsuid())) { 1063028db3e2SLinus Torvalds key->perm = perm; 1064028db3e2SLinus Torvalds ret = 0; 1065028db3e2SLinus Torvalds } 1066028db3e2SLinus Torvalds 10671da177e4SLinus Torvalds up_write(&key->sem); 10681da177e4SLinus Torvalds key_put(key); 10691da177e4SLinus Torvalds error: 10701da177e4SLinus Torvalds return ret; 1071a8b17ed0SDavid Howells } 10721da177e4SLinus Torvalds 10738bbf4976SDavid Howells /* 1074973c9f4fSDavid Howells * Get the destination keyring for instantiation and check that the caller has 1075973c9f4fSDavid Howells * Write permission on it. 10768bbf4976SDavid Howells */ 10778bbf4976SDavid Howells static long get_instantiation_keyring(key_serial_t ringid, 10788bbf4976SDavid Howells struct request_key_auth *rka, 10798bbf4976SDavid Howells struct key **_dest_keyring) 10808bbf4976SDavid Howells { 10818bbf4976SDavid Howells key_ref_t dkref; 10828bbf4976SDavid Howells 10838bbf4976SDavid Howells *_dest_keyring = NULL; 1084eca1bf5bSDavid Howells 1085eca1bf5bSDavid Howells /* just return a NULL pointer if we weren't asked to make a link */ 1086eca1bf5bSDavid Howells if (ringid == 0) 10878bbf4976SDavid Howells return 0; 10888bbf4976SDavid Howells 10898bbf4976SDavid Howells /* if a specific keyring is nominated by ID, then use that */ 10908bbf4976SDavid Howells if (ringid > 0) { 1091f5895943SDavid Howells dkref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE); 10928bbf4976SDavid Howells if (IS_ERR(dkref)) 10938bbf4976SDavid Howells return PTR_ERR(dkref); 10948bbf4976SDavid Howells *_dest_keyring = key_ref_to_ptr(dkref); 10958bbf4976SDavid Howells return 0; 10968bbf4976SDavid Howells } 10978bbf4976SDavid Howells 10988bbf4976SDavid Howells if (ringid == KEY_SPEC_REQKEY_AUTH_KEY) 10998bbf4976SDavid Howells return -EINVAL; 11008bbf4976SDavid Howells 11018bbf4976SDavid Howells /* otherwise specify the destination keyring recorded in the 11028bbf4976SDavid Howells * authorisation key (any KEY_SPEC_*_KEYRING) */ 11038bbf4976SDavid Howells if (ringid >= KEY_SPEC_REQUESTOR_KEYRING) { 110421279cfaSDavid Howells *_dest_keyring = key_get(rka->dest_keyring); 11058bbf4976SDavid Howells return 0; 11068bbf4976SDavid Howells } 11078bbf4976SDavid Howells 11088bbf4976SDavid Howells return -ENOKEY; 11098bbf4976SDavid Howells } 11108bbf4976SDavid Howells 1111d84f4f99SDavid Howells /* 1112973c9f4fSDavid Howells * Change the request_key authorisation key on the current process. 1113d84f4f99SDavid Howells */ 1114d84f4f99SDavid Howells static int keyctl_change_reqkey_auth(struct key *key) 1115d84f4f99SDavid Howells { 1116d84f4f99SDavid Howells struct cred *new; 1117d84f4f99SDavid Howells 1118d84f4f99SDavid Howells new = prepare_creds(); 1119d84f4f99SDavid Howells if (!new) 1120d84f4f99SDavid Howells return -ENOMEM; 1121d84f4f99SDavid Howells 1122d84f4f99SDavid Howells key_put(new->request_key_auth); 1123d84f4f99SDavid Howells new->request_key_auth = key_get(key); 1124d84f4f99SDavid Howells 1125d84f4f99SDavid Howells return commit_creds(new); 1126d84f4f99SDavid Howells } 1127d84f4f99SDavid Howells 11281da177e4SLinus Torvalds /* 1129973c9f4fSDavid Howells * Instantiate a key with the specified payload and link the key into the 1130973c9f4fSDavid Howells * destination keyring if one is given. 1131973c9f4fSDavid Howells * 1132973c9f4fSDavid Howells * The caller must have the appropriate instantiation permit set for this to 1133973c9f4fSDavid Howells * work (see keyctl_assume_authority). No other permissions are required. 1134973c9f4fSDavid Howells * 1135973c9f4fSDavid Howells * If successful, 0 will be returned. 11361da177e4SLinus Torvalds */ 1137ee009e4aSDavid Howells long keyctl_instantiate_key_common(key_serial_t id, 1138b353a1f7SAl Viro struct iov_iter *from, 11391da177e4SLinus Torvalds key_serial_t ringid) 11401da177e4SLinus Torvalds { 1141d84f4f99SDavid Howells const struct cred *cred = current_cred(); 11423e30148cSDavid Howells struct request_key_auth *rka; 11438bbf4976SDavid Howells struct key *instkey, *dest_keyring; 1144b353a1f7SAl Viro size_t plen = from ? iov_iter_count(from) : 0; 11451da177e4SLinus Torvalds void *payload; 11461da177e4SLinus Torvalds long ret; 11471da177e4SLinus Torvalds 1148d84f4f99SDavid Howells kenter("%d,,%zu,%d", id, plen, ringid); 1149d84f4f99SDavid Howells 1150b353a1f7SAl Viro if (!plen) 1151b353a1f7SAl Viro from = NULL; 1152b353a1f7SAl Viro 11531da177e4SLinus Torvalds ret = -EINVAL; 115438bbca6bSDavid Howells if (plen > 1024 * 1024 - 1) 11551da177e4SLinus Torvalds goto error; 11561da177e4SLinus Torvalds 1157b5f545c8SDavid Howells /* the appropriate instantiation authorisation key must have been 1158b5f545c8SDavid Howells * assumed before calling this */ 1159b5f545c8SDavid Howells ret = -EPERM; 1160d84f4f99SDavid Howells instkey = cred->request_key_auth; 1161b5f545c8SDavid Howells if (!instkey) 1162b5f545c8SDavid Howells goto error; 1163b5f545c8SDavid Howells 1164146aa8b1SDavid Howells rka = instkey->payload.data[0]; 1165b5f545c8SDavid Howells if (rka->target_key->serial != id) 1166b5f545c8SDavid Howells goto error; 1167b5f545c8SDavid Howells 11681da177e4SLinus Torvalds /* pull the payload in if one was supplied */ 11691da177e4SLinus Torvalds payload = NULL; 11701da177e4SLinus Torvalds 1171b353a1f7SAl Viro if (from) { 11721da177e4SLinus Torvalds ret = -ENOMEM; 1173752ade68SMichal Hocko payload = kvmalloc(plen, GFP_KERNEL); 11741da177e4SLinus Torvalds if (!payload) 11751da177e4SLinus Torvalds goto error; 11761da177e4SLinus Torvalds 1177b353a1f7SAl Viro ret = -EFAULT; 1178cbbd26b8SAl Viro if (!copy_from_iter_full(payload, plen, from)) 11791da177e4SLinus Torvalds goto error2; 11801da177e4SLinus Torvalds } 11811da177e4SLinus Torvalds 11823e30148cSDavid Howells /* find the destination keyring amongst those belonging to the 11833e30148cSDavid Howells * requesting task */ 11848bbf4976SDavid Howells ret = get_instantiation_keyring(ringid, rka, &dest_keyring); 11858bbf4976SDavid Howells if (ret < 0) 1186b5f545c8SDavid Howells goto error2; 11871da177e4SLinus Torvalds 11881da177e4SLinus Torvalds /* instantiate the key and link it into a keyring */ 11893e30148cSDavid Howells ret = key_instantiate_and_link(rka->target_key, payload, plen, 11908bbf4976SDavid Howells dest_keyring, instkey); 11911da177e4SLinus Torvalds 11928bbf4976SDavid Howells key_put(dest_keyring); 1193b5f545c8SDavid Howells 1194b5f545c8SDavid Howells /* discard the assumed authority if it's just been disabled by 1195b5f545c8SDavid Howells * instantiation of the key */ 1196d84f4f99SDavid Howells if (ret == 0) 1197d84f4f99SDavid Howells keyctl_change_reqkey_auth(NULL); 1198b5f545c8SDavid Howells 11991da177e4SLinus Torvalds error2: 120057070c85SEric Biggers if (payload) { 120157070c85SEric Biggers memzero_explicit(payload, plen); 1202b353a1f7SAl Viro kvfree(payload); 120357070c85SEric Biggers } 12041da177e4SLinus Torvalds error: 12051da177e4SLinus Torvalds return ret; 1206a8b17ed0SDavid Howells } 12071da177e4SLinus Torvalds 12081da177e4SLinus Torvalds /* 1209ee009e4aSDavid Howells * Instantiate a key with the specified payload and link the key into the 1210ee009e4aSDavid Howells * destination keyring if one is given. 1211ee009e4aSDavid Howells * 1212ee009e4aSDavid Howells * The caller must have the appropriate instantiation permit set for this to 1213ee009e4aSDavid Howells * work (see keyctl_assume_authority). No other permissions are required. 1214ee009e4aSDavid Howells * 1215ee009e4aSDavid Howells * If successful, 0 will be returned. 1216ee009e4aSDavid Howells */ 1217ee009e4aSDavid Howells long keyctl_instantiate_key(key_serial_t id, 1218ee009e4aSDavid Howells const void __user *_payload, 1219ee009e4aSDavid Howells size_t plen, 1220ee009e4aSDavid Howells key_serial_t ringid) 1221ee009e4aSDavid Howells { 1222ee009e4aSDavid Howells if (_payload && plen) { 1223b353a1f7SAl Viro struct iovec iov; 1224b353a1f7SAl Viro struct iov_iter from; 1225b353a1f7SAl Viro int ret; 1226ee009e4aSDavid Howells 1227b353a1f7SAl Viro ret = import_single_range(WRITE, (void __user *)_payload, plen, 1228b353a1f7SAl Viro &iov, &from); 1229b353a1f7SAl Viro if (unlikely(ret)) 1230b353a1f7SAl Viro return ret; 1231b353a1f7SAl Viro 1232b353a1f7SAl Viro return keyctl_instantiate_key_common(id, &from, ringid); 1233ee009e4aSDavid Howells } 1234ee009e4aSDavid Howells 1235b353a1f7SAl Viro return keyctl_instantiate_key_common(id, NULL, ringid); 1236ee009e4aSDavid Howells } 1237ee009e4aSDavid Howells 1238ee009e4aSDavid Howells /* 1239ee009e4aSDavid Howells * Instantiate a key with the specified multipart payload and link the key into 1240ee009e4aSDavid Howells * the destination keyring if one is given. 1241ee009e4aSDavid Howells * 1242ee009e4aSDavid Howells * The caller must have the appropriate instantiation permit set for this to 1243ee009e4aSDavid Howells * work (see keyctl_assume_authority). No other permissions are required. 1244ee009e4aSDavid Howells * 1245ee009e4aSDavid Howells * If successful, 0 will be returned. 1246ee009e4aSDavid Howells */ 1247ee009e4aSDavid Howells long keyctl_instantiate_key_iov(key_serial_t id, 1248ee009e4aSDavid Howells const struct iovec __user *_payload_iov, 1249ee009e4aSDavid Howells unsigned ioc, 1250ee009e4aSDavid Howells key_serial_t ringid) 1251ee009e4aSDavid Howells { 1252ee009e4aSDavid Howells struct iovec iovstack[UIO_FASTIOV], *iov = iovstack; 1253b353a1f7SAl Viro struct iov_iter from; 1254ee009e4aSDavid Howells long ret; 1255ee009e4aSDavid Howells 1256b353a1f7SAl Viro if (!_payload_iov) 1257b353a1f7SAl Viro ioc = 0; 1258ee009e4aSDavid Howells 1259b353a1f7SAl Viro ret = import_iovec(WRITE, _payload_iov, ioc, 1260b353a1f7SAl Viro ARRAY_SIZE(iovstack), &iov, &from); 1261ee009e4aSDavid Howells if (ret < 0) 1262b353a1f7SAl Viro return ret; 1263b353a1f7SAl Viro ret = keyctl_instantiate_key_common(id, &from, ringid); 1264ee009e4aSDavid Howells kfree(iov); 1265ee009e4aSDavid Howells return ret; 1266ee009e4aSDavid Howells } 1267ee009e4aSDavid Howells 1268ee009e4aSDavid Howells /* 1269973c9f4fSDavid Howells * Negatively instantiate the key with the given timeout (in seconds) and link 1270973c9f4fSDavid Howells * the key into the destination keyring if one is given. 1271973c9f4fSDavid Howells * 1272973c9f4fSDavid Howells * The caller must have the appropriate instantiation permit set for this to 1273973c9f4fSDavid Howells * work (see keyctl_assume_authority). No other permissions are required. 1274973c9f4fSDavid Howells * 1275973c9f4fSDavid Howells * The key and any links to the key will be automatically garbage collected 1276973c9f4fSDavid Howells * after the timeout expires. 1277973c9f4fSDavid Howells * 1278973c9f4fSDavid Howells * Negative keys are used to rate limit repeated request_key() calls by causing 1279973c9f4fSDavid Howells * them to return -ENOKEY until the negative key expires. 1280973c9f4fSDavid Howells * 1281973c9f4fSDavid Howells * If successful, 0 will be returned. 12821da177e4SLinus Torvalds */ 12831da177e4SLinus Torvalds long keyctl_negate_key(key_serial_t id, unsigned timeout, key_serial_t ringid) 12841da177e4SLinus Torvalds { 1285fdd1b945SDavid Howells return keyctl_reject_key(id, timeout, ENOKEY, ringid); 1286fdd1b945SDavid Howells } 1287fdd1b945SDavid Howells 1288fdd1b945SDavid Howells /* 1289fdd1b945SDavid Howells * Negatively instantiate the key with the given timeout (in seconds) and error 1290fdd1b945SDavid Howells * code and link the key into the destination keyring if one is given. 1291fdd1b945SDavid Howells * 1292fdd1b945SDavid Howells * The caller must have the appropriate instantiation permit set for this to 1293fdd1b945SDavid Howells * work (see keyctl_assume_authority). No other permissions are required. 1294fdd1b945SDavid Howells * 1295fdd1b945SDavid Howells * The key and any links to the key will be automatically garbage collected 1296fdd1b945SDavid Howells * after the timeout expires. 1297fdd1b945SDavid Howells * 1298fdd1b945SDavid Howells * Negative keys are used to rate limit repeated request_key() calls by causing 1299fdd1b945SDavid Howells * them to return the specified error code until the negative key expires. 1300fdd1b945SDavid Howells * 1301fdd1b945SDavid Howells * If successful, 0 will be returned. 1302fdd1b945SDavid Howells */ 1303fdd1b945SDavid Howells long keyctl_reject_key(key_serial_t id, unsigned timeout, unsigned error, 1304fdd1b945SDavid Howells key_serial_t ringid) 1305fdd1b945SDavid Howells { 1306d84f4f99SDavid Howells const struct cred *cred = current_cred(); 13073e30148cSDavid Howells struct request_key_auth *rka; 13088bbf4976SDavid Howells struct key *instkey, *dest_keyring; 13091da177e4SLinus Torvalds long ret; 13101da177e4SLinus Torvalds 1311fdd1b945SDavid Howells kenter("%d,%u,%u,%d", id, timeout, error, ringid); 1312fdd1b945SDavid Howells 1313fdd1b945SDavid Howells /* must be a valid error code and mustn't be a kernel special */ 1314fdd1b945SDavid Howells if (error <= 0 || 1315fdd1b945SDavid Howells error >= MAX_ERRNO || 1316fdd1b945SDavid Howells error == ERESTARTSYS || 1317fdd1b945SDavid Howells error == ERESTARTNOINTR || 1318fdd1b945SDavid Howells error == ERESTARTNOHAND || 1319fdd1b945SDavid Howells error == ERESTART_RESTARTBLOCK) 1320fdd1b945SDavid Howells return -EINVAL; 1321d84f4f99SDavid Howells 1322b5f545c8SDavid Howells /* the appropriate instantiation authorisation key must have been 1323b5f545c8SDavid Howells * assumed before calling this */ 1324b5f545c8SDavid Howells ret = -EPERM; 1325d84f4f99SDavid Howells instkey = cred->request_key_auth; 1326b5f545c8SDavid Howells if (!instkey) 13271da177e4SLinus Torvalds goto error; 13281da177e4SLinus Torvalds 1329146aa8b1SDavid Howells rka = instkey->payload.data[0]; 1330b5f545c8SDavid Howells if (rka->target_key->serial != id) 1331b5f545c8SDavid Howells goto error; 13323e30148cSDavid Howells 13331da177e4SLinus Torvalds /* find the destination keyring if present (which must also be 13341da177e4SLinus Torvalds * writable) */ 13358bbf4976SDavid Howells ret = get_instantiation_keyring(ringid, rka, &dest_keyring); 13368bbf4976SDavid Howells if (ret < 0) 1337b5f545c8SDavid Howells goto error; 13381da177e4SLinus Torvalds 13391da177e4SLinus Torvalds /* instantiate the key and link it into a keyring */ 1340fdd1b945SDavid Howells ret = key_reject_and_link(rka->target_key, timeout, error, 13418bbf4976SDavid Howells dest_keyring, instkey); 13421da177e4SLinus Torvalds 13438bbf4976SDavid Howells key_put(dest_keyring); 1344b5f545c8SDavid Howells 1345b5f545c8SDavid Howells /* discard the assumed authority if it's just been disabled by 1346b5f545c8SDavid Howells * instantiation of the key */ 1347d84f4f99SDavid Howells if (ret == 0) 1348d84f4f99SDavid Howells keyctl_change_reqkey_auth(NULL); 1349b5f545c8SDavid Howells 13501da177e4SLinus Torvalds error: 13511da177e4SLinus Torvalds return ret; 1352a8b17ed0SDavid Howells } 13531da177e4SLinus Torvalds 13541da177e4SLinus Torvalds /* 1355973c9f4fSDavid Howells * Read or set the default keyring in which request_key() will cache keys and 1356973c9f4fSDavid Howells * return the old setting. 1357973c9f4fSDavid Howells * 1358c9f838d1SEric Biggers * If a thread or process keyring is specified then it will be created if it 1359c9f838d1SEric Biggers * doesn't yet exist. The old setting will be returned if successful. 13603e30148cSDavid Howells */ 13613e30148cSDavid Howells long keyctl_set_reqkey_keyring(int reqkey_defl) 13623e30148cSDavid Howells { 1363d84f4f99SDavid Howells struct cred *new; 1364d84f4f99SDavid Howells int ret, old_setting; 1365d84f4f99SDavid Howells 1366d84f4f99SDavid Howells old_setting = current_cred_xxx(jit_keyring); 1367d84f4f99SDavid Howells 1368d84f4f99SDavid Howells if (reqkey_defl == KEY_REQKEY_DEFL_NO_CHANGE) 1369d84f4f99SDavid Howells return old_setting; 1370d84f4f99SDavid Howells 1371d84f4f99SDavid Howells new = prepare_creds(); 1372d84f4f99SDavid Howells if (!new) 1373d84f4f99SDavid Howells return -ENOMEM; 13743e30148cSDavid Howells 13753e30148cSDavid Howells switch (reqkey_defl) { 13763e30148cSDavid Howells case KEY_REQKEY_DEFL_THREAD_KEYRING: 1377d84f4f99SDavid Howells ret = install_thread_keyring_to_cred(new); 13783e30148cSDavid Howells if (ret < 0) 1379d84f4f99SDavid Howells goto error; 13803e30148cSDavid Howells goto set; 13813e30148cSDavid Howells 13823e30148cSDavid Howells case KEY_REQKEY_DEFL_PROCESS_KEYRING: 1383d84f4f99SDavid Howells ret = install_process_keyring_to_cred(new); 1384c9f838d1SEric Biggers if (ret < 0) 1385d84f4f99SDavid Howells goto error; 1386d84f4f99SDavid Howells goto set; 13873e30148cSDavid Howells 13883e30148cSDavid Howells case KEY_REQKEY_DEFL_DEFAULT: 13893e30148cSDavid Howells case KEY_REQKEY_DEFL_SESSION_KEYRING: 13903e30148cSDavid Howells case KEY_REQKEY_DEFL_USER_KEYRING: 13913e30148cSDavid Howells case KEY_REQKEY_DEFL_USER_SESSION_KEYRING: 1392d84f4f99SDavid Howells case KEY_REQKEY_DEFL_REQUESTOR_KEYRING: 1393d84f4f99SDavid Howells goto set; 13943e30148cSDavid Howells 13953e30148cSDavid Howells case KEY_REQKEY_DEFL_NO_CHANGE: 13963e30148cSDavid Howells case KEY_REQKEY_DEFL_GROUP_KEYRING: 13973e30148cSDavid Howells default: 1398d84f4f99SDavid Howells ret = -EINVAL; 1399d84f4f99SDavid Howells goto error; 14003e30148cSDavid Howells } 14013e30148cSDavid Howells 1402d84f4f99SDavid Howells set: 1403d84f4f99SDavid Howells new->jit_keyring = reqkey_defl; 1404d84f4f99SDavid Howells commit_creds(new); 1405d84f4f99SDavid Howells return old_setting; 1406d84f4f99SDavid Howells error: 1407d84f4f99SDavid Howells abort_creds(new); 14084303ef19SDan Carpenter return ret; 1409a8b17ed0SDavid Howells } 1410d84f4f99SDavid Howells 14113e30148cSDavid Howells /* 1412973c9f4fSDavid Howells * Set or clear the timeout on a key. 1413973c9f4fSDavid Howells * 1414973c9f4fSDavid Howells * Either the key must grant the caller Setattr permission or else the caller 1415973c9f4fSDavid Howells * must hold an instantiation authorisation token for the key. 1416973c9f4fSDavid Howells * 1417973c9f4fSDavid Howells * The timeout is either 0 to clear the timeout, or a number of seconds from 1418973c9f4fSDavid Howells * the current time. The key and any links to the key will be automatically 1419973c9f4fSDavid Howells * garbage collected after the timeout expires. 1420973c9f4fSDavid Howells * 1421d3600bcfSMimi Zohar * Keys with KEY_FLAG_KEEP set should not be timed out. 1422d3600bcfSMimi Zohar * 1423973c9f4fSDavid Howells * If successful, 0 is returned. 1424017679c4SDavid Howells */ 1425017679c4SDavid Howells long keyctl_set_timeout(key_serial_t id, unsigned timeout) 1426017679c4SDavid Howells { 14279156235bSDavid Howells struct key *key, *instkey; 1428017679c4SDavid Howells key_ref_t key_ref; 1429017679c4SDavid Howells long ret; 1430017679c4SDavid Howells 14315593122eSDavid Howells key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE | KEY_LOOKUP_PARTIAL, 1432028db3e2SLinus Torvalds KEY_NEED_SETATTR); 1433017679c4SDavid Howells if (IS_ERR(key_ref)) { 14349156235bSDavid Howells /* setting the timeout on a key under construction is permitted 14359156235bSDavid Howells * if we have the authorisation token handy */ 14369156235bSDavid Howells if (PTR_ERR(key_ref) == -EACCES) { 14379156235bSDavid Howells instkey = key_get_instantiation_authkey(id); 14389156235bSDavid Howells if (!IS_ERR(instkey)) { 14399156235bSDavid Howells key_put(instkey); 14409156235bSDavid Howells key_ref = lookup_user_key(id, 14419156235bSDavid Howells KEY_LOOKUP_PARTIAL, 14429156235bSDavid Howells 0); 14439156235bSDavid Howells if (!IS_ERR(key_ref)) 14449156235bSDavid Howells goto okay; 14459156235bSDavid Howells } 14469156235bSDavid Howells } 14479156235bSDavid Howells 1448017679c4SDavid Howells ret = PTR_ERR(key_ref); 1449017679c4SDavid Howells goto error; 1450017679c4SDavid Howells } 1451017679c4SDavid Howells 14529156235bSDavid Howells okay: 1453017679c4SDavid Howells key = key_ref_to_ptr(key_ref); 14541d6d167cSMimi Zohar ret = 0; 1455d3600bcfSMimi Zohar if (test_bit(KEY_FLAG_KEEP, &key->flags)) 1456d3600bcfSMimi Zohar ret = -EPERM; 14571d6d167cSMimi Zohar else 145859e6b9c1SBryan Schumaker key_set_timeout(key, timeout); 1459017679c4SDavid Howells key_put(key); 1460017679c4SDavid Howells 1461017679c4SDavid Howells error: 1462017679c4SDavid Howells return ret; 1463a8b17ed0SDavid Howells } 1464017679c4SDavid Howells 1465017679c4SDavid Howells /* 1466973c9f4fSDavid Howells * Assume (or clear) the authority to instantiate the specified key. 1467973c9f4fSDavid Howells * 1468973c9f4fSDavid Howells * This sets the authoritative token currently in force for key instantiation. 1469973c9f4fSDavid Howells * This must be done for a key to be instantiated. It has the effect of making 1470973c9f4fSDavid Howells * available all the keys from the caller of the request_key() that created a 1471973c9f4fSDavid Howells * key to request_key() calls made by the caller of this function. 1472973c9f4fSDavid Howells * 1473973c9f4fSDavid Howells * The caller must have the instantiation key in their process keyrings with a 1474973c9f4fSDavid Howells * Search permission grant available to the caller. 1475973c9f4fSDavid Howells * 1476973c9f4fSDavid Howells * If the ID given is 0, then the setting will be cleared and 0 returned. 1477973c9f4fSDavid Howells * 1478973c9f4fSDavid Howells * If the ID given has a matching an authorisation key, then that key will be 1479973c9f4fSDavid Howells * set and its ID will be returned. The authorisation key can be read to get 1480973c9f4fSDavid Howells * the callout information passed to request_key(). 1481b5f545c8SDavid Howells */ 1482b5f545c8SDavid Howells long keyctl_assume_authority(key_serial_t id) 1483b5f545c8SDavid Howells { 1484b5f545c8SDavid Howells struct key *authkey; 1485b5f545c8SDavid Howells long ret; 1486b5f545c8SDavid Howells 1487b5f545c8SDavid Howells /* special key IDs aren't permitted */ 1488b5f545c8SDavid Howells ret = -EINVAL; 1489b5f545c8SDavid Howells if (id < 0) 1490b5f545c8SDavid Howells goto error; 1491b5f545c8SDavid Howells 1492b5f545c8SDavid Howells /* we divest ourselves of authority if given an ID of 0 */ 1493b5f545c8SDavid Howells if (id == 0) { 1494d84f4f99SDavid Howells ret = keyctl_change_reqkey_auth(NULL); 1495b5f545c8SDavid Howells goto error; 1496b5f545c8SDavid Howells } 1497b5f545c8SDavid Howells 1498b5f545c8SDavid Howells /* attempt to assume the authority temporarily granted to us whilst we 1499b5f545c8SDavid Howells * instantiate the specified key 1500b5f545c8SDavid Howells * - the authorisation key must be in the current task's keyrings 1501b5f545c8SDavid Howells * somewhere 1502b5f545c8SDavid Howells */ 1503b5f545c8SDavid Howells authkey = key_get_instantiation_authkey(id); 1504b5f545c8SDavid Howells if (IS_ERR(authkey)) { 1505b5f545c8SDavid Howells ret = PTR_ERR(authkey); 1506b5f545c8SDavid Howells goto error; 1507b5f545c8SDavid Howells } 1508b5f545c8SDavid Howells 1509d84f4f99SDavid Howells ret = keyctl_change_reqkey_auth(authkey); 1510884bee02SEric Biggers if (ret == 0) 1511d84f4f99SDavid Howells ret = authkey->serial; 1512884bee02SEric Biggers key_put(authkey); 1513b5f545c8SDavid Howells error: 1514b5f545c8SDavid Howells return ret; 1515a8b17ed0SDavid Howells } 1516b5f545c8SDavid Howells 151770a5bb72SDavid Howells /* 1518973c9f4fSDavid Howells * Get a key's the LSM security label. 1519973c9f4fSDavid Howells * 1520973c9f4fSDavid Howells * The key must grant the caller View permission for this to work. 1521973c9f4fSDavid Howells * 1522973c9f4fSDavid Howells * If there's a buffer, then up to buflen bytes of data will be placed into it. 1523973c9f4fSDavid Howells * 1524973c9f4fSDavid Howells * If successful, the amount of information available will be returned, 1525973c9f4fSDavid Howells * irrespective of how much was copied (including the terminal NUL). 152670a5bb72SDavid Howells */ 152770a5bb72SDavid Howells long keyctl_get_security(key_serial_t keyid, 152870a5bb72SDavid Howells char __user *buffer, 152970a5bb72SDavid Howells size_t buflen) 153070a5bb72SDavid Howells { 153170a5bb72SDavid Howells struct key *key, *instkey; 153270a5bb72SDavid Howells key_ref_t key_ref; 153370a5bb72SDavid Howells char *context; 153470a5bb72SDavid Howells long ret; 153570a5bb72SDavid Howells 1536f5895943SDavid Howells key_ref = lookup_user_key(keyid, KEY_LOOKUP_PARTIAL, KEY_NEED_VIEW); 153770a5bb72SDavid Howells if (IS_ERR(key_ref)) { 153870a5bb72SDavid Howells if (PTR_ERR(key_ref) != -EACCES) 153970a5bb72SDavid Howells return PTR_ERR(key_ref); 154070a5bb72SDavid Howells 154170a5bb72SDavid Howells /* viewing a key under construction is also permitted if we 154270a5bb72SDavid Howells * have the authorisation token handy */ 154370a5bb72SDavid Howells instkey = key_get_instantiation_authkey(keyid); 154470a5bb72SDavid Howells if (IS_ERR(instkey)) 1545fa1cc7b5SRoel Kluin return PTR_ERR(instkey); 154670a5bb72SDavid Howells key_put(instkey); 154770a5bb72SDavid Howells 15485593122eSDavid Howells key_ref = lookup_user_key(keyid, KEY_LOOKUP_PARTIAL, 0); 154970a5bb72SDavid Howells if (IS_ERR(key_ref)) 155070a5bb72SDavid Howells return PTR_ERR(key_ref); 155170a5bb72SDavid Howells } 155270a5bb72SDavid Howells 155370a5bb72SDavid Howells key = key_ref_to_ptr(key_ref); 155470a5bb72SDavid Howells ret = security_key_getsecurity(key, &context); 155570a5bb72SDavid Howells if (ret == 0) { 155670a5bb72SDavid Howells /* if no information was returned, give userspace an empty 155770a5bb72SDavid Howells * string */ 155870a5bb72SDavid Howells ret = 1; 155970a5bb72SDavid Howells if (buffer && buflen > 0 && 156070a5bb72SDavid Howells copy_to_user(buffer, "", 1) != 0) 156170a5bb72SDavid Howells ret = -EFAULT; 156270a5bb72SDavid Howells } else if (ret > 0) { 156370a5bb72SDavid Howells /* return as much data as there's room for */ 156470a5bb72SDavid Howells if (buffer && buflen > 0) { 156570a5bb72SDavid Howells if (buflen > ret) 156670a5bb72SDavid Howells buflen = ret; 156770a5bb72SDavid Howells 156870a5bb72SDavid Howells if (copy_to_user(buffer, context, buflen) != 0) 156970a5bb72SDavid Howells ret = -EFAULT; 157070a5bb72SDavid Howells } 157170a5bb72SDavid Howells 157270a5bb72SDavid Howells kfree(context); 157370a5bb72SDavid Howells } 157470a5bb72SDavid Howells 157570a5bb72SDavid Howells key_ref_put(key_ref); 157670a5bb72SDavid Howells return ret; 157770a5bb72SDavid Howells } 157870a5bb72SDavid Howells 1579ee18d64cSDavid Howells /* 1580973c9f4fSDavid Howells * Attempt to install the calling process's session keyring on the process's 1581973c9f4fSDavid Howells * parent process. 1582973c9f4fSDavid Howells * 1583028db3e2SLinus Torvalds * The keyring must exist and must grant the caller LINK permission, and the 1584973c9f4fSDavid Howells * parent process must be single-threaded and must have the same effective 1585973c9f4fSDavid Howells * ownership as this process and mustn't be SUID/SGID. 1586973c9f4fSDavid Howells * 1587973c9f4fSDavid Howells * The keyring will be emplaced on the parent when it next resumes userspace. 1588973c9f4fSDavid Howells * 1589973c9f4fSDavid Howells * If successful, 0 will be returned. 1590ee18d64cSDavid Howells */ 1591ee18d64cSDavid Howells long keyctl_session_to_parent(void) 1592ee18d64cSDavid Howells { 1593ee18d64cSDavid Howells struct task_struct *me, *parent; 1594ee18d64cSDavid Howells const struct cred *mycred, *pcred; 159567d12145SAl Viro struct callback_head *newwork, *oldwork; 1596ee18d64cSDavid Howells key_ref_t keyring_r; 1597413cd3d9SOleg Nesterov struct cred *cred; 1598ee18d64cSDavid Howells int ret; 1599ee18d64cSDavid Howells 1600028db3e2SLinus Torvalds keyring_r = lookup_user_key(KEY_SPEC_SESSION_KEYRING, 0, KEY_NEED_LINK); 1601ee18d64cSDavid Howells if (IS_ERR(keyring_r)) 1602ee18d64cSDavid Howells return PTR_ERR(keyring_r); 1603ee18d64cSDavid Howells 1604413cd3d9SOleg Nesterov ret = -ENOMEM; 1605413cd3d9SOleg Nesterov 1606ee18d64cSDavid Howells /* our parent is going to need a new cred struct, a new tgcred struct 1607ee18d64cSDavid Howells * and new security data, so we allocate them here to prevent ENOMEM in 1608ee18d64cSDavid Howells * our parent */ 1609ee18d64cSDavid Howells cred = cred_alloc_blank(); 1610ee18d64cSDavid Howells if (!cred) 161167d12145SAl Viro goto error_keyring; 161267d12145SAl Viro newwork = &cred->rcu; 1613ee18d64cSDavid Howells 16143a50597dSDavid Howells cred->session_keyring = key_ref_to_ptr(keyring_r); 16153a50597dSDavid Howells keyring_r = NULL; 161667d12145SAl Viro init_task_work(newwork, key_change_session_keyring); 1617ee18d64cSDavid Howells 1618ee18d64cSDavid Howells me = current; 16199d1ac65aSDavid Howells rcu_read_lock(); 1620ee18d64cSDavid Howells write_lock_irq(&tasklist_lock); 1621ee18d64cSDavid Howells 1622ee18d64cSDavid Howells ret = -EPERM; 1623413cd3d9SOleg Nesterov oldwork = NULL; 16247936d16dSDavid Howells parent = rcu_dereference_protected(me->real_parent, 16257936d16dSDavid Howells lockdep_is_held(&tasklist_lock)); 1626ee18d64cSDavid Howells 1627ee18d64cSDavid Howells /* the parent mustn't be init and mustn't be a kernel thread */ 1628ee18d64cSDavid Howells if (parent->pid <= 1 || !parent->mm) 1629413cd3d9SOleg Nesterov goto unlock; 1630ee18d64cSDavid Howells 1631ee18d64cSDavid Howells /* the parent must be single threaded */ 1632dd98acf7SOleg Nesterov if (!thread_group_empty(parent)) 1633413cd3d9SOleg Nesterov goto unlock; 1634ee18d64cSDavid Howells 1635ee18d64cSDavid Howells /* the parent and the child must have different session keyrings or 1636ee18d64cSDavid Howells * there's no point */ 1637ee18d64cSDavid Howells mycred = current_cred(); 1638ee18d64cSDavid Howells pcred = __task_cred(parent); 1639ee18d64cSDavid Howells if (mycred == pcred || 16403a50597dSDavid Howells mycred->session_keyring == pcred->session_keyring) { 1641413cd3d9SOleg Nesterov ret = 0; 1642413cd3d9SOleg Nesterov goto unlock; 1643413cd3d9SOleg Nesterov } 1644ee18d64cSDavid Howells 1645ee18d64cSDavid Howells /* the parent must have the same effective ownership and mustn't be 1646ee18d64cSDavid Howells * SUID/SGID */ 16479a56c2dbSEric W. Biederman if (!uid_eq(pcred->uid, mycred->euid) || 16489a56c2dbSEric W. Biederman !uid_eq(pcred->euid, mycred->euid) || 16499a56c2dbSEric W. Biederman !uid_eq(pcred->suid, mycred->euid) || 16509a56c2dbSEric W. Biederman !gid_eq(pcred->gid, mycred->egid) || 16519a56c2dbSEric W. Biederman !gid_eq(pcred->egid, mycred->egid) || 16529a56c2dbSEric W. Biederman !gid_eq(pcred->sgid, mycred->egid)) 1653413cd3d9SOleg Nesterov goto unlock; 1654ee18d64cSDavid Howells 1655ee18d64cSDavid Howells /* the keyrings must have the same UID */ 16563a50597dSDavid Howells if ((pcred->session_keyring && 16572a74dbb9SLinus Torvalds !uid_eq(pcred->session_keyring->uid, mycred->euid)) || 16582a74dbb9SLinus Torvalds !uid_eq(mycred->session_keyring->uid, mycred->euid)) 1659413cd3d9SOleg Nesterov goto unlock; 1660ee18d64cSDavid Howells 1661413cd3d9SOleg Nesterov /* cancel an already pending keyring replacement */ 1662413cd3d9SOleg Nesterov oldwork = task_work_cancel(parent, key_change_session_keyring); 1663ee18d64cSDavid Howells 1664ee18d64cSDavid Howells /* the replacement session keyring is applied just prior to userspace 1665ee18d64cSDavid Howells * restarting */ 166667d12145SAl Viro ret = task_work_add(parent, newwork, true); 1667413cd3d9SOleg Nesterov if (!ret) 1668413cd3d9SOleg Nesterov newwork = NULL; 1669413cd3d9SOleg Nesterov unlock: 1670ee18d64cSDavid Howells write_unlock_irq(&tasklist_lock); 16719d1ac65aSDavid Howells rcu_read_unlock(); 167267d12145SAl Viro if (oldwork) 167367d12145SAl Viro put_cred(container_of(oldwork, struct cred, rcu)); 167467d12145SAl Viro if (newwork) 167567d12145SAl Viro put_cred(cred); 1676ee18d64cSDavid Howells return ret; 1677ee18d64cSDavid Howells 1678ee18d64cSDavid Howells error_keyring: 1679ee18d64cSDavid Howells key_ref_put(keyring_r); 1680ee18d64cSDavid Howells return ret; 1681ee18d64cSDavid Howells } 1682ee18d64cSDavid Howells 1683b5f545c8SDavid Howells /* 16846563c91fSMat Martineau * Apply a restriction to a given keyring. 16856563c91fSMat Martineau * 16866563c91fSMat Martineau * The caller must have Setattr permission to change keyring restrictions. 16876563c91fSMat Martineau * 16886563c91fSMat Martineau * The requested type name may be a NULL pointer to reject all attempts 168918026d86SEric Biggers * to link to the keyring. In this case, _restriction must also be NULL. 169018026d86SEric Biggers * Otherwise, both _type and _restriction must be non-NULL. 16916563c91fSMat Martineau * 16926563c91fSMat Martineau * Returns 0 if successful. 16936563c91fSMat Martineau */ 16946563c91fSMat Martineau long keyctl_restrict_keyring(key_serial_t id, const char __user *_type, 16956563c91fSMat Martineau const char __user *_restriction) 16966563c91fSMat Martineau { 16976563c91fSMat Martineau key_ref_t key_ref; 16986563c91fSMat Martineau char type[32]; 16996563c91fSMat Martineau char *restriction = NULL; 17006563c91fSMat Martineau long ret; 17016563c91fSMat Martineau 1702028db3e2SLinus Torvalds key_ref = lookup_user_key(id, 0, KEY_NEED_SETATTR); 17036563c91fSMat Martineau if (IS_ERR(key_ref)) 17046563c91fSMat Martineau return PTR_ERR(key_ref); 17056563c91fSMat Martineau 170618026d86SEric Biggers ret = -EINVAL; 17076563c91fSMat Martineau if (_type) { 170818026d86SEric Biggers if (!_restriction) 170918026d86SEric Biggers goto error; 171018026d86SEric Biggers 17116563c91fSMat Martineau ret = key_get_type_from_user(type, _type, sizeof(type)); 17126563c91fSMat Martineau if (ret < 0) 17136563c91fSMat Martineau goto error; 17146563c91fSMat Martineau 17156563c91fSMat Martineau restriction = strndup_user(_restriction, PAGE_SIZE); 17166563c91fSMat Martineau if (IS_ERR(restriction)) { 17176563c91fSMat Martineau ret = PTR_ERR(restriction); 17186563c91fSMat Martineau goto error; 17196563c91fSMat Martineau } 172018026d86SEric Biggers } else { 172118026d86SEric Biggers if (_restriction) 172218026d86SEric Biggers goto error; 17236563c91fSMat Martineau } 17246563c91fSMat Martineau 172518026d86SEric Biggers ret = keyring_restrict(key_ref, _type ? type : NULL, restriction); 17266563c91fSMat Martineau kfree(restriction); 17276563c91fSMat Martineau error: 17286563c91fSMat Martineau key_ref_put(key_ref); 17296563c91fSMat Martineau return ret; 17306563c91fSMat Martineau } 17316563c91fSMat Martineau 17326563c91fSMat Martineau /* 173345e0f30cSDavid Howells * Get keyrings subsystem capabilities. 173445e0f30cSDavid Howells */ 173545e0f30cSDavid Howells long keyctl_capabilities(unsigned char __user *_buffer, size_t buflen) 173645e0f30cSDavid Howells { 173745e0f30cSDavid Howells size_t size = buflen; 173845e0f30cSDavid Howells 173945e0f30cSDavid Howells if (size > 0) { 174045e0f30cSDavid Howells if (size > sizeof(keyrings_capabilities)) 174145e0f30cSDavid Howells size = sizeof(keyrings_capabilities); 174245e0f30cSDavid Howells if (copy_to_user(_buffer, keyrings_capabilities, size) != 0) 174345e0f30cSDavid Howells return -EFAULT; 174445e0f30cSDavid Howells if (size < buflen && 174545e0f30cSDavid Howells clear_user(_buffer + size, buflen - size) != 0) 174645e0f30cSDavid Howells return -EFAULT; 174745e0f30cSDavid Howells } 174845e0f30cSDavid Howells 174945e0f30cSDavid Howells return sizeof(keyrings_capabilities); 175045e0f30cSDavid Howells } 175145e0f30cSDavid Howells 175245e0f30cSDavid Howells /* 1753973c9f4fSDavid Howells * The key control system call 17541da177e4SLinus Torvalds */ 1755938bb9f5SHeiko Carstens SYSCALL_DEFINE5(keyctl, int, option, unsigned long, arg2, unsigned long, arg3, 1756938bb9f5SHeiko Carstens unsigned long, arg4, unsigned long, arg5) 17571da177e4SLinus Torvalds { 17581da177e4SLinus Torvalds switch (option) { 17591da177e4SLinus Torvalds case KEYCTL_GET_KEYRING_ID: 17601da177e4SLinus Torvalds return keyctl_get_keyring_ID((key_serial_t) arg2, 17611da177e4SLinus Torvalds (int) arg3); 17621da177e4SLinus Torvalds 17631da177e4SLinus Torvalds case KEYCTL_JOIN_SESSION_KEYRING: 17641da177e4SLinus Torvalds return keyctl_join_session_keyring((const char __user *) arg2); 17651da177e4SLinus Torvalds 17661da177e4SLinus Torvalds case KEYCTL_UPDATE: 17671da177e4SLinus Torvalds return keyctl_update_key((key_serial_t) arg2, 17681da177e4SLinus Torvalds (const void __user *) arg3, 17691da177e4SLinus Torvalds (size_t) arg4); 17701da177e4SLinus Torvalds 17711da177e4SLinus Torvalds case KEYCTL_REVOKE: 17721da177e4SLinus Torvalds return keyctl_revoke_key((key_serial_t) arg2); 17731da177e4SLinus Torvalds 17741da177e4SLinus Torvalds case KEYCTL_DESCRIBE: 17751da177e4SLinus Torvalds return keyctl_describe_key((key_serial_t) arg2, 17761da177e4SLinus Torvalds (char __user *) arg3, 17771da177e4SLinus Torvalds (unsigned) arg4); 17781da177e4SLinus Torvalds 17791da177e4SLinus Torvalds case KEYCTL_CLEAR: 17801da177e4SLinus Torvalds return keyctl_keyring_clear((key_serial_t) arg2); 17811da177e4SLinus Torvalds 17821da177e4SLinus Torvalds case KEYCTL_LINK: 17831da177e4SLinus Torvalds return keyctl_keyring_link((key_serial_t) arg2, 17841da177e4SLinus Torvalds (key_serial_t) arg3); 17851da177e4SLinus Torvalds 17861da177e4SLinus Torvalds case KEYCTL_UNLINK: 17871da177e4SLinus Torvalds return keyctl_keyring_unlink((key_serial_t) arg2, 17881da177e4SLinus Torvalds (key_serial_t) arg3); 17891da177e4SLinus Torvalds 17901da177e4SLinus Torvalds case KEYCTL_SEARCH: 17911da177e4SLinus Torvalds return keyctl_keyring_search((key_serial_t) arg2, 17921da177e4SLinus Torvalds (const char __user *) arg3, 17931da177e4SLinus Torvalds (const char __user *) arg4, 17941da177e4SLinus Torvalds (key_serial_t) arg5); 17951da177e4SLinus Torvalds 17961da177e4SLinus Torvalds case KEYCTL_READ: 17971da177e4SLinus Torvalds return keyctl_read_key((key_serial_t) arg2, 17981da177e4SLinus Torvalds (char __user *) arg3, 17991da177e4SLinus Torvalds (size_t) arg4); 18001da177e4SLinus Torvalds 18011da177e4SLinus Torvalds case KEYCTL_CHOWN: 18021da177e4SLinus Torvalds return keyctl_chown_key((key_serial_t) arg2, 18031da177e4SLinus Torvalds (uid_t) arg3, 18041da177e4SLinus Torvalds (gid_t) arg4); 18051da177e4SLinus Torvalds 18061da177e4SLinus Torvalds case KEYCTL_SETPERM: 18071da177e4SLinus Torvalds return keyctl_setperm_key((key_serial_t) arg2, 1808028db3e2SLinus Torvalds (key_perm_t) arg3); 18091da177e4SLinus Torvalds 18101da177e4SLinus Torvalds case KEYCTL_INSTANTIATE: 18111da177e4SLinus Torvalds return keyctl_instantiate_key((key_serial_t) arg2, 18121da177e4SLinus Torvalds (const void __user *) arg3, 18131da177e4SLinus Torvalds (size_t) arg4, 18141da177e4SLinus Torvalds (key_serial_t) arg5); 18151da177e4SLinus Torvalds 18161da177e4SLinus Torvalds case KEYCTL_NEGATE: 18171da177e4SLinus Torvalds return keyctl_negate_key((key_serial_t) arg2, 18181da177e4SLinus Torvalds (unsigned) arg3, 18191da177e4SLinus Torvalds (key_serial_t) arg4); 18201da177e4SLinus Torvalds 18213e30148cSDavid Howells case KEYCTL_SET_REQKEY_KEYRING: 18223e30148cSDavid Howells return keyctl_set_reqkey_keyring(arg2); 18233e30148cSDavid Howells 1824017679c4SDavid Howells case KEYCTL_SET_TIMEOUT: 1825017679c4SDavid Howells return keyctl_set_timeout((key_serial_t) arg2, 1826017679c4SDavid Howells (unsigned) arg3); 1827017679c4SDavid Howells 1828b5f545c8SDavid Howells case KEYCTL_ASSUME_AUTHORITY: 1829b5f545c8SDavid Howells return keyctl_assume_authority((key_serial_t) arg2); 1830b5f545c8SDavid Howells 183170a5bb72SDavid Howells case KEYCTL_GET_SECURITY: 183270a5bb72SDavid Howells return keyctl_get_security((key_serial_t) arg2, 183390bd49abSJames Morris (char __user *) arg3, 183470a5bb72SDavid Howells (size_t) arg4); 183570a5bb72SDavid Howells 1836ee18d64cSDavid Howells case KEYCTL_SESSION_TO_PARENT: 1837ee18d64cSDavid Howells return keyctl_session_to_parent(); 1838ee18d64cSDavid Howells 1839fdd1b945SDavid Howells case KEYCTL_REJECT: 1840fdd1b945SDavid Howells return keyctl_reject_key((key_serial_t) arg2, 1841fdd1b945SDavid Howells (unsigned) arg3, 1842fdd1b945SDavid Howells (unsigned) arg4, 1843fdd1b945SDavid Howells (key_serial_t) arg5); 1844fdd1b945SDavid Howells 1845ee009e4aSDavid Howells case KEYCTL_INSTANTIATE_IOV: 1846ee009e4aSDavid Howells return keyctl_instantiate_key_iov( 1847ee009e4aSDavid Howells (key_serial_t) arg2, 1848ee009e4aSDavid Howells (const struct iovec __user *) arg3, 1849ee009e4aSDavid Howells (unsigned) arg4, 1850ee009e4aSDavid Howells (key_serial_t) arg5); 1851ee009e4aSDavid Howells 1852fd75815fSDavid Howells case KEYCTL_INVALIDATE: 1853fd75815fSDavid Howells return keyctl_invalidate_key((key_serial_t) arg2); 1854fd75815fSDavid Howells 1855f36f8c75SDavid Howells case KEYCTL_GET_PERSISTENT: 1856f36f8c75SDavid Howells return keyctl_get_persistent((uid_t)arg2, (key_serial_t)arg3); 1857f36f8c75SDavid Howells 1858ddbb4114SMat Martineau case KEYCTL_DH_COMPUTE: 1859ddbb4114SMat Martineau return keyctl_dh_compute((struct keyctl_dh_params __user *) arg2, 18604693fc73SStephan Mueller (char __user *) arg3, (size_t) arg4, 1861f1c316a3SStephan Mueller (struct keyctl_kdf_params __user *) arg5); 1862ddbb4114SMat Martineau 18636563c91fSMat Martineau case KEYCTL_RESTRICT_KEYRING: 18646563c91fSMat Martineau return keyctl_restrict_keyring((key_serial_t) arg2, 18656563c91fSMat Martineau (const char __user *) arg3, 18666563c91fSMat Martineau (const char __user *) arg4); 18671da177e4SLinus Torvalds 186800d60fd3SDavid Howells case KEYCTL_PKEY_QUERY: 186900d60fd3SDavid Howells if (arg3 != 0) 187000d60fd3SDavid Howells return -EINVAL; 187100d60fd3SDavid Howells return keyctl_pkey_query((key_serial_t)arg2, 187200d60fd3SDavid Howells (const char __user *)arg4, 1873468e91ceSBen Dooks (struct keyctl_pkey_query __user *)arg5); 187400d60fd3SDavid Howells 187500d60fd3SDavid Howells case KEYCTL_PKEY_ENCRYPT: 187600d60fd3SDavid Howells case KEYCTL_PKEY_DECRYPT: 187700d60fd3SDavid Howells case KEYCTL_PKEY_SIGN: 187800d60fd3SDavid Howells return keyctl_pkey_e_d_s( 187900d60fd3SDavid Howells option, 188000d60fd3SDavid Howells (const struct keyctl_pkey_params __user *)arg2, 188100d60fd3SDavid Howells (const char __user *)arg3, 188200d60fd3SDavid Howells (const void __user *)arg4, 188300d60fd3SDavid Howells (void __user *)arg5); 188400d60fd3SDavid Howells 188500d60fd3SDavid Howells case KEYCTL_PKEY_VERIFY: 188600d60fd3SDavid Howells return keyctl_pkey_verify( 188700d60fd3SDavid Howells (const struct keyctl_pkey_params __user *)arg2, 188800d60fd3SDavid Howells (const char __user *)arg3, 188900d60fd3SDavid Howells (const void __user *)arg4, 189000d60fd3SDavid Howells (const void __user *)arg5); 189100d60fd3SDavid Howells 1892ed0ac5c7SDavid Howells case KEYCTL_MOVE: 1893ed0ac5c7SDavid Howells return keyctl_keyring_move((key_serial_t)arg2, 1894ed0ac5c7SDavid Howells (key_serial_t)arg3, 1895ed0ac5c7SDavid Howells (key_serial_t)arg4, 1896ed0ac5c7SDavid Howells (unsigned int)arg5); 1897ed0ac5c7SDavid Howells 189845e0f30cSDavid Howells case KEYCTL_CAPABILITIES: 189945e0f30cSDavid Howells return keyctl_capabilities((unsigned char __user *)arg2, (size_t)arg3); 190045e0f30cSDavid Howells 19011da177e4SLinus Torvalds default: 19021da177e4SLinus Torvalds return -EOPNOTSUPP; 19031da177e4SLinus Torvalds } 19041da177e4SLinus Torvalds } 1905