1 /* Userspace key control operations
3 * Copyright (C) 2004-5 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
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.
12 #include <linux/module.h>
13 #include <linux/init.h>
14 #include <linux/sched.h>
15 #include <linux/slab.h>
16 #include <linux/syscalls.h>
17 #include <linux/key.h>
18 #include <linux/keyctl.h>
20 #include <linux/capability.h>
21 #include <linux/string.h>
22 #include <linux/err.h>
23 #include <linux/vmalloc.h>
24 #include <linux/security.h>
25 #include <linux/uio.h>
26 #include <linux/uaccess.h>
29 #define KEY_MAX_DESC_SIZE 4096
31 static int key_get_type_from_user(char *type
,
32 const char __user
*_type
,
37 ret
= strncpy_from_user(type
, _type
, len
);
40 if (ret
== 0 || ret
>= len
)
49 * Extract the description of a new key from userspace and either add it as a
50 * new key to the specified keyring or update a matching key in that keyring.
52 * If the description is NULL or an empty string, the key type is asked to
53 * generate one from the payload.
55 * The keyring must be writable so that we can attach the key to it.
57 * If successful, the new key's serial number is returned, otherwise an error
60 SYSCALL_DEFINE5(add_key
, const char __user
*, _type
,
61 const char __user
*, _description
,
62 const void __user
*, _payload
,
66 key_ref_t keyring_ref
, key_ref
;
67 char type
[32], *description
;
72 if (plen
> 1024 * 1024 - 1)
75 /* draw all the data into kernel space */
76 ret
= key_get_type_from_user(type
, _type
, sizeof(type
));
82 description
= strndup_user(_description
, KEY_MAX_DESC_SIZE
);
83 if (IS_ERR(description
)) {
84 ret
= PTR_ERR(description
);
90 } else if ((description
[0] == '.') &&
91 (strncmp(type
, "keyring", 7) == 0)) {
97 /* pull the payload in if one was supplied */
102 payload
= kmalloc(plen
, GFP_KERNEL
| __GFP_NOWARN
);
104 if (plen
<= PAGE_SIZE
)
106 payload
= vmalloc(plen
);
112 if (copy_from_user(payload
, _payload
, plen
) != 0)
116 /* find the target keyring (which must be writable) */
117 keyring_ref
= lookup_user_key(ringid
, KEY_LOOKUP_CREATE
, KEY_NEED_WRITE
);
118 if (IS_ERR(keyring_ref
)) {
119 ret
= PTR_ERR(keyring_ref
);
123 /* create or update the requested key and add it to the target
125 key_ref
= key_create_or_update(keyring_ref
, type
, description
,
126 payload
, plen
, KEY_PERM_UNDEF
,
128 if (!IS_ERR(key_ref
)) {
129 ret
= key_ref_to_ptr(key_ref
)->serial
;
130 key_ref_put(key_ref
);
133 ret
= PTR_ERR(key_ref
);
136 key_ref_put(keyring_ref
);
146 * Search the process keyrings and keyring trees linked from those for a
147 * matching key. Keyrings must have appropriate Search permission to be
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.
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 "-".
158 SYSCALL_DEFINE4(request_key
, const char __user
*, _type
,
159 const char __user
*, _description
,
160 const char __user
*, _callout_info
,
161 key_serial_t
, destringid
)
163 struct key_type
*ktype
;
167 char type
[32], *description
, *callout_info
;
170 /* pull the type into kernel space */
171 ret
= key_get_type_from_user(type
, _type
, sizeof(type
));
175 /* pull the description into kernel space */
176 description
= strndup_user(_description
, KEY_MAX_DESC_SIZE
);
177 if (IS_ERR(description
)) {
178 ret
= PTR_ERR(description
);
182 /* pull the callout info into kernel space */
186 callout_info
= strndup_user(_callout_info
, PAGE_SIZE
);
187 if (IS_ERR(callout_info
)) {
188 ret
= PTR_ERR(callout_info
);
191 callout_len
= strlen(callout_info
);
194 /* get the destination keyring if specified */
197 dest_ref
= lookup_user_key(destringid
, KEY_LOOKUP_CREATE
,
199 if (IS_ERR(dest_ref
)) {
200 ret
= PTR_ERR(dest_ref
);
205 /* find the key type */
206 ktype
= key_type_lookup(type
);
208 ret
= PTR_ERR(ktype
);
213 key
= request_key_and_link(ktype
, description
, callout_info
,
214 callout_len
, NULL
, key_ref_to_ptr(dest_ref
),
221 /* wait for the key to finish being constructed */
222 ret
= wait_for_key_construction(key
, 1);
233 key_ref_put(dest_ref
);
243 * Get the ID of the specified process keyring.
245 * The requested keyring must have search permission to be found.
247 * If successful, the ID of the requested keyring will be returned.
249 long keyctl_get_keyring_ID(key_serial_t id
, int create
)
252 unsigned long lflags
;
255 lflags
= create
? KEY_LOOKUP_CREATE
: 0;
256 key_ref
= lookup_user_key(id
, lflags
, KEY_NEED_SEARCH
);
257 if (IS_ERR(key_ref
)) {
258 ret
= PTR_ERR(key_ref
);
262 ret
= key_ref_to_ptr(key_ref
)->serial
;
263 key_ref_put(key_ref
);
269 * Join a (named) session keyring.
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
276 * If successful, the ID of the joined session keyring will be returned.
278 long keyctl_join_session_keyring(const char __user
*_name
)
283 /* fetch the name from userspace */
286 name
= strndup_user(_name
, KEY_MAX_DESC_SIZE
);
293 /* join the session */
294 ret
= join_session_keyring(name
);
302 * Update a key's data payload from the given data.
304 * The key must grant the caller Write permission and the key type must support
305 * updating for this to work. A negative key can be positively instantiated
308 * If successful, 0 will be returned. If the key type does not support
309 * updating, then -EOPNOTSUPP will be returned.
311 long keyctl_update_key(key_serial_t id
,
312 const void __user
*_payload
,
320 if (plen
> PAGE_SIZE
)
323 /* pull the payload in if one was supplied */
327 payload
= kmalloc(plen
, GFP_KERNEL
);
332 if (copy_from_user(payload
, _payload
, plen
) != 0)
336 /* find the target key (which must be writable) */
337 key_ref
= lookup_user_key(id
, 0, KEY_NEED_WRITE
);
338 if (IS_ERR(key_ref
)) {
339 ret
= PTR_ERR(key_ref
);
344 ret
= key_update(key_ref
, payload
, plen
);
346 key_ref_put(key_ref
);
356 * The key must be grant the caller Write or Setattr permission for this to
357 * work. The key type should give up its quota claim when revoked. The key
358 * and any links to the key will be automatically garbage collected after a
359 * certain amount of time (/proc/sys/kernel/keys/gc_delay).
361 * Keys with KEY_FLAG_KEEP set should not be revoked.
363 * If successful, 0 is returned.
365 long keyctl_revoke_key(key_serial_t id
)
371 key_ref
= lookup_user_key(id
, 0, KEY_NEED_WRITE
);
372 if (IS_ERR(key_ref
)) {
373 ret
= PTR_ERR(key_ref
);
376 key_ref
= lookup_user_key(id
, 0, KEY_NEED_SETATTR
);
377 if (IS_ERR(key_ref
)) {
378 ret
= PTR_ERR(key_ref
);
383 key
= key_ref_to_ptr(key_ref
);
385 if (test_bit(KEY_FLAG_KEEP
, &key
->flags
))
390 key_ref_put(key_ref
);
398 * The key must be grant the caller Invalidate permission for this to work.
399 * The key and any links to the key will be automatically garbage collected
402 * Keys with KEY_FLAG_KEEP set should not be invalidated.
404 * If successful, 0 is returned.
406 long keyctl_invalidate_key(key_serial_t id
)
414 key_ref
= lookup_user_key(id
, 0, KEY_NEED_SEARCH
);
415 if (IS_ERR(key_ref
)) {
416 ret
= PTR_ERR(key_ref
);
418 /* Root is permitted to invalidate certain special keys */
419 if (capable(CAP_SYS_ADMIN
)) {
420 key_ref
= lookup_user_key(id
, 0, 0);
423 if (test_bit(KEY_FLAG_ROOT_CAN_INVAL
,
424 &key_ref_to_ptr(key_ref
)->flags
))
433 key
= key_ref_to_ptr(key_ref
);
435 if (test_bit(KEY_FLAG_KEEP
, &key
->flags
))
440 key_ref_put(key_ref
);
442 kleave(" = %ld", ret
);
447 * Clear the specified keyring, creating an empty process keyring if one of the
448 * special keyring IDs is used.
450 * The keyring must grant the caller Write permission and not have
451 * KEY_FLAG_KEEP set for this to work. If successful, 0 will be returned.
453 long keyctl_keyring_clear(key_serial_t ringid
)
455 key_ref_t keyring_ref
;
459 keyring_ref
= lookup_user_key(ringid
, KEY_LOOKUP_CREATE
, KEY_NEED_WRITE
);
460 if (IS_ERR(keyring_ref
)) {
461 ret
= PTR_ERR(keyring_ref
);
463 /* Root is permitted to invalidate certain special keyrings */
464 if (capable(CAP_SYS_ADMIN
)) {
465 keyring_ref
= lookup_user_key(ringid
, 0, 0);
466 if (IS_ERR(keyring_ref
))
468 if (test_bit(KEY_FLAG_ROOT_CAN_CLEAR
,
469 &key_ref_to_ptr(keyring_ref
)->flags
))
478 keyring
= key_ref_to_ptr(keyring_ref
);
479 if (test_bit(KEY_FLAG_KEEP
, &keyring
->flags
))
482 ret
= keyring_clear(keyring
);
484 key_ref_put(keyring_ref
);
490 * Create a link from a keyring to a key if there's no matching key in the
491 * keyring, otherwise replace the link to the matching key with a link to the
494 * The key must grant the caller Link permission and the the keyring must grant
495 * the caller Write permission. Furthermore, if an additional link is created,
496 * the keyring's quota will be extended.
498 * If successful, 0 will be returned.
500 long keyctl_keyring_link(key_serial_t id
, key_serial_t ringid
)
502 key_ref_t keyring_ref
, key_ref
;
505 keyring_ref
= lookup_user_key(ringid
, KEY_LOOKUP_CREATE
, KEY_NEED_WRITE
);
506 if (IS_ERR(keyring_ref
)) {
507 ret
= PTR_ERR(keyring_ref
);
511 key_ref
= lookup_user_key(id
, KEY_LOOKUP_CREATE
, KEY_NEED_LINK
);
512 if (IS_ERR(key_ref
)) {
513 ret
= PTR_ERR(key_ref
);
517 ret
= key_link(key_ref_to_ptr(keyring_ref
), key_ref_to_ptr(key_ref
));
519 key_ref_put(key_ref
);
521 key_ref_put(keyring_ref
);
527 * Unlink a key from a keyring.
529 * The keyring must grant the caller Write permission for this to work; the key
530 * itself need not grant the caller anything. If the last link to a key is
531 * removed then that key will be scheduled for destruction.
533 * Keys or keyrings with KEY_FLAG_KEEP set should not be unlinked.
535 * If successful, 0 will be returned.
537 long keyctl_keyring_unlink(key_serial_t id
, key_serial_t ringid
)
539 key_ref_t keyring_ref
, key_ref
;
540 struct key
*keyring
, *key
;
543 keyring_ref
= lookup_user_key(ringid
, 0, KEY_NEED_WRITE
);
544 if (IS_ERR(keyring_ref
)) {
545 ret
= PTR_ERR(keyring_ref
);
549 key_ref
= lookup_user_key(id
, KEY_LOOKUP_FOR_UNLINK
, 0);
550 if (IS_ERR(key_ref
)) {
551 ret
= PTR_ERR(key_ref
);
555 keyring
= key_ref_to_ptr(keyring_ref
);
556 key
= key_ref_to_ptr(key_ref
);
557 if (test_bit(KEY_FLAG_KEEP
, &keyring
->flags
) &&
558 test_bit(KEY_FLAG_KEEP
, &key
->flags
))
561 ret
= key_unlink(keyring
, key
);
563 key_ref_put(key_ref
);
565 key_ref_put(keyring_ref
);
571 * Return a description of a key to userspace.
573 * The key must grant the caller View permission for this to work.
575 * If there's a buffer, we place up to buflen bytes of data into it formatted
576 * in the following way:
578 * type;uid;gid;perm;description<NUL>
580 * If successful, we return the amount of description available, irrespective
581 * of how much we may have copied into the buffer.
583 long keyctl_describe_key(key_serial_t keyid
,
587 struct key
*key
, *instkey
;
591 int desclen
, infolen
;
593 key_ref
= lookup_user_key(keyid
, KEY_LOOKUP_PARTIAL
, KEY_NEED_VIEW
);
594 if (IS_ERR(key_ref
)) {
595 /* viewing a key under construction is permitted if we have the
596 * authorisation token handy */
597 if (PTR_ERR(key_ref
) == -EACCES
) {
598 instkey
= key_get_instantiation_authkey(keyid
);
599 if (!IS_ERR(instkey
)) {
601 key_ref
= lookup_user_key(keyid
,
604 if (!IS_ERR(key_ref
))
609 ret
= PTR_ERR(key_ref
);
614 key
= key_ref_to_ptr(key_ref
);
615 desclen
= strlen(key
->description
);
617 /* calculate how much information we're going to return */
619 infobuf
= kasprintf(GFP_KERNEL
,
622 from_kuid_munged(current_user_ns(), key
->uid
),
623 from_kgid_munged(current_user_ns(), key
->gid
),
627 infolen
= strlen(infobuf
);
628 ret
= infolen
+ desclen
+ 1;
630 /* consider returning the data */
631 if (buffer
&& buflen
>= ret
) {
632 if (copy_to_user(buffer
, infobuf
, infolen
) != 0 ||
633 copy_to_user(buffer
+ infolen
, key
->description
,
640 key_ref_put(key_ref
);
646 * Search the specified keyring and any keyrings it links to for a matching
647 * key. Only keyrings that grant the caller Search permission will be searched
648 * (this includes the starting keyring). Only keys with Search permission can
651 * If successful, the found key will be linked to the destination keyring if
652 * supplied and the key has Link permission, and the found key ID will be
655 long keyctl_keyring_search(key_serial_t ringid
,
656 const char __user
*_type
,
657 const char __user
*_description
,
658 key_serial_t destringid
)
660 struct key_type
*ktype
;
661 key_ref_t keyring_ref
, key_ref
, dest_ref
;
662 char type
[32], *description
;
665 /* pull the type and description into kernel space */
666 ret
= key_get_type_from_user(type
, _type
, sizeof(type
));
670 description
= strndup_user(_description
, KEY_MAX_DESC_SIZE
);
671 if (IS_ERR(description
)) {
672 ret
= PTR_ERR(description
);
676 /* get the keyring at which to begin the search */
677 keyring_ref
= lookup_user_key(ringid
, 0, KEY_NEED_SEARCH
);
678 if (IS_ERR(keyring_ref
)) {
679 ret
= PTR_ERR(keyring_ref
);
683 /* get the destination keyring if specified */
686 dest_ref
= lookup_user_key(destringid
, KEY_LOOKUP_CREATE
,
688 if (IS_ERR(dest_ref
)) {
689 ret
= PTR_ERR(dest_ref
);
694 /* find the key type */
695 ktype
= key_type_lookup(type
);
697 ret
= PTR_ERR(ktype
);
702 key_ref
= keyring_search(keyring_ref
, ktype
, description
);
703 if (IS_ERR(key_ref
)) {
704 ret
= PTR_ERR(key_ref
);
706 /* treat lack or presence of a negative key the same */
712 /* link the resulting key to the destination keyring if we can */
714 ret
= key_permission(key_ref
, KEY_NEED_LINK
);
718 ret
= key_link(key_ref_to_ptr(dest_ref
), key_ref_to_ptr(key_ref
));
723 ret
= key_ref_to_ptr(key_ref
)->serial
;
726 key_ref_put(key_ref
);
730 key_ref_put(dest_ref
);
732 key_ref_put(keyring_ref
);
740 * Read a key's payload.
742 * The key must either grant the caller Read permission, or it must grant the
743 * caller Search permission when searched for from the process keyrings.
745 * If successful, we place up to buflen bytes of data into the buffer, if one
746 * is provided, and return the amount of data that is available in the key,
747 * irrespective of how much we copied into the buffer.
749 long keyctl_read_key(key_serial_t keyid
, char __user
*buffer
, size_t buflen
)
755 /* find the key first */
756 key_ref
= lookup_user_key(keyid
, 0, 0);
757 if (IS_ERR(key_ref
)) {
762 key
= key_ref_to_ptr(key_ref
);
764 /* see if we can read it directly */
765 ret
= key_permission(key_ref
, KEY_NEED_READ
);
771 /* we can't; see if it's searchable from this process's keyrings
772 * - we automatically take account of the fact that it may be
773 * dangling off an instantiation key
775 if (!is_key_possessed(key_ref
)) {
780 /* the key is probably readable - now try to read it */
783 if (key
->type
->read
) {
784 /* Read the data with the semaphore held (since we might sleep)
785 * to protect against the key being updated or revoked.
787 down_read(&key
->sem
);
788 ret
= key_validate(key
);
790 ret
= key
->type
->read(key
, buffer
, buflen
);
801 * Change the ownership of a key
803 * The key must grant the caller Setattr permission for this to work, though
804 * the key need not be fully instantiated yet. For the UID to be changed, or
805 * for the GID to be changed to a group the caller is not a member of, the
806 * caller must have sysadmin capability. If either uid or gid is -1 then that
807 * attribute is not changed.
809 * If the UID is to be changed, the new user must have sufficient quota to
810 * accept the key. The quota deduction will be removed from the old user to
811 * the new user should the attribute be changed.
813 * If successful, 0 will be returned.
815 long keyctl_chown_key(key_serial_t id
, uid_t user
, gid_t group
)
817 struct key_user
*newowner
, *zapowner
= NULL
;
824 uid
= make_kuid(current_user_ns(), user
);
825 gid
= make_kgid(current_user_ns(), group
);
827 if ((user
!= (uid_t
) -1) && !uid_valid(uid
))
829 if ((group
!= (gid_t
) -1) && !gid_valid(gid
))
833 if (user
== (uid_t
) -1 && group
== (gid_t
) -1)
836 key_ref
= lookup_user_key(id
, KEY_LOOKUP_CREATE
| KEY_LOOKUP_PARTIAL
,
838 if (IS_ERR(key_ref
)) {
839 ret
= PTR_ERR(key_ref
);
843 key
= key_ref_to_ptr(key_ref
);
845 /* make the changes with the locks held to prevent chown/chown races */
847 down_write(&key
->sem
);
849 if (!capable(CAP_SYS_ADMIN
)) {
850 /* only the sysadmin can chown a key to some other UID */
851 if (user
!= (uid_t
) -1 && !uid_eq(key
->uid
, uid
))
854 /* only the sysadmin can set the key's GID to a group other
855 * than one of those that the current process subscribes to */
856 if (group
!= (gid_t
) -1 && !gid_eq(gid
, key
->gid
) && !in_group_p(gid
))
861 if (user
!= (uid_t
) -1 && !uid_eq(uid
, key
->uid
)) {
863 newowner
= key_user_lookup(uid
);
867 /* transfer the quota burden to the new user */
868 if (test_bit(KEY_FLAG_IN_QUOTA
, &key
->flags
)) {
869 unsigned maxkeys
= uid_eq(uid
, GLOBAL_ROOT_UID
) ?
870 key_quota_root_maxkeys
: key_quota_maxkeys
;
871 unsigned maxbytes
= uid_eq(uid
, GLOBAL_ROOT_UID
) ?
872 key_quota_root_maxbytes
: key_quota_maxbytes
;
874 spin_lock(&newowner
->lock
);
875 if (newowner
->qnkeys
+ 1 >= maxkeys
||
876 newowner
->qnbytes
+ key
->quotalen
>= maxbytes
||
877 newowner
->qnbytes
+ key
->quotalen
<
882 newowner
->qnbytes
+= key
->quotalen
;
883 spin_unlock(&newowner
->lock
);
885 spin_lock(&key
->user
->lock
);
887 key
->user
->qnbytes
-= key
->quotalen
;
888 spin_unlock(&key
->user
->lock
);
891 atomic_dec(&key
->user
->nkeys
);
892 atomic_inc(&newowner
->nkeys
);
894 if (test_bit(KEY_FLAG_INSTANTIATED
, &key
->flags
)) {
895 atomic_dec(&key
->user
->nikeys
);
896 atomic_inc(&newowner
->nikeys
);
899 zapowner
= key
->user
;
900 key
->user
= newowner
;
905 if (group
!= (gid_t
) -1)
914 key_user_put(zapowner
);
919 spin_unlock(&newowner
->lock
);
926 * Change the permission mask on a key.
928 * The key must grant the caller Setattr permission for this to work, though
929 * the key need not be fully instantiated yet. If the caller does not have
930 * sysadmin capability, it may only change the permission on keys that it owns.
932 long keyctl_setperm_key(key_serial_t id
, key_perm_t perm
)
939 if (perm
& ~(KEY_POS_ALL
| KEY_USR_ALL
| KEY_GRP_ALL
| KEY_OTH_ALL
))
942 key_ref
= lookup_user_key(id
, KEY_LOOKUP_CREATE
| KEY_LOOKUP_PARTIAL
,
944 if (IS_ERR(key_ref
)) {
945 ret
= PTR_ERR(key_ref
);
949 key
= key_ref_to_ptr(key_ref
);
951 /* make the changes with the locks held to prevent chown/chmod races */
953 down_write(&key
->sem
);
955 /* if we're not the sysadmin, we can only change a key that we own */
956 if (capable(CAP_SYS_ADMIN
) || uid_eq(key
->uid
, current_fsuid())) {
968 * Get the destination keyring for instantiation and check that the caller has
969 * Write permission on it.
971 static long get_instantiation_keyring(key_serial_t ringid
,
972 struct request_key_auth
*rka
,
973 struct key
**_dest_keyring
)
977 *_dest_keyring
= NULL
;
979 /* just return a NULL pointer if we weren't asked to make a link */
983 /* if a specific keyring is nominated by ID, then use that */
985 dkref
= lookup_user_key(ringid
, KEY_LOOKUP_CREATE
, KEY_NEED_WRITE
);
987 return PTR_ERR(dkref
);
988 *_dest_keyring
= key_ref_to_ptr(dkref
);
992 if (ringid
== KEY_SPEC_REQKEY_AUTH_KEY
)
995 /* otherwise specify the destination keyring recorded in the
996 * authorisation key (any KEY_SPEC_*_KEYRING) */
997 if (ringid
>= KEY_SPEC_REQUESTOR_KEYRING
) {
998 *_dest_keyring
= key_get(rka
->dest_keyring
);
1006 * Change the request_key authorisation key on the current process.
1008 static int keyctl_change_reqkey_auth(struct key
*key
)
1012 new = prepare_creds();
1016 key_put(new->request_key_auth
);
1017 new->request_key_auth
= key_get(key
);
1019 return commit_creds(new);
1023 * Instantiate a key with the specified payload and link the key into the
1024 * destination keyring if one is given.
1026 * The caller must have the appropriate instantiation permit set for this to
1027 * work (see keyctl_assume_authority). No other permissions are required.
1029 * If successful, 0 will be returned.
1031 long keyctl_instantiate_key_common(key_serial_t id
,
1032 struct iov_iter
*from
,
1033 key_serial_t ringid
)
1035 const struct cred
*cred
= current_cred();
1036 struct request_key_auth
*rka
;
1037 struct key
*instkey
, *dest_keyring
;
1038 size_t plen
= from
? iov_iter_count(from
) : 0;
1042 kenter("%d,,%zu,%d", id
, plen
, ringid
);
1048 if (plen
> 1024 * 1024 - 1)
1051 /* the appropriate instantiation authorisation key must have been
1052 * assumed before calling this */
1054 instkey
= cred
->request_key_auth
;
1058 rka
= instkey
->payload
.data
[0];
1059 if (rka
->target_key
->serial
!= id
)
1062 /* pull the payload in if one was supplied */
1067 payload
= kmalloc(plen
, GFP_KERNEL
);
1069 if (plen
<= PAGE_SIZE
)
1071 payload
= vmalloc(plen
);
1077 if (!copy_from_iter_full(payload
, plen
, from
))
1081 /* find the destination keyring amongst those belonging to the
1082 * requesting task */
1083 ret
= get_instantiation_keyring(ringid
, rka
, &dest_keyring
);
1087 /* instantiate the key and link it into a keyring */
1088 ret
= key_instantiate_and_link(rka
->target_key
, payload
, plen
,
1089 dest_keyring
, instkey
);
1091 key_put(dest_keyring
);
1093 /* discard the assumed authority if it's just been disabled by
1094 * instantiation of the key */
1096 keyctl_change_reqkey_auth(NULL
);
1105 * Instantiate a key with the specified payload and link the key into the
1106 * destination keyring if one is given.
1108 * The caller must have the appropriate instantiation permit set for this to
1109 * work (see keyctl_assume_authority). No other permissions are required.
1111 * If successful, 0 will be returned.
1113 long keyctl_instantiate_key(key_serial_t id
,
1114 const void __user
*_payload
,
1116 key_serial_t ringid
)
1118 if (_payload
&& plen
) {
1120 struct iov_iter from
;
1123 ret
= import_single_range(WRITE
, (void __user
*)_payload
, plen
,
1128 return keyctl_instantiate_key_common(id
, &from
, ringid
);
1131 return keyctl_instantiate_key_common(id
, NULL
, ringid
);
1135 * Instantiate a key with the specified multipart payload and link the key into
1136 * the destination keyring if one is given.
1138 * The caller must have the appropriate instantiation permit set for this to
1139 * work (see keyctl_assume_authority). No other permissions are required.
1141 * If successful, 0 will be returned.
1143 long keyctl_instantiate_key_iov(key_serial_t id
,
1144 const struct iovec __user
*_payload_iov
,
1146 key_serial_t ringid
)
1148 struct iovec iovstack
[UIO_FASTIOV
], *iov
= iovstack
;
1149 struct iov_iter from
;
1155 ret
= import_iovec(WRITE
, _payload_iov
, ioc
,
1156 ARRAY_SIZE(iovstack
), &iov
, &from
);
1159 ret
= keyctl_instantiate_key_common(id
, &from
, ringid
);
1165 * Negatively instantiate the key with the given timeout (in seconds) and link
1166 * the key into the destination keyring if one is given.
1168 * The caller must have the appropriate instantiation permit set for this to
1169 * work (see keyctl_assume_authority). No other permissions are required.
1171 * The key and any links to the key will be automatically garbage collected
1172 * after the timeout expires.
1174 * Negative keys are used to rate limit repeated request_key() calls by causing
1175 * them to return -ENOKEY until the negative key expires.
1177 * If successful, 0 will be returned.
1179 long keyctl_negate_key(key_serial_t id
, unsigned timeout
, key_serial_t ringid
)
1181 return keyctl_reject_key(id
, timeout
, ENOKEY
, ringid
);
1185 * Negatively instantiate the key with the given timeout (in seconds) and error
1186 * code and link the key into the destination keyring if one is given.
1188 * The caller must have the appropriate instantiation permit set for this to
1189 * work (see keyctl_assume_authority). No other permissions are required.
1191 * The key and any links to the key will be automatically garbage collected
1192 * after the timeout expires.
1194 * Negative keys are used to rate limit repeated request_key() calls by causing
1195 * them to return the specified error code until the negative key expires.
1197 * If successful, 0 will be returned.
1199 long keyctl_reject_key(key_serial_t id
, unsigned timeout
, unsigned error
,
1200 key_serial_t ringid
)
1202 const struct cred
*cred
= current_cred();
1203 struct request_key_auth
*rka
;
1204 struct key
*instkey
, *dest_keyring
;
1207 kenter("%d,%u,%u,%d", id
, timeout
, error
, ringid
);
1209 /* must be a valid error code and mustn't be a kernel special */
1211 error
>= MAX_ERRNO
||
1212 error
== ERESTARTSYS
||
1213 error
== ERESTARTNOINTR
||
1214 error
== ERESTARTNOHAND
||
1215 error
== ERESTART_RESTARTBLOCK
)
1218 /* the appropriate instantiation authorisation key must have been
1219 * assumed before calling this */
1221 instkey
= cred
->request_key_auth
;
1225 rka
= instkey
->payload
.data
[0];
1226 if (rka
->target_key
->serial
!= id
)
1229 /* find the destination keyring if present (which must also be
1231 ret
= get_instantiation_keyring(ringid
, rka
, &dest_keyring
);
1235 /* instantiate the key and link it into a keyring */
1236 ret
= key_reject_and_link(rka
->target_key
, timeout
, error
,
1237 dest_keyring
, instkey
);
1239 key_put(dest_keyring
);
1241 /* discard the assumed authority if it's just been disabled by
1242 * instantiation of the key */
1244 keyctl_change_reqkey_auth(NULL
);
1251 * Read or set the default keyring in which request_key() will cache keys and
1252 * return the old setting.
1254 * If a process keyring is specified then this will be created if it doesn't
1255 * yet exist. The old setting will be returned if successful.
1257 long keyctl_set_reqkey_keyring(int reqkey_defl
)
1260 int ret
, old_setting
;
1262 old_setting
= current_cred_xxx(jit_keyring
);
1264 if (reqkey_defl
== KEY_REQKEY_DEFL_NO_CHANGE
)
1267 new = prepare_creds();
1271 switch (reqkey_defl
) {
1272 case KEY_REQKEY_DEFL_THREAD_KEYRING
:
1273 ret
= install_thread_keyring_to_cred(new);
1278 case KEY_REQKEY_DEFL_PROCESS_KEYRING
:
1279 ret
= install_process_keyring_to_cred(new);
1287 case KEY_REQKEY_DEFL_DEFAULT
:
1288 case KEY_REQKEY_DEFL_SESSION_KEYRING
:
1289 case KEY_REQKEY_DEFL_USER_KEYRING
:
1290 case KEY_REQKEY_DEFL_USER_SESSION_KEYRING
:
1291 case KEY_REQKEY_DEFL_REQUESTOR_KEYRING
:
1294 case KEY_REQKEY_DEFL_NO_CHANGE
:
1295 case KEY_REQKEY_DEFL_GROUP_KEYRING
:
1302 new->jit_keyring
= reqkey_defl
;
1311 * Set or clear the timeout on a key.
1313 * Either the key must grant the caller Setattr permission or else the caller
1314 * must hold an instantiation authorisation token for the key.
1316 * The timeout is either 0 to clear the timeout, or a number of seconds from
1317 * the current time. The key and any links to the key will be automatically
1318 * garbage collected after the timeout expires.
1320 * Keys with KEY_FLAG_KEEP set should not be timed out.
1322 * If successful, 0 is returned.
1324 long keyctl_set_timeout(key_serial_t id
, unsigned timeout
)
1326 struct key
*key
, *instkey
;
1330 key_ref
= lookup_user_key(id
, KEY_LOOKUP_CREATE
| KEY_LOOKUP_PARTIAL
,
1332 if (IS_ERR(key_ref
)) {
1333 /* setting the timeout on a key under construction is permitted
1334 * if we have the authorisation token handy */
1335 if (PTR_ERR(key_ref
) == -EACCES
) {
1336 instkey
= key_get_instantiation_authkey(id
);
1337 if (!IS_ERR(instkey
)) {
1339 key_ref
= lookup_user_key(id
,
1342 if (!IS_ERR(key_ref
))
1347 ret
= PTR_ERR(key_ref
);
1352 key
= key_ref_to_ptr(key_ref
);
1354 if (test_bit(KEY_FLAG_KEEP
, &key
->flags
))
1357 key_set_timeout(key
, timeout
);
1365 * Assume (or clear) the authority to instantiate the specified key.
1367 * This sets the authoritative token currently in force for key instantiation.
1368 * This must be done for a key to be instantiated. It has the effect of making
1369 * available all the keys from the caller of the request_key() that created a
1370 * key to request_key() calls made by the caller of this function.
1372 * The caller must have the instantiation key in their process keyrings with a
1373 * Search permission grant available to the caller.
1375 * If the ID given is 0, then the setting will be cleared and 0 returned.
1377 * If the ID given has a matching an authorisation key, then that key will be
1378 * set and its ID will be returned. The authorisation key can be read to get
1379 * the callout information passed to request_key().
1381 long keyctl_assume_authority(key_serial_t id
)
1383 struct key
*authkey
;
1386 /* special key IDs aren't permitted */
1391 /* we divest ourselves of authority if given an ID of 0 */
1393 ret
= keyctl_change_reqkey_auth(NULL
);
1397 /* attempt to assume the authority temporarily granted to us whilst we
1398 * instantiate the specified key
1399 * - the authorisation key must be in the current task's keyrings
1402 authkey
= key_get_instantiation_authkey(id
);
1403 if (IS_ERR(authkey
)) {
1404 ret
= PTR_ERR(authkey
);
1408 ret
= keyctl_change_reqkey_auth(authkey
);
1413 ret
= authkey
->serial
;
1419 * Get a key's the LSM security label.
1421 * The key must grant the caller View permission for this to work.
1423 * If there's a buffer, then up to buflen bytes of data will be placed into it.
1425 * If successful, the amount of information available will be returned,
1426 * irrespective of how much was copied (including the terminal NUL).
1428 long keyctl_get_security(key_serial_t keyid
,
1429 char __user
*buffer
,
1432 struct key
*key
, *instkey
;
1437 key_ref
= lookup_user_key(keyid
, KEY_LOOKUP_PARTIAL
, KEY_NEED_VIEW
);
1438 if (IS_ERR(key_ref
)) {
1439 if (PTR_ERR(key_ref
) != -EACCES
)
1440 return PTR_ERR(key_ref
);
1442 /* viewing a key under construction is also permitted if we
1443 * have the authorisation token handy */
1444 instkey
= key_get_instantiation_authkey(keyid
);
1445 if (IS_ERR(instkey
))
1446 return PTR_ERR(instkey
);
1449 key_ref
= lookup_user_key(keyid
, KEY_LOOKUP_PARTIAL
, 0);
1450 if (IS_ERR(key_ref
))
1451 return PTR_ERR(key_ref
);
1454 key
= key_ref_to_ptr(key_ref
);
1455 ret
= security_key_getsecurity(key
, &context
);
1457 /* if no information was returned, give userspace an empty
1460 if (buffer
&& buflen
> 0 &&
1461 copy_to_user(buffer
, "", 1) != 0)
1463 } else if (ret
> 0) {
1464 /* return as much data as there's room for */
1465 if (buffer
&& buflen
> 0) {
1469 if (copy_to_user(buffer
, context
, buflen
) != 0)
1476 key_ref_put(key_ref
);
1481 * Attempt to install the calling process's session keyring on the process's
1484 * The keyring must exist and must grant the caller LINK permission, and the
1485 * parent process must be single-threaded and must have the same effective
1486 * ownership as this process and mustn't be SUID/SGID.
1488 * The keyring will be emplaced on the parent when it next resumes userspace.
1490 * If successful, 0 will be returned.
1492 long keyctl_session_to_parent(void)
1494 struct task_struct
*me
, *parent
;
1495 const struct cred
*mycred
, *pcred
;
1496 struct callback_head
*newwork
, *oldwork
;
1497 key_ref_t keyring_r
;
1501 keyring_r
= lookup_user_key(KEY_SPEC_SESSION_KEYRING
, 0, KEY_NEED_LINK
);
1502 if (IS_ERR(keyring_r
))
1503 return PTR_ERR(keyring_r
);
1507 /* our parent is going to need a new cred struct, a new tgcred struct
1508 * and new security data, so we allocate them here to prevent ENOMEM in
1510 cred
= cred_alloc_blank();
1513 newwork
= &cred
->rcu
;
1515 cred
->session_keyring
= key_ref_to_ptr(keyring_r
);
1517 init_task_work(newwork
, key_change_session_keyring
);
1521 write_lock_irq(&tasklist_lock
);
1525 parent
= me
->real_parent
;
1527 /* the parent mustn't be init and mustn't be a kernel thread */
1528 if (parent
->pid
<= 1 || !parent
->mm
)
1531 /* the parent must be single threaded */
1532 if (!thread_group_empty(parent
))
1535 /* the parent and the child must have different session keyrings or
1536 * there's no point */
1537 mycred
= current_cred();
1538 pcred
= __task_cred(parent
);
1539 if (mycred
== pcred
||
1540 mycred
->session_keyring
== pcred
->session_keyring
) {
1545 /* the parent must have the same effective ownership and mustn't be
1547 if (!uid_eq(pcred
->uid
, mycred
->euid
) ||
1548 !uid_eq(pcred
->euid
, mycred
->euid
) ||
1549 !uid_eq(pcred
->suid
, mycred
->euid
) ||
1550 !gid_eq(pcred
->gid
, mycred
->egid
) ||
1551 !gid_eq(pcred
->egid
, mycred
->egid
) ||
1552 !gid_eq(pcred
->sgid
, mycred
->egid
))
1555 /* the keyrings must have the same UID */
1556 if ((pcred
->session_keyring
&&
1557 !uid_eq(pcred
->session_keyring
->uid
, mycred
->euid
)) ||
1558 !uid_eq(mycred
->session_keyring
->uid
, mycred
->euid
))
1561 /* cancel an already pending keyring replacement */
1562 oldwork
= task_work_cancel(parent
, key_change_session_keyring
);
1564 /* the replacement session keyring is applied just prior to userspace
1566 ret
= task_work_add(parent
, newwork
, true);
1570 write_unlock_irq(&tasklist_lock
);
1573 put_cred(container_of(oldwork
, struct cred
, rcu
));
1579 key_ref_put(keyring_r
);
1584 * The key control system call
1586 SYSCALL_DEFINE5(keyctl
, int, option
, unsigned long, arg2
, unsigned long, arg3
,
1587 unsigned long, arg4
, unsigned long, arg5
)
1590 case KEYCTL_GET_KEYRING_ID
:
1591 return keyctl_get_keyring_ID((key_serial_t
) arg2
,
1594 case KEYCTL_JOIN_SESSION_KEYRING
:
1595 return keyctl_join_session_keyring((const char __user
*) arg2
);
1598 return keyctl_update_key((key_serial_t
) arg2
,
1599 (const void __user
*) arg3
,
1603 return keyctl_revoke_key((key_serial_t
) arg2
);
1605 case KEYCTL_DESCRIBE
:
1606 return keyctl_describe_key((key_serial_t
) arg2
,
1607 (char __user
*) arg3
,
1611 return keyctl_keyring_clear((key_serial_t
) arg2
);
1614 return keyctl_keyring_link((key_serial_t
) arg2
,
1615 (key_serial_t
) arg3
);
1618 return keyctl_keyring_unlink((key_serial_t
) arg2
,
1619 (key_serial_t
) arg3
);
1622 return keyctl_keyring_search((key_serial_t
) arg2
,
1623 (const char __user
*) arg3
,
1624 (const char __user
*) arg4
,
1625 (key_serial_t
) arg5
);
1628 return keyctl_read_key((key_serial_t
) arg2
,
1629 (char __user
*) arg3
,
1633 return keyctl_chown_key((key_serial_t
) arg2
,
1637 case KEYCTL_SETPERM
:
1638 return keyctl_setperm_key((key_serial_t
) arg2
,
1641 case KEYCTL_INSTANTIATE
:
1642 return keyctl_instantiate_key((key_serial_t
) arg2
,
1643 (const void __user
*) arg3
,
1645 (key_serial_t
) arg5
);
1648 return keyctl_negate_key((key_serial_t
) arg2
,
1650 (key_serial_t
) arg4
);
1652 case KEYCTL_SET_REQKEY_KEYRING
:
1653 return keyctl_set_reqkey_keyring(arg2
);
1655 case KEYCTL_SET_TIMEOUT
:
1656 return keyctl_set_timeout((key_serial_t
) arg2
,
1659 case KEYCTL_ASSUME_AUTHORITY
:
1660 return keyctl_assume_authority((key_serial_t
) arg2
);
1662 case KEYCTL_GET_SECURITY
:
1663 return keyctl_get_security((key_serial_t
) arg2
,
1664 (char __user
*) arg3
,
1667 case KEYCTL_SESSION_TO_PARENT
:
1668 return keyctl_session_to_parent();
1671 return keyctl_reject_key((key_serial_t
) arg2
,
1674 (key_serial_t
) arg5
);
1676 case KEYCTL_INSTANTIATE_IOV
:
1677 return keyctl_instantiate_key_iov(
1678 (key_serial_t
) arg2
,
1679 (const struct iovec __user
*) arg3
,
1681 (key_serial_t
) arg5
);
1683 case KEYCTL_INVALIDATE
:
1684 return keyctl_invalidate_key((key_serial_t
) arg2
);
1686 case KEYCTL_GET_PERSISTENT
:
1687 return keyctl_get_persistent((uid_t
)arg2
, (key_serial_t
)arg3
);
1689 case KEYCTL_DH_COMPUTE
:
1690 return keyctl_dh_compute((struct keyctl_dh_params __user
*) arg2
,
1691 (char __user
*) arg3
, (size_t) arg4
,
1692 (void __user
*) arg5
);