]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - security/keys/keyctl.c
selinux: KASAN: slab-out-of-bounds in xattr_getsecurity
[mirror_ubuntu-bionic-kernel.git] / security / keys / keyctl.c
CommitLineData
973c9f4f 1/* Userspace key control operations
1da177e4 2 *
3e30148c 3 * Copyright (C) 2004-5 Red Hat, Inc. All Rights Reserved.
1da177e4
LT
4 * Written by David Howells (dhowells@redhat.com)
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 */
11
12#include <linux/module.h>
13#include <linux/init.h>
14#include <linux/sched.h>
29930025 15#include <linux/sched/task.h>
1da177e4
LT
16#include <linux/slab.h>
17#include <linux/syscalls.h>
59e6b9c1 18#include <linux/key.h>
1da177e4
LT
19#include <linux/keyctl.h>
20#include <linux/fs.h>
c59ede7b 21#include <linux/capability.h>
5b825c3a 22#include <linux/cred.h>
0cb409d9 23#include <linux/string.h>
1da177e4 24#include <linux/err.h>
38bbca6b 25#include <linux/vmalloc.h>
70a5bb72 26#include <linux/security.h>
a27bb332 27#include <linux/uio.h>
7c0f6ba6 28#include <linux/uaccess.h>
1da177e4
LT
29#include "internal.h"
30
aa9d4437
DH
31#define KEY_MAX_DESC_SIZE 4096
32
0cb409d9
DA
33static int key_get_type_from_user(char *type,
34 const char __user *_type,
35 unsigned len)
36{
37 int ret;
38
39 ret = strncpy_from_user(type, _type, len);
0cb409d9 40 if (ret < 0)
4303ef19 41 return ret;
0cb409d9
DA
42 if (ret == 0 || ret >= len)
43 return -EINVAL;
54e2c2c1
DH
44 if (type[0] == '.')
45 return -EPERM;
0cb409d9 46 type[len - 1] = '\0';
0cb409d9
DA
47 return 0;
48}
49
1da177e4 50/*
973c9f4f
DH
51 * Extract the description of a new key from userspace and either add it as a
52 * new key to the specified keyring or update a matching key in that keyring.
53 *
cf7f601c
DH
54 * If the description is NULL or an empty string, the key type is asked to
55 * generate one from the payload.
56 *
973c9f4f
DH
57 * The keyring must be writable so that we can attach the key to it.
58 *
59 * If successful, the new key's serial number is returned, otherwise an error
60 * code is returned.
1da177e4 61 */
1e7bfb21
HC
62SYSCALL_DEFINE5(add_key, const char __user *, _type,
63 const char __user *, _description,
64 const void __user *, _payload,
65 size_t, plen,
66 key_serial_t, ringid)
1da177e4 67{
664cceb0 68 key_ref_t keyring_ref, key_ref;
1da177e4
LT
69 char type[32], *description;
70 void *payload;
0cb409d9 71 long ret;
1da177e4
LT
72
73 ret = -EINVAL;
38bbca6b 74 if (plen > 1024 * 1024 - 1)
1da177e4
LT
75 goto error;
76
77 /* draw all the data into kernel space */
0cb409d9 78 ret = key_get_type_from_user(type, _type, sizeof(type));
1da177e4
LT
79 if (ret < 0)
80 goto error;
1da177e4 81
cf7f601c
DH
82 description = NULL;
83 if (_description) {
aa9d4437 84 description = strndup_user(_description, KEY_MAX_DESC_SIZE);
cf7f601c
DH
85 if (IS_ERR(description)) {
86 ret = PTR_ERR(description);
87 goto error;
88 }
89 if (!*description) {
90 kfree(description);
91 description = NULL;
a4e3b8d7
MZ
92 } else if ((description[0] == '.') &&
93 (strncmp(type, "keyring", 7) == 0)) {
94 ret = -EPERM;
95 goto error2;
cf7f601c 96 }
0cb409d9 97 }
1da177e4
LT
98
99 /* pull the payload in if one was supplied */
100 payload = NULL;
101
5649645d 102 if (plen) {
1da177e4 103 ret = -ENOMEM;
752ade68
MH
104 payload = kvmalloc(plen, GFP_KERNEL);
105 if (!payload)
106 goto error2;
1da177e4
LT
107
108 ret = -EFAULT;
109 if (copy_from_user(payload, _payload, plen) != 0)
110 goto error3;
111 }
112
113 /* find the target keyring (which must be writable) */
f5895943 114 keyring_ref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE);
664cceb0
DH
115 if (IS_ERR(keyring_ref)) {
116 ret = PTR_ERR(keyring_ref);
1da177e4
LT
117 goto error3;
118 }
119
120 /* create or update the requested key and add it to the target
121 * keyring */
664cceb0 122 key_ref = key_create_or_update(keyring_ref, type, description,
6b79ccb5
AR
123 payload, plen, KEY_PERM_UNDEF,
124 KEY_ALLOC_IN_QUOTA);
664cceb0
DH
125 if (!IS_ERR(key_ref)) {
126 ret = key_ref_to_ptr(key_ref)->serial;
127 key_ref_put(key_ref);
1da177e4
LT
128 }
129 else {
664cceb0 130 ret = PTR_ERR(key_ref);
1da177e4
LT
131 }
132
664cceb0 133 key_ref_put(keyring_ref);
1da177e4 134 error3:
57070c85
EB
135 if (payload) {
136 memzero_explicit(payload, plen);
137 kvfree(payload);
138 }
1da177e4
LT
139 error2:
140 kfree(description);
141 error:
142 return ret;
a8b17ed0 143}
1da177e4 144
1da177e4 145/*
973c9f4f
DH
146 * Search the process keyrings and keyring trees linked from those for a
147 * matching key. Keyrings must have appropriate Search permission to be
148 * searched.
149 *
150 * If a key is found, it will be attached to the destination keyring if there's
151 * one specified and the serial number of the key will be returned.
152 *
153 * If no key is found, /sbin/request-key will be invoked if _callout_info is
154 * non-NULL in an attempt to create a key. The _callout_info string will be
155 * passed to /sbin/request-key to aid with completing the request. If the
156 * _callout_info string is "" then it will be changed to "-".
1da177e4 157 */
1e7bfb21
HC
158SYSCALL_DEFINE4(request_key, const char __user *, _type,
159 const char __user *, _description,
160 const char __user *, _callout_info,
161 key_serial_t, destringid)
1da177e4
LT
162{
163 struct key_type *ktype;
664cceb0
DH
164 struct key *key;
165 key_ref_t dest_ref;
4a38e122 166 size_t callout_len;
1da177e4 167 char type[32], *description, *callout_info;
0cb409d9 168 long ret;
1da177e4
LT
169
170 /* pull the type into kernel space */
0cb409d9 171 ret = key_get_type_from_user(type, _type, sizeof(type));
1da177e4
LT
172 if (ret < 0)
173 goto error;
1260f801 174
1da177e4 175 /* pull the description into kernel space */
aa9d4437 176 description = strndup_user(_description, KEY_MAX_DESC_SIZE);
0cb409d9
DA
177 if (IS_ERR(description)) {
178 ret = PTR_ERR(description);
1da177e4 179 goto error;
0cb409d9 180 }
1da177e4
LT
181
182 /* pull the callout info into kernel space */
183 callout_info = NULL;
4a38e122 184 callout_len = 0;
1da177e4 185 if (_callout_info) {
0cb409d9
DA
186 callout_info = strndup_user(_callout_info, PAGE_SIZE);
187 if (IS_ERR(callout_info)) {
188 ret = PTR_ERR(callout_info);
1da177e4 189 goto error2;
0cb409d9 190 }
4a38e122 191 callout_len = strlen(callout_info);
1da177e4
LT
192 }
193
194 /* get the destination keyring if specified */
664cceb0 195 dest_ref = NULL;
1da177e4 196 if (destringid) {
5593122e 197 dest_ref = lookup_user_key(destringid, KEY_LOOKUP_CREATE,
f5895943 198 KEY_NEED_WRITE);
664cceb0
DH
199 if (IS_ERR(dest_ref)) {
200 ret = PTR_ERR(dest_ref);
1da177e4
LT
201 goto error3;
202 }
203 }
204
205 /* find the key type */
206 ktype = key_type_lookup(type);
207 if (IS_ERR(ktype)) {
208 ret = PTR_ERR(ktype);
209 goto error4;
210 }
211
212 /* do the search */
4a38e122
DH
213 key = request_key_and_link(ktype, description, callout_info,
214 callout_len, NULL, key_ref_to_ptr(dest_ref),
7e047ef5 215 KEY_ALLOC_IN_QUOTA);
1da177e4
LT
216 if (IS_ERR(key)) {
217 ret = PTR_ERR(key);
218 goto error5;
219 }
220
4aab1e89
DH
221 /* wait for the key to finish being constructed */
222 ret = wait_for_key_construction(key, 1);
223 if (ret < 0)
224 goto error6;
225
1da177e4
LT
226 ret = key->serial;
227
4aab1e89 228error6:
3e30148c 229 key_put(key);
c5b60b5e 230error5:
1da177e4 231 key_type_put(ktype);
c5b60b5e 232error4:
664cceb0 233 key_ref_put(dest_ref);
c5b60b5e 234error3:
1da177e4 235 kfree(callout_info);
c5b60b5e 236error2:
1da177e4 237 kfree(description);
c5b60b5e 238error:
1da177e4 239 return ret;
a8b17ed0 240}
1da177e4 241
1da177e4 242/*
973c9f4f
DH
243 * Get the ID of the specified process keyring.
244 *
245 * The requested keyring must have search permission to be found.
246 *
247 * If successful, the ID of the requested keyring will be returned.
1da177e4
LT
248 */
249long keyctl_get_keyring_ID(key_serial_t id, int create)
250{
664cceb0 251 key_ref_t key_ref;
5593122e 252 unsigned long lflags;
1da177e4
LT
253 long ret;
254
5593122e 255 lflags = create ? KEY_LOOKUP_CREATE : 0;
f5895943 256 key_ref = lookup_user_key(id, lflags, KEY_NEED_SEARCH);
664cceb0
DH
257 if (IS_ERR(key_ref)) {
258 ret = PTR_ERR(key_ref);
1da177e4
LT
259 goto error;
260 }
261
664cceb0
DH
262 ret = key_ref_to_ptr(key_ref)->serial;
263 key_ref_put(key_ref);
c5b60b5e 264error:
1da177e4 265 return ret;
973c9f4f 266}
1da177e4 267
1da177e4 268/*
973c9f4f
DH
269 * Join a (named) session keyring.
270 *
271 * Create and join an anonymous session keyring or join a named session
272 * keyring, creating it if necessary. A named session keyring must have Search
273 * permission for it to be joined. Session keyrings without this permit will
ee8f844e
DH
274 * be skipped over. It is not permitted for userspace to create or join
275 * keyrings whose name begin with a dot.
973c9f4f
DH
276 *
277 * If successful, the ID of the joined session keyring will be returned.
1da177e4
LT
278 */
279long keyctl_join_session_keyring(const char __user *_name)
280{
281 char *name;
0cb409d9 282 long ret;
1da177e4
LT
283
284 /* fetch the name from userspace */
285 name = NULL;
286 if (_name) {
aa9d4437 287 name = strndup_user(_name, KEY_MAX_DESC_SIZE);
0cb409d9
DA
288 if (IS_ERR(name)) {
289 ret = PTR_ERR(name);
1da177e4 290 goto error;
0cb409d9 291 }
ee8f844e
DH
292
293 ret = -EPERM;
294 if (name[0] == '.')
295 goto error_name;
1da177e4
LT
296 }
297
298 /* join the session */
299 ret = join_session_keyring(name);
ee8f844e 300error_name:
0d54ee1c 301 kfree(name);
c5b60b5e 302error:
1da177e4 303 return ret;
a8b17ed0 304}
1da177e4 305
1da177e4 306/*
973c9f4f
DH
307 * Update a key's data payload from the given data.
308 *
309 * The key must grant the caller Write permission and the key type must support
310 * updating for this to work. A negative key can be positively instantiated
311 * with this call.
312 *
313 * If successful, 0 will be returned. If the key type does not support
314 * updating, then -EOPNOTSUPP will be returned.
1da177e4
LT
315 */
316long keyctl_update_key(key_serial_t id,
317 const void __user *_payload,
318 size_t plen)
319{
664cceb0 320 key_ref_t key_ref;
1da177e4
LT
321 void *payload;
322 long ret;
323
324 ret = -EINVAL;
325 if (plen > PAGE_SIZE)
326 goto error;
327
328 /* pull the payload in if one was supplied */
329 payload = NULL;
5649645d 330 if (plen) {
1da177e4
LT
331 ret = -ENOMEM;
332 payload = kmalloc(plen, GFP_KERNEL);
333 if (!payload)
334 goto error;
335
336 ret = -EFAULT;
337 if (copy_from_user(payload, _payload, plen) != 0)
338 goto error2;
339 }
340
341 /* find the target key (which must be writable) */
f5895943 342 key_ref = lookup_user_key(id, 0, KEY_NEED_WRITE);
664cceb0
DH
343 if (IS_ERR(key_ref)) {
344 ret = PTR_ERR(key_ref);
1da177e4
LT
345 goto error2;
346 }
347
348 /* update the key */
664cceb0 349 ret = key_update(key_ref, payload, plen);
1da177e4 350
664cceb0 351 key_ref_put(key_ref);
c5b60b5e 352error2:
57070c85 353 kzfree(payload);
c5b60b5e 354error:
1da177e4 355 return ret;
a8b17ed0 356}
1da177e4 357
1da177e4 358/*
973c9f4f
DH
359 * Revoke a key.
360 *
361 * The key must be grant the caller Write or Setattr permission for this to
362 * work. The key type should give up its quota claim when revoked. The key
363 * and any links to the key will be automatically garbage collected after a
364 * certain amount of time (/proc/sys/kernel/keys/gc_delay).
365 *
d3600bcf
MZ
366 * Keys with KEY_FLAG_KEEP set should not be revoked.
367 *
973c9f4f 368 * If successful, 0 is returned.
1da177e4
LT
369 */
370long keyctl_revoke_key(key_serial_t id)
371{
664cceb0 372 key_ref_t key_ref;
d3600bcf 373 struct key *key;
1da177e4
LT
374 long ret;
375
f5895943 376 key_ref = lookup_user_key(id, 0, KEY_NEED_WRITE);
664cceb0
DH
377 if (IS_ERR(key_ref)) {
378 ret = PTR_ERR(key_ref);
0c2c9a3f
DH
379 if (ret != -EACCES)
380 goto error;
f5895943 381 key_ref = lookup_user_key(id, 0, KEY_NEED_SETATTR);
0c2c9a3f
DH
382 if (IS_ERR(key_ref)) {
383 ret = PTR_ERR(key_ref);
384 goto error;
385 }
1da177e4
LT
386 }
387
d3600bcf 388 key = key_ref_to_ptr(key_ref);
1da177e4 389 ret = 0;
d3600bcf 390 if (test_bit(KEY_FLAG_KEEP, &key->flags))
1d6d167c
MZ
391 ret = -EPERM;
392 else
d3600bcf 393 key_revoke(key);
1da177e4 394
664cceb0 395 key_ref_put(key_ref);
c5b60b5e 396error:
1260f801 397 return ret;
a8b17ed0 398}
1da177e4 399
fd75815f
DH
400/*
401 * Invalidate a key.
402 *
403 * The key must be grant the caller Invalidate permission for this to work.
404 * The key and any links to the key will be automatically garbage collected
405 * immediately.
406 *
d3600bcf
MZ
407 * Keys with KEY_FLAG_KEEP set should not be invalidated.
408 *
fd75815f
DH
409 * If successful, 0 is returned.
410 */
411long keyctl_invalidate_key(key_serial_t id)
412{
413 key_ref_t key_ref;
d3600bcf 414 struct key *key;
fd75815f
DH
415 long ret;
416
417 kenter("%d", id);
418
f5895943 419 key_ref = lookup_user_key(id, 0, KEY_NEED_SEARCH);
fd75815f
DH
420 if (IS_ERR(key_ref)) {
421 ret = PTR_ERR(key_ref);
0c7774ab
DH
422
423 /* Root is permitted to invalidate certain special keys */
424 if (capable(CAP_SYS_ADMIN)) {
425 key_ref = lookup_user_key(id, 0, 0);
426 if (IS_ERR(key_ref))
427 goto error;
428 if (test_bit(KEY_FLAG_ROOT_CAN_INVAL,
429 &key_ref_to_ptr(key_ref)->flags))
430 goto invalidate;
431 goto error_put;
432 }
433
fd75815f
DH
434 goto error;
435 }
436
0c7774ab 437invalidate:
d3600bcf 438 key = key_ref_to_ptr(key_ref);
fd75815f 439 ret = 0;
d3600bcf
MZ
440 if (test_bit(KEY_FLAG_KEEP, &key->flags))
441 ret = -EPERM;
1d6d167c 442 else
d3600bcf 443 key_invalidate(key);
0c7774ab 444error_put:
fd75815f
DH
445 key_ref_put(key_ref);
446error:
447 kleave(" = %ld", ret);
448 return ret;
449}
450
1da177e4 451/*
973c9f4f
DH
452 * Clear the specified keyring, creating an empty process keyring if one of the
453 * special keyring IDs is used.
454 *
d3600bcf
MZ
455 * The keyring must grant the caller Write permission and not have
456 * KEY_FLAG_KEEP set for this to work. If successful, 0 will be returned.
1da177e4
LT
457 */
458long keyctl_keyring_clear(key_serial_t ringid)
459{
664cceb0 460 key_ref_t keyring_ref;
d3600bcf 461 struct key *keyring;
1da177e4
LT
462 long ret;
463
f5895943 464 keyring_ref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE);
664cceb0
DH
465 if (IS_ERR(keyring_ref)) {
466 ret = PTR_ERR(keyring_ref);
700920eb
DH
467
468 /* Root is permitted to invalidate certain special keyrings */
469 if (capable(CAP_SYS_ADMIN)) {
470 keyring_ref = lookup_user_key(ringid, 0, 0);
471 if (IS_ERR(keyring_ref))
472 goto error;
473 if (test_bit(KEY_FLAG_ROOT_CAN_CLEAR,
474 &key_ref_to_ptr(keyring_ref)->flags))
475 goto clear;
476 goto error_put;
477 }
478
1da177e4
LT
479 goto error;
480 }
481
700920eb 482clear:
d3600bcf
MZ
483 keyring = key_ref_to_ptr(keyring_ref);
484 if (test_bit(KEY_FLAG_KEEP, &keyring->flags))
485 ret = -EPERM;
486 else
487 ret = keyring_clear(keyring);
700920eb 488error_put:
664cceb0 489 key_ref_put(keyring_ref);
c5b60b5e 490error:
1da177e4 491 return ret;
a8b17ed0 492}
1da177e4 493
1da177e4 494/*
973c9f4f
DH
495 * Create a link from a keyring to a key if there's no matching key in the
496 * keyring, otherwise replace the link to the matching key with a link to the
497 * new key.
498 *
499 * The key must grant the caller Link permission and the the keyring must grant
500 * the caller Write permission. Furthermore, if an additional link is created,
501 * the keyring's quota will be extended.
502 *
503 * If successful, 0 will be returned.
1da177e4
LT
504 */
505long keyctl_keyring_link(key_serial_t id, key_serial_t ringid)
506{
664cceb0 507 key_ref_t keyring_ref, key_ref;
1da177e4
LT
508 long ret;
509
f5895943 510 keyring_ref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE);
664cceb0
DH
511 if (IS_ERR(keyring_ref)) {
512 ret = PTR_ERR(keyring_ref);
1da177e4
LT
513 goto error;
514 }
515
f5895943 516 key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE, KEY_NEED_LINK);
664cceb0
DH
517 if (IS_ERR(key_ref)) {
518 ret = PTR_ERR(key_ref);
1da177e4
LT
519 goto error2;
520 }
521
664cceb0 522 ret = key_link(key_ref_to_ptr(keyring_ref), key_ref_to_ptr(key_ref));
1da177e4 523
664cceb0 524 key_ref_put(key_ref);
c5b60b5e 525error2:
664cceb0 526 key_ref_put(keyring_ref);
c5b60b5e 527error:
1da177e4 528 return ret;
a8b17ed0 529}
1da177e4 530
1da177e4 531/*
973c9f4f
DH
532 * Unlink a key from a keyring.
533 *
534 * The keyring must grant the caller Write permission for this to work; the key
535 * itself need not grant the caller anything. If the last link to a key is
536 * removed then that key will be scheduled for destruction.
537 *
d3600bcf
MZ
538 * Keys or keyrings with KEY_FLAG_KEEP set should not be unlinked.
539 *
973c9f4f 540 * If successful, 0 will be returned.
1da177e4
LT
541 */
542long keyctl_keyring_unlink(key_serial_t id, key_serial_t ringid)
543{
664cceb0 544 key_ref_t keyring_ref, key_ref;
d3600bcf 545 struct key *keyring, *key;
1da177e4
LT
546 long ret;
547
f5895943 548 keyring_ref = lookup_user_key(ringid, 0, KEY_NEED_WRITE);
664cceb0
DH
549 if (IS_ERR(keyring_ref)) {
550 ret = PTR_ERR(keyring_ref);
1da177e4
LT
551 goto error;
552 }
553
5593122e 554 key_ref = lookup_user_key(id, KEY_LOOKUP_FOR_UNLINK, 0);
664cceb0
DH
555 if (IS_ERR(key_ref)) {
556 ret = PTR_ERR(key_ref);
1da177e4
LT
557 goto error2;
558 }
559
d3600bcf
MZ
560 keyring = key_ref_to_ptr(keyring_ref);
561 key = key_ref_to_ptr(key_ref);
562 if (test_bit(KEY_FLAG_KEEP, &keyring->flags) &&
563 test_bit(KEY_FLAG_KEEP, &key->flags))
564 ret = -EPERM;
565 else
566 ret = key_unlink(keyring, key);
1da177e4 567
664cceb0 568 key_ref_put(key_ref);
c5b60b5e 569error2:
664cceb0 570 key_ref_put(keyring_ref);
c5b60b5e 571error:
1da177e4 572 return ret;
a8b17ed0 573}
1da177e4 574
1da177e4 575/*
973c9f4f
DH
576 * Return a description of a key to userspace.
577 *
578 * The key must grant the caller View permission for this to work.
579 *
580 * If there's a buffer, we place up to buflen bytes of data into it formatted
581 * in the following way:
582 *
1da177e4 583 * type;uid;gid;perm;description<NUL>
973c9f4f
DH
584 *
585 * If successful, we return the amount of description available, irrespective
586 * of how much we may have copied into the buffer.
1da177e4
LT
587 */
588long keyctl_describe_key(key_serial_t keyid,
589 char __user *buffer,
590 size_t buflen)
591{
3e30148c 592 struct key *key, *instkey;
664cceb0 593 key_ref_t key_ref;
aa9d4437 594 char *infobuf;
1da177e4 595 long ret;
aa9d4437 596 int desclen, infolen;
1da177e4 597
f5895943 598 key_ref = lookup_user_key(keyid, KEY_LOOKUP_PARTIAL, KEY_NEED_VIEW);
664cceb0 599 if (IS_ERR(key_ref)) {
3e30148c
DH
600 /* viewing a key under construction is permitted if we have the
601 * authorisation token handy */
664cceb0 602 if (PTR_ERR(key_ref) == -EACCES) {
3e30148c
DH
603 instkey = key_get_instantiation_authkey(keyid);
604 if (!IS_ERR(instkey)) {
605 key_put(instkey);
8bbf4976 606 key_ref = lookup_user_key(keyid,
5593122e
DH
607 KEY_LOOKUP_PARTIAL,
608 0);
664cceb0 609 if (!IS_ERR(key_ref))
3e30148c
DH
610 goto okay;
611 }
612 }
613
664cceb0 614 ret = PTR_ERR(key_ref);
1da177e4
LT
615 goto error;
616 }
617
3e30148c 618okay:
664cceb0 619 key = key_ref_to_ptr(key_ref);
aa9d4437 620 desclen = strlen(key->description);
664cceb0 621
aa9d4437
DH
622 /* calculate how much information we're going to return */
623 ret = -ENOMEM;
624 infobuf = kasprintf(GFP_KERNEL,
625 "%s;%d;%d;%08x;",
626 key->type->name,
627 from_kuid_munged(current_user_ns(), key->uid),
628 from_kgid_munged(current_user_ns(), key->gid),
629 key->perm);
630 if (!infobuf)
631 goto error2;
632 infolen = strlen(infobuf);
633 ret = infolen + desclen + 1;
1da177e4
LT
634
635 /* consider returning the data */
aa9d4437
DH
636 if (buffer && buflen >= ret) {
637 if (copy_to_user(buffer, infobuf, infolen) != 0 ||
638 copy_to_user(buffer + infolen, key->description,
639 desclen + 1) != 0)
1da177e4
LT
640 ret = -EFAULT;
641 }
642
aa9d4437 643 kfree(infobuf);
c5b60b5e 644error2:
664cceb0 645 key_ref_put(key_ref);
c5b60b5e 646error:
1da177e4 647 return ret;
a8b17ed0 648}
1da177e4 649
1da177e4 650/*
973c9f4f
DH
651 * Search the specified keyring and any keyrings it links to for a matching
652 * key. Only keyrings that grant the caller Search permission will be searched
653 * (this includes the starting keyring). Only keys with Search permission can
654 * be found.
655 *
656 * If successful, the found key will be linked to the destination keyring if
657 * supplied and the key has Link permission, and the found key ID will be
658 * returned.
1da177e4
LT
659 */
660long keyctl_keyring_search(key_serial_t ringid,
661 const char __user *_type,
662 const char __user *_description,
663 key_serial_t destringid)
664{
665 struct key_type *ktype;
664cceb0 666 key_ref_t keyring_ref, key_ref, dest_ref;
1da177e4 667 char type[32], *description;
0cb409d9 668 long ret;
1da177e4
LT
669
670 /* pull the type and description into kernel space */
0cb409d9 671 ret = key_get_type_from_user(type, _type, sizeof(type));
1da177e4
LT
672 if (ret < 0)
673 goto error;
1da177e4 674
aa9d4437 675 description = strndup_user(_description, KEY_MAX_DESC_SIZE);
0cb409d9
DA
676 if (IS_ERR(description)) {
677 ret = PTR_ERR(description);
1da177e4 678 goto error;
0cb409d9 679 }
1da177e4
LT
680
681 /* get the keyring at which to begin the search */
f5895943 682 keyring_ref = lookup_user_key(ringid, 0, KEY_NEED_SEARCH);
664cceb0
DH
683 if (IS_ERR(keyring_ref)) {
684 ret = PTR_ERR(keyring_ref);
1da177e4
LT
685 goto error2;
686 }
687
688 /* get the destination keyring if specified */
664cceb0 689 dest_ref = NULL;
1da177e4 690 if (destringid) {
5593122e 691 dest_ref = lookup_user_key(destringid, KEY_LOOKUP_CREATE,
f5895943 692 KEY_NEED_WRITE);
664cceb0
DH
693 if (IS_ERR(dest_ref)) {
694 ret = PTR_ERR(dest_ref);
1da177e4
LT
695 goto error3;
696 }
697 }
698
699 /* find the key type */
700 ktype = key_type_lookup(type);
701 if (IS_ERR(ktype)) {
702 ret = PTR_ERR(ktype);
703 goto error4;
704 }
705
706 /* do the search */
664cceb0
DH
707 key_ref = keyring_search(keyring_ref, ktype, description);
708 if (IS_ERR(key_ref)) {
709 ret = PTR_ERR(key_ref);
1da177e4
LT
710
711 /* treat lack or presence of a negative key the same */
712 if (ret == -EAGAIN)
713 ret = -ENOKEY;
714 goto error5;
715 }
716
717 /* link the resulting key to the destination keyring if we can */
664cceb0 718 if (dest_ref) {
f5895943 719 ret = key_permission(key_ref, KEY_NEED_LINK);
29db9190 720 if (ret < 0)
1da177e4
LT
721 goto error6;
722
664cceb0 723 ret = key_link(key_ref_to_ptr(dest_ref), key_ref_to_ptr(key_ref));
1da177e4
LT
724 if (ret < 0)
725 goto error6;
726 }
727
664cceb0 728 ret = key_ref_to_ptr(key_ref)->serial;
1da177e4 729
c5b60b5e 730error6:
664cceb0 731 key_ref_put(key_ref);
c5b60b5e 732error5:
1da177e4 733 key_type_put(ktype);
c5b60b5e 734error4:
664cceb0 735 key_ref_put(dest_ref);
c5b60b5e 736error3:
664cceb0 737 key_ref_put(keyring_ref);
c5b60b5e 738error2:
1da177e4 739 kfree(description);
c5b60b5e 740error:
1da177e4 741 return ret;
a8b17ed0 742}
1da177e4 743
1da177e4 744/*
973c9f4f
DH
745 * Read a key's payload.
746 *
747 * The key must either grant the caller Read permission, or it must grant the
748 * caller Search permission when searched for from the process keyrings.
749 *
750 * If successful, we place up to buflen bytes of data into the buffer, if one
751 * is provided, and return the amount of data that is available in the key,
752 * irrespective of how much we copied into the buffer.
1da177e4
LT
753 */
754long keyctl_read_key(key_serial_t keyid, char __user *buffer, size_t buflen)
755{
664cceb0
DH
756 struct key *key;
757 key_ref_t key_ref;
1da177e4
LT
758 long ret;
759
760 /* find the key first */
5593122e 761 key_ref = lookup_user_key(keyid, 0, 0);
664cceb0
DH
762 if (IS_ERR(key_ref)) {
763 ret = -ENOKEY;
764 goto error;
1da177e4
LT
765 }
766
664cceb0
DH
767 key = key_ref_to_ptr(key_ref);
768
363b02da
DH
769 ret = key_read_state(key);
770 if (ret < 0)
771 goto error2; /* Negatively instantiated */
37863c43 772
664cceb0 773 /* see if we can read it directly */
f5895943 774 ret = key_permission(key_ref, KEY_NEED_READ);
29db9190 775 if (ret == 0)
664cceb0 776 goto can_read_key;
29db9190 777 if (ret != -EACCES)
7fc0786d 778 goto error2;
664cceb0
DH
779
780 /* we can't; see if it's searchable from this process's keyrings
781 * - we automatically take account of the fact that it may be
782 * dangling off an instantiation key
783 */
784 if (!is_key_possessed(key_ref)) {
785 ret = -EACCES;
786 goto error2;
787 }
1da177e4
LT
788
789 /* the key is probably readable - now try to read it */
c5b60b5e 790can_read_key:
b4a1b4f5
DH
791 ret = -EOPNOTSUPP;
792 if (key->type->read) {
793 /* Read the data with the semaphore held (since we might sleep)
794 * to protect against the key being updated or revoked.
795 */
796 down_read(&key->sem);
797 ret = key_validate(key);
798 if (ret == 0)
1da177e4 799 ret = key->type->read(key, buffer, buflen);
b4a1b4f5 800 up_read(&key->sem);
1da177e4
LT
801 }
802
c5b60b5e 803error2:
1da177e4 804 key_put(key);
c5b60b5e 805error:
1da177e4 806 return ret;
a8b17ed0 807}
1da177e4 808
1da177e4 809/*
973c9f4f
DH
810 * Change the ownership of a key
811 *
812 * The key must grant the caller Setattr permission for this to work, though
813 * the key need not be fully instantiated yet. For the UID to be changed, or
814 * for the GID to be changed to a group the caller is not a member of, the
815 * caller must have sysadmin capability. If either uid or gid is -1 then that
816 * attribute is not changed.
817 *
818 * If the UID is to be changed, the new user must have sufficient quota to
819 * accept the key. The quota deduction will be removed from the old user to
820 * the new user should the attribute be changed.
821 *
822 * If successful, 0 will be returned.
1da177e4 823 */
9a56c2db 824long keyctl_chown_key(key_serial_t id, uid_t user, gid_t group)
1da177e4 825{
5801649d 826 struct key_user *newowner, *zapowner = NULL;
1da177e4 827 struct key *key;
664cceb0 828 key_ref_t key_ref;
1da177e4 829 long ret;
9a56c2db
EB
830 kuid_t uid;
831 kgid_t gid;
832
833 uid = make_kuid(current_user_ns(), user);
834 gid = make_kgid(current_user_ns(), group);
835 ret = -EINVAL;
836 if ((user != (uid_t) -1) && !uid_valid(uid))
837 goto error;
838 if ((group != (gid_t) -1) && !gid_valid(gid))
839 goto error;
1da177e4
LT
840
841 ret = 0;
9a56c2db 842 if (user == (uid_t) -1 && group == (gid_t) -1)
1da177e4
LT
843 goto error;
844
5593122e 845 key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE | KEY_LOOKUP_PARTIAL,
f5895943 846 KEY_NEED_SETATTR);
664cceb0
DH
847 if (IS_ERR(key_ref)) {
848 ret = PTR_ERR(key_ref);
1da177e4
LT
849 goto error;
850 }
851
664cceb0
DH
852 key = key_ref_to_ptr(key_ref);
853
1da177e4
LT
854 /* make the changes with the locks held to prevent chown/chown races */
855 ret = -EACCES;
856 down_write(&key->sem);
1da177e4
LT
857
858 if (!capable(CAP_SYS_ADMIN)) {
859 /* only the sysadmin can chown a key to some other UID */
9a56c2db 860 if (user != (uid_t) -1 && !uid_eq(key->uid, uid))
5801649d 861 goto error_put;
1da177e4
LT
862
863 /* only the sysadmin can set the key's GID to a group other
864 * than one of those that the current process subscribes to */
9a56c2db 865 if (group != (gid_t) -1 && !gid_eq(gid, key->gid) && !in_group_p(gid))
5801649d 866 goto error_put;
1da177e4
LT
867 }
868
5801649d 869 /* change the UID */
9a56c2db 870 if (user != (uid_t) -1 && !uid_eq(uid, key->uid)) {
5801649d 871 ret = -ENOMEM;
9a56c2db 872 newowner = key_user_lookup(uid);
5801649d
FT
873 if (!newowner)
874 goto error_put;
875
876 /* transfer the quota burden to the new user */
877 if (test_bit(KEY_FLAG_IN_QUOTA, &key->flags)) {
9a56c2db 878 unsigned maxkeys = uid_eq(uid, GLOBAL_ROOT_UID) ?
0b77f5bf 879 key_quota_root_maxkeys : key_quota_maxkeys;
9a56c2db 880 unsigned maxbytes = uid_eq(uid, GLOBAL_ROOT_UID) ?
0b77f5bf
DH
881 key_quota_root_maxbytes : key_quota_maxbytes;
882
5801649d 883 spin_lock(&newowner->lock);
0b77f5bf
DH
884 if (newowner->qnkeys + 1 >= maxkeys ||
885 newowner->qnbytes + key->quotalen >= maxbytes ||
886 newowner->qnbytes + key->quotalen <
887 newowner->qnbytes)
5801649d
FT
888 goto quota_overrun;
889
890 newowner->qnkeys++;
891 newowner->qnbytes += key->quotalen;
892 spin_unlock(&newowner->lock);
893
894 spin_lock(&key->user->lock);
895 key->user->qnkeys--;
896 key->user->qnbytes -= key->quotalen;
897 spin_unlock(&key->user->lock);
898 }
899
900 atomic_dec(&key->user->nkeys);
901 atomic_inc(&newowner->nkeys);
902
363b02da 903 if (key->state != KEY_IS_UNINSTANTIATED) {
5801649d
FT
904 atomic_dec(&key->user->nikeys);
905 atomic_inc(&newowner->nikeys);
906 }
907
908 zapowner = key->user;
909 key->user = newowner;
910 key->uid = uid;
1da177e4
LT
911 }
912
913 /* change the GID */
9a56c2db 914 if (group != (gid_t) -1)
1da177e4
LT
915 key->gid = gid;
916
917 ret = 0;
918
5801649d 919error_put:
1da177e4
LT
920 up_write(&key->sem);
921 key_put(key);
5801649d
FT
922 if (zapowner)
923 key_user_put(zapowner);
924error:
1da177e4
LT
925 return ret;
926
5801649d
FT
927quota_overrun:
928 spin_unlock(&newowner->lock);
929 zapowner = newowner;
930 ret = -EDQUOT;
931 goto error_put;
a8b17ed0 932}
5801649d 933
1da177e4 934/*
973c9f4f
DH
935 * Change the permission mask on 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. If the caller does not have
939 * sysadmin capability, it may only change the permission on keys that it owns.
1da177e4
LT
940 */
941long keyctl_setperm_key(key_serial_t id, key_perm_t perm)
942{
943 struct key *key;
664cceb0 944 key_ref_t key_ref;
1da177e4
LT
945 long ret;
946
947 ret = -EINVAL;
664cceb0 948 if (perm & ~(KEY_POS_ALL | KEY_USR_ALL | KEY_GRP_ALL | KEY_OTH_ALL))
1da177e4
LT
949 goto error;
950
5593122e 951 key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE | KEY_LOOKUP_PARTIAL,
f5895943 952 KEY_NEED_SETATTR);
664cceb0
DH
953 if (IS_ERR(key_ref)) {
954 ret = PTR_ERR(key_ref);
1da177e4
LT
955 goto error;
956 }
957
664cceb0
DH
958 key = key_ref_to_ptr(key_ref);
959
76d8aeab 960 /* make the changes with the locks held to prevent chown/chmod races */
1da177e4
LT
961 ret = -EACCES;
962 down_write(&key->sem);
1da177e4 963
76d8aeab 964 /* if we're not the sysadmin, we can only change a key that we own */
9a56c2db 965 if (capable(CAP_SYS_ADMIN) || uid_eq(key->uid, current_fsuid())) {
76d8aeab
DH
966 key->perm = perm;
967 ret = 0;
968 }
1da177e4 969
1da177e4
LT
970 up_write(&key->sem);
971 key_put(key);
76d8aeab 972error:
1da177e4 973 return ret;
a8b17ed0 974}
1da177e4 975
8bbf4976 976/*
973c9f4f
DH
977 * Get the destination keyring for instantiation and check that the caller has
978 * Write permission on it.
8bbf4976
DH
979 */
980static long get_instantiation_keyring(key_serial_t ringid,
981 struct request_key_auth *rka,
982 struct key **_dest_keyring)
983{
984 key_ref_t dkref;
985
eca1bf5b
DH
986 *_dest_keyring = NULL;
987
8bbf4976 988 /* just return a NULL pointer if we weren't asked to make a link */
eca1bf5b 989 if (ringid == 0)
8bbf4976 990 return 0;
8bbf4976
DH
991
992 /* if a specific keyring is nominated by ID, then use that */
993 if (ringid > 0) {
f5895943 994 dkref = lookup_user_key(ringid, KEY_LOOKUP_CREATE, KEY_NEED_WRITE);
8bbf4976
DH
995 if (IS_ERR(dkref))
996 return PTR_ERR(dkref);
997 *_dest_keyring = key_ref_to_ptr(dkref);
998 return 0;
999 }
1000
1001 if (ringid == KEY_SPEC_REQKEY_AUTH_KEY)
1002 return -EINVAL;
1003
1004 /* otherwise specify the destination keyring recorded in the
1005 * authorisation key (any KEY_SPEC_*_KEYRING) */
1006 if (ringid >= KEY_SPEC_REQUESTOR_KEYRING) {
21279cfa 1007 *_dest_keyring = key_get(rka->dest_keyring);
8bbf4976
DH
1008 return 0;
1009 }
1010
1011 return -ENOKEY;
1012}
1013
d84f4f99 1014/*
973c9f4f 1015 * Change the request_key authorisation key on the current process.
d84f4f99
DH
1016 */
1017static int keyctl_change_reqkey_auth(struct key *key)
1018{
1019 struct cred *new;
1020
1021 new = prepare_creds();
1022 if (!new)
1023 return -ENOMEM;
1024
1025 key_put(new->request_key_auth);
1026 new->request_key_auth = key_get(key);
1027
1028 return commit_creds(new);
1029}
1030
1da177e4 1031/*
973c9f4f
DH
1032 * Instantiate a key with the specified payload and link the key into the
1033 * destination keyring if one is given.
1034 *
1035 * The caller must have the appropriate instantiation permit set for this to
1036 * work (see keyctl_assume_authority). No other permissions are required.
1037 *
1038 * If successful, 0 will be returned.
1da177e4 1039 */
ee009e4a 1040long keyctl_instantiate_key_common(key_serial_t id,
b353a1f7 1041 struct iov_iter *from,
ee009e4a 1042 key_serial_t ringid)
1da177e4 1043{
d84f4f99 1044 const struct cred *cred = current_cred();
3e30148c 1045 struct request_key_auth *rka;
8bbf4976 1046 struct key *instkey, *dest_keyring;
b353a1f7 1047 size_t plen = from ? iov_iter_count(from) : 0;
1da177e4
LT
1048 void *payload;
1049 long ret;
1050
d84f4f99
DH
1051 kenter("%d,,%zu,%d", id, plen, ringid);
1052
b353a1f7
AV
1053 if (!plen)
1054 from = NULL;
1055
1da177e4 1056 ret = -EINVAL;
38bbca6b 1057 if (plen > 1024 * 1024 - 1)
1da177e4
LT
1058 goto error;
1059
b5f545c8
DH
1060 /* the appropriate instantiation authorisation key must have been
1061 * assumed before calling this */
1062 ret = -EPERM;
d84f4f99 1063 instkey = cred->request_key_auth;
b5f545c8
DH
1064 if (!instkey)
1065 goto error;
1066
146aa8b1 1067 rka = instkey->payload.data[0];
b5f545c8
DH
1068 if (rka->target_key->serial != id)
1069 goto error;
1070
1da177e4
LT
1071 /* pull the payload in if one was supplied */
1072 payload = NULL;
1073
b353a1f7 1074 if (from) {
1da177e4 1075 ret = -ENOMEM;
752ade68
MH
1076 payload = kvmalloc(plen, GFP_KERNEL);
1077 if (!payload)
1078 goto error;
1da177e4 1079
b353a1f7 1080 ret = -EFAULT;
cbbd26b8 1081 if (!copy_from_iter_full(payload, plen, from))
1da177e4
LT
1082 goto error2;
1083 }
1084
3e30148c
DH
1085 /* find the destination keyring amongst those belonging to the
1086 * requesting task */
8bbf4976
DH
1087 ret = get_instantiation_keyring(ringid, rka, &dest_keyring);
1088 if (ret < 0)
1089 goto error2;
1da177e4
LT
1090
1091 /* instantiate the key and link it into a keyring */
3e30148c 1092 ret = key_instantiate_and_link(rka->target_key, payload, plen,
8bbf4976 1093 dest_keyring, instkey);
1da177e4 1094
8bbf4976 1095 key_put(dest_keyring);
b5f545c8
DH
1096
1097 /* discard the assumed authority if it's just been disabled by
1098 * instantiation of the key */
d84f4f99
DH
1099 if (ret == 0)
1100 keyctl_change_reqkey_auth(NULL);
b5f545c8
DH
1101
1102error2:
57070c85
EB
1103 if (payload) {
1104 memzero_explicit(payload, plen);
1105 kvfree(payload);
1106 }
b5f545c8 1107error:
1da177e4 1108 return ret;
a8b17ed0 1109}
1da177e4 1110
ee009e4a
DH
1111/*
1112 * Instantiate a key with the specified payload and link the key into the
1113 * destination keyring if one is given.
1114 *
1115 * The caller must have the appropriate instantiation permit set for this to
1116 * work (see keyctl_assume_authority). No other permissions are required.
1117 *
1118 * If successful, 0 will be returned.
1119 */
1120long keyctl_instantiate_key(key_serial_t id,
1121 const void __user *_payload,
1122 size_t plen,
1123 key_serial_t ringid)
1124{
1125 if (_payload && plen) {
b353a1f7
AV
1126 struct iovec iov;
1127 struct iov_iter from;
1128 int ret;
ee009e4a 1129
b353a1f7
AV
1130 ret = import_single_range(WRITE, (void __user *)_payload, plen,
1131 &iov, &from);
1132 if (unlikely(ret))
1133 return ret;
1134
1135 return keyctl_instantiate_key_common(id, &from, ringid);
ee009e4a
DH
1136 }
1137
b353a1f7 1138 return keyctl_instantiate_key_common(id, NULL, ringid);
ee009e4a
DH
1139}
1140
1141/*
1142 * Instantiate a key with the specified multipart payload and link the key into
1143 * the destination keyring if one is given.
1144 *
1145 * The caller must have the appropriate instantiation permit set for this to
1146 * work (see keyctl_assume_authority). No other permissions are required.
1147 *
1148 * If successful, 0 will be returned.
1149 */
1150long keyctl_instantiate_key_iov(key_serial_t id,
1151 const struct iovec __user *_payload_iov,
1152 unsigned ioc,
1153 key_serial_t ringid)
1154{
1155 struct iovec iovstack[UIO_FASTIOV], *iov = iovstack;
b353a1f7 1156 struct iov_iter from;
ee009e4a
DH
1157 long ret;
1158
b353a1f7
AV
1159 if (!_payload_iov)
1160 ioc = 0;
ee009e4a 1161
b353a1f7
AV
1162 ret = import_iovec(WRITE, _payload_iov, ioc,
1163 ARRAY_SIZE(iovstack), &iov, &from);
ee009e4a 1164 if (ret < 0)
b353a1f7
AV
1165 return ret;
1166 ret = keyctl_instantiate_key_common(id, &from, ringid);
1167 kfree(iov);
ee009e4a 1168 return ret;
ee009e4a
DH
1169}
1170
1da177e4 1171/*
973c9f4f
DH
1172 * Negatively instantiate the key with the given timeout (in seconds) and link
1173 * the key into the destination keyring if one is given.
1174 *
1175 * The caller must have the appropriate instantiation permit set for this to
1176 * work (see keyctl_assume_authority). No other permissions are required.
1177 *
1178 * The key and any links to the key will be automatically garbage collected
1179 * after the timeout expires.
1180 *
1181 * Negative keys are used to rate limit repeated request_key() calls by causing
1182 * them to return -ENOKEY until the negative key expires.
1183 *
1184 * If successful, 0 will be returned.
1da177e4
LT
1185 */
1186long keyctl_negate_key(key_serial_t id, unsigned timeout, key_serial_t ringid)
fdd1b945
DH
1187{
1188 return keyctl_reject_key(id, timeout, ENOKEY, ringid);
1189}
1190
1191/*
1192 * Negatively instantiate the key with the given timeout (in seconds) and error
1193 * code and link the key into the destination keyring if one is given.
1194 *
1195 * The caller must have the appropriate instantiation permit set for this to
1196 * work (see keyctl_assume_authority). No other permissions are required.
1197 *
1198 * The key and any links to the key will be automatically garbage collected
1199 * after the timeout expires.
1200 *
1201 * Negative keys are used to rate limit repeated request_key() calls by causing
1202 * them to return the specified error code until the negative key expires.
1203 *
1204 * If successful, 0 will be returned.
1205 */
1206long keyctl_reject_key(key_serial_t id, unsigned timeout, unsigned error,
1207 key_serial_t ringid)
1da177e4 1208{
d84f4f99 1209 const struct cred *cred = current_cred();
3e30148c 1210 struct request_key_auth *rka;
8bbf4976 1211 struct key *instkey, *dest_keyring;
1da177e4
LT
1212 long ret;
1213
fdd1b945
DH
1214 kenter("%d,%u,%u,%d", id, timeout, error, ringid);
1215
1216 /* must be a valid error code and mustn't be a kernel special */
1217 if (error <= 0 ||
1218 error >= MAX_ERRNO ||
1219 error == ERESTARTSYS ||
1220 error == ERESTARTNOINTR ||
1221 error == ERESTARTNOHAND ||
1222 error == ERESTART_RESTARTBLOCK)
1223 return -EINVAL;
d84f4f99 1224
b5f545c8
DH
1225 /* the appropriate instantiation authorisation key must have been
1226 * assumed before calling this */
1227 ret = -EPERM;
d84f4f99 1228 instkey = cred->request_key_auth;
b5f545c8 1229 if (!instkey)
1da177e4 1230 goto error;
1da177e4 1231
146aa8b1 1232 rka = instkey->payload.data[0];
b5f545c8
DH
1233 if (rka->target_key->serial != id)
1234 goto error;
3e30148c 1235
1da177e4
LT
1236 /* find the destination keyring if present (which must also be
1237 * writable) */
8bbf4976
DH
1238 ret = get_instantiation_keyring(ringid, rka, &dest_keyring);
1239 if (ret < 0)
1240 goto error;
1da177e4
LT
1241
1242 /* instantiate the key and link it into a keyring */
fdd1b945 1243 ret = key_reject_and_link(rka->target_key, timeout, error,
8bbf4976 1244 dest_keyring, instkey);
1da177e4 1245
8bbf4976 1246 key_put(dest_keyring);
b5f545c8
DH
1247
1248 /* discard the assumed authority if it's just been disabled by
1249 * instantiation of the key */
d84f4f99
DH
1250 if (ret == 0)
1251 keyctl_change_reqkey_auth(NULL);
b5f545c8
DH
1252
1253error:
1da177e4 1254 return ret;
a8b17ed0 1255}
1da177e4 1256
3e30148c 1257/*
973c9f4f
DH
1258 * Read or set the default keyring in which request_key() will cache keys and
1259 * return the old setting.
1260 *
c9f838d1
EB
1261 * If a thread or process keyring is specified then it will be created if it
1262 * doesn't yet exist. The old setting will be returned if successful.
3e30148c
DH
1263 */
1264long keyctl_set_reqkey_keyring(int reqkey_defl)
1265{
d84f4f99
DH
1266 struct cred *new;
1267 int ret, old_setting;
1268
1269 old_setting = current_cred_xxx(jit_keyring);
1270
1271 if (reqkey_defl == KEY_REQKEY_DEFL_NO_CHANGE)
1272 return old_setting;
1273
1274 new = prepare_creds();
1275 if (!new)
1276 return -ENOMEM;
3e30148c
DH
1277
1278 switch (reqkey_defl) {
1279 case KEY_REQKEY_DEFL_THREAD_KEYRING:
d84f4f99 1280 ret = install_thread_keyring_to_cred(new);
3e30148c 1281 if (ret < 0)
d84f4f99 1282 goto error;
3e30148c
DH
1283 goto set;
1284
1285 case KEY_REQKEY_DEFL_PROCESS_KEYRING:
d84f4f99 1286 ret = install_process_keyring_to_cred(new);
c9f838d1
EB
1287 if (ret < 0)
1288 goto error;
d84f4f99 1289 goto set;
3e30148c
DH
1290
1291 case KEY_REQKEY_DEFL_DEFAULT:
1292 case KEY_REQKEY_DEFL_SESSION_KEYRING:
1293 case KEY_REQKEY_DEFL_USER_KEYRING:
1294 case KEY_REQKEY_DEFL_USER_SESSION_KEYRING:
d84f4f99
DH
1295 case KEY_REQKEY_DEFL_REQUESTOR_KEYRING:
1296 goto set;
3e30148c
DH
1297
1298 case KEY_REQKEY_DEFL_NO_CHANGE:
3e30148c
DH
1299 case KEY_REQKEY_DEFL_GROUP_KEYRING:
1300 default:
d84f4f99
DH
1301 ret = -EINVAL;
1302 goto error;
3e30148c
DH
1303 }
1304
d84f4f99
DH
1305set:
1306 new->jit_keyring = reqkey_defl;
1307 commit_creds(new);
1308 return old_setting;
1309error:
1310 abort_creds(new);
4303ef19 1311 return ret;
a8b17ed0 1312}
d84f4f99 1313
017679c4 1314/*
973c9f4f
DH
1315 * Set or clear the timeout on a key.
1316 *
1317 * Either the key must grant the caller Setattr permission or else the caller
1318 * must hold an instantiation authorisation token for the key.
1319 *
1320 * The timeout is either 0 to clear the timeout, or a number of seconds from
1321 * the current time. The key and any links to the key will be automatically
1322 * garbage collected after the timeout expires.
1323 *
d3600bcf
MZ
1324 * Keys with KEY_FLAG_KEEP set should not be timed out.
1325 *
973c9f4f 1326 * If successful, 0 is returned.
017679c4
DH
1327 */
1328long keyctl_set_timeout(key_serial_t id, unsigned timeout)
1329{
9156235b 1330 struct key *key, *instkey;
017679c4 1331 key_ref_t key_ref;
017679c4
DH
1332 long ret;
1333
5593122e 1334 key_ref = lookup_user_key(id, KEY_LOOKUP_CREATE | KEY_LOOKUP_PARTIAL,
f5895943 1335 KEY_NEED_SETATTR);
017679c4 1336 if (IS_ERR(key_ref)) {
9156235b
DH
1337 /* setting the timeout on a key under construction is permitted
1338 * if we have the authorisation token handy */
1339 if (PTR_ERR(key_ref) == -EACCES) {
1340 instkey = key_get_instantiation_authkey(id);
1341 if (!IS_ERR(instkey)) {
1342 key_put(instkey);
1343 key_ref = lookup_user_key(id,
1344 KEY_LOOKUP_PARTIAL,
1345 0);
1346 if (!IS_ERR(key_ref))
1347 goto okay;
1348 }
1349 }
1350
017679c4
DH
1351 ret = PTR_ERR(key_ref);
1352 goto error;
1353 }
1354
9156235b 1355okay:
017679c4 1356 key = key_ref_to_ptr(key_ref);
1d6d167c 1357 ret = 0;
d3600bcf
MZ
1358 if (test_bit(KEY_FLAG_KEEP, &key->flags))
1359 ret = -EPERM;
1d6d167c 1360 else
d3600bcf 1361 key_set_timeout(key, timeout);
017679c4
DH
1362 key_put(key);
1363
017679c4
DH
1364error:
1365 return ret;
a8b17ed0 1366}
017679c4 1367
b5f545c8 1368/*
973c9f4f
DH
1369 * Assume (or clear) the authority to instantiate the specified key.
1370 *
1371 * This sets the authoritative token currently in force for key instantiation.
1372 * This must be done for a key to be instantiated. It has the effect of making
1373 * available all the keys from the caller of the request_key() that created a
1374 * key to request_key() calls made by the caller of this function.
1375 *
1376 * The caller must have the instantiation key in their process keyrings with a
1377 * Search permission grant available to the caller.
1378 *
1379 * If the ID given is 0, then the setting will be cleared and 0 returned.
1380 *
1381 * If the ID given has a matching an authorisation key, then that key will be
1382 * set and its ID will be returned. The authorisation key can be read to get
1383 * the callout information passed to request_key().
b5f545c8
DH
1384 */
1385long keyctl_assume_authority(key_serial_t id)
1386{
1387 struct key *authkey;
1388 long ret;
1389
1390 /* special key IDs aren't permitted */
1391 ret = -EINVAL;
1392 if (id < 0)
1393 goto error;
1394
1395 /* we divest ourselves of authority if given an ID of 0 */
1396 if (id == 0) {
d84f4f99 1397 ret = keyctl_change_reqkey_auth(NULL);
b5f545c8
DH
1398 goto error;
1399 }
1400
1401 /* attempt to assume the authority temporarily granted to us whilst we
1402 * instantiate the specified key
1403 * - the authorisation key must be in the current task's keyrings
1404 * somewhere
1405 */
1406 authkey = key_get_instantiation_authkey(id);
1407 if (IS_ERR(authkey)) {
1408 ret = PTR_ERR(authkey);
1409 goto error;
1410 }
1411
d84f4f99 1412 ret = keyctl_change_reqkey_auth(authkey);
884bee02
EB
1413 if (ret == 0)
1414 ret = authkey->serial;
d84f4f99 1415 key_put(authkey);
b5f545c8
DH
1416error:
1417 return ret;
a8b17ed0 1418}
b5f545c8 1419
70a5bb72 1420/*
973c9f4f
DH
1421 * Get a key's the LSM security label.
1422 *
1423 * The key must grant the caller View permission for this to work.
1424 *
1425 * If there's a buffer, then up to buflen bytes of data will be placed into it.
1426 *
1427 * If successful, the amount of information available will be returned,
1428 * irrespective of how much was copied (including the terminal NUL).
70a5bb72
DH
1429 */
1430long keyctl_get_security(key_serial_t keyid,
1431 char __user *buffer,
1432 size_t buflen)
1433{
1434 struct key *key, *instkey;
1435 key_ref_t key_ref;
1436 char *context;
1437 long ret;
1438
f5895943 1439 key_ref = lookup_user_key(keyid, KEY_LOOKUP_PARTIAL, KEY_NEED_VIEW);
70a5bb72
DH
1440 if (IS_ERR(key_ref)) {
1441 if (PTR_ERR(key_ref) != -EACCES)
1442 return PTR_ERR(key_ref);
1443
1444 /* viewing a key under construction is also permitted if we
1445 * have the authorisation token handy */
1446 instkey = key_get_instantiation_authkey(keyid);
1447 if (IS_ERR(instkey))
fa1cc7b5 1448 return PTR_ERR(instkey);
70a5bb72
DH
1449 key_put(instkey);
1450
5593122e 1451 key_ref = lookup_user_key(keyid, KEY_LOOKUP_PARTIAL, 0);
70a5bb72
DH
1452 if (IS_ERR(key_ref))
1453 return PTR_ERR(key_ref);
1454 }
1455
1456 key = key_ref_to_ptr(key_ref);
1457 ret = security_key_getsecurity(key, &context);
1458 if (ret == 0) {
1459 /* if no information was returned, give userspace an empty
1460 * string */
1461 ret = 1;
1462 if (buffer && buflen > 0 &&
1463 copy_to_user(buffer, "", 1) != 0)
1464 ret = -EFAULT;
1465 } else if (ret > 0) {
1466 /* return as much data as there's room for */
1467 if (buffer && buflen > 0) {
1468 if (buflen > ret)
1469 buflen = ret;
1470
1471 if (copy_to_user(buffer, context, buflen) != 0)
1472 ret = -EFAULT;
1473 }
1474
1475 kfree(context);
1476 }
1477
1478 key_ref_put(key_ref);
1479 return ret;
1480}
1481
ee18d64c 1482/*
973c9f4f
DH
1483 * Attempt to install the calling process's session keyring on the process's
1484 * parent process.
1485 *
1486 * The keyring must exist and must grant the caller LINK permission, and the
1487 * parent process must be single-threaded and must have the same effective
1488 * ownership as this process and mustn't be SUID/SGID.
1489 *
1490 * The keyring will be emplaced on the parent when it next resumes userspace.
1491 *
1492 * If successful, 0 will be returned.
ee18d64c
DH
1493 */
1494long keyctl_session_to_parent(void)
1495{
1496 struct task_struct *me, *parent;
1497 const struct cred *mycred, *pcred;
67d12145 1498 struct callback_head *newwork, *oldwork;
ee18d64c 1499 key_ref_t keyring_r;
413cd3d9 1500 struct cred *cred;
ee18d64c
DH
1501 int ret;
1502
f5895943 1503 keyring_r = lookup_user_key(KEY_SPEC_SESSION_KEYRING, 0, KEY_NEED_LINK);
ee18d64c
DH
1504 if (IS_ERR(keyring_r))
1505 return PTR_ERR(keyring_r);
1506
413cd3d9 1507 ret = -ENOMEM;
413cd3d9 1508
ee18d64c
DH
1509 /* our parent is going to need a new cred struct, a new tgcred struct
1510 * and new security data, so we allocate them here to prevent ENOMEM in
1511 * our parent */
ee18d64c
DH
1512 cred = cred_alloc_blank();
1513 if (!cred)
67d12145
AV
1514 goto error_keyring;
1515 newwork = &cred->rcu;
ee18d64c 1516
3a50597d
DH
1517 cred->session_keyring = key_ref_to_ptr(keyring_r);
1518 keyring_r = NULL;
67d12145 1519 init_task_work(newwork, key_change_session_keyring);
ee18d64c
DH
1520
1521 me = current;
9d1ac65a 1522 rcu_read_lock();
ee18d64c
DH
1523 write_lock_irq(&tasklist_lock);
1524
ee18d64c 1525 ret = -EPERM;
413cd3d9
ON
1526 oldwork = NULL;
1527 parent = me->real_parent;
ee18d64c
DH
1528
1529 /* the parent mustn't be init and mustn't be a kernel thread */
1530 if (parent->pid <= 1 || !parent->mm)
413cd3d9 1531 goto unlock;
ee18d64c
DH
1532
1533 /* the parent must be single threaded */
dd98acf7 1534 if (!thread_group_empty(parent))
413cd3d9 1535 goto unlock;
ee18d64c
DH
1536
1537 /* the parent and the child must have different session keyrings or
1538 * there's no point */
1539 mycred = current_cred();
1540 pcred = __task_cred(parent);
1541 if (mycred == pcred ||
3a50597d 1542 mycred->session_keyring == pcred->session_keyring) {
413cd3d9
ON
1543 ret = 0;
1544 goto unlock;
1545 }
ee18d64c
DH
1546
1547 /* the parent must have the same effective ownership and mustn't be
1548 * SUID/SGID */
9a56c2db
EB
1549 if (!uid_eq(pcred->uid, mycred->euid) ||
1550 !uid_eq(pcred->euid, mycred->euid) ||
1551 !uid_eq(pcred->suid, mycred->euid) ||
1552 !gid_eq(pcred->gid, mycred->egid) ||
1553 !gid_eq(pcred->egid, mycred->egid) ||
1554 !gid_eq(pcred->sgid, mycred->egid))
413cd3d9 1555 goto unlock;
ee18d64c
DH
1556
1557 /* the keyrings must have the same UID */
3a50597d 1558 if ((pcred->session_keyring &&
2a74dbb9
LT
1559 !uid_eq(pcred->session_keyring->uid, mycred->euid)) ||
1560 !uid_eq(mycred->session_keyring->uid, mycred->euid))
413cd3d9 1561 goto unlock;
ee18d64c 1562
413cd3d9
ON
1563 /* cancel an already pending keyring replacement */
1564 oldwork = task_work_cancel(parent, key_change_session_keyring);
ee18d64c
DH
1565
1566 /* the replacement session keyring is applied just prior to userspace
1567 * restarting */
67d12145 1568 ret = task_work_add(parent, newwork, true);
413cd3d9
ON
1569 if (!ret)
1570 newwork = NULL;
1571unlock:
ee18d64c 1572 write_unlock_irq(&tasklist_lock);
9d1ac65a 1573 rcu_read_unlock();
67d12145
AV
1574 if (oldwork)
1575 put_cred(container_of(oldwork, struct cred, rcu));
1576 if (newwork)
1577 put_cred(cred);
ee18d64c
DH
1578 return ret;
1579
1580error_keyring:
1581 key_ref_put(keyring_r);
1582 return ret;
1583}
1584
6563c91f
MM
1585/*
1586 * Apply a restriction to a given keyring.
1587 *
1588 * The caller must have Setattr permission to change keyring restrictions.
1589 *
1590 * The requested type name may be a NULL pointer to reject all attempts
18026d86
EB
1591 * to link to the keyring. In this case, _restriction must also be NULL.
1592 * Otherwise, both _type and _restriction must be non-NULL.
6563c91f
MM
1593 *
1594 * Returns 0 if successful.
1595 */
1596long keyctl_restrict_keyring(key_serial_t id, const char __user *_type,
1597 const char __user *_restriction)
1598{
1599 key_ref_t key_ref;
6563c91f
MM
1600 char type[32];
1601 char *restriction = NULL;
1602 long ret;
1603
1604 key_ref = lookup_user_key(id, 0, KEY_NEED_SETATTR);
1605 if (IS_ERR(key_ref))
1606 return PTR_ERR(key_ref);
1607
18026d86 1608 ret = -EINVAL;
6563c91f 1609 if (_type) {
18026d86 1610 if (!_restriction)
6563c91f 1611 goto error;
6563c91f 1612
18026d86
EB
1613 ret = key_get_type_from_user(type, _type, sizeof(type));
1614 if (ret < 0)
6563c91f 1615 goto error;
6563c91f
MM
1616
1617 restriction = strndup_user(_restriction, PAGE_SIZE);
1618 if (IS_ERR(restriction)) {
1619 ret = PTR_ERR(restriction);
1620 goto error;
1621 }
18026d86
EB
1622 } else {
1623 if (_restriction)
1624 goto error;
6563c91f
MM
1625 }
1626
18026d86 1627 ret = keyring_restrict(key_ref, _type ? type : NULL, restriction);
6563c91f 1628 kfree(restriction);
6563c91f
MM
1629error:
1630 key_ref_put(key_ref);
6563c91f
MM
1631 return ret;
1632}
1633
1da177e4 1634/*
973c9f4f 1635 * The key control system call
1da177e4 1636 */
938bb9f5
HC
1637SYSCALL_DEFINE5(keyctl, int, option, unsigned long, arg2, unsigned long, arg3,
1638 unsigned long, arg4, unsigned long, arg5)
1da177e4
LT
1639{
1640 switch (option) {
1641 case KEYCTL_GET_KEYRING_ID:
1642 return keyctl_get_keyring_ID((key_serial_t) arg2,
1643 (int) arg3);
1644
1645 case KEYCTL_JOIN_SESSION_KEYRING:
1646 return keyctl_join_session_keyring((const char __user *) arg2);
1647
1648 case KEYCTL_UPDATE:
1649 return keyctl_update_key((key_serial_t) arg2,
1650 (const void __user *) arg3,
1651 (size_t) arg4);
1652
1653 case KEYCTL_REVOKE:
1654 return keyctl_revoke_key((key_serial_t) arg2);
1655
1656 case KEYCTL_DESCRIBE:
1657 return keyctl_describe_key((key_serial_t) arg2,
1658 (char __user *) arg3,
1659 (unsigned) arg4);
1660
1661 case KEYCTL_CLEAR:
1662 return keyctl_keyring_clear((key_serial_t) arg2);
1663
1664 case KEYCTL_LINK:
1665 return keyctl_keyring_link((key_serial_t) arg2,
1666 (key_serial_t) arg3);
1667
1668 case KEYCTL_UNLINK:
1669 return keyctl_keyring_unlink((key_serial_t) arg2,
1670 (key_serial_t) arg3);
1671
1672 case KEYCTL_SEARCH:
1673 return keyctl_keyring_search((key_serial_t) arg2,
1674 (const char __user *) arg3,
1675 (const char __user *) arg4,
1676 (key_serial_t) arg5);
1677
1678 case KEYCTL_READ:
1679 return keyctl_read_key((key_serial_t) arg2,
1680 (char __user *) arg3,
1681 (size_t) arg4);
1682
1683 case KEYCTL_CHOWN:
1684 return keyctl_chown_key((key_serial_t) arg2,
1685 (uid_t) arg3,
1686 (gid_t) arg4);
1687
1688 case KEYCTL_SETPERM:
1689 return keyctl_setperm_key((key_serial_t) arg2,
1690 (key_perm_t) arg3);
1691
1692 case KEYCTL_INSTANTIATE:
1693 return keyctl_instantiate_key((key_serial_t) arg2,
1694 (const void __user *) arg3,
1695 (size_t) arg4,
1696 (key_serial_t) arg5);
1697
1698 case KEYCTL_NEGATE:
1699 return keyctl_negate_key((key_serial_t) arg2,
1700 (unsigned) arg3,
1701 (key_serial_t) arg4);
1702
3e30148c
DH
1703 case KEYCTL_SET_REQKEY_KEYRING:
1704 return keyctl_set_reqkey_keyring(arg2);
1705
017679c4
DH
1706 case KEYCTL_SET_TIMEOUT:
1707 return keyctl_set_timeout((key_serial_t) arg2,
1708 (unsigned) arg3);
1709
b5f545c8
DH
1710 case KEYCTL_ASSUME_AUTHORITY:
1711 return keyctl_assume_authority((key_serial_t) arg2);
1712
70a5bb72
DH
1713 case KEYCTL_GET_SECURITY:
1714 return keyctl_get_security((key_serial_t) arg2,
90bd49ab 1715 (char __user *) arg3,
70a5bb72
DH
1716 (size_t) arg4);
1717
ee18d64c
DH
1718 case KEYCTL_SESSION_TO_PARENT:
1719 return keyctl_session_to_parent();
1720
fdd1b945
DH
1721 case KEYCTL_REJECT:
1722 return keyctl_reject_key((key_serial_t) arg2,
1723 (unsigned) arg3,
1724 (unsigned) arg4,
1725 (key_serial_t) arg5);
1726
ee009e4a
DH
1727 case KEYCTL_INSTANTIATE_IOV:
1728 return keyctl_instantiate_key_iov(
1729 (key_serial_t) arg2,
1730 (const struct iovec __user *) arg3,
1731 (unsigned) arg4,
1732 (key_serial_t) arg5);
1733
fd75815f
DH
1734 case KEYCTL_INVALIDATE:
1735 return keyctl_invalidate_key((key_serial_t) arg2);
1736
f36f8c75
DH
1737 case KEYCTL_GET_PERSISTENT:
1738 return keyctl_get_persistent((uid_t)arg2, (key_serial_t)arg3);
1739
ddbb4114
MM
1740 case KEYCTL_DH_COMPUTE:
1741 return keyctl_dh_compute((struct keyctl_dh_params __user *) arg2,
4693fc73 1742 (char __user *) arg3, (size_t) arg4,
f1c316a3 1743 (struct keyctl_kdf_params __user *) arg5);
ddbb4114 1744
6563c91f
MM
1745 case KEYCTL_RESTRICT_KEYRING:
1746 return keyctl_restrict_keyring((key_serial_t) arg2,
1747 (const char __user *) arg3,
1748 (const char __user *) arg4);
ddbb4114 1749
1da177e4
LT
1750 default:
1751 return -EOPNOTSUPP;
1752 }
a8b17ed0 1753}