1 /* keyctl.c: userspace keyctl 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/keyctl.h>
19 #include <linux/err.h>
20 #include <asm/uaccess.h>
23 /*****************************************************************************/
25 * extract the description of a new key from userspace and either add it as a
26 * new key to the specified keyring or update a matching key in that keyring
27 * - the keyring must be writable
28 * - returns the new key's serial number
29 * - implements add_key()
31 asmlinkage long sys_add_key(const char __user *_type,
32 const char __user *_description,
33 const void __user *_payload,
37 key_ref_t keyring_ref, key_ref;
38 char type[32], *description;
46 /* draw all the data into kernel space */
47 ret = strncpy_from_user(type, _type, sizeof(type) - 1);
57 dlen = strnlen_user(_description, PAGE_SIZE - 1);
62 if (dlen > PAGE_SIZE - 1)
66 description = kmalloc(dlen + 1, GFP_KERNEL);
71 if (copy_from_user(description, _description, dlen + 1) != 0)
74 /* pull the payload in if one was supplied */
79 payload = kmalloc(plen, GFP_KERNEL);
84 if (copy_from_user(payload, _payload, plen) != 0)
88 /* find the target keyring (which must be writable) */
89 keyring_ref = lookup_user_key(NULL, ringid, 1, 0, KEY_WRITE);
90 if (IS_ERR(keyring_ref)) {
91 ret = PTR_ERR(keyring_ref);
95 /* create or update the requested key and add it to the target
97 key_ref = key_create_or_update(keyring_ref, type, description,
99 if (!IS_ERR(key_ref)) {
100 ret = key_ref_to_ptr(key_ref)->serial;
101 key_ref_put(key_ref);
104 ret = PTR_ERR(key_ref);
107 key_ref_put(keyring_ref);
115 } /* end sys_add_key() */
117 /*****************************************************************************/
119 * search the process keyrings for a matching key
120 * - nested keyrings may also be searched if they have Search permission
121 * - if a key is found, it will be attached to the destination keyring if
122 * there's one specified
123 * - /sbin/request-key will be invoked if _callout_info is non-NULL
124 * - the _callout_info string will be passed to /sbin/request-key
125 * - if the _callout_info string is empty, it will be rendered as "-"
126 * - implements request_key()
128 asmlinkage long sys_request_key(const char __user *_type,
129 const char __user *_description,
130 const char __user *_callout_info,
131 key_serial_t destringid)
133 struct key_type *ktype;
136 char type[32], *description, *callout_info;
139 /* pull the type into kernel space */
140 ret = strncpy_from_user(type, _type, sizeof(type) - 1);
149 /* pull the description into kernel space */
151 dlen = strnlen_user(_description, PAGE_SIZE - 1);
156 if (dlen > PAGE_SIZE - 1)
160 description = kmalloc(dlen + 1, GFP_KERNEL);
165 if (copy_from_user(description, _description, dlen + 1) != 0)
168 /* pull the callout info into kernel space */
172 dlen = strnlen_user(_callout_info, PAGE_SIZE - 1);
177 if (dlen > PAGE_SIZE - 1)
181 callout_info = kmalloc(dlen + 1, GFP_KERNEL);
186 if (copy_from_user(callout_info, _callout_info, dlen + 1) != 0)
190 /* get the destination keyring if specified */
193 dest_ref = lookup_user_key(NULL, destringid, 1, 0, KEY_WRITE);
194 if (IS_ERR(dest_ref)) {
195 ret = PTR_ERR(dest_ref);
200 /* find the key type */
201 ktype = key_type_lookup(type);
203 ret = PTR_ERR(ktype);
208 key = request_key_and_link(ktype, description, callout_info,
209 key_ref_to_ptr(dest_ref));
221 key_ref_put(dest_ref);
229 } /* end sys_request_key() */
231 /*****************************************************************************/
233 * get the ID of the specified process keyring
234 * - the keyring must have search permission to be found
235 * - implements keyctl(KEYCTL_GET_KEYRING_ID)
237 long keyctl_get_keyring_ID(key_serial_t id, int create)
242 key_ref = lookup_user_key(NULL, id, create, 0, KEY_SEARCH);
243 if (IS_ERR(key_ref)) {
244 ret = PTR_ERR(key_ref);
248 ret = key_ref_to_ptr(key_ref)->serial;
249 key_ref_put(key_ref);
253 } /* end keyctl_get_keyring_ID() */
255 /*****************************************************************************/
257 * join the session keyring
258 * - implements keyctl(KEYCTL_JOIN_SESSION_KEYRING)
260 long keyctl_join_session_keyring(const char __user *_name)
265 /* fetch the name from userspace */
269 nlen = strnlen_user(_name, PAGE_SIZE - 1);
274 if (nlen > PAGE_SIZE - 1)
278 name = kmalloc(nlen + 1, GFP_KERNEL);
283 if (copy_from_user(name, _name, nlen + 1) != 0)
287 /* join the session */
288 ret = join_session_keyring(name);
295 } /* end keyctl_join_session_keyring() */
297 /*****************************************************************************/
299 * update a key's data payload
300 * - the key must be writable
301 * - implements keyctl(KEYCTL_UPDATE)
303 long keyctl_update_key(key_serial_t id,
304 const void __user *_payload,
312 if (plen > PAGE_SIZE)
315 /* pull the payload in if one was supplied */
319 payload = kmalloc(plen, GFP_KERNEL);
324 if (copy_from_user(payload, _payload, plen) != 0)
328 /* find the target key (which must be writable) */
329 key_ref = lookup_user_key(NULL, id, 0, 0, KEY_WRITE);
330 if (IS_ERR(key_ref)) {
331 ret = PTR_ERR(key_ref);
336 ret = key_update(key_ref, payload, plen);
338 key_ref_put(key_ref);
344 } /* end keyctl_update_key() */
346 /*****************************************************************************/
349 * - the key must be writable
350 * - implements keyctl(KEYCTL_REVOKE)
352 long keyctl_revoke_key(key_serial_t id)
357 key_ref = lookup_user_key(NULL, id, 0, 0, KEY_WRITE);
358 if (IS_ERR(key_ref)) {
359 ret = PTR_ERR(key_ref);
363 key_revoke(key_ref_to_ptr(key_ref));
366 key_ref_put(key_ref);
370 } /* end keyctl_revoke_key() */
372 /*****************************************************************************/
374 * clear the specified process keyring
375 * - the keyring must be writable
376 * - implements keyctl(KEYCTL_CLEAR)
378 long keyctl_keyring_clear(key_serial_t ringid)
380 key_ref_t keyring_ref;
383 keyring_ref = lookup_user_key(NULL, ringid, 1, 0, KEY_WRITE);
384 if (IS_ERR(keyring_ref)) {
385 ret = PTR_ERR(keyring_ref);
389 ret = keyring_clear(key_ref_to_ptr(keyring_ref));
391 key_ref_put(keyring_ref);
395 } /* end keyctl_keyring_clear() */
397 /*****************************************************************************/
399 * link a key into a keyring
400 * - the keyring must be writable
401 * - the key must be linkable
402 * - implements keyctl(KEYCTL_LINK)
404 long keyctl_keyring_link(key_serial_t id, key_serial_t ringid)
406 key_ref_t keyring_ref, key_ref;
409 keyring_ref = lookup_user_key(NULL, ringid, 1, 0, KEY_WRITE);
410 if (IS_ERR(keyring_ref)) {
411 ret = PTR_ERR(keyring_ref);
415 key_ref = lookup_user_key(NULL, id, 1, 0, KEY_LINK);
416 if (IS_ERR(key_ref)) {
417 ret = PTR_ERR(key_ref);
421 ret = key_link(key_ref_to_ptr(keyring_ref), key_ref_to_ptr(key_ref));
423 key_ref_put(key_ref);
425 key_ref_put(keyring_ref);
429 } /* end keyctl_keyring_link() */
431 /*****************************************************************************/
433 * unlink the first attachment of a key from a keyring
434 * - the keyring must be writable
435 * - we don't need any permissions on the key
436 * - implements keyctl(KEYCTL_UNLINK)
438 long keyctl_keyring_unlink(key_serial_t id, key_serial_t ringid)
440 key_ref_t keyring_ref, key_ref;
443 keyring_ref = lookup_user_key(NULL, ringid, 0, 0, KEY_WRITE);
444 if (IS_ERR(keyring_ref)) {
445 ret = PTR_ERR(keyring_ref);
449 key_ref = lookup_user_key(NULL, id, 0, 0, 0);
450 if (IS_ERR(key_ref)) {
451 ret = PTR_ERR(key_ref);
455 ret = key_unlink(key_ref_to_ptr(keyring_ref), key_ref_to_ptr(key_ref));
457 key_ref_put(key_ref);
459 key_ref_put(keyring_ref);
463 } /* end keyctl_keyring_unlink() */
465 /*****************************************************************************/
467 * describe a user key
468 * - the key must have view permission
469 * - if there's a buffer, we place up to buflen bytes of data into it
470 * - unless there's an error, we return the amount of description available,
471 * irrespective of how much we may have copied
472 * - the description is formatted thus:
473 * type;uid;gid;perm;description<NUL>
474 * - implements keyctl(KEYCTL_DESCRIBE)
476 long keyctl_describe_key(key_serial_t keyid,
480 struct key *key, *instkey;
485 key_ref = lookup_user_key(NULL, keyid, 0, 1, KEY_VIEW);
486 if (IS_ERR(key_ref)) {
487 /* viewing a key under construction is permitted if we have the
488 * authorisation token handy */
489 if (PTR_ERR(key_ref) == -EACCES) {
490 instkey = key_get_instantiation_authkey(keyid);
491 if (!IS_ERR(instkey)) {
493 key_ref = lookup_user_key(NULL, keyid,
495 if (!IS_ERR(key_ref))
500 ret = PTR_ERR(key_ref);
505 /* calculate how much description we're going to return */
507 tmpbuf = kmalloc(PAGE_SIZE, GFP_KERNEL);
511 key = key_ref_to_ptr(key_ref);
513 ret = snprintf(tmpbuf, PAGE_SIZE - 1,
515 key_ref_to_ptr(key_ref)->type->name,
516 key_ref_to_ptr(key_ref)->uid,
517 key_ref_to_ptr(key_ref)->gid,
518 key_ref_to_ptr(key_ref)->perm,
519 key_ref_to_ptr(key_ref)->description ?
520 key_ref_to_ptr(key_ref)->description : ""
523 /* include a NUL char at the end of the data */
524 if (ret > PAGE_SIZE - 1)
529 /* consider returning the data */
530 if (buffer && buflen > 0) {
534 if (copy_to_user(buffer, tmpbuf, buflen) != 0)
540 key_ref_put(key_ref);
544 } /* end keyctl_describe_key() */
546 /*****************************************************************************/
548 * search the specified keyring for a matching key
549 * - the start keyring must be searchable
550 * - nested keyrings may also be searched if they are searchable
551 * - only keys with search permission may be found
552 * - if a key is found, it will be attached to the destination keyring if
553 * there's one specified
554 * - implements keyctl(KEYCTL_SEARCH)
556 long keyctl_keyring_search(key_serial_t ringid,
557 const char __user *_type,
558 const char __user *_description,
559 key_serial_t destringid)
561 struct key_type *ktype;
562 key_ref_t keyring_ref, key_ref, dest_ref;
563 char type[32], *description;
566 /* pull the type and description into kernel space */
567 ret = strncpy_from_user(type, _type, sizeof(type) - 1);
573 dlen = strnlen_user(_description, PAGE_SIZE - 1);
578 if (dlen > PAGE_SIZE - 1)
582 description = kmalloc(dlen + 1, GFP_KERNEL);
587 if (copy_from_user(description, _description, dlen + 1) != 0)
590 /* get the keyring at which to begin the search */
591 keyring_ref = lookup_user_key(NULL, ringid, 0, 0, KEY_SEARCH);
592 if (IS_ERR(keyring_ref)) {
593 ret = PTR_ERR(keyring_ref);
597 /* get the destination keyring if specified */
600 dest_ref = lookup_user_key(NULL, destringid, 1, 0, KEY_WRITE);
601 if (IS_ERR(dest_ref)) {
602 ret = PTR_ERR(dest_ref);
607 /* find the key type */
608 ktype = key_type_lookup(type);
610 ret = PTR_ERR(ktype);
615 key_ref = keyring_search(keyring_ref, ktype, description);
616 if (IS_ERR(key_ref)) {
617 ret = PTR_ERR(key_ref);
619 /* treat lack or presence of a negative key the same */
625 /* link the resulting key to the destination keyring if we can */
628 if (!key_permission(key_ref, KEY_LINK))
631 ret = key_link(key_ref_to_ptr(dest_ref), key_ref_to_ptr(key_ref));
636 ret = key_ref_to_ptr(key_ref)->serial;
639 key_ref_put(key_ref);
643 key_ref_put(dest_ref);
645 key_ref_put(keyring_ref);
651 } /* end keyctl_keyring_search() */
653 /*****************************************************************************/
655 * read a user key's payload
656 * - the keyring must be readable or the key must be searchable from the
658 * - if there's a buffer, we place up to buflen bytes of data into it
659 * - unless there's an error, we return the amount of data in the key,
660 * irrespective of how much we may have copied
661 * - implements keyctl(KEYCTL_READ)
663 long keyctl_read_key(key_serial_t keyid, char __user *buffer, size_t buflen)
669 /* find the key first */
670 key_ref = lookup_user_key(NULL, keyid, 0, 0, 0);
671 if (IS_ERR(key_ref)) {
676 key = key_ref_to_ptr(key_ref);
678 /* see if we can read it directly */
679 if (key_permission(key_ref, KEY_READ))
682 /* we can't; see if it's searchable from this process's keyrings
683 * - we automatically take account of the fact that it may be
684 * dangling off an instantiation key
686 if (!is_key_possessed(key_ref)) {
691 /* the key is probably readable - now try to read it */
693 ret = key_validate(key);
696 if (key->type->read) {
697 /* read the data with the semaphore held (since we
699 down_read(&key->sem);
700 ret = key->type->read(key, buffer, buflen);
710 } /* end keyctl_read_key() */
712 /*****************************************************************************/
714 * change the ownership of a key
715 * - the keyring owned by the changer
716 * - if the uid or gid is -1, then that parameter is not changed
717 * - implements keyctl(KEYCTL_CHOWN)
719 long keyctl_chown_key(key_serial_t id, uid_t uid, gid_t gid)
726 if (uid == (uid_t) -1 && gid == (gid_t) -1)
729 key_ref = lookup_user_key(NULL, id, 1, 1, 0);
730 if (IS_ERR(key_ref)) {
731 ret = PTR_ERR(key_ref);
735 key = key_ref_to_ptr(key_ref);
737 /* make the changes with the locks held to prevent chown/chown races */
739 down_write(&key->sem);
741 if (!capable(CAP_SYS_ADMIN)) {
742 /* only the sysadmin can chown a key to some other UID */
743 if (uid != (uid_t) -1 && key->uid != uid)
746 /* only the sysadmin can set the key's GID to a group other
747 * than one of those that the current process subscribes to */
748 if (gid != (gid_t) -1 && gid != key->gid && !in_group_p(gid))
752 /* change the UID (have to update the quotas) */
753 if (uid != (uid_t) -1 && uid != key->uid) {
754 /* don't support UID changing yet */
760 if (gid != (gid_t) -1)
771 } /* end keyctl_chown_key() */
773 /*****************************************************************************/
775 * change the permission mask on a key
776 * - the keyring owned by the changer
777 * - implements keyctl(KEYCTL_SETPERM)
779 long keyctl_setperm_key(key_serial_t id, key_perm_t perm)
786 if (perm & ~(KEY_POS_ALL | KEY_USR_ALL | KEY_GRP_ALL | KEY_OTH_ALL))
789 key_ref = lookup_user_key(NULL, id, 1, 1, 0);
790 if (IS_ERR(key_ref)) {
791 ret = PTR_ERR(key_ref);
795 key = key_ref_to_ptr(key_ref);
797 /* make the changes with the locks held to prevent chown/chmod races */
799 down_write(&key->sem);
801 /* if we're not the sysadmin, we can only change a key that we own */
802 if (capable(CAP_SYS_ADMIN) || key->uid == current->fsuid) {
812 } /* end keyctl_setperm_key() */
814 /*****************************************************************************/
816 * instantiate the key with the specified payload, and, if one is given, link
817 * the key into the keyring
819 long keyctl_instantiate_key(key_serial_t id,
820 const void __user *_payload,
824 struct request_key_auth *rka;
826 key_ref_t keyring_ref;
834 /* pull the payload in if one was supplied */
839 payload = kmalloc(plen, GFP_KERNEL);
844 if (copy_from_user(payload, _payload, plen) != 0)
848 /* find the instantiation authorisation key */
849 instkey = key_get_instantiation_authkey(id);
850 if (IS_ERR(instkey)) {
851 ret = PTR_ERR(instkey);
855 rka = instkey->payload.data;
857 /* find the destination keyring amongst those belonging to the
861 keyring_ref = lookup_user_key(rka->context, ringid, 1, 0,
863 if (IS_ERR(keyring_ref)) {
864 ret = PTR_ERR(keyring_ref);
869 /* instantiate the key and link it into a keyring */
870 ret = key_instantiate_and_link(rka->target_key, payload, plen,
871 key_ref_to_ptr(keyring_ref), instkey);
873 key_ref_put(keyring_ref);
881 } /* end keyctl_instantiate_key() */
883 /*****************************************************************************/
885 * negatively instantiate the key with the given timeout (in seconds), and, if
886 * one is given, link the key into the keyring
888 long keyctl_negate_key(key_serial_t id, unsigned timeout, key_serial_t ringid)
890 struct request_key_auth *rka;
892 key_ref_t keyring_ref;
895 /* find the instantiation authorisation key */
896 instkey = key_get_instantiation_authkey(id);
897 if (IS_ERR(instkey)) {
898 ret = PTR_ERR(instkey);
902 rka = instkey->payload.data;
904 /* find the destination keyring if present (which must also be
908 keyring_ref = lookup_user_key(NULL, ringid, 1, 0, KEY_WRITE);
909 if (IS_ERR(keyring_ref)) {
910 ret = PTR_ERR(keyring_ref);
915 /* instantiate the key and link it into a keyring */
916 ret = key_negate_and_link(rka->target_key, timeout,
917 key_ref_to_ptr(keyring_ref), instkey);
919 key_ref_put(keyring_ref);
925 } /* end keyctl_negate_key() */
927 /*****************************************************************************/
929 * set the default keyring in which request_key() will cache keys
930 * - return the old setting
932 long keyctl_set_reqkey_keyring(int reqkey_defl)
936 switch (reqkey_defl) {
937 case KEY_REQKEY_DEFL_THREAD_KEYRING:
938 ret = install_thread_keyring(current);
943 case KEY_REQKEY_DEFL_PROCESS_KEYRING:
944 ret = install_process_keyring(current);
948 case KEY_REQKEY_DEFL_DEFAULT:
949 case KEY_REQKEY_DEFL_SESSION_KEYRING:
950 case KEY_REQKEY_DEFL_USER_KEYRING:
951 case KEY_REQKEY_DEFL_USER_SESSION_KEYRING:
953 current->jit_keyring = reqkey_defl;
955 case KEY_REQKEY_DEFL_NO_CHANGE:
956 return current->jit_keyring;
958 case KEY_REQKEY_DEFL_GROUP_KEYRING:
963 } /* end keyctl_set_reqkey_keyring() */
965 /*****************************************************************************/
967 * the key control system call
969 asmlinkage long sys_keyctl(int option, unsigned long arg2, unsigned long arg3,
970 unsigned long arg4, unsigned long arg5)
973 case KEYCTL_GET_KEYRING_ID:
974 return keyctl_get_keyring_ID((key_serial_t) arg2,
977 case KEYCTL_JOIN_SESSION_KEYRING:
978 return keyctl_join_session_keyring((const char __user *) arg2);
981 return keyctl_update_key((key_serial_t) arg2,
982 (const void __user *) arg3,
986 return keyctl_revoke_key((key_serial_t) arg2);
988 case KEYCTL_DESCRIBE:
989 return keyctl_describe_key((key_serial_t) arg2,
990 (char __user *) arg3,
994 return keyctl_keyring_clear((key_serial_t) arg2);
997 return keyctl_keyring_link((key_serial_t) arg2,
998 (key_serial_t) arg3);
1001 return keyctl_keyring_unlink((key_serial_t) arg2,
1002 (key_serial_t) arg3);
1005 return keyctl_keyring_search((key_serial_t) arg2,
1006 (const char __user *) arg3,
1007 (const char __user *) arg4,
1008 (key_serial_t) arg5);
1011 return keyctl_read_key((key_serial_t) arg2,
1012 (char __user *) arg3,
1016 return keyctl_chown_key((key_serial_t) arg2,
1020 case KEYCTL_SETPERM:
1021 return keyctl_setperm_key((key_serial_t) arg2,
1024 case KEYCTL_INSTANTIATE:
1025 return keyctl_instantiate_key((key_serial_t) arg2,
1026 (const void __user *) arg3,
1028 (key_serial_t) arg5);
1031 return keyctl_negate_key((key_serial_t) arg2,
1033 (key_serial_t) arg4);
1035 case KEYCTL_SET_REQKEY_KEYRING:
1036 return keyctl_set_reqkey_keyring(arg2);
1042 } /* end sys_keyctl() */