xref: /openbmc/linux/security/keys/keyctl.c (revision 6563c91f)
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/module.h>
131da177e4SLinus Torvalds #include <linux/init.h>
141da177e4SLinus Torvalds #include <linux/sched.h>
1529930025SIngo Molnar #include <linux/sched/task.h>
161da177e4SLinus Torvalds #include <linux/slab.h>
171da177e4SLinus Torvalds #include <linux/syscalls.h>
1859e6b9c1SBryan Schumaker #include <linux/key.h>
191da177e4SLinus Torvalds #include <linux/keyctl.h>
201da177e4SLinus Torvalds #include <linux/fs.h>
21c59ede7bSRandy.Dunlap #include <linux/capability.h>
225b825c3aSIngo Molnar #include <linux/cred.h>
230cb409d9SDavi Arnaut #include <linux/string.h>
241da177e4SLinus Torvalds #include <linux/err.h>
2538bbca6bSDavid Howells #include <linux/vmalloc.h>
2670a5bb72SDavid Howells #include <linux/security.h>
27a27bb332SKent Overstreet #include <linux/uio.h>
287c0f6ba6SLinus Torvalds #include <linux/uaccess.h>
291da177e4SLinus Torvalds #include "internal.h"
301da177e4SLinus Torvalds 
31aa9d4437SDavid Howells #define KEY_MAX_DESC_SIZE 4096
32aa9d4437SDavid Howells 
330cb409d9SDavi Arnaut static int key_get_type_from_user(char *type,
340cb409d9SDavi Arnaut 				  const char __user *_type,
350cb409d9SDavi Arnaut 				  unsigned len)
360cb409d9SDavi Arnaut {
370cb409d9SDavi Arnaut 	int ret;
380cb409d9SDavi Arnaut 
390cb409d9SDavi Arnaut 	ret = strncpy_from_user(type, _type, len);
400cb409d9SDavi Arnaut 	if (ret < 0)
414303ef19SDan Carpenter 		return ret;
420cb409d9SDavi Arnaut 	if (ret == 0 || ret >= len)
430cb409d9SDavi Arnaut 		return -EINVAL;
4454e2c2c1SDavid Howells 	if (type[0] == '.')
4554e2c2c1SDavid Howells 		return -EPERM;
460cb409d9SDavi Arnaut 	type[len - 1] = '\0';
470cb409d9SDavi Arnaut 	return 0;
480cb409d9SDavi Arnaut }
490cb409d9SDavi Arnaut 
501da177e4SLinus Torvalds /*
51973c9f4fSDavid Howells  * Extract the description of a new key from userspace and either add it as a
52973c9f4fSDavid Howells  * new key to the specified keyring or update a matching key in that keyring.
53973c9f4fSDavid Howells  *
54cf7f601cSDavid Howells  * If the description is NULL or an empty string, the key type is asked to
55cf7f601cSDavid Howells  * generate one from the payload.
56cf7f601cSDavid Howells  *
57973c9f4fSDavid Howells  * The keyring must be writable so that we can attach the key to it.
58973c9f4fSDavid Howells  *
59973c9f4fSDavid Howells  * If successful, the new key's serial number is returned, otherwise an error
60973c9f4fSDavid Howells  * code is returned.
611da177e4SLinus Torvalds  */
621e7bfb21SHeiko Carstens SYSCALL_DEFINE5(add_key, const char __user *, _type,
631e7bfb21SHeiko Carstens 		const char __user *, _description,
641e7bfb21SHeiko Carstens 		const void __user *, _payload,
651e7bfb21SHeiko Carstens 		size_t, plen,
661e7bfb21SHeiko Carstens 		key_serial_t, ringid)
671da177e4SLinus Torvalds {
68664cceb0SDavid Howells 	key_ref_t keyring_ref, key_ref;
691da177e4SLinus Torvalds 	char type[32], *description;
701da177e4SLinus Torvalds 	void *payload;
710cb409d9SDavi Arnaut 	long ret;
721da177e4SLinus Torvalds 
731da177e4SLinus Torvalds 	ret = -EINVAL;
7438bbca6bSDavid Howells 	if (plen > 1024 * 1024 - 1)
751da177e4SLinus Torvalds 		goto error;
761da177e4SLinus Torvalds 
771da177e4SLinus Torvalds 	/* draw all the data into kernel space */
780cb409d9SDavi Arnaut 	ret = key_get_type_from_user(type, _type, sizeof(type));
791da177e4SLinus Torvalds 	if (ret < 0)
801da177e4SLinus Torvalds 		goto error;
811da177e4SLinus Torvalds 
82cf7f601cSDavid Howells 	description = NULL;
83cf7f601cSDavid Howells 	if (_description) {
84aa9d4437SDavid Howells 		description = strndup_user(_description, KEY_MAX_DESC_SIZE);
850cb409d9SDavi Arnaut 		if (IS_ERR(description)) {
860cb409d9SDavi Arnaut 			ret = PTR_ERR(description);
873e30148cSDavid Howells 			goto error;
880cb409d9SDavi Arnaut 		}
89cf7f601cSDavid Howells 		if (!*description) {
90cf7f601cSDavid Howells 			kfree(description);
91cf7f601cSDavid Howells 			description = NULL;
92a4e3b8d7SMimi Zohar 		} else if ((description[0] == '.') &&
93a4e3b8d7SMimi Zohar 			   (strncmp(type, "keyring", 7) == 0)) {
94a4e3b8d7SMimi Zohar 			ret = -EPERM;
95a4e3b8d7SMimi Zohar 			goto error2;
96cf7f601cSDavid Howells 		}
97cf7f601cSDavid Howells 	}
981da177e4SLinus Torvalds 
991da177e4SLinus Torvalds 	/* pull the payload in if one was supplied */
1001da177e4SLinus Torvalds 	payload = NULL;
1011da177e4SLinus Torvalds 
1021da177e4SLinus Torvalds 	if (_payload) {
1031da177e4SLinus Torvalds 		ret = -ENOMEM;
1044f1c28d2SAndrew Morton 		payload = kmalloc(plen, GFP_KERNEL | __GFP_NOWARN);
10538bbca6bSDavid Howells 		if (!payload) {
10638bbca6bSDavid Howells 			if (plen <= PAGE_SIZE)
10738bbca6bSDavid Howells 				goto error2;
10838bbca6bSDavid Howells 			payload = vmalloc(plen);
1091da177e4SLinus Torvalds 			if (!payload)
1101da177e4SLinus Torvalds 				goto error2;
11138bbca6bSDavid Howells 		}
1121da177e4SLinus Torvalds 
1131da177e4SLinus Torvalds 		ret = -EFAULT;
1141da177e4SLinus Torvalds 		if (copy_from_user(payload, _payload, plen) != 0)
1151da177e4SLinus Torvalds 			goto error3;
1161da177e4SLinus Torvalds 	}
1171da177e4SLinus Torvalds 
1181da177e4SLinus Torvalds 	/* find the target keyring (which must be writable) */
119f5895943SDavid Howells 	keyring_ref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE);
120664cceb0SDavid Howells 	if (IS_ERR(keyring_ref)) {
121664cceb0SDavid Howells 		ret = PTR_ERR(keyring_ref);
1221da177e4SLinus Torvalds 		goto error3;
1231da177e4SLinus Torvalds 	}
1241da177e4SLinus Torvalds 
1251da177e4SLinus Torvalds 	/* create or update the requested key and add it to the target
1261da177e4SLinus Torvalds 	 * keyring */
127664cceb0SDavid Howells 	key_ref = key_create_or_update(keyring_ref, type, description,
1286b79ccb5SArun Raghavan 				       payload, plen, KEY_PERM_UNDEF,
1296b79ccb5SArun Raghavan 				       KEY_ALLOC_IN_QUOTA);
130664cceb0SDavid Howells 	if (!IS_ERR(key_ref)) {
131664cceb0SDavid Howells 		ret = key_ref_to_ptr(key_ref)->serial;
132664cceb0SDavid Howells 		key_ref_put(key_ref);
1331da177e4SLinus Torvalds 	}
1341da177e4SLinus Torvalds 	else {
135664cceb0SDavid Howells 		ret = PTR_ERR(key_ref);
1361da177e4SLinus Torvalds 	}
1371da177e4SLinus Torvalds 
138664cceb0SDavid Howells 	key_ref_put(keyring_ref);
1391da177e4SLinus Torvalds  error3:
140d0e0eba0SGeliang Tang 	kvfree(payload);
1411da177e4SLinus Torvalds  error2:
1421da177e4SLinus Torvalds 	kfree(description);
1431da177e4SLinus Torvalds  error:
1441da177e4SLinus Torvalds 	return ret;
145a8b17ed0SDavid Howells }
1461da177e4SLinus Torvalds 
1471da177e4SLinus Torvalds /*
148973c9f4fSDavid Howells  * Search the process keyrings and keyring trees linked from those for a
149973c9f4fSDavid Howells  * matching key.  Keyrings must have appropriate Search permission to be
150973c9f4fSDavid Howells  * searched.
151973c9f4fSDavid Howells  *
152973c9f4fSDavid Howells  * If a key is found, it will be attached to the destination keyring if there's
153973c9f4fSDavid Howells  * one specified and the serial number of the key will be returned.
154973c9f4fSDavid Howells  *
155973c9f4fSDavid Howells  * If no key is found, /sbin/request-key will be invoked if _callout_info is
156973c9f4fSDavid Howells  * non-NULL in an attempt to create a key.  The _callout_info string will be
157973c9f4fSDavid Howells  * passed to /sbin/request-key to aid with completing the request.  If the
158973c9f4fSDavid Howells  * _callout_info string is "" then it will be changed to "-".
1591da177e4SLinus Torvalds  */
1601e7bfb21SHeiko Carstens SYSCALL_DEFINE4(request_key, const char __user *, _type,
1611e7bfb21SHeiko Carstens 		const char __user *, _description,
1621e7bfb21SHeiko Carstens 		const char __user *, _callout_info,
1631e7bfb21SHeiko Carstens 		key_serial_t, destringid)
1641da177e4SLinus Torvalds {
1651da177e4SLinus Torvalds 	struct key_type *ktype;
166664cceb0SDavid Howells 	struct key *key;
167664cceb0SDavid Howells 	key_ref_t dest_ref;
1684a38e122SDavid Howells 	size_t callout_len;
1691da177e4SLinus Torvalds 	char type[32], *description, *callout_info;
1700cb409d9SDavi Arnaut 	long ret;
1711da177e4SLinus Torvalds 
1721da177e4SLinus Torvalds 	/* pull the type into kernel space */
1730cb409d9SDavi Arnaut 	ret = key_get_type_from_user(type, _type, sizeof(type));
1741da177e4SLinus Torvalds 	if (ret < 0)
1751da177e4SLinus Torvalds 		goto error;
1761260f801SDavid Howells 
1771da177e4SLinus Torvalds 	/* pull the description into kernel space */
178aa9d4437SDavid Howells 	description = strndup_user(_description, KEY_MAX_DESC_SIZE);
1790cb409d9SDavi Arnaut 	if (IS_ERR(description)) {
1800cb409d9SDavi Arnaut 		ret = PTR_ERR(description);
1811da177e4SLinus Torvalds 		goto error;
1820cb409d9SDavi Arnaut 	}
1831da177e4SLinus Torvalds 
1841da177e4SLinus Torvalds 	/* pull the callout info into kernel space */
1851da177e4SLinus Torvalds 	callout_info = NULL;
1864a38e122SDavid Howells 	callout_len = 0;
1871da177e4SLinus Torvalds 	if (_callout_info) {
1880cb409d9SDavi Arnaut 		callout_info = strndup_user(_callout_info, PAGE_SIZE);
1890cb409d9SDavi Arnaut 		if (IS_ERR(callout_info)) {
1900cb409d9SDavi Arnaut 			ret = PTR_ERR(callout_info);
1911da177e4SLinus Torvalds 			goto error2;
1920cb409d9SDavi Arnaut 		}
1934a38e122SDavid Howells 		callout_len = strlen(callout_info);
1941da177e4SLinus Torvalds 	}
1951da177e4SLinus Torvalds 
1961da177e4SLinus Torvalds 	/* get the destination keyring if specified */
197664cceb0SDavid Howells 	dest_ref = NULL;
1981da177e4SLinus Torvalds 	if (destringid) {
1995593122eSDavid Howells 		dest_ref = lookup_user_key(destringid, KEY_LOOKUP_CREATE,
200f5895943SDavid Howells 					   KEY_NEED_WRITE);
201664cceb0SDavid Howells 		if (IS_ERR(dest_ref)) {
202664cceb0SDavid Howells 			ret = PTR_ERR(dest_ref);
2031da177e4SLinus Torvalds 			goto error3;
2041da177e4SLinus Torvalds 		}
2051da177e4SLinus Torvalds 	}
2061da177e4SLinus Torvalds 
2071da177e4SLinus Torvalds 	/* find the key type */
2081da177e4SLinus Torvalds 	ktype = key_type_lookup(type);
2091da177e4SLinus Torvalds 	if (IS_ERR(ktype)) {
2101da177e4SLinus Torvalds 		ret = PTR_ERR(ktype);
2111da177e4SLinus Torvalds 		goto error4;
2121da177e4SLinus Torvalds 	}
2131da177e4SLinus Torvalds 
2141da177e4SLinus Torvalds 	/* do the search */
2154a38e122SDavid Howells 	key = request_key_and_link(ktype, description, callout_info,
2164a38e122SDavid Howells 				   callout_len, NULL, key_ref_to_ptr(dest_ref),
2177e047ef5SDavid Howells 				   KEY_ALLOC_IN_QUOTA);
2181da177e4SLinus Torvalds 	if (IS_ERR(key)) {
2191da177e4SLinus Torvalds 		ret = PTR_ERR(key);
2201da177e4SLinus Torvalds 		goto error5;
2211da177e4SLinus Torvalds 	}
2221da177e4SLinus Torvalds 
2234aab1e89SDavid Howells 	/* wait for the key to finish being constructed */
2244aab1e89SDavid Howells 	ret = wait_for_key_construction(key, 1);
2254aab1e89SDavid Howells 	if (ret < 0)
2264aab1e89SDavid Howells 		goto error6;
2274aab1e89SDavid Howells 
2281da177e4SLinus Torvalds 	ret = key->serial;
2291da177e4SLinus Torvalds 
2304aab1e89SDavid Howells error6:
2311da177e4SLinus Torvalds  	key_put(key);
2321da177e4SLinus Torvalds error5:
2331da177e4SLinus Torvalds 	key_type_put(ktype);
2341da177e4SLinus Torvalds error4:
235664cceb0SDavid Howells 	key_ref_put(dest_ref);
2361da177e4SLinus Torvalds error3:
2371da177e4SLinus Torvalds 	kfree(callout_info);
2381da177e4SLinus Torvalds error2:
2391da177e4SLinus Torvalds 	kfree(description);
2401da177e4SLinus Torvalds error:
2411da177e4SLinus Torvalds 	return ret;
242a8b17ed0SDavid Howells }
2431da177e4SLinus Torvalds 
2441da177e4SLinus Torvalds /*
245973c9f4fSDavid Howells  * Get the ID of the specified process keyring.
246973c9f4fSDavid Howells  *
247973c9f4fSDavid Howells  * The requested keyring must have search permission to be found.
248973c9f4fSDavid Howells  *
249973c9f4fSDavid Howells  * If successful, the ID of the requested keyring will be returned.
2501da177e4SLinus Torvalds  */
2511da177e4SLinus Torvalds long keyctl_get_keyring_ID(key_serial_t id, int create)
2521da177e4SLinus Torvalds {
253664cceb0SDavid Howells 	key_ref_t key_ref;
2545593122eSDavid Howells 	unsigned long lflags;
2551da177e4SLinus Torvalds 	long ret;
2561da177e4SLinus Torvalds 
2575593122eSDavid Howells 	lflags = create ? KEY_LOOKUP_CREATE : 0;
258f5895943SDavid Howells 	key_ref = lookup_user_key(id, lflags, KEY_NEED_SEARCH);
259664cceb0SDavid Howells 	if (IS_ERR(key_ref)) {
260664cceb0SDavid Howells 		ret = PTR_ERR(key_ref);
2611da177e4SLinus Torvalds 		goto error;
2621da177e4SLinus Torvalds 	}
2631da177e4SLinus Torvalds 
264664cceb0SDavid Howells 	ret = key_ref_to_ptr(key_ref)->serial;
265664cceb0SDavid Howells 	key_ref_put(key_ref);
2661da177e4SLinus Torvalds error:
2671da177e4SLinus Torvalds 	return ret;
268973c9f4fSDavid Howells }
2691da177e4SLinus Torvalds 
2701da177e4SLinus Torvalds /*
271973c9f4fSDavid Howells  * Join a (named) session keyring.
272973c9f4fSDavid Howells  *
273973c9f4fSDavid Howells  * Create and join an anonymous session keyring or join a named session
274973c9f4fSDavid Howells  * keyring, creating it if necessary.  A named session keyring must have Search
275973c9f4fSDavid Howells  * permission for it to be joined.  Session keyrings without this permit will
276973c9f4fSDavid Howells  * be skipped over.
277973c9f4fSDavid Howells  *
278973c9f4fSDavid Howells  * If successful, the ID of the joined session keyring will be returned.
2791da177e4SLinus Torvalds  */
2801da177e4SLinus Torvalds long keyctl_join_session_keyring(const char __user *_name)
2811da177e4SLinus Torvalds {
2821da177e4SLinus Torvalds 	char *name;
2830cb409d9SDavi Arnaut 	long ret;
2841da177e4SLinus Torvalds 
2851da177e4SLinus Torvalds 	/* fetch the name from userspace */
2861da177e4SLinus Torvalds 	name = NULL;
2871da177e4SLinus Torvalds 	if (_name) {
288aa9d4437SDavid Howells 		name = strndup_user(_name, KEY_MAX_DESC_SIZE);
2890cb409d9SDavi Arnaut 		if (IS_ERR(name)) {
2900cb409d9SDavi Arnaut 			ret = PTR_ERR(name);
2911da177e4SLinus Torvalds 			goto error;
2920cb409d9SDavi Arnaut 		}
2931da177e4SLinus Torvalds 	}
2941da177e4SLinus Torvalds 
2951da177e4SLinus Torvalds 	/* join the session */
2961da177e4SLinus Torvalds 	ret = join_session_keyring(name);
2970d54ee1cSVegard Nossum 	kfree(name);
2981da177e4SLinus Torvalds 
2991da177e4SLinus Torvalds error:
3001da177e4SLinus Torvalds 	return ret;
301a8b17ed0SDavid Howells }
3021da177e4SLinus Torvalds 
3031da177e4SLinus Torvalds /*
304973c9f4fSDavid Howells  * Update a key's data payload from the given data.
305973c9f4fSDavid Howells  *
306973c9f4fSDavid Howells  * The key must grant the caller Write permission and the key type must support
307973c9f4fSDavid Howells  * updating for this to work.  A negative key can be positively instantiated
308973c9f4fSDavid Howells  * with this call.
309973c9f4fSDavid Howells  *
310973c9f4fSDavid Howells  * If successful, 0 will be returned.  If the key type does not support
311973c9f4fSDavid Howells  * updating, then -EOPNOTSUPP will be returned.
3121da177e4SLinus Torvalds  */
3131da177e4SLinus Torvalds long keyctl_update_key(key_serial_t id,
3141da177e4SLinus Torvalds 		       const void __user *_payload,
3151da177e4SLinus Torvalds 		       size_t plen)
3161da177e4SLinus Torvalds {
317664cceb0SDavid Howells 	key_ref_t key_ref;
3181da177e4SLinus Torvalds 	void *payload;
3191da177e4SLinus Torvalds 	long ret;
3201da177e4SLinus Torvalds 
3211da177e4SLinus Torvalds 	ret = -EINVAL;
3221da177e4SLinus Torvalds 	if (plen > PAGE_SIZE)
3231da177e4SLinus Torvalds 		goto error;
3241da177e4SLinus Torvalds 
3251da177e4SLinus Torvalds 	/* pull the payload in if one was supplied */
3261da177e4SLinus Torvalds 	payload = NULL;
3271da177e4SLinus Torvalds 	if (_payload) {
3281da177e4SLinus Torvalds 		ret = -ENOMEM;
3291da177e4SLinus Torvalds 		payload = kmalloc(plen, GFP_KERNEL);
3301da177e4SLinus Torvalds 		if (!payload)
3311da177e4SLinus Torvalds 			goto error;
3321da177e4SLinus Torvalds 
3331da177e4SLinus Torvalds 		ret = -EFAULT;
3341da177e4SLinus Torvalds 		if (copy_from_user(payload, _payload, plen) != 0)
3351da177e4SLinus Torvalds 			goto error2;
3361da177e4SLinus Torvalds 	}
3371da177e4SLinus Torvalds 
3381da177e4SLinus Torvalds 	/* find the target key (which must be writable) */
339f5895943SDavid Howells 	key_ref = lookup_user_key(id, 0, KEY_NEED_WRITE);
340664cceb0SDavid Howells 	if (IS_ERR(key_ref)) {
341664cceb0SDavid Howells 		ret = PTR_ERR(key_ref);
3421da177e4SLinus Torvalds 		goto error2;
3431da177e4SLinus Torvalds 	}
3441da177e4SLinus Torvalds 
3451da177e4SLinus Torvalds 	/* update the key */
346664cceb0SDavid Howells 	ret = key_update(key_ref, payload, plen);
3471da177e4SLinus Torvalds 
348664cceb0SDavid Howells 	key_ref_put(key_ref);
3491da177e4SLinus Torvalds error2:
3501da177e4SLinus Torvalds 	kfree(payload);
3511da177e4SLinus Torvalds error:
3521da177e4SLinus Torvalds 	return ret;
353a8b17ed0SDavid Howells }
3541da177e4SLinus Torvalds 
3551da177e4SLinus Torvalds /*
356973c9f4fSDavid Howells  * Revoke a key.
357973c9f4fSDavid Howells  *
358973c9f4fSDavid Howells  * The key must be grant the caller Write or Setattr permission for this to
359973c9f4fSDavid Howells  * work.  The key type should give up its quota claim when revoked.  The key
360973c9f4fSDavid Howells  * and any links to the key will be automatically garbage collected after a
361973c9f4fSDavid Howells  * certain amount of time (/proc/sys/kernel/keys/gc_delay).
362973c9f4fSDavid Howells  *
363d3600bcfSMimi Zohar  * Keys with KEY_FLAG_KEEP set should not be revoked.
364d3600bcfSMimi Zohar  *
365973c9f4fSDavid Howells  * If successful, 0 is returned.
3661da177e4SLinus Torvalds  */
3671da177e4SLinus Torvalds long keyctl_revoke_key(key_serial_t id)
3681da177e4SLinus Torvalds {
369664cceb0SDavid Howells 	key_ref_t key_ref;
370d3600bcfSMimi Zohar 	struct key *key;
3711da177e4SLinus Torvalds 	long ret;
3721da177e4SLinus Torvalds 
373f5895943SDavid Howells 	key_ref = lookup_user_key(id, 0, KEY_NEED_WRITE);
374664cceb0SDavid Howells 	if (IS_ERR(key_ref)) {
375664cceb0SDavid Howells 		ret = PTR_ERR(key_ref);
3760c2c9a3fSDavid Howells 		if (ret != -EACCES)
3771da177e4SLinus Torvalds 			goto error;
378f5895943SDavid Howells 		key_ref = lookup_user_key(id, 0, KEY_NEED_SETATTR);
3790c2c9a3fSDavid Howells 		if (IS_ERR(key_ref)) {
3800c2c9a3fSDavid Howells 			ret = PTR_ERR(key_ref);
3810c2c9a3fSDavid Howells 			goto error;
3820c2c9a3fSDavid Howells 		}
3831da177e4SLinus Torvalds 	}
3841da177e4SLinus Torvalds 
385d3600bcfSMimi Zohar 	key = key_ref_to_ptr(key_ref);
3861da177e4SLinus Torvalds 	ret = 0;
3871d6d167cSMimi Zohar 	if (test_bit(KEY_FLAG_KEEP, &key->flags))
3881d6d167cSMimi Zohar 		ret = -EPERM;
3891d6d167cSMimi Zohar 	else
3901d6d167cSMimi Zohar 		key_revoke(key);
3911da177e4SLinus Torvalds 
392664cceb0SDavid Howells 	key_ref_put(key_ref);
3931da177e4SLinus Torvalds error:
3941260f801SDavid Howells 	return ret;
395a8b17ed0SDavid Howells }
3961da177e4SLinus Torvalds 
3971da177e4SLinus Torvalds /*
398fd75815fSDavid Howells  * Invalidate a key.
399fd75815fSDavid Howells  *
400fd75815fSDavid Howells  * The key must be grant the caller Invalidate permission for this to work.
401fd75815fSDavid Howells  * The key and any links to the key will be automatically garbage collected
402fd75815fSDavid Howells  * immediately.
403fd75815fSDavid Howells  *
404d3600bcfSMimi Zohar  * Keys with KEY_FLAG_KEEP set should not be invalidated.
405d3600bcfSMimi Zohar  *
406fd75815fSDavid Howells  * If successful, 0 is returned.
407fd75815fSDavid Howells  */
408fd75815fSDavid Howells long keyctl_invalidate_key(key_serial_t id)
409fd75815fSDavid Howells {
410fd75815fSDavid Howells 	key_ref_t key_ref;
411d3600bcfSMimi Zohar 	struct key *key;
412fd75815fSDavid Howells 	long ret;
413fd75815fSDavid Howells 
414fd75815fSDavid Howells 	kenter("%d", id);
415fd75815fSDavid Howells 
416f5895943SDavid Howells 	key_ref = lookup_user_key(id, 0, KEY_NEED_SEARCH);
417fd75815fSDavid Howells 	if (IS_ERR(key_ref)) {
418fd75815fSDavid Howells 		ret = PTR_ERR(key_ref);
4190c7774abSDavid Howells 
4200c7774abSDavid Howells 		/* Root is permitted to invalidate certain special keys */
4210c7774abSDavid Howells 		if (capable(CAP_SYS_ADMIN)) {
4220c7774abSDavid Howells 			key_ref = lookup_user_key(id, 0, 0);
4230c7774abSDavid Howells 			if (IS_ERR(key_ref))
4240c7774abSDavid Howells 				goto error;
4250c7774abSDavid Howells 			if (test_bit(KEY_FLAG_ROOT_CAN_INVAL,
4260c7774abSDavid Howells 				     &key_ref_to_ptr(key_ref)->flags))
4270c7774abSDavid Howells 				goto invalidate;
4280c7774abSDavid Howells 			goto error_put;
4290c7774abSDavid Howells 		}
4300c7774abSDavid Howells 
431fd75815fSDavid Howells 		goto error;
432fd75815fSDavid Howells 	}
433fd75815fSDavid Howells 
4340c7774abSDavid Howells invalidate:
435d3600bcfSMimi Zohar 	key = key_ref_to_ptr(key_ref);
436fd75815fSDavid Howells 	ret = 0;
437d3600bcfSMimi Zohar 	if (test_bit(KEY_FLAG_KEEP, &key->flags))
438d3600bcfSMimi Zohar 		ret = -EPERM;
4391d6d167cSMimi Zohar 	else
440d3600bcfSMimi Zohar 		key_invalidate(key);
4410c7774abSDavid Howells error_put:
442fd75815fSDavid Howells 	key_ref_put(key_ref);
443fd75815fSDavid Howells error:
444fd75815fSDavid Howells 	kleave(" = %ld", ret);
445fd75815fSDavid Howells 	return ret;
446fd75815fSDavid Howells }
447fd75815fSDavid Howells 
448fd75815fSDavid Howells /*
449973c9f4fSDavid Howells  * Clear the specified keyring, creating an empty process keyring if one of the
450973c9f4fSDavid Howells  * special keyring IDs is used.
451973c9f4fSDavid Howells  *
452d3600bcfSMimi Zohar  * The keyring must grant the caller Write permission and not have
453d3600bcfSMimi Zohar  * KEY_FLAG_KEEP set for this to work.  If successful, 0 will be returned.
4541da177e4SLinus Torvalds  */
4551da177e4SLinus Torvalds long keyctl_keyring_clear(key_serial_t ringid)
4561da177e4SLinus Torvalds {
457664cceb0SDavid Howells 	key_ref_t keyring_ref;
458d3600bcfSMimi Zohar 	struct key *keyring;
4591da177e4SLinus Torvalds 	long ret;
4601da177e4SLinus Torvalds 
461f5895943SDavid Howells 	keyring_ref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE);
462664cceb0SDavid Howells 	if (IS_ERR(keyring_ref)) {
463664cceb0SDavid Howells 		ret = PTR_ERR(keyring_ref);
464700920ebSDavid Howells 
465700920ebSDavid Howells 		/* Root is permitted to invalidate certain special keyrings */
466700920ebSDavid Howells 		if (capable(CAP_SYS_ADMIN)) {
467700920ebSDavid Howells 			keyring_ref = lookup_user_key(ringid, 0, 0);
468700920ebSDavid Howells 			if (IS_ERR(keyring_ref))
469700920ebSDavid Howells 				goto error;
470700920ebSDavid Howells 			if (test_bit(KEY_FLAG_ROOT_CAN_CLEAR,
471700920ebSDavid Howells 				     &key_ref_to_ptr(keyring_ref)->flags))
472700920ebSDavid Howells 				goto clear;
473700920ebSDavid Howells 			goto error_put;
474700920ebSDavid Howells 		}
475700920ebSDavid Howells 
4761da177e4SLinus Torvalds 		goto error;
4771da177e4SLinus Torvalds 	}
4781da177e4SLinus Torvalds 
479700920ebSDavid Howells clear:
480d3600bcfSMimi Zohar 	keyring = key_ref_to_ptr(keyring_ref);
481d3600bcfSMimi Zohar 	if (test_bit(KEY_FLAG_KEEP, &keyring->flags))
482d3600bcfSMimi Zohar 		ret = -EPERM;
483d3600bcfSMimi Zohar 	else
484d3600bcfSMimi Zohar 		ret = keyring_clear(keyring);
485700920ebSDavid Howells error_put:
486664cceb0SDavid Howells 	key_ref_put(keyring_ref);
4871da177e4SLinus Torvalds error:
4881da177e4SLinus Torvalds 	return ret;
489a8b17ed0SDavid Howells }
4901da177e4SLinus Torvalds 
4911da177e4SLinus Torvalds /*
492973c9f4fSDavid Howells  * Create a link from a keyring to a key if there's no matching key in the
493973c9f4fSDavid Howells  * keyring, otherwise replace the link to the matching key with a link to the
494973c9f4fSDavid Howells  * new key.
495973c9f4fSDavid Howells  *
496973c9f4fSDavid Howells  * The key must grant the caller Link permission and the the keyring must grant
497973c9f4fSDavid Howells  * the caller Write permission.  Furthermore, if an additional link is created,
498973c9f4fSDavid Howells  * the keyring's quota will be extended.
499973c9f4fSDavid Howells  *
500973c9f4fSDavid Howells  * If successful, 0 will be returned.
5011da177e4SLinus Torvalds  */
5021da177e4SLinus Torvalds long keyctl_keyring_link(key_serial_t id, key_serial_t ringid)
5031da177e4SLinus Torvalds {
504664cceb0SDavid Howells 	key_ref_t keyring_ref, key_ref;
5051da177e4SLinus Torvalds 	long ret;
5061da177e4SLinus Torvalds 
507f5895943SDavid Howells 	keyring_ref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE);
508664cceb0SDavid Howells 	if (IS_ERR(keyring_ref)) {
509664cceb0SDavid Howells 		ret = PTR_ERR(keyring_ref);
5101da177e4SLinus Torvalds 		goto error;
5111da177e4SLinus Torvalds 	}
5121da177e4SLinus Torvalds 
513f5895943SDavid Howells 	key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE, KEY_NEED_LINK);
514664cceb0SDavid Howells 	if (IS_ERR(key_ref)) {
515664cceb0SDavid Howells 		ret = PTR_ERR(key_ref);
5161da177e4SLinus Torvalds 		goto error2;
5171da177e4SLinus Torvalds 	}
5181da177e4SLinus Torvalds 
519664cceb0SDavid Howells 	ret = key_link(key_ref_to_ptr(keyring_ref), key_ref_to_ptr(key_ref));
5201da177e4SLinus Torvalds 
521664cceb0SDavid Howells 	key_ref_put(key_ref);
5221da177e4SLinus Torvalds error2:
523664cceb0SDavid Howells 	key_ref_put(keyring_ref);
5241da177e4SLinus Torvalds error:
5251da177e4SLinus Torvalds 	return ret;
526a8b17ed0SDavid Howells }
5271da177e4SLinus Torvalds 
5281da177e4SLinus Torvalds /*
529973c9f4fSDavid Howells  * Unlink a key from a keyring.
530973c9f4fSDavid Howells  *
531973c9f4fSDavid Howells  * The keyring must grant the caller Write permission for this to work; the key
532973c9f4fSDavid Howells  * itself need not grant the caller anything.  If the last link to a key is
533973c9f4fSDavid Howells  * removed then that key will be scheduled for destruction.
534973c9f4fSDavid Howells  *
535d3600bcfSMimi Zohar  * Keys or keyrings with KEY_FLAG_KEEP set should not be unlinked.
536d3600bcfSMimi Zohar  *
537973c9f4fSDavid Howells  * If successful, 0 will be returned.
5381da177e4SLinus Torvalds  */
5391da177e4SLinus Torvalds long keyctl_keyring_unlink(key_serial_t id, key_serial_t ringid)
5401da177e4SLinus Torvalds {
541664cceb0SDavid Howells 	key_ref_t keyring_ref, key_ref;
542d3600bcfSMimi Zohar 	struct key *keyring, *key;
5431da177e4SLinus Torvalds 	long ret;
5441da177e4SLinus Torvalds 
545f5895943SDavid Howells 	keyring_ref = lookup_user_key(ringid, 0, KEY_NEED_WRITE);
546664cceb0SDavid Howells 	if (IS_ERR(keyring_ref)) {
547664cceb0SDavid Howells 		ret = PTR_ERR(keyring_ref);
5481da177e4SLinus Torvalds 		goto error;
5491da177e4SLinus Torvalds 	}
5501da177e4SLinus Torvalds 
5515593122eSDavid Howells 	key_ref = lookup_user_key(id, KEY_LOOKUP_FOR_UNLINK, 0);
552664cceb0SDavid Howells 	if (IS_ERR(key_ref)) {
553664cceb0SDavid Howells 		ret = PTR_ERR(key_ref);
5541da177e4SLinus Torvalds 		goto error2;
5551da177e4SLinus Torvalds 	}
5561da177e4SLinus Torvalds 
557d3600bcfSMimi Zohar 	keyring = key_ref_to_ptr(keyring_ref);
558d3600bcfSMimi Zohar 	key = key_ref_to_ptr(key_ref);
559d3600bcfSMimi Zohar 	if (test_bit(KEY_FLAG_KEEP, &keyring->flags) &&
560d3600bcfSMimi Zohar 	    test_bit(KEY_FLAG_KEEP, &key->flags))
561d3600bcfSMimi Zohar 		ret = -EPERM;
562d3600bcfSMimi Zohar 	else
563d3600bcfSMimi Zohar 		ret = key_unlink(keyring, key);
5641da177e4SLinus Torvalds 
565664cceb0SDavid Howells 	key_ref_put(key_ref);
5661da177e4SLinus Torvalds error2:
567664cceb0SDavid Howells 	key_ref_put(keyring_ref);
5681da177e4SLinus Torvalds error:
5691da177e4SLinus Torvalds 	return ret;
570a8b17ed0SDavid Howells }
5711da177e4SLinus Torvalds 
5721da177e4SLinus Torvalds /*
573973c9f4fSDavid Howells  * Return a description of a key to userspace.
574973c9f4fSDavid Howells  *
575973c9f4fSDavid Howells  * The key must grant the caller View permission for this to work.
576973c9f4fSDavid Howells  *
577973c9f4fSDavid Howells  * If there's a buffer, we place up to buflen bytes of data into it formatted
578973c9f4fSDavid Howells  * in the following way:
579973c9f4fSDavid Howells  *
5801da177e4SLinus Torvalds  *	type;uid;gid;perm;description<NUL>
581973c9f4fSDavid Howells  *
582973c9f4fSDavid Howells  * If successful, we return the amount of description available, irrespective
583973c9f4fSDavid Howells  * of how much we may have copied into the buffer.
5841da177e4SLinus Torvalds  */
5851da177e4SLinus Torvalds long keyctl_describe_key(key_serial_t keyid,
5861da177e4SLinus Torvalds 			 char __user *buffer,
5871da177e4SLinus Torvalds 			 size_t buflen)
5881da177e4SLinus Torvalds {
5893e30148cSDavid Howells 	struct key *key, *instkey;
590664cceb0SDavid Howells 	key_ref_t key_ref;
591aa9d4437SDavid Howells 	char *infobuf;
5921da177e4SLinus Torvalds 	long ret;
593aa9d4437SDavid Howells 	int desclen, infolen;
5941da177e4SLinus Torvalds 
595f5895943SDavid Howells 	key_ref = lookup_user_key(keyid, KEY_LOOKUP_PARTIAL, KEY_NEED_VIEW);
596664cceb0SDavid Howells 	if (IS_ERR(key_ref)) {
5973e30148cSDavid Howells 		/* viewing a key under construction is permitted if we have the
5983e30148cSDavid Howells 		 * authorisation token handy */
599664cceb0SDavid Howells 		if (PTR_ERR(key_ref) == -EACCES) {
6003e30148cSDavid Howells 			instkey = key_get_instantiation_authkey(keyid);
6013e30148cSDavid Howells 			if (!IS_ERR(instkey)) {
6023e30148cSDavid Howells 				key_put(instkey);
6038bbf4976SDavid Howells 				key_ref = lookup_user_key(keyid,
6045593122eSDavid Howells 							  KEY_LOOKUP_PARTIAL,
6055593122eSDavid Howells 							  0);
606664cceb0SDavid Howells 				if (!IS_ERR(key_ref))
6073e30148cSDavid Howells 					goto okay;
6083e30148cSDavid Howells 			}
6093e30148cSDavid Howells 		}
6103e30148cSDavid Howells 
611664cceb0SDavid Howells 		ret = PTR_ERR(key_ref);
6121da177e4SLinus Torvalds 		goto error;
6131da177e4SLinus Torvalds 	}
6141da177e4SLinus Torvalds 
6153e30148cSDavid Howells okay:
616664cceb0SDavid Howells 	key = key_ref_to_ptr(key_ref);
617aa9d4437SDavid Howells 	desclen = strlen(key->description);
618664cceb0SDavid Howells 
619aa9d4437SDavid Howells 	/* calculate how much information we're going to return */
620aa9d4437SDavid Howells 	ret = -ENOMEM;
621aa9d4437SDavid Howells 	infobuf = kasprintf(GFP_KERNEL,
622aa9d4437SDavid Howells 			    "%s;%d;%d;%08x;",
62394fd8405SDavid Howells 			    key->type->name,
6249a56c2dbSEric W. Biederman 			    from_kuid_munged(current_user_ns(), key->uid),
6259a56c2dbSEric W. Biederman 			    from_kgid_munged(current_user_ns(), key->gid),
626aa9d4437SDavid Howells 			    key->perm);
627aa9d4437SDavid Howells 	if (!infobuf)
628aa9d4437SDavid Howells 		goto error2;
629aa9d4437SDavid Howells 	infolen = strlen(infobuf);
630aa9d4437SDavid Howells 	ret = infolen + desclen + 1;
6311da177e4SLinus Torvalds 
6321da177e4SLinus Torvalds 	/* consider returning the data */
633aa9d4437SDavid Howells 	if (buffer && buflen >= ret) {
634aa9d4437SDavid Howells 		if (copy_to_user(buffer, infobuf, infolen) != 0 ||
635aa9d4437SDavid Howells 		    copy_to_user(buffer + infolen, key->description,
636aa9d4437SDavid Howells 				 desclen + 1) != 0)
6371da177e4SLinus Torvalds 			ret = -EFAULT;
6381da177e4SLinus Torvalds 	}
6391da177e4SLinus Torvalds 
640aa9d4437SDavid Howells 	kfree(infobuf);
6411da177e4SLinus Torvalds error2:
642664cceb0SDavid Howells 	key_ref_put(key_ref);
6431da177e4SLinus Torvalds error:
6441da177e4SLinus Torvalds 	return ret;
645a8b17ed0SDavid Howells }
6461da177e4SLinus Torvalds 
6471da177e4SLinus Torvalds /*
648973c9f4fSDavid Howells  * Search the specified keyring and any keyrings it links to for a matching
649973c9f4fSDavid Howells  * key.  Only keyrings that grant the caller Search permission will be searched
650973c9f4fSDavid Howells  * (this includes the starting keyring).  Only keys with Search permission can
651973c9f4fSDavid Howells  * be found.
652973c9f4fSDavid Howells  *
653973c9f4fSDavid Howells  * If successful, the found key will be linked to the destination keyring if
654973c9f4fSDavid Howells  * supplied and the key has Link permission, and the found key ID will be
655973c9f4fSDavid Howells  * returned.
6561da177e4SLinus Torvalds  */
6571da177e4SLinus Torvalds long keyctl_keyring_search(key_serial_t ringid,
6581da177e4SLinus Torvalds 			   const char __user *_type,
6591da177e4SLinus Torvalds 			   const char __user *_description,
6601da177e4SLinus Torvalds 			   key_serial_t destringid)
6611da177e4SLinus Torvalds {
6621da177e4SLinus Torvalds 	struct key_type *ktype;
663664cceb0SDavid Howells 	key_ref_t keyring_ref, key_ref, dest_ref;
6641da177e4SLinus Torvalds 	char type[32], *description;
6650cb409d9SDavi Arnaut 	long ret;
6661da177e4SLinus Torvalds 
6671da177e4SLinus Torvalds 	/* pull the type and description into kernel space */
6680cb409d9SDavi Arnaut 	ret = key_get_type_from_user(type, _type, sizeof(type));
6691da177e4SLinus Torvalds 	if (ret < 0)
6701da177e4SLinus Torvalds 		goto error;
6711da177e4SLinus Torvalds 
672aa9d4437SDavid Howells 	description = strndup_user(_description, KEY_MAX_DESC_SIZE);
6730cb409d9SDavi Arnaut 	if (IS_ERR(description)) {
6740cb409d9SDavi Arnaut 		ret = PTR_ERR(description);
6751da177e4SLinus Torvalds 		goto error;
6760cb409d9SDavi Arnaut 	}
6771da177e4SLinus Torvalds 
6781da177e4SLinus Torvalds 	/* get the keyring at which to begin the search */
679f5895943SDavid Howells 	keyring_ref = lookup_user_key(ringid, 0, KEY_NEED_SEARCH);
680664cceb0SDavid Howells 	if (IS_ERR(keyring_ref)) {
681664cceb0SDavid Howells 		ret = PTR_ERR(keyring_ref);
6821da177e4SLinus Torvalds 		goto error2;
6831da177e4SLinus Torvalds 	}
6841da177e4SLinus Torvalds 
6851da177e4SLinus Torvalds 	/* get the destination keyring if specified */
686664cceb0SDavid Howells 	dest_ref = NULL;
6871da177e4SLinus Torvalds 	if (destringid) {
6885593122eSDavid Howells 		dest_ref = lookup_user_key(destringid, KEY_LOOKUP_CREATE,
689f5895943SDavid Howells 					   KEY_NEED_WRITE);
690664cceb0SDavid Howells 		if (IS_ERR(dest_ref)) {
691664cceb0SDavid Howells 			ret = PTR_ERR(dest_ref);
6921da177e4SLinus Torvalds 			goto error3;
6931da177e4SLinus Torvalds 		}
6941da177e4SLinus Torvalds 	}
6951da177e4SLinus Torvalds 
6961da177e4SLinus Torvalds 	/* find the key type */
6971da177e4SLinus Torvalds 	ktype = key_type_lookup(type);
6981da177e4SLinus Torvalds 	if (IS_ERR(ktype)) {
6991da177e4SLinus Torvalds 		ret = PTR_ERR(ktype);
7001da177e4SLinus Torvalds 		goto error4;
7011da177e4SLinus Torvalds 	}
7021da177e4SLinus Torvalds 
7031da177e4SLinus Torvalds 	/* do the search */
704664cceb0SDavid Howells 	key_ref = keyring_search(keyring_ref, ktype, description);
705664cceb0SDavid Howells 	if (IS_ERR(key_ref)) {
706664cceb0SDavid Howells 		ret = PTR_ERR(key_ref);
7071da177e4SLinus Torvalds 
7081da177e4SLinus Torvalds 		/* treat lack or presence of a negative key the same */
7091da177e4SLinus Torvalds 		if (ret == -EAGAIN)
7101da177e4SLinus Torvalds 			ret = -ENOKEY;
7111da177e4SLinus Torvalds 		goto error5;
7121da177e4SLinus Torvalds 	}
7131da177e4SLinus Torvalds 
7141da177e4SLinus Torvalds 	/* link the resulting key to the destination keyring if we can */
715664cceb0SDavid Howells 	if (dest_ref) {
716f5895943SDavid Howells 		ret = key_permission(key_ref, KEY_NEED_LINK);
71729db9190SDavid Howells 		if (ret < 0)
7181da177e4SLinus Torvalds 			goto error6;
7191da177e4SLinus Torvalds 
720664cceb0SDavid Howells 		ret = key_link(key_ref_to_ptr(dest_ref), key_ref_to_ptr(key_ref));
7211da177e4SLinus Torvalds 		if (ret < 0)
7221da177e4SLinus Torvalds 			goto error6;
7231da177e4SLinus Torvalds 	}
7241da177e4SLinus Torvalds 
725664cceb0SDavid Howells 	ret = key_ref_to_ptr(key_ref)->serial;
7261da177e4SLinus Torvalds 
7271da177e4SLinus Torvalds error6:
728664cceb0SDavid Howells 	key_ref_put(key_ref);
7291da177e4SLinus Torvalds error5:
7301da177e4SLinus Torvalds 	key_type_put(ktype);
7311da177e4SLinus Torvalds error4:
732664cceb0SDavid Howells 	key_ref_put(dest_ref);
7331da177e4SLinus Torvalds error3:
734664cceb0SDavid Howells 	key_ref_put(keyring_ref);
7351da177e4SLinus Torvalds error2:
7361da177e4SLinus Torvalds 	kfree(description);
7371da177e4SLinus Torvalds error:
7381da177e4SLinus Torvalds 	return ret;
739a8b17ed0SDavid Howells }
7401da177e4SLinus Torvalds 
7411da177e4SLinus Torvalds /*
742973c9f4fSDavid Howells  * Read a key's payload.
743973c9f4fSDavid Howells  *
744973c9f4fSDavid Howells  * The key must either grant the caller Read permission, or it must grant the
745973c9f4fSDavid Howells  * caller Search permission when searched for from the process keyrings.
746973c9f4fSDavid Howells  *
747973c9f4fSDavid Howells  * If successful, we place up to buflen bytes of data into the buffer, if one
748973c9f4fSDavid Howells  * is provided, and return the amount of data that is available in the key,
749973c9f4fSDavid Howells  * irrespective of how much we copied into the buffer.
7501da177e4SLinus Torvalds  */
7511da177e4SLinus Torvalds long keyctl_read_key(key_serial_t keyid, char __user *buffer, size_t buflen)
7521da177e4SLinus Torvalds {
753664cceb0SDavid Howells 	struct key *key;
754664cceb0SDavid Howells 	key_ref_t key_ref;
7551da177e4SLinus Torvalds 	long ret;
7561da177e4SLinus Torvalds 
7571da177e4SLinus Torvalds 	/* find the key first */
7585593122eSDavid Howells 	key_ref = lookup_user_key(keyid, 0, 0);
759664cceb0SDavid Howells 	if (IS_ERR(key_ref)) {
760664cceb0SDavid Howells 		ret = -ENOKEY;
761664cceb0SDavid Howells 		goto error;
762664cceb0SDavid Howells 	}
763664cceb0SDavid Howells 
764664cceb0SDavid Howells 	key = key_ref_to_ptr(key_ref);
765664cceb0SDavid Howells 
7661da177e4SLinus Torvalds 	/* see if we can read it directly */
767f5895943SDavid Howells 	ret = key_permission(key_ref, KEY_NEED_READ);
76829db9190SDavid Howells 	if (ret == 0)
7691da177e4SLinus Torvalds 		goto can_read_key;
77029db9190SDavid Howells 	if (ret != -EACCES)
77129db9190SDavid Howells 		goto error;
7721da177e4SLinus Torvalds 
773664cceb0SDavid Howells 	/* we can't; see if it's searchable from this process's keyrings
7743e30148cSDavid Howells 	 * - we automatically take account of the fact that it may be
7753e30148cSDavid Howells 	 *   dangling off an instantiation key
7763e30148cSDavid Howells 	 */
777664cceb0SDavid Howells 	if (!is_key_possessed(key_ref)) {
7781260f801SDavid Howells 		ret = -EACCES;
7791da177e4SLinus Torvalds 		goto error2;
7801da177e4SLinus Torvalds 	}
7811da177e4SLinus Torvalds 
7821da177e4SLinus Torvalds 	/* the key is probably readable - now try to read it */
7831da177e4SLinus Torvalds can_read_key:
7841da177e4SLinus Torvalds 	ret = -EOPNOTSUPP;
7851da177e4SLinus Torvalds 	if (key->type->read) {
786b4a1b4f5SDavid Howells 		/* Read the data with the semaphore held (since we might sleep)
787b4a1b4f5SDavid Howells 		 * to protect against the key being updated or revoked.
788b4a1b4f5SDavid Howells 		 */
7891da177e4SLinus Torvalds 		down_read(&key->sem);
790b4a1b4f5SDavid Howells 		ret = key_validate(key);
791b4a1b4f5SDavid Howells 		if (ret == 0)
7921da177e4SLinus Torvalds 			ret = key->type->read(key, buffer, buflen);
7931da177e4SLinus Torvalds 		up_read(&key->sem);
7941da177e4SLinus Torvalds 	}
7951da177e4SLinus Torvalds 
7961da177e4SLinus Torvalds error2:
7971da177e4SLinus Torvalds 	key_put(key);
7981da177e4SLinus Torvalds error:
7991da177e4SLinus Torvalds 	return ret;
800a8b17ed0SDavid Howells }
8011da177e4SLinus Torvalds 
8021da177e4SLinus Torvalds /*
803973c9f4fSDavid Howells  * Change the ownership of a key
804973c9f4fSDavid Howells  *
805973c9f4fSDavid Howells  * The key must grant the caller Setattr permission for this to work, though
806973c9f4fSDavid Howells  * the key need not be fully instantiated yet.  For the UID to be changed, or
807973c9f4fSDavid Howells  * for the GID to be changed to a group the caller is not a member of, the
808973c9f4fSDavid Howells  * caller must have sysadmin capability.  If either uid or gid is -1 then that
809973c9f4fSDavid Howells  * attribute is not changed.
810973c9f4fSDavid Howells  *
811973c9f4fSDavid Howells  * If the UID is to be changed, the new user must have sufficient quota to
812973c9f4fSDavid Howells  * accept the key.  The quota deduction will be removed from the old user to
813973c9f4fSDavid Howells  * the new user should the attribute be changed.
814973c9f4fSDavid Howells  *
815973c9f4fSDavid Howells  * If successful, 0 will be returned.
8161da177e4SLinus Torvalds  */
8179a56c2dbSEric W. Biederman long keyctl_chown_key(key_serial_t id, uid_t user, gid_t group)
8181da177e4SLinus Torvalds {
8195801649dSFredrik Tolf 	struct key_user *newowner, *zapowner = NULL;
8201da177e4SLinus Torvalds 	struct key *key;
821664cceb0SDavid Howells 	key_ref_t key_ref;
8221da177e4SLinus Torvalds 	long ret;
8239a56c2dbSEric W. Biederman 	kuid_t uid;
8249a56c2dbSEric W. Biederman 	kgid_t gid;
8259a56c2dbSEric W. Biederman 
8269a56c2dbSEric W. Biederman 	uid = make_kuid(current_user_ns(), user);
8279a56c2dbSEric W. Biederman 	gid = make_kgid(current_user_ns(), group);
8289a56c2dbSEric W. Biederman 	ret = -EINVAL;
8299a56c2dbSEric W. Biederman 	if ((user != (uid_t) -1) && !uid_valid(uid))
8309a56c2dbSEric W. Biederman 		goto error;
8319a56c2dbSEric W. Biederman 	if ((group != (gid_t) -1) && !gid_valid(gid))
8329a56c2dbSEric W. Biederman 		goto error;
8331da177e4SLinus Torvalds 
8341da177e4SLinus Torvalds 	ret = 0;
8359a56c2dbSEric W. Biederman 	if (user == (uid_t) -1 && group == (gid_t) -1)
8361da177e4SLinus Torvalds 		goto error;
8371da177e4SLinus Torvalds 
8385593122eSDavid Howells 	key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE | KEY_LOOKUP_PARTIAL,
839f5895943SDavid Howells 				  KEY_NEED_SETATTR);
840664cceb0SDavid Howells 	if (IS_ERR(key_ref)) {
841664cceb0SDavid Howells 		ret = PTR_ERR(key_ref);
8421da177e4SLinus Torvalds 		goto error;
8431da177e4SLinus Torvalds 	}
8441da177e4SLinus Torvalds 
845664cceb0SDavid Howells 	key = key_ref_to_ptr(key_ref);
846664cceb0SDavid Howells 
8471da177e4SLinus Torvalds 	/* make the changes with the locks held to prevent chown/chown races */
8481da177e4SLinus Torvalds 	ret = -EACCES;
8491da177e4SLinus Torvalds 	down_write(&key->sem);
8501da177e4SLinus Torvalds 
8511da177e4SLinus Torvalds 	if (!capable(CAP_SYS_ADMIN)) {
8521da177e4SLinus Torvalds 		/* only the sysadmin can chown a key to some other UID */
8539a56c2dbSEric W. Biederman 		if (user != (uid_t) -1 && !uid_eq(key->uid, uid))
8545801649dSFredrik Tolf 			goto error_put;
8551da177e4SLinus Torvalds 
8561da177e4SLinus Torvalds 		/* only the sysadmin can set the key's GID to a group other
8571da177e4SLinus Torvalds 		 * than one of those that the current process subscribes to */
8589a56c2dbSEric W. Biederman 		if (group != (gid_t) -1 && !gid_eq(gid, key->gid) && !in_group_p(gid))
8595801649dSFredrik Tolf 			goto error_put;
8601da177e4SLinus Torvalds 	}
8611da177e4SLinus Torvalds 
8625801649dSFredrik Tolf 	/* change the UID */
8639a56c2dbSEric W. Biederman 	if (user != (uid_t) -1 && !uid_eq(uid, key->uid)) {
8645801649dSFredrik Tolf 		ret = -ENOMEM;
8659a56c2dbSEric W. Biederman 		newowner = key_user_lookup(uid);
8665801649dSFredrik Tolf 		if (!newowner)
8675801649dSFredrik Tolf 			goto error_put;
8685801649dSFredrik Tolf 
8695801649dSFredrik Tolf 		/* transfer the quota burden to the new user */
8705801649dSFredrik Tolf 		if (test_bit(KEY_FLAG_IN_QUOTA, &key->flags)) {
8719a56c2dbSEric W. Biederman 			unsigned maxkeys = uid_eq(uid, GLOBAL_ROOT_UID) ?
8720b77f5bfSDavid Howells 				key_quota_root_maxkeys : key_quota_maxkeys;
8739a56c2dbSEric W. Biederman 			unsigned maxbytes = uid_eq(uid, GLOBAL_ROOT_UID) ?
8740b77f5bfSDavid Howells 				key_quota_root_maxbytes : key_quota_maxbytes;
8750b77f5bfSDavid Howells 
8765801649dSFredrik Tolf 			spin_lock(&newowner->lock);
8770b77f5bfSDavid Howells 			if (newowner->qnkeys + 1 >= maxkeys ||
8780b77f5bfSDavid Howells 			    newowner->qnbytes + key->quotalen >= maxbytes ||
8790b77f5bfSDavid Howells 			    newowner->qnbytes + key->quotalen <
8800b77f5bfSDavid Howells 			    newowner->qnbytes)
8815801649dSFredrik Tolf 				goto quota_overrun;
8825801649dSFredrik Tolf 
8835801649dSFredrik Tolf 			newowner->qnkeys++;
8845801649dSFredrik Tolf 			newowner->qnbytes += key->quotalen;
8855801649dSFredrik Tolf 			spin_unlock(&newowner->lock);
8865801649dSFredrik Tolf 
8875801649dSFredrik Tolf 			spin_lock(&key->user->lock);
8885801649dSFredrik Tolf 			key->user->qnkeys--;
8895801649dSFredrik Tolf 			key->user->qnbytes -= key->quotalen;
8905801649dSFredrik Tolf 			spin_unlock(&key->user->lock);
8915801649dSFredrik Tolf 		}
8925801649dSFredrik Tolf 
8935801649dSFredrik Tolf 		atomic_dec(&key->user->nkeys);
8945801649dSFredrik Tolf 		atomic_inc(&newowner->nkeys);
8955801649dSFredrik Tolf 
8965801649dSFredrik Tolf 		if (test_bit(KEY_FLAG_INSTANTIATED, &key->flags)) {
8975801649dSFredrik Tolf 			atomic_dec(&key->user->nikeys);
8985801649dSFredrik Tolf 			atomic_inc(&newowner->nikeys);
8995801649dSFredrik Tolf 		}
9005801649dSFredrik Tolf 
9015801649dSFredrik Tolf 		zapowner = key->user;
9025801649dSFredrik Tolf 		key->user = newowner;
9035801649dSFredrik Tolf 		key->uid = uid;
9041da177e4SLinus Torvalds 	}
9051da177e4SLinus Torvalds 
9061da177e4SLinus Torvalds 	/* change the GID */
9079a56c2dbSEric W. Biederman 	if (group != (gid_t) -1)
9081da177e4SLinus Torvalds 		key->gid = gid;
9091da177e4SLinus Torvalds 
9101da177e4SLinus Torvalds 	ret = 0;
9111da177e4SLinus Torvalds 
9125801649dSFredrik Tolf error_put:
9131da177e4SLinus Torvalds 	up_write(&key->sem);
9141da177e4SLinus Torvalds 	key_put(key);
9155801649dSFredrik Tolf 	if (zapowner)
9165801649dSFredrik Tolf 		key_user_put(zapowner);
9171da177e4SLinus Torvalds error:
9181da177e4SLinus Torvalds 	return ret;
9191da177e4SLinus Torvalds 
9205801649dSFredrik Tolf quota_overrun:
9215801649dSFredrik Tolf 	spin_unlock(&newowner->lock);
9225801649dSFredrik Tolf 	zapowner = newowner;
9235801649dSFredrik Tolf 	ret = -EDQUOT;
9245801649dSFredrik Tolf 	goto error_put;
925a8b17ed0SDavid Howells }
9265801649dSFredrik Tolf 
9271da177e4SLinus Torvalds /*
928973c9f4fSDavid Howells  * Change the permission mask on a key.
929973c9f4fSDavid Howells  *
930973c9f4fSDavid Howells  * The key must grant the caller Setattr permission for this to work, though
931973c9f4fSDavid Howells  * the key need not be fully instantiated yet.  If the caller does not have
932973c9f4fSDavid Howells  * sysadmin capability, it may only change the permission on keys that it owns.
9331da177e4SLinus Torvalds  */
9341da177e4SLinus Torvalds long keyctl_setperm_key(key_serial_t id, key_perm_t perm)
9351da177e4SLinus Torvalds {
9361da177e4SLinus Torvalds 	struct key *key;
937664cceb0SDavid Howells 	key_ref_t key_ref;
9381da177e4SLinus Torvalds 	long ret;
9391da177e4SLinus Torvalds 
9401da177e4SLinus Torvalds 	ret = -EINVAL;
941664cceb0SDavid Howells 	if (perm & ~(KEY_POS_ALL | KEY_USR_ALL | KEY_GRP_ALL | KEY_OTH_ALL))
9421da177e4SLinus Torvalds 		goto error;
9431da177e4SLinus Torvalds 
9445593122eSDavid Howells 	key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE | KEY_LOOKUP_PARTIAL,
945f5895943SDavid Howells 				  KEY_NEED_SETATTR);
946664cceb0SDavid Howells 	if (IS_ERR(key_ref)) {
947664cceb0SDavid Howells 		ret = PTR_ERR(key_ref);
9481da177e4SLinus Torvalds 		goto error;
9491da177e4SLinus Torvalds 	}
9501da177e4SLinus Torvalds 
951664cceb0SDavid Howells 	key = key_ref_to_ptr(key_ref);
952664cceb0SDavid Howells 
95376d8aeabSDavid Howells 	/* make the changes with the locks held to prevent chown/chmod races */
9541da177e4SLinus Torvalds 	ret = -EACCES;
9551da177e4SLinus Torvalds 	down_write(&key->sem);
9561da177e4SLinus Torvalds 
95776d8aeabSDavid Howells 	/* if we're not the sysadmin, we can only change a key that we own */
9589a56c2dbSEric W. Biederman 	if (capable(CAP_SYS_ADMIN) || uid_eq(key->uid, current_fsuid())) {
9591da177e4SLinus Torvalds 		key->perm = perm;
9601da177e4SLinus Torvalds 		ret = 0;
96176d8aeabSDavid Howells 	}
9621da177e4SLinus Torvalds 
9631da177e4SLinus Torvalds 	up_write(&key->sem);
9641da177e4SLinus Torvalds 	key_put(key);
9651da177e4SLinus Torvalds error:
9661da177e4SLinus Torvalds 	return ret;
967a8b17ed0SDavid Howells }
9681da177e4SLinus Torvalds 
9698bbf4976SDavid Howells /*
970973c9f4fSDavid Howells  * Get the destination keyring for instantiation and check that the caller has
971973c9f4fSDavid Howells  * Write permission on it.
9728bbf4976SDavid Howells  */
9738bbf4976SDavid Howells static long get_instantiation_keyring(key_serial_t ringid,
9748bbf4976SDavid Howells 				      struct request_key_auth *rka,
9758bbf4976SDavid Howells 				      struct key **_dest_keyring)
9768bbf4976SDavid Howells {
9778bbf4976SDavid Howells 	key_ref_t dkref;
9788bbf4976SDavid Howells 
9798bbf4976SDavid Howells 	*_dest_keyring = NULL;
980eca1bf5bSDavid Howells 
981eca1bf5bSDavid Howells 	/* just return a NULL pointer if we weren't asked to make a link */
982eca1bf5bSDavid Howells 	if (ringid == 0)
9838bbf4976SDavid Howells 		return 0;
9848bbf4976SDavid Howells 
9858bbf4976SDavid Howells 	/* if a specific keyring is nominated by ID, then use that */
9868bbf4976SDavid Howells 	if (ringid > 0) {
987f5895943SDavid Howells 		dkref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE);
9888bbf4976SDavid Howells 		if (IS_ERR(dkref))
9898bbf4976SDavid Howells 			return PTR_ERR(dkref);
9908bbf4976SDavid Howells 		*_dest_keyring = key_ref_to_ptr(dkref);
9918bbf4976SDavid Howells 		return 0;
9928bbf4976SDavid Howells 	}
9938bbf4976SDavid Howells 
9948bbf4976SDavid Howells 	if (ringid == KEY_SPEC_REQKEY_AUTH_KEY)
9958bbf4976SDavid Howells 		return -EINVAL;
9968bbf4976SDavid Howells 
9978bbf4976SDavid Howells 	/* otherwise specify the destination keyring recorded in the
9988bbf4976SDavid Howells 	 * authorisation key (any KEY_SPEC_*_KEYRING) */
9998bbf4976SDavid Howells 	if (ringid >= KEY_SPEC_REQUESTOR_KEYRING) {
100021279cfaSDavid Howells 		*_dest_keyring = key_get(rka->dest_keyring);
10018bbf4976SDavid Howells 		return 0;
10028bbf4976SDavid Howells 	}
10038bbf4976SDavid Howells 
10048bbf4976SDavid Howells 	return -ENOKEY;
10058bbf4976SDavid Howells }
10068bbf4976SDavid Howells 
1007d84f4f99SDavid Howells /*
1008973c9f4fSDavid Howells  * Change the request_key authorisation key on the current process.
1009d84f4f99SDavid Howells  */
1010d84f4f99SDavid Howells static int keyctl_change_reqkey_auth(struct key *key)
1011d84f4f99SDavid Howells {
1012d84f4f99SDavid Howells 	struct cred *new;
1013d84f4f99SDavid Howells 
1014d84f4f99SDavid Howells 	new = prepare_creds();
1015d84f4f99SDavid Howells 	if (!new)
1016d84f4f99SDavid Howells 		return -ENOMEM;
1017d84f4f99SDavid Howells 
1018d84f4f99SDavid Howells 	key_put(new->request_key_auth);
1019d84f4f99SDavid Howells 	new->request_key_auth = key_get(key);
1020d84f4f99SDavid Howells 
1021d84f4f99SDavid Howells 	return commit_creds(new);
1022d84f4f99SDavid Howells }
1023d84f4f99SDavid Howells 
10241da177e4SLinus Torvalds /*
1025973c9f4fSDavid Howells  * Instantiate a key with the specified payload and link the key into the
1026973c9f4fSDavid Howells  * destination keyring if one is given.
1027973c9f4fSDavid Howells  *
1028973c9f4fSDavid Howells  * The caller must have the appropriate instantiation permit set for this to
1029973c9f4fSDavid Howells  * work (see keyctl_assume_authority).  No other permissions are required.
1030973c9f4fSDavid Howells  *
1031973c9f4fSDavid Howells  * If successful, 0 will be returned.
10321da177e4SLinus Torvalds  */
1033ee009e4aSDavid Howells long keyctl_instantiate_key_common(key_serial_t id,
1034b353a1f7SAl Viro 				   struct iov_iter *from,
10351da177e4SLinus Torvalds 				   key_serial_t ringid)
10361da177e4SLinus Torvalds {
1037d84f4f99SDavid Howells 	const struct cred *cred = current_cred();
10383e30148cSDavid Howells 	struct request_key_auth *rka;
10398bbf4976SDavid Howells 	struct key *instkey, *dest_keyring;
1040b353a1f7SAl Viro 	size_t plen = from ? iov_iter_count(from) : 0;
10411da177e4SLinus Torvalds 	void *payload;
10421da177e4SLinus Torvalds 	long ret;
10431da177e4SLinus Torvalds 
1044d84f4f99SDavid Howells 	kenter("%d,,%zu,%d", id, plen, ringid);
1045d84f4f99SDavid Howells 
1046b353a1f7SAl Viro 	if (!plen)
1047b353a1f7SAl Viro 		from = NULL;
1048b353a1f7SAl Viro 
10491da177e4SLinus Torvalds 	ret = -EINVAL;
105038bbca6bSDavid Howells 	if (plen > 1024 * 1024 - 1)
10511da177e4SLinus Torvalds 		goto error;
10521da177e4SLinus Torvalds 
1053b5f545c8SDavid Howells 	/* the appropriate instantiation authorisation key must have been
1054b5f545c8SDavid Howells 	 * assumed before calling this */
1055b5f545c8SDavid Howells 	ret = -EPERM;
1056d84f4f99SDavid Howells 	instkey = cred->request_key_auth;
1057b5f545c8SDavid Howells 	if (!instkey)
1058b5f545c8SDavid Howells 		goto error;
1059b5f545c8SDavid Howells 
1060146aa8b1SDavid Howells 	rka = instkey->payload.data[0];
1061b5f545c8SDavid Howells 	if (rka->target_key->serial != id)
1062b5f545c8SDavid Howells 		goto error;
1063b5f545c8SDavid Howells 
10641da177e4SLinus Torvalds 	/* pull the payload in if one was supplied */
10651da177e4SLinus Torvalds 	payload = NULL;
10661da177e4SLinus Torvalds 
1067b353a1f7SAl Viro 	if (from) {
10681da177e4SLinus Torvalds 		ret = -ENOMEM;
10691da177e4SLinus Torvalds 		payload = kmalloc(plen, GFP_KERNEL);
107038bbca6bSDavid Howells 		if (!payload) {
107138bbca6bSDavid Howells 			if (plen <= PAGE_SIZE)
107238bbca6bSDavid Howells 				goto error;
107338bbca6bSDavid Howells 			payload = vmalloc(plen);
10741da177e4SLinus Torvalds 			if (!payload)
10751da177e4SLinus Torvalds 				goto error;
107638bbca6bSDavid Howells 		}
10771da177e4SLinus Torvalds 
1078b353a1f7SAl Viro 		ret = -EFAULT;
1079cbbd26b8SAl Viro 		if (!copy_from_iter_full(payload, plen, from))
10801da177e4SLinus Torvalds 			goto error2;
10811da177e4SLinus Torvalds 	}
10821da177e4SLinus Torvalds 
10833e30148cSDavid Howells 	/* find the destination keyring amongst those belonging to the
10843e30148cSDavid Howells 	 * requesting task */
10858bbf4976SDavid Howells 	ret = get_instantiation_keyring(ringid, rka, &dest_keyring);
10868bbf4976SDavid Howells 	if (ret < 0)
1087b5f545c8SDavid Howells 		goto error2;
10881da177e4SLinus Torvalds 
10891da177e4SLinus Torvalds 	/* instantiate the key and link it into a keyring */
10903e30148cSDavid Howells 	ret = key_instantiate_and_link(rka->target_key, payload, plen,
10918bbf4976SDavid Howells 				       dest_keyring, instkey);
10921da177e4SLinus Torvalds 
10938bbf4976SDavid Howells 	key_put(dest_keyring);
1094b5f545c8SDavid Howells 
1095b5f545c8SDavid Howells 	/* discard the assumed authority if it's just been disabled by
1096b5f545c8SDavid Howells 	 * instantiation of the key */
1097d84f4f99SDavid Howells 	if (ret == 0)
1098d84f4f99SDavid Howells 		keyctl_change_reqkey_auth(NULL);
1099b5f545c8SDavid Howells 
11001da177e4SLinus Torvalds error2:
1101b353a1f7SAl Viro 	kvfree(payload);
11021da177e4SLinus Torvalds error:
11031da177e4SLinus Torvalds 	return ret;
1104a8b17ed0SDavid Howells }
11051da177e4SLinus Torvalds 
11061da177e4SLinus Torvalds /*
1107ee009e4aSDavid Howells  * Instantiate a key with the specified payload and link the key into the
1108ee009e4aSDavid Howells  * destination keyring if one is given.
1109ee009e4aSDavid Howells  *
1110ee009e4aSDavid Howells  * The caller must have the appropriate instantiation permit set for this to
1111ee009e4aSDavid Howells  * work (see keyctl_assume_authority).  No other permissions are required.
1112ee009e4aSDavid Howells  *
1113ee009e4aSDavid Howells  * If successful, 0 will be returned.
1114ee009e4aSDavid Howells  */
1115ee009e4aSDavid Howells long keyctl_instantiate_key(key_serial_t id,
1116ee009e4aSDavid Howells 			    const void __user *_payload,
1117ee009e4aSDavid Howells 			    size_t plen,
1118ee009e4aSDavid Howells 			    key_serial_t ringid)
1119ee009e4aSDavid Howells {
1120ee009e4aSDavid Howells 	if (_payload && plen) {
1121b353a1f7SAl Viro 		struct iovec iov;
1122b353a1f7SAl Viro 		struct iov_iter from;
1123b353a1f7SAl Viro 		int ret;
1124ee009e4aSDavid Howells 
1125b353a1f7SAl Viro 		ret = import_single_range(WRITE, (void __user *)_payload, plen,
1126b353a1f7SAl Viro 					  &iov, &from);
1127b353a1f7SAl Viro 		if (unlikely(ret))
1128b353a1f7SAl Viro 			return ret;
1129b353a1f7SAl Viro 
1130b353a1f7SAl Viro 		return keyctl_instantiate_key_common(id, &from, ringid);
1131ee009e4aSDavid Howells 	}
1132ee009e4aSDavid Howells 
1133b353a1f7SAl Viro 	return keyctl_instantiate_key_common(id, NULL, ringid);
1134ee009e4aSDavid Howells }
1135ee009e4aSDavid Howells 
1136ee009e4aSDavid Howells /*
1137ee009e4aSDavid Howells  * Instantiate a key with the specified multipart payload and link the key into
1138ee009e4aSDavid Howells  * the destination keyring if one is given.
1139ee009e4aSDavid Howells  *
1140ee009e4aSDavid Howells  * The caller must have the appropriate instantiation permit set for this to
1141ee009e4aSDavid Howells  * work (see keyctl_assume_authority).  No other permissions are required.
1142ee009e4aSDavid Howells  *
1143ee009e4aSDavid Howells  * If successful, 0 will be returned.
1144ee009e4aSDavid Howells  */
1145ee009e4aSDavid Howells long keyctl_instantiate_key_iov(key_serial_t id,
1146ee009e4aSDavid Howells 				const struct iovec __user *_payload_iov,
1147ee009e4aSDavid Howells 				unsigned ioc,
1148ee009e4aSDavid Howells 				key_serial_t ringid)
1149ee009e4aSDavid Howells {
1150ee009e4aSDavid Howells 	struct iovec iovstack[UIO_FASTIOV], *iov = iovstack;
1151b353a1f7SAl Viro 	struct iov_iter from;
1152ee009e4aSDavid Howells 	long ret;
1153ee009e4aSDavid Howells 
1154b353a1f7SAl Viro 	if (!_payload_iov)
1155b353a1f7SAl Viro 		ioc = 0;
1156ee009e4aSDavid Howells 
1157b353a1f7SAl Viro 	ret = import_iovec(WRITE, _payload_iov, ioc,
1158b353a1f7SAl Viro 				    ARRAY_SIZE(iovstack), &iov, &from);
1159ee009e4aSDavid Howells 	if (ret < 0)
1160b353a1f7SAl Viro 		return ret;
1161b353a1f7SAl Viro 	ret = keyctl_instantiate_key_common(id, &from, ringid);
1162ee009e4aSDavid Howells 	kfree(iov);
1163ee009e4aSDavid Howells 	return ret;
1164ee009e4aSDavid Howells }
1165ee009e4aSDavid Howells 
1166ee009e4aSDavid Howells /*
1167973c9f4fSDavid Howells  * Negatively instantiate the key with the given timeout (in seconds) and link
1168973c9f4fSDavid Howells  * the key into the destination keyring if one is given.
1169973c9f4fSDavid Howells  *
1170973c9f4fSDavid Howells  * The caller must have the appropriate instantiation permit set for this to
1171973c9f4fSDavid Howells  * work (see keyctl_assume_authority).  No other permissions are required.
1172973c9f4fSDavid Howells  *
1173973c9f4fSDavid Howells  * The key and any links to the key will be automatically garbage collected
1174973c9f4fSDavid Howells  * after the timeout expires.
1175973c9f4fSDavid Howells  *
1176973c9f4fSDavid Howells  * Negative keys are used to rate limit repeated request_key() calls by causing
1177973c9f4fSDavid Howells  * them to return -ENOKEY until the negative key expires.
1178973c9f4fSDavid Howells  *
1179973c9f4fSDavid Howells  * If successful, 0 will be returned.
11801da177e4SLinus Torvalds  */
11811da177e4SLinus Torvalds long keyctl_negate_key(key_serial_t id, unsigned timeout, key_serial_t ringid)
11821da177e4SLinus Torvalds {
1183fdd1b945SDavid Howells 	return keyctl_reject_key(id, timeout, ENOKEY, ringid);
1184fdd1b945SDavid Howells }
1185fdd1b945SDavid Howells 
1186fdd1b945SDavid Howells /*
1187fdd1b945SDavid Howells  * Negatively instantiate the key with the given timeout (in seconds) and error
1188fdd1b945SDavid Howells  * code and link the key into the destination keyring if one is given.
1189fdd1b945SDavid Howells  *
1190fdd1b945SDavid Howells  * The caller must have the appropriate instantiation permit set for this to
1191fdd1b945SDavid Howells  * work (see keyctl_assume_authority).  No other permissions are required.
1192fdd1b945SDavid Howells  *
1193fdd1b945SDavid Howells  * The key and any links to the key will be automatically garbage collected
1194fdd1b945SDavid Howells  * after the timeout expires.
1195fdd1b945SDavid Howells  *
1196fdd1b945SDavid Howells  * Negative keys are used to rate limit repeated request_key() calls by causing
1197fdd1b945SDavid Howells  * them to return the specified error code until the negative key expires.
1198fdd1b945SDavid Howells  *
1199fdd1b945SDavid Howells  * If successful, 0 will be returned.
1200fdd1b945SDavid Howells  */
1201fdd1b945SDavid Howells long keyctl_reject_key(key_serial_t id, unsigned timeout, unsigned error,
1202fdd1b945SDavid Howells 		       key_serial_t ringid)
1203fdd1b945SDavid Howells {
1204d84f4f99SDavid Howells 	const struct cred *cred = current_cred();
12053e30148cSDavid Howells 	struct request_key_auth *rka;
12068bbf4976SDavid Howells 	struct key *instkey, *dest_keyring;
12071da177e4SLinus Torvalds 	long ret;
12081da177e4SLinus Torvalds 
1209fdd1b945SDavid Howells 	kenter("%d,%u,%u,%d", id, timeout, error, ringid);
1210fdd1b945SDavid Howells 
1211fdd1b945SDavid Howells 	/* must be a valid error code and mustn't be a kernel special */
1212fdd1b945SDavid Howells 	if (error <= 0 ||
1213fdd1b945SDavid Howells 	    error >= MAX_ERRNO ||
1214fdd1b945SDavid Howells 	    error == ERESTARTSYS ||
1215fdd1b945SDavid Howells 	    error == ERESTARTNOINTR ||
1216fdd1b945SDavid Howells 	    error == ERESTARTNOHAND ||
1217fdd1b945SDavid Howells 	    error == ERESTART_RESTARTBLOCK)
1218fdd1b945SDavid Howells 		return -EINVAL;
1219d84f4f99SDavid Howells 
1220b5f545c8SDavid Howells 	/* the appropriate instantiation authorisation key must have been
1221b5f545c8SDavid Howells 	 * assumed before calling this */
1222b5f545c8SDavid Howells 	ret = -EPERM;
1223d84f4f99SDavid Howells 	instkey = cred->request_key_auth;
1224b5f545c8SDavid Howells 	if (!instkey)
12251da177e4SLinus Torvalds 		goto error;
12261da177e4SLinus Torvalds 
1227146aa8b1SDavid Howells 	rka = instkey->payload.data[0];
1228b5f545c8SDavid Howells 	if (rka->target_key->serial != id)
1229b5f545c8SDavid Howells 		goto error;
12303e30148cSDavid Howells 
12311da177e4SLinus Torvalds 	/* find the destination keyring if present (which must also be
12321da177e4SLinus Torvalds 	 * writable) */
12338bbf4976SDavid Howells 	ret = get_instantiation_keyring(ringid, rka, &dest_keyring);
12348bbf4976SDavid Howells 	if (ret < 0)
1235b5f545c8SDavid Howells 		goto error;
12361da177e4SLinus Torvalds 
12371da177e4SLinus Torvalds 	/* instantiate the key and link it into a keyring */
1238fdd1b945SDavid Howells 	ret = key_reject_and_link(rka->target_key, timeout, error,
12398bbf4976SDavid Howells 				  dest_keyring, instkey);
12401da177e4SLinus Torvalds 
12418bbf4976SDavid Howells 	key_put(dest_keyring);
1242b5f545c8SDavid Howells 
1243b5f545c8SDavid Howells 	/* discard the assumed authority if it's just been disabled by
1244b5f545c8SDavid Howells 	 * instantiation of the key */
1245d84f4f99SDavid Howells 	if (ret == 0)
1246d84f4f99SDavid Howells 		keyctl_change_reqkey_auth(NULL);
1247b5f545c8SDavid Howells 
12481da177e4SLinus Torvalds error:
12491da177e4SLinus Torvalds 	return ret;
1250a8b17ed0SDavid Howells }
12511da177e4SLinus Torvalds 
12521da177e4SLinus Torvalds /*
1253973c9f4fSDavid Howells  * Read or set the default keyring in which request_key() will cache keys and
1254973c9f4fSDavid Howells  * return the old setting.
1255973c9f4fSDavid Howells  *
1256973c9f4fSDavid Howells  * If a process keyring is specified then this will be created if it doesn't
1257973c9f4fSDavid Howells  * yet exist.  The old setting will be returned if successful.
12583e30148cSDavid Howells  */
12593e30148cSDavid Howells long keyctl_set_reqkey_keyring(int reqkey_defl)
12603e30148cSDavid Howells {
1261d84f4f99SDavid Howells 	struct cred *new;
1262d84f4f99SDavid Howells 	int ret, old_setting;
1263d84f4f99SDavid Howells 
1264d84f4f99SDavid Howells 	old_setting = current_cred_xxx(jit_keyring);
1265d84f4f99SDavid Howells 
1266d84f4f99SDavid Howells 	if (reqkey_defl == KEY_REQKEY_DEFL_NO_CHANGE)
1267d84f4f99SDavid Howells 		return old_setting;
1268d84f4f99SDavid Howells 
1269d84f4f99SDavid Howells 	new = prepare_creds();
1270d84f4f99SDavid Howells 	if (!new)
1271d84f4f99SDavid Howells 		return -ENOMEM;
12723e30148cSDavid Howells 
12733e30148cSDavid Howells 	switch (reqkey_defl) {
12743e30148cSDavid Howells 	case KEY_REQKEY_DEFL_THREAD_KEYRING:
1275d84f4f99SDavid Howells 		ret = install_thread_keyring_to_cred(new);
12763e30148cSDavid Howells 		if (ret < 0)
1277d84f4f99SDavid Howells 			goto error;
12783e30148cSDavid Howells 		goto set;
12793e30148cSDavid Howells 
12803e30148cSDavid Howells 	case KEY_REQKEY_DEFL_PROCESS_KEYRING:
1281d84f4f99SDavid Howells 		ret = install_process_keyring_to_cred(new);
1282d84f4f99SDavid Howells 		if (ret < 0) {
1283d84f4f99SDavid Howells 			if (ret != -EEXIST)
1284d84f4f99SDavid Howells 				goto error;
1285d84f4f99SDavid Howells 			ret = 0;
1286d84f4f99SDavid Howells 		}
1287d84f4f99SDavid Howells 		goto set;
12883e30148cSDavid Howells 
12893e30148cSDavid Howells 	case KEY_REQKEY_DEFL_DEFAULT:
12903e30148cSDavid Howells 	case KEY_REQKEY_DEFL_SESSION_KEYRING:
12913e30148cSDavid Howells 	case KEY_REQKEY_DEFL_USER_KEYRING:
12923e30148cSDavid Howells 	case KEY_REQKEY_DEFL_USER_SESSION_KEYRING:
1293d84f4f99SDavid Howells 	case KEY_REQKEY_DEFL_REQUESTOR_KEYRING:
1294d84f4f99SDavid Howells 		goto set;
12953e30148cSDavid Howells 
12963e30148cSDavid Howells 	case KEY_REQKEY_DEFL_NO_CHANGE:
12973e30148cSDavid Howells 	case KEY_REQKEY_DEFL_GROUP_KEYRING:
12983e30148cSDavid Howells 	default:
1299d84f4f99SDavid Howells 		ret = -EINVAL;
1300d84f4f99SDavid Howells 		goto error;
13013e30148cSDavid Howells 	}
13023e30148cSDavid Howells 
1303d84f4f99SDavid Howells set:
1304d84f4f99SDavid Howells 	new->jit_keyring = reqkey_defl;
1305d84f4f99SDavid Howells 	commit_creds(new);
1306d84f4f99SDavid Howells 	return old_setting;
1307d84f4f99SDavid Howells error:
1308d84f4f99SDavid Howells 	abort_creds(new);
13094303ef19SDan Carpenter 	return ret;
1310a8b17ed0SDavid Howells }
1311d84f4f99SDavid Howells 
13123e30148cSDavid Howells /*
1313973c9f4fSDavid Howells  * Set or clear the timeout on a key.
1314973c9f4fSDavid Howells  *
1315973c9f4fSDavid Howells  * Either the key must grant the caller Setattr permission or else the caller
1316973c9f4fSDavid Howells  * must hold an instantiation authorisation token for the key.
1317973c9f4fSDavid Howells  *
1318973c9f4fSDavid Howells  * The timeout is either 0 to clear the timeout, or a number of seconds from
1319973c9f4fSDavid Howells  * the current time.  The key and any links to the key will be automatically
1320973c9f4fSDavid Howells  * garbage collected after the timeout expires.
1321973c9f4fSDavid Howells  *
1322d3600bcfSMimi Zohar  * Keys with KEY_FLAG_KEEP set should not be timed out.
1323d3600bcfSMimi Zohar  *
1324973c9f4fSDavid Howells  * If successful, 0 is returned.
1325017679c4SDavid Howells  */
1326017679c4SDavid Howells long keyctl_set_timeout(key_serial_t id, unsigned timeout)
1327017679c4SDavid Howells {
13289156235bSDavid Howells 	struct key *key, *instkey;
1329017679c4SDavid Howells 	key_ref_t key_ref;
1330017679c4SDavid Howells 	long ret;
1331017679c4SDavid Howells 
13325593122eSDavid Howells 	key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE | KEY_LOOKUP_PARTIAL,
1333f5895943SDavid Howells 				  KEY_NEED_SETATTR);
1334017679c4SDavid Howells 	if (IS_ERR(key_ref)) {
13359156235bSDavid Howells 		/* setting the timeout on a key under construction is permitted
13369156235bSDavid Howells 		 * if we have the authorisation token handy */
13379156235bSDavid Howells 		if (PTR_ERR(key_ref) == -EACCES) {
13389156235bSDavid Howells 			instkey = key_get_instantiation_authkey(id);
13399156235bSDavid Howells 			if (!IS_ERR(instkey)) {
13409156235bSDavid Howells 				key_put(instkey);
13419156235bSDavid Howells 				key_ref = lookup_user_key(id,
13429156235bSDavid Howells 							  KEY_LOOKUP_PARTIAL,
13439156235bSDavid Howells 							  0);
13449156235bSDavid Howells 				if (!IS_ERR(key_ref))
13459156235bSDavid Howells 					goto okay;
13469156235bSDavid Howells 			}
13479156235bSDavid Howells 		}
13489156235bSDavid Howells 
1349017679c4SDavid Howells 		ret = PTR_ERR(key_ref);
1350017679c4SDavid Howells 		goto error;
1351017679c4SDavid Howells 	}
1352017679c4SDavid Howells 
13539156235bSDavid Howells okay:
1354017679c4SDavid Howells 	key = key_ref_to_ptr(key_ref);
13551d6d167cSMimi Zohar 	ret = 0;
1356d3600bcfSMimi Zohar 	if (test_bit(KEY_FLAG_KEEP, &key->flags))
1357d3600bcfSMimi Zohar 		ret = -EPERM;
13581d6d167cSMimi Zohar 	else
135959e6b9c1SBryan Schumaker 		key_set_timeout(key, timeout);
1360017679c4SDavid Howells 	key_put(key);
1361017679c4SDavid Howells 
1362017679c4SDavid Howells error:
1363017679c4SDavid Howells 	return ret;
1364a8b17ed0SDavid Howells }
1365017679c4SDavid Howells 
1366017679c4SDavid Howells /*
1367973c9f4fSDavid Howells  * Assume (or clear) the authority to instantiate the specified key.
1368973c9f4fSDavid Howells  *
1369973c9f4fSDavid Howells  * This sets the authoritative token currently in force for key instantiation.
1370973c9f4fSDavid Howells  * This must be done for a key to be instantiated.  It has the effect of making
1371973c9f4fSDavid Howells  * available all the keys from the caller of the request_key() that created a
1372973c9f4fSDavid Howells  * key to request_key() calls made by the caller of this function.
1373973c9f4fSDavid Howells  *
1374973c9f4fSDavid Howells  * The caller must have the instantiation key in their process keyrings with a
1375973c9f4fSDavid Howells  * Search permission grant available to the caller.
1376973c9f4fSDavid Howells  *
1377973c9f4fSDavid Howells  * If the ID given is 0, then the setting will be cleared and 0 returned.
1378973c9f4fSDavid Howells  *
1379973c9f4fSDavid Howells  * If the ID given has a matching an authorisation key, then that key will be
1380973c9f4fSDavid Howells  * set and its ID will be returned.  The authorisation key can be read to get
1381973c9f4fSDavid Howells  * the callout information passed to request_key().
1382b5f545c8SDavid Howells  */
1383b5f545c8SDavid Howells long keyctl_assume_authority(key_serial_t id)
1384b5f545c8SDavid Howells {
1385b5f545c8SDavid Howells 	struct key *authkey;
1386b5f545c8SDavid Howells 	long ret;
1387b5f545c8SDavid Howells 
1388b5f545c8SDavid Howells 	/* special key IDs aren't permitted */
1389b5f545c8SDavid Howells 	ret = -EINVAL;
1390b5f545c8SDavid Howells 	if (id < 0)
1391b5f545c8SDavid Howells 		goto error;
1392b5f545c8SDavid Howells 
1393b5f545c8SDavid Howells 	/* we divest ourselves of authority if given an ID of 0 */
1394b5f545c8SDavid Howells 	if (id == 0) {
1395d84f4f99SDavid Howells 		ret = keyctl_change_reqkey_auth(NULL);
1396b5f545c8SDavid Howells 		goto error;
1397b5f545c8SDavid Howells 	}
1398b5f545c8SDavid Howells 
1399b5f545c8SDavid Howells 	/* attempt to assume the authority temporarily granted to us whilst we
1400b5f545c8SDavid Howells 	 * instantiate the specified key
1401b5f545c8SDavid Howells 	 * - the authorisation key must be in the current task's keyrings
1402b5f545c8SDavid Howells 	 *   somewhere
1403b5f545c8SDavid Howells 	 */
1404b5f545c8SDavid Howells 	authkey = key_get_instantiation_authkey(id);
1405b5f545c8SDavid Howells 	if (IS_ERR(authkey)) {
1406b5f545c8SDavid Howells 		ret = PTR_ERR(authkey);
1407b5f545c8SDavid Howells 		goto error;
1408b5f545c8SDavid Howells 	}
1409b5f545c8SDavid Howells 
1410d84f4f99SDavid Howells 	ret = keyctl_change_reqkey_auth(authkey);
1411d84f4f99SDavid Howells 	if (ret < 0)
1412d84f4f99SDavid Howells 		goto error;
1413d84f4f99SDavid Howells 	key_put(authkey);
1414b5f545c8SDavid Howells 
1415d84f4f99SDavid Howells 	ret = authkey->serial;
1416b5f545c8SDavid Howells error:
1417b5f545c8SDavid Howells 	return ret;
1418a8b17ed0SDavid Howells }
1419b5f545c8SDavid Howells 
142070a5bb72SDavid Howells /*
1421973c9f4fSDavid Howells  * Get a key's the LSM security label.
1422973c9f4fSDavid Howells  *
1423973c9f4fSDavid Howells  * The key must grant the caller View permission for this to work.
1424973c9f4fSDavid Howells  *
1425973c9f4fSDavid Howells  * If there's a buffer, then up to buflen bytes of data will be placed into it.
1426973c9f4fSDavid Howells  *
1427973c9f4fSDavid Howells  * If successful, the amount of information available will be returned,
1428973c9f4fSDavid Howells  * irrespective of how much was copied (including the terminal NUL).
142970a5bb72SDavid Howells  */
143070a5bb72SDavid Howells long keyctl_get_security(key_serial_t keyid,
143170a5bb72SDavid Howells 			 char __user *buffer,
143270a5bb72SDavid Howells 			 size_t buflen)
143370a5bb72SDavid Howells {
143470a5bb72SDavid Howells 	struct key *key, *instkey;
143570a5bb72SDavid Howells 	key_ref_t key_ref;
143670a5bb72SDavid Howells 	char *context;
143770a5bb72SDavid Howells 	long ret;
143870a5bb72SDavid Howells 
1439f5895943SDavid Howells 	key_ref = lookup_user_key(keyid, KEY_LOOKUP_PARTIAL, KEY_NEED_VIEW);
144070a5bb72SDavid Howells 	if (IS_ERR(key_ref)) {
144170a5bb72SDavid Howells 		if (PTR_ERR(key_ref) != -EACCES)
144270a5bb72SDavid Howells 			return PTR_ERR(key_ref);
144370a5bb72SDavid Howells 
144470a5bb72SDavid Howells 		/* viewing a key under construction is also permitted if we
144570a5bb72SDavid Howells 		 * have the authorisation token handy */
144670a5bb72SDavid Howells 		instkey = key_get_instantiation_authkey(keyid);
144770a5bb72SDavid Howells 		if (IS_ERR(instkey))
1448fa1cc7b5SRoel Kluin 			return PTR_ERR(instkey);
144970a5bb72SDavid Howells 		key_put(instkey);
145070a5bb72SDavid Howells 
14515593122eSDavid Howells 		key_ref = lookup_user_key(keyid, KEY_LOOKUP_PARTIAL, 0);
145270a5bb72SDavid Howells 		if (IS_ERR(key_ref))
145370a5bb72SDavid Howells 			return PTR_ERR(key_ref);
145470a5bb72SDavid Howells 	}
145570a5bb72SDavid Howells 
145670a5bb72SDavid Howells 	key = key_ref_to_ptr(key_ref);
145770a5bb72SDavid Howells 	ret = security_key_getsecurity(key, &context);
145870a5bb72SDavid Howells 	if (ret == 0) {
145970a5bb72SDavid Howells 		/* if no information was returned, give userspace an empty
146070a5bb72SDavid Howells 		 * string */
146170a5bb72SDavid Howells 		ret = 1;
146270a5bb72SDavid Howells 		if (buffer && buflen > 0 &&
146370a5bb72SDavid Howells 		    copy_to_user(buffer, "", 1) != 0)
146470a5bb72SDavid Howells 			ret = -EFAULT;
146570a5bb72SDavid Howells 	} else if (ret > 0) {
146670a5bb72SDavid Howells 		/* return as much data as there's room for */
146770a5bb72SDavid Howells 		if (buffer && buflen > 0) {
146870a5bb72SDavid Howells 			if (buflen > ret)
146970a5bb72SDavid Howells 				buflen = ret;
147070a5bb72SDavid Howells 
147170a5bb72SDavid Howells 			if (copy_to_user(buffer, context, buflen) != 0)
147270a5bb72SDavid Howells 				ret = -EFAULT;
147370a5bb72SDavid Howells 		}
147470a5bb72SDavid Howells 
147570a5bb72SDavid Howells 		kfree(context);
147670a5bb72SDavid Howells 	}
147770a5bb72SDavid Howells 
147870a5bb72SDavid Howells 	key_ref_put(key_ref);
147970a5bb72SDavid Howells 	return ret;
148070a5bb72SDavid Howells }
148170a5bb72SDavid Howells 
1482ee18d64cSDavid Howells /*
1483973c9f4fSDavid Howells  * Attempt to install the calling process's session keyring on the process's
1484973c9f4fSDavid Howells  * parent process.
1485973c9f4fSDavid Howells  *
1486973c9f4fSDavid Howells  * The keyring must exist and must grant the caller LINK permission, and the
1487973c9f4fSDavid Howells  * parent process must be single-threaded and must have the same effective
1488973c9f4fSDavid Howells  * ownership as this process and mustn't be SUID/SGID.
1489973c9f4fSDavid Howells  *
1490973c9f4fSDavid Howells  * The keyring will be emplaced on the parent when it next resumes userspace.
1491973c9f4fSDavid Howells  *
1492973c9f4fSDavid Howells  * If successful, 0 will be returned.
1493ee18d64cSDavid Howells  */
1494ee18d64cSDavid Howells long keyctl_session_to_parent(void)
1495ee18d64cSDavid Howells {
1496ee18d64cSDavid Howells 	struct task_struct *me, *parent;
1497ee18d64cSDavid Howells 	const struct cred *mycred, *pcred;
149867d12145SAl Viro 	struct callback_head *newwork, *oldwork;
1499ee18d64cSDavid Howells 	key_ref_t keyring_r;
1500413cd3d9SOleg Nesterov 	struct cred *cred;
1501ee18d64cSDavid Howells 	int ret;
1502ee18d64cSDavid Howells 
1503f5895943SDavid Howells 	keyring_r = lookup_user_key(KEY_SPEC_SESSION_KEYRING, 0, KEY_NEED_LINK);
1504ee18d64cSDavid Howells 	if (IS_ERR(keyring_r))
1505ee18d64cSDavid Howells 		return PTR_ERR(keyring_r);
1506ee18d64cSDavid Howells 
1507413cd3d9SOleg Nesterov 	ret = -ENOMEM;
1508413cd3d9SOleg Nesterov 
1509ee18d64cSDavid Howells 	/* our parent is going to need a new cred struct, a new tgcred struct
1510ee18d64cSDavid Howells 	 * and new security data, so we allocate them here to prevent ENOMEM in
1511ee18d64cSDavid Howells 	 * our parent */
1512ee18d64cSDavid Howells 	cred = cred_alloc_blank();
1513ee18d64cSDavid Howells 	if (!cred)
151467d12145SAl Viro 		goto error_keyring;
151567d12145SAl Viro 	newwork = &cred->rcu;
1516ee18d64cSDavid Howells 
15173a50597dSDavid Howells 	cred->session_keyring = key_ref_to_ptr(keyring_r);
15183a50597dSDavid Howells 	keyring_r = NULL;
151967d12145SAl Viro 	init_task_work(newwork, key_change_session_keyring);
1520ee18d64cSDavid Howells 
1521ee18d64cSDavid Howells 	me = current;
15229d1ac65aSDavid Howells 	rcu_read_lock();
1523ee18d64cSDavid Howells 	write_lock_irq(&tasklist_lock);
1524ee18d64cSDavid Howells 
1525ee18d64cSDavid Howells 	ret = -EPERM;
1526413cd3d9SOleg Nesterov 	oldwork = NULL;
1527413cd3d9SOleg Nesterov 	parent = me->real_parent;
1528ee18d64cSDavid Howells 
1529ee18d64cSDavid Howells 	/* the parent mustn't be init and mustn't be a kernel thread */
1530ee18d64cSDavid Howells 	if (parent->pid <= 1 || !parent->mm)
1531413cd3d9SOleg Nesterov 		goto unlock;
1532ee18d64cSDavid Howells 
1533ee18d64cSDavid Howells 	/* the parent must be single threaded */
1534dd98acf7SOleg Nesterov 	if (!thread_group_empty(parent))
1535413cd3d9SOleg Nesterov 		goto unlock;
1536ee18d64cSDavid Howells 
1537ee18d64cSDavid Howells 	/* the parent and the child must have different session keyrings or
1538ee18d64cSDavid Howells 	 * there's no point */
1539ee18d64cSDavid Howells 	mycred = current_cred();
1540ee18d64cSDavid Howells 	pcred = __task_cred(parent);
1541ee18d64cSDavid Howells 	if (mycred == pcred ||
15423a50597dSDavid Howells 	    mycred->session_keyring == pcred->session_keyring) {
1543413cd3d9SOleg Nesterov 		ret = 0;
1544413cd3d9SOleg Nesterov 		goto unlock;
1545413cd3d9SOleg Nesterov 	}
1546ee18d64cSDavid Howells 
1547ee18d64cSDavid Howells 	/* the parent must have the same effective ownership and mustn't be
1548ee18d64cSDavid Howells 	 * SUID/SGID */
15499a56c2dbSEric W. Biederman 	if (!uid_eq(pcred->uid,	 mycred->euid) ||
15509a56c2dbSEric W. Biederman 	    !uid_eq(pcred->euid, mycred->euid) ||
15519a56c2dbSEric W. Biederman 	    !uid_eq(pcred->suid, mycred->euid) ||
15529a56c2dbSEric W. Biederman 	    !gid_eq(pcred->gid,	 mycred->egid) ||
15539a56c2dbSEric W. Biederman 	    !gid_eq(pcred->egid, mycred->egid) ||
15549a56c2dbSEric W. Biederman 	    !gid_eq(pcred->sgid, mycred->egid))
1555413cd3d9SOleg Nesterov 		goto unlock;
1556ee18d64cSDavid Howells 
1557ee18d64cSDavid Howells 	/* the keyrings must have the same UID */
15583a50597dSDavid Howells 	if ((pcred->session_keyring &&
15592a74dbb9SLinus Torvalds 	     !uid_eq(pcred->session_keyring->uid, mycred->euid)) ||
15602a74dbb9SLinus Torvalds 	    !uid_eq(mycred->session_keyring->uid, mycred->euid))
1561413cd3d9SOleg Nesterov 		goto unlock;
1562ee18d64cSDavid Howells 
1563413cd3d9SOleg Nesterov 	/* cancel an already pending keyring replacement */
1564413cd3d9SOleg Nesterov 	oldwork = task_work_cancel(parent, key_change_session_keyring);
1565ee18d64cSDavid Howells 
1566ee18d64cSDavid Howells 	/* the replacement session keyring is applied just prior to userspace
1567ee18d64cSDavid Howells 	 * restarting */
156867d12145SAl Viro 	ret = task_work_add(parent, newwork, true);
1569413cd3d9SOleg Nesterov 	if (!ret)
1570413cd3d9SOleg Nesterov 		newwork = NULL;
1571413cd3d9SOleg Nesterov unlock:
1572ee18d64cSDavid Howells 	write_unlock_irq(&tasklist_lock);
15739d1ac65aSDavid Howells 	rcu_read_unlock();
157467d12145SAl Viro 	if (oldwork)
157567d12145SAl Viro 		put_cred(container_of(oldwork, struct cred, rcu));
157667d12145SAl Viro 	if (newwork)
157767d12145SAl Viro 		put_cred(cred);
1578ee18d64cSDavid Howells 	return ret;
1579ee18d64cSDavid Howells 
1580ee18d64cSDavid Howells error_keyring:
1581ee18d64cSDavid Howells 	key_ref_put(keyring_r);
1582ee18d64cSDavid Howells 	return ret;
1583ee18d64cSDavid Howells }
1584ee18d64cSDavid Howells 
1585b5f545c8SDavid Howells /*
1586*6563c91fSMat Martineau  * Apply a restriction to a given keyring.
1587*6563c91fSMat Martineau  *
1588*6563c91fSMat Martineau  * The caller must have Setattr permission to change keyring restrictions.
1589*6563c91fSMat Martineau  *
1590*6563c91fSMat Martineau  * The requested type name may be a NULL pointer to reject all attempts
1591*6563c91fSMat Martineau  * to link to the keyring. If _type is non-NULL, _restriction can be
1592*6563c91fSMat Martineau  * NULL or a pointer to a string describing the restriction. If _type is
1593*6563c91fSMat Martineau  * NULL, _restriction must also be NULL.
1594*6563c91fSMat Martineau  *
1595*6563c91fSMat Martineau  * Returns 0 if successful.
1596*6563c91fSMat Martineau  */
1597*6563c91fSMat Martineau long keyctl_restrict_keyring(key_serial_t id, const char __user *_type,
1598*6563c91fSMat Martineau 			     const char __user *_restriction)
1599*6563c91fSMat Martineau {
1600*6563c91fSMat Martineau 	key_ref_t key_ref;
1601*6563c91fSMat Martineau 	bool link_reject = !_type;
1602*6563c91fSMat Martineau 	char type[32];
1603*6563c91fSMat Martineau 	char *restriction = NULL;
1604*6563c91fSMat Martineau 	long ret;
1605*6563c91fSMat Martineau 
1606*6563c91fSMat Martineau 	key_ref = lookup_user_key(id, 0, KEY_NEED_SETATTR);
1607*6563c91fSMat Martineau 	if (IS_ERR(key_ref))
1608*6563c91fSMat Martineau 		return PTR_ERR(key_ref);
1609*6563c91fSMat Martineau 
1610*6563c91fSMat Martineau 	if (_type) {
1611*6563c91fSMat Martineau 		ret = key_get_type_from_user(type, _type, sizeof(type));
1612*6563c91fSMat Martineau 		if (ret < 0)
1613*6563c91fSMat Martineau 			goto error;
1614*6563c91fSMat Martineau 	}
1615*6563c91fSMat Martineau 
1616*6563c91fSMat Martineau 	if (_restriction) {
1617*6563c91fSMat Martineau 		if (!_type) {
1618*6563c91fSMat Martineau 			ret = -EINVAL;
1619*6563c91fSMat Martineau 			goto error;
1620*6563c91fSMat Martineau 		}
1621*6563c91fSMat Martineau 
1622*6563c91fSMat Martineau 		restriction = strndup_user(_restriction, PAGE_SIZE);
1623*6563c91fSMat Martineau 		if (IS_ERR(restriction)) {
1624*6563c91fSMat Martineau 			ret = PTR_ERR(restriction);
1625*6563c91fSMat Martineau 			goto error;
1626*6563c91fSMat Martineau 		}
1627*6563c91fSMat Martineau 	}
1628*6563c91fSMat Martineau 
1629*6563c91fSMat Martineau 	ret = keyring_restrict(key_ref, link_reject ? NULL : type, restriction);
1630*6563c91fSMat Martineau 	kfree(restriction);
1631*6563c91fSMat Martineau 
1632*6563c91fSMat Martineau error:
1633*6563c91fSMat Martineau 	key_ref_put(key_ref);
1634*6563c91fSMat Martineau 
1635*6563c91fSMat Martineau 	return ret;
1636*6563c91fSMat Martineau }
1637*6563c91fSMat Martineau 
1638*6563c91fSMat Martineau /*
1639973c9f4fSDavid Howells  * The key control system call
16401da177e4SLinus Torvalds  */
1641938bb9f5SHeiko Carstens SYSCALL_DEFINE5(keyctl, int, option, unsigned long, arg2, unsigned long, arg3,
1642938bb9f5SHeiko Carstens 		unsigned long, arg4, unsigned long, arg5)
16431da177e4SLinus Torvalds {
16441da177e4SLinus Torvalds 	switch (option) {
16451da177e4SLinus Torvalds 	case KEYCTL_GET_KEYRING_ID:
16461da177e4SLinus Torvalds 		return keyctl_get_keyring_ID((key_serial_t) arg2,
16471da177e4SLinus Torvalds 					     (int) arg3);
16481da177e4SLinus Torvalds 
16491da177e4SLinus Torvalds 	case KEYCTL_JOIN_SESSION_KEYRING:
16501da177e4SLinus Torvalds 		return keyctl_join_session_keyring((const char __user *) arg2);
16511da177e4SLinus Torvalds 
16521da177e4SLinus Torvalds 	case KEYCTL_UPDATE:
16531da177e4SLinus Torvalds 		return keyctl_update_key((key_serial_t) arg2,
16541da177e4SLinus Torvalds 					 (const void __user *) arg3,
16551da177e4SLinus Torvalds 					 (size_t) arg4);
16561da177e4SLinus Torvalds 
16571da177e4SLinus Torvalds 	case KEYCTL_REVOKE:
16581da177e4SLinus Torvalds 		return keyctl_revoke_key((key_serial_t) arg2);
16591da177e4SLinus Torvalds 
16601da177e4SLinus Torvalds 	case KEYCTL_DESCRIBE:
16611da177e4SLinus Torvalds 		return keyctl_describe_key((key_serial_t) arg2,
16621da177e4SLinus Torvalds 					   (char __user *) arg3,
16631da177e4SLinus Torvalds 					   (unsigned) arg4);
16641da177e4SLinus Torvalds 
16651da177e4SLinus Torvalds 	case KEYCTL_CLEAR:
16661da177e4SLinus Torvalds 		return keyctl_keyring_clear((key_serial_t) arg2);
16671da177e4SLinus Torvalds 
16681da177e4SLinus Torvalds 	case KEYCTL_LINK:
16691da177e4SLinus Torvalds 		return keyctl_keyring_link((key_serial_t) arg2,
16701da177e4SLinus Torvalds 					   (key_serial_t) arg3);
16711da177e4SLinus Torvalds 
16721da177e4SLinus Torvalds 	case KEYCTL_UNLINK:
16731da177e4SLinus Torvalds 		return keyctl_keyring_unlink((key_serial_t) arg2,
16741da177e4SLinus Torvalds 					     (key_serial_t) arg3);
16751da177e4SLinus Torvalds 
16761da177e4SLinus Torvalds 	case KEYCTL_SEARCH:
16771da177e4SLinus Torvalds 		return keyctl_keyring_search((key_serial_t) arg2,
16781da177e4SLinus Torvalds 					     (const char __user *) arg3,
16791da177e4SLinus Torvalds 					     (const char __user *) arg4,
16801da177e4SLinus Torvalds 					     (key_serial_t) arg5);
16811da177e4SLinus Torvalds 
16821da177e4SLinus Torvalds 	case KEYCTL_READ:
16831da177e4SLinus Torvalds 		return keyctl_read_key((key_serial_t) arg2,
16841da177e4SLinus Torvalds 				       (char __user *) arg3,
16851da177e4SLinus Torvalds 				       (size_t) arg4);
16861da177e4SLinus Torvalds 
16871da177e4SLinus Torvalds 	case KEYCTL_CHOWN:
16881da177e4SLinus Torvalds 		return keyctl_chown_key((key_serial_t) arg2,
16891da177e4SLinus Torvalds 					(uid_t) arg3,
16901da177e4SLinus Torvalds 					(gid_t) arg4);
16911da177e4SLinus Torvalds 
16921da177e4SLinus Torvalds 	case KEYCTL_SETPERM:
16931da177e4SLinus Torvalds 		return keyctl_setperm_key((key_serial_t) arg2,
16941da177e4SLinus Torvalds 					  (key_perm_t) arg3);
16951da177e4SLinus Torvalds 
16961da177e4SLinus Torvalds 	case KEYCTL_INSTANTIATE:
16971da177e4SLinus Torvalds 		return keyctl_instantiate_key((key_serial_t) arg2,
16981da177e4SLinus Torvalds 					      (const void __user *) arg3,
16991da177e4SLinus Torvalds 					      (size_t) arg4,
17001da177e4SLinus Torvalds 					      (key_serial_t) arg5);
17011da177e4SLinus Torvalds 
17021da177e4SLinus Torvalds 	case KEYCTL_NEGATE:
17031da177e4SLinus Torvalds 		return keyctl_negate_key((key_serial_t) arg2,
17041da177e4SLinus Torvalds 					 (unsigned) arg3,
17051da177e4SLinus Torvalds 					 (key_serial_t) arg4);
17061da177e4SLinus Torvalds 
17073e30148cSDavid Howells 	case KEYCTL_SET_REQKEY_KEYRING:
17083e30148cSDavid Howells 		return keyctl_set_reqkey_keyring(arg2);
17093e30148cSDavid Howells 
1710017679c4SDavid Howells 	case KEYCTL_SET_TIMEOUT:
1711017679c4SDavid Howells 		return keyctl_set_timeout((key_serial_t) arg2,
1712017679c4SDavid Howells 					  (unsigned) arg3);
1713017679c4SDavid Howells 
1714b5f545c8SDavid Howells 	case KEYCTL_ASSUME_AUTHORITY:
1715b5f545c8SDavid Howells 		return keyctl_assume_authority((key_serial_t) arg2);
1716b5f545c8SDavid Howells 
171770a5bb72SDavid Howells 	case KEYCTL_GET_SECURITY:
171870a5bb72SDavid Howells 		return keyctl_get_security((key_serial_t) arg2,
171990bd49abSJames Morris 					   (char __user *) arg3,
172070a5bb72SDavid Howells 					   (size_t) arg4);
172170a5bb72SDavid Howells 
1722ee18d64cSDavid Howells 	case KEYCTL_SESSION_TO_PARENT:
1723ee18d64cSDavid Howells 		return keyctl_session_to_parent();
1724ee18d64cSDavid Howells 
1725fdd1b945SDavid Howells 	case KEYCTL_REJECT:
1726fdd1b945SDavid Howells 		return keyctl_reject_key((key_serial_t) arg2,
1727fdd1b945SDavid Howells 					 (unsigned) arg3,
1728fdd1b945SDavid Howells 					 (unsigned) arg4,
1729fdd1b945SDavid Howells 					 (key_serial_t) arg5);
1730fdd1b945SDavid Howells 
1731ee009e4aSDavid Howells 	case KEYCTL_INSTANTIATE_IOV:
1732ee009e4aSDavid Howells 		return keyctl_instantiate_key_iov(
1733ee009e4aSDavid Howells 			(key_serial_t) arg2,
1734ee009e4aSDavid Howells 			(const struct iovec __user *) arg3,
1735ee009e4aSDavid Howells 			(unsigned) arg4,
1736ee009e4aSDavid Howells 			(key_serial_t) arg5);
1737ee009e4aSDavid Howells 
1738fd75815fSDavid Howells 	case KEYCTL_INVALIDATE:
1739fd75815fSDavid Howells 		return keyctl_invalidate_key((key_serial_t) arg2);
1740fd75815fSDavid Howells 
1741f36f8c75SDavid Howells 	case KEYCTL_GET_PERSISTENT:
1742f36f8c75SDavid Howells 		return keyctl_get_persistent((uid_t)arg2, (key_serial_t)arg3);
1743f36f8c75SDavid Howells 
1744ddbb4114SMat Martineau 	case KEYCTL_DH_COMPUTE:
1745ddbb4114SMat Martineau 		return keyctl_dh_compute((struct keyctl_dh_params __user *) arg2,
17464693fc73SStephan Mueller 					 (char __user *) arg3, (size_t) arg4,
17474693fc73SStephan Mueller 					 (void __user *) arg5);
1748ddbb4114SMat Martineau 
1749*6563c91fSMat Martineau 	case KEYCTL_RESTRICT_KEYRING:
1750*6563c91fSMat Martineau 		return keyctl_restrict_keyring((key_serial_t) arg2,
1751*6563c91fSMat Martineau 					       (const char __user *) arg3,
1752*6563c91fSMat Martineau 					       (const char __user *) arg4);
1753*6563c91fSMat Martineau 
17541da177e4SLinus Torvalds 	default:
17551da177e4SLinus Torvalds 		return -EOPNOTSUPP;
17561da177e4SLinus Torvalds 	}
1757a8b17ed0SDavid Howells }
1758