blob: 96a92a645216de09e1870e93ad0464b09f522078 [file] [log] [blame]
Thomas Gleixner2874c5f2019-05-27 08:55:01 +02001// SPDX-License-Identifier: GPL-2.0-or-later
David Howells973c9f42011-01-20 16:38:33 +00002/* Userspace key control operations
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
David Howells3e301482005-06-23 22:00:56 -07004 * Copyright (C) 2004-5 Red Hat, Inc. All Rights Reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * Written by David Howells (dhowells@redhat.com)
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 */
7
Linus Torvalds1da177e2005-04-16 15:20:36 -07008#include <linux/init.h>
9#include <linux/sched.h>
Ingo Molnar29930022017-02-08 18:51:36 +010010#include <linux/sched/task.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/slab.h>
12#include <linux/syscalls.h>
Bryan Schumaker59e6b9c2012-02-24 14:14:50 -050013#include <linux/key.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/keyctl.h>
15#include <linux/fs.h>
Randy.Dunlapc59ede72006-01-11 12:17:46 -080016#include <linux/capability.h>
Ingo Molnar5b825c32017-02-02 17:54:15 +010017#include <linux/cred.h>
Davi Arnaut0cb409d2006-03-24 03:18:43 -080018#include <linux/string.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/err.h>
David Howells38bbca62008-04-29 01:01:19 -070020#include <linux/vmalloc.h>
David Howells70a5bb72008-04-29 01:01:26 -070021#include <linux/security.h>
Kent Overstreeta27bb332013-05-07 16:19:08 -070022#include <linux/uio.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080023#include <linux/uaccess.h>
David Howells822ad642019-02-14 16:20:25 +000024#include <keys/request_key_auth-type.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include "internal.h"
26
David Howellsaa9d4432014-12-01 22:52:45 +000027#define KEY_MAX_DESC_SIZE 4096
28
David Howellsb206f282019-06-26 21:02:32 +010029static const unsigned char keyrings_capabilities[2] = {
David Howells45e0f302019-05-30 14:53:10 +010030 [0] = (KEYCTL_CAPS0_CAPABILITIES |
31 (IS_ENABLED(CONFIG_PERSISTENT_KEYRINGS) ? KEYCTL_CAPS0_PERSISTENT_KEYRINGS : 0) |
32 (IS_ENABLED(CONFIG_KEY_DH_OPERATIONS) ? KEYCTL_CAPS0_DIFFIE_HELLMAN : 0) |
33 (IS_ENABLED(CONFIG_ASYMMETRIC_KEY_TYPE) ? KEYCTL_CAPS0_PUBLIC_KEY : 0) |
34 (IS_ENABLED(CONFIG_BIG_KEYS) ? KEYCTL_CAPS0_BIG_KEY : 0) |
35 KEYCTL_CAPS0_INVALIDATE |
36 KEYCTL_CAPS0_RESTRICT_KEYRING |
37 KEYCTL_CAPS0_MOVE
38 ),
David Howells3b6e4de2019-06-26 21:02:32 +010039 [1] = (KEYCTL_CAPS1_NS_KEYRING_NAME |
David Howellsf7e47672020-01-14 17:07:11 +000040 KEYCTL_CAPS1_NS_KEY_TAG |
41 (IS_ENABLED(CONFIG_KEY_NOTIFICATIONS) ? KEYCTL_CAPS1_NOTIFICATIONS : 0)
42 ),
David Howells45e0f302019-05-30 14:53:10 +010043};
44
Davi Arnaut0cb409d2006-03-24 03:18:43 -080045static int key_get_type_from_user(char *type,
46 const char __user *_type,
47 unsigned len)
48{
49 int ret;
50
51 ret = strncpy_from_user(type, _type, len);
Davi Arnaut0cb409d2006-03-24 03:18:43 -080052 if (ret < 0)
Dan Carpenter4303ef12010-06-11 17:30:05 +010053 return ret;
Davi Arnaut0cb409d2006-03-24 03:18:43 -080054 if (ret == 0 || ret >= len)
55 return -EINVAL;
David Howells54e2c2c2014-09-16 17:29:03 +010056 if (type[0] == '.')
57 return -EPERM;
Davi Arnaut0cb409d2006-03-24 03:18:43 -080058 type[len - 1] = '\0';
Davi Arnaut0cb409d2006-03-24 03:18:43 -080059 return 0;
60}
61
Linus Torvalds1da177e2005-04-16 15:20:36 -070062/*
David Howells973c9f42011-01-20 16:38:33 +000063 * Extract the description of a new key from userspace and either add it as a
64 * new key to the specified keyring or update a matching key in that keyring.
65 *
David Howellscf7f6012012-09-13 13:06:29 +010066 * If the description is NULL or an empty string, the key type is asked to
67 * generate one from the payload.
68 *
David Howells973c9f42011-01-20 16:38:33 +000069 * The keyring must be writable so that we can attach the key to it.
70 *
71 * If successful, the new key's serial number is returned, otherwise an error
72 * code is returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 */
Heiko Carstens1e7bfb22009-01-14 14:14:29 +010074SYSCALL_DEFINE5(add_key, const char __user *, _type,
75 const char __user *, _description,
76 const void __user *, _payload,
77 size_t, plen,
78 key_serial_t, ringid)
Linus Torvalds1da177e2005-04-16 15:20:36 -070079{
David Howells664cceb2005-09-28 17:03:15 +010080 key_ref_t keyring_ref, key_ref;
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 char type[32], *description;
82 void *payload;
Davi Arnaut0cb409d2006-03-24 03:18:43 -080083 long ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
85 ret = -EINVAL;
David Howells38bbca62008-04-29 01:01:19 -070086 if (plen > 1024 * 1024 - 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 goto error;
88
89 /* draw all the data into kernel space */
Davi Arnaut0cb409d2006-03-24 03:18:43 -080090 ret = key_get_type_from_user(type, _type, sizeof(type));
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 if (ret < 0)
92 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
David Howellscf7f6012012-09-13 13:06:29 +010094 description = NULL;
95 if (_description) {
David Howellsaa9d4432014-12-01 22:52:45 +000096 description = strndup_user(_description, KEY_MAX_DESC_SIZE);
David Howellscf7f6012012-09-13 13:06:29 +010097 if (IS_ERR(description)) {
98 ret = PTR_ERR(description);
99 goto error;
100 }
101 if (!*description) {
102 kfree(description);
103 description = NULL;
Mimi Zohara4e3b8d2014-05-22 14:02:23 -0400104 } else if ((description[0] == '.') &&
105 (strncmp(type, "keyring", 7) == 0)) {
106 ret = -EPERM;
107 goto error2;
David Howellscf7f6012012-09-13 13:06:29 +0100108 }
Davi Arnaut0cb409d2006-03-24 03:18:43 -0800109 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
111 /* pull the payload in if one was supplied */
112 payload = NULL;
113
Eric Biggers56496452017-06-08 14:48:40 +0100114 if (plen) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 ret = -ENOMEM;
Michal Hocko752ade62017-05-08 15:57:27 -0700116 payload = kvmalloc(plen, GFP_KERNEL);
117 if (!payload)
118 goto error2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
120 ret = -EFAULT;
121 if (copy_from_user(payload, _payload, plen) != 0)
122 goto error3;
123 }
124
125 /* find the target keyring (which must be writable) */
David Howellsf5895942014-03-14 17:44:49 +0000126 keyring_ref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE);
David Howells664cceb2005-09-28 17:03:15 +0100127 if (IS_ERR(keyring_ref)) {
128 ret = PTR_ERR(keyring_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 goto error3;
130 }
131
132 /* create or update the requested key and add it to the target
133 * keyring */
David Howells664cceb2005-09-28 17:03:15 +0100134 key_ref = key_create_or_update(keyring_ref, type, description,
Linus Torvalds028db3e2019-07-10 18:43:43 -0700135 payload, plen, KEY_PERM_UNDEF,
136 KEY_ALLOC_IN_QUOTA);
David Howells664cceb2005-09-28 17:03:15 +0100137 if (!IS_ERR(key_ref)) {
138 ret = key_ref_to_ptr(key_ref)->serial;
139 key_ref_put(key_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 }
141 else {
David Howells664cceb2005-09-28 17:03:15 +0100142 ret = PTR_ERR(key_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 }
144
David Howells664cceb2005-09-28 17:03:15 +0100145 key_ref_put(keyring_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 error3:
Waiman Longd4eaa282020-06-04 16:48:21 -0700147 kvfree_sensitive(payload, plen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 error2:
149 kfree(description);
150 error:
151 return ret;
David Howellsa8b17ed2011-01-20 16:38:27 +0000152}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154/*
David Howells973c9f42011-01-20 16:38:33 +0000155 * Search the process keyrings and keyring trees linked from those for a
156 * matching key. Keyrings must have appropriate Search permission to be
157 * searched.
158 *
159 * If a key is found, it will be attached to the destination keyring if there's
160 * one specified and the serial number of the key will be returned.
161 *
162 * If no key is found, /sbin/request-key will be invoked if _callout_info is
163 * non-NULL in an attempt to create a key. The _callout_info string will be
164 * passed to /sbin/request-key to aid with completing the request. If the
165 * _callout_info string is "" then it will be changed to "-".
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 */
Heiko Carstens1e7bfb22009-01-14 14:14:29 +0100167SYSCALL_DEFINE4(request_key, const char __user *, _type,
168 const char __user *, _description,
169 const char __user *, _callout_info,
170 key_serial_t, destringid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171{
172 struct key_type *ktype;
David Howells664cceb2005-09-28 17:03:15 +0100173 struct key *key;
174 key_ref_t dest_ref;
David Howells4a38e122008-04-29 01:01:24 -0700175 size_t callout_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 char type[32], *description, *callout_info;
Davi Arnaut0cb409d2006-03-24 03:18:43 -0800177 long ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
179 /* pull the type into kernel space */
Davi Arnaut0cb409d2006-03-24 03:18:43 -0800180 ret = key_get_type_from_user(type, _type, sizeof(type));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 if (ret < 0)
182 goto error;
David Howells1260f802005-08-04 11:50:01 +0100183
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 /* pull the description into kernel space */
David Howellsaa9d4432014-12-01 22:52:45 +0000185 description = strndup_user(_description, KEY_MAX_DESC_SIZE);
Davi Arnaut0cb409d2006-03-24 03:18:43 -0800186 if (IS_ERR(description)) {
187 ret = PTR_ERR(description);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 goto error;
Davi Arnaut0cb409d2006-03-24 03:18:43 -0800189 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190
191 /* pull the callout info into kernel space */
192 callout_info = NULL;
David Howells4a38e122008-04-29 01:01:24 -0700193 callout_len = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 if (_callout_info) {
Davi Arnaut0cb409d2006-03-24 03:18:43 -0800195 callout_info = strndup_user(_callout_info, PAGE_SIZE);
196 if (IS_ERR(callout_info)) {
197 ret = PTR_ERR(callout_info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 goto error2;
Davi Arnaut0cb409d2006-03-24 03:18:43 -0800199 }
David Howells4a38e122008-04-29 01:01:24 -0700200 callout_len = strlen(callout_info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 }
202
203 /* get the destination keyring if specified */
David Howells664cceb2005-09-28 17:03:15 +0100204 dest_ref = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 if (destringid) {
David Howells55931222009-09-02 09:13:45 +0100206 dest_ref = lookup_user_key(destringid, KEY_LOOKUP_CREATE,
David Howellsf5895942014-03-14 17:44:49 +0000207 KEY_NEED_WRITE);
David Howells664cceb2005-09-28 17:03:15 +0100208 if (IS_ERR(dest_ref)) {
209 ret = PTR_ERR(dest_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 goto error3;
211 }
212 }
213
214 /* find the key type */
215 ktype = key_type_lookup(type);
216 if (IS_ERR(ktype)) {
217 ret = PTR_ERR(ktype);
218 goto error4;
219 }
220
221 /* do the search */
David Howellsa58946c2019-06-26 21:02:33 +0100222 key = request_key_and_link(ktype, description, NULL, callout_info,
Linus Torvalds028db3e2019-07-10 18:43:43 -0700223 callout_len, NULL, key_ref_to_ptr(dest_ref),
David Howells7e047ef2006-06-26 00:24:50 -0700224 KEY_ALLOC_IN_QUOTA);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 if (IS_ERR(key)) {
226 ret = PTR_ERR(key);
227 goto error5;
228 }
229
David Howells4aab1e82011-03-11 17:57:33 +0000230 /* wait for the key to finish being constructed */
231 ret = wait_for_key_construction(key, 1);
232 if (ret < 0)
233 goto error6;
234
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 ret = key->serial;
236
David Howells4aab1e82011-03-11 17:57:33 +0000237error6:
David Howells3e301482005-06-23 22:00:56 -0700238 key_put(key);
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700239error5:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 key_type_put(ktype);
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700241error4:
David Howells664cceb2005-09-28 17:03:15 +0100242 key_ref_put(dest_ref);
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700243error3:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 kfree(callout_info);
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700245error2:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 kfree(description);
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700247error:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 return ret;
David Howellsa8b17ed2011-01-20 16:38:27 +0000249}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251/*
David Howells973c9f42011-01-20 16:38:33 +0000252 * Get the ID of the specified process keyring.
253 *
254 * The requested keyring must have search permission to be found.
255 *
256 * If successful, the ID of the requested keyring will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 */
258long keyctl_get_keyring_ID(key_serial_t id, int create)
259{
David Howells664cceb2005-09-28 17:03:15 +0100260 key_ref_t key_ref;
David Howells55931222009-09-02 09:13:45 +0100261 unsigned long lflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 long ret;
263
David Howells55931222009-09-02 09:13:45 +0100264 lflags = create ? KEY_LOOKUP_CREATE : 0;
David Howellsf5895942014-03-14 17:44:49 +0000265 key_ref = lookup_user_key(id, lflags, KEY_NEED_SEARCH);
David Howells664cceb2005-09-28 17:03:15 +0100266 if (IS_ERR(key_ref)) {
267 ret = PTR_ERR(key_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 goto error;
269 }
270
David Howells664cceb2005-09-28 17:03:15 +0100271 ret = key_ref_to_ptr(key_ref)->serial;
272 key_ref_put(key_ref);
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700273error:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 return ret;
David Howells973c9f42011-01-20 16:38:33 +0000275}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277/*
David Howells973c9f42011-01-20 16:38:33 +0000278 * Join a (named) session keyring.
279 *
280 * Create and join an anonymous session keyring or join a named session
281 * keyring, creating it if necessary. A named session keyring must have Search
282 * permission for it to be joined. Session keyrings without this permit will
David Howellsee8f8442017-04-18 15:31:07 +0100283 * be skipped over. It is not permitted for userspace to create or join
284 * keyrings whose name begin with a dot.
David Howells973c9f42011-01-20 16:38:33 +0000285 *
286 * If successful, the ID of the joined session keyring will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 */
288long keyctl_join_session_keyring(const char __user *_name)
289{
290 char *name;
Davi Arnaut0cb409d2006-03-24 03:18:43 -0800291 long ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292
293 /* fetch the name from userspace */
294 name = NULL;
295 if (_name) {
David Howellsaa9d4432014-12-01 22:52:45 +0000296 name = strndup_user(_name, KEY_MAX_DESC_SIZE);
Davi Arnaut0cb409d2006-03-24 03:18:43 -0800297 if (IS_ERR(name)) {
298 ret = PTR_ERR(name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 goto error;
Davi Arnaut0cb409d2006-03-24 03:18:43 -0800300 }
David Howellsee8f8442017-04-18 15:31:07 +0100301
302 ret = -EPERM;
303 if (name[0] == '.')
304 goto error_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 }
306
307 /* join the session */
308 ret = join_session_keyring(name);
David Howellsee8f8442017-04-18 15:31:07 +0100309error_name:
Vegard Nossum0d54ee12009-01-17 17:45:45 +0100310 kfree(name);
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700311error:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312 return ret;
David Howellsa8b17ed2011-01-20 16:38:27 +0000313}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315/*
David Howells973c9f42011-01-20 16:38:33 +0000316 * Update a key's data payload from the given data.
317 *
318 * The key must grant the caller Write permission and the key type must support
319 * updating for this to work. A negative key can be positively instantiated
320 * with this call.
321 *
322 * If successful, 0 will be returned. If the key type does not support
323 * updating, then -EOPNOTSUPP will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 */
325long keyctl_update_key(key_serial_t id,
326 const void __user *_payload,
327 size_t plen)
328{
David Howells664cceb2005-09-28 17:03:15 +0100329 key_ref_t key_ref;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 void *payload;
331 long ret;
332
333 ret = -EINVAL;
334 if (plen > PAGE_SIZE)
335 goto error;
336
337 /* pull the payload in if one was supplied */
338 payload = NULL;
Eric Biggers56496452017-06-08 14:48:40 +0100339 if (plen) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 ret = -ENOMEM;
Waiman Long4f088242020-03-21 21:11:25 -0400341 payload = kvmalloc(plen, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 if (!payload)
343 goto error;
344
345 ret = -EFAULT;
346 if (copy_from_user(payload, _payload, plen) != 0)
347 goto error2;
348 }
349
350 /* find the target key (which must be writable) */
David Howellsf5895942014-03-14 17:44:49 +0000351 key_ref = lookup_user_key(id, 0, KEY_NEED_WRITE);
David Howells664cceb2005-09-28 17:03:15 +0100352 if (IS_ERR(key_ref)) {
353 ret = PTR_ERR(key_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 goto error2;
355 }
356
357 /* update the key */
David Howells664cceb2005-09-28 17:03:15 +0100358 ret = key_update(key_ref, payload, plen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359
David Howells664cceb2005-09-28 17:03:15 +0100360 key_ref_put(key_ref);
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700361error2:
Waiman Longd4eaa282020-06-04 16:48:21 -0700362 kvfree_sensitive(payload, plen);
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700363error:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 return ret;
David Howellsa8b17ed2011-01-20 16:38:27 +0000365}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367/*
David Howells973c9f42011-01-20 16:38:33 +0000368 * Revoke a key.
369 *
370 * The key must be grant the caller Write or Setattr permission for this to
371 * work. The key type should give up its quota claim when revoked. The key
372 * and any links to the key will be automatically garbage collected after a
373 * certain amount of time (/proc/sys/kernel/keys/gc_delay).
374 *
Mimi Zohard3600bc2015-11-10 08:34:46 -0500375 * Keys with KEY_FLAG_KEEP set should not be revoked.
376 *
David Howells973c9f42011-01-20 16:38:33 +0000377 * If successful, 0 is returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 */
379long keyctl_revoke_key(key_serial_t id)
380{
David Howells664cceb2005-09-28 17:03:15 +0100381 key_ref_t key_ref;
Mimi Zohard3600bc2015-11-10 08:34:46 -0500382 struct key *key;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 long ret;
384
Linus Torvalds028db3e2019-07-10 18:43:43 -0700385 key_ref = lookup_user_key(id, 0, KEY_NEED_WRITE);
David Howells664cceb2005-09-28 17:03:15 +0100386 if (IS_ERR(key_ref)) {
387 ret = PTR_ERR(key_ref);
Linus Torvalds028db3e2019-07-10 18:43:43 -0700388 if (ret != -EACCES)
389 goto error;
390 key_ref = lookup_user_key(id, 0, KEY_NEED_SETATTR);
391 if (IS_ERR(key_ref)) {
392 ret = PTR_ERR(key_ref);
393 goto error;
394 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 }
396
Mimi Zohard3600bc2015-11-10 08:34:46 -0500397 key = key_ref_to_ptr(key_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 ret = 0;
Mimi Zohard3600bc2015-11-10 08:34:46 -0500399 if (test_bit(KEY_FLAG_KEEP, &key->flags))
Mimi Zohar1d6d1672016-01-07 07:46:36 -0500400 ret = -EPERM;
401 else
Mimi Zohard3600bc2015-11-10 08:34:46 -0500402 key_revoke(key);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403
David Howells664cceb2005-09-28 17:03:15 +0100404 key_ref_put(key_ref);
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700405error:
David Howells1260f802005-08-04 11:50:01 +0100406 return ret;
David Howellsa8b17ed2011-01-20 16:38:27 +0000407}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409/*
David Howellsfd758152012-05-11 10:56:56 +0100410 * Invalidate a key.
411 *
412 * The key must be grant the caller Invalidate permission for this to work.
413 * The key and any links to the key will be automatically garbage collected
414 * immediately.
415 *
Mimi Zohard3600bc2015-11-10 08:34:46 -0500416 * Keys with KEY_FLAG_KEEP set should not be invalidated.
417 *
David Howellsfd758152012-05-11 10:56:56 +0100418 * If successful, 0 is returned.
419 */
420long keyctl_invalidate_key(key_serial_t id)
421{
422 key_ref_t key_ref;
Mimi Zohard3600bc2015-11-10 08:34:46 -0500423 struct key *key;
David Howellsfd758152012-05-11 10:56:56 +0100424 long ret;
425
426 kenter("%d", id);
427
Linus Torvalds028db3e2019-07-10 18:43:43 -0700428 key_ref = lookup_user_key(id, 0, KEY_NEED_SEARCH);
David Howellsfd758152012-05-11 10:56:56 +0100429 if (IS_ERR(key_ref)) {
430 ret = PTR_ERR(key_ref);
David Howells0c7774a2014-07-17 20:45:08 +0100431
432 /* Root is permitted to invalidate certain special keys */
433 if (capable(CAP_SYS_ADMIN)) {
David Howells8c0637e2020-05-12 15:16:29 +0100434 key_ref = lookup_user_key(id, 0, KEY_SYSADMIN_OVERRIDE);
David Howells0c7774a2014-07-17 20:45:08 +0100435 if (IS_ERR(key_ref))
436 goto error;
437 if (test_bit(KEY_FLAG_ROOT_CAN_INVAL,
438 &key_ref_to_ptr(key_ref)->flags))
439 goto invalidate;
440 goto error_put;
441 }
442
David Howellsfd758152012-05-11 10:56:56 +0100443 goto error;
444 }
445
David Howells0c7774a2014-07-17 20:45:08 +0100446invalidate:
Mimi Zohard3600bc2015-11-10 08:34:46 -0500447 key = key_ref_to_ptr(key_ref);
David Howellsfd758152012-05-11 10:56:56 +0100448 ret = 0;
Mimi Zohard3600bc2015-11-10 08:34:46 -0500449 if (test_bit(KEY_FLAG_KEEP, &key->flags))
450 ret = -EPERM;
Mimi Zohar1d6d1672016-01-07 07:46:36 -0500451 else
Mimi Zohard3600bc2015-11-10 08:34:46 -0500452 key_invalidate(key);
David Howells0c7774a2014-07-17 20:45:08 +0100453error_put:
David Howellsfd758152012-05-11 10:56:56 +0100454 key_ref_put(key_ref);
455error:
456 kleave(" = %ld", ret);
457 return ret;
458}
459
460/*
David Howells973c9f42011-01-20 16:38:33 +0000461 * Clear the specified keyring, creating an empty process keyring if one of the
462 * special keyring IDs is used.
463 *
Mimi Zohard3600bc2015-11-10 08:34:46 -0500464 * The keyring must grant the caller Write permission and not have
465 * KEY_FLAG_KEEP set for this to work. If successful, 0 will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 */
467long keyctl_keyring_clear(key_serial_t ringid)
468{
David Howells664cceb2005-09-28 17:03:15 +0100469 key_ref_t keyring_ref;
Mimi Zohard3600bc2015-11-10 08:34:46 -0500470 struct key *keyring;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 long ret;
472
Linus Torvalds028db3e2019-07-10 18:43:43 -0700473 keyring_ref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE);
David Howells664cceb2005-09-28 17:03:15 +0100474 if (IS_ERR(keyring_ref)) {
475 ret = PTR_ERR(keyring_ref);
David Howells700920e2012-01-18 15:31:45 +0000476
477 /* Root is permitted to invalidate certain special keyrings */
478 if (capable(CAP_SYS_ADMIN)) {
David Howells8c0637e2020-05-12 15:16:29 +0100479 keyring_ref = lookup_user_key(ringid, 0,
480 KEY_SYSADMIN_OVERRIDE);
David Howells700920e2012-01-18 15:31:45 +0000481 if (IS_ERR(keyring_ref))
482 goto error;
483 if (test_bit(KEY_FLAG_ROOT_CAN_CLEAR,
484 &key_ref_to_ptr(keyring_ref)->flags))
485 goto clear;
486 goto error_put;
487 }
488
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 goto error;
490 }
491
David Howells700920e2012-01-18 15:31:45 +0000492clear:
Mimi Zohard3600bc2015-11-10 08:34:46 -0500493 keyring = key_ref_to_ptr(keyring_ref);
494 if (test_bit(KEY_FLAG_KEEP, &keyring->flags))
495 ret = -EPERM;
496 else
497 ret = keyring_clear(keyring);
David Howells700920e2012-01-18 15:31:45 +0000498error_put:
David Howells664cceb2005-09-28 17:03:15 +0100499 key_ref_put(keyring_ref);
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700500error:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 return ret;
David Howellsa8b17ed2011-01-20 16:38:27 +0000502}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504/*
David Howells973c9f42011-01-20 16:38:33 +0000505 * Create a link from a keyring to a key if there's no matching key in the
506 * keyring, otherwise replace the link to the matching key with a link to the
507 * new key.
508 *
Randy Dunlap328c95d2020-08-07 09:51:23 -0700509 * The key must grant the caller Link permission and the keyring must grant
David Howells973c9f42011-01-20 16:38:33 +0000510 * the caller Write permission. Furthermore, if an additional link is created,
511 * the keyring's quota will be extended.
512 *
513 * If successful, 0 will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 */
515long keyctl_keyring_link(key_serial_t id, key_serial_t ringid)
516{
David Howells664cceb2005-09-28 17:03:15 +0100517 key_ref_t keyring_ref, key_ref;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 long ret;
519
David Howellsf5895942014-03-14 17:44:49 +0000520 keyring_ref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE);
David Howells664cceb2005-09-28 17:03:15 +0100521 if (IS_ERR(keyring_ref)) {
522 ret = PTR_ERR(keyring_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 goto error;
524 }
525
David Howellsf5895942014-03-14 17:44:49 +0000526 key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE, KEY_NEED_LINK);
David Howells664cceb2005-09-28 17:03:15 +0100527 if (IS_ERR(key_ref)) {
528 ret = PTR_ERR(key_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 goto error2;
530 }
531
David Howells664cceb2005-09-28 17:03:15 +0100532 ret = key_link(key_ref_to_ptr(keyring_ref), key_ref_to_ptr(key_ref));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533
David Howells664cceb2005-09-28 17:03:15 +0100534 key_ref_put(key_ref);
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700535error2:
David Howells664cceb2005-09-28 17:03:15 +0100536 key_ref_put(keyring_ref);
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700537error:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 return ret;
David Howellsa8b17ed2011-01-20 16:38:27 +0000539}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541/*
David Howells973c9f42011-01-20 16:38:33 +0000542 * Unlink a key from a keyring.
543 *
544 * The keyring must grant the caller Write permission for this to work; the key
545 * itself need not grant the caller anything. If the last link to a key is
546 * removed then that key will be scheduled for destruction.
547 *
Mimi Zohard3600bc2015-11-10 08:34:46 -0500548 * Keys or keyrings with KEY_FLAG_KEEP set should not be unlinked.
549 *
David Howells973c9f42011-01-20 16:38:33 +0000550 * If successful, 0 will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 */
552long keyctl_keyring_unlink(key_serial_t id, key_serial_t ringid)
553{
David Howells664cceb2005-09-28 17:03:15 +0100554 key_ref_t keyring_ref, key_ref;
Mimi Zohard3600bc2015-11-10 08:34:46 -0500555 struct key *keyring, *key;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 long ret;
557
David Howellsf5895942014-03-14 17:44:49 +0000558 keyring_ref = lookup_user_key(ringid, 0, KEY_NEED_WRITE);
David Howells664cceb2005-09-28 17:03:15 +0100559 if (IS_ERR(keyring_ref)) {
560 ret = PTR_ERR(keyring_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 goto error;
562 }
563
David Howells8c0637e2020-05-12 15:16:29 +0100564 key_ref = lookup_user_key(id, KEY_LOOKUP_PARTIAL, KEY_NEED_UNLINK);
David Howells664cceb2005-09-28 17:03:15 +0100565 if (IS_ERR(key_ref)) {
566 ret = PTR_ERR(key_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 goto error2;
568 }
569
Mimi Zohard3600bc2015-11-10 08:34:46 -0500570 keyring = key_ref_to_ptr(keyring_ref);
571 key = key_ref_to_ptr(key_ref);
572 if (test_bit(KEY_FLAG_KEEP, &keyring->flags) &&
573 test_bit(KEY_FLAG_KEEP, &key->flags))
574 ret = -EPERM;
575 else
576 ret = key_unlink(keyring, key);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577
David Howells664cceb2005-09-28 17:03:15 +0100578 key_ref_put(key_ref);
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700579error2:
David Howells664cceb2005-09-28 17:03:15 +0100580 key_ref_put(keyring_ref);
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700581error:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 return ret;
David Howellsa8b17ed2011-01-20 16:38:27 +0000583}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585/*
David Howellsed0ac5c2019-05-20 21:51:50 +0100586 * Move a link to a key from one keyring to another, displacing any matching
587 * key from the destination keyring.
588 *
589 * The key must grant the caller Link permission and both keyrings must grant
590 * the caller Write permission. There must also be a link in the from keyring
591 * to the key. If both keyrings are the same, nothing is done.
592 *
593 * If successful, 0 will be returned.
594 */
595long keyctl_keyring_move(key_serial_t id, key_serial_t from_ringid,
596 key_serial_t to_ringid, unsigned int flags)
597{
598 key_ref_t key_ref, from_ref, to_ref;
599 long ret;
600
601 if (flags & ~KEYCTL_MOVE_EXCL)
602 return -EINVAL;
603
604 key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE, KEY_NEED_LINK);
605 if (IS_ERR(key_ref))
606 return PTR_ERR(key_ref);
607
608 from_ref = lookup_user_key(from_ringid, 0, KEY_NEED_WRITE);
609 if (IS_ERR(from_ref)) {
610 ret = PTR_ERR(from_ref);
611 goto error2;
612 }
613
614 to_ref = lookup_user_key(to_ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE);
615 if (IS_ERR(to_ref)) {
616 ret = PTR_ERR(to_ref);
617 goto error3;
618 }
619
620 ret = key_move(key_ref_to_ptr(key_ref), key_ref_to_ptr(from_ref),
621 key_ref_to_ptr(to_ref), flags);
622
623 key_ref_put(to_ref);
624error3:
625 key_ref_put(from_ref);
626error2:
627 key_ref_put(key_ref);
628 return ret;
629}
630
631/*
David Howells973c9f42011-01-20 16:38:33 +0000632 * Return a description of a key to userspace.
633 *
634 * The key must grant the caller View permission for this to work.
635 *
636 * If there's a buffer, we place up to buflen bytes of data into it formatted
637 * in the following way:
638 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 * type;uid;gid;perm;description<NUL>
David Howells973c9f42011-01-20 16:38:33 +0000640 *
641 * If successful, we return the amount of description available, irrespective
642 * of how much we may have copied into the buffer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 */
644long keyctl_describe_key(key_serial_t keyid,
645 char __user *buffer,
646 size_t buflen)
647{
David Howells3e301482005-06-23 22:00:56 -0700648 struct key *key, *instkey;
David Howells664cceb2005-09-28 17:03:15 +0100649 key_ref_t key_ref;
David Howellsaa9d4432014-12-01 22:52:45 +0000650 char *infobuf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 long ret;
David Howellsaa9d4432014-12-01 22:52:45 +0000652 int desclen, infolen;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
David Howellsf5895942014-03-14 17:44:49 +0000654 key_ref = lookup_user_key(keyid, KEY_LOOKUP_PARTIAL, KEY_NEED_VIEW);
David Howells664cceb2005-09-28 17:03:15 +0100655 if (IS_ERR(key_ref)) {
David Howells3e301482005-06-23 22:00:56 -0700656 /* viewing a key under construction is permitted if we have the
657 * authorisation token handy */
David Howells664cceb2005-09-28 17:03:15 +0100658 if (PTR_ERR(key_ref) == -EACCES) {
David Howells3e301482005-06-23 22:00:56 -0700659 instkey = key_get_instantiation_authkey(keyid);
660 if (!IS_ERR(instkey)) {
661 key_put(instkey);
David Howells8bbf49762008-11-14 10:39:14 +1100662 key_ref = lookup_user_key(keyid,
David Howells55931222009-09-02 09:13:45 +0100663 KEY_LOOKUP_PARTIAL,
David Howells8c0637e2020-05-12 15:16:29 +0100664 KEY_AUTHTOKEN_OVERRIDE);
David Howells664cceb2005-09-28 17:03:15 +0100665 if (!IS_ERR(key_ref))
David Howells3e301482005-06-23 22:00:56 -0700666 goto okay;
667 }
668 }
669
David Howells664cceb2005-09-28 17:03:15 +0100670 ret = PTR_ERR(key_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 goto error;
672 }
673
David Howells3e301482005-06-23 22:00:56 -0700674okay:
David Howells664cceb2005-09-28 17:03:15 +0100675 key = key_ref_to_ptr(key_ref);
David Howellsaa9d4432014-12-01 22:52:45 +0000676 desclen = strlen(key->description);
David Howells664cceb2005-09-28 17:03:15 +0100677
David Howellsaa9d4432014-12-01 22:52:45 +0000678 /* calculate how much information we're going to return */
679 ret = -ENOMEM;
680 infobuf = kasprintf(GFP_KERNEL,
681 "%s;%d;%d;%08x;",
682 key->type->name,
683 from_kuid_munged(current_user_ns(), key->uid),
684 from_kgid_munged(current_user_ns(), key->gid),
Linus Torvalds028db3e2019-07-10 18:43:43 -0700685 key->perm);
David Howellsaa9d4432014-12-01 22:52:45 +0000686 if (!infobuf)
687 goto error2;
688 infolen = strlen(infobuf);
689 ret = infolen + desclen + 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690
691 /* consider returning the data */
David Howellsaa9d4432014-12-01 22:52:45 +0000692 if (buffer && buflen >= ret) {
693 if (copy_to_user(buffer, infobuf, infolen) != 0 ||
694 copy_to_user(buffer + infolen, key->description,
695 desclen + 1) != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 ret = -EFAULT;
697 }
698
David Howellsaa9d4432014-12-01 22:52:45 +0000699 kfree(infobuf);
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700700error2:
David Howells664cceb2005-09-28 17:03:15 +0100701 key_ref_put(key_ref);
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700702error:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 return ret;
David Howellsa8b17ed2011-01-20 16:38:27 +0000704}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706/*
David Howells973c9f42011-01-20 16:38:33 +0000707 * Search the specified keyring and any keyrings it links to for a matching
708 * key. Only keyrings that grant the caller Search permission will be searched
709 * (this includes the starting keyring). Only keys with Search permission can
710 * be found.
711 *
712 * If successful, the found key will be linked to the destination keyring if
713 * supplied and the key has Link permission, and the found key ID will be
714 * returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 */
716long keyctl_keyring_search(key_serial_t ringid,
717 const char __user *_type,
718 const char __user *_description,
719 key_serial_t destringid)
720{
721 struct key_type *ktype;
David Howells664cceb2005-09-28 17:03:15 +0100722 key_ref_t keyring_ref, key_ref, dest_ref;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 char type[32], *description;
Davi Arnaut0cb409d2006-03-24 03:18:43 -0800724 long ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725
726 /* pull the type and description into kernel space */
Davi Arnaut0cb409d2006-03-24 03:18:43 -0800727 ret = key_get_type_from_user(type, _type, sizeof(type));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 if (ret < 0)
729 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730
David Howellsaa9d4432014-12-01 22:52:45 +0000731 description = strndup_user(_description, KEY_MAX_DESC_SIZE);
Davi Arnaut0cb409d2006-03-24 03:18:43 -0800732 if (IS_ERR(description)) {
733 ret = PTR_ERR(description);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 goto error;
Davi Arnaut0cb409d2006-03-24 03:18:43 -0800735 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736
737 /* get the keyring at which to begin the search */
David Howellsf5895942014-03-14 17:44:49 +0000738 keyring_ref = lookup_user_key(ringid, 0, KEY_NEED_SEARCH);
David Howells664cceb2005-09-28 17:03:15 +0100739 if (IS_ERR(keyring_ref)) {
740 ret = PTR_ERR(keyring_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 goto error2;
742 }
743
744 /* get the destination keyring if specified */
David Howells664cceb2005-09-28 17:03:15 +0100745 dest_ref = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 if (destringid) {
David Howells55931222009-09-02 09:13:45 +0100747 dest_ref = lookup_user_key(destringid, KEY_LOOKUP_CREATE,
David Howellsf5895942014-03-14 17:44:49 +0000748 KEY_NEED_WRITE);
David Howells664cceb2005-09-28 17:03:15 +0100749 if (IS_ERR(dest_ref)) {
750 ret = PTR_ERR(dest_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 goto error3;
752 }
753 }
754
755 /* find the key type */
756 ktype = key_type_lookup(type);
757 if (IS_ERR(ktype)) {
758 ret = PTR_ERR(ktype);
759 goto error4;
760 }
761
762 /* do the search */
David Howellsdcf49db2019-06-26 21:02:32 +0100763 key_ref = keyring_search(keyring_ref, ktype, description, true);
David Howells664cceb2005-09-28 17:03:15 +0100764 if (IS_ERR(key_ref)) {
765 ret = PTR_ERR(key_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766
767 /* treat lack or presence of a negative key the same */
768 if (ret == -EAGAIN)
769 ret = -ENOKEY;
770 goto error5;
771 }
772
773 /* link the resulting key to the destination keyring if we can */
David Howells664cceb2005-09-28 17:03:15 +0100774 if (dest_ref) {
David Howellsf5895942014-03-14 17:44:49 +0000775 ret = key_permission(key_ref, KEY_NEED_LINK);
David Howells29db9192005-10-30 15:02:44 -0800776 if (ret < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 goto error6;
778
David Howells664cceb2005-09-28 17:03:15 +0100779 ret = key_link(key_ref_to_ptr(dest_ref), key_ref_to_ptr(key_ref));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 if (ret < 0)
781 goto error6;
782 }
783
David Howells664cceb2005-09-28 17:03:15 +0100784 ret = key_ref_to_ptr(key_ref)->serial;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700786error6:
David Howells664cceb2005-09-28 17:03:15 +0100787 key_ref_put(key_ref);
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700788error5:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 key_type_put(ktype);
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700790error4:
David Howells664cceb2005-09-28 17:03:15 +0100791 key_ref_put(dest_ref);
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700792error3:
David Howells664cceb2005-09-28 17:03:15 +0100793 key_ref_put(keyring_ref);
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700794error2:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 kfree(description);
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700796error:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 return ret;
David Howellsa8b17ed2011-01-20 16:38:27 +0000798}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800/*
Waiman Longd3ec10a2020-03-21 21:11:24 -0400801 * Call the read method
802 */
803static long __keyctl_read_key(struct key *key, char *buffer, size_t buflen)
804{
805 long ret;
806
807 down_read(&key->sem);
808 ret = key_validate(key);
809 if (ret == 0)
810 ret = key->type->read(key, buffer, buflen);
811 up_read(&key->sem);
812 return ret;
813}
814
815/*
David Howells973c9f42011-01-20 16:38:33 +0000816 * Read a key's payload.
817 *
818 * The key must either grant the caller Read permission, or it must grant the
819 * caller Search permission when searched for from the process keyrings.
820 *
821 * If successful, we place up to buflen bytes of data into the buffer, if one
822 * is provided, and return the amount of data that is available in the key,
823 * irrespective of how much we copied into the buffer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 */
825long keyctl_read_key(key_serial_t keyid, char __user *buffer, size_t buflen)
826{
David Howells664cceb2005-09-28 17:03:15 +0100827 struct key *key;
828 key_ref_t key_ref;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 long ret;
Waiman Long4f088242020-03-21 21:11:25 -0400830 char *key_data = NULL;
831 size_t key_data_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832
833 /* find the key first */
David Howells8c0637e2020-05-12 15:16:29 +0100834 key_ref = lookup_user_key(keyid, 0, KEY_DEFER_PERM_CHECK);
David Howells664cceb2005-09-28 17:03:15 +0100835 if (IS_ERR(key_ref)) {
836 ret = -ENOKEY;
Waiman Longd3ec10a2020-03-21 21:11:24 -0400837 goto out;
David Howells664cceb2005-09-28 17:03:15 +0100838 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839
David Howells664cceb2005-09-28 17:03:15 +0100840 key = key_ref_to_ptr(key_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841
David Howells363b02d2017-10-04 16:43:25 +0100842 ret = key_read_state(key);
843 if (ret < 0)
Waiman Longd3ec10a2020-03-21 21:11:24 -0400844 goto key_put_out; /* Negatively instantiated */
Eric Biggers37863c42017-09-18 11:37:23 -0700845
David Howells664cceb2005-09-28 17:03:15 +0100846 /* see if we can read it directly */
David Howellsf5895942014-03-14 17:44:49 +0000847 ret = key_permission(key_ref, KEY_NEED_READ);
David Howells29db9192005-10-30 15:02:44 -0800848 if (ret == 0)
David Howells664cceb2005-09-28 17:03:15 +0100849 goto can_read_key;
David Howells29db9192005-10-30 15:02:44 -0800850 if (ret != -EACCES)
Waiman Longd3ec10a2020-03-21 21:11:24 -0400851 goto key_put_out;
David Howells664cceb2005-09-28 17:03:15 +0100852
853 /* we can't; see if it's searchable from this process's keyrings
854 * - we automatically take account of the fact that it may be
855 * dangling off an instantiation key
856 */
857 if (!is_key_possessed(key_ref)) {
858 ret = -EACCES;
Waiman Longd3ec10a2020-03-21 21:11:24 -0400859 goto key_put_out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 }
861
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 /* the key is probably readable - now try to read it */
Justin P. Mattockc5b60b52010-04-21 00:02:11 -0700863can_read_key:
Waiman Longd3ec10a2020-03-21 21:11:24 -0400864 if (!key->type->read) {
865 ret = -EOPNOTSUPP;
866 goto key_put_out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 }
868
Waiman Longd3ec10a2020-03-21 21:11:24 -0400869 if (!buffer || !buflen) {
870 /* Get the key length from the read method */
871 ret = __keyctl_read_key(key, NULL, 0);
872 goto key_put_out;
873 }
874
875 /*
876 * Read the data with the semaphore held (since we might sleep)
877 * to protect against the key being updated or revoked.
878 *
879 * Allocating a temporary buffer to hold the keys before
880 * transferring them to user buffer to avoid potential
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -0700881 * deadlock involving page fault and mmap_lock.
Waiman Long4f088242020-03-21 21:11:25 -0400882 *
883 * key_data_len = (buflen <= PAGE_SIZE)
884 * ? buflen : actual length of key data
885 *
886 * This prevents allocating arbitrary large buffer which can
887 * be much larger than the actual key length. In the latter case,
888 * at least 2 passes of this loop is required.
Waiman Longd3ec10a2020-03-21 21:11:24 -0400889 */
Waiman Long4f088242020-03-21 21:11:25 -0400890 key_data_len = (buflen <= PAGE_SIZE) ? buflen : 0;
891 for (;;) {
892 if (key_data_len) {
893 key_data = kvmalloc(key_data_len, GFP_KERNEL);
894 if (!key_data) {
895 ret = -ENOMEM;
896 goto key_put_out;
897 }
898 }
Waiman Longd3ec10a2020-03-21 21:11:24 -0400899
Waiman Long4f088242020-03-21 21:11:25 -0400900 ret = __keyctl_read_key(key, key_data, key_data_len);
Waiman Longd3ec10a2020-03-21 21:11:24 -0400901
Waiman Long4f088242020-03-21 21:11:25 -0400902 /*
903 * Read methods will just return the required length without
904 * any copying if the provided length isn't large enough.
905 */
906 if (ret <= 0 || ret > buflen)
907 break;
908
909 /*
910 * The key may change (unlikely) in between 2 consecutive
911 * __keyctl_read_key() calls. In this case, we reallocate
912 * a larger buffer and redo the key read when
913 * key_data_len < ret <= buflen.
914 */
915 if (ret > key_data_len) {
916 if (unlikely(key_data))
Waiman Longd4eaa282020-06-04 16:48:21 -0700917 kvfree_sensitive(key_data, key_data_len);
Waiman Long4f088242020-03-21 21:11:25 -0400918 key_data_len = ret;
919 continue; /* Allocate buffer */
920 }
921
Waiman Longd3ec10a2020-03-21 21:11:24 -0400922 if (copy_to_user(buffer, key_data, ret))
923 ret = -EFAULT;
Waiman Long4f088242020-03-21 21:11:25 -0400924 break;
Waiman Longd3ec10a2020-03-21 21:11:24 -0400925 }
Waiman Longd4eaa282020-06-04 16:48:21 -0700926 kvfree_sensitive(key_data, key_data_len);
Waiman Longd3ec10a2020-03-21 21:11:24 -0400927
928key_put_out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 key_put(key);
Waiman Longd3ec10a2020-03-21 21:11:24 -0400930out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 return ret;
David Howellsa8b17ed2011-01-20 16:38:27 +0000932}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934/*
David Howells973c9f42011-01-20 16:38:33 +0000935 * Change the ownership of a key
936 *
937 * The key must grant the caller Setattr permission for this to work, though
938 * the key need not be fully instantiated yet. For the UID to be changed, or
939 * for the GID to be changed to a group the caller is not a member of, the
940 * caller must have sysadmin capability. If either uid or gid is -1 then that
941 * attribute is not changed.
942 *
943 * If the UID is to be changed, the new user must have sufficient quota to
944 * accept the key. The quota deduction will be removed from the old user to
945 * the new user should the attribute be changed.
946 *
947 * If successful, 0 will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948 */
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800949long keyctl_chown_key(key_serial_t id, uid_t user, gid_t group)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950{
Fredrik Tolf58016492006-06-26 00:24:51 -0700951 struct key_user *newowner, *zapowner = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 struct key *key;
David Howells664cceb2005-09-28 17:03:15 +0100953 key_ref_t key_ref;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 long ret;
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800955 kuid_t uid;
956 kgid_t gid;
957
958 uid = make_kuid(current_user_ns(), user);
959 gid = make_kgid(current_user_ns(), group);
960 ret = -EINVAL;
961 if ((user != (uid_t) -1) && !uid_valid(uid))
962 goto error;
963 if ((group != (gid_t) -1) && !gid_valid(gid))
964 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965
966 ret = 0;
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800967 if (user == (uid_t) -1 && group == (gid_t) -1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 goto error;
969
David Howells55931222009-09-02 09:13:45 +0100970 key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE | KEY_LOOKUP_PARTIAL,
Linus Torvalds028db3e2019-07-10 18:43:43 -0700971 KEY_NEED_SETATTR);
David Howells664cceb2005-09-28 17:03:15 +0100972 if (IS_ERR(key_ref)) {
973 ret = PTR_ERR(key_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974 goto error;
975 }
976
David Howells664cceb2005-09-28 17:03:15 +0100977 key = key_ref_to_ptr(key_ref);
978
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979 /* make the changes with the locks held to prevent chown/chown races */
980 ret = -EACCES;
981 down_write(&key->sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982
983 if (!capable(CAP_SYS_ADMIN)) {
984 /* only the sysadmin can chown a key to some other UID */
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800985 if (user != (uid_t) -1 && !uid_eq(key->uid, uid))
Fredrik Tolf58016492006-06-26 00:24:51 -0700986 goto error_put;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987
988 /* only the sysadmin can set the key's GID to a group other
989 * than one of those that the current process subscribes to */
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800990 if (group != (gid_t) -1 && !gid_eq(gid, key->gid) && !in_group_p(gid))
Fredrik Tolf58016492006-06-26 00:24:51 -0700991 goto error_put;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 }
993
Fredrik Tolf58016492006-06-26 00:24:51 -0700994 /* change the UID */
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800995 if (user != (uid_t) -1 && !uid_eq(uid, key->uid)) {
Fredrik Tolf58016492006-06-26 00:24:51 -0700996 ret = -ENOMEM;
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800997 newowner = key_user_lookup(uid);
Fredrik Tolf58016492006-06-26 00:24:51 -0700998 if (!newowner)
999 goto error_put;
1000
1001 /* transfer the quota burden to the new user */
1002 if (test_bit(KEY_FLAG_IN_QUOTA, &key->flags)) {
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -08001003 unsigned maxkeys = uid_eq(uid, GLOBAL_ROOT_UID) ?
David Howells0b77f5b2008-04-29 01:01:32 -07001004 key_quota_root_maxkeys : key_quota_maxkeys;
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -08001005 unsigned maxbytes = uid_eq(uid, GLOBAL_ROOT_UID) ?
David Howells0b77f5b2008-04-29 01:01:32 -07001006 key_quota_root_maxbytes : key_quota_maxbytes;
1007
Fredrik Tolf58016492006-06-26 00:24:51 -07001008 spin_lock(&newowner->lock);
Yang Xu2e356102020-02-28 12:41:51 +08001009 if (newowner->qnkeys + 1 > maxkeys ||
1010 newowner->qnbytes + key->quotalen > maxbytes ||
David Howells0b77f5b2008-04-29 01:01:32 -07001011 newowner->qnbytes + key->quotalen <
1012 newowner->qnbytes)
Fredrik Tolf58016492006-06-26 00:24:51 -07001013 goto quota_overrun;
1014
1015 newowner->qnkeys++;
1016 newowner->qnbytes += key->quotalen;
1017 spin_unlock(&newowner->lock);
1018
1019 spin_lock(&key->user->lock);
1020 key->user->qnkeys--;
1021 key->user->qnbytes -= key->quotalen;
1022 spin_unlock(&key->user->lock);
1023 }
1024
1025 atomic_dec(&key->user->nkeys);
1026 atomic_inc(&newowner->nkeys);
1027
David Howells363b02d2017-10-04 16:43:25 +01001028 if (key->state != KEY_IS_UNINSTANTIATED) {
Fredrik Tolf58016492006-06-26 00:24:51 -07001029 atomic_dec(&key->user->nikeys);
1030 atomic_inc(&newowner->nikeys);
1031 }
1032
1033 zapowner = key->user;
1034 key->user = newowner;
1035 key->uid = uid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 }
1037
1038 /* change the GID */
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -08001039 if (group != (gid_t) -1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040 key->gid = gid;
1041
David Howellsf7e47672020-01-14 17:07:11 +00001042 notify_key(key, NOTIFY_KEY_SETATTR, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 ret = 0;
1044
Fredrik Tolf58016492006-06-26 00:24:51 -07001045error_put:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046 up_write(&key->sem);
1047 key_put(key);
Fredrik Tolf58016492006-06-26 00:24:51 -07001048 if (zapowner)
1049 key_user_put(zapowner);
1050error:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051 return ret;
1052
Fredrik Tolf58016492006-06-26 00:24:51 -07001053quota_overrun:
1054 spin_unlock(&newowner->lock);
1055 zapowner = newowner;
1056 ret = -EDQUOT;
1057 goto error_put;
David Howellsa8b17ed2011-01-20 16:38:27 +00001058}
Fredrik Tolf58016492006-06-26 00:24:51 -07001059
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060/*
David Howells973c9f42011-01-20 16:38:33 +00001061 * Change the permission mask on a key.
1062 *
1063 * The key must grant the caller Setattr permission for this to work, though
1064 * the key need not be fully instantiated yet. If the caller does not have
1065 * sysadmin capability, it may only change the permission on keys that it owns.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 */
Linus Torvalds028db3e2019-07-10 18:43:43 -07001067long keyctl_setperm_key(key_serial_t id, key_perm_t perm)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068{
1069 struct key *key;
David Howells664cceb2005-09-28 17:03:15 +01001070 key_ref_t key_ref;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 long ret;
1072
Linus Torvalds028db3e2019-07-10 18:43:43 -07001073 ret = -EINVAL;
David Howells664cceb2005-09-28 17:03:15 +01001074 if (perm & ~(KEY_POS_ALL | KEY_USR_ALL | KEY_GRP_ALL | KEY_OTH_ALL))
Linus Torvalds028db3e2019-07-10 18:43:43 -07001075 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076
David Howells55931222009-09-02 09:13:45 +01001077 key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE | KEY_LOOKUP_PARTIAL,
Linus Torvalds028db3e2019-07-10 18:43:43 -07001078 KEY_NEED_SETATTR);
David Howells664cceb2005-09-28 17:03:15 +01001079 if (IS_ERR(key_ref)) {
1080 ret = PTR_ERR(key_ref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081 goto error;
1082 }
1083
David Howells664cceb2005-09-28 17:03:15 +01001084 key = key_ref_to_ptr(key_ref);
1085
Linus Torvalds028db3e2019-07-10 18:43:43 -07001086 /* make the changes with the locks held to prevent chown/chmod races */
1087 ret = -EACCES;
1088 down_write(&key->sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089
Linus Torvalds028db3e2019-07-10 18:43:43 -07001090 /* if we're not the sysadmin, we can only change a key that we own */
1091 if (capable(CAP_SYS_ADMIN) || uid_eq(key->uid, current_fsuid())) {
1092 key->perm = perm;
David Howellsf7e47672020-01-14 17:07:11 +00001093 notify_key(key, NOTIFY_KEY_SETATTR, 0);
Linus Torvalds028db3e2019-07-10 18:43:43 -07001094 ret = 0;
David Howells76d8aea2005-06-23 22:00:49 -07001095 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 up_write(&key->sem);
1098 key_put(key);
David Howells76d8aea2005-06-23 22:00:49 -07001099error:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 return ret;
David Howellsa8b17ed2011-01-20 16:38:27 +00001101}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102
David Howells8bbf49762008-11-14 10:39:14 +11001103/*
David Howells973c9f42011-01-20 16:38:33 +00001104 * Get the destination keyring for instantiation and check that the caller has
1105 * Write permission on it.
David Howells8bbf49762008-11-14 10:39:14 +11001106 */
1107static long get_instantiation_keyring(key_serial_t ringid,
1108 struct request_key_auth *rka,
1109 struct key **_dest_keyring)
1110{
1111 key_ref_t dkref;
1112
David Howellseca1bf52008-12-29 00:41:51 +00001113 *_dest_keyring = NULL;
1114
David Howells8bbf49762008-11-14 10:39:14 +11001115 /* just return a NULL pointer if we weren't asked to make a link */
David Howellseca1bf52008-12-29 00:41:51 +00001116 if (ringid == 0)
David Howells8bbf49762008-11-14 10:39:14 +11001117 return 0;
David Howells8bbf49762008-11-14 10:39:14 +11001118
1119 /* if a specific keyring is nominated by ID, then use that */
1120 if (ringid > 0) {
David Howellsf5895942014-03-14 17:44:49 +00001121 dkref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE);
David Howells8bbf49762008-11-14 10:39:14 +11001122 if (IS_ERR(dkref))
1123 return PTR_ERR(dkref);
1124 *_dest_keyring = key_ref_to_ptr(dkref);
1125 return 0;
1126 }
1127
1128 if (ringid == KEY_SPEC_REQKEY_AUTH_KEY)
1129 return -EINVAL;
1130
1131 /* otherwise specify the destination keyring recorded in the
1132 * authorisation key (any KEY_SPEC_*_KEYRING) */
1133 if (ringid >= KEY_SPEC_REQUESTOR_KEYRING) {
David Howells21279cf2009-10-15 10:14:35 +01001134 *_dest_keyring = key_get(rka->dest_keyring);
David Howells8bbf49762008-11-14 10:39:14 +11001135 return 0;
1136 }
1137
1138 return -ENOKEY;
1139}
1140
David Howellsd84f4f92008-11-14 10:39:23 +11001141/*
David Howells973c9f42011-01-20 16:38:33 +00001142 * Change the request_key authorisation key on the current process.
David Howellsd84f4f92008-11-14 10:39:23 +11001143 */
1144static int keyctl_change_reqkey_auth(struct key *key)
1145{
1146 struct cred *new;
1147
1148 new = prepare_creds();
1149 if (!new)
1150 return -ENOMEM;
1151
1152 key_put(new->request_key_auth);
1153 new->request_key_auth = key_get(key);
1154
1155 return commit_creds(new);
1156}
1157
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158/*
David Howells973c9f42011-01-20 16:38:33 +00001159 * Instantiate a key with the specified payload and link the key into the
1160 * destination keyring if one is given.
1161 *
1162 * The caller must have the appropriate instantiation permit set for this to
1163 * work (see keyctl_assume_authority). No other permissions are required.
1164 *
1165 * If successful, 0 will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166 */
Christoph Hellwig5d47b392020-09-25 06:51:46 +02001167static long keyctl_instantiate_key_common(key_serial_t id,
Al Virob353a1f2015-03-17 09:59:38 -04001168 struct iov_iter *from,
David Howellsee009e4a02011-03-07 15:06:20 +00001169 key_serial_t ringid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170{
David Howellsd84f4f92008-11-14 10:39:23 +11001171 const struct cred *cred = current_cred();
David Howells3e301482005-06-23 22:00:56 -07001172 struct request_key_auth *rka;
David Howells8bbf49762008-11-14 10:39:14 +11001173 struct key *instkey, *dest_keyring;
Al Virob353a1f2015-03-17 09:59:38 -04001174 size_t plen = from ? iov_iter_count(from) : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175 void *payload;
1176 long ret;
1177
David Howellsd84f4f92008-11-14 10:39:23 +11001178 kenter("%d,,%zu,%d", id, plen, ringid);
1179
Al Virob353a1f2015-03-17 09:59:38 -04001180 if (!plen)
1181 from = NULL;
1182
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 ret = -EINVAL;
David Howells38bbca62008-04-29 01:01:19 -07001184 if (plen > 1024 * 1024 - 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185 goto error;
1186
David Howellsb5f545c2006-01-08 01:02:47 -08001187 /* the appropriate instantiation authorisation key must have been
1188 * assumed before calling this */
1189 ret = -EPERM;
David Howellsd84f4f92008-11-14 10:39:23 +11001190 instkey = cred->request_key_auth;
David Howellsb5f545c2006-01-08 01:02:47 -08001191 if (!instkey)
1192 goto error;
1193
David Howells146aa8b2015-10-21 14:04:48 +01001194 rka = instkey->payload.data[0];
David Howellsb5f545c2006-01-08 01:02:47 -08001195 if (rka->target_key->serial != id)
1196 goto error;
1197
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 /* pull the payload in if one was supplied */
1199 payload = NULL;
1200
Al Virob353a1f2015-03-17 09:59:38 -04001201 if (from) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202 ret = -ENOMEM;
Michal Hocko752ade62017-05-08 15:57:27 -07001203 payload = kvmalloc(plen, GFP_KERNEL);
1204 if (!payload)
1205 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206
Al Virob353a1f2015-03-17 09:59:38 -04001207 ret = -EFAULT;
Al Virocbbd26b2016-11-01 22:09:04 -04001208 if (!copy_from_iter_full(payload, plen, from))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 goto error2;
1210 }
1211
David Howells3e301482005-06-23 22:00:56 -07001212 /* find the destination keyring amongst those belonging to the
1213 * requesting task */
David Howells8bbf49762008-11-14 10:39:14 +11001214 ret = get_instantiation_keyring(ringid, rka, &dest_keyring);
1215 if (ret < 0)
1216 goto error2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217
1218 /* instantiate the key and link it into a keyring */
David Howells3e301482005-06-23 22:00:56 -07001219 ret = key_instantiate_and_link(rka->target_key, payload, plen,
David Howells8bbf49762008-11-14 10:39:14 +11001220 dest_keyring, instkey);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221
David Howells8bbf49762008-11-14 10:39:14 +11001222 key_put(dest_keyring);
David Howellsb5f545c2006-01-08 01:02:47 -08001223
1224 /* discard the assumed authority if it's just been disabled by
1225 * instantiation of the key */
David Howellsd84f4f92008-11-14 10:39:23 +11001226 if (ret == 0)
1227 keyctl_change_reqkey_auth(NULL);
David Howellsb5f545c2006-01-08 01:02:47 -08001228
1229error2:
Waiman Longd4eaa282020-06-04 16:48:21 -07001230 kvfree_sensitive(payload, plen);
David Howellsb5f545c2006-01-08 01:02:47 -08001231error:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232 return ret;
David Howellsa8b17ed2011-01-20 16:38:27 +00001233}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235/*
David Howellsee009e4a02011-03-07 15:06:20 +00001236 * Instantiate a key with the specified payload and link the key into the
1237 * destination keyring if one is given.
1238 *
1239 * The caller must have the appropriate instantiation permit set for this to
1240 * work (see keyctl_assume_authority). No other permissions are required.
1241 *
1242 * If successful, 0 will be returned.
1243 */
1244long keyctl_instantiate_key(key_serial_t id,
1245 const void __user *_payload,
1246 size_t plen,
1247 key_serial_t ringid)
1248{
1249 if (_payload && plen) {
Al Virob353a1f2015-03-17 09:59:38 -04001250 struct iovec iov;
1251 struct iov_iter from;
1252 int ret;
David Howellsee009e4a02011-03-07 15:06:20 +00001253
Al Virob353a1f2015-03-17 09:59:38 -04001254 ret = import_single_range(WRITE, (void __user *)_payload, plen,
1255 &iov, &from);
1256 if (unlikely(ret))
1257 return ret;
1258
1259 return keyctl_instantiate_key_common(id, &from, ringid);
David Howellsee009e4a02011-03-07 15:06:20 +00001260 }
1261
Al Virob353a1f2015-03-17 09:59:38 -04001262 return keyctl_instantiate_key_common(id, NULL, ringid);
David Howellsee009e4a02011-03-07 15:06:20 +00001263}
1264
1265/*
1266 * Instantiate a key with the specified multipart payload and link the key into
1267 * the destination keyring if one is given.
1268 *
1269 * The caller must have the appropriate instantiation permit set for this to
1270 * work (see keyctl_assume_authority). No other permissions are required.
1271 *
1272 * If successful, 0 will be returned.
1273 */
1274long keyctl_instantiate_key_iov(key_serial_t id,
1275 const struct iovec __user *_payload_iov,
1276 unsigned ioc,
1277 key_serial_t ringid)
1278{
1279 struct iovec iovstack[UIO_FASTIOV], *iov = iovstack;
Al Virob353a1f2015-03-17 09:59:38 -04001280 struct iov_iter from;
David Howellsee009e4a02011-03-07 15:06:20 +00001281 long ret;
1282
Al Virob353a1f2015-03-17 09:59:38 -04001283 if (!_payload_iov)
1284 ioc = 0;
David Howellsee009e4a02011-03-07 15:06:20 +00001285
Al Virob353a1f2015-03-17 09:59:38 -04001286 ret = import_iovec(WRITE, _payload_iov, ioc,
1287 ARRAY_SIZE(iovstack), &iov, &from);
David Howellsee009e4a02011-03-07 15:06:20 +00001288 if (ret < 0)
Al Virob353a1f2015-03-17 09:59:38 -04001289 return ret;
1290 ret = keyctl_instantiate_key_common(id, &from, ringid);
1291 kfree(iov);
David Howellsee009e4a02011-03-07 15:06:20 +00001292 return ret;
David Howellsee009e4a02011-03-07 15:06:20 +00001293}
1294
1295/*
David Howells973c9f42011-01-20 16:38:33 +00001296 * Negatively instantiate the key with the given timeout (in seconds) and link
1297 * the key into the destination keyring if one is given.
1298 *
1299 * The caller must have the appropriate instantiation permit set for this to
1300 * work (see keyctl_assume_authority). No other permissions are required.
1301 *
1302 * The key and any links to the key will be automatically garbage collected
1303 * after the timeout expires.
1304 *
1305 * Negative keys are used to rate limit repeated request_key() calls by causing
1306 * them to return -ENOKEY until the negative key expires.
1307 *
1308 * If successful, 0 will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309 */
1310long keyctl_negate_key(key_serial_t id, unsigned timeout, key_serial_t ringid)
1311{
David Howellsfdd1b942011-03-07 15:06:09 +00001312 return keyctl_reject_key(id, timeout, ENOKEY, ringid);
1313}
1314
1315/*
1316 * Negatively instantiate the key with the given timeout (in seconds) and error
1317 * code and link the key into the destination keyring if one is given.
1318 *
1319 * The caller must have the appropriate instantiation permit set for this to
1320 * work (see keyctl_assume_authority). No other permissions are required.
1321 *
1322 * The key and any links to the key will be automatically garbage collected
1323 * after the timeout expires.
1324 *
1325 * Negative keys are used to rate limit repeated request_key() calls by causing
1326 * them to return the specified error code until the negative key expires.
1327 *
1328 * If successful, 0 will be returned.
1329 */
1330long keyctl_reject_key(key_serial_t id, unsigned timeout, unsigned error,
1331 key_serial_t ringid)
1332{
David Howellsd84f4f92008-11-14 10:39:23 +11001333 const struct cred *cred = current_cred();
David Howells3e301482005-06-23 22:00:56 -07001334 struct request_key_auth *rka;
David Howells8bbf49762008-11-14 10:39:14 +11001335 struct key *instkey, *dest_keyring;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336 long ret;
1337
David Howellsfdd1b942011-03-07 15:06:09 +00001338 kenter("%d,%u,%u,%d", id, timeout, error, ringid);
1339
1340 /* must be a valid error code and mustn't be a kernel special */
1341 if (error <= 0 ||
1342 error >= MAX_ERRNO ||
1343 error == ERESTARTSYS ||
1344 error == ERESTARTNOINTR ||
1345 error == ERESTARTNOHAND ||
1346 error == ERESTART_RESTARTBLOCK)
1347 return -EINVAL;
David Howellsd84f4f92008-11-14 10:39:23 +11001348
David Howellsb5f545c2006-01-08 01:02:47 -08001349 /* the appropriate instantiation authorisation key must have been
1350 * assumed before calling this */
1351 ret = -EPERM;
David Howellsd84f4f92008-11-14 10:39:23 +11001352 instkey = cred->request_key_auth;
David Howellsb5f545c2006-01-08 01:02:47 -08001353 if (!instkey)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355
David Howells146aa8b2015-10-21 14:04:48 +01001356 rka = instkey->payload.data[0];
David Howellsb5f545c2006-01-08 01:02:47 -08001357 if (rka->target_key->serial != id)
1358 goto error;
David Howells3e301482005-06-23 22:00:56 -07001359
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 /* find the destination keyring if present (which must also be
1361 * writable) */
David Howells8bbf49762008-11-14 10:39:14 +11001362 ret = get_instantiation_keyring(ringid, rka, &dest_keyring);
1363 if (ret < 0)
1364 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365
1366 /* instantiate the key and link it into a keyring */
David Howellsfdd1b942011-03-07 15:06:09 +00001367 ret = key_reject_and_link(rka->target_key, timeout, error,
David Howells8bbf49762008-11-14 10:39:14 +11001368 dest_keyring, instkey);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369
David Howells8bbf49762008-11-14 10:39:14 +11001370 key_put(dest_keyring);
David Howellsb5f545c2006-01-08 01:02:47 -08001371
1372 /* discard the assumed authority if it's just been disabled by
1373 * instantiation of the key */
David Howellsd84f4f92008-11-14 10:39:23 +11001374 if (ret == 0)
1375 keyctl_change_reqkey_auth(NULL);
David Howellsb5f545c2006-01-08 01:02:47 -08001376
1377error:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378 return ret;
David Howellsa8b17ed2011-01-20 16:38:27 +00001379}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381/*
David Howells973c9f42011-01-20 16:38:33 +00001382 * Read or set the default keyring in which request_key() will cache keys and
1383 * return the old setting.
1384 *
Eric Biggersc9f838d2017-04-18 15:31:09 +01001385 * If a thread or process keyring is specified then it will be created if it
1386 * doesn't yet exist. The old setting will be returned if successful.
David Howells3e301482005-06-23 22:00:56 -07001387 */
1388long keyctl_set_reqkey_keyring(int reqkey_defl)
1389{
David Howellsd84f4f92008-11-14 10:39:23 +11001390 struct cred *new;
1391 int ret, old_setting;
1392
1393 old_setting = current_cred_xxx(jit_keyring);
1394
1395 if (reqkey_defl == KEY_REQKEY_DEFL_NO_CHANGE)
1396 return old_setting;
1397
1398 new = prepare_creds();
1399 if (!new)
1400 return -ENOMEM;
David Howells3e301482005-06-23 22:00:56 -07001401
1402 switch (reqkey_defl) {
1403 case KEY_REQKEY_DEFL_THREAD_KEYRING:
David Howellsd84f4f92008-11-14 10:39:23 +11001404 ret = install_thread_keyring_to_cred(new);
David Howells3e301482005-06-23 22:00:56 -07001405 if (ret < 0)
David Howellsd84f4f92008-11-14 10:39:23 +11001406 goto error;
David Howells3e301482005-06-23 22:00:56 -07001407 goto set;
1408
1409 case KEY_REQKEY_DEFL_PROCESS_KEYRING:
David Howellsd84f4f92008-11-14 10:39:23 +11001410 ret = install_process_keyring_to_cred(new);
Eric Biggersc9f838d2017-04-18 15:31:09 +01001411 if (ret < 0)
1412 goto error;
David Howellsd84f4f92008-11-14 10:39:23 +11001413 goto set;
David Howells3e301482005-06-23 22:00:56 -07001414
1415 case KEY_REQKEY_DEFL_DEFAULT:
1416 case KEY_REQKEY_DEFL_SESSION_KEYRING:
1417 case KEY_REQKEY_DEFL_USER_KEYRING:
1418 case KEY_REQKEY_DEFL_USER_SESSION_KEYRING:
David Howellsd84f4f92008-11-14 10:39:23 +11001419 case KEY_REQKEY_DEFL_REQUESTOR_KEYRING:
1420 goto set;
David Howells3e301482005-06-23 22:00:56 -07001421
1422 case KEY_REQKEY_DEFL_NO_CHANGE:
David Howells3e301482005-06-23 22:00:56 -07001423 case KEY_REQKEY_DEFL_GROUP_KEYRING:
1424 default:
David Howellsd84f4f92008-11-14 10:39:23 +11001425 ret = -EINVAL;
1426 goto error;
David Howells3e301482005-06-23 22:00:56 -07001427 }
1428
David Howellsd84f4f92008-11-14 10:39:23 +11001429set:
1430 new->jit_keyring = reqkey_defl;
1431 commit_creds(new);
1432 return old_setting;
1433error:
1434 abort_creds(new);
Dan Carpenter4303ef12010-06-11 17:30:05 +01001435 return ret;
David Howellsa8b17ed2011-01-20 16:38:27 +00001436}
David Howellsd84f4f92008-11-14 10:39:23 +11001437
David Howells3e301482005-06-23 22:00:56 -07001438/*
David Howells973c9f42011-01-20 16:38:33 +00001439 * Set or clear the timeout on a key.
1440 *
1441 * Either the key must grant the caller Setattr permission or else the caller
1442 * must hold an instantiation authorisation token for the key.
1443 *
1444 * The timeout is either 0 to clear the timeout, or a number of seconds from
1445 * the current time. The key and any links to the key will be automatically
1446 * garbage collected after the timeout expires.
1447 *
Mimi Zohard3600bc2015-11-10 08:34:46 -05001448 * Keys with KEY_FLAG_KEEP set should not be timed out.
1449 *
David Howells973c9f42011-01-20 16:38:33 +00001450 * If successful, 0 is returned.
David Howells017679c2006-01-08 01:02:43 -08001451 */
1452long keyctl_set_timeout(key_serial_t id, unsigned timeout)
1453{
David Howells91562352010-06-11 17:31:05 +01001454 struct key *key, *instkey;
David Howells017679c2006-01-08 01:02:43 -08001455 key_ref_t key_ref;
David Howells017679c2006-01-08 01:02:43 -08001456 long ret;
1457
David Howells55931222009-09-02 09:13:45 +01001458 key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE | KEY_LOOKUP_PARTIAL,
Linus Torvalds028db3e2019-07-10 18:43:43 -07001459 KEY_NEED_SETATTR);
David Howells017679c2006-01-08 01:02:43 -08001460 if (IS_ERR(key_ref)) {
David Howells91562352010-06-11 17:31:05 +01001461 /* setting the timeout on a key under construction is permitted
1462 * if we have the authorisation token handy */
1463 if (PTR_ERR(key_ref) == -EACCES) {
1464 instkey = key_get_instantiation_authkey(id);
1465 if (!IS_ERR(instkey)) {
1466 key_put(instkey);
1467 key_ref = lookup_user_key(id,
1468 KEY_LOOKUP_PARTIAL,
David Howells8c0637e2020-05-12 15:16:29 +01001469 KEY_AUTHTOKEN_OVERRIDE);
David Howells91562352010-06-11 17:31:05 +01001470 if (!IS_ERR(key_ref))
1471 goto okay;
1472 }
1473 }
1474
David Howells017679c2006-01-08 01:02:43 -08001475 ret = PTR_ERR(key_ref);
1476 goto error;
1477 }
1478
David Howells91562352010-06-11 17:31:05 +01001479okay:
David Howells017679c2006-01-08 01:02:43 -08001480 key = key_ref_to_ptr(key_ref);
Mimi Zohar1d6d1672016-01-07 07:46:36 -05001481 ret = 0;
David Howellsf7e47672020-01-14 17:07:11 +00001482 if (test_bit(KEY_FLAG_KEEP, &key->flags)) {
Mimi Zohard3600bc2015-11-10 08:34:46 -05001483 ret = -EPERM;
David Howellsf7e47672020-01-14 17:07:11 +00001484 } else {
Mimi Zohard3600bc2015-11-10 08:34:46 -05001485 key_set_timeout(key, timeout);
David Howellsf7e47672020-01-14 17:07:11 +00001486 notify_key(key, NOTIFY_KEY_SETATTR, 0);
1487 }
David Howells017679c2006-01-08 01:02:43 -08001488 key_put(key);
1489
David Howells017679c2006-01-08 01:02:43 -08001490error:
1491 return ret;
David Howellsa8b17ed2011-01-20 16:38:27 +00001492}
David Howells017679c2006-01-08 01:02:43 -08001493
David Howells017679c2006-01-08 01:02:43 -08001494/*
David Howells973c9f42011-01-20 16:38:33 +00001495 * Assume (or clear) the authority to instantiate the specified key.
1496 *
1497 * This sets the authoritative token currently in force for key instantiation.
1498 * This must be done for a key to be instantiated. It has the effect of making
1499 * available all the keys from the caller of the request_key() that created a
1500 * key to request_key() calls made by the caller of this function.
1501 *
1502 * The caller must have the instantiation key in their process keyrings with a
1503 * Search permission grant available to the caller.
1504 *
1505 * If the ID given is 0, then the setting will be cleared and 0 returned.
1506 *
1507 * If the ID given has a matching an authorisation key, then that key will be
1508 * set and its ID will be returned. The authorisation key can be read to get
1509 * the callout information passed to request_key().
David Howellsb5f545c2006-01-08 01:02:47 -08001510 */
1511long keyctl_assume_authority(key_serial_t id)
1512{
1513 struct key *authkey;
1514 long ret;
1515
1516 /* special key IDs aren't permitted */
1517 ret = -EINVAL;
1518 if (id < 0)
1519 goto error;
1520
1521 /* we divest ourselves of authority if given an ID of 0 */
1522 if (id == 0) {
David Howellsd84f4f92008-11-14 10:39:23 +11001523 ret = keyctl_change_reqkey_auth(NULL);
David Howellsb5f545c2006-01-08 01:02:47 -08001524 goto error;
1525 }
1526
1527 /* attempt to assume the authority temporarily granted to us whilst we
1528 * instantiate the specified key
1529 * - the authorisation key must be in the current task's keyrings
1530 * somewhere
1531 */
1532 authkey = key_get_instantiation_authkey(id);
1533 if (IS_ERR(authkey)) {
1534 ret = PTR_ERR(authkey);
1535 goto error;
1536 }
1537
David Howellsd84f4f92008-11-14 10:39:23 +11001538 ret = keyctl_change_reqkey_auth(authkey);
Eric Biggers884bee02017-09-18 11:36:12 -07001539 if (ret == 0)
1540 ret = authkey->serial;
David Howellsd84f4f92008-11-14 10:39:23 +11001541 key_put(authkey);
David Howellsb5f545c2006-01-08 01:02:47 -08001542error:
1543 return ret;
David Howellsa8b17ed2011-01-20 16:38:27 +00001544}
David Howellsb5f545c2006-01-08 01:02:47 -08001545
David Howells70a5bb72008-04-29 01:01:26 -07001546/*
David Howells973c9f42011-01-20 16:38:33 +00001547 * Get a key's the LSM security label.
1548 *
1549 * The key must grant the caller View permission for this to work.
1550 *
1551 * If there's a buffer, then up to buflen bytes of data will be placed into it.
1552 *
1553 * If successful, the amount of information available will be returned,
1554 * irrespective of how much was copied (including the terminal NUL).
David Howells70a5bb72008-04-29 01:01:26 -07001555 */
1556long keyctl_get_security(key_serial_t keyid,
1557 char __user *buffer,
1558 size_t buflen)
1559{
1560 struct key *key, *instkey;
1561 key_ref_t key_ref;
1562 char *context;
1563 long ret;
1564
David Howellsf5895942014-03-14 17:44:49 +00001565 key_ref = lookup_user_key(keyid, KEY_LOOKUP_PARTIAL, KEY_NEED_VIEW);
David Howells70a5bb72008-04-29 01:01:26 -07001566 if (IS_ERR(key_ref)) {
1567 if (PTR_ERR(key_ref) != -EACCES)
1568 return PTR_ERR(key_ref);
1569
1570 /* viewing a key under construction is also permitted if we
1571 * have the authorisation token handy */
1572 instkey = key_get_instantiation_authkey(keyid);
1573 if (IS_ERR(instkey))
Roel Kluinfa1cc7b2009-12-15 15:05:12 -08001574 return PTR_ERR(instkey);
David Howells70a5bb72008-04-29 01:01:26 -07001575 key_put(instkey);
1576
David Howells8c0637e2020-05-12 15:16:29 +01001577 key_ref = lookup_user_key(keyid, KEY_LOOKUP_PARTIAL,
1578 KEY_AUTHTOKEN_OVERRIDE);
David Howells70a5bb72008-04-29 01:01:26 -07001579 if (IS_ERR(key_ref))
1580 return PTR_ERR(key_ref);
1581 }
1582
1583 key = key_ref_to_ptr(key_ref);
1584 ret = security_key_getsecurity(key, &context);
1585 if (ret == 0) {
1586 /* if no information was returned, give userspace an empty
1587 * string */
1588 ret = 1;
1589 if (buffer && buflen > 0 &&
1590 copy_to_user(buffer, "", 1) != 0)
1591 ret = -EFAULT;
1592 } else if (ret > 0) {
1593 /* return as much data as there's room for */
1594 if (buffer && buflen > 0) {
1595 if (buflen > ret)
1596 buflen = ret;
1597
1598 if (copy_to_user(buffer, context, buflen) != 0)
1599 ret = -EFAULT;
1600 }
1601
1602 kfree(context);
1603 }
1604
1605 key_ref_put(key_ref);
1606 return ret;
1607}
1608
David Howellsee18d642009-09-02 09:14:21 +01001609/*
David Howells973c9f42011-01-20 16:38:33 +00001610 * Attempt to install the calling process's session keyring on the process's
1611 * parent process.
1612 *
Linus Torvalds028db3e2019-07-10 18:43:43 -07001613 * The keyring must exist and must grant the caller LINK permission, and the
David Howells973c9f42011-01-20 16:38:33 +00001614 * parent process must be single-threaded and must have the same effective
1615 * ownership as this process and mustn't be SUID/SGID.
1616 *
1617 * The keyring will be emplaced on the parent when it next resumes userspace.
1618 *
1619 * If successful, 0 will be returned.
David Howellsee18d642009-09-02 09:14:21 +01001620 */
1621long keyctl_session_to_parent(void)
1622{
1623 struct task_struct *me, *parent;
1624 const struct cred *mycred, *pcred;
Al Viro67d12142012-06-27 11:07:19 +04001625 struct callback_head *newwork, *oldwork;
David Howellsee18d642009-09-02 09:14:21 +01001626 key_ref_t keyring_r;
Oleg Nesterov413cd3d2012-05-11 10:59:08 +10001627 struct cred *cred;
David Howellsee18d642009-09-02 09:14:21 +01001628 int ret;
1629
Linus Torvalds028db3e2019-07-10 18:43:43 -07001630 keyring_r = lookup_user_key(KEY_SPEC_SESSION_KEYRING, 0, KEY_NEED_LINK);
David Howellsee18d642009-09-02 09:14:21 +01001631 if (IS_ERR(keyring_r))
1632 return PTR_ERR(keyring_r);
1633
Oleg Nesterov413cd3d2012-05-11 10:59:08 +10001634 ret = -ENOMEM;
Oleg Nesterov413cd3d2012-05-11 10:59:08 +10001635
David Howellsee18d642009-09-02 09:14:21 +01001636 /* our parent is going to need a new cred struct, a new tgcred struct
1637 * and new security data, so we allocate them here to prevent ENOMEM in
1638 * our parent */
David Howellsee18d642009-09-02 09:14:21 +01001639 cred = cred_alloc_blank();
1640 if (!cred)
Al Viro67d12142012-06-27 11:07:19 +04001641 goto error_keyring;
1642 newwork = &cred->rcu;
David Howellsee18d642009-09-02 09:14:21 +01001643
David Howells3a505972012-10-02 19:24:29 +01001644 cred->session_keyring = key_ref_to_ptr(keyring_r);
1645 keyring_r = NULL;
Al Viro67d12142012-06-27 11:07:19 +04001646 init_task_work(newwork, key_change_session_keyring);
David Howellsee18d642009-09-02 09:14:21 +01001647
1648 me = current;
David Howells9d1ac652010-09-10 09:59:46 +01001649 rcu_read_lock();
David Howellsee18d642009-09-02 09:14:21 +01001650 write_lock_irq(&tasklist_lock);
1651
David Howellsee18d642009-09-02 09:14:21 +01001652 ret = -EPERM;
Oleg Nesterov413cd3d2012-05-11 10:59:08 +10001653 oldwork = NULL;
David Howells7936d162019-05-22 14:09:29 +01001654 parent = rcu_dereference_protected(me->real_parent,
1655 lockdep_is_held(&tasklist_lock));
David Howellsee18d642009-09-02 09:14:21 +01001656
1657 /* the parent mustn't be init and mustn't be a kernel thread */
1658 if (parent->pid <= 1 || !parent->mm)
Oleg Nesterov413cd3d2012-05-11 10:59:08 +10001659 goto unlock;
David Howellsee18d642009-09-02 09:14:21 +01001660
1661 /* the parent must be single threaded */
Oleg Nesterovdd98acf2010-05-26 14:43:23 -07001662 if (!thread_group_empty(parent))
Oleg Nesterov413cd3d2012-05-11 10:59:08 +10001663 goto unlock;
David Howellsee18d642009-09-02 09:14:21 +01001664
1665 /* the parent and the child must have different session keyrings or
1666 * there's no point */
1667 mycred = current_cred();
1668 pcred = __task_cred(parent);
1669 if (mycred == pcred ||
David Howells3a505972012-10-02 19:24:29 +01001670 mycred->session_keyring == pcred->session_keyring) {
Oleg Nesterov413cd3d2012-05-11 10:59:08 +10001671 ret = 0;
1672 goto unlock;
1673 }
David Howellsee18d642009-09-02 09:14:21 +01001674
1675 /* the parent must have the same effective ownership and mustn't be
1676 * SUID/SGID */
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -08001677 if (!uid_eq(pcred->uid, mycred->euid) ||
1678 !uid_eq(pcred->euid, mycred->euid) ||
1679 !uid_eq(pcred->suid, mycred->euid) ||
1680 !gid_eq(pcred->gid, mycred->egid) ||
1681 !gid_eq(pcred->egid, mycred->egid) ||
1682 !gid_eq(pcred->sgid, mycred->egid))
Oleg Nesterov413cd3d2012-05-11 10:59:08 +10001683 goto unlock;
David Howellsee18d642009-09-02 09:14:21 +01001684
1685 /* the keyrings must have the same UID */
David Howells3a505972012-10-02 19:24:29 +01001686 if ((pcred->session_keyring &&
Linus Torvalds2a74dbb2012-12-16 15:40:50 -08001687 !uid_eq(pcred->session_keyring->uid, mycred->euid)) ||
1688 !uid_eq(mycred->session_keyring->uid, mycred->euid))
Oleg Nesterov413cd3d2012-05-11 10:59:08 +10001689 goto unlock;
David Howellsee18d642009-09-02 09:14:21 +01001690
Oleg Nesterov413cd3d2012-05-11 10:59:08 +10001691 /* cancel an already pending keyring replacement */
1692 oldwork = task_work_cancel(parent, key_change_session_keyring);
David Howellsee18d642009-09-02 09:14:21 +01001693
1694 /* the replacement session keyring is applied just prior to userspace
1695 * restarting */
Jens Axboe91989c72020-10-16 09:02:26 -06001696 ret = task_work_add(parent, newwork, TWA_RESUME);
Oleg Nesterov413cd3d2012-05-11 10:59:08 +10001697 if (!ret)
1698 newwork = NULL;
1699unlock:
David Howellsee18d642009-09-02 09:14:21 +01001700 write_unlock_irq(&tasklist_lock);
David Howells9d1ac652010-09-10 09:59:46 +01001701 rcu_read_unlock();
Al Viro67d12142012-06-27 11:07:19 +04001702 if (oldwork)
1703 put_cred(container_of(oldwork, struct cred, rcu));
1704 if (newwork)
1705 put_cred(cred);
David Howellsee18d642009-09-02 09:14:21 +01001706 return ret;
1707
1708error_keyring:
1709 key_ref_put(keyring_r);
1710 return ret;
1711}
1712
David Howellsb5f545c2006-01-08 01:02:47 -08001713/*
Mat Martineau6563c912017-03-01 16:44:09 -08001714 * Apply a restriction to a given keyring.
1715 *
1716 * The caller must have Setattr permission to change keyring restrictions.
1717 *
1718 * The requested type name may be a NULL pointer to reject all attempts
Eric Biggers18026d82017-12-08 15:13:29 +00001719 * to link to the keyring. In this case, _restriction must also be NULL.
1720 * Otherwise, both _type and _restriction must be non-NULL.
Mat Martineau6563c912017-03-01 16:44:09 -08001721 *
1722 * Returns 0 if successful.
1723 */
1724long keyctl_restrict_keyring(key_serial_t id, const char __user *_type,
1725 const char __user *_restriction)
1726{
1727 key_ref_t key_ref;
Mat Martineau6563c912017-03-01 16:44:09 -08001728 char type[32];
1729 char *restriction = NULL;
1730 long ret;
1731
Linus Torvalds028db3e2019-07-10 18:43:43 -07001732 key_ref = lookup_user_key(id, 0, KEY_NEED_SETATTR);
Mat Martineau6563c912017-03-01 16:44:09 -08001733 if (IS_ERR(key_ref))
1734 return PTR_ERR(key_ref);
1735
Eric Biggers18026d82017-12-08 15:13:29 +00001736 ret = -EINVAL;
Mat Martineau6563c912017-03-01 16:44:09 -08001737 if (_type) {
Eric Biggers18026d82017-12-08 15:13:29 +00001738 if (!_restriction)
1739 goto error;
1740
Mat Martineau6563c912017-03-01 16:44:09 -08001741 ret = key_get_type_from_user(type, _type, sizeof(type));
1742 if (ret < 0)
1743 goto error;
Mat Martineau6563c912017-03-01 16:44:09 -08001744
1745 restriction = strndup_user(_restriction, PAGE_SIZE);
1746 if (IS_ERR(restriction)) {
1747 ret = PTR_ERR(restriction);
1748 goto error;
1749 }
Eric Biggers18026d82017-12-08 15:13:29 +00001750 } else {
1751 if (_restriction)
1752 goto error;
Mat Martineau6563c912017-03-01 16:44:09 -08001753 }
1754
Eric Biggers18026d82017-12-08 15:13:29 +00001755 ret = keyring_restrict(key_ref, _type ? type : NULL, restriction);
Mat Martineau6563c912017-03-01 16:44:09 -08001756 kfree(restriction);
Mat Martineau6563c912017-03-01 16:44:09 -08001757error:
1758 key_ref_put(key_ref);
Mat Martineau6563c912017-03-01 16:44:09 -08001759 return ret;
1760}
1761
David Howellsf7e47672020-01-14 17:07:11 +00001762#ifdef CONFIG_KEY_NOTIFICATIONS
1763/*
1764 * Watch for changes to a key.
1765 *
1766 * The caller must have View permission to watch a key or keyring.
1767 */
1768long keyctl_watch_key(key_serial_t id, int watch_queue_fd, int watch_id)
1769{
1770 struct watch_queue *wqueue;
1771 struct watch_list *wlist = NULL;
1772 struct watch *watch = NULL;
1773 struct key *key;
1774 key_ref_t key_ref;
1775 long ret;
1776
1777 if (watch_id < -1 || watch_id > 0xff)
1778 return -EINVAL;
1779
1780 key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE, KEY_NEED_VIEW);
1781 if (IS_ERR(key_ref))
1782 return PTR_ERR(key_ref);
1783 key = key_ref_to_ptr(key_ref);
1784
1785 wqueue = get_watch_queue(watch_queue_fd);
1786 if (IS_ERR(wqueue)) {
1787 ret = PTR_ERR(wqueue);
1788 goto err_key;
1789 }
1790
1791 if (watch_id >= 0) {
1792 ret = -ENOMEM;
1793 if (!key->watchers) {
1794 wlist = kzalloc(sizeof(*wlist), GFP_KERNEL);
1795 if (!wlist)
1796 goto err_wqueue;
1797 init_watch_list(wlist, NULL);
1798 }
1799
1800 watch = kzalloc(sizeof(*watch), GFP_KERNEL);
1801 if (!watch)
1802 goto err_wlist;
1803
1804 init_watch(watch, wqueue);
1805 watch->id = key->serial;
1806 watch->info_id = (u32)watch_id << WATCH_INFO_ID__SHIFT;
1807
1808 ret = security_watch_key(key);
1809 if (ret < 0)
1810 goto err_watch;
1811
1812 down_write(&key->sem);
1813 if (!key->watchers) {
1814 key->watchers = wlist;
1815 wlist = NULL;
1816 }
1817
1818 ret = add_watch_to_object(watch, key->watchers);
1819 up_write(&key->sem);
1820
1821 if (ret == 0)
1822 watch = NULL;
1823 } else {
1824 ret = -EBADSLT;
1825 if (key->watchers) {
1826 down_write(&key->sem);
1827 ret = remove_watch_from_object(key->watchers,
1828 wqueue, key_serial(key),
1829 false);
1830 up_write(&key->sem);
1831 }
1832 }
1833
1834err_watch:
1835 kfree(watch);
1836err_wlist:
1837 kfree(wlist);
1838err_wqueue:
1839 put_watch_queue(wqueue);
1840err_key:
1841 key_put(key);
1842 return ret;
1843}
1844#endif /* CONFIG_KEY_NOTIFICATIONS */
1845
Mat Martineau6563c912017-03-01 16:44:09 -08001846/*
David Howells45e0f302019-05-30 14:53:10 +01001847 * Get keyrings subsystem capabilities.
1848 */
1849long keyctl_capabilities(unsigned char __user *_buffer, size_t buflen)
1850{
1851 size_t size = buflen;
1852
1853 if (size > 0) {
1854 if (size > sizeof(keyrings_capabilities))
1855 size = sizeof(keyrings_capabilities);
1856 if (copy_to_user(_buffer, keyrings_capabilities, size) != 0)
1857 return -EFAULT;
1858 if (size < buflen &&
1859 clear_user(_buffer + size, buflen - size) != 0)
1860 return -EFAULT;
1861 }
1862
1863 return sizeof(keyrings_capabilities);
1864}
1865
1866/*
David Howells973c9f42011-01-20 16:38:33 +00001867 * The key control system call
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868 */
Heiko Carstens938bb9f2009-01-14 14:14:30 +01001869SYSCALL_DEFINE5(keyctl, int, option, unsigned long, arg2, unsigned long, arg3,
1870 unsigned long, arg4, unsigned long, arg5)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871{
1872 switch (option) {
1873 case KEYCTL_GET_KEYRING_ID:
1874 return keyctl_get_keyring_ID((key_serial_t) arg2,
1875 (int) arg3);
1876
1877 case KEYCTL_JOIN_SESSION_KEYRING:
1878 return keyctl_join_session_keyring((const char __user *) arg2);
1879
1880 case KEYCTL_UPDATE:
1881 return keyctl_update_key((key_serial_t) arg2,
1882 (const void __user *) arg3,
1883 (size_t) arg4);
1884
1885 case KEYCTL_REVOKE:
1886 return keyctl_revoke_key((key_serial_t) arg2);
1887
1888 case KEYCTL_DESCRIBE:
1889 return keyctl_describe_key((key_serial_t) arg2,
1890 (char __user *) arg3,
1891 (unsigned) arg4);
1892
1893 case KEYCTL_CLEAR:
1894 return keyctl_keyring_clear((key_serial_t) arg2);
1895
1896 case KEYCTL_LINK:
1897 return keyctl_keyring_link((key_serial_t) arg2,
1898 (key_serial_t) arg3);
1899
1900 case KEYCTL_UNLINK:
1901 return keyctl_keyring_unlink((key_serial_t) arg2,
1902 (key_serial_t) arg3);
1903
1904 case KEYCTL_SEARCH:
1905 return keyctl_keyring_search((key_serial_t) arg2,
1906 (const char __user *) arg3,
1907 (const char __user *) arg4,
1908 (key_serial_t) arg5);
1909
1910 case KEYCTL_READ:
1911 return keyctl_read_key((key_serial_t) arg2,
1912 (char __user *) arg3,
1913 (size_t) arg4);
1914
1915 case KEYCTL_CHOWN:
1916 return keyctl_chown_key((key_serial_t) arg2,
1917 (uid_t) arg3,
1918 (gid_t) arg4);
1919
1920 case KEYCTL_SETPERM:
1921 return keyctl_setperm_key((key_serial_t) arg2,
Linus Torvalds028db3e2019-07-10 18:43:43 -07001922 (key_perm_t) arg3);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923
1924 case KEYCTL_INSTANTIATE:
1925 return keyctl_instantiate_key((key_serial_t) arg2,
1926 (const void __user *) arg3,
1927 (size_t) arg4,
1928 (key_serial_t) arg5);
1929
1930 case KEYCTL_NEGATE:
1931 return keyctl_negate_key((key_serial_t) arg2,
1932 (unsigned) arg3,
1933 (key_serial_t) arg4);
1934
David Howells3e301482005-06-23 22:00:56 -07001935 case KEYCTL_SET_REQKEY_KEYRING:
1936 return keyctl_set_reqkey_keyring(arg2);
1937
David Howells017679c2006-01-08 01:02:43 -08001938 case KEYCTL_SET_TIMEOUT:
1939 return keyctl_set_timeout((key_serial_t) arg2,
1940 (unsigned) arg3);
1941
David Howellsb5f545c2006-01-08 01:02:47 -08001942 case KEYCTL_ASSUME_AUTHORITY:
1943 return keyctl_assume_authority((key_serial_t) arg2);
1944
David Howells70a5bb72008-04-29 01:01:26 -07001945 case KEYCTL_GET_SECURITY:
1946 return keyctl_get_security((key_serial_t) arg2,
James Morris90bd49a2008-12-29 14:35:35 +11001947 (char __user *) arg3,
David Howells70a5bb72008-04-29 01:01:26 -07001948 (size_t) arg4);
1949
David Howellsee18d642009-09-02 09:14:21 +01001950 case KEYCTL_SESSION_TO_PARENT:
1951 return keyctl_session_to_parent();
1952
David Howellsfdd1b942011-03-07 15:06:09 +00001953 case KEYCTL_REJECT:
1954 return keyctl_reject_key((key_serial_t) arg2,
1955 (unsigned) arg3,
1956 (unsigned) arg4,
1957 (key_serial_t) arg5);
1958
David Howellsee009e4a02011-03-07 15:06:20 +00001959 case KEYCTL_INSTANTIATE_IOV:
1960 return keyctl_instantiate_key_iov(
1961 (key_serial_t) arg2,
1962 (const struct iovec __user *) arg3,
1963 (unsigned) arg4,
1964 (key_serial_t) arg5);
1965
David Howellsfd758152012-05-11 10:56:56 +01001966 case KEYCTL_INVALIDATE:
1967 return keyctl_invalidate_key((key_serial_t) arg2);
1968
David Howellsf36f8c72013-09-24 10:35:19 +01001969 case KEYCTL_GET_PERSISTENT:
1970 return keyctl_get_persistent((uid_t)arg2, (key_serial_t)arg3);
1971
Mat Martineauddbb4112016-04-12 19:54:58 +01001972 case KEYCTL_DH_COMPUTE:
1973 return keyctl_dh_compute((struct keyctl_dh_params __user *) arg2,
Stephan Mueller4693fc72016-05-26 23:38:12 +02001974 (char __user *) arg3, (size_t) arg4,
Stephan Muellerf1c316a2016-08-19 20:39:09 +02001975 (struct keyctl_kdf_params __user *) arg5);
Mat Martineauddbb4112016-04-12 19:54:58 +01001976
Mat Martineau6563c912017-03-01 16:44:09 -08001977 case KEYCTL_RESTRICT_KEYRING:
1978 return keyctl_restrict_keyring((key_serial_t) arg2,
1979 (const char __user *) arg3,
1980 (const char __user *) arg4);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981
David Howells00d60fd2018-10-09 17:46:59 +01001982 case KEYCTL_PKEY_QUERY:
1983 if (arg3 != 0)
1984 return -EINVAL;
1985 return keyctl_pkey_query((key_serial_t)arg2,
1986 (const char __user *)arg4,
Ben Dooks468e91c2019-03-01 11:30:26 +00001987 (struct keyctl_pkey_query __user *)arg5);
David Howells00d60fd2018-10-09 17:46:59 +01001988
1989 case KEYCTL_PKEY_ENCRYPT:
1990 case KEYCTL_PKEY_DECRYPT:
1991 case KEYCTL_PKEY_SIGN:
1992 return keyctl_pkey_e_d_s(
1993 option,
1994 (const struct keyctl_pkey_params __user *)arg2,
1995 (const char __user *)arg3,
1996 (const void __user *)arg4,
1997 (void __user *)arg5);
1998
1999 case KEYCTL_PKEY_VERIFY:
2000 return keyctl_pkey_verify(
2001 (const struct keyctl_pkey_params __user *)arg2,
2002 (const char __user *)arg3,
2003 (const void __user *)arg4,
2004 (const void __user *)arg5);
2005
David Howellsed0ac5c2019-05-20 21:51:50 +01002006 case KEYCTL_MOVE:
2007 return keyctl_keyring_move((key_serial_t)arg2,
2008 (key_serial_t)arg3,
2009 (key_serial_t)arg4,
2010 (unsigned int)arg5);
2011
David Howells45e0f302019-05-30 14:53:10 +01002012 case KEYCTL_CAPABILITIES:
2013 return keyctl_capabilities((unsigned char __user *)arg2, (size_t)arg3);
2014
David Howellsf7e47672020-01-14 17:07:11 +00002015 case KEYCTL_WATCH_KEY:
2016 return keyctl_watch_key((key_serial_t)arg2, (int)arg3, (int)arg4);
2017
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 default:
2019 return -EOPNOTSUPP;
2020 }
2021}