xref: /openbmc/linux/security/keys/keyctl.c (revision 18026d86)
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 
1025649645dSEric Biggers 	if (plen) {
1031da177e4SLinus Torvalds 		ret = -ENOMEM;
104752ade68SMichal Hocko 		payload = kvmalloc(plen, GFP_KERNEL);
1051da177e4SLinus Torvalds 		if (!payload)
1061da177e4SLinus Torvalds 			goto error2;
1071da177e4SLinus Torvalds 
1081da177e4SLinus Torvalds 		ret = -EFAULT;
1091da177e4SLinus Torvalds 		if (copy_from_user(payload, _payload, plen) != 0)
1101da177e4SLinus Torvalds 			goto error3;
1111da177e4SLinus Torvalds 	}
1121da177e4SLinus Torvalds 
1131da177e4SLinus Torvalds 	/* find the target keyring (which must be writable) */
114f5895943SDavid Howells 	keyring_ref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE);
115664cceb0SDavid Howells 	if (IS_ERR(keyring_ref)) {
116664cceb0SDavid Howells 		ret = PTR_ERR(keyring_ref);
1171da177e4SLinus Torvalds 		goto error3;
1181da177e4SLinus Torvalds 	}
1191da177e4SLinus Torvalds 
1201da177e4SLinus Torvalds 	/* create or update the requested key and add it to the target
1211da177e4SLinus Torvalds 	 * keyring */
122664cceb0SDavid Howells 	key_ref = key_create_or_update(keyring_ref, type, description,
1236b79ccb5SArun Raghavan 				       payload, plen, KEY_PERM_UNDEF,
1246b79ccb5SArun Raghavan 				       KEY_ALLOC_IN_QUOTA);
125664cceb0SDavid Howells 	if (!IS_ERR(key_ref)) {
126664cceb0SDavid Howells 		ret = key_ref_to_ptr(key_ref)->serial;
127664cceb0SDavid Howells 		key_ref_put(key_ref);
1281da177e4SLinus Torvalds 	}
1291da177e4SLinus Torvalds 	else {
130664cceb0SDavid Howells 		ret = PTR_ERR(key_ref);
1311da177e4SLinus Torvalds 	}
1321da177e4SLinus Torvalds 
133664cceb0SDavid Howells 	key_ref_put(keyring_ref);
1341da177e4SLinus Torvalds  error3:
13557070c85SEric Biggers 	if (payload) {
13657070c85SEric Biggers 		memzero_explicit(payload, plen);
137d0e0eba0SGeliang Tang 		kvfree(payload);
13857070c85SEric Biggers 	}
1391da177e4SLinus Torvalds  error2:
1401da177e4SLinus Torvalds 	kfree(description);
1411da177e4SLinus Torvalds  error:
1421da177e4SLinus Torvalds 	return ret;
143a8b17ed0SDavid Howells }
1441da177e4SLinus Torvalds 
1451da177e4SLinus Torvalds /*
146973c9f4fSDavid Howells  * Search the process keyrings and keyring trees linked from those for a
147973c9f4fSDavid Howells  * matching key.  Keyrings must have appropriate Search permission to be
148973c9f4fSDavid Howells  * searched.
149973c9f4fSDavid Howells  *
150973c9f4fSDavid Howells  * If a key is found, it will be attached to the destination keyring if there's
151973c9f4fSDavid Howells  * one specified and the serial number of the key will be returned.
152973c9f4fSDavid Howells  *
153973c9f4fSDavid Howells  * If no key is found, /sbin/request-key will be invoked if _callout_info is
154973c9f4fSDavid Howells  * non-NULL in an attempt to create a key.  The _callout_info string will be
155973c9f4fSDavid Howells  * passed to /sbin/request-key to aid with completing the request.  If the
156973c9f4fSDavid Howells  * _callout_info string is "" then it will be changed to "-".
1571da177e4SLinus Torvalds  */
1581e7bfb21SHeiko Carstens SYSCALL_DEFINE4(request_key, const char __user *, _type,
1591e7bfb21SHeiko Carstens 		const char __user *, _description,
1601e7bfb21SHeiko Carstens 		const char __user *, _callout_info,
1611e7bfb21SHeiko Carstens 		key_serial_t, destringid)
1621da177e4SLinus Torvalds {
1631da177e4SLinus Torvalds 	struct key_type *ktype;
164664cceb0SDavid Howells 	struct key *key;
165664cceb0SDavid Howells 	key_ref_t dest_ref;
1664a38e122SDavid Howells 	size_t callout_len;
1671da177e4SLinus Torvalds 	char type[32], *description, *callout_info;
1680cb409d9SDavi Arnaut 	long ret;
1691da177e4SLinus Torvalds 
1701da177e4SLinus Torvalds 	/* pull the type into kernel space */
1710cb409d9SDavi Arnaut 	ret = key_get_type_from_user(type, _type, sizeof(type));
1721da177e4SLinus Torvalds 	if (ret < 0)
1731da177e4SLinus Torvalds 		goto error;
1741260f801SDavid Howells 
1751da177e4SLinus Torvalds 	/* pull the description into kernel space */
176aa9d4437SDavid Howells 	description = strndup_user(_description, KEY_MAX_DESC_SIZE);
1770cb409d9SDavi Arnaut 	if (IS_ERR(description)) {
1780cb409d9SDavi Arnaut 		ret = PTR_ERR(description);
1791da177e4SLinus Torvalds 		goto error;
1800cb409d9SDavi Arnaut 	}
1811da177e4SLinus Torvalds 
1821da177e4SLinus Torvalds 	/* pull the callout info into kernel space */
1831da177e4SLinus Torvalds 	callout_info = NULL;
1844a38e122SDavid Howells 	callout_len = 0;
1851da177e4SLinus Torvalds 	if (_callout_info) {
1860cb409d9SDavi Arnaut 		callout_info = strndup_user(_callout_info, PAGE_SIZE);
1870cb409d9SDavi Arnaut 		if (IS_ERR(callout_info)) {
1880cb409d9SDavi Arnaut 			ret = PTR_ERR(callout_info);
1891da177e4SLinus Torvalds 			goto error2;
1900cb409d9SDavi Arnaut 		}
1914a38e122SDavid Howells 		callout_len = strlen(callout_info);
1921da177e4SLinus Torvalds 	}
1931da177e4SLinus Torvalds 
1941da177e4SLinus Torvalds 	/* get the destination keyring if specified */
195664cceb0SDavid Howells 	dest_ref = NULL;
1961da177e4SLinus Torvalds 	if (destringid) {
1975593122eSDavid Howells 		dest_ref = lookup_user_key(destringid, KEY_LOOKUP_CREATE,
198f5895943SDavid Howells 					   KEY_NEED_WRITE);
199664cceb0SDavid Howells 		if (IS_ERR(dest_ref)) {
200664cceb0SDavid Howells 			ret = PTR_ERR(dest_ref);
2011da177e4SLinus Torvalds 			goto error3;
2021da177e4SLinus Torvalds 		}
2031da177e4SLinus Torvalds 	}
2041da177e4SLinus Torvalds 
2051da177e4SLinus Torvalds 	/* find the key type */
2061da177e4SLinus Torvalds 	ktype = key_type_lookup(type);
2071da177e4SLinus Torvalds 	if (IS_ERR(ktype)) {
2081da177e4SLinus Torvalds 		ret = PTR_ERR(ktype);
2091da177e4SLinus Torvalds 		goto error4;
2101da177e4SLinus Torvalds 	}
2111da177e4SLinus Torvalds 
2121da177e4SLinus Torvalds 	/* do the search */
2134a38e122SDavid Howells 	key = request_key_and_link(ktype, description, callout_info,
2144a38e122SDavid Howells 				   callout_len, NULL, key_ref_to_ptr(dest_ref),
2157e047ef5SDavid Howells 				   KEY_ALLOC_IN_QUOTA);
2161da177e4SLinus Torvalds 	if (IS_ERR(key)) {
2171da177e4SLinus Torvalds 		ret = PTR_ERR(key);
2181da177e4SLinus Torvalds 		goto error5;
2191da177e4SLinus Torvalds 	}
2201da177e4SLinus Torvalds 
2214aab1e89SDavid Howells 	/* wait for the key to finish being constructed */
2224aab1e89SDavid Howells 	ret = wait_for_key_construction(key, 1);
2234aab1e89SDavid Howells 	if (ret < 0)
2244aab1e89SDavid Howells 		goto error6;
2254aab1e89SDavid Howells 
2261da177e4SLinus Torvalds 	ret = key->serial;
2271da177e4SLinus Torvalds 
2284aab1e89SDavid Howells error6:
2291da177e4SLinus Torvalds  	key_put(key);
2301da177e4SLinus Torvalds error5:
2311da177e4SLinus Torvalds 	key_type_put(ktype);
2321da177e4SLinus Torvalds error4:
233664cceb0SDavid Howells 	key_ref_put(dest_ref);
2341da177e4SLinus Torvalds error3:
2351da177e4SLinus Torvalds 	kfree(callout_info);
2361da177e4SLinus Torvalds error2:
2371da177e4SLinus Torvalds 	kfree(description);
2381da177e4SLinus Torvalds error:
2391da177e4SLinus Torvalds 	return ret;
240a8b17ed0SDavid Howells }
2411da177e4SLinus Torvalds 
2421da177e4SLinus Torvalds /*
243973c9f4fSDavid Howells  * Get the ID of the specified process keyring.
244973c9f4fSDavid Howells  *
245973c9f4fSDavid Howells  * The requested keyring must have search permission to be found.
246973c9f4fSDavid Howells  *
247973c9f4fSDavid Howells  * If successful, the ID of the requested keyring will be returned.
2481da177e4SLinus Torvalds  */
2491da177e4SLinus Torvalds long keyctl_get_keyring_ID(key_serial_t id, int create)
2501da177e4SLinus Torvalds {
251664cceb0SDavid Howells 	key_ref_t key_ref;
2525593122eSDavid Howells 	unsigned long lflags;
2531da177e4SLinus Torvalds 	long ret;
2541da177e4SLinus Torvalds 
2555593122eSDavid Howells 	lflags = create ? KEY_LOOKUP_CREATE : 0;
256f5895943SDavid Howells 	key_ref = lookup_user_key(id, lflags, KEY_NEED_SEARCH);
257664cceb0SDavid Howells 	if (IS_ERR(key_ref)) {
258664cceb0SDavid Howells 		ret = PTR_ERR(key_ref);
2591da177e4SLinus Torvalds 		goto error;
2601da177e4SLinus Torvalds 	}
2611da177e4SLinus Torvalds 
262664cceb0SDavid Howells 	ret = key_ref_to_ptr(key_ref)->serial;
263664cceb0SDavid Howells 	key_ref_put(key_ref);
2641da177e4SLinus Torvalds error:
2651da177e4SLinus Torvalds 	return ret;
266973c9f4fSDavid Howells }
2671da177e4SLinus Torvalds 
2681da177e4SLinus Torvalds /*
269973c9f4fSDavid Howells  * Join a (named) session keyring.
270973c9f4fSDavid Howells  *
271973c9f4fSDavid Howells  * Create and join an anonymous session keyring or join a named session
272973c9f4fSDavid Howells  * keyring, creating it if necessary.  A named session keyring must have Search
273973c9f4fSDavid Howells  * permission for it to be joined.  Session keyrings without this permit will
274ee8f844eSDavid Howells  * be skipped over.  It is not permitted for userspace to create or join
275ee8f844eSDavid Howells  * keyrings whose name begin with a dot.
276973c9f4fSDavid Howells  *
277973c9f4fSDavid Howells  * If successful, the ID of the joined session keyring will be returned.
2781da177e4SLinus Torvalds  */
2791da177e4SLinus Torvalds long keyctl_join_session_keyring(const char __user *_name)
2801da177e4SLinus Torvalds {
2811da177e4SLinus Torvalds 	char *name;
2820cb409d9SDavi Arnaut 	long ret;
2831da177e4SLinus Torvalds 
2841da177e4SLinus Torvalds 	/* fetch the name from userspace */
2851da177e4SLinus Torvalds 	name = NULL;
2861da177e4SLinus Torvalds 	if (_name) {
287aa9d4437SDavid Howells 		name = strndup_user(_name, KEY_MAX_DESC_SIZE);
2880cb409d9SDavi Arnaut 		if (IS_ERR(name)) {
2890cb409d9SDavi Arnaut 			ret = PTR_ERR(name);
2901da177e4SLinus Torvalds 			goto error;
2910cb409d9SDavi Arnaut 		}
292ee8f844eSDavid Howells 
293ee8f844eSDavid Howells 		ret = -EPERM;
294ee8f844eSDavid Howells 		if (name[0] == '.')
295ee8f844eSDavid Howells 			goto error_name;
2961da177e4SLinus Torvalds 	}
2971da177e4SLinus Torvalds 
2981da177e4SLinus Torvalds 	/* join the session */
2991da177e4SLinus Torvalds 	ret = join_session_keyring(name);
300ee8f844eSDavid Howells error_name:
3010d54ee1cSVegard Nossum 	kfree(name);
3021da177e4SLinus Torvalds error:
3031da177e4SLinus Torvalds 	return ret;
304a8b17ed0SDavid Howells }
3051da177e4SLinus Torvalds 
3061da177e4SLinus Torvalds /*
307973c9f4fSDavid Howells  * Update a key's data payload from the given data.
308973c9f4fSDavid Howells  *
309973c9f4fSDavid Howells  * The key must grant the caller Write permission and the key type must support
310973c9f4fSDavid Howells  * updating for this to work.  A negative key can be positively instantiated
311973c9f4fSDavid Howells  * with this call.
312973c9f4fSDavid Howells  *
313973c9f4fSDavid Howells  * If successful, 0 will be returned.  If the key type does not support
314973c9f4fSDavid Howells  * updating, then -EOPNOTSUPP will be returned.
3151da177e4SLinus Torvalds  */
3161da177e4SLinus Torvalds long keyctl_update_key(key_serial_t id,
3171da177e4SLinus Torvalds 		       const void __user *_payload,
3181da177e4SLinus Torvalds 		       size_t plen)
3191da177e4SLinus Torvalds {
320664cceb0SDavid Howells 	key_ref_t key_ref;
3211da177e4SLinus Torvalds 	void *payload;
3221da177e4SLinus Torvalds 	long ret;
3231da177e4SLinus Torvalds 
3241da177e4SLinus Torvalds 	ret = -EINVAL;
3251da177e4SLinus Torvalds 	if (plen > PAGE_SIZE)
3261da177e4SLinus Torvalds 		goto error;
3271da177e4SLinus Torvalds 
3281da177e4SLinus Torvalds 	/* pull the payload in if one was supplied */
3291da177e4SLinus Torvalds 	payload = NULL;
3305649645dSEric Biggers 	if (plen) {
3311da177e4SLinus Torvalds 		ret = -ENOMEM;
3321da177e4SLinus Torvalds 		payload = kmalloc(plen, GFP_KERNEL);
3331da177e4SLinus Torvalds 		if (!payload)
3341da177e4SLinus Torvalds 			goto error;
3351da177e4SLinus Torvalds 
3361da177e4SLinus Torvalds 		ret = -EFAULT;
3371da177e4SLinus Torvalds 		if (copy_from_user(payload, _payload, plen) != 0)
3381da177e4SLinus Torvalds 			goto error2;
3391da177e4SLinus Torvalds 	}
3401da177e4SLinus Torvalds 
3411da177e4SLinus Torvalds 	/* find the target key (which must be writable) */
342f5895943SDavid Howells 	key_ref = lookup_user_key(id, 0, KEY_NEED_WRITE);
343664cceb0SDavid Howells 	if (IS_ERR(key_ref)) {
344664cceb0SDavid Howells 		ret = PTR_ERR(key_ref);
3451da177e4SLinus Torvalds 		goto error2;
3461da177e4SLinus Torvalds 	}
3471da177e4SLinus Torvalds 
3481da177e4SLinus Torvalds 	/* update the key */
349664cceb0SDavid Howells 	ret = key_update(key_ref, payload, plen);
3501da177e4SLinus Torvalds 
351664cceb0SDavid Howells 	key_ref_put(key_ref);
3521da177e4SLinus Torvalds error2:
35357070c85SEric Biggers 	kzfree(payload);
3541da177e4SLinus Torvalds error:
3551da177e4SLinus Torvalds 	return ret;
356a8b17ed0SDavid Howells }
3571da177e4SLinus Torvalds 
3581da177e4SLinus Torvalds /*
359973c9f4fSDavid Howells  * Revoke a key.
360973c9f4fSDavid Howells  *
361973c9f4fSDavid Howells  * The key must be grant the caller Write or Setattr permission for this to
362973c9f4fSDavid Howells  * work.  The key type should give up its quota claim when revoked.  The key
363973c9f4fSDavid Howells  * and any links to the key will be automatically garbage collected after a
364973c9f4fSDavid Howells  * certain amount of time (/proc/sys/kernel/keys/gc_delay).
365973c9f4fSDavid Howells  *
366d3600bcfSMimi Zohar  * Keys with KEY_FLAG_KEEP set should not be revoked.
367d3600bcfSMimi Zohar  *
368973c9f4fSDavid Howells  * If successful, 0 is returned.
3691da177e4SLinus Torvalds  */
3701da177e4SLinus Torvalds long keyctl_revoke_key(key_serial_t id)
3711da177e4SLinus Torvalds {
372664cceb0SDavid Howells 	key_ref_t key_ref;
373d3600bcfSMimi Zohar 	struct key *key;
3741da177e4SLinus Torvalds 	long ret;
3751da177e4SLinus Torvalds 
376f5895943SDavid Howells 	key_ref = lookup_user_key(id, 0, KEY_NEED_WRITE);
377664cceb0SDavid Howells 	if (IS_ERR(key_ref)) {
378664cceb0SDavid Howells 		ret = PTR_ERR(key_ref);
3790c2c9a3fSDavid Howells 		if (ret != -EACCES)
3801da177e4SLinus Torvalds 			goto error;
381f5895943SDavid Howells 		key_ref = lookup_user_key(id, 0, KEY_NEED_SETATTR);
3820c2c9a3fSDavid Howells 		if (IS_ERR(key_ref)) {
3830c2c9a3fSDavid Howells 			ret = PTR_ERR(key_ref);
3840c2c9a3fSDavid Howells 			goto error;
3850c2c9a3fSDavid Howells 		}
3861da177e4SLinus Torvalds 	}
3871da177e4SLinus Torvalds 
388d3600bcfSMimi Zohar 	key = key_ref_to_ptr(key_ref);
3891da177e4SLinus Torvalds 	ret = 0;
3901d6d167cSMimi Zohar 	if (test_bit(KEY_FLAG_KEEP, &key->flags))
3911d6d167cSMimi Zohar 		ret = -EPERM;
3921d6d167cSMimi Zohar 	else
3931d6d167cSMimi Zohar 		key_revoke(key);
3941da177e4SLinus Torvalds 
395664cceb0SDavid Howells 	key_ref_put(key_ref);
3961da177e4SLinus Torvalds error:
3971260f801SDavid Howells 	return ret;
398a8b17ed0SDavid Howells }
3991da177e4SLinus Torvalds 
4001da177e4SLinus Torvalds /*
401fd75815fSDavid Howells  * Invalidate a key.
402fd75815fSDavid Howells  *
403fd75815fSDavid Howells  * The key must be grant the caller Invalidate permission for this to work.
404fd75815fSDavid Howells  * The key and any links to the key will be automatically garbage collected
405fd75815fSDavid Howells  * immediately.
406fd75815fSDavid Howells  *
407d3600bcfSMimi Zohar  * Keys with KEY_FLAG_KEEP set should not be invalidated.
408d3600bcfSMimi Zohar  *
409fd75815fSDavid Howells  * If successful, 0 is returned.
410fd75815fSDavid Howells  */
411fd75815fSDavid Howells long keyctl_invalidate_key(key_serial_t id)
412fd75815fSDavid Howells {
413fd75815fSDavid Howells 	key_ref_t key_ref;
414d3600bcfSMimi Zohar 	struct key *key;
415fd75815fSDavid Howells 	long ret;
416fd75815fSDavid Howells 
417fd75815fSDavid Howells 	kenter("%d", id);
418fd75815fSDavid Howells 
419f5895943SDavid Howells 	key_ref = lookup_user_key(id, 0, KEY_NEED_SEARCH);
420fd75815fSDavid Howells 	if (IS_ERR(key_ref)) {
421fd75815fSDavid Howells 		ret = PTR_ERR(key_ref);
4220c7774abSDavid Howells 
4230c7774abSDavid Howells 		/* Root is permitted to invalidate certain special keys */
4240c7774abSDavid Howells 		if (capable(CAP_SYS_ADMIN)) {
4250c7774abSDavid Howells 			key_ref = lookup_user_key(id, 0, 0);
4260c7774abSDavid Howells 			if (IS_ERR(key_ref))
4270c7774abSDavid Howells 				goto error;
4280c7774abSDavid Howells 			if (test_bit(KEY_FLAG_ROOT_CAN_INVAL,
4290c7774abSDavid Howells 				     &key_ref_to_ptr(key_ref)->flags))
4300c7774abSDavid Howells 				goto invalidate;
4310c7774abSDavid Howells 			goto error_put;
4320c7774abSDavid Howells 		}
4330c7774abSDavid Howells 
434fd75815fSDavid Howells 		goto error;
435fd75815fSDavid Howells 	}
436fd75815fSDavid Howells 
4370c7774abSDavid Howells invalidate:
438d3600bcfSMimi Zohar 	key = key_ref_to_ptr(key_ref);
439fd75815fSDavid Howells 	ret = 0;
440d3600bcfSMimi Zohar 	if (test_bit(KEY_FLAG_KEEP, &key->flags))
441d3600bcfSMimi Zohar 		ret = -EPERM;
4421d6d167cSMimi Zohar 	else
443d3600bcfSMimi Zohar 		key_invalidate(key);
4440c7774abSDavid Howells error_put:
445fd75815fSDavid Howells 	key_ref_put(key_ref);
446fd75815fSDavid Howells error:
447fd75815fSDavid Howells 	kleave(" = %ld", ret);
448fd75815fSDavid Howells 	return ret;
449fd75815fSDavid Howells }
450fd75815fSDavid Howells 
451fd75815fSDavid Howells /*
452973c9f4fSDavid Howells  * Clear the specified keyring, creating an empty process keyring if one of the
453973c9f4fSDavid Howells  * special keyring IDs is used.
454973c9f4fSDavid Howells  *
455d3600bcfSMimi Zohar  * The keyring must grant the caller Write permission and not have
456d3600bcfSMimi Zohar  * KEY_FLAG_KEEP set for this to work.  If successful, 0 will be returned.
4571da177e4SLinus Torvalds  */
4581da177e4SLinus Torvalds long keyctl_keyring_clear(key_serial_t ringid)
4591da177e4SLinus Torvalds {
460664cceb0SDavid Howells 	key_ref_t keyring_ref;
461d3600bcfSMimi Zohar 	struct key *keyring;
4621da177e4SLinus Torvalds 	long ret;
4631da177e4SLinus Torvalds 
464f5895943SDavid Howells 	keyring_ref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE);
465664cceb0SDavid Howells 	if (IS_ERR(keyring_ref)) {
466664cceb0SDavid Howells 		ret = PTR_ERR(keyring_ref);
467700920ebSDavid Howells 
468700920ebSDavid Howells 		/* Root is permitted to invalidate certain special keyrings */
469700920ebSDavid Howells 		if (capable(CAP_SYS_ADMIN)) {
470700920ebSDavid Howells 			keyring_ref = lookup_user_key(ringid, 0, 0);
471700920ebSDavid Howells 			if (IS_ERR(keyring_ref))
472700920ebSDavid Howells 				goto error;
473700920ebSDavid Howells 			if (test_bit(KEY_FLAG_ROOT_CAN_CLEAR,
474700920ebSDavid Howells 				     &key_ref_to_ptr(keyring_ref)->flags))
475700920ebSDavid Howells 				goto clear;
476700920ebSDavid Howells 			goto error_put;
477700920ebSDavid Howells 		}
478700920ebSDavid Howells 
4791da177e4SLinus Torvalds 		goto error;
4801da177e4SLinus Torvalds 	}
4811da177e4SLinus Torvalds 
482700920ebSDavid Howells clear:
483d3600bcfSMimi Zohar 	keyring = key_ref_to_ptr(keyring_ref);
484d3600bcfSMimi Zohar 	if (test_bit(KEY_FLAG_KEEP, &keyring->flags))
485d3600bcfSMimi Zohar 		ret = -EPERM;
486d3600bcfSMimi Zohar 	else
487d3600bcfSMimi Zohar 		ret = keyring_clear(keyring);
488700920ebSDavid Howells error_put:
489664cceb0SDavid Howells 	key_ref_put(keyring_ref);
4901da177e4SLinus Torvalds error:
4911da177e4SLinus Torvalds 	return ret;
492a8b17ed0SDavid Howells }
4931da177e4SLinus Torvalds 
4941da177e4SLinus Torvalds /*
495973c9f4fSDavid Howells  * Create a link from a keyring to a key if there's no matching key in the
496973c9f4fSDavid Howells  * keyring, otherwise replace the link to the matching key with a link to the
497973c9f4fSDavid Howells  * new key.
498973c9f4fSDavid Howells  *
499973c9f4fSDavid Howells  * The key must grant the caller Link permission and the the keyring must grant
500973c9f4fSDavid Howells  * the caller Write permission.  Furthermore, if an additional link is created,
501973c9f4fSDavid Howells  * the keyring's quota will be extended.
502973c9f4fSDavid Howells  *
503973c9f4fSDavid Howells  * If successful, 0 will be returned.
5041da177e4SLinus Torvalds  */
5051da177e4SLinus Torvalds long keyctl_keyring_link(key_serial_t id, key_serial_t ringid)
5061da177e4SLinus Torvalds {
507664cceb0SDavid Howells 	key_ref_t keyring_ref, key_ref;
5081da177e4SLinus Torvalds 	long ret;
5091da177e4SLinus Torvalds 
510f5895943SDavid Howells 	keyring_ref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE);
511664cceb0SDavid Howells 	if (IS_ERR(keyring_ref)) {
512664cceb0SDavid Howells 		ret = PTR_ERR(keyring_ref);
5131da177e4SLinus Torvalds 		goto error;
5141da177e4SLinus Torvalds 	}
5151da177e4SLinus Torvalds 
516f5895943SDavid Howells 	key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE, KEY_NEED_LINK);
517664cceb0SDavid Howells 	if (IS_ERR(key_ref)) {
518664cceb0SDavid Howells 		ret = PTR_ERR(key_ref);
5191da177e4SLinus Torvalds 		goto error2;
5201da177e4SLinus Torvalds 	}
5211da177e4SLinus Torvalds 
522664cceb0SDavid Howells 	ret = key_link(key_ref_to_ptr(keyring_ref), key_ref_to_ptr(key_ref));
5231da177e4SLinus Torvalds 
524664cceb0SDavid Howells 	key_ref_put(key_ref);
5251da177e4SLinus Torvalds error2:
526664cceb0SDavid Howells 	key_ref_put(keyring_ref);
5271da177e4SLinus Torvalds error:
5281da177e4SLinus Torvalds 	return ret;
529a8b17ed0SDavid Howells }
5301da177e4SLinus Torvalds 
5311da177e4SLinus Torvalds /*
532973c9f4fSDavid Howells  * Unlink a key from a keyring.
533973c9f4fSDavid Howells  *
534973c9f4fSDavid Howells  * The keyring must grant the caller Write permission for this to work; the key
535973c9f4fSDavid Howells  * itself need not grant the caller anything.  If the last link to a key is
536973c9f4fSDavid Howells  * removed then that key will be scheduled for destruction.
537973c9f4fSDavid Howells  *
538d3600bcfSMimi Zohar  * Keys or keyrings with KEY_FLAG_KEEP set should not be unlinked.
539d3600bcfSMimi Zohar  *
540973c9f4fSDavid Howells  * If successful, 0 will be returned.
5411da177e4SLinus Torvalds  */
5421da177e4SLinus Torvalds long keyctl_keyring_unlink(key_serial_t id, key_serial_t ringid)
5431da177e4SLinus Torvalds {
544664cceb0SDavid Howells 	key_ref_t keyring_ref, key_ref;
545d3600bcfSMimi Zohar 	struct key *keyring, *key;
5461da177e4SLinus Torvalds 	long ret;
5471da177e4SLinus Torvalds 
548f5895943SDavid Howells 	keyring_ref = lookup_user_key(ringid, 0, KEY_NEED_WRITE);
549664cceb0SDavid Howells 	if (IS_ERR(keyring_ref)) {
550664cceb0SDavid Howells 		ret = PTR_ERR(keyring_ref);
5511da177e4SLinus Torvalds 		goto error;
5521da177e4SLinus Torvalds 	}
5531da177e4SLinus Torvalds 
5545593122eSDavid Howells 	key_ref = lookup_user_key(id, KEY_LOOKUP_FOR_UNLINK, 0);
555664cceb0SDavid Howells 	if (IS_ERR(key_ref)) {
556664cceb0SDavid Howells 		ret = PTR_ERR(key_ref);
5571da177e4SLinus Torvalds 		goto error2;
5581da177e4SLinus Torvalds 	}
5591da177e4SLinus Torvalds 
560d3600bcfSMimi Zohar 	keyring = key_ref_to_ptr(keyring_ref);
561d3600bcfSMimi Zohar 	key = key_ref_to_ptr(key_ref);
562d3600bcfSMimi Zohar 	if (test_bit(KEY_FLAG_KEEP, &keyring->flags) &&
563d3600bcfSMimi Zohar 	    test_bit(KEY_FLAG_KEEP, &key->flags))
564d3600bcfSMimi Zohar 		ret = -EPERM;
565d3600bcfSMimi Zohar 	else
566d3600bcfSMimi Zohar 		ret = key_unlink(keyring, key);
5671da177e4SLinus Torvalds 
568664cceb0SDavid Howells 	key_ref_put(key_ref);
5691da177e4SLinus Torvalds error2:
570664cceb0SDavid Howells 	key_ref_put(keyring_ref);
5711da177e4SLinus Torvalds error:
5721da177e4SLinus Torvalds 	return ret;
573a8b17ed0SDavid Howells }
5741da177e4SLinus Torvalds 
5751da177e4SLinus Torvalds /*
576973c9f4fSDavid Howells  * Return a description of a key to userspace.
577973c9f4fSDavid Howells  *
578973c9f4fSDavid Howells  * The key must grant the caller View permission for this to work.
579973c9f4fSDavid Howells  *
580973c9f4fSDavid Howells  * If there's a buffer, we place up to buflen bytes of data into it formatted
581973c9f4fSDavid Howells  * in the following way:
582973c9f4fSDavid Howells  *
5831da177e4SLinus Torvalds  *	type;uid;gid;perm;description<NUL>
584973c9f4fSDavid Howells  *
585973c9f4fSDavid Howells  * If successful, we return the amount of description available, irrespective
586973c9f4fSDavid Howells  * of how much we may have copied into the buffer.
5871da177e4SLinus Torvalds  */
5881da177e4SLinus Torvalds long keyctl_describe_key(key_serial_t keyid,
5891da177e4SLinus Torvalds 			 char __user *buffer,
5901da177e4SLinus Torvalds 			 size_t buflen)
5911da177e4SLinus Torvalds {
5923e30148cSDavid Howells 	struct key *key, *instkey;
593664cceb0SDavid Howells 	key_ref_t key_ref;
594aa9d4437SDavid Howells 	char *infobuf;
5951da177e4SLinus Torvalds 	long ret;
596aa9d4437SDavid Howells 	int desclen, infolen;
5971da177e4SLinus Torvalds 
598f5895943SDavid Howells 	key_ref = lookup_user_key(keyid, KEY_LOOKUP_PARTIAL, KEY_NEED_VIEW);
599664cceb0SDavid Howells 	if (IS_ERR(key_ref)) {
6003e30148cSDavid Howells 		/* viewing a key under construction is permitted if we have the
6013e30148cSDavid Howells 		 * authorisation token handy */
602664cceb0SDavid Howells 		if (PTR_ERR(key_ref) == -EACCES) {
6033e30148cSDavid Howells 			instkey = key_get_instantiation_authkey(keyid);
6043e30148cSDavid Howells 			if (!IS_ERR(instkey)) {
6053e30148cSDavid Howells 				key_put(instkey);
6068bbf4976SDavid Howells 				key_ref = lookup_user_key(keyid,
6075593122eSDavid Howells 							  KEY_LOOKUP_PARTIAL,
6085593122eSDavid Howells 							  0);
609664cceb0SDavid Howells 				if (!IS_ERR(key_ref))
6103e30148cSDavid Howells 					goto okay;
6113e30148cSDavid Howells 			}
6123e30148cSDavid Howells 		}
6133e30148cSDavid Howells 
614664cceb0SDavid Howells 		ret = PTR_ERR(key_ref);
6151da177e4SLinus Torvalds 		goto error;
6161da177e4SLinus Torvalds 	}
6171da177e4SLinus Torvalds 
6183e30148cSDavid Howells okay:
619664cceb0SDavid Howells 	key = key_ref_to_ptr(key_ref);
620aa9d4437SDavid Howells 	desclen = strlen(key->description);
621664cceb0SDavid Howells 
622aa9d4437SDavid Howells 	/* calculate how much information we're going to return */
623aa9d4437SDavid Howells 	ret = -ENOMEM;
624aa9d4437SDavid Howells 	infobuf = kasprintf(GFP_KERNEL,
625aa9d4437SDavid Howells 			    "%s;%d;%d;%08x;",
62694fd8405SDavid Howells 			    key->type->name,
6279a56c2dbSEric W. Biederman 			    from_kuid_munged(current_user_ns(), key->uid),
6289a56c2dbSEric W. Biederman 			    from_kgid_munged(current_user_ns(), key->gid),
629aa9d4437SDavid Howells 			    key->perm);
630aa9d4437SDavid Howells 	if (!infobuf)
631aa9d4437SDavid Howells 		goto error2;
632aa9d4437SDavid Howells 	infolen = strlen(infobuf);
633aa9d4437SDavid Howells 	ret = infolen + desclen + 1;
6341da177e4SLinus Torvalds 
6351da177e4SLinus Torvalds 	/* consider returning the data */
636aa9d4437SDavid Howells 	if (buffer && buflen >= ret) {
637aa9d4437SDavid Howells 		if (copy_to_user(buffer, infobuf, infolen) != 0 ||
638aa9d4437SDavid Howells 		    copy_to_user(buffer + infolen, key->description,
639aa9d4437SDavid Howells 				 desclen + 1) != 0)
6401da177e4SLinus Torvalds 			ret = -EFAULT;
6411da177e4SLinus Torvalds 	}
6421da177e4SLinus Torvalds 
643aa9d4437SDavid Howells 	kfree(infobuf);
6441da177e4SLinus Torvalds error2:
645664cceb0SDavid Howells 	key_ref_put(key_ref);
6461da177e4SLinus Torvalds error:
6471da177e4SLinus Torvalds 	return ret;
648a8b17ed0SDavid Howells }
6491da177e4SLinus Torvalds 
6501da177e4SLinus Torvalds /*
651973c9f4fSDavid Howells  * Search the specified keyring and any keyrings it links to for a matching
652973c9f4fSDavid Howells  * key.  Only keyrings that grant the caller Search permission will be searched
653973c9f4fSDavid Howells  * (this includes the starting keyring).  Only keys with Search permission can
654973c9f4fSDavid Howells  * be found.
655973c9f4fSDavid Howells  *
656973c9f4fSDavid Howells  * If successful, the found key will be linked to the destination keyring if
657973c9f4fSDavid Howells  * supplied and the key has Link permission, and the found key ID will be
658973c9f4fSDavid Howells  * returned.
6591da177e4SLinus Torvalds  */
6601da177e4SLinus Torvalds long keyctl_keyring_search(key_serial_t ringid,
6611da177e4SLinus Torvalds 			   const char __user *_type,
6621da177e4SLinus Torvalds 			   const char __user *_description,
6631da177e4SLinus Torvalds 			   key_serial_t destringid)
6641da177e4SLinus Torvalds {
6651da177e4SLinus Torvalds 	struct key_type *ktype;
666664cceb0SDavid Howells 	key_ref_t keyring_ref, key_ref, dest_ref;
6671da177e4SLinus Torvalds 	char type[32], *description;
6680cb409d9SDavi Arnaut 	long ret;
6691da177e4SLinus Torvalds 
6701da177e4SLinus Torvalds 	/* pull the type and description into kernel space */
6710cb409d9SDavi Arnaut 	ret = key_get_type_from_user(type, _type, sizeof(type));
6721da177e4SLinus Torvalds 	if (ret < 0)
6731da177e4SLinus Torvalds 		goto error;
6741da177e4SLinus Torvalds 
675aa9d4437SDavid Howells 	description = strndup_user(_description, KEY_MAX_DESC_SIZE);
6760cb409d9SDavi Arnaut 	if (IS_ERR(description)) {
6770cb409d9SDavi Arnaut 		ret = PTR_ERR(description);
6781da177e4SLinus Torvalds 		goto error;
6790cb409d9SDavi Arnaut 	}
6801da177e4SLinus Torvalds 
6811da177e4SLinus Torvalds 	/* get the keyring at which to begin the search */
682f5895943SDavid Howells 	keyring_ref = lookup_user_key(ringid, 0, KEY_NEED_SEARCH);
683664cceb0SDavid Howells 	if (IS_ERR(keyring_ref)) {
684664cceb0SDavid Howells 		ret = PTR_ERR(keyring_ref);
6851da177e4SLinus Torvalds 		goto error2;
6861da177e4SLinus Torvalds 	}
6871da177e4SLinus Torvalds 
6881da177e4SLinus Torvalds 	/* get the destination keyring if specified */
689664cceb0SDavid Howells 	dest_ref = NULL;
6901da177e4SLinus Torvalds 	if (destringid) {
6915593122eSDavid Howells 		dest_ref = lookup_user_key(destringid, KEY_LOOKUP_CREATE,
692f5895943SDavid Howells 					   KEY_NEED_WRITE);
693664cceb0SDavid Howells 		if (IS_ERR(dest_ref)) {
694664cceb0SDavid Howells 			ret = PTR_ERR(dest_ref);
6951da177e4SLinus Torvalds 			goto error3;
6961da177e4SLinus Torvalds 		}
6971da177e4SLinus Torvalds 	}
6981da177e4SLinus Torvalds 
6991da177e4SLinus Torvalds 	/* find the key type */
7001da177e4SLinus Torvalds 	ktype = key_type_lookup(type);
7011da177e4SLinus Torvalds 	if (IS_ERR(ktype)) {
7021da177e4SLinus Torvalds 		ret = PTR_ERR(ktype);
7031da177e4SLinus Torvalds 		goto error4;
7041da177e4SLinus Torvalds 	}
7051da177e4SLinus Torvalds 
7061da177e4SLinus Torvalds 	/* do the search */
707664cceb0SDavid Howells 	key_ref = keyring_search(keyring_ref, ktype, description);
708664cceb0SDavid Howells 	if (IS_ERR(key_ref)) {
709664cceb0SDavid Howells 		ret = PTR_ERR(key_ref);
7101da177e4SLinus Torvalds 
7111da177e4SLinus Torvalds 		/* treat lack or presence of a negative key the same */
7121da177e4SLinus Torvalds 		if (ret == -EAGAIN)
7131da177e4SLinus Torvalds 			ret = -ENOKEY;
7141da177e4SLinus Torvalds 		goto error5;
7151da177e4SLinus Torvalds 	}
7161da177e4SLinus Torvalds 
7171da177e4SLinus Torvalds 	/* link the resulting key to the destination keyring if we can */
718664cceb0SDavid Howells 	if (dest_ref) {
719f5895943SDavid Howells 		ret = key_permission(key_ref, KEY_NEED_LINK);
72029db9190SDavid Howells 		if (ret < 0)
7211da177e4SLinus Torvalds 			goto error6;
7221da177e4SLinus Torvalds 
723664cceb0SDavid Howells 		ret = key_link(key_ref_to_ptr(dest_ref), key_ref_to_ptr(key_ref));
7241da177e4SLinus Torvalds 		if (ret < 0)
7251da177e4SLinus Torvalds 			goto error6;
7261da177e4SLinus Torvalds 	}
7271da177e4SLinus Torvalds 
728664cceb0SDavid Howells 	ret = key_ref_to_ptr(key_ref)->serial;
7291da177e4SLinus Torvalds 
7301da177e4SLinus Torvalds error6:
731664cceb0SDavid Howells 	key_ref_put(key_ref);
7321da177e4SLinus Torvalds error5:
7331da177e4SLinus Torvalds 	key_type_put(ktype);
7341da177e4SLinus Torvalds error4:
735664cceb0SDavid Howells 	key_ref_put(dest_ref);
7361da177e4SLinus Torvalds error3:
737664cceb0SDavid Howells 	key_ref_put(keyring_ref);
7381da177e4SLinus Torvalds error2:
7391da177e4SLinus Torvalds 	kfree(description);
7401da177e4SLinus Torvalds error:
7411da177e4SLinus Torvalds 	return ret;
742a8b17ed0SDavid Howells }
7431da177e4SLinus Torvalds 
7441da177e4SLinus Torvalds /*
745973c9f4fSDavid Howells  * Read a key's payload.
746973c9f4fSDavid Howells  *
747973c9f4fSDavid Howells  * The key must either grant the caller Read permission, or it must grant the
748973c9f4fSDavid Howells  * caller Search permission when searched for from the process keyrings.
749973c9f4fSDavid Howells  *
750973c9f4fSDavid Howells  * If successful, we place up to buflen bytes of data into the buffer, if one
751973c9f4fSDavid Howells  * is provided, and return the amount of data that is available in the key,
752973c9f4fSDavid Howells  * irrespective of how much we copied into the buffer.
7531da177e4SLinus Torvalds  */
7541da177e4SLinus Torvalds long keyctl_read_key(key_serial_t keyid, char __user *buffer, size_t buflen)
7551da177e4SLinus Torvalds {
756664cceb0SDavid Howells 	struct key *key;
757664cceb0SDavid Howells 	key_ref_t key_ref;
7581da177e4SLinus Torvalds 	long ret;
7591da177e4SLinus Torvalds 
7601da177e4SLinus Torvalds 	/* find the key first */
7615593122eSDavid Howells 	key_ref = lookup_user_key(keyid, 0, 0);
762664cceb0SDavid Howells 	if (IS_ERR(key_ref)) {
763664cceb0SDavid Howells 		ret = -ENOKEY;
764664cceb0SDavid Howells 		goto error;
765664cceb0SDavid Howells 	}
766664cceb0SDavid Howells 
767664cceb0SDavid Howells 	key = key_ref_to_ptr(key_ref);
768664cceb0SDavid Howells 
769363b02daSDavid Howells 	ret = key_read_state(key);
770363b02daSDavid Howells 	if (ret < 0)
771363b02daSDavid Howells 		goto error2; /* Negatively instantiated */
77237863c43SEric Biggers 
7731da177e4SLinus Torvalds 	/* see if we can read it directly */
774f5895943SDavid Howells 	ret = key_permission(key_ref, KEY_NEED_READ);
77529db9190SDavid Howells 	if (ret == 0)
7761da177e4SLinus Torvalds 		goto can_read_key;
77729db9190SDavid Howells 	if (ret != -EACCES)
7787fc0786dSEric Biggers 		goto error2;
7791da177e4SLinus Torvalds 
780664cceb0SDavid Howells 	/* we can't; see if it's searchable from this process's keyrings
7813e30148cSDavid Howells 	 * - we automatically take account of the fact that it may be
7823e30148cSDavid Howells 	 *   dangling off an instantiation key
7833e30148cSDavid Howells 	 */
784664cceb0SDavid Howells 	if (!is_key_possessed(key_ref)) {
7851260f801SDavid Howells 		ret = -EACCES;
7861da177e4SLinus Torvalds 		goto error2;
7871da177e4SLinus Torvalds 	}
7881da177e4SLinus Torvalds 
7891da177e4SLinus Torvalds 	/* the key is probably readable - now try to read it */
7901da177e4SLinus Torvalds can_read_key:
7911da177e4SLinus Torvalds 	ret = -EOPNOTSUPP;
7921da177e4SLinus Torvalds 	if (key->type->read) {
793b4a1b4f5SDavid Howells 		/* Read the data with the semaphore held (since we might sleep)
794b4a1b4f5SDavid Howells 		 * to protect against the key being updated or revoked.
795b4a1b4f5SDavid Howells 		 */
7961da177e4SLinus Torvalds 		down_read(&key->sem);
797b4a1b4f5SDavid Howells 		ret = key_validate(key);
798b4a1b4f5SDavid Howells 		if (ret == 0)
7991da177e4SLinus Torvalds 			ret = key->type->read(key, buffer, buflen);
8001da177e4SLinus Torvalds 		up_read(&key->sem);
8011da177e4SLinus Torvalds 	}
8021da177e4SLinus Torvalds 
8031da177e4SLinus Torvalds error2:
8041da177e4SLinus Torvalds 	key_put(key);
8051da177e4SLinus Torvalds error:
8061da177e4SLinus Torvalds 	return ret;
807a8b17ed0SDavid Howells }
8081da177e4SLinus Torvalds 
8091da177e4SLinus Torvalds /*
810973c9f4fSDavid Howells  * Change the ownership of a key
811973c9f4fSDavid Howells  *
812973c9f4fSDavid Howells  * The key must grant the caller Setattr permission for this to work, though
813973c9f4fSDavid Howells  * the key need not be fully instantiated yet.  For the UID to be changed, or
814973c9f4fSDavid Howells  * for the GID to be changed to a group the caller is not a member of, the
815973c9f4fSDavid Howells  * caller must have sysadmin capability.  If either uid or gid is -1 then that
816973c9f4fSDavid Howells  * attribute is not changed.
817973c9f4fSDavid Howells  *
818973c9f4fSDavid Howells  * If the UID is to be changed, the new user must have sufficient quota to
819973c9f4fSDavid Howells  * accept the key.  The quota deduction will be removed from the old user to
820973c9f4fSDavid Howells  * the new user should the attribute be changed.
821973c9f4fSDavid Howells  *
822973c9f4fSDavid Howells  * If successful, 0 will be returned.
8231da177e4SLinus Torvalds  */
8249a56c2dbSEric W. Biederman long keyctl_chown_key(key_serial_t id, uid_t user, gid_t group)
8251da177e4SLinus Torvalds {
8265801649dSFredrik Tolf 	struct key_user *newowner, *zapowner = NULL;
8271da177e4SLinus Torvalds 	struct key *key;
828664cceb0SDavid Howells 	key_ref_t key_ref;
8291da177e4SLinus Torvalds 	long ret;
8309a56c2dbSEric W. Biederman 	kuid_t uid;
8319a56c2dbSEric W. Biederman 	kgid_t gid;
8329a56c2dbSEric W. Biederman 
8339a56c2dbSEric W. Biederman 	uid = make_kuid(current_user_ns(), user);
8349a56c2dbSEric W. Biederman 	gid = make_kgid(current_user_ns(), group);
8359a56c2dbSEric W. Biederman 	ret = -EINVAL;
8369a56c2dbSEric W. Biederman 	if ((user != (uid_t) -1) && !uid_valid(uid))
8379a56c2dbSEric W. Biederman 		goto error;
8389a56c2dbSEric W. Biederman 	if ((group != (gid_t) -1) && !gid_valid(gid))
8399a56c2dbSEric W. Biederman 		goto error;
8401da177e4SLinus Torvalds 
8411da177e4SLinus Torvalds 	ret = 0;
8429a56c2dbSEric W. Biederman 	if (user == (uid_t) -1 && group == (gid_t) -1)
8431da177e4SLinus Torvalds 		goto error;
8441da177e4SLinus Torvalds 
8455593122eSDavid Howells 	key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE | KEY_LOOKUP_PARTIAL,
846f5895943SDavid Howells 				  KEY_NEED_SETATTR);
847664cceb0SDavid Howells 	if (IS_ERR(key_ref)) {
848664cceb0SDavid Howells 		ret = PTR_ERR(key_ref);
8491da177e4SLinus Torvalds 		goto error;
8501da177e4SLinus Torvalds 	}
8511da177e4SLinus Torvalds 
852664cceb0SDavid Howells 	key = key_ref_to_ptr(key_ref);
853664cceb0SDavid Howells 
8541da177e4SLinus Torvalds 	/* make the changes with the locks held to prevent chown/chown races */
8551da177e4SLinus Torvalds 	ret = -EACCES;
8561da177e4SLinus Torvalds 	down_write(&key->sem);
8571da177e4SLinus Torvalds 
8581da177e4SLinus Torvalds 	if (!capable(CAP_SYS_ADMIN)) {
8591da177e4SLinus Torvalds 		/* only the sysadmin can chown a key to some other UID */
8609a56c2dbSEric W. Biederman 		if (user != (uid_t) -1 && !uid_eq(key->uid, uid))
8615801649dSFredrik Tolf 			goto error_put;
8621da177e4SLinus Torvalds 
8631da177e4SLinus Torvalds 		/* only the sysadmin can set the key's GID to a group other
8641da177e4SLinus Torvalds 		 * than one of those that the current process subscribes to */
8659a56c2dbSEric W. Biederman 		if (group != (gid_t) -1 && !gid_eq(gid, key->gid) && !in_group_p(gid))
8665801649dSFredrik Tolf 			goto error_put;
8671da177e4SLinus Torvalds 	}
8681da177e4SLinus Torvalds 
8695801649dSFredrik Tolf 	/* change the UID */
8709a56c2dbSEric W. Biederman 	if (user != (uid_t) -1 && !uid_eq(uid, key->uid)) {
8715801649dSFredrik Tolf 		ret = -ENOMEM;
8729a56c2dbSEric W. Biederman 		newowner = key_user_lookup(uid);
8735801649dSFredrik Tolf 		if (!newowner)
8745801649dSFredrik Tolf 			goto error_put;
8755801649dSFredrik Tolf 
8765801649dSFredrik Tolf 		/* transfer the quota burden to the new user */
8775801649dSFredrik Tolf 		if (test_bit(KEY_FLAG_IN_QUOTA, &key->flags)) {
8789a56c2dbSEric W. Biederman 			unsigned maxkeys = uid_eq(uid, GLOBAL_ROOT_UID) ?
8790b77f5bfSDavid Howells 				key_quota_root_maxkeys : key_quota_maxkeys;
8809a56c2dbSEric W. Biederman 			unsigned maxbytes = uid_eq(uid, GLOBAL_ROOT_UID) ?
8810b77f5bfSDavid Howells 				key_quota_root_maxbytes : key_quota_maxbytes;
8820b77f5bfSDavid Howells 
8835801649dSFredrik Tolf 			spin_lock(&newowner->lock);
8840b77f5bfSDavid Howells 			if (newowner->qnkeys + 1 >= maxkeys ||
8850b77f5bfSDavid Howells 			    newowner->qnbytes + key->quotalen >= maxbytes ||
8860b77f5bfSDavid Howells 			    newowner->qnbytes + key->quotalen <
8870b77f5bfSDavid Howells 			    newowner->qnbytes)
8885801649dSFredrik Tolf 				goto quota_overrun;
8895801649dSFredrik Tolf 
8905801649dSFredrik Tolf 			newowner->qnkeys++;
8915801649dSFredrik Tolf 			newowner->qnbytes += key->quotalen;
8925801649dSFredrik Tolf 			spin_unlock(&newowner->lock);
8935801649dSFredrik Tolf 
8945801649dSFredrik Tolf 			spin_lock(&key->user->lock);
8955801649dSFredrik Tolf 			key->user->qnkeys--;
8965801649dSFredrik Tolf 			key->user->qnbytes -= key->quotalen;
8975801649dSFredrik Tolf 			spin_unlock(&key->user->lock);
8985801649dSFredrik Tolf 		}
8995801649dSFredrik Tolf 
9005801649dSFredrik Tolf 		atomic_dec(&key->user->nkeys);
9015801649dSFredrik Tolf 		atomic_inc(&newowner->nkeys);
9025801649dSFredrik Tolf 
903363b02daSDavid Howells 		if (key->state != KEY_IS_UNINSTANTIATED) {
9045801649dSFredrik Tolf 			atomic_dec(&key->user->nikeys);
9055801649dSFredrik Tolf 			atomic_inc(&newowner->nikeys);
9065801649dSFredrik Tolf 		}
9075801649dSFredrik Tolf 
9085801649dSFredrik Tolf 		zapowner = key->user;
9095801649dSFredrik Tolf 		key->user = newowner;
9105801649dSFredrik Tolf 		key->uid = uid;
9111da177e4SLinus Torvalds 	}
9121da177e4SLinus Torvalds 
9131da177e4SLinus Torvalds 	/* change the GID */
9149a56c2dbSEric W. Biederman 	if (group != (gid_t) -1)
9151da177e4SLinus Torvalds 		key->gid = gid;
9161da177e4SLinus Torvalds 
9171da177e4SLinus Torvalds 	ret = 0;
9181da177e4SLinus Torvalds 
9195801649dSFredrik Tolf error_put:
9201da177e4SLinus Torvalds 	up_write(&key->sem);
9211da177e4SLinus Torvalds 	key_put(key);
9225801649dSFredrik Tolf 	if (zapowner)
9235801649dSFredrik Tolf 		key_user_put(zapowner);
9241da177e4SLinus Torvalds error:
9251da177e4SLinus Torvalds 	return ret;
9261da177e4SLinus Torvalds 
9275801649dSFredrik Tolf quota_overrun:
9285801649dSFredrik Tolf 	spin_unlock(&newowner->lock);
9295801649dSFredrik Tolf 	zapowner = newowner;
9305801649dSFredrik Tolf 	ret = -EDQUOT;
9315801649dSFredrik Tolf 	goto error_put;
932a8b17ed0SDavid Howells }
9335801649dSFredrik Tolf 
9341da177e4SLinus Torvalds /*
935973c9f4fSDavid Howells  * Change the permission mask on a key.
936973c9f4fSDavid Howells  *
937973c9f4fSDavid Howells  * The key must grant the caller Setattr permission for this to work, though
938973c9f4fSDavid Howells  * the key need not be fully instantiated yet.  If the caller does not have
939973c9f4fSDavid Howells  * sysadmin capability, it may only change the permission on keys that it owns.
9401da177e4SLinus Torvalds  */
9411da177e4SLinus Torvalds long keyctl_setperm_key(key_serial_t id, key_perm_t perm)
9421da177e4SLinus Torvalds {
9431da177e4SLinus Torvalds 	struct key *key;
944664cceb0SDavid Howells 	key_ref_t key_ref;
9451da177e4SLinus Torvalds 	long ret;
9461da177e4SLinus Torvalds 
9471da177e4SLinus Torvalds 	ret = -EINVAL;
948664cceb0SDavid Howells 	if (perm & ~(KEY_POS_ALL | KEY_USR_ALL | KEY_GRP_ALL | KEY_OTH_ALL))
9491da177e4SLinus Torvalds 		goto error;
9501da177e4SLinus Torvalds 
9515593122eSDavid Howells 	key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE | KEY_LOOKUP_PARTIAL,
952f5895943SDavid Howells 				  KEY_NEED_SETATTR);
953664cceb0SDavid Howells 	if (IS_ERR(key_ref)) {
954664cceb0SDavid Howells 		ret = PTR_ERR(key_ref);
9551da177e4SLinus Torvalds 		goto error;
9561da177e4SLinus Torvalds 	}
9571da177e4SLinus Torvalds 
958664cceb0SDavid Howells 	key = key_ref_to_ptr(key_ref);
959664cceb0SDavid Howells 
96076d8aeabSDavid Howells 	/* make the changes with the locks held to prevent chown/chmod races */
9611da177e4SLinus Torvalds 	ret = -EACCES;
9621da177e4SLinus Torvalds 	down_write(&key->sem);
9631da177e4SLinus Torvalds 
96476d8aeabSDavid Howells 	/* if we're not the sysadmin, we can only change a key that we own */
9659a56c2dbSEric W. Biederman 	if (capable(CAP_SYS_ADMIN) || uid_eq(key->uid, current_fsuid())) {
9661da177e4SLinus Torvalds 		key->perm = perm;
9671da177e4SLinus Torvalds 		ret = 0;
96876d8aeabSDavid Howells 	}
9691da177e4SLinus Torvalds 
9701da177e4SLinus Torvalds 	up_write(&key->sem);
9711da177e4SLinus Torvalds 	key_put(key);
9721da177e4SLinus Torvalds error:
9731da177e4SLinus Torvalds 	return ret;
974a8b17ed0SDavid Howells }
9751da177e4SLinus Torvalds 
9768bbf4976SDavid Howells /*
977973c9f4fSDavid Howells  * Get the destination keyring for instantiation and check that the caller has
978973c9f4fSDavid Howells  * Write permission on it.
9798bbf4976SDavid Howells  */
9808bbf4976SDavid Howells static long get_instantiation_keyring(key_serial_t ringid,
9818bbf4976SDavid Howells 				      struct request_key_auth *rka,
9828bbf4976SDavid Howells 				      struct key **_dest_keyring)
9838bbf4976SDavid Howells {
9848bbf4976SDavid Howells 	key_ref_t dkref;
9858bbf4976SDavid Howells 
9868bbf4976SDavid Howells 	*_dest_keyring = NULL;
987eca1bf5bSDavid Howells 
988eca1bf5bSDavid Howells 	/* just return a NULL pointer if we weren't asked to make a link */
989eca1bf5bSDavid Howells 	if (ringid == 0)
9908bbf4976SDavid Howells 		return 0;
9918bbf4976SDavid Howells 
9928bbf4976SDavid Howells 	/* if a specific keyring is nominated by ID, then use that */
9938bbf4976SDavid Howells 	if (ringid > 0) {
994f5895943SDavid Howells 		dkref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE);
9958bbf4976SDavid Howells 		if (IS_ERR(dkref))
9968bbf4976SDavid Howells 			return PTR_ERR(dkref);
9978bbf4976SDavid Howells 		*_dest_keyring = key_ref_to_ptr(dkref);
9988bbf4976SDavid Howells 		return 0;
9998bbf4976SDavid Howells 	}
10008bbf4976SDavid Howells 
10018bbf4976SDavid Howells 	if (ringid == KEY_SPEC_REQKEY_AUTH_KEY)
10028bbf4976SDavid Howells 		return -EINVAL;
10038bbf4976SDavid Howells 
10048bbf4976SDavid Howells 	/* otherwise specify the destination keyring recorded in the
10058bbf4976SDavid Howells 	 * authorisation key (any KEY_SPEC_*_KEYRING) */
10068bbf4976SDavid Howells 	if (ringid >= KEY_SPEC_REQUESTOR_KEYRING) {
100721279cfaSDavid Howells 		*_dest_keyring = key_get(rka->dest_keyring);
10088bbf4976SDavid Howells 		return 0;
10098bbf4976SDavid Howells 	}
10108bbf4976SDavid Howells 
10118bbf4976SDavid Howells 	return -ENOKEY;
10128bbf4976SDavid Howells }
10138bbf4976SDavid Howells 
1014d84f4f99SDavid Howells /*
1015973c9f4fSDavid Howells  * Change the request_key authorisation key on the current process.
1016d84f4f99SDavid Howells  */
1017d84f4f99SDavid Howells static int keyctl_change_reqkey_auth(struct key *key)
1018d84f4f99SDavid Howells {
1019d84f4f99SDavid Howells 	struct cred *new;
1020d84f4f99SDavid Howells 
1021d84f4f99SDavid Howells 	new = prepare_creds();
1022d84f4f99SDavid Howells 	if (!new)
1023d84f4f99SDavid Howells 		return -ENOMEM;
1024d84f4f99SDavid Howells 
1025d84f4f99SDavid Howells 	key_put(new->request_key_auth);
1026d84f4f99SDavid Howells 	new->request_key_auth = key_get(key);
1027d84f4f99SDavid Howells 
1028d84f4f99SDavid Howells 	return commit_creds(new);
1029d84f4f99SDavid Howells }
1030d84f4f99SDavid Howells 
10311da177e4SLinus Torvalds /*
1032973c9f4fSDavid Howells  * Instantiate a key with the specified payload and link the key into the
1033973c9f4fSDavid Howells  * destination keyring if one is given.
1034973c9f4fSDavid Howells  *
1035973c9f4fSDavid Howells  * The caller must have the appropriate instantiation permit set for this to
1036973c9f4fSDavid Howells  * work (see keyctl_assume_authority).  No other permissions are required.
1037973c9f4fSDavid Howells  *
1038973c9f4fSDavid Howells  * If successful, 0 will be returned.
10391da177e4SLinus Torvalds  */
1040ee009e4aSDavid Howells long keyctl_instantiate_key_common(key_serial_t id,
1041b353a1f7SAl Viro 				   struct iov_iter *from,
10421da177e4SLinus Torvalds 				   key_serial_t ringid)
10431da177e4SLinus Torvalds {
1044d84f4f99SDavid Howells 	const struct cred *cred = current_cred();
10453e30148cSDavid Howells 	struct request_key_auth *rka;
10468bbf4976SDavid Howells 	struct key *instkey, *dest_keyring;
1047b353a1f7SAl Viro 	size_t plen = from ? iov_iter_count(from) : 0;
10481da177e4SLinus Torvalds 	void *payload;
10491da177e4SLinus Torvalds 	long ret;
10501da177e4SLinus Torvalds 
1051d84f4f99SDavid Howells 	kenter("%d,,%zu,%d", id, plen, ringid);
1052d84f4f99SDavid Howells 
1053b353a1f7SAl Viro 	if (!plen)
1054b353a1f7SAl Viro 		from = NULL;
1055b353a1f7SAl Viro 
10561da177e4SLinus Torvalds 	ret = -EINVAL;
105738bbca6bSDavid Howells 	if (plen > 1024 * 1024 - 1)
10581da177e4SLinus Torvalds 		goto error;
10591da177e4SLinus Torvalds 
1060b5f545c8SDavid Howells 	/* the appropriate instantiation authorisation key must have been
1061b5f545c8SDavid Howells 	 * assumed before calling this */
1062b5f545c8SDavid Howells 	ret = -EPERM;
1063d84f4f99SDavid Howells 	instkey = cred->request_key_auth;
1064b5f545c8SDavid Howells 	if (!instkey)
1065b5f545c8SDavid Howells 		goto error;
1066b5f545c8SDavid Howells 
1067146aa8b1SDavid Howells 	rka = instkey->payload.data[0];
1068b5f545c8SDavid Howells 	if (rka->target_key->serial != id)
1069b5f545c8SDavid Howells 		goto error;
1070b5f545c8SDavid Howells 
10711da177e4SLinus Torvalds 	/* pull the payload in if one was supplied */
10721da177e4SLinus Torvalds 	payload = NULL;
10731da177e4SLinus Torvalds 
1074b353a1f7SAl Viro 	if (from) {
10751da177e4SLinus Torvalds 		ret = -ENOMEM;
1076752ade68SMichal Hocko 		payload = kvmalloc(plen, GFP_KERNEL);
10771da177e4SLinus Torvalds 		if (!payload)
10781da177e4SLinus Torvalds 			goto error;
10791da177e4SLinus Torvalds 
1080b353a1f7SAl Viro 		ret = -EFAULT;
1081cbbd26b8SAl Viro 		if (!copy_from_iter_full(payload, plen, from))
10821da177e4SLinus Torvalds 			goto error2;
10831da177e4SLinus Torvalds 	}
10841da177e4SLinus Torvalds 
10853e30148cSDavid Howells 	/* find the destination keyring amongst those belonging to the
10863e30148cSDavid Howells 	 * requesting task */
10878bbf4976SDavid Howells 	ret = get_instantiation_keyring(ringid, rka, &dest_keyring);
10888bbf4976SDavid Howells 	if (ret < 0)
1089b5f545c8SDavid Howells 		goto error2;
10901da177e4SLinus Torvalds 
10911da177e4SLinus Torvalds 	/* instantiate the key and link it into a keyring */
10923e30148cSDavid Howells 	ret = key_instantiate_and_link(rka->target_key, payload, plen,
10938bbf4976SDavid Howells 				       dest_keyring, instkey);
10941da177e4SLinus Torvalds 
10958bbf4976SDavid Howells 	key_put(dest_keyring);
1096b5f545c8SDavid Howells 
1097b5f545c8SDavid Howells 	/* discard the assumed authority if it's just been disabled by
1098b5f545c8SDavid Howells 	 * instantiation of the key */
1099d84f4f99SDavid Howells 	if (ret == 0)
1100d84f4f99SDavid Howells 		keyctl_change_reqkey_auth(NULL);
1101b5f545c8SDavid Howells 
11021da177e4SLinus Torvalds error2:
110357070c85SEric Biggers 	if (payload) {
110457070c85SEric Biggers 		memzero_explicit(payload, plen);
1105b353a1f7SAl Viro 		kvfree(payload);
110657070c85SEric Biggers 	}
11071da177e4SLinus Torvalds error:
11081da177e4SLinus Torvalds 	return ret;
1109a8b17ed0SDavid Howells }
11101da177e4SLinus Torvalds 
11111da177e4SLinus Torvalds /*
1112ee009e4aSDavid Howells  * Instantiate a key with the specified payload and link the key into the
1113ee009e4aSDavid Howells  * destination keyring if one is given.
1114ee009e4aSDavid Howells  *
1115ee009e4aSDavid Howells  * The caller must have the appropriate instantiation permit set for this to
1116ee009e4aSDavid Howells  * work (see keyctl_assume_authority).  No other permissions are required.
1117ee009e4aSDavid Howells  *
1118ee009e4aSDavid Howells  * If successful, 0 will be returned.
1119ee009e4aSDavid Howells  */
1120ee009e4aSDavid Howells long keyctl_instantiate_key(key_serial_t id,
1121ee009e4aSDavid Howells 			    const void __user *_payload,
1122ee009e4aSDavid Howells 			    size_t plen,
1123ee009e4aSDavid Howells 			    key_serial_t ringid)
1124ee009e4aSDavid Howells {
1125ee009e4aSDavid Howells 	if (_payload && plen) {
1126b353a1f7SAl Viro 		struct iovec iov;
1127b353a1f7SAl Viro 		struct iov_iter from;
1128b353a1f7SAl Viro 		int ret;
1129ee009e4aSDavid Howells 
1130b353a1f7SAl Viro 		ret = import_single_range(WRITE, (void __user *)_payload, plen,
1131b353a1f7SAl Viro 					  &iov, &from);
1132b353a1f7SAl Viro 		if (unlikely(ret))
1133b353a1f7SAl Viro 			return ret;
1134b353a1f7SAl Viro 
1135b353a1f7SAl Viro 		return keyctl_instantiate_key_common(id, &from, ringid);
1136ee009e4aSDavid Howells 	}
1137ee009e4aSDavid Howells 
1138b353a1f7SAl Viro 	return keyctl_instantiate_key_common(id, NULL, ringid);
1139ee009e4aSDavid Howells }
1140ee009e4aSDavid Howells 
1141ee009e4aSDavid Howells /*
1142ee009e4aSDavid Howells  * Instantiate a key with the specified multipart payload and link the key into
1143ee009e4aSDavid Howells  * the destination keyring if one is given.
1144ee009e4aSDavid Howells  *
1145ee009e4aSDavid Howells  * The caller must have the appropriate instantiation permit set for this to
1146ee009e4aSDavid Howells  * work (see keyctl_assume_authority).  No other permissions are required.
1147ee009e4aSDavid Howells  *
1148ee009e4aSDavid Howells  * If successful, 0 will be returned.
1149ee009e4aSDavid Howells  */
1150ee009e4aSDavid Howells long keyctl_instantiate_key_iov(key_serial_t id,
1151ee009e4aSDavid Howells 				const struct iovec __user *_payload_iov,
1152ee009e4aSDavid Howells 				unsigned ioc,
1153ee009e4aSDavid Howells 				key_serial_t ringid)
1154ee009e4aSDavid Howells {
1155ee009e4aSDavid Howells 	struct iovec iovstack[UIO_FASTIOV], *iov = iovstack;
1156b353a1f7SAl Viro 	struct iov_iter from;
1157ee009e4aSDavid Howells 	long ret;
1158ee009e4aSDavid Howells 
1159b353a1f7SAl Viro 	if (!_payload_iov)
1160b353a1f7SAl Viro 		ioc = 0;
1161ee009e4aSDavid Howells 
1162b353a1f7SAl Viro 	ret = import_iovec(WRITE, _payload_iov, ioc,
1163b353a1f7SAl Viro 				    ARRAY_SIZE(iovstack), &iov, &from);
1164ee009e4aSDavid Howells 	if (ret < 0)
1165b353a1f7SAl Viro 		return ret;
1166b353a1f7SAl Viro 	ret = keyctl_instantiate_key_common(id, &from, ringid);
1167ee009e4aSDavid Howells 	kfree(iov);
1168ee009e4aSDavid Howells 	return ret;
1169ee009e4aSDavid Howells }
1170ee009e4aSDavid Howells 
1171ee009e4aSDavid Howells /*
1172973c9f4fSDavid Howells  * Negatively instantiate the key with the given timeout (in seconds) and link
1173973c9f4fSDavid Howells  * the key into the destination keyring if one is given.
1174973c9f4fSDavid Howells  *
1175973c9f4fSDavid Howells  * The caller must have the appropriate instantiation permit set for this to
1176973c9f4fSDavid Howells  * work (see keyctl_assume_authority).  No other permissions are required.
1177973c9f4fSDavid Howells  *
1178973c9f4fSDavid Howells  * The key and any links to the key will be automatically garbage collected
1179973c9f4fSDavid Howells  * after the timeout expires.
1180973c9f4fSDavid Howells  *
1181973c9f4fSDavid Howells  * Negative keys are used to rate limit repeated request_key() calls by causing
1182973c9f4fSDavid Howells  * them to return -ENOKEY until the negative key expires.
1183973c9f4fSDavid Howells  *
1184973c9f4fSDavid Howells  * If successful, 0 will be returned.
11851da177e4SLinus Torvalds  */
11861da177e4SLinus Torvalds long keyctl_negate_key(key_serial_t id, unsigned timeout, key_serial_t ringid)
11871da177e4SLinus Torvalds {
1188fdd1b945SDavid Howells 	return keyctl_reject_key(id, timeout, ENOKEY, ringid);
1189fdd1b945SDavid Howells }
1190fdd1b945SDavid Howells 
1191fdd1b945SDavid Howells /*
1192fdd1b945SDavid Howells  * Negatively instantiate the key with the given timeout (in seconds) and error
1193fdd1b945SDavid Howells  * code and link the key into the destination keyring if one is given.
1194fdd1b945SDavid Howells  *
1195fdd1b945SDavid Howells  * The caller must have the appropriate instantiation permit set for this to
1196fdd1b945SDavid Howells  * work (see keyctl_assume_authority).  No other permissions are required.
1197fdd1b945SDavid Howells  *
1198fdd1b945SDavid Howells  * The key and any links to the key will be automatically garbage collected
1199fdd1b945SDavid Howells  * after the timeout expires.
1200fdd1b945SDavid Howells  *
1201fdd1b945SDavid Howells  * Negative keys are used to rate limit repeated request_key() calls by causing
1202fdd1b945SDavid Howells  * them to return the specified error code until the negative key expires.
1203fdd1b945SDavid Howells  *
1204fdd1b945SDavid Howells  * If successful, 0 will be returned.
1205fdd1b945SDavid Howells  */
1206fdd1b945SDavid Howells long keyctl_reject_key(key_serial_t id, unsigned timeout, unsigned error,
1207fdd1b945SDavid Howells 		       key_serial_t ringid)
1208fdd1b945SDavid Howells {
1209d84f4f99SDavid Howells 	const struct cred *cred = current_cred();
12103e30148cSDavid Howells 	struct request_key_auth *rka;
12118bbf4976SDavid Howells 	struct key *instkey, *dest_keyring;
12121da177e4SLinus Torvalds 	long ret;
12131da177e4SLinus Torvalds 
1214fdd1b945SDavid Howells 	kenter("%d,%u,%u,%d", id, timeout, error, ringid);
1215fdd1b945SDavid Howells 
1216fdd1b945SDavid Howells 	/* must be a valid error code and mustn't be a kernel special */
1217fdd1b945SDavid Howells 	if (error <= 0 ||
1218fdd1b945SDavid Howells 	    error >= MAX_ERRNO ||
1219fdd1b945SDavid Howells 	    error == ERESTARTSYS ||
1220fdd1b945SDavid Howells 	    error == ERESTARTNOINTR ||
1221fdd1b945SDavid Howells 	    error == ERESTARTNOHAND ||
1222fdd1b945SDavid Howells 	    error == ERESTART_RESTARTBLOCK)
1223fdd1b945SDavid Howells 		return -EINVAL;
1224d84f4f99SDavid Howells 
1225b5f545c8SDavid Howells 	/* the appropriate instantiation authorisation key must have been
1226b5f545c8SDavid Howells 	 * assumed before calling this */
1227b5f545c8SDavid Howells 	ret = -EPERM;
1228d84f4f99SDavid Howells 	instkey = cred->request_key_auth;
1229b5f545c8SDavid Howells 	if (!instkey)
12301da177e4SLinus Torvalds 		goto error;
12311da177e4SLinus Torvalds 
1232146aa8b1SDavid Howells 	rka = instkey->payload.data[0];
1233b5f545c8SDavid Howells 	if (rka->target_key->serial != id)
1234b5f545c8SDavid Howells 		goto error;
12353e30148cSDavid Howells 
12361da177e4SLinus Torvalds 	/* find the destination keyring if present (which must also be
12371da177e4SLinus Torvalds 	 * writable) */
12388bbf4976SDavid Howells 	ret = get_instantiation_keyring(ringid, rka, &dest_keyring);
12398bbf4976SDavid Howells 	if (ret < 0)
1240b5f545c8SDavid Howells 		goto error;
12411da177e4SLinus Torvalds 
12421da177e4SLinus Torvalds 	/* instantiate the key and link it into a keyring */
1243fdd1b945SDavid Howells 	ret = key_reject_and_link(rka->target_key, timeout, error,
12448bbf4976SDavid Howells 				  dest_keyring, instkey);
12451da177e4SLinus Torvalds 
12468bbf4976SDavid Howells 	key_put(dest_keyring);
1247b5f545c8SDavid Howells 
1248b5f545c8SDavid Howells 	/* discard the assumed authority if it's just been disabled by
1249b5f545c8SDavid Howells 	 * instantiation of the key */
1250d84f4f99SDavid Howells 	if (ret == 0)
1251d84f4f99SDavid Howells 		keyctl_change_reqkey_auth(NULL);
1252b5f545c8SDavid Howells 
12531da177e4SLinus Torvalds error:
12541da177e4SLinus Torvalds 	return ret;
1255a8b17ed0SDavid Howells }
12561da177e4SLinus Torvalds 
12571da177e4SLinus Torvalds /*
1258973c9f4fSDavid Howells  * Read or set the default keyring in which request_key() will cache keys and
1259973c9f4fSDavid Howells  * return the old setting.
1260973c9f4fSDavid Howells  *
1261c9f838d1SEric Biggers  * If a thread or process keyring is specified then it will be created if it
1262c9f838d1SEric Biggers  * doesn't yet exist.  The old setting will be returned if successful.
12633e30148cSDavid Howells  */
12643e30148cSDavid Howells long keyctl_set_reqkey_keyring(int reqkey_defl)
12653e30148cSDavid Howells {
1266d84f4f99SDavid Howells 	struct cred *new;
1267d84f4f99SDavid Howells 	int ret, old_setting;
1268d84f4f99SDavid Howells 
1269d84f4f99SDavid Howells 	old_setting = current_cred_xxx(jit_keyring);
1270d84f4f99SDavid Howells 
1271d84f4f99SDavid Howells 	if (reqkey_defl == KEY_REQKEY_DEFL_NO_CHANGE)
1272d84f4f99SDavid Howells 		return old_setting;
1273d84f4f99SDavid Howells 
1274d84f4f99SDavid Howells 	new = prepare_creds();
1275d84f4f99SDavid Howells 	if (!new)
1276d84f4f99SDavid Howells 		return -ENOMEM;
12773e30148cSDavid Howells 
12783e30148cSDavid Howells 	switch (reqkey_defl) {
12793e30148cSDavid Howells 	case KEY_REQKEY_DEFL_THREAD_KEYRING:
1280d84f4f99SDavid Howells 		ret = install_thread_keyring_to_cred(new);
12813e30148cSDavid Howells 		if (ret < 0)
1282d84f4f99SDavid Howells 			goto error;
12833e30148cSDavid Howells 		goto set;
12843e30148cSDavid Howells 
12853e30148cSDavid Howells 	case KEY_REQKEY_DEFL_PROCESS_KEYRING:
1286d84f4f99SDavid Howells 		ret = install_process_keyring_to_cred(new);
1287c9f838d1SEric Biggers 		if (ret < 0)
1288d84f4f99SDavid Howells 			goto error;
1289d84f4f99SDavid Howells 		goto set;
12903e30148cSDavid Howells 
12913e30148cSDavid Howells 	case KEY_REQKEY_DEFL_DEFAULT:
12923e30148cSDavid Howells 	case KEY_REQKEY_DEFL_SESSION_KEYRING:
12933e30148cSDavid Howells 	case KEY_REQKEY_DEFL_USER_KEYRING:
12943e30148cSDavid Howells 	case KEY_REQKEY_DEFL_USER_SESSION_KEYRING:
1295d84f4f99SDavid Howells 	case KEY_REQKEY_DEFL_REQUESTOR_KEYRING:
1296d84f4f99SDavid Howells 		goto set;
12973e30148cSDavid Howells 
12983e30148cSDavid Howells 	case KEY_REQKEY_DEFL_NO_CHANGE:
12993e30148cSDavid Howells 	case KEY_REQKEY_DEFL_GROUP_KEYRING:
13003e30148cSDavid Howells 	default:
1301d84f4f99SDavid Howells 		ret = -EINVAL;
1302d84f4f99SDavid Howells 		goto error;
13033e30148cSDavid Howells 	}
13043e30148cSDavid Howells 
1305d84f4f99SDavid Howells set:
1306d84f4f99SDavid Howells 	new->jit_keyring = reqkey_defl;
1307d84f4f99SDavid Howells 	commit_creds(new);
1308d84f4f99SDavid Howells 	return old_setting;
1309d84f4f99SDavid Howells error:
1310d84f4f99SDavid Howells 	abort_creds(new);
13114303ef19SDan Carpenter 	return ret;
1312a8b17ed0SDavid Howells }
1313d84f4f99SDavid Howells 
13143e30148cSDavid Howells /*
1315973c9f4fSDavid Howells  * Set or clear the timeout on a key.
1316973c9f4fSDavid Howells  *
1317973c9f4fSDavid Howells  * Either the key must grant the caller Setattr permission or else the caller
1318973c9f4fSDavid Howells  * must hold an instantiation authorisation token for the key.
1319973c9f4fSDavid Howells  *
1320973c9f4fSDavid Howells  * The timeout is either 0 to clear the timeout, or a number of seconds from
1321973c9f4fSDavid Howells  * the current time.  The key and any links to the key will be automatically
1322973c9f4fSDavid Howells  * garbage collected after the timeout expires.
1323973c9f4fSDavid Howells  *
1324d3600bcfSMimi Zohar  * Keys with KEY_FLAG_KEEP set should not be timed out.
1325d3600bcfSMimi Zohar  *
1326973c9f4fSDavid Howells  * If successful, 0 is returned.
1327017679c4SDavid Howells  */
1328017679c4SDavid Howells long keyctl_set_timeout(key_serial_t id, unsigned timeout)
1329017679c4SDavid Howells {
13309156235bSDavid Howells 	struct key *key, *instkey;
1331017679c4SDavid Howells 	key_ref_t key_ref;
1332017679c4SDavid Howells 	long ret;
1333017679c4SDavid Howells 
13345593122eSDavid Howells 	key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE | KEY_LOOKUP_PARTIAL,
1335f5895943SDavid Howells 				  KEY_NEED_SETATTR);
1336017679c4SDavid Howells 	if (IS_ERR(key_ref)) {
13379156235bSDavid Howells 		/* setting the timeout on a key under construction is permitted
13389156235bSDavid Howells 		 * if we have the authorisation token handy */
13399156235bSDavid Howells 		if (PTR_ERR(key_ref) == -EACCES) {
13409156235bSDavid Howells 			instkey = key_get_instantiation_authkey(id);
13419156235bSDavid Howells 			if (!IS_ERR(instkey)) {
13429156235bSDavid Howells 				key_put(instkey);
13439156235bSDavid Howells 				key_ref = lookup_user_key(id,
13449156235bSDavid Howells 							  KEY_LOOKUP_PARTIAL,
13459156235bSDavid Howells 							  0);
13469156235bSDavid Howells 				if (!IS_ERR(key_ref))
13479156235bSDavid Howells 					goto okay;
13489156235bSDavid Howells 			}
13499156235bSDavid Howells 		}
13509156235bSDavid Howells 
1351017679c4SDavid Howells 		ret = PTR_ERR(key_ref);
1352017679c4SDavid Howells 		goto error;
1353017679c4SDavid Howells 	}
1354017679c4SDavid Howells 
13559156235bSDavid Howells okay:
1356017679c4SDavid Howells 	key = key_ref_to_ptr(key_ref);
13571d6d167cSMimi Zohar 	ret = 0;
1358d3600bcfSMimi Zohar 	if (test_bit(KEY_FLAG_KEEP, &key->flags))
1359d3600bcfSMimi Zohar 		ret = -EPERM;
13601d6d167cSMimi Zohar 	else
136159e6b9c1SBryan Schumaker 		key_set_timeout(key, timeout);
1362017679c4SDavid Howells 	key_put(key);
1363017679c4SDavid Howells 
1364017679c4SDavid Howells error:
1365017679c4SDavid Howells 	return ret;
1366a8b17ed0SDavid Howells }
1367017679c4SDavid Howells 
1368017679c4SDavid Howells /*
1369973c9f4fSDavid Howells  * Assume (or clear) the authority to instantiate the specified key.
1370973c9f4fSDavid Howells  *
1371973c9f4fSDavid Howells  * This sets the authoritative token currently in force for key instantiation.
1372973c9f4fSDavid Howells  * This must be done for a key to be instantiated.  It has the effect of making
1373973c9f4fSDavid Howells  * available all the keys from the caller of the request_key() that created a
1374973c9f4fSDavid Howells  * key to request_key() calls made by the caller of this function.
1375973c9f4fSDavid Howells  *
1376973c9f4fSDavid Howells  * The caller must have the instantiation key in their process keyrings with a
1377973c9f4fSDavid Howells  * Search permission grant available to the caller.
1378973c9f4fSDavid Howells  *
1379973c9f4fSDavid Howells  * If the ID given is 0, then the setting will be cleared and 0 returned.
1380973c9f4fSDavid Howells  *
1381973c9f4fSDavid Howells  * If the ID given has a matching an authorisation key, then that key will be
1382973c9f4fSDavid Howells  * set and its ID will be returned.  The authorisation key can be read to get
1383973c9f4fSDavid Howells  * the callout information passed to request_key().
1384b5f545c8SDavid Howells  */
1385b5f545c8SDavid Howells long keyctl_assume_authority(key_serial_t id)
1386b5f545c8SDavid Howells {
1387b5f545c8SDavid Howells 	struct key *authkey;
1388b5f545c8SDavid Howells 	long ret;
1389b5f545c8SDavid Howells 
1390b5f545c8SDavid Howells 	/* special key IDs aren't permitted */
1391b5f545c8SDavid Howells 	ret = -EINVAL;
1392b5f545c8SDavid Howells 	if (id < 0)
1393b5f545c8SDavid Howells 		goto error;
1394b5f545c8SDavid Howells 
1395b5f545c8SDavid Howells 	/* we divest ourselves of authority if given an ID of 0 */
1396b5f545c8SDavid Howells 	if (id == 0) {
1397d84f4f99SDavid Howells 		ret = keyctl_change_reqkey_auth(NULL);
1398b5f545c8SDavid Howells 		goto error;
1399b5f545c8SDavid Howells 	}
1400b5f545c8SDavid Howells 
1401b5f545c8SDavid Howells 	/* attempt to assume the authority temporarily granted to us whilst we
1402b5f545c8SDavid Howells 	 * instantiate the specified key
1403b5f545c8SDavid Howells 	 * - the authorisation key must be in the current task's keyrings
1404b5f545c8SDavid Howells 	 *   somewhere
1405b5f545c8SDavid Howells 	 */
1406b5f545c8SDavid Howells 	authkey = key_get_instantiation_authkey(id);
1407b5f545c8SDavid Howells 	if (IS_ERR(authkey)) {
1408b5f545c8SDavid Howells 		ret = PTR_ERR(authkey);
1409b5f545c8SDavid Howells 		goto error;
1410b5f545c8SDavid Howells 	}
1411b5f545c8SDavid Howells 
1412d84f4f99SDavid Howells 	ret = keyctl_change_reqkey_auth(authkey);
1413884bee02SEric Biggers 	if (ret == 0)
1414d84f4f99SDavid Howells 		ret = authkey->serial;
1415884bee02SEric Biggers 	key_put(authkey);
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 /*
15866563c91fSMat Martineau  * Apply a restriction to a given keyring.
15876563c91fSMat Martineau  *
15886563c91fSMat Martineau  * The caller must have Setattr permission to change keyring restrictions.
15896563c91fSMat Martineau  *
15906563c91fSMat Martineau  * The requested type name may be a NULL pointer to reject all attempts
1591*18026d86SEric Biggers  * to link to the keyring.  In this case, _restriction must also be NULL.
1592*18026d86SEric Biggers  * Otherwise, both _type and _restriction must be non-NULL.
15936563c91fSMat Martineau  *
15946563c91fSMat Martineau  * Returns 0 if successful.
15956563c91fSMat Martineau  */
15966563c91fSMat Martineau long keyctl_restrict_keyring(key_serial_t id, const char __user *_type,
15976563c91fSMat Martineau 			     const char __user *_restriction)
15986563c91fSMat Martineau {
15996563c91fSMat Martineau 	key_ref_t key_ref;
16006563c91fSMat Martineau 	char type[32];
16016563c91fSMat Martineau 	char *restriction = NULL;
16026563c91fSMat Martineau 	long ret;
16036563c91fSMat Martineau 
16046563c91fSMat Martineau 	key_ref = lookup_user_key(id, 0, KEY_NEED_SETATTR);
16056563c91fSMat Martineau 	if (IS_ERR(key_ref))
16066563c91fSMat Martineau 		return PTR_ERR(key_ref);
16076563c91fSMat Martineau 
1608*18026d86SEric Biggers 	ret = -EINVAL;
16096563c91fSMat Martineau 	if (_type) {
1610*18026d86SEric Biggers 		if (!_restriction)
1611*18026d86SEric Biggers 			goto error;
1612*18026d86SEric Biggers 
16136563c91fSMat Martineau 		ret = key_get_type_from_user(type, _type, sizeof(type));
16146563c91fSMat Martineau 		if (ret < 0)
16156563c91fSMat Martineau 			goto error;
16166563c91fSMat Martineau 
16176563c91fSMat Martineau 		restriction = strndup_user(_restriction, PAGE_SIZE);
16186563c91fSMat Martineau 		if (IS_ERR(restriction)) {
16196563c91fSMat Martineau 			ret = PTR_ERR(restriction);
16206563c91fSMat Martineau 			goto error;
16216563c91fSMat Martineau 		}
1622*18026d86SEric Biggers 	} else {
1623*18026d86SEric Biggers 		if (_restriction)
1624*18026d86SEric Biggers 			goto error;
16256563c91fSMat Martineau 	}
16266563c91fSMat Martineau 
1627*18026d86SEric Biggers 	ret = keyring_restrict(key_ref, _type ? type : NULL, restriction);
16286563c91fSMat Martineau 	kfree(restriction);
16296563c91fSMat Martineau error:
16306563c91fSMat Martineau 	key_ref_put(key_ref);
16316563c91fSMat Martineau 	return ret;
16326563c91fSMat Martineau }
16336563c91fSMat Martineau 
16346563c91fSMat Martineau /*
1635973c9f4fSDavid Howells  * The key control system call
16361da177e4SLinus Torvalds  */
1637938bb9f5SHeiko Carstens SYSCALL_DEFINE5(keyctl, int, option, unsigned long, arg2, unsigned long, arg3,
1638938bb9f5SHeiko Carstens 		unsigned long, arg4, unsigned long, arg5)
16391da177e4SLinus Torvalds {
16401da177e4SLinus Torvalds 	switch (option) {
16411da177e4SLinus Torvalds 	case KEYCTL_GET_KEYRING_ID:
16421da177e4SLinus Torvalds 		return keyctl_get_keyring_ID((key_serial_t) arg2,
16431da177e4SLinus Torvalds 					     (int) arg3);
16441da177e4SLinus Torvalds 
16451da177e4SLinus Torvalds 	case KEYCTL_JOIN_SESSION_KEYRING:
16461da177e4SLinus Torvalds 		return keyctl_join_session_keyring((const char __user *) arg2);
16471da177e4SLinus Torvalds 
16481da177e4SLinus Torvalds 	case KEYCTL_UPDATE:
16491da177e4SLinus Torvalds 		return keyctl_update_key((key_serial_t) arg2,
16501da177e4SLinus Torvalds 					 (const void __user *) arg3,
16511da177e4SLinus Torvalds 					 (size_t) arg4);
16521da177e4SLinus Torvalds 
16531da177e4SLinus Torvalds 	case KEYCTL_REVOKE:
16541da177e4SLinus Torvalds 		return keyctl_revoke_key((key_serial_t) arg2);
16551da177e4SLinus Torvalds 
16561da177e4SLinus Torvalds 	case KEYCTL_DESCRIBE:
16571da177e4SLinus Torvalds 		return keyctl_describe_key((key_serial_t) arg2,
16581da177e4SLinus Torvalds 					   (char __user *) arg3,
16591da177e4SLinus Torvalds 					   (unsigned) arg4);
16601da177e4SLinus Torvalds 
16611da177e4SLinus Torvalds 	case KEYCTL_CLEAR:
16621da177e4SLinus Torvalds 		return keyctl_keyring_clear((key_serial_t) arg2);
16631da177e4SLinus Torvalds 
16641da177e4SLinus Torvalds 	case KEYCTL_LINK:
16651da177e4SLinus Torvalds 		return keyctl_keyring_link((key_serial_t) arg2,
16661da177e4SLinus Torvalds 					   (key_serial_t) arg3);
16671da177e4SLinus Torvalds 
16681da177e4SLinus Torvalds 	case KEYCTL_UNLINK:
16691da177e4SLinus Torvalds 		return keyctl_keyring_unlink((key_serial_t) arg2,
16701da177e4SLinus Torvalds 					     (key_serial_t) arg3);
16711da177e4SLinus Torvalds 
16721da177e4SLinus Torvalds 	case KEYCTL_SEARCH:
16731da177e4SLinus Torvalds 		return keyctl_keyring_search((key_serial_t) arg2,
16741da177e4SLinus Torvalds 					     (const char __user *) arg3,
16751da177e4SLinus Torvalds 					     (const char __user *) arg4,
16761da177e4SLinus Torvalds 					     (key_serial_t) arg5);
16771da177e4SLinus Torvalds 
16781da177e4SLinus Torvalds 	case KEYCTL_READ:
16791da177e4SLinus Torvalds 		return keyctl_read_key((key_serial_t) arg2,
16801da177e4SLinus Torvalds 				       (char __user *) arg3,
16811da177e4SLinus Torvalds 				       (size_t) arg4);
16821da177e4SLinus Torvalds 
16831da177e4SLinus Torvalds 	case KEYCTL_CHOWN:
16841da177e4SLinus Torvalds 		return keyctl_chown_key((key_serial_t) arg2,
16851da177e4SLinus Torvalds 					(uid_t) arg3,
16861da177e4SLinus Torvalds 					(gid_t) arg4);
16871da177e4SLinus Torvalds 
16881da177e4SLinus Torvalds 	case KEYCTL_SETPERM:
16891da177e4SLinus Torvalds 		return keyctl_setperm_key((key_serial_t) arg2,
16901da177e4SLinus Torvalds 					  (key_perm_t) arg3);
16911da177e4SLinus Torvalds 
16921da177e4SLinus Torvalds 	case KEYCTL_INSTANTIATE:
16931da177e4SLinus Torvalds 		return keyctl_instantiate_key((key_serial_t) arg2,
16941da177e4SLinus Torvalds 					      (const void __user *) arg3,
16951da177e4SLinus Torvalds 					      (size_t) arg4,
16961da177e4SLinus Torvalds 					      (key_serial_t) arg5);
16971da177e4SLinus Torvalds 
16981da177e4SLinus Torvalds 	case KEYCTL_NEGATE:
16991da177e4SLinus Torvalds 		return keyctl_negate_key((key_serial_t) arg2,
17001da177e4SLinus Torvalds 					 (unsigned) arg3,
17011da177e4SLinus Torvalds 					 (key_serial_t) arg4);
17021da177e4SLinus Torvalds 
17033e30148cSDavid Howells 	case KEYCTL_SET_REQKEY_KEYRING:
17043e30148cSDavid Howells 		return keyctl_set_reqkey_keyring(arg2);
17053e30148cSDavid Howells 
1706017679c4SDavid Howells 	case KEYCTL_SET_TIMEOUT:
1707017679c4SDavid Howells 		return keyctl_set_timeout((key_serial_t) arg2,
1708017679c4SDavid Howells 					  (unsigned) arg3);
1709017679c4SDavid Howells 
1710b5f545c8SDavid Howells 	case KEYCTL_ASSUME_AUTHORITY:
1711b5f545c8SDavid Howells 		return keyctl_assume_authority((key_serial_t) arg2);
1712b5f545c8SDavid Howells 
171370a5bb72SDavid Howells 	case KEYCTL_GET_SECURITY:
171470a5bb72SDavid Howells 		return keyctl_get_security((key_serial_t) arg2,
171590bd49abSJames Morris 					   (char __user *) arg3,
171670a5bb72SDavid Howells 					   (size_t) arg4);
171770a5bb72SDavid Howells 
1718ee18d64cSDavid Howells 	case KEYCTL_SESSION_TO_PARENT:
1719ee18d64cSDavid Howells 		return keyctl_session_to_parent();
1720ee18d64cSDavid Howells 
1721fdd1b945SDavid Howells 	case KEYCTL_REJECT:
1722fdd1b945SDavid Howells 		return keyctl_reject_key((key_serial_t) arg2,
1723fdd1b945SDavid Howells 					 (unsigned) arg3,
1724fdd1b945SDavid Howells 					 (unsigned) arg4,
1725fdd1b945SDavid Howells 					 (key_serial_t) arg5);
1726fdd1b945SDavid Howells 
1727ee009e4aSDavid Howells 	case KEYCTL_INSTANTIATE_IOV:
1728ee009e4aSDavid Howells 		return keyctl_instantiate_key_iov(
1729ee009e4aSDavid Howells 			(key_serial_t) arg2,
1730ee009e4aSDavid Howells 			(const struct iovec __user *) arg3,
1731ee009e4aSDavid Howells 			(unsigned) arg4,
1732ee009e4aSDavid Howells 			(key_serial_t) arg5);
1733ee009e4aSDavid Howells 
1734fd75815fSDavid Howells 	case KEYCTL_INVALIDATE:
1735fd75815fSDavid Howells 		return keyctl_invalidate_key((key_serial_t) arg2);
1736fd75815fSDavid Howells 
1737f36f8c75SDavid Howells 	case KEYCTL_GET_PERSISTENT:
1738f36f8c75SDavid Howells 		return keyctl_get_persistent((uid_t)arg2, (key_serial_t)arg3);
1739f36f8c75SDavid Howells 
1740ddbb4114SMat Martineau 	case KEYCTL_DH_COMPUTE:
1741ddbb4114SMat Martineau 		return keyctl_dh_compute((struct keyctl_dh_params __user *) arg2,
17424693fc73SStephan Mueller 					 (char __user *) arg3, (size_t) arg4,
1743f1c316a3SStephan Mueller 					 (struct keyctl_kdf_params __user *) arg5);
1744ddbb4114SMat Martineau 
17456563c91fSMat Martineau 	case KEYCTL_RESTRICT_KEYRING:
17466563c91fSMat Martineau 		return keyctl_restrict_keyring((key_serial_t) arg2,
17476563c91fSMat Martineau 					       (const char __user *) arg3,
17486563c91fSMat Martineau 					       (const char __user *) arg4);
17491da177e4SLinus Torvalds 
17501da177e4SLinus Torvalds 	default:
17511da177e4SLinus Torvalds 		return -EOPNOTSUPP;
17521da177e4SLinus Torvalds 	}
17531da177e4SLinus Torvalds }
1754