1973c9f4fSDavid Howells /* Userspace key control operations 21da177e4SLinus Torvalds * 33e30148cSDavid Howells * Copyright (C) 2004-5 Red Hat, Inc. All Rights Reserved. 41da177e4SLinus Torvalds * Written by David Howells (dhowells@redhat.com) 51da177e4SLinus Torvalds * 61da177e4SLinus Torvalds * This program is free software; you can redistribute it and/or 71da177e4SLinus Torvalds * modify it under the terms of the GNU General Public License 81da177e4SLinus Torvalds * as published by the Free Software Foundation; either version 91da177e4SLinus Torvalds * 2 of the License, or (at your option) any later version. 101da177e4SLinus Torvalds */ 111da177e4SLinus Torvalds 121da177e4SLinus Torvalds #include <linux/init.h> 131da177e4SLinus Torvalds #include <linux/sched.h> 1429930025SIngo Molnar #include <linux/sched/task.h> 151da177e4SLinus Torvalds #include <linux/slab.h> 161da177e4SLinus Torvalds #include <linux/syscalls.h> 1759e6b9c1SBryan Schumaker #include <linux/key.h> 181da177e4SLinus Torvalds #include <linux/keyctl.h> 191da177e4SLinus Torvalds #include <linux/fs.h> 20c59ede7bSRandy.Dunlap #include <linux/capability.h> 215b825c3aSIngo Molnar #include <linux/cred.h> 220cb409d9SDavi Arnaut #include <linux/string.h> 231da177e4SLinus Torvalds #include <linux/err.h> 2438bbca6bSDavid Howells #include <linux/vmalloc.h> 2570a5bb72SDavid Howells #include <linux/security.h> 26a27bb332SKent Overstreet #include <linux/uio.h> 277c0f6ba6SLinus Torvalds #include <linux/uaccess.h> 28822ad64dSDavid Howells #include <keys/request_key_auth-type.h> 291da177e4SLinus Torvalds #include "internal.h" 301da177e4SLinus Torvalds 31aa9d4437SDavid Howells #define KEY_MAX_DESC_SIZE 4096 32aa9d4437SDavid Howells 33*45e0f30cSDavid Howells static const unsigned char keyrings_capabilities[1] = { 34*45e0f30cSDavid Howells [0] = (KEYCTL_CAPS0_CAPABILITIES | 35*45e0f30cSDavid Howells (IS_ENABLED(CONFIG_PERSISTENT_KEYRINGS) ? KEYCTL_CAPS0_PERSISTENT_KEYRINGS : 0) | 36*45e0f30cSDavid Howells (IS_ENABLED(CONFIG_KEY_DH_OPERATIONS) ? KEYCTL_CAPS0_DIFFIE_HELLMAN : 0) | 37*45e0f30cSDavid Howells (IS_ENABLED(CONFIG_ASYMMETRIC_KEY_TYPE) ? KEYCTL_CAPS0_PUBLIC_KEY : 0) | 38*45e0f30cSDavid Howells (IS_ENABLED(CONFIG_BIG_KEYS) ? KEYCTL_CAPS0_BIG_KEY : 0) | 39*45e0f30cSDavid Howells KEYCTL_CAPS0_INVALIDATE | 40*45e0f30cSDavid Howells KEYCTL_CAPS0_RESTRICT_KEYRING | 41*45e0f30cSDavid Howells KEYCTL_CAPS0_MOVE 42*45e0f30cSDavid Howells ), 43*45e0f30cSDavid Howells }; 44*45e0f30cSDavid Howells 450cb409d9SDavi Arnaut static int key_get_type_from_user(char *type, 460cb409d9SDavi Arnaut const char __user *_type, 470cb409d9SDavi Arnaut unsigned len) 480cb409d9SDavi Arnaut { 490cb409d9SDavi Arnaut int ret; 500cb409d9SDavi Arnaut 510cb409d9SDavi Arnaut ret = strncpy_from_user(type, _type, len); 520cb409d9SDavi Arnaut if (ret < 0) 534303ef19SDan Carpenter return ret; 540cb409d9SDavi Arnaut if (ret == 0 || ret >= len) 550cb409d9SDavi Arnaut return -EINVAL; 5654e2c2c1SDavid Howells if (type[0] == '.') 5754e2c2c1SDavid Howells return -EPERM; 580cb409d9SDavi Arnaut type[len - 1] = '\0'; 590cb409d9SDavi Arnaut return 0; 600cb409d9SDavi Arnaut } 610cb409d9SDavi Arnaut 621da177e4SLinus Torvalds /* 63973c9f4fSDavid Howells * Extract the description of a new key from userspace and either add it as a 64973c9f4fSDavid Howells * new key to the specified keyring or update a matching key in that keyring. 65973c9f4fSDavid Howells * 66cf7f601cSDavid Howells * If the description is NULL or an empty string, the key type is asked to 67cf7f601cSDavid Howells * generate one from the payload. 68cf7f601cSDavid Howells * 69973c9f4fSDavid Howells * The keyring must be writable so that we can attach the key to it. 70973c9f4fSDavid Howells * 71973c9f4fSDavid Howells * If successful, the new key's serial number is returned, otherwise an error 72973c9f4fSDavid Howells * code is returned. 731da177e4SLinus Torvalds */ 741e7bfb21SHeiko Carstens SYSCALL_DEFINE5(add_key, const char __user *, _type, 751e7bfb21SHeiko Carstens const char __user *, _description, 761e7bfb21SHeiko Carstens const void __user *, _payload, 771e7bfb21SHeiko Carstens size_t, plen, 781e7bfb21SHeiko Carstens key_serial_t, ringid) 791da177e4SLinus Torvalds { 80664cceb0SDavid Howells key_ref_t keyring_ref, key_ref; 811da177e4SLinus Torvalds char type[32], *description; 821da177e4SLinus Torvalds void *payload; 830cb409d9SDavi Arnaut long ret; 841da177e4SLinus Torvalds 851da177e4SLinus Torvalds ret = -EINVAL; 8638bbca6bSDavid Howells if (plen > 1024 * 1024 - 1) 871da177e4SLinus Torvalds goto error; 881da177e4SLinus Torvalds 891da177e4SLinus Torvalds /* draw all the data into kernel space */ 900cb409d9SDavi Arnaut ret = key_get_type_from_user(type, _type, sizeof(type)); 911da177e4SLinus Torvalds if (ret < 0) 921da177e4SLinus Torvalds goto error; 931da177e4SLinus Torvalds 94cf7f601cSDavid Howells description = NULL; 95cf7f601cSDavid Howells if (_description) { 96aa9d4437SDavid Howells description = strndup_user(_description, KEY_MAX_DESC_SIZE); 970cb409d9SDavi Arnaut if (IS_ERR(description)) { 980cb409d9SDavi Arnaut ret = PTR_ERR(description); 993e30148cSDavid Howells goto error; 1000cb409d9SDavi Arnaut } 101cf7f601cSDavid Howells if (!*description) { 102cf7f601cSDavid Howells kfree(description); 103cf7f601cSDavid Howells description = NULL; 104a4e3b8d7SMimi Zohar } else if ((description[0] == '.') && 105a4e3b8d7SMimi Zohar (strncmp(type, "keyring", 7) == 0)) { 106a4e3b8d7SMimi Zohar ret = -EPERM; 107a4e3b8d7SMimi Zohar goto error2; 108cf7f601cSDavid Howells } 109cf7f601cSDavid Howells } 1101da177e4SLinus Torvalds 1111da177e4SLinus Torvalds /* pull the payload in if one was supplied */ 1121da177e4SLinus Torvalds payload = NULL; 1131da177e4SLinus Torvalds 1145649645dSEric Biggers if (plen) { 1151da177e4SLinus Torvalds ret = -ENOMEM; 116752ade68SMichal Hocko payload = kvmalloc(plen, GFP_KERNEL); 1171da177e4SLinus Torvalds if (!payload) 1181da177e4SLinus Torvalds goto error2; 1191da177e4SLinus Torvalds 1201da177e4SLinus Torvalds ret = -EFAULT; 1211da177e4SLinus Torvalds if (copy_from_user(payload, _payload, plen) != 0) 1221da177e4SLinus Torvalds goto error3; 1231da177e4SLinus Torvalds } 1241da177e4SLinus Torvalds 1251da177e4SLinus Torvalds /* find the target keyring (which must be writable) */ 126f5895943SDavid Howells keyring_ref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE); 127664cceb0SDavid Howells if (IS_ERR(keyring_ref)) { 128664cceb0SDavid Howells ret = PTR_ERR(keyring_ref); 1291da177e4SLinus Torvalds goto error3; 1301da177e4SLinus Torvalds } 1311da177e4SLinus Torvalds 1321da177e4SLinus Torvalds /* create or update the requested key and add it to the target 1331da177e4SLinus Torvalds * keyring */ 134664cceb0SDavid Howells key_ref = key_create_or_update(keyring_ref, type, description, 1356b79ccb5SArun Raghavan payload, plen, KEY_PERM_UNDEF, 1366b79ccb5SArun Raghavan KEY_ALLOC_IN_QUOTA); 137664cceb0SDavid Howells if (!IS_ERR(key_ref)) { 138664cceb0SDavid Howells ret = key_ref_to_ptr(key_ref)->serial; 139664cceb0SDavid Howells key_ref_put(key_ref); 1401da177e4SLinus Torvalds } 1411da177e4SLinus Torvalds else { 142664cceb0SDavid Howells ret = PTR_ERR(key_ref); 1431da177e4SLinus Torvalds } 1441da177e4SLinus Torvalds 145664cceb0SDavid Howells key_ref_put(keyring_ref); 1461da177e4SLinus Torvalds error3: 14757070c85SEric Biggers if (payload) { 14857070c85SEric Biggers memzero_explicit(payload, plen); 149d0e0eba0SGeliang Tang kvfree(payload); 15057070c85SEric Biggers } 1511da177e4SLinus Torvalds error2: 1521da177e4SLinus Torvalds kfree(description); 1531da177e4SLinus Torvalds error: 1541da177e4SLinus Torvalds return ret; 155a8b17ed0SDavid Howells } 1561da177e4SLinus Torvalds 1571da177e4SLinus Torvalds /* 158973c9f4fSDavid Howells * Search the process keyrings and keyring trees linked from those for a 159973c9f4fSDavid Howells * matching key. Keyrings must have appropriate Search permission to be 160973c9f4fSDavid Howells * searched. 161973c9f4fSDavid Howells * 162973c9f4fSDavid Howells * If a key is found, it will be attached to the destination keyring if there's 163973c9f4fSDavid Howells * one specified and the serial number of the key will be returned. 164973c9f4fSDavid Howells * 165973c9f4fSDavid Howells * If no key is found, /sbin/request-key will be invoked if _callout_info is 166973c9f4fSDavid Howells * non-NULL in an attempt to create a key. The _callout_info string will be 167973c9f4fSDavid Howells * passed to /sbin/request-key to aid with completing the request. If the 168973c9f4fSDavid Howells * _callout_info string is "" then it will be changed to "-". 1691da177e4SLinus Torvalds */ 1701e7bfb21SHeiko Carstens SYSCALL_DEFINE4(request_key, const char __user *, _type, 1711e7bfb21SHeiko Carstens const char __user *, _description, 1721e7bfb21SHeiko Carstens const char __user *, _callout_info, 1731e7bfb21SHeiko Carstens key_serial_t, destringid) 1741da177e4SLinus Torvalds { 1751da177e4SLinus Torvalds struct key_type *ktype; 176664cceb0SDavid Howells struct key *key; 177664cceb0SDavid Howells key_ref_t dest_ref; 1784a38e122SDavid Howells size_t callout_len; 1791da177e4SLinus Torvalds char type[32], *description, *callout_info; 1800cb409d9SDavi Arnaut long ret; 1811da177e4SLinus Torvalds 1821da177e4SLinus Torvalds /* pull the type into kernel space */ 1830cb409d9SDavi Arnaut ret = key_get_type_from_user(type, _type, sizeof(type)); 1841da177e4SLinus Torvalds if (ret < 0) 1851da177e4SLinus Torvalds goto error; 1861260f801SDavid Howells 1871da177e4SLinus Torvalds /* pull the description into kernel space */ 188aa9d4437SDavid Howells description = strndup_user(_description, KEY_MAX_DESC_SIZE); 1890cb409d9SDavi Arnaut if (IS_ERR(description)) { 1900cb409d9SDavi Arnaut ret = PTR_ERR(description); 1911da177e4SLinus Torvalds goto error; 1920cb409d9SDavi Arnaut } 1931da177e4SLinus Torvalds 1941da177e4SLinus Torvalds /* pull the callout info into kernel space */ 1951da177e4SLinus Torvalds callout_info = NULL; 1964a38e122SDavid Howells callout_len = 0; 1971da177e4SLinus Torvalds if (_callout_info) { 1980cb409d9SDavi Arnaut callout_info = strndup_user(_callout_info, PAGE_SIZE); 1990cb409d9SDavi Arnaut if (IS_ERR(callout_info)) { 2000cb409d9SDavi Arnaut ret = PTR_ERR(callout_info); 2011da177e4SLinus Torvalds goto error2; 2020cb409d9SDavi Arnaut } 2034a38e122SDavid Howells callout_len = strlen(callout_info); 2041da177e4SLinus Torvalds } 2051da177e4SLinus Torvalds 2061da177e4SLinus Torvalds /* get the destination keyring if specified */ 207664cceb0SDavid Howells dest_ref = NULL; 2081da177e4SLinus Torvalds if (destringid) { 2095593122eSDavid Howells dest_ref = lookup_user_key(destringid, KEY_LOOKUP_CREATE, 210f5895943SDavid Howells KEY_NEED_WRITE); 211664cceb0SDavid Howells if (IS_ERR(dest_ref)) { 212664cceb0SDavid Howells ret = PTR_ERR(dest_ref); 2131da177e4SLinus Torvalds goto error3; 2141da177e4SLinus Torvalds } 2151da177e4SLinus Torvalds } 2161da177e4SLinus Torvalds 2171da177e4SLinus Torvalds /* find the key type */ 2181da177e4SLinus Torvalds ktype = key_type_lookup(type); 2191da177e4SLinus Torvalds if (IS_ERR(ktype)) { 2201da177e4SLinus Torvalds ret = PTR_ERR(ktype); 2211da177e4SLinus Torvalds goto error4; 2221da177e4SLinus Torvalds } 2231da177e4SLinus Torvalds 2241da177e4SLinus Torvalds /* do the search */ 2254a38e122SDavid Howells key = request_key_and_link(ktype, description, callout_info, 2264a38e122SDavid Howells callout_len, NULL, key_ref_to_ptr(dest_ref), 2277e047ef5SDavid Howells KEY_ALLOC_IN_QUOTA); 2281da177e4SLinus Torvalds if (IS_ERR(key)) { 2291da177e4SLinus Torvalds ret = PTR_ERR(key); 2301da177e4SLinus Torvalds goto error5; 2311da177e4SLinus Torvalds } 2321da177e4SLinus Torvalds 2334aab1e89SDavid Howells /* wait for the key to finish being constructed */ 2344aab1e89SDavid Howells ret = wait_for_key_construction(key, 1); 2354aab1e89SDavid Howells if (ret < 0) 2364aab1e89SDavid Howells goto error6; 2374aab1e89SDavid Howells 2381da177e4SLinus Torvalds ret = key->serial; 2391da177e4SLinus Torvalds 2404aab1e89SDavid Howells error6: 2411da177e4SLinus Torvalds key_put(key); 2421da177e4SLinus Torvalds error5: 2431da177e4SLinus Torvalds key_type_put(ktype); 2441da177e4SLinus Torvalds error4: 245664cceb0SDavid Howells key_ref_put(dest_ref); 2461da177e4SLinus Torvalds error3: 2471da177e4SLinus Torvalds kfree(callout_info); 2481da177e4SLinus Torvalds error2: 2491da177e4SLinus Torvalds kfree(description); 2501da177e4SLinus Torvalds error: 2511da177e4SLinus Torvalds return ret; 252a8b17ed0SDavid Howells } 2531da177e4SLinus Torvalds 2541da177e4SLinus Torvalds /* 255973c9f4fSDavid Howells * Get the ID of the specified process keyring. 256973c9f4fSDavid Howells * 257973c9f4fSDavid Howells * The requested keyring must have search permission to be found. 258973c9f4fSDavid Howells * 259973c9f4fSDavid Howells * If successful, the ID of the requested keyring will be returned. 2601da177e4SLinus Torvalds */ 2611da177e4SLinus Torvalds long keyctl_get_keyring_ID(key_serial_t id, int create) 2621da177e4SLinus Torvalds { 263664cceb0SDavid Howells key_ref_t key_ref; 2645593122eSDavid Howells unsigned long lflags; 2651da177e4SLinus Torvalds long ret; 2661da177e4SLinus Torvalds 2675593122eSDavid Howells lflags = create ? KEY_LOOKUP_CREATE : 0; 268f5895943SDavid Howells key_ref = lookup_user_key(id, lflags, KEY_NEED_SEARCH); 269664cceb0SDavid Howells if (IS_ERR(key_ref)) { 270664cceb0SDavid Howells ret = PTR_ERR(key_ref); 2711da177e4SLinus Torvalds goto error; 2721da177e4SLinus Torvalds } 2731da177e4SLinus Torvalds 274664cceb0SDavid Howells ret = key_ref_to_ptr(key_ref)->serial; 275664cceb0SDavid Howells key_ref_put(key_ref); 2761da177e4SLinus Torvalds error: 2771da177e4SLinus Torvalds return ret; 278973c9f4fSDavid Howells } 2791da177e4SLinus Torvalds 2801da177e4SLinus Torvalds /* 281973c9f4fSDavid Howells * Join a (named) session keyring. 282973c9f4fSDavid Howells * 283973c9f4fSDavid Howells * Create and join an anonymous session keyring or join a named session 284973c9f4fSDavid Howells * keyring, creating it if necessary. A named session keyring must have Search 285973c9f4fSDavid Howells * permission for it to be joined. Session keyrings without this permit will 286ee8f844eSDavid Howells * be skipped over. It is not permitted for userspace to create or join 287ee8f844eSDavid Howells * keyrings whose name begin with a dot. 288973c9f4fSDavid Howells * 289973c9f4fSDavid Howells * If successful, the ID of the joined session keyring will be returned. 2901da177e4SLinus Torvalds */ 2911da177e4SLinus Torvalds long keyctl_join_session_keyring(const char __user *_name) 2921da177e4SLinus Torvalds { 2931da177e4SLinus Torvalds char *name; 2940cb409d9SDavi Arnaut long ret; 2951da177e4SLinus Torvalds 2961da177e4SLinus Torvalds /* fetch the name from userspace */ 2971da177e4SLinus Torvalds name = NULL; 2981da177e4SLinus Torvalds if (_name) { 299aa9d4437SDavid Howells name = strndup_user(_name, KEY_MAX_DESC_SIZE); 3000cb409d9SDavi Arnaut if (IS_ERR(name)) { 3010cb409d9SDavi Arnaut ret = PTR_ERR(name); 3021da177e4SLinus Torvalds goto error; 3030cb409d9SDavi Arnaut } 304ee8f844eSDavid Howells 305ee8f844eSDavid Howells ret = -EPERM; 306ee8f844eSDavid Howells if (name[0] == '.') 307ee8f844eSDavid Howells goto error_name; 3081da177e4SLinus Torvalds } 3091da177e4SLinus Torvalds 3101da177e4SLinus Torvalds /* join the session */ 3111da177e4SLinus Torvalds ret = join_session_keyring(name); 312ee8f844eSDavid Howells error_name: 3130d54ee1cSVegard Nossum kfree(name); 3141da177e4SLinus Torvalds error: 3151da177e4SLinus Torvalds return ret; 316a8b17ed0SDavid Howells } 3171da177e4SLinus Torvalds 3181da177e4SLinus Torvalds /* 319973c9f4fSDavid Howells * Update a key's data payload from the given data. 320973c9f4fSDavid Howells * 321973c9f4fSDavid Howells * The key must grant the caller Write permission and the key type must support 322973c9f4fSDavid Howells * updating for this to work. A negative key can be positively instantiated 323973c9f4fSDavid Howells * with this call. 324973c9f4fSDavid Howells * 325973c9f4fSDavid Howells * If successful, 0 will be returned. If the key type does not support 326973c9f4fSDavid Howells * updating, then -EOPNOTSUPP will be returned. 3271da177e4SLinus Torvalds */ 3281da177e4SLinus Torvalds long keyctl_update_key(key_serial_t id, 3291da177e4SLinus Torvalds const void __user *_payload, 3301da177e4SLinus Torvalds size_t plen) 3311da177e4SLinus Torvalds { 332664cceb0SDavid Howells key_ref_t key_ref; 3331da177e4SLinus Torvalds void *payload; 3341da177e4SLinus Torvalds long ret; 3351da177e4SLinus Torvalds 3361da177e4SLinus Torvalds ret = -EINVAL; 3371da177e4SLinus Torvalds if (plen > PAGE_SIZE) 3381da177e4SLinus Torvalds goto error; 3391da177e4SLinus Torvalds 3401da177e4SLinus Torvalds /* pull the payload in if one was supplied */ 3411da177e4SLinus Torvalds payload = NULL; 3425649645dSEric Biggers if (plen) { 3431da177e4SLinus Torvalds ret = -ENOMEM; 3441da177e4SLinus Torvalds payload = kmalloc(plen, GFP_KERNEL); 3451da177e4SLinus Torvalds if (!payload) 3461da177e4SLinus Torvalds goto error; 3471da177e4SLinus Torvalds 3481da177e4SLinus Torvalds ret = -EFAULT; 3491da177e4SLinus Torvalds if (copy_from_user(payload, _payload, plen) != 0) 3501da177e4SLinus Torvalds goto error2; 3511da177e4SLinus Torvalds } 3521da177e4SLinus Torvalds 3531da177e4SLinus Torvalds /* find the target key (which must be writable) */ 354f5895943SDavid Howells key_ref = lookup_user_key(id, 0, KEY_NEED_WRITE); 355664cceb0SDavid Howells if (IS_ERR(key_ref)) { 356664cceb0SDavid Howells ret = PTR_ERR(key_ref); 3571da177e4SLinus Torvalds goto error2; 3581da177e4SLinus Torvalds } 3591da177e4SLinus Torvalds 3601da177e4SLinus Torvalds /* update the key */ 361664cceb0SDavid Howells ret = key_update(key_ref, payload, plen); 3621da177e4SLinus Torvalds 363664cceb0SDavid Howells key_ref_put(key_ref); 3641da177e4SLinus Torvalds error2: 36557070c85SEric Biggers kzfree(payload); 3661da177e4SLinus Torvalds error: 3671da177e4SLinus Torvalds return ret; 368a8b17ed0SDavid Howells } 3691da177e4SLinus Torvalds 3701da177e4SLinus Torvalds /* 371973c9f4fSDavid Howells * Revoke a key. 372973c9f4fSDavid Howells * 373973c9f4fSDavid Howells * The key must be grant the caller Write or Setattr permission for this to 374973c9f4fSDavid Howells * work. The key type should give up its quota claim when revoked. The key 375973c9f4fSDavid Howells * and any links to the key will be automatically garbage collected after a 376973c9f4fSDavid Howells * certain amount of time (/proc/sys/kernel/keys/gc_delay). 377973c9f4fSDavid Howells * 378d3600bcfSMimi Zohar * Keys with KEY_FLAG_KEEP set should not be revoked. 379d3600bcfSMimi Zohar * 380973c9f4fSDavid Howells * If successful, 0 is returned. 3811da177e4SLinus Torvalds */ 3821da177e4SLinus Torvalds long keyctl_revoke_key(key_serial_t id) 3831da177e4SLinus Torvalds { 384664cceb0SDavid Howells key_ref_t key_ref; 385d3600bcfSMimi Zohar struct key *key; 3861da177e4SLinus Torvalds long ret; 3871da177e4SLinus Torvalds 388f5895943SDavid Howells key_ref = lookup_user_key(id, 0, KEY_NEED_WRITE); 389664cceb0SDavid Howells if (IS_ERR(key_ref)) { 390664cceb0SDavid Howells ret = PTR_ERR(key_ref); 3910c2c9a3fSDavid Howells if (ret != -EACCES) 3921da177e4SLinus Torvalds goto error; 393f5895943SDavid Howells key_ref = lookup_user_key(id, 0, KEY_NEED_SETATTR); 3940c2c9a3fSDavid Howells if (IS_ERR(key_ref)) { 3950c2c9a3fSDavid Howells ret = PTR_ERR(key_ref); 3960c2c9a3fSDavid Howells goto error; 3970c2c9a3fSDavid Howells } 3981da177e4SLinus Torvalds } 3991da177e4SLinus Torvalds 400d3600bcfSMimi Zohar key = key_ref_to_ptr(key_ref); 4011da177e4SLinus Torvalds ret = 0; 4021d6d167cSMimi Zohar if (test_bit(KEY_FLAG_KEEP, &key->flags)) 4031d6d167cSMimi Zohar ret = -EPERM; 4041d6d167cSMimi Zohar else 4051d6d167cSMimi Zohar key_revoke(key); 4061da177e4SLinus Torvalds 407664cceb0SDavid Howells key_ref_put(key_ref); 4081da177e4SLinus Torvalds error: 4091260f801SDavid Howells return ret; 410a8b17ed0SDavid Howells } 4111da177e4SLinus Torvalds 4121da177e4SLinus Torvalds /* 413fd75815fSDavid Howells * Invalidate a key. 414fd75815fSDavid Howells * 415fd75815fSDavid Howells * The key must be grant the caller Invalidate permission for this to work. 416fd75815fSDavid Howells * The key and any links to the key will be automatically garbage collected 417fd75815fSDavid Howells * immediately. 418fd75815fSDavid Howells * 419d3600bcfSMimi Zohar * Keys with KEY_FLAG_KEEP set should not be invalidated. 420d3600bcfSMimi Zohar * 421fd75815fSDavid Howells * If successful, 0 is returned. 422fd75815fSDavid Howells */ 423fd75815fSDavid Howells long keyctl_invalidate_key(key_serial_t id) 424fd75815fSDavid Howells { 425fd75815fSDavid Howells key_ref_t key_ref; 426d3600bcfSMimi Zohar struct key *key; 427fd75815fSDavid Howells long ret; 428fd75815fSDavid Howells 429fd75815fSDavid Howells kenter("%d", id); 430fd75815fSDavid Howells 431f5895943SDavid Howells key_ref = lookup_user_key(id, 0, KEY_NEED_SEARCH); 432fd75815fSDavid Howells if (IS_ERR(key_ref)) { 433fd75815fSDavid Howells ret = PTR_ERR(key_ref); 4340c7774abSDavid Howells 4350c7774abSDavid Howells /* Root is permitted to invalidate certain special keys */ 4360c7774abSDavid Howells if (capable(CAP_SYS_ADMIN)) { 4370c7774abSDavid Howells key_ref = lookup_user_key(id, 0, 0); 4380c7774abSDavid Howells if (IS_ERR(key_ref)) 4390c7774abSDavid Howells goto error; 4400c7774abSDavid Howells if (test_bit(KEY_FLAG_ROOT_CAN_INVAL, 4410c7774abSDavid Howells &key_ref_to_ptr(key_ref)->flags)) 4420c7774abSDavid Howells goto invalidate; 4430c7774abSDavid Howells goto error_put; 4440c7774abSDavid Howells } 4450c7774abSDavid Howells 446fd75815fSDavid Howells goto error; 447fd75815fSDavid Howells } 448fd75815fSDavid Howells 4490c7774abSDavid Howells invalidate: 450d3600bcfSMimi Zohar key = key_ref_to_ptr(key_ref); 451fd75815fSDavid Howells ret = 0; 452d3600bcfSMimi Zohar if (test_bit(KEY_FLAG_KEEP, &key->flags)) 453d3600bcfSMimi Zohar ret = -EPERM; 4541d6d167cSMimi Zohar else 455d3600bcfSMimi Zohar key_invalidate(key); 4560c7774abSDavid Howells error_put: 457fd75815fSDavid Howells key_ref_put(key_ref); 458fd75815fSDavid Howells error: 459fd75815fSDavid Howells kleave(" = %ld", ret); 460fd75815fSDavid Howells return ret; 461fd75815fSDavid Howells } 462fd75815fSDavid Howells 463fd75815fSDavid Howells /* 464973c9f4fSDavid Howells * Clear the specified keyring, creating an empty process keyring if one of the 465973c9f4fSDavid Howells * special keyring IDs is used. 466973c9f4fSDavid Howells * 467d3600bcfSMimi Zohar * The keyring must grant the caller Write permission and not have 468d3600bcfSMimi Zohar * KEY_FLAG_KEEP set for this to work. If successful, 0 will be returned. 4691da177e4SLinus Torvalds */ 4701da177e4SLinus Torvalds long keyctl_keyring_clear(key_serial_t ringid) 4711da177e4SLinus Torvalds { 472664cceb0SDavid Howells key_ref_t keyring_ref; 473d3600bcfSMimi Zohar struct key *keyring; 4741da177e4SLinus Torvalds long ret; 4751da177e4SLinus Torvalds 476f5895943SDavid Howells keyring_ref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE); 477664cceb0SDavid Howells if (IS_ERR(keyring_ref)) { 478664cceb0SDavid Howells ret = PTR_ERR(keyring_ref); 479700920ebSDavid Howells 480700920ebSDavid Howells /* Root is permitted to invalidate certain special keyrings */ 481700920ebSDavid Howells if (capable(CAP_SYS_ADMIN)) { 482700920ebSDavid Howells keyring_ref = lookup_user_key(ringid, 0, 0); 483700920ebSDavid Howells if (IS_ERR(keyring_ref)) 484700920ebSDavid Howells goto error; 485700920ebSDavid Howells if (test_bit(KEY_FLAG_ROOT_CAN_CLEAR, 486700920ebSDavid Howells &key_ref_to_ptr(keyring_ref)->flags)) 487700920ebSDavid Howells goto clear; 488700920ebSDavid Howells goto error_put; 489700920ebSDavid Howells } 490700920ebSDavid Howells 4911da177e4SLinus Torvalds goto error; 4921da177e4SLinus Torvalds } 4931da177e4SLinus Torvalds 494700920ebSDavid Howells clear: 495d3600bcfSMimi Zohar keyring = key_ref_to_ptr(keyring_ref); 496d3600bcfSMimi Zohar if (test_bit(KEY_FLAG_KEEP, &keyring->flags)) 497d3600bcfSMimi Zohar ret = -EPERM; 498d3600bcfSMimi Zohar else 499d3600bcfSMimi Zohar ret = keyring_clear(keyring); 500700920ebSDavid Howells error_put: 501664cceb0SDavid Howells key_ref_put(keyring_ref); 5021da177e4SLinus Torvalds error: 5031da177e4SLinus Torvalds return ret; 504a8b17ed0SDavid Howells } 5051da177e4SLinus Torvalds 5061da177e4SLinus Torvalds /* 507973c9f4fSDavid Howells * Create a link from a keyring to a key if there's no matching key in the 508973c9f4fSDavid Howells * keyring, otherwise replace the link to the matching key with a link to the 509973c9f4fSDavid Howells * new key. 510973c9f4fSDavid Howells * 511973c9f4fSDavid Howells * The key must grant the caller Link permission and the the keyring must grant 512973c9f4fSDavid Howells * the caller Write permission. Furthermore, if an additional link is created, 513973c9f4fSDavid Howells * the keyring's quota will be extended. 514973c9f4fSDavid Howells * 515973c9f4fSDavid Howells * If successful, 0 will be returned. 5161da177e4SLinus Torvalds */ 5171da177e4SLinus Torvalds long keyctl_keyring_link(key_serial_t id, key_serial_t ringid) 5181da177e4SLinus Torvalds { 519664cceb0SDavid Howells key_ref_t keyring_ref, key_ref; 5201da177e4SLinus Torvalds long ret; 5211da177e4SLinus Torvalds 522f5895943SDavid Howells keyring_ref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE); 523664cceb0SDavid Howells if (IS_ERR(keyring_ref)) { 524664cceb0SDavid Howells ret = PTR_ERR(keyring_ref); 5251da177e4SLinus Torvalds goto error; 5261da177e4SLinus Torvalds } 5271da177e4SLinus Torvalds 528f5895943SDavid Howells key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE, KEY_NEED_LINK); 529664cceb0SDavid Howells if (IS_ERR(key_ref)) { 530664cceb0SDavid Howells ret = PTR_ERR(key_ref); 5311da177e4SLinus Torvalds goto error2; 5321da177e4SLinus Torvalds } 5331da177e4SLinus Torvalds 534664cceb0SDavid Howells ret = key_link(key_ref_to_ptr(keyring_ref), key_ref_to_ptr(key_ref)); 5351da177e4SLinus Torvalds 536664cceb0SDavid Howells key_ref_put(key_ref); 5371da177e4SLinus Torvalds error2: 538664cceb0SDavid Howells key_ref_put(keyring_ref); 5391da177e4SLinus Torvalds error: 5401da177e4SLinus Torvalds return ret; 541a8b17ed0SDavid Howells } 5421da177e4SLinus Torvalds 5431da177e4SLinus Torvalds /* 544973c9f4fSDavid Howells * Unlink a key from a keyring. 545973c9f4fSDavid Howells * 546973c9f4fSDavid Howells * The keyring must grant the caller Write permission for this to work; the key 547973c9f4fSDavid Howells * itself need not grant the caller anything. If the last link to a key is 548973c9f4fSDavid Howells * removed then that key will be scheduled for destruction. 549973c9f4fSDavid Howells * 550d3600bcfSMimi Zohar * Keys or keyrings with KEY_FLAG_KEEP set should not be unlinked. 551d3600bcfSMimi Zohar * 552973c9f4fSDavid Howells * If successful, 0 will be returned. 5531da177e4SLinus Torvalds */ 5541da177e4SLinus Torvalds long keyctl_keyring_unlink(key_serial_t id, key_serial_t ringid) 5551da177e4SLinus Torvalds { 556664cceb0SDavid Howells key_ref_t keyring_ref, key_ref; 557d3600bcfSMimi Zohar struct key *keyring, *key; 5581da177e4SLinus Torvalds long ret; 5591da177e4SLinus Torvalds 560f5895943SDavid Howells keyring_ref = lookup_user_key(ringid, 0, KEY_NEED_WRITE); 561664cceb0SDavid Howells if (IS_ERR(keyring_ref)) { 562664cceb0SDavid Howells ret = PTR_ERR(keyring_ref); 5631da177e4SLinus Torvalds goto error; 5641da177e4SLinus Torvalds } 5651da177e4SLinus Torvalds 5665593122eSDavid Howells key_ref = lookup_user_key(id, KEY_LOOKUP_FOR_UNLINK, 0); 567664cceb0SDavid Howells if (IS_ERR(key_ref)) { 568664cceb0SDavid Howells ret = PTR_ERR(key_ref); 5691da177e4SLinus Torvalds goto error2; 5701da177e4SLinus Torvalds } 5711da177e4SLinus Torvalds 572d3600bcfSMimi Zohar keyring = key_ref_to_ptr(keyring_ref); 573d3600bcfSMimi Zohar key = key_ref_to_ptr(key_ref); 574d3600bcfSMimi Zohar if (test_bit(KEY_FLAG_KEEP, &keyring->flags) && 575d3600bcfSMimi Zohar test_bit(KEY_FLAG_KEEP, &key->flags)) 576d3600bcfSMimi Zohar ret = -EPERM; 577d3600bcfSMimi Zohar else 578d3600bcfSMimi Zohar ret = key_unlink(keyring, key); 5791da177e4SLinus Torvalds 580664cceb0SDavid Howells key_ref_put(key_ref); 5811da177e4SLinus Torvalds error2: 582664cceb0SDavid Howells key_ref_put(keyring_ref); 5831da177e4SLinus Torvalds error: 5841da177e4SLinus Torvalds return ret; 585a8b17ed0SDavid Howells } 5861da177e4SLinus Torvalds 5871da177e4SLinus Torvalds /* 588ed0ac5c7SDavid Howells * Move a link to a key from one keyring to another, displacing any matching 589ed0ac5c7SDavid Howells * key from the destination keyring. 590ed0ac5c7SDavid Howells * 591ed0ac5c7SDavid Howells * The key must grant the caller Link permission and both keyrings must grant 592ed0ac5c7SDavid Howells * the caller Write permission. There must also be a link in the from keyring 593ed0ac5c7SDavid Howells * to the key. If both keyrings are the same, nothing is done. 594ed0ac5c7SDavid Howells * 595ed0ac5c7SDavid Howells * If successful, 0 will be returned. 596ed0ac5c7SDavid Howells */ 597ed0ac5c7SDavid Howells long keyctl_keyring_move(key_serial_t id, key_serial_t from_ringid, 598ed0ac5c7SDavid Howells key_serial_t to_ringid, unsigned int flags) 599ed0ac5c7SDavid Howells { 600ed0ac5c7SDavid Howells key_ref_t key_ref, from_ref, to_ref; 601ed0ac5c7SDavid Howells long ret; 602ed0ac5c7SDavid Howells 603ed0ac5c7SDavid Howells if (flags & ~KEYCTL_MOVE_EXCL) 604ed0ac5c7SDavid Howells return -EINVAL; 605ed0ac5c7SDavid Howells 606ed0ac5c7SDavid Howells key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE, KEY_NEED_LINK); 607ed0ac5c7SDavid Howells if (IS_ERR(key_ref)) 608ed0ac5c7SDavid Howells return PTR_ERR(key_ref); 609ed0ac5c7SDavid Howells 610ed0ac5c7SDavid Howells from_ref = lookup_user_key(from_ringid, 0, KEY_NEED_WRITE); 611ed0ac5c7SDavid Howells if (IS_ERR(from_ref)) { 612ed0ac5c7SDavid Howells ret = PTR_ERR(from_ref); 613ed0ac5c7SDavid Howells goto error2; 614ed0ac5c7SDavid Howells } 615ed0ac5c7SDavid Howells 616ed0ac5c7SDavid Howells to_ref = lookup_user_key(to_ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE); 617ed0ac5c7SDavid Howells if (IS_ERR(to_ref)) { 618ed0ac5c7SDavid Howells ret = PTR_ERR(to_ref); 619ed0ac5c7SDavid Howells goto error3; 620ed0ac5c7SDavid Howells } 621ed0ac5c7SDavid Howells 622ed0ac5c7SDavid Howells ret = key_move(key_ref_to_ptr(key_ref), key_ref_to_ptr(from_ref), 623ed0ac5c7SDavid Howells key_ref_to_ptr(to_ref), flags); 624ed0ac5c7SDavid Howells 625ed0ac5c7SDavid Howells key_ref_put(to_ref); 626ed0ac5c7SDavid Howells error3: 627ed0ac5c7SDavid Howells key_ref_put(from_ref); 628ed0ac5c7SDavid Howells error2: 629ed0ac5c7SDavid Howells key_ref_put(key_ref); 630ed0ac5c7SDavid Howells return ret; 631ed0ac5c7SDavid Howells } 632ed0ac5c7SDavid Howells 633ed0ac5c7SDavid Howells /* 634973c9f4fSDavid Howells * Return a description of a key to userspace. 635973c9f4fSDavid Howells * 636973c9f4fSDavid Howells * The key must grant the caller View permission for this to work. 637973c9f4fSDavid Howells * 638973c9f4fSDavid Howells * If there's a buffer, we place up to buflen bytes of data into it formatted 639973c9f4fSDavid Howells * in the following way: 640973c9f4fSDavid Howells * 6411da177e4SLinus Torvalds * type;uid;gid;perm;description<NUL> 642973c9f4fSDavid Howells * 643973c9f4fSDavid Howells * If successful, we return the amount of description available, irrespective 644973c9f4fSDavid Howells * of how much we may have copied into the buffer. 6451da177e4SLinus Torvalds */ 6461da177e4SLinus Torvalds long keyctl_describe_key(key_serial_t keyid, 6471da177e4SLinus Torvalds char __user *buffer, 6481da177e4SLinus Torvalds size_t buflen) 6491da177e4SLinus Torvalds { 6503e30148cSDavid Howells struct key *key, *instkey; 651664cceb0SDavid Howells key_ref_t key_ref; 652aa9d4437SDavid Howells char *infobuf; 6531da177e4SLinus Torvalds long ret; 654aa9d4437SDavid Howells int desclen, infolen; 6551da177e4SLinus Torvalds 656f5895943SDavid Howells key_ref = lookup_user_key(keyid, KEY_LOOKUP_PARTIAL, KEY_NEED_VIEW); 657664cceb0SDavid Howells if (IS_ERR(key_ref)) { 6583e30148cSDavid Howells /* viewing a key under construction is permitted if we have the 6593e30148cSDavid Howells * authorisation token handy */ 660664cceb0SDavid Howells if (PTR_ERR(key_ref) == -EACCES) { 6613e30148cSDavid Howells instkey = key_get_instantiation_authkey(keyid); 6623e30148cSDavid Howells if (!IS_ERR(instkey)) { 6633e30148cSDavid Howells key_put(instkey); 6648bbf4976SDavid Howells key_ref = lookup_user_key(keyid, 6655593122eSDavid Howells KEY_LOOKUP_PARTIAL, 6665593122eSDavid Howells 0); 667664cceb0SDavid Howells if (!IS_ERR(key_ref)) 6683e30148cSDavid Howells goto okay; 6693e30148cSDavid Howells } 6703e30148cSDavid Howells } 6713e30148cSDavid Howells 672664cceb0SDavid Howells ret = PTR_ERR(key_ref); 6731da177e4SLinus Torvalds goto error; 6741da177e4SLinus Torvalds } 6751da177e4SLinus Torvalds 6763e30148cSDavid Howells okay: 677664cceb0SDavid Howells key = key_ref_to_ptr(key_ref); 678aa9d4437SDavid Howells desclen = strlen(key->description); 679664cceb0SDavid Howells 680aa9d4437SDavid Howells /* calculate how much information we're going to return */ 681aa9d4437SDavid Howells ret = -ENOMEM; 682aa9d4437SDavid Howells infobuf = kasprintf(GFP_KERNEL, 683aa9d4437SDavid Howells "%s;%d;%d;%08x;", 68494fd8405SDavid Howells key->type->name, 6859a56c2dbSEric W. Biederman from_kuid_munged(current_user_ns(), key->uid), 6869a56c2dbSEric W. Biederman from_kgid_munged(current_user_ns(), key->gid), 687aa9d4437SDavid Howells key->perm); 688aa9d4437SDavid Howells if (!infobuf) 689aa9d4437SDavid Howells goto error2; 690aa9d4437SDavid Howells infolen = strlen(infobuf); 691aa9d4437SDavid Howells ret = infolen + desclen + 1; 6921da177e4SLinus Torvalds 6931da177e4SLinus Torvalds /* consider returning the data */ 694aa9d4437SDavid Howells if (buffer && buflen >= ret) { 695aa9d4437SDavid Howells if (copy_to_user(buffer, infobuf, infolen) != 0 || 696aa9d4437SDavid Howells copy_to_user(buffer + infolen, key->description, 697aa9d4437SDavid Howells desclen + 1) != 0) 6981da177e4SLinus Torvalds ret = -EFAULT; 6991da177e4SLinus Torvalds } 7001da177e4SLinus Torvalds 701aa9d4437SDavid Howells kfree(infobuf); 7021da177e4SLinus Torvalds error2: 703664cceb0SDavid Howells key_ref_put(key_ref); 7041da177e4SLinus Torvalds error: 7051da177e4SLinus Torvalds return ret; 706a8b17ed0SDavid Howells } 7071da177e4SLinus Torvalds 7081da177e4SLinus Torvalds /* 709973c9f4fSDavid Howells * Search the specified keyring and any keyrings it links to for a matching 710973c9f4fSDavid Howells * key. Only keyrings that grant the caller Search permission will be searched 711973c9f4fSDavid Howells * (this includes the starting keyring). Only keys with Search permission can 712973c9f4fSDavid Howells * be found. 713973c9f4fSDavid Howells * 714973c9f4fSDavid Howells * If successful, the found key will be linked to the destination keyring if 715973c9f4fSDavid Howells * supplied and the key has Link permission, and the found key ID will be 716973c9f4fSDavid Howells * returned. 7171da177e4SLinus Torvalds */ 7181da177e4SLinus Torvalds long keyctl_keyring_search(key_serial_t ringid, 7191da177e4SLinus Torvalds const char __user *_type, 7201da177e4SLinus Torvalds const char __user *_description, 7211da177e4SLinus Torvalds key_serial_t destringid) 7221da177e4SLinus Torvalds { 7231da177e4SLinus Torvalds struct key_type *ktype; 724664cceb0SDavid Howells key_ref_t keyring_ref, key_ref, dest_ref; 7251da177e4SLinus Torvalds char type[32], *description; 7260cb409d9SDavi Arnaut long ret; 7271da177e4SLinus Torvalds 7281da177e4SLinus Torvalds /* pull the type and description into kernel space */ 7290cb409d9SDavi Arnaut ret = key_get_type_from_user(type, _type, sizeof(type)); 7301da177e4SLinus Torvalds if (ret < 0) 7311da177e4SLinus Torvalds goto error; 7321da177e4SLinus Torvalds 733aa9d4437SDavid Howells description = strndup_user(_description, KEY_MAX_DESC_SIZE); 7340cb409d9SDavi Arnaut if (IS_ERR(description)) { 7350cb409d9SDavi Arnaut ret = PTR_ERR(description); 7361da177e4SLinus Torvalds goto error; 7370cb409d9SDavi Arnaut } 7381da177e4SLinus Torvalds 7391da177e4SLinus Torvalds /* get the keyring at which to begin the search */ 740f5895943SDavid Howells keyring_ref = lookup_user_key(ringid, 0, KEY_NEED_SEARCH); 741664cceb0SDavid Howells if (IS_ERR(keyring_ref)) { 742664cceb0SDavid Howells ret = PTR_ERR(keyring_ref); 7431da177e4SLinus Torvalds goto error2; 7441da177e4SLinus Torvalds } 7451da177e4SLinus Torvalds 7461da177e4SLinus Torvalds /* get the destination keyring if specified */ 747664cceb0SDavid Howells dest_ref = NULL; 7481da177e4SLinus Torvalds if (destringid) { 7495593122eSDavid Howells dest_ref = lookup_user_key(destringid, KEY_LOOKUP_CREATE, 750f5895943SDavid Howells KEY_NEED_WRITE); 751664cceb0SDavid Howells if (IS_ERR(dest_ref)) { 752664cceb0SDavid Howells ret = PTR_ERR(dest_ref); 7531da177e4SLinus Torvalds goto error3; 7541da177e4SLinus Torvalds } 7551da177e4SLinus Torvalds } 7561da177e4SLinus Torvalds 7571da177e4SLinus Torvalds /* find the key type */ 7581da177e4SLinus Torvalds ktype = key_type_lookup(type); 7591da177e4SLinus Torvalds if (IS_ERR(ktype)) { 7601da177e4SLinus Torvalds ret = PTR_ERR(ktype); 7611da177e4SLinus Torvalds goto error4; 7621da177e4SLinus Torvalds } 7631da177e4SLinus Torvalds 7641da177e4SLinus Torvalds /* do the search */ 765664cceb0SDavid Howells key_ref = keyring_search(keyring_ref, ktype, description); 766664cceb0SDavid Howells if (IS_ERR(key_ref)) { 767664cceb0SDavid Howells ret = PTR_ERR(key_ref); 7681da177e4SLinus Torvalds 7691da177e4SLinus Torvalds /* treat lack or presence of a negative key the same */ 7701da177e4SLinus Torvalds if (ret == -EAGAIN) 7711da177e4SLinus Torvalds ret = -ENOKEY; 7721da177e4SLinus Torvalds goto error5; 7731da177e4SLinus Torvalds } 7741da177e4SLinus Torvalds 7751da177e4SLinus Torvalds /* link the resulting key to the destination keyring if we can */ 776664cceb0SDavid Howells if (dest_ref) { 777f5895943SDavid Howells ret = key_permission(key_ref, KEY_NEED_LINK); 77829db9190SDavid Howells if (ret < 0) 7791da177e4SLinus Torvalds goto error6; 7801da177e4SLinus Torvalds 781664cceb0SDavid Howells ret = key_link(key_ref_to_ptr(dest_ref), key_ref_to_ptr(key_ref)); 7821da177e4SLinus Torvalds if (ret < 0) 7831da177e4SLinus Torvalds goto error6; 7841da177e4SLinus Torvalds } 7851da177e4SLinus Torvalds 786664cceb0SDavid Howells ret = key_ref_to_ptr(key_ref)->serial; 7871da177e4SLinus Torvalds 7881da177e4SLinus Torvalds error6: 789664cceb0SDavid Howells key_ref_put(key_ref); 7901da177e4SLinus Torvalds error5: 7911da177e4SLinus Torvalds key_type_put(ktype); 7921da177e4SLinus Torvalds error4: 793664cceb0SDavid Howells key_ref_put(dest_ref); 7941da177e4SLinus Torvalds error3: 795664cceb0SDavid Howells key_ref_put(keyring_ref); 7961da177e4SLinus Torvalds error2: 7971da177e4SLinus Torvalds kfree(description); 7981da177e4SLinus Torvalds error: 7991da177e4SLinus Torvalds return ret; 800a8b17ed0SDavid Howells } 8011da177e4SLinus Torvalds 8021da177e4SLinus Torvalds /* 803973c9f4fSDavid Howells * Read a key's payload. 804973c9f4fSDavid Howells * 805973c9f4fSDavid Howells * The key must either grant the caller Read permission, or it must grant the 806973c9f4fSDavid Howells * caller Search permission when searched for from the process keyrings. 807973c9f4fSDavid Howells * 808973c9f4fSDavid Howells * If successful, we place up to buflen bytes of data into the buffer, if one 809973c9f4fSDavid Howells * is provided, and return the amount of data that is available in the key, 810973c9f4fSDavid Howells * irrespective of how much we copied into the buffer. 8111da177e4SLinus Torvalds */ 8121da177e4SLinus Torvalds long keyctl_read_key(key_serial_t keyid, char __user *buffer, size_t buflen) 8131da177e4SLinus Torvalds { 814664cceb0SDavid Howells struct key *key; 815664cceb0SDavid Howells key_ref_t key_ref; 8161da177e4SLinus Torvalds long ret; 8171da177e4SLinus Torvalds 8181da177e4SLinus Torvalds /* find the key first */ 8195593122eSDavid Howells key_ref = lookup_user_key(keyid, 0, 0); 820664cceb0SDavid Howells if (IS_ERR(key_ref)) { 821664cceb0SDavid Howells ret = -ENOKEY; 822664cceb0SDavid Howells goto error; 823664cceb0SDavid Howells } 824664cceb0SDavid Howells 825664cceb0SDavid Howells key = key_ref_to_ptr(key_ref); 826664cceb0SDavid Howells 827363b02daSDavid Howells ret = key_read_state(key); 828363b02daSDavid Howells if (ret < 0) 829363b02daSDavid Howells goto error2; /* Negatively instantiated */ 83037863c43SEric Biggers 8311da177e4SLinus Torvalds /* see if we can read it directly */ 832f5895943SDavid Howells ret = key_permission(key_ref, KEY_NEED_READ); 83329db9190SDavid Howells if (ret == 0) 8341da177e4SLinus Torvalds goto can_read_key; 83529db9190SDavid Howells if (ret != -EACCES) 8367fc0786dSEric Biggers goto error2; 8371da177e4SLinus Torvalds 838664cceb0SDavid Howells /* we can't; see if it's searchable from this process's keyrings 8393e30148cSDavid Howells * - we automatically take account of the fact that it may be 8403e30148cSDavid Howells * dangling off an instantiation key 8413e30148cSDavid Howells */ 842664cceb0SDavid Howells if (!is_key_possessed(key_ref)) { 8431260f801SDavid Howells ret = -EACCES; 8441da177e4SLinus Torvalds goto error2; 8451da177e4SLinus Torvalds } 8461da177e4SLinus Torvalds 8471da177e4SLinus Torvalds /* the key is probably readable - now try to read it */ 8481da177e4SLinus Torvalds can_read_key: 8491da177e4SLinus Torvalds ret = -EOPNOTSUPP; 8501da177e4SLinus Torvalds if (key->type->read) { 851b4a1b4f5SDavid Howells /* Read the data with the semaphore held (since we might sleep) 852b4a1b4f5SDavid Howells * to protect against the key being updated or revoked. 853b4a1b4f5SDavid Howells */ 8541da177e4SLinus Torvalds down_read(&key->sem); 855b4a1b4f5SDavid Howells ret = key_validate(key); 856b4a1b4f5SDavid Howells if (ret == 0) 8571da177e4SLinus Torvalds ret = key->type->read(key, buffer, buflen); 8581da177e4SLinus Torvalds up_read(&key->sem); 8591da177e4SLinus Torvalds } 8601da177e4SLinus Torvalds 8611da177e4SLinus Torvalds error2: 8621da177e4SLinus Torvalds key_put(key); 8631da177e4SLinus Torvalds error: 8641da177e4SLinus Torvalds return ret; 865a8b17ed0SDavid Howells } 8661da177e4SLinus Torvalds 8671da177e4SLinus Torvalds /* 868973c9f4fSDavid Howells * Change the ownership of a key 869973c9f4fSDavid Howells * 870973c9f4fSDavid Howells * The key must grant the caller Setattr permission for this to work, though 871973c9f4fSDavid Howells * the key need not be fully instantiated yet. For the UID to be changed, or 872973c9f4fSDavid Howells * for the GID to be changed to a group the caller is not a member of, the 873973c9f4fSDavid Howells * caller must have sysadmin capability. If either uid or gid is -1 then that 874973c9f4fSDavid Howells * attribute is not changed. 875973c9f4fSDavid Howells * 876973c9f4fSDavid Howells * If the UID is to be changed, the new user must have sufficient quota to 877973c9f4fSDavid Howells * accept the key. The quota deduction will be removed from the old user to 878973c9f4fSDavid Howells * the new user should the attribute be changed. 879973c9f4fSDavid Howells * 880973c9f4fSDavid Howells * If successful, 0 will be returned. 8811da177e4SLinus Torvalds */ 8829a56c2dbSEric W. Biederman long keyctl_chown_key(key_serial_t id, uid_t user, gid_t group) 8831da177e4SLinus Torvalds { 8845801649dSFredrik Tolf struct key_user *newowner, *zapowner = NULL; 8851da177e4SLinus Torvalds struct key *key; 886664cceb0SDavid Howells key_ref_t key_ref; 8871da177e4SLinus Torvalds long ret; 8889a56c2dbSEric W. Biederman kuid_t uid; 8899a56c2dbSEric W. Biederman kgid_t gid; 8909a56c2dbSEric W. Biederman 8919a56c2dbSEric W. Biederman uid = make_kuid(current_user_ns(), user); 8929a56c2dbSEric W. Biederman gid = make_kgid(current_user_ns(), group); 8939a56c2dbSEric W. Biederman ret = -EINVAL; 8949a56c2dbSEric W. Biederman if ((user != (uid_t) -1) && !uid_valid(uid)) 8959a56c2dbSEric W. Biederman goto error; 8969a56c2dbSEric W. Biederman if ((group != (gid_t) -1) && !gid_valid(gid)) 8979a56c2dbSEric W. Biederman goto error; 8981da177e4SLinus Torvalds 8991da177e4SLinus Torvalds ret = 0; 9009a56c2dbSEric W. Biederman if (user == (uid_t) -1 && group == (gid_t) -1) 9011da177e4SLinus Torvalds goto error; 9021da177e4SLinus Torvalds 9035593122eSDavid Howells key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE | KEY_LOOKUP_PARTIAL, 904f5895943SDavid Howells KEY_NEED_SETATTR); 905664cceb0SDavid Howells if (IS_ERR(key_ref)) { 906664cceb0SDavid Howells ret = PTR_ERR(key_ref); 9071da177e4SLinus Torvalds goto error; 9081da177e4SLinus Torvalds } 9091da177e4SLinus Torvalds 910664cceb0SDavid Howells key = key_ref_to_ptr(key_ref); 911664cceb0SDavid Howells 9121da177e4SLinus Torvalds /* make the changes with the locks held to prevent chown/chown races */ 9131da177e4SLinus Torvalds ret = -EACCES; 9141da177e4SLinus Torvalds down_write(&key->sem); 9151da177e4SLinus Torvalds 9161da177e4SLinus Torvalds if (!capable(CAP_SYS_ADMIN)) { 9171da177e4SLinus Torvalds /* only the sysadmin can chown a key to some other UID */ 9189a56c2dbSEric W. Biederman if (user != (uid_t) -1 && !uid_eq(key->uid, uid)) 9195801649dSFredrik Tolf goto error_put; 9201da177e4SLinus Torvalds 9211da177e4SLinus Torvalds /* only the sysadmin can set the key's GID to a group other 9221da177e4SLinus Torvalds * than one of those that the current process subscribes to */ 9239a56c2dbSEric W. Biederman if (group != (gid_t) -1 && !gid_eq(gid, key->gid) && !in_group_p(gid)) 9245801649dSFredrik Tolf goto error_put; 9251da177e4SLinus Torvalds } 9261da177e4SLinus Torvalds 9275801649dSFredrik Tolf /* change the UID */ 9289a56c2dbSEric W. Biederman if (user != (uid_t) -1 && !uid_eq(uid, key->uid)) { 9295801649dSFredrik Tolf ret = -ENOMEM; 9309a56c2dbSEric W. Biederman newowner = key_user_lookup(uid); 9315801649dSFredrik Tolf if (!newowner) 9325801649dSFredrik Tolf goto error_put; 9335801649dSFredrik Tolf 9345801649dSFredrik Tolf /* transfer the quota burden to the new user */ 9355801649dSFredrik Tolf if (test_bit(KEY_FLAG_IN_QUOTA, &key->flags)) { 9369a56c2dbSEric W. Biederman unsigned maxkeys = uid_eq(uid, GLOBAL_ROOT_UID) ? 9370b77f5bfSDavid Howells key_quota_root_maxkeys : key_quota_maxkeys; 9389a56c2dbSEric W. Biederman unsigned maxbytes = uid_eq(uid, GLOBAL_ROOT_UID) ? 9390b77f5bfSDavid Howells key_quota_root_maxbytes : key_quota_maxbytes; 9400b77f5bfSDavid Howells 9415801649dSFredrik Tolf spin_lock(&newowner->lock); 9420b77f5bfSDavid Howells if (newowner->qnkeys + 1 >= maxkeys || 9430b77f5bfSDavid Howells newowner->qnbytes + key->quotalen >= maxbytes || 9440b77f5bfSDavid Howells newowner->qnbytes + key->quotalen < 9450b77f5bfSDavid Howells newowner->qnbytes) 9465801649dSFredrik Tolf goto quota_overrun; 9475801649dSFredrik Tolf 9485801649dSFredrik Tolf newowner->qnkeys++; 9495801649dSFredrik Tolf newowner->qnbytes += key->quotalen; 9505801649dSFredrik Tolf spin_unlock(&newowner->lock); 9515801649dSFredrik Tolf 9525801649dSFredrik Tolf spin_lock(&key->user->lock); 9535801649dSFredrik Tolf key->user->qnkeys--; 9545801649dSFredrik Tolf key->user->qnbytes -= key->quotalen; 9555801649dSFredrik Tolf spin_unlock(&key->user->lock); 9565801649dSFredrik Tolf } 9575801649dSFredrik Tolf 9585801649dSFredrik Tolf atomic_dec(&key->user->nkeys); 9595801649dSFredrik Tolf atomic_inc(&newowner->nkeys); 9605801649dSFredrik Tolf 961363b02daSDavid Howells if (key->state != KEY_IS_UNINSTANTIATED) { 9625801649dSFredrik Tolf atomic_dec(&key->user->nikeys); 9635801649dSFredrik Tolf atomic_inc(&newowner->nikeys); 9645801649dSFredrik Tolf } 9655801649dSFredrik Tolf 9665801649dSFredrik Tolf zapowner = key->user; 9675801649dSFredrik Tolf key->user = newowner; 9685801649dSFredrik Tolf key->uid = uid; 9691da177e4SLinus Torvalds } 9701da177e4SLinus Torvalds 9711da177e4SLinus Torvalds /* change the GID */ 9729a56c2dbSEric W. Biederman if (group != (gid_t) -1) 9731da177e4SLinus Torvalds key->gid = gid; 9741da177e4SLinus Torvalds 9751da177e4SLinus Torvalds ret = 0; 9761da177e4SLinus Torvalds 9775801649dSFredrik Tolf error_put: 9781da177e4SLinus Torvalds up_write(&key->sem); 9791da177e4SLinus Torvalds key_put(key); 9805801649dSFredrik Tolf if (zapowner) 9815801649dSFredrik Tolf key_user_put(zapowner); 9821da177e4SLinus Torvalds error: 9831da177e4SLinus Torvalds return ret; 9841da177e4SLinus Torvalds 9855801649dSFredrik Tolf quota_overrun: 9865801649dSFredrik Tolf spin_unlock(&newowner->lock); 9875801649dSFredrik Tolf zapowner = newowner; 9885801649dSFredrik Tolf ret = -EDQUOT; 9895801649dSFredrik Tolf goto error_put; 990a8b17ed0SDavid Howells } 9915801649dSFredrik Tolf 9921da177e4SLinus Torvalds /* 993973c9f4fSDavid Howells * Change the permission mask on a key. 994973c9f4fSDavid Howells * 995973c9f4fSDavid Howells * The key must grant the caller Setattr permission for this to work, though 996973c9f4fSDavid Howells * the key need not be fully instantiated yet. If the caller does not have 997973c9f4fSDavid Howells * sysadmin capability, it may only change the permission on keys that it owns. 9981da177e4SLinus Torvalds */ 9991da177e4SLinus Torvalds long keyctl_setperm_key(key_serial_t id, key_perm_t perm) 10001da177e4SLinus Torvalds { 10011da177e4SLinus Torvalds struct key *key; 1002664cceb0SDavid Howells key_ref_t key_ref; 10031da177e4SLinus Torvalds long ret; 10041da177e4SLinus Torvalds 10051da177e4SLinus Torvalds ret = -EINVAL; 1006664cceb0SDavid Howells if (perm & ~(KEY_POS_ALL | KEY_USR_ALL | KEY_GRP_ALL | KEY_OTH_ALL)) 10071da177e4SLinus Torvalds goto error; 10081da177e4SLinus Torvalds 10095593122eSDavid Howells key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE | KEY_LOOKUP_PARTIAL, 1010f5895943SDavid Howells KEY_NEED_SETATTR); 1011664cceb0SDavid Howells if (IS_ERR(key_ref)) { 1012664cceb0SDavid Howells ret = PTR_ERR(key_ref); 10131da177e4SLinus Torvalds goto error; 10141da177e4SLinus Torvalds } 10151da177e4SLinus Torvalds 1016664cceb0SDavid Howells key = key_ref_to_ptr(key_ref); 1017664cceb0SDavid Howells 101876d8aeabSDavid Howells /* make the changes with the locks held to prevent chown/chmod races */ 10191da177e4SLinus Torvalds ret = -EACCES; 10201da177e4SLinus Torvalds down_write(&key->sem); 10211da177e4SLinus Torvalds 102276d8aeabSDavid Howells /* if we're not the sysadmin, we can only change a key that we own */ 10239a56c2dbSEric W. Biederman if (capable(CAP_SYS_ADMIN) || uid_eq(key->uid, current_fsuid())) { 10241da177e4SLinus Torvalds key->perm = perm; 10251da177e4SLinus Torvalds ret = 0; 102676d8aeabSDavid Howells } 10271da177e4SLinus Torvalds 10281da177e4SLinus Torvalds up_write(&key->sem); 10291da177e4SLinus Torvalds key_put(key); 10301da177e4SLinus Torvalds error: 10311da177e4SLinus Torvalds return ret; 1032a8b17ed0SDavid Howells } 10331da177e4SLinus Torvalds 10348bbf4976SDavid Howells /* 1035973c9f4fSDavid Howells * Get the destination keyring for instantiation and check that the caller has 1036973c9f4fSDavid Howells * Write permission on it. 10378bbf4976SDavid Howells */ 10388bbf4976SDavid Howells static long get_instantiation_keyring(key_serial_t ringid, 10398bbf4976SDavid Howells struct request_key_auth *rka, 10408bbf4976SDavid Howells struct key **_dest_keyring) 10418bbf4976SDavid Howells { 10428bbf4976SDavid Howells key_ref_t dkref; 10438bbf4976SDavid Howells 10448bbf4976SDavid Howells *_dest_keyring = NULL; 1045eca1bf5bSDavid Howells 1046eca1bf5bSDavid Howells /* just return a NULL pointer if we weren't asked to make a link */ 1047eca1bf5bSDavid Howells if (ringid == 0) 10488bbf4976SDavid Howells return 0; 10498bbf4976SDavid Howells 10508bbf4976SDavid Howells /* if a specific keyring is nominated by ID, then use that */ 10518bbf4976SDavid Howells if (ringid > 0) { 1052f5895943SDavid Howells dkref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE); 10538bbf4976SDavid Howells if (IS_ERR(dkref)) 10548bbf4976SDavid Howells return PTR_ERR(dkref); 10558bbf4976SDavid Howells *_dest_keyring = key_ref_to_ptr(dkref); 10568bbf4976SDavid Howells return 0; 10578bbf4976SDavid Howells } 10588bbf4976SDavid Howells 10598bbf4976SDavid Howells if (ringid == KEY_SPEC_REQKEY_AUTH_KEY) 10608bbf4976SDavid Howells return -EINVAL; 10618bbf4976SDavid Howells 10628bbf4976SDavid Howells /* otherwise specify the destination keyring recorded in the 10638bbf4976SDavid Howells * authorisation key (any KEY_SPEC_*_KEYRING) */ 10648bbf4976SDavid Howells if (ringid >= KEY_SPEC_REQUESTOR_KEYRING) { 106521279cfaSDavid Howells *_dest_keyring = key_get(rka->dest_keyring); 10668bbf4976SDavid Howells return 0; 10678bbf4976SDavid Howells } 10688bbf4976SDavid Howells 10698bbf4976SDavid Howells return -ENOKEY; 10708bbf4976SDavid Howells } 10718bbf4976SDavid Howells 1072d84f4f99SDavid Howells /* 1073973c9f4fSDavid Howells * Change the request_key authorisation key on the current process. 1074d84f4f99SDavid Howells */ 1075d84f4f99SDavid Howells static int keyctl_change_reqkey_auth(struct key *key) 1076d84f4f99SDavid Howells { 1077d84f4f99SDavid Howells struct cred *new; 1078d84f4f99SDavid Howells 1079d84f4f99SDavid Howells new = prepare_creds(); 1080d84f4f99SDavid Howells if (!new) 1081d84f4f99SDavid Howells return -ENOMEM; 1082d84f4f99SDavid Howells 1083d84f4f99SDavid Howells key_put(new->request_key_auth); 1084d84f4f99SDavid Howells new->request_key_auth = key_get(key); 1085d84f4f99SDavid Howells 1086d84f4f99SDavid Howells return commit_creds(new); 1087d84f4f99SDavid Howells } 1088d84f4f99SDavid Howells 10891da177e4SLinus Torvalds /* 1090973c9f4fSDavid Howells * Instantiate a key with the specified payload and link the key into the 1091973c9f4fSDavid Howells * destination keyring if one is given. 1092973c9f4fSDavid Howells * 1093973c9f4fSDavid Howells * The caller must have the appropriate instantiation permit set for this to 1094973c9f4fSDavid Howells * work (see keyctl_assume_authority). No other permissions are required. 1095973c9f4fSDavid Howells * 1096973c9f4fSDavid Howells * If successful, 0 will be returned. 10971da177e4SLinus Torvalds */ 1098ee009e4aSDavid Howells long keyctl_instantiate_key_common(key_serial_t id, 1099b353a1f7SAl Viro struct iov_iter *from, 11001da177e4SLinus Torvalds key_serial_t ringid) 11011da177e4SLinus Torvalds { 1102d84f4f99SDavid Howells const struct cred *cred = current_cred(); 11033e30148cSDavid Howells struct request_key_auth *rka; 11048bbf4976SDavid Howells struct key *instkey, *dest_keyring; 1105b353a1f7SAl Viro size_t plen = from ? iov_iter_count(from) : 0; 11061da177e4SLinus Torvalds void *payload; 11071da177e4SLinus Torvalds long ret; 11081da177e4SLinus Torvalds 1109d84f4f99SDavid Howells kenter("%d,,%zu,%d", id, plen, ringid); 1110d84f4f99SDavid Howells 1111b353a1f7SAl Viro if (!plen) 1112b353a1f7SAl Viro from = NULL; 1113b353a1f7SAl Viro 11141da177e4SLinus Torvalds ret = -EINVAL; 111538bbca6bSDavid Howells if (plen > 1024 * 1024 - 1) 11161da177e4SLinus Torvalds goto error; 11171da177e4SLinus Torvalds 1118b5f545c8SDavid Howells /* the appropriate instantiation authorisation key must have been 1119b5f545c8SDavid Howells * assumed before calling this */ 1120b5f545c8SDavid Howells ret = -EPERM; 1121d84f4f99SDavid Howells instkey = cred->request_key_auth; 1122b5f545c8SDavid Howells if (!instkey) 1123b5f545c8SDavid Howells goto error; 1124b5f545c8SDavid Howells 1125146aa8b1SDavid Howells rka = instkey->payload.data[0]; 1126b5f545c8SDavid Howells if (rka->target_key->serial != id) 1127b5f545c8SDavid Howells goto error; 1128b5f545c8SDavid Howells 11291da177e4SLinus Torvalds /* pull the payload in if one was supplied */ 11301da177e4SLinus Torvalds payload = NULL; 11311da177e4SLinus Torvalds 1132b353a1f7SAl Viro if (from) { 11331da177e4SLinus Torvalds ret = -ENOMEM; 1134752ade68SMichal Hocko payload = kvmalloc(plen, GFP_KERNEL); 11351da177e4SLinus Torvalds if (!payload) 11361da177e4SLinus Torvalds goto error; 11371da177e4SLinus Torvalds 1138b353a1f7SAl Viro ret = -EFAULT; 1139cbbd26b8SAl Viro if (!copy_from_iter_full(payload, plen, from)) 11401da177e4SLinus Torvalds goto error2; 11411da177e4SLinus Torvalds } 11421da177e4SLinus Torvalds 11433e30148cSDavid Howells /* find the destination keyring amongst those belonging to the 11443e30148cSDavid Howells * requesting task */ 11458bbf4976SDavid Howells ret = get_instantiation_keyring(ringid, rka, &dest_keyring); 11468bbf4976SDavid Howells if (ret < 0) 1147b5f545c8SDavid Howells goto error2; 11481da177e4SLinus Torvalds 11491da177e4SLinus Torvalds /* instantiate the key and link it into a keyring */ 11503e30148cSDavid Howells ret = key_instantiate_and_link(rka->target_key, payload, plen, 11518bbf4976SDavid Howells dest_keyring, instkey); 11521da177e4SLinus Torvalds 11538bbf4976SDavid Howells key_put(dest_keyring); 1154b5f545c8SDavid Howells 1155b5f545c8SDavid Howells /* discard the assumed authority if it's just been disabled by 1156b5f545c8SDavid Howells * instantiation of the key */ 1157d84f4f99SDavid Howells if (ret == 0) 1158d84f4f99SDavid Howells keyctl_change_reqkey_auth(NULL); 1159b5f545c8SDavid Howells 11601da177e4SLinus Torvalds error2: 116157070c85SEric Biggers if (payload) { 116257070c85SEric Biggers memzero_explicit(payload, plen); 1163b353a1f7SAl Viro kvfree(payload); 116457070c85SEric Biggers } 11651da177e4SLinus Torvalds error: 11661da177e4SLinus Torvalds return ret; 1167a8b17ed0SDavid Howells } 11681da177e4SLinus Torvalds 11691da177e4SLinus Torvalds /* 1170ee009e4aSDavid Howells * Instantiate a key with the specified payload and link the key into the 1171ee009e4aSDavid Howells * destination keyring if one is given. 1172ee009e4aSDavid Howells * 1173ee009e4aSDavid Howells * The caller must have the appropriate instantiation permit set for this to 1174ee009e4aSDavid Howells * work (see keyctl_assume_authority). No other permissions are required. 1175ee009e4aSDavid Howells * 1176ee009e4aSDavid Howells * If successful, 0 will be returned. 1177ee009e4aSDavid Howells */ 1178ee009e4aSDavid Howells long keyctl_instantiate_key(key_serial_t id, 1179ee009e4aSDavid Howells const void __user *_payload, 1180ee009e4aSDavid Howells size_t plen, 1181ee009e4aSDavid Howells key_serial_t ringid) 1182ee009e4aSDavid Howells { 1183ee009e4aSDavid Howells if (_payload && plen) { 1184b353a1f7SAl Viro struct iovec iov; 1185b353a1f7SAl Viro struct iov_iter from; 1186b353a1f7SAl Viro int ret; 1187ee009e4aSDavid Howells 1188b353a1f7SAl Viro ret = import_single_range(WRITE, (void __user *)_payload, plen, 1189b353a1f7SAl Viro &iov, &from); 1190b353a1f7SAl Viro if (unlikely(ret)) 1191b353a1f7SAl Viro return ret; 1192b353a1f7SAl Viro 1193b353a1f7SAl Viro return keyctl_instantiate_key_common(id, &from, ringid); 1194ee009e4aSDavid Howells } 1195ee009e4aSDavid Howells 1196b353a1f7SAl Viro return keyctl_instantiate_key_common(id, NULL, ringid); 1197ee009e4aSDavid Howells } 1198ee009e4aSDavid Howells 1199ee009e4aSDavid Howells /* 1200ee009e4aSDavid Howells * Instantiate a key with the specified multipart payload and link the key into 1201ee009e4aSDavid Howells * the destination keyring if one is given. 1202ee009e4aSDavid Howells * 1203ee009e4aSDavid Howells * The caller must have the appropriate instantiation permit set for this to 1204ee009e4aSDavid Howells * work (see keyctl_assume_authority). No other permissions are required. 1205ee009e4aSDavid Howells * 1206ee009e4aSDavid Howells * If successful, 0 will be returned. 1207ee009e4aSDavid Howells */ 1208ee009e4aSDavid Howells long keyctl_instantiate_key_iov(key_serial_t id, 1209ee009e4aSDavid Howells const struct iovec __user *_payload_iov, 1210ee009e4aSDavid Howells unsigned ioc, 1211ee009e4aSDavid Howells key_serial_t ringid) 1212ee009e4aSDavid Howells { 1213ee009e4aSDavid Howells struct iovec iovstack[UIO_FASTIOV], *iov = iovstack; 1214b353a1f7SAl Viro struct iov_iter from; 1215ee009e4aSDavid Howells long ret; 1216ee009e4aSDavid Howells 1217b353a1f7SAl Viro if (!_payload_iov) 1218b353a1f7SAl Viro ioc = 0; 1219ee009e4aSDavid Howells 1220b353a1f7SAl Viro ret = import_iovec(WRITE, _payload_iov, ioc, 1221b353a1f7SAl Viro ARRAY_SIZE(iovstack), &iov, &from); 1222ee009e4aSDavid Howells if (ret < 0) 1223b353a1f7SAl Viro return ret; 1224b353a1f7SAl Viro ret = keyctl_instantiate_key_common(id, &from, ringid); 1225ee009e4aSDavid Howells kfree(iov); 1226ee009e4aSDavid Howells return ret; 1227ee009e4aSDavid Howells } 1228ee009e4aSDavid Howells 1229ee009e4aSDavid Howells /* 1230973c9f4fSDavid Howells * Negatively instantiate the key with the given timeout (in seconds) and link 1231973c9f4fSDavid Howells * the key into the destination keyring if one is given. 1232973c9f4fSDavid Howells * 1233973c9f4fSDavid Howells * The caller must have the appropriate instantiation permit set for this to 1234973c9f4fSDavid Howells * work (see keyctl_assume_authority). No other permissions are required. 1235973c9f4fSDavid Howells * 1236973c9f4fSDavid Howells * The key and any links to the key will be automatically garbage collected 1237973c9f4fSDavid Howells * after the timeout expires. 1238973c9f4fSDavid Howells * 1239973c9f4fSDavid Howells * Negative keys are used to rate limit repeated request_key() calls by causing 1240973c9f4fSDavid Howells * them to return -ENOKEY until the negative key expires. 1241973c9f4fSDavid Howells * 1242973c9f4fSDavid Howells * If successful, 0 will be returned. 12431da177e4SLinus Torvalds */ 12441da177e4SLinus Torvalds long keyctl_negate_key(key_serial_t id, unsigned timeout, key_serial_t ringid) 12451da177e4SLinus Torvalds { 1246fdd1b945SDavid Howells return keyctl_reject_key(id, timeout, ENOKEY, ringid); 1247fdd1b945SDavid Howells } 1248fdd1b945SDavid Howells 1249fdd1b945SDavid Howells /* 1250fdd1b945SDavid Howells * Negatively instantiate the key with the given timeout (in seconds) and error 1251fdd1b945SDavid Howells * code and link the key into the destination keyring if one is given. 1252fdd1b945SDavid Howells * 1253fdd1b945SDavid Howells * The caller must have the appropriate instantiation permit set for this to 1254fdd1b945SDavid Howells * work (see keyctl_assume_authority). No other permissions are required. 1255fdd1b945SDavid Howells * 1256fdd1b945SDavid Howells * The key and any links to the key will be automatically garbage collected 1257fdd1b945SDavid Howells * after the timeout expires. 1258fdd1b945SDavid Howells * 1259fdd1b945SDavid Howells * Negative keys are used to rate limit repeated request_key() calls by causing 1260fdd1b945SDavid Howells * them to return the specified error code until the negative key expires. 1261fdd1b945SDavid Howells * 1262fdd1b945SDavid Howells * If successful, 0 will be returned. 1263fdd1b945SDavid Howells */ 1264fdd1b945SDavid Howells long keyctl_reject_key(key_serial_t id, unsigned timeout, unsigned error, 1265fdd1b945SDavid Howells key_serial_t ringid) 1266fdd1b945SDavid Howells { 1267d84f4f99SDavid Howells const struct cred *cred = current_cred(); 12683e30148cSDavid Howells struct request_key_auth *rka; 12698bbf4976SDavid Howells struct key *instkey, *dest_keyring; 12701da177e4SLinus Torvalds long ret; 12711da177e4SLinus Torvalds 1272fdd1b945SDavid Howells kenter("%d,%u,%u,%d", id, timeout, error, ringid); 1273fdd1b945SDavid Howells 1274fdd1b945SDavid Howells /* must be a valid error code and mustn't be a kernel special */ 1275fdd1b945SDavid Howells if (error <= 0 || 1276fdd1b945SDavid Howells error >= MAX_ERRNO || 1277fdd1b945SDavid Howells error == ERESTARTSYS || 1278fdd1b945SDavid Howells error == ERESTARTNOINTR || 1279fdd1b945SDavid Howells error == ERESTARTNOHAND || 1280fdd1b945SDavid Howells error == ERESTART_RESTARTBLOCK) 1281fdd1b945SDavid Howells return -EINVAL; 1282d84f4f99SDavid Howells 1283b5f545c8SDavid Howells /* the appropriate instantiation authorisation key must have been 1284b5f545c8SDavid Howells * assumed before calling this */ 1285b5f545c8SDavid Howells ret = -EPERM; 1286d84f4f99SDavid Howells instkey = cred->request_key_auth; 1287b5f545c8SDavid Howells if (!instkey) 12881da177e4SLinus Torvalds goto error; 12891da177e4SLinus Torvalds 1290146aa8b1SDavid Howells rka = instkey->payload.data[0]; 1291b5f545c8SDavid Howells if (rka->target_key->serial != id) 1292b5f545c8SDavid Howells goto error; 12933e30148cSDavid Howells 12941da177e4SLinus Torvalds /* find the destination keyring if present (which must also be 12951da177e4SLinus Torvalds * writable) */ 12968bbf4976SDavid Howells ret = get_instantiation_keyring(ringid, rka, &dest_keyring); 12978bbf4976SDavid Howells if (ret < 0) 1298b5f545c8SDavid Howells goto error; 12991da177e4SLinus Torvalds 13001da177e4SLinus Torvalds /* instantiate the key and link it into a keyring */ 1301fdd1b945SDavid Howells ret = key_reject_and_link(rka->target_key, timeout, error, 13028bbf4976SDavid Howells dest_keyring, instkey); 13031da177e4SLinus Torvalds 13048bbf4976SDavid Howells key_put(dest_keyring); 1305b5f545c8SDavid Howells 1306b5f545c8SDavid Howells /* discard the assumed authority if it's just been disabled by 1307b5f545c8SDavid Howells * instantiation of the key */ 1308d84f4f99SDavid Howells if (ret == 0) 1309d84f4f99SDavid Howells keyctl_change_reqkey_auth(NULL); 1310b5f545c8SDavid Howells 13111da177e4SLinus Torvalds error: 13121da177e4SLinus Torvalds return ret; 1313a8b17ed0SDavid Howells } 13141da177e4SLinus Torvalds 13151da177e4SLinus Torvalds /* 1316973c9f4fSDavid Howells * Read or set the default keyring in which request_key() will cache keys and 1317973c9f4fSDavid Howells * return the old setting. 1318973c9f4fSDavid Howells * 1319c9f838d1SEric Biggers * If a thread or process keyring is specified then it will be created if it 1320c9f838d1SEric Biggers * doesn't yet exist. The old setting will be returned if successful. 13213e30148cSDavid Howells */ 13223e30148cSDavid Howells long keyctl_set_reqkey_keyring(int reqkey_defl) 13233e30148cSDavid Howells { 1324d84f4f99SDavid Howells struct cred *new; 1325d84f4f99SDavid Howells int ret, old_setting; 1326d84f4f99SDavid Howells 1327d84f4f99SDavid Howells old_setting = current_cred_xxx(jit_keyring); 1328d84f4f99SDavid Howells 1329d84f4f99SDavid Howells if (reqkey_defl == KEY_REQKEY_DEFL_NO_CHANGE) 1330d84f4f99SDavid Howells return old_setting; 1331d84f4f99SDavid Howells 1332d84f4f99SDavid Howells new = prepare_creds(); 1333d84f4f99SDavid Howells if (!new) 1334d84f4f99SDavid Howells return -ENOMEM; 13353e30148cSDavid Howells 13363e30148cSDavid Howells switch (reqkey_defl) { 13373e30148cSDavid Howells case KEY_REQKEY_DEFL_THREAD_KEYRING: 1338d84f4f99SDavid Howells ret = install_thread_keyring_to_cred(new); 13393e30148cSDavid Howells if (ret < 0) 1340d84f4f99SDavid Howells goto error; 13413e30148cSDavid Howells goto set; 13423e30148cSDavid Howells 13433e30148cSDavid Howells case KEY_REQKEY_DEFL_PROCESS_KEYRING: 1344d84f4f99SDavid Howells ret = install_process_keyring_to_cred(new); 1345c9f838d1SEric Biggers if (ret < 0) 1346d84f4f99SDavid Howells goto error; 1347d84f4f99SDavid Howells goto set; 13483e30148cSDavid Howells 13493e30148cSDavid Howells case KEY_REQKEY_DEFL_DEFAULT: 13503e30148cSDavid Howells case KEY_REQKEY_DEFL_SESSION_KEYRING: 13513e30148cSDavid Howells case KEY_REQKEY_DEFL_USER_KEYRING: 13523e30148cSDavid Howells case KEY_REQKEY_DEFL_USER_SESSION_KEYRING: 1353d84f4f99SDavid Howells case KEY_REQKEY_DEFL_REQUESTOR_KEYRING: 1354d84f4f99SDavid Howells goto set; 13553e30148cSDavid Howells 13563e30148cSDavid Howells case KEY_REQKEY_DEFL_NO_CHANGE: 13573e30148cSDavid Howells case KEY_REQKEY_DEFL_GROUP_KEYRING: 13583e30148cSDavid Howells default: 1359d84f4f99SDavid Howells ret = -EINVAL; 1360d84f4f99SDavid Howells goto error; 13613e30148cSDavid Howells } 13623e30148cSDavid Howells 1363d84f4f99SDavid Howells set: 1364d84f4f99SDavid Howells new->jit_keyring = reqkey_defl; 1365d84f4f99SDavid Howells commit_creds(new); 1366d84f4f99SDavid Howells return old_setting; 1367d84f4f99SDavid Howells error: 1368d84f4f99SDavid Howells abort_creds(new); 13694303ef19SDan Carpenter return ret; 1370a8b17ed0SDavid Howells } 1371d84f4f99SDavid Howells 13723e30148cSDavid Howells /* 1373973c9f4fSDavid Howells * Set or clear the timeout on a key. 1374973c9f4fSDavid Howells * 1375973c9f4fSDavid Howells * Either the key must grant the caller Setattr permission or else the caller 1376973c9f4fSDavid Howells * must hold an instantiation authorisation token for the key. 1377973c9f4fSDavid Howells * 1378973c9f4fSDavid Howells * The timeout is either 0 to clear the timeout, or a number of seconds from 1379973c9f4fSDavid Howells * the current time. The key and any links to the key will be automatically 1380973c9f4fSDavid Howells * garbage collected after the timeout expires. 1381973c9f4fSDavid Howells * 1382d3600bcfSMimi Zohar * Keys with KEY_FLAG_KEEP set should not be timed out. 1383d3600bcfSMimi Zohar * 1384973c9f4fSDavid Howells * If successful, 0 is returned. 1385017679c4SDavid Howells */ 1386017679c4SDavid Howells long keyctl_set_timeout(key_serial_t id, unsigned timeout) 1387017679c4SDavid Howells { 13889156235bSDavid Howells struct key *key, *instkey; 1389017679c4SDavid Howells key_ref_t key_ref; 1390017679c4SDavid Howells long ret; 1391017679c4SDavid Howells 13925593122eSDavid Howells key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE | KEY_LOOKUP_PARTIAL, 1393f5895943SDavid Howells KEY_NEED_SETATTR); 1394017679c4SDavid Howells if (IS_ERR(key_ref)) { 13959156235bSDavid Howells /* setting the timeout on a key under construction is permitted 13969156235bSDavid Howells * if we have the authorisation token handy */ 13979156235bSDavid Howells if (PTR_ERR(key_ref) == -EACCES) { 13989156235bSDavid Howells instkey = key_get_instantiation_authkey(id); 13999156235bSDavid Howells if (!IS_ERR(instkey)) { 14009156235bSDavid Howells key_put(instkey); 14019156235bSDavid Howells key_ref = lookup_user_key(id, 14029156235bSDavid Howells KEY_LOOKUP_PARTIAL, 14039156235bSDavid Howells 0); 14049156235bSDavid Howells if (!IS_ERR(key_ref)) 14059156235bSDavid Howells goto okay; 14069156235bSDavid Howells } 14079156235bSDavid Howells } 14089156235bSDavid Howells 1409017679c4SDavid Howells ret = PTR_ERR(key_ref); 1410017679c4SDavid Howells goto error; 1411017679c4SDavid Howells } 1412017679c4SDavid Howells 14139156235bSDavid Howells okay: 1414017679c4SDavid Howells key = key_ref_to_ptr(key_ref); 14151d6d167cSMimi Zohar ret = 0; 1416d3600bcfSMimi Zohar if (test_bit(KEY_FLAG_KEEP, &key->flags)) 1417d3600bcfSMimi Zohar ret = -EPERM; 14181d6d167cSMimi Zohar else 141959e6b9c1SBryan Schumaker key_set_timeout(key, timeout); 1420017679c4SDavid Howells key_put(key); 1421017679c4SDavid Howells 1422017679c4SDavid Howells error: 1423017679c4SDavid Howells return ret; 1424a8b17ed0SDavid Howells } 1425017679c4SDavid Howells 1426017679c4SDavid Howells /* 1427973c9f4fSDavid Howells * Assume (or clear) the authority to instantiate the specified key. 1428973c9f4fSDavid Howells * 1429973c9f4fSDavid Howells * This sets the authoritative token currently in force for key instantiation. 1430973c9f4fSDavid Howells * This must be done for a key to be instantiated. It has the effect of making 1431973c9f4fSDavid Howells * available all the keys from the caller of the request_key() that created a 1432973c9f4fSDavid Howells * key to request_key() calls made by the caller of this function. 1433973c9f4fSDavid Howells * 1434973c9f4fSDavid Howells * The caller must have the instantiation key in their process keyrings with a 1435973c9f4fSDavid Howells * Search permission grant available to the caller. 1436973c9f4fSDavid Howells * 1437973c9f4fSDavid Howells * If the ID given is 0, then the setting will be cleared and 0 returned. 1438973c9f4fSDavid Howells * 1439973c9f4fSDavid Howells * If the ID given has a matching an authorisation key, then that key will be 1440973c9f4fSDavid Howells * set and its ID will be returned. The authorisation key can be read to get 1441973c9f4fSDavid Howells * the callout information passed to request_key(). 1442b5f545c8SDavid Howells */ 1443b5f545c8SDavid Howells long keyctl_assume_authority(key_serial_t id) 1444b5f545c8SDavid Howells { 1445b5f545c8SDavid Howells struct key *authkey; 1446b5f545c8SDavid Howells long ret; 1447b5f545c8SDavid Howells 1448b5f545c8SDavid Howells /* special key IDs aren't permitted */ 1449b5f545c8SDavid Howells ret = -EINVAL; 1450b5f545c8SDavid Howells if (id < 0) 1451b5f545c8SDavid Howells goto error; 1452b5f545c8SDavid Howells 1453b5f545c8SDavid Howells /* we divest ourselves of authority if given an ID of 0 */ 1454b5f545c8SDavid Howells if (id == 0) { 1455d84f4f99SDavid Howells ret = keyctl_change_reqkey_auth(NULL); 1456b5f545c8SDavid Howells goto error; 1457b5f545c8SDavid Howells } 1458b5f545c8SDavid Howells 1459b5f545c8SDavid Howells /* attempt to assume the authority temporarily granted to us whilst we 1460b5f545c8SDavid Howells * instantiate the specified key 1461b5f545c8SDavid Howells * - the authorisation key must be in the current task's keyrings 1462b5f545c8SDavid Howells * somewhere 1463b5f545c8SDavid Howells */ 1464b5f545c8SDavid Howells authkey = key_get_instantiation_authkey(id); 1465b5f545c8SDavid Howells if (IS_ERR(authkey)) { 1466b5f545c8SDavid Howells ret = PTR_ERR(authkey); 1467b5f545c8SDavid Howells goto error; 1468b5f545c8SDavid Howells } 1469b5f545c8SDavid Howells 1470d84f4f99SDavid Howells ret = keyctl_change_reqkey_auth(authkey); 1471884bee02SEric Biggers if (ret == 0) 1472d84f4f99SDavid Howells ret = authkey->serial; 1473884bee02SEric Biggers key_put(authkey); 1474b5f545c8SDavid Howells error: 1475b5f545c8SDavid Howells return ret; 1476a8b17ed0SDavid Howells } 1477b5f545c8SDavid Howells 147870a5bb72SDavid Howells /* 1479973c9f4fSDavid Howells * Get a key's the LSM security label. 1480973c9f4fSDavid Howells * 1481973c9f4fSDavid Howells * The key must grant the caller View permission for this to work. 1482973c9f4fSDavid Howells * 1483973c9f4fSDavid Howells * If there's a buffer, then up to buflen bytes of data will be placed into it. 1484973c9f4fSDavid Howells * 1485973c9f4fSDavid Howells * If successful, the amount of information available will be returned, 1486973c9f4fSDavid Howells * irrespective of how much was copied (including the terminal NUL). 148770a5bb72SDavid Howells */ 148870a5bb72SDavid Howells long keyctl_get_security(key_serial_t keyid, 148970a5bb72SDavid Howells char __user *buffer, 149070a5bb72SDavid Howells size_t buflen) 149170a5bb72SDavid Howells { 149270a5bb72SDavid Howells struct key *key, *instkey; 149370a5bb72SDavid Howells key_ref_t key_ref; 149470a5bb72SDavid Howells char *context; 149570a5bb72SDavid Howells long ret; 149670a5bb72SDavid Howells 1497f5895943SDavid Howells key_ref = lookup_user_key(keyid, KEY_LOOKUP_PARTIAL, KEY_NEED_VIEW); 149870a5bb72SDavid Howells if (IS_ERR(key_ref)) { 149970a5bb72SDavid Howells if (PTR_ERR(key_ref) != -EACCES) 150070a5bb72SDavid Howells return PTR_ERR(key_ref); 150170a5bb72SDavid Howells 150270a5bb72SDavid Howells /* viewing a key under construction is also permitted if we 150370a5bb72SDavid Howells * have the authorisation token handy */ 150470a5bb72SDavid Howells instkey = key_get_instantiation_authkey(keyid); 150570a5bb72SDavid Howells if (IS_ERR(instkey)) 1506fa1cc7b5SRoel Kluin return PTR_ERR(instkey); 150770a5bb72SDavid Howells key_put(instkey); 150870a5bb72SDavid Howells 15095593122eSDavid Howells key_ref = lookup_user_key(keyid, KEY_LOOKUP_PARTIAL, 0); 151070a5bb72SDavid Howells if (IS_ERR(key_ref)) 151170a5bb72SDavid Howells return PTR_ERR(key_ref); 151270a5bb72SDavid Howells } 151370a5bb72SDavid Howells 151470a5bb72SDavid Howells key = key_ref_to_ptr(key_ref); 151570a5bb72SDavid Howells ret = security_key_getsecurity(key, &context); 151670a5bb72SDavid Howells if (ret == 0) { 151770a5bb72SDavid Howells /* if no information was returned, give userspace an empty 151870a5bb72SDavid Howells * string */ 151970a5bb72SDavid Howells ret = 1; 152070a5bb72SDavid Howells if (buffer && buflen > 0 && 152170a5bb72SDavid Howells copy_to_user(buffer, "", 1) != 0) 152270a5bb72SDavid Howells ret = -EFAULT; 152370a5bb72SDavid Howells } else if (ret > 0) { 152470a5bb72SDavid Howells /* return as much data as there's room for */ 152570a5bb72SDavid Howells if (buffer && buflen > 0) { 152670a5bb72SDavid Howells if (buflen > ret) 152770a5bb72SDavid Howells buflen = ret; 152870a5bb72SDavid Howells 152970a5bb72SDavid Howells if (copy_to_user(buffer, context, buflen) != 0) 153070a5bb72SDavid Howells ret = -EFAULT; 153170a5bb72SDavid Howells } 153270a5bb72SDavid Howells 153370a5bb72SDavid Howells kfree(context); 153470a5bb72SDavid Howells } 153570a5bb72SDavid Howells 153670a5bb72SDavid Howells key_ref_put(key_ref); 153770a5bb72SDavid Howells return ret; 153870a5bb72SDavid Howells } 153970a5bb72SDavid Howells 1540ee18d64cSDavid Howells /* 1541973c9f4fSDavid Howells * Attempt to install the calling process's session keyring on the process's 1542973c9f4fSDavid Howells * parent process. 1543973c9f4fSDavid Howells * 1544973c9f4fSDavid Howells * The keyring must exist and must grant the caller LINK permission, and the 1545973c9f4fSDavid Howells * parent process must be single-threaded and must have the same effective 1546973c9f4fSDavid Howells * ownership as this process and mustn't be SUID/SGID. 1547973c9f4fSDavid Howells * 1548973c9f4fSDavid Howells * The keyring will be emplaced on the parent when it next resumes userspace. 1549973c9f4fSDavid Howells * 1550973c9f4fSDavid Howells * If successful, 0 will be returned. 1551ee18d64cSDavid Howells */ 1552ee18d64cSDavid Howells long keyctl_session_to_parent(void) 1553ee18d64cSDavid Howells { 1554ee18d64cSDavid Howells struct task_struct *me, *parent; 1555ee18d64cSDavid Howells const struct cred *mycred, *pcred; 155667d12145SAl Viro struct callback_head *newwork, *oldwork; 1557ee18d64cSDavid Howells key_ref_t keyring_r; 1558413cd3d9SOleg Nesterov struct cred *cred; 1559ee18d64cSDavid Howells int ret; 1560ee18d64cSDavid Howells 1561f5895943SDavid Howells keyring_r = lookup_user_key(KEY_SPEC_SESSION_KEYRING, 0, KEY_NEED_LINK); 1562ee18d64cSDavid Howells if (IS_ERR(keyring_r)) 1563ee18d64cSDavid Howells return PTR_ERR(keyring_r); 1564ee18d64cSDavid Howells 1565413cd3d9SOleg Nesterov ret = -ENOMEM; 1566413cd3d9SOleg Nesterov 1567ee18d64cSDavid Howells /* our parent is going to need a new cred struct, a new tgcred struct 1568ee18d64cSDavid Howells * and new security data, so we allocate them here to prevent ENOMEM in 1569ee18d64cSDavid Howells * our parent */ 1570ee18d64cSDavid Howells cred = cred_alloc_blank(); 1571ee18d64cSDavid Howells if (!cred) 157267d12145SAl Viro goto error_keyring; 157367d12145SAl Viro newwork = &cred->rcu; 1574ee18d64cSDavid Howells 15753a50597dSDavid Howells cred->session_keyring = key_ref_to_ptr(keyring_r); 15763a50597dSDavid Howells keyring_r = NULL; 157767d12145SAl Viro init_task_work(newwork, key_change_session_keyring); 1578ee18d64cSDavid Howells 1579ee18d64cSDavid Howells me = current; 15809d1ac65aSDavid Howells rcu_read_lock(); 1581ee18d64cSDavid Howells write_lock_irq(&tasklist_lock); 1582ee18d64cSDavid Howells 1583ee18d64cSDavid Howells ret = -EPERM; 1584413cd3d9SOleg Nesterov oldwork = NULL; 15857936d16dSDavid Howells parent = rcu_dereference_protected(me->real_parent, 15867936d16dSDavid Howells lockdep_is_held(&tasklist_lock)); 1587ee18d64cSDavid Howells 1588ee18d64cSDavid Howells /* the parent mustn't be init and mustn't be a kernel thread */ 1589ee18d64cSDavid Howells if (parent->pid <= 1 || !parent->mm) 1590413cd3d9SOleg Nesterov goto unlock; 1591ee18d64cSDavid Howells 1592ee18d64cSDavid Howells /* the parent must be single threaded */ 1593dd98acf7SOleg Nesterov if (!thread_group_empty(parent)) 1594413cd3d9SOleg Nesterov goto unlock; 1595ee18d64cSDavid Howells 1596ee18d64cSDavid Howells /* the parent and the child must have different session keyrings or 1597ee18d64cSDavid Howells * there's no point */ 1598ee18d64cSDavid Howells mycred = current_cred(); 1599ee18d64cSDavid Howells pcred = __task_cred(parent); 1600ee18d64cSDavid Howells if (mycred == pcred || 16013a50597dSDavid Howells mycred->session_keyring == pcred->session_keyring) { 1602413cd3d9SOleg Nesterov ret = 0; 1603413cd3d9SOleg Nesterov goto unlock; 1604413cd3d9SOleg Nesterov } 1605ee18d64cSDavid Howells 1606ee18d64cSDavid Howells /* the parent must have the same effective ownership and mustn't be 1607ee18d64cSDavid Howells * SUID/SGID */ 16089a56c2dbSEric W. Biederman if (!uid_eq(pcred->uid, mycred->euid) || 16099a56c2dbSEric W. Biederman !uid_eq(pcred->euid, mycred->euid) || 16109a56c2dbSEric W. Biederman !uid_eq(pcred->suid, mycred->euid) || 16119a56c2dbSEric W. Biederman !gid_eq(pcred->gid, mycred->egid) || 16129a56c2dbSEric W. Biederman !gid_eq(pcred->egid, mycred->egid) || 16139a56c2dbSEric W. Biederman !gid_eq(pcred->sgid, mycred->egid)) 1614413cd3d9SOleg Nesterov goto unlock; 1615ee18d64cSDavid Howells 1616ee18d64cSDavid Howells /* the keyrings must have the same UID */ 16173a50597dSDavid Howells if ((pcred->session_keyring && 16182a74dbb9SLinus Torvalds !uid_eq(pcred->session_keyring->uid, mycred->euid)) || 16192a74dbb9SLinus Torvalds !uid_eq(mycred->session_keyring->uid, mycred->euid)) 1620413cd3d9SOleg Nesterov goto unlock; 1621ee18d64cSDavid Howells 1622413cd3d9SOleg Nesterov /* cancel an already pending keyring replacement */ 1623413cd3d9SOleg Nesterov oldwork = task_work_cancel(parent, key_change_session_keyring); 1624ee18d64cSDavid Howells 1625ee18d64cSDavid Howells /* the replacement session keyring is applied just prior to userspace 1626ee18d64cSDavid Howells * restarting */ 162767d12145SAl Viro ret = task_work_add(parent, newwork, true); 1628413cd3d9SOleg Nesterov if (!ret) 1629413cd3d9SOleg Nesterov newwork = NULL; 1630413cd3d9SOleg Nesterov unlock: 1631ee18d64cSDavid Howells write_unlock_irq(&tasklist_lock); 16329d1ac65aSDavid Howells rcu_read_unlock(); 163367d12145SAl Viro if (oldwork) 163467d12145SAl Viro put_cred(container_of(oldwork, struct cred, rcu)); 163567d12145SAl Viro if (newwork) 163667d12145SAl Viro put_cred(cred); 1637ee18d64cSDavid Howells return ret; 1638ee18d64cSDavid Howells 1639ee18d64cSDavid Howells error_keyring: 1640ee18d64cSDavid Howells key_ref_put(keyring_r); 1641ee18d64cSDavid Howells return ret; 1642ee18d64cSDavid Howells } 1643ee18d64cSDavid Howells 1644b5f545c8SDavid Howells /* 16456563c91fSMat Martineau * Apply a restriction to a given keyring. 16466563c91fSMat Martineau * 16476563c91fSMat Martineau * The caller must have Setattr permission to change keyring restrictions. 16486563c91fSMat Martineau * 16496563c91fSMat Martineau * The requested type name may be a NULL pointer to reject all attempts 165018026d86SEric Biggers * to link to the keyring. In this case, _restriction must also be NULL. 165118026d86SEric Biggers * Otherwise, both _type and _restriction must be non-NULL. 16526563c91fSMat Martineau * 16536563c91fSMat Martineau * Returns 0 if successful. 16546563c91fSMat Martineau */ 16556563c91fSMat Martineau long keyctl_restrict_keyring(key_serial_t id, const char __user *_type, 16566563c91fSMat Martineau const char __user *_restriction) 16576563c91fSMat Martineau { 16586563c91fSMat Martineau key_ref_t key_ref; 16596563c91fSMat Martineau char type[32]; 16606563c91fSMat Martineau char *restriction = NULL; 16616563c91fSMat Martineau long ret; 16626563c91fSMat Martineau 16636563c91fSMat Martineau key_ref = lookup_user_key(id, 0, KEY_NEED_SETATTR); 16646563c91fSMat Martineau if (IS_ERR(key_ref)) 16656563c91fSMat Martineau return PTR_ERR(key_ref); 16666563c91fSMat Martineau 166718026d86SEric Biggers ret = -EINVAL; 16686563c91fSMat Martineau if (_type) { 166918026d86SEric Biggers if (!_restriction) 167018026d86SEric Biggers goto error; 167118026d86SEric Biggers 16726563c91fSMat Martineau ret = key_get_type_from_user(type, _type, sizeof(type)); 16736563c91fSMat Martineau if (ret < 0) 16746563c91fSMat Martineau goto error; 16756563c91fSMat Martineau 16766563c91fSMat Martineau restriction = strndup_user(_restriction, PAGE_SIZE); 16776563c91fSMat Martineau if (IS_ERR(restriction)) { 16786563c91fSMat Martineau ret = PTR_ERR(restriction); 16796563c91fSMat Martineau goto error; 16806563c91fSMat Martineau } 168118026d86SEric Biggers } else { 168218026d86SEric Biggers if (_restriction) 168318026d86SEric Biggers goto error; 16846563c91fSMat Martineau } 16856563c91fSMat Martineau 168618026d86SEric Biggers ret = keyring_restrict(key_ref, _type ? type : NULL, restriction); 16876563c91fSMat Martineau kfree(restriction); 16886563c91fSMat Martineau error: 16896563c91fSMat Martineau key_ref_put(key_ref); 16906563c91fSMat Martineau return ret; 16916563c91fSMat Martineau } 16926563c91fSMat Martineau 16936563c91fSMat Martineau /* 1694*45e0f30cSDavid Howells * Get keyrings subsystem capabilities. 1695*45e0f30cSDavid Howells */ 1696*45e0f30cSDavid Howells long keyctl_capabilities(unsigned char __user *_buffer, size_t buflen) 1697*45e0f30cSDavid Howells { 1698*45e0f30cSDavid Howells size_t size = buflen; 1699*45e0f30cSDavid Howells 1700*45e0f30cSDavid Howells if (size > 0) { 1701*45e0f30cSDavid Howells if (size > sizeof(keyrings_capabilities)) 1702*45e0f30cSDavid Howells size = sizeof(keyrings_capabilities); 1703*45e0f30cSDavid Howells if (copy_to_user(_buffer, keyrings_capabilities, size) != 0) 1704*45e0f30cSDavid Howells return -EFAULT; 1705*45e0f30cSDavid Howells if (size < buflen && 1706*45e0f30cSDavid Howells clear_user(_buffer + size, buflen - size) != 0) 1707*45e0f30cSDavid Howells return -EFAULT; 1708*45e0f30cSDavid Howells } 1709*45e0f30cSDavid Howells 1710*45e0f30cSDavid Howells return sizeof(keyrings_capabilities); 1711*45e0f30cSDavid Howells } 1712*45e0f30cSDavid Howells 1713*45e0f30cSDavid Howells /* 1714973c9f4fSDavid Howells * The key control system call 17151da177e4SLinus Torvalds */ 1716938bb9f5SHeiko Carstens SYSCALL_DEFINE5(keyctl, int, option, unsigned long, arg2, unsigned long, arg3, 1717938bb9f5SHeiko Carstens unsigned long, arg4, unsigned long, arg5) 17181da177e4SLinus Torvalds { 17191da177e4SLinus Torvalds switch (option) { 17201da177e4SLinus Torvalds case KEYCTL_GET_KEYRING_ID: 17211da177e4SLinus Torvalds return keyctl_get_keyring_ID((key_serial_t) arg2, 17221da177e4SLinus Torvalds (int) arg3); 17231da177e4SLinus Torvalds 17241da177e4SLinus Torvalds case KEYCTL_JOIN_SESSION_KEYRING: 17251da177e4SLinus Torvalds return keyctl_join_session_keyring((const char __user *) arg2); 17261da177e4SLinus Torvalds 17271da177e4SLinus Torvalds case KEYCTL_UPDATE: 17281da177e4SLinus Torvalds return keyctl_update_key((key_serial_t) arg2, 17291da177e4SLinus Torvalds (const void __user *) arg3, 17301da177e4SLinus Torvalds (size_t) arg4); 17311da177e4SLinus Torvalds 17321da177e4SLinus Torvalds case KEYCTL_REVOKE: 17331da177e4SLinus Torvalds return keyctl_revoke_key((key_serial_t) arg2); 17341da177e4SLinus Torvalds 17351da177e4SLinus Torvalds case KEYCTL_DESCRIBE: 17361da177e4SLinus Torvalds return keyctl_describe_key((key_serial_t) arg2, 17371da177e4SLinus Torvalds (char __user *) arg3, 17381da177e4SLinus Torvalds (unsigned) arg4); 17391da177e4SLinus Torvalds 17401da177e4SLinus Torvalds case KEYCTL_CLEAR: 17411da177e4SLinus Torvalds return keyctl_keyring_clear((key_serial_t) arg2); 17421da177e4SLinus Torvalds 17431da177e4SLinus Torvalds case KEYCTL_LINK: 17441da177e4SLinus Torvalds return keyctl_keyring_link((key_serial_t) arg2, 17451da177e4SLinus Torvalds (key_serial_t) arg3); 17461da177e4SLinus Torvalds 17471da177e4SLinus Torvalds case KEYCTL_UNLINK: 17481da177e4SLinus Torvalds return keyctl_keyring_unlink((key_serial_t) arg2, 17491da177e4SLinus Torvalds (key_serial_t) arg3); 17501da177e4SLinus Torvalds 17511da177e4SLinus Torvalds case KEYCTL_SEARCH: 17521da177e4SLinus Torvalds return keyctl_keyring_search((key_serial_t) arg2, 17531da177e4SLinus Torvalds (const char __user *) arg3, 17541da177e4SLinus Torvalds (const char __user *) arg4, 17551da177e4SLinus Torvalds (key_serial_t) arg5); 17561da177e4SLinus Torvalds 17571da177e4SLinus Torvalds case KEYCTL_READ: 17581da177e4SLinus Torvalds return keyctl_read_key((key_serial_t) arg2, 17591da177e4SLinus Torvalds (char __user *) arg3, 17601da177e4SLinus Torvalds (size_t) arg4); 17611da177e4SLinus Torvalds 17621da177e4SLinus Torvalds case KEYCTL_CHOWN: 17631da177e4SLinus Torvalds return keyctl_chown_key((key_serial_t) arg2, 17641da177e4SLinus Torvalds (uid_t) arg3, 17651da177e4SLinus Torvalds (gid_t) arg4); 17661da177e4SLinus Torvalds 17671da177e4SLinus Torvalds case KEYCTL_SETPERM: 17681da177e4SLinus Torvalds return keyctl_setperm_key((key_serial_t) arg2, 17691da177e4SLinus Torvalds (key_perm_t) arg3); 17701da177e4SLinus Torvalds 17711da177e4SLinus Torvalds case KEYCTL_INSTANTIATE: 17721da177e4SLinus Torvalds return keyctl_instantiate_key((key_serial_t) arg2, 17731da177e4SLinus Torvalds (const void __user *) arg3, 17741da177e4SLinus Torvalds (size_t) arg4, 17751da177e4SLinus Torvalds (key_serial_t) arg5); 17761da177e4SLinus Torvalds 17771da177e4SLinus Torvalds case KEYCTL_NEGATE: 17781da177e4SLinus Torvalds return keyctl_negate_key((key_serial_t) arg2, 17791da177e4SLinus Torvalds (unsigned) arg3, 17801da177e4SLinus Torvalds (key_serial_t) arg4); 17811da177e4SLinus Torvalds 17823e30148cSDavid Howells case KEYCTL_SET_REQKEY_KEYRING: 17833e30148cSDavid Howells return keyctl_set_reqkey_keyring(arg2); 17843e30148cSDavid Howells 1785017679c4SDavid Howells case KEYCTL_SET_TIMEOUT: 1786017679c4SDavid Howells return keyctl_set_timeout((key_serial_t) arg2, 1787017679c4SDavid Howells (unsigned) arg3); 1788017679c4SDavid Howells 1789b5f545c8SDavid Howells case KEYCTL_ASSUME_AUTHORITY: 1790b5f545c8SDavid Howells return keyctl_assume_authority((key_serial_t) arg2); 1791b5f545c8SDavid Howells 179270a5bb72SDavid Howells case KEYCTL_GET_SECURITY: 179370a5bb72SDavid Howells return keyctl_get_security((key_serial_t) arg2, 179490bd49abSJames Morris (char __user *) arg3, 179570a5bb72SDavid Howells (size_t) arg4); 179670a5bb72SDavid Howells 1797ee18d64cSDavid Howells case KEYCTL_SESSION_TO_PARENT: 1798ee18d64cSDavid Howells return keyctl_session_to_parent(); 1799ee18d64cSDavid Howells 1800fdd1b945SDavid Howells case KEYCTL_REJECT: 1801fdd1b945SDavid Howells return keyctl_reject_key((key_serial_t) arg2, 1802fdd1b945SDavid Howells (unsigned) arg3, 1803fdd1b945SDavid Howells (unsigned) arg4, 1804fdd1b945SDavid Howells (key_serial_t) arg5); 1805fdd1b945SDavid Howells 1806ee009e4aSDavid Howells case KEYCTL_INSTANTIATE_IOV: 1807ee009e4aSDavid Howells return keyctl_instantiate_key_iov( 1808ee009e4aSDavid Howells (key_serial_t) arg2, 1809ee009e4aSDavid Howells (const struct iovec __user *) arg3, 1810ee009e4aSDavid Howells (unsigned) arg4, 1811ee009e4aSDavid Howells (key_serial_t) arg5); 1812ee009e4aSDavid Howells 1813fd75815fSDavid Howells case KEYCTL_INVALIDATE: 1814fd75815fSDavid Howells return keyctl_invalidate_key((key_serial_t) arg2); 1815fd75815fSDavid Howells 1816f36f8c75SDavid Howells case KEYCTL_GET_PERSISTENT: 1817f36f8c75SDavid Howells return keyctl_get_persistent((uid_t)arg2, (key_serial_t)arg3); 1818f36f8c75SDavid Howells 1819ddbb4114SMat Martineau case KEYCTL_DH_COMPUTE: 1820ddbb4114SMat Martineau return keyctl_dh_compute((struct keyctl_dh_params __user *) arg2, 18214693fc73SStephan Mueller (char __user *) arg3, (size_t) arg4, 1822f1c316a3SStephan Mueller (struct keyctl_kdf_params __user *) arg5); 1823ddbb4114SMat Martineau 18246563c91fSMat Martineau case KEYCTL_RESTRICT_KEYRING: 18256563c91fSMat Martineau return keyctl_restrict_keyring((key_serial_t) arg2, 18266563c91fSMat Martineau (const char __user *) arg3, 18276563c91fSMat Martineau (const char __user *) arg4); 18281da177e4SLinus Torvalds 182900d60fd3SDavid Howells case KEYCTL_PKEY_QUERY: 183000d60fd3SDavid Howells if (arg3 != 0) 183100d60fd3SDavid Howells return -EINVAL; 183200d60fd3SDavid Howells return keyctl_pkey_query((key_serial_t)arg2, 183300d60fd3SDavid Howells (const char __user *)arg4, 1834468e91ceSBen Dooks (struct keyctl_pkey_query __user *)arg5); 183500d60fd3SDavid Howells 183600d60fd3SDavid Howells case KEYCTL_PKEY_ENCRYPT: 183700d60fd3SDavid Howells case KEYCTL_PKEY_DECRYPT: 183800d60fd3SDavid Howells case KEYCTL_PKEY_SIGN: 183900d60fd3SDavid Howells return keyctl_pkey_e_d_s( 184000d60fd3SDavid Howells option, 184100d60fd3SDavid Howells (const struct keyctl_pkey_params __user *)arg2, 184200d60fd3SDavid Howells (const char __user *)arg3, 184300d60fd3SDavid Howells (const void __user *)arg4, 184400d60fd3SDavid Howells (void __user *)arg5); 184500d60fd3SDavid Howells 184600d60fd3SDavid Howells case KEYCTL_PKEY_VERIFY: 184700d60fd3SDavid Howells return keyctl_pkey_verify( 184800d60fd3SDavid Howells (const struct keyctl_pkey_params __user *)arg2, 184900d60fd3SDavid Howells (const char __user *)arg3, 185000d60fd3SDavid Howells (const void __user *)arg4, 185100d60fd3SDavid Howells (const void __user *)arg5); 185200d60fd3SDavid Howells 1853ed0ac5c7SDavid Howells case KEYCTL_MOVE: 1854ed0ac5c7SDavid Howells return keyctl_keyring_move((key_serial_t)arg2, 1855ed0ac5c7SDavid Howells (key_serial_t)arg3, 1856ed0ac5c7SDavid Howells (key_serial_t)arg4, 1857ed0ac5c7SDavid Howells (unsigned int)arg5); 1858ed0ac5c7SDavid Howells 1859*45e0f30cSDavid Howells case KEYCTL_CAPABILITIES: 1860*45e0f30cSDavid Howells return keyctl_capabilities((unsigned char __user *)arg2, (size_t)arg3); 1861*45e0f30cSDavid Howells 18621da177e4SLinus Torvalds default: 18631da177e4SLinus Torvalds return -EOPNOTSUPP; 18641da177e4SLinus Torvalds } 18651da177e4SLinus Torvalds } 1866