1 /* keyring.c: keyring handling
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/seq_file.h>
17 #include <linux/err.h>
18 #include <asm/uaccess.h>
22 * when plumbing the depths of the key tree, this sets a hard limit set on how
23 * deep we're willing to go
25 #define KEYRING_SEARCH_MAX_DEPTH 6
28 * we keep all named keyrings in a hash to speed looking them up
30 #define KEYRING_NAME_HASH_SIZE (1 << 5)
32 static struct list_head keyring_name_hash
[KEYRING_NAME_HASH_SIZE
];
33 static DEFINE_RWLOCK(keyring_name_lock
);
35 static inline unsigned keyring_hash(const char *desc
)
40 bucket
+= (unsigned char) *desc
;
42 return bucket
& (KEYRING_NAME_HASH_SIZE
- 1);
46 * the keyring type definition
48 static int keyring_instantiate(struct key
*keyring
,
49 const void *data
, size_t datalen
);
50 static int keyring_duplicate(struct key
*keyring
, const struct key
*source
);
51 static int keyring_match(const struct key
*keyring
, const void *criterion
);
52 static void keyring_destroy(struct key
*keyring
);
53 static void keyring_describe(const struct key
*keyring
, struct seq_file
*m
);
54 static long keyring_read(const struct key
*keyring
,
55 char __user
*buffer
, size_t buflen
);
57 struct key_type key_type_keyring
= {
59 .def_datalen
= sizeof(struct keyring_list
),
60 .instantiate
= keyring_instantiate
,
61 .duplicate
= keyring_duplicate
,
62 .match
= keyring_match
,
63 .destroy
= keyring_destroy
,
64 .describe
= keyring_describe
,
69 * semaphore to serialise link/link calls to prevent two link calls in parallel
72 DECLARE_RWSEM(keyring_serialise_link_sem
);
74 /*****************************************************************************/
76 * publish the name of a keyring so that it can be found by name (if it has
79 void keyring_publish_name(struct key
*keyring
)
83 if (keyring
->description
) {
84 bucket
= keyring_hash(keyring
->description
);
86 write_lock(&keyring_name_lock
);
88 if (!keyring_name_hash
[bucket
].next
)
89 INIT_LIST_HEAD(&keyring_name_hash
[bucket
]);
91 list_add_tail(&keyring
->type_data
.link
,
92 &keyring_name_hash
[bucket
]);
94 write_unlock(&keyring_name_lock
);
97 } /* end keyring_publish_name() */
99 /*****************************************************************************/
101 * initialise a keyring
102 * - we object if we were given any data
104 static int keyring_instantiate(struct key
*keyring
,
105 const void *data
, size_t datalen
)
111 /* make the keyring available by name if it has one */
112 keyring_publish_name(keyring
);
118 } /* end keyring_instantiate() */
120 /*****************************************************************************/
122 * duplicate the list of subscribed keys from a source keyring into this one
124 static int keyring_duplicate(struct key
*keyring
, const struct key
*source
)
126 struct keyring_list
*sklist
, *klist
;
131 const unsigned limit
=
132 (PAGE_SIZE
- sizeof(*klist
)) / sizeof(struct key
);
136 /* find out how many keys are currently linked */
138 sklist
= rcu_dereference(source
->payload
.subscriptions
);
144 /* allocate a new payload and stuff load with key links */
148 max
= (max
+ 3) & ~3;
153 size
= sizeof(*klist
) + sizeof(struct key
) * max
;
154 klist
= kmalloc(size
, GFP_KERNEL
);
160 sklist
= rcu_dereference(source
->payload
.subscriptions
);
162 klist
->maxkeys
= max
;
163 klist
->nkeys
= sklist
->nkeys
;
166 sklist
->nkeys
* sizeof(struct key
));
168 for (loop
= klist
->nkeys
- 1; loop
>= 0; loop
--)
169 atomic_inc(&klist
->keys
[loop
]->usage
);
173 rcu_assign_pointer(keyring
->payload
.subscriptions
, klist
);
180 } /* end keyring_duplicate() */
182 /*****************************************************************************/
184 * match keyrings on their name
186 static int keyring_match(const struct key
*keyring
, const void *description
)
188 return keyring
->description
&&
189 strcmp(keyring
->description
, description
) == 0;
191 } /* end keyring_match() */
193 /*****************************************************************************/
195 * dispose of the data dangling from the corpse of a keyring
197 static void keyring_destroy(struct key
*keyring
)
199 struct keyring_list
*klist
;
202 if (keyring
->description
) {
203 write_lock(&keyring_name_lock
);
204 list_del(&keyring
->type_data
.link
);
205 write_unlock(&keyring_name_lock
);
208 klist
= rcu_dereference(keyring
->payload
.subscriptions
);
210 for (loop
= klist
->nkeys
- 1; loop
>= 0; loop
--)
211 key_put(klist
->keys
[loop
]);
215 } /* end keyring_destroy() */
217 /*****************************************************************************/
219 * describe the keyring
221 static void keyring_describe(const struct key
*keyring
, struct seq_file
*m
)
223 struct keyring_list
*klist
;
225 if (keyring
->description
) {
226 seq_puts(m
, keyring
->description
);
229 seq_puts(m
, "[anon]");
233 klist
= rcu_dereference(keyring
->payload
.subscriptions
);
235 seq_printf(m
, ": %u/%u", klist
->nkeys
, klist
->maxkeys
);
237 seq_puts(m
, ": empty");
240 } /* end keyring_describe() */
242 /*****************************************************************************/
244 * read a list of key IDs from the keyring's contents
245 * - the keyring's semaphore is read-locked
247 static long keyring_read(const struct key
*keyring
,
248 char __user
*buffer
, size_t buflen
)
250 struct keyring_list
*klist
;
256 klist
= rcu_dereference(keyring
->payload
.subscriptions
);
259 /* calculate how much data we could return */
260 qty
= klist
->nkeys
* sizeof(key_serial_t
);
262 if (buffer
&& buflen
> 0) {
266 /* copy the IDs of the subscribed keys into the
270 for (loop
= 0; loop
< klist
->nkeys
; loop
++) {
271 key
= klist
->keys
[loop
];
273 tmp
= sizeof(key_serial_t
);
277 if (copy_to_user(buffer
,
295 } /* end keyring_read() */
297 /*****************************************************************************/
299 * allocate a keyring and link into the destination keyring
301 struct key
*keyring_alloc(const char *description
, uid_t uid
, gid_t gid
,
302 int not_in_quota
, struct key
*dest
)
307 keyring
= key_alloc(&key_type_keyring
, description
,
308 uid
, gid
, KEY_USR_ALL
, not_in_quota
);
310 if (!IS_ERR(keyring
)) {
311 ret
= key_instantiate_and_link(keyring
, NULL
, 0, dest
, NULL
);
314 keyring
= ERR_PTR(ret
);
320 } /* end keyring_alloc() */
322 /*****************************************************************************/
324 * search the supplied keyring tree for a key that matches the criterion
325 * - perform a breadth-then-depth search up to the prescribed limit
326 * - we only find keys on which we have search permission
327 * - we use the supplied match function to see if the description (or other
328 * feature of interest) matches
329 * - we rely on RCU to prevent the keyring lists from disappearing on us
330 * - we return -EAGAIN if we didn't find any matching key
331 * - we return -ENOKEY if we only found negative matching keys
333 struct key
*keyring_search_aux(struct key
*keyring
,
334 struct task_struct
*context
,
335 struct key_type
*type
,
336 const void *description
,
337 key_match_func_t match
)
340 struct keyring_list
*keylist
;
342 } stack
[KEYRING_SEARCH_MAX_DEPTH
];
344 struct keyring_list
*keylist
;
354 /* top keyring must have search permission to begin the search */
355 key
= ERR_PTR(-EACCES
);
356 if (!key_task_permission(keyring
, context
, KEY_SEARCH
))
359 key
= ERR_PTR(-ENOTDIR
);
360 if (keyring
->type
!= &key_type_keyring
)
363 now
= current_kernel_time();
367 /* start processing a new keyring */
369 if (test_bit(KEY_FLAG_REVOKED
, &keyring
->flags
))
370 goto not_this_keyring
;
372 keylist
= rcu_dereference(keyring
->payload
.subscriptions
);
374 goto not_this_keyring
;
376 /* iterate through the keys in this keyring first */
377 for (kix
= 0; kix
< keylist
->nkeys
; kix
++) {
378 key
= keylist
->keys
[kix
];
380 /* ignore keys not of this type */
381 if (key
->type
!= type
)
384 /* skip revoked keys and expired keys */
385 if (test_bit(KEY_FLAG_REVOKED
, &key
->flags
))
388 if (key
->expiry
&& now
.tv_sec
>= key
->expiry
)
391 /* keys that don't match */
392 if (!match(key
, description
))
395 /* key must have search permissions */
396 if (!key_task_permission(key
, context
, KEY_SEARCH
))
399 /* we set a different error code if we find a negative key */
400 if (test_bit(KEY_FLAG_NEGATIVE
, &key
->flags
)) {
408 /* search through the keyrings nested in this one */
411 for (; kix
< keylist
->nkeys
; kix
++) {
412 key
= keylist
->keys
[kix
];
413 if (key
->type
!= &key_type_keyring
)
416 /* recursively search nested keyrings
417 * - only search keyrings for which we have search permission
419 if (sp
>= KEYRING_SEARCH_MAX_DEPTH
)
422 if (!key_task_permission(key
, context
, KEY_SEARCH
))
425 /* stack the current position */
426 stack
[sp
].keylist
= keylist
;
430 /* begin again with the new keyring */
435 /* the keyring we're looking at was disqualified or didn't contain a
439 /* resume the processing of a keyring higher up in the tree */
441 keylist
= stack
[sp
].keylist
;
442 kix
= stack
[sp
].kix
+ 1;
449 /* we found a viable match */
451 atomic_inc(&key
->usage
);
457 } /* end keyring_search_aux() */
459 /*****************************************************************************/
461 * search the supplied keyring tree for a key that matches the criterion
462 * - perform a breadth-then-depth search up to the prescribed limit
463 * - we only find keys on which we have search permission
464 * - we readlock the keyrings as we search down the tree
465 * - we return -EAGAIN if we didn't find any matching key
466 * - we return -ENOKEY if we only found negative matching keys
468 struct key
*keyring_search(struct key
*keyring
,
469 struct key_type
*type
,
470 const char *description
)
473 return ERR_PTR(-ENOKEY
);
475 return keyring_search_aux(keyring
, current
,
476 type
, description
, type
->match
);
478 } /* end keyring_search() */
480 EXPORT_SYMBOL(keyring_search
);
482 /*****************************************************************************/
484 * search the given keyring only (no recursion)
485 * - keyring must be locked by caller
487 struct key
*__keyring_search_one(struct key
*keyring
,
488 const struct key_type
*ktype
,
489 const char *description
,
492 struct keyring_list
*klist
;
498 klist
= rcu_dereference(keyring
->payload
.subscriptions
);
500 for (loop
= 0; loop
< klist
->nkeys
; loop
++) {
501 key
= klist
->keys
[loop
];
503 if (key
->type
== ktype
&&
504 (!key
->type
->match
||
505 key
->type
->match(key
, description
)) &&
506 key_permission(key
, perm
) &&
507 !test_bit(KEY_FLAG_REVOKED
, &key
->flags
)
513 key
= ERR_PTR(-ENOKEY
);
517 atomic_inc(&key
->usage
);
522 } /* end __keyring_search_one() */
524 /*****************************************************************************/
526 * search for an instantiation authorisation key matching a target key
527 * - the RCU read lock must be held by the caller
528 * - a target_id of zero specifies any valid token
530 struct key
*keyring_search_instkey(struct key
*keyring
,
531 key_serial_t target_id
)
533 struct request_key_auth
*rka
;
534 struct keyring_list
*klist
;
538 klist
= rcu_dereference(keyring
->payload
.subscriptions
);
540 for (loop
= 0; loop
< klist
->nkeys
; loop
++) {
541 instkey
= klist
->keys
[loop
];
543 if (instkey
->type
!= &key_type_request_key_auth
)
546 rka
= instkey
->payload
.data
;
547 if (target_id
&& rka
->target_key
->serial
!= target_id
)
550 /* the auth key is revoked during instantiation */
551 if (!test_bit(KEY_FLAG_REVOKED
, &instkey
->flags
))
554 instkey
= ERR_PTR(-EKEYREVOKED
);
559 instkey
= ERR_PTR(-EACCES
);
563 atomic_inc(&instkey
->usage
);
567 } /* end keyring_search_instkey() */
569 /*****************************************************************************/
571 * find a keyring with the specified name
572 * - all named keyrings are searched
573 * - only find keyrings with search permission for the process
574 * - only find keyrings with a serial number greater than the one specified
576 struct key
*find_keyring_by_name(const char *name
, key_serial_t bound
)
581 keyring
= ERR_PTR(-EINVAL
);
585 bucket
= keyring_hash(name
);
587 read_lock(&keyring_name_lock
);
589 if (keyring_name_hash
[bucket
].next
) {
590 /* search this hash bucket for a keyring with a matching name
591 * that's readable and that hasn't been revoked */
592 list_for_each_entry(keyring
,
593 &keyring_name_hash
[bucket
],
596 if (test_bit(KEY_FLAG_REVOKED
, &keyring
->flags
))
599 if (strcmp(keyring
->description
, name
) != 0)
602 if (!key_permission(keyring
, KEY_SEARCH
))
605 /* found a potential candidate, but we still need to
606 * check the serial number */
607 if (keyring
->serial
<= bound
)
610 /* we've got a match */
611 atomic_inc(&keyring
->usage
);
612 read_unlock(&keyring_name_lock
);
617 read_unlock(&keyring_name_lock
);
618 keyring
= ERR_PTR(-ENOKEY
);
623 } /* end find_keyring_by_name() */
625 /*****************************************************************************/
627 * see if a cycle will will be created by inserting acyclic tree B in acyclic
628 * tree A at the topmost level (ie: as a direct child of A)
629 * - since we are adding B to A at the top level, checking for cycles should
630 * just be a matter of seeing if node A is somewhere in tree B
632 static int keyring_detect_cycle(struct key
*A
, struct key
*B
)
635 struct keyring_list
*keylist
;
637 } stack
[KEYRING_SEARCH_MAX_DEPTH
];
639 struct keyring_list
*keylist
;
640 struct key
*subtree
, *key
;
652 /* start processing a new keyring */
654 if (test_bit(KEY_FLAG_REVOKED
, &subtree
->flags
))
655 goto not_this_keyring
;
657 keylist
= rcu_dereference(subtree
->payload
.subscriptions
);
659 goto not_this_keyring
;
663 /* iterate through the remaining keys in this keyring */
664 for (; kix
< keylist
->nkeys
; kix
++) {
665 key
= keylist
->keys
[kix
];
670 /* recursively check nested keyrings */
671 if (key
->type
== &key_type_keyring
) {
672 if (sp
>= KEYRING_SEARCH_MAX_DEPTH
)
675 /* stack the current position */
676 stack
[sp
].keylist
= keylist
;
680 /* begin again with the new keyring */
686 /* the keyring we're looking at was disqualified or didn't contain a
690 /* resume the checking of a keyring higher up in the tree */
692 keylist
= stack
[sp
].keylist
;
693 kix
= stack
[sp
].kix
+ 1;
697 ret
= 0; /* no cycles detected */
711 } /* end keyring_detect_cycle() */
713 /*****************************************************************************/
715 * dispose of a keyring list after the RCU grace period
717 static void keyring_link_rcu_disposal(struct rcu_head
*rcu
)
719 struct keyring_list
*klist
=
720 container_of(rcu
, struct keyring_list
, rcu
);
724 } /* end keyring_link_rcu_disposal() */
726 /*****************************************************************************/
728 * link a key into to a keyring
729 * - must be called with the keyring's semaphore write-locked
731 int __key_link(struct key
*keyring
, struct key
*key
)
733 struct keyring_list
*klist
, *nklist
;
739 if (test_bit(KEY_FLAG_REVOKED
, &keyring
->flags
))
743 if (keyring
->type
!= &key_type_keyring
)
746 /* serialise link/link calls to prevent parallel calls causing a
747 * cycle when applied to two keyring in opposite orders */
748 down_write(&keyring_serialise_link_sem
);
750 /* check that we aren't going to create a cycle adding one keyring to
752 if (key
->type
== &key_type_keyring
) {
753 ret
= keyring_detect_cycle(keyring
, key
);
758 /* check that we aren't going to overrun the user's quota */
759 ret
= key_payload_reserve(keyring
,
760 keyring
->datalen
+ KEYQUOTA_LINK_BYTES
);
764 klist
= keyring
->payload
.subscriptions
;
766 if (klist
&& klist
->nkeys
< klist
->maxkeys
) {
767 /* there's sufficient slack space to add directly */
768 atomic_inc(&key
->usage
);
770 klist
->keys
[klist
->nkeys
] = key
;
778 /* grow the key list */
781 max
+= klist
->maxkeys
;
786 size
= sizeof(*klist
) + sizeof(*key
) * max
;
787 if (size
> PAGE_SIZE
)
791 nklist
= kmalloc(size
, GFP_KERNEL
);
794 nklist
->maxkeys
= max
;
798 nklist
->nkeys
= klist
->nkeys
;
801 sizeof(struct key
*) * klist
->nkeys
);
804 /* add the key into the new space */
805 atomic_inc(&key
->usage
);
806 nklist
->keys
[nklist
->nkeys
++] = key
;
808 rcu_assign_pointer(keyring
->payload
.subscriptions
, nklist
);
810 /* dispose of the old keyring list */
812 call_rcu(&klist
->rcu
, keyring_link_rcu_disposal
);
818 up_write(&keyring_serialise_link_sem
);
823 /* undo the quota changes */
824 key_payload_reserve(keyring
,
825 keyring
->datalen
- KEYQUOTA_LINK_BYTES
);
828 } /* end __key_link() */
830 /*****************************************************************************/
832 * link a key to a keyring
834 int key_link(struct key
*keyring
, struct key
*key
)
841 down_write(&keyring
->sem
);
842 ret
= __key_link(keyring
, key
);
843 up_write(&keyring
->sem
);
847 } /* end key_link() */
849 EXPORT_SYMBOL(key_link
);
851 /*****************************************************************************/
853 * dispose of a keyring list after the RCU grace period, freeing the unlinked
856 static void keyring_unlink_rcu_disposal(struct rcu_head
*rcu
)
858 struct keyring_list
*klist
=
859 container_of(rcu
, struct keyring_list
, rcu
);
861 key_put(klist
->keys
[klist
->delkey
]);
864 } /* end keyring_unlink_rcu_disposal() */
866 /*****************************************************************************/
868 * unlink the first link to a key from a keyring
870 int key_unlink(struct key
*keyring
, struct key
*key
)
872 struct keyring_list
*klist
, *nklist
;
879 if (keyring
->type
!= &key_type_keyring
)
882 down_write(&keyring
->sem
);
884 klist
= keyring
->payload
.subscriptions
;
886 /* search the keyring for the key */
887 for (loop
= 0; loop
< klist
->nkeys
; loop
++)
888 if (klist
->keys
[loop
] == key
)
892 up_write(&keyring
->sem
);
897 /* we need to copy the key list for RCU purposes */
898 nklist
= kmalloc(sizeof(*klist
) + sizeof(*key
) * klist
->maxkeys
,
902 nklist
->maxkeys
= klist
->maxkeys
;
903 nklist
->nkeys
= klist
->nkeys
- 1;
906 memcpy(&nklist
->keys
[0],
908 loop
* sizeof(klist
->keys
[0]));
910 if (loop
< nklist
->nkeys
)
911 memcpy(&nklist
->keys
[loop
],
912 &klist
->keys
[loop
+ 1],
913 (nklist
->nkeys
- loop
) * sizeof(klist
->keys
[0]));
915 /* adjust the user's quota */
916 key_payload_reserve(keyring
,
917 keyring
->datalen
- KEYQUOTA_LINK_BYTES
);
919 rcu_assign_pointer(keyring
->payload
.subscriptions
, nklist
);
921 up_write(&keyring
->sem
);
923 /* schedule for later cleanup */
924 klist
->delkey
= loop
;
925 call_rcu(&klist
->rcu
, keyring_unlink_rcu_disposal
);
933 up_write(&keyring
->sem
);
936 } /* end key_unlink() */
938 EXPORT_SYMBOL(key_unlink
);
940 /*****************************************************************************/
942 * dispose of a keyring list after the RCU grace period, releasing the keys it
945 static void keyring_clear_rcu_disposal(struct rcu_head
*rcu
)
947 struct keyring_list
*klist
;
950 klist
= container_of(rcu
, struct keyring_list
, rcu
);
952 for (loop
= klist
->nkeys
- 1; loop
>= 0; loop
--)
953 key_put(klist
->keys
[loop
]);
957 } /* end keyring_clear_rcu_disposal() */
959 /*****************************************************************************/
961 * clear the specified process keyring
962 * - implements keyctl(KEYCTL_CLEAR)
964 int keyring_clear(struct key
*keyring
)
966 struct keyring_list
*klist
;
970 if (keyring
->type
== &key_type_keyring
) {
971 /* detach the pointer block with the locks held */
972 down_write(&keyring
->sem
);
974 klist
= keyring
->payload
.subscriptions
;
976 /* adjust the quota */
977 key_payload_reserve(keyring
,
978 sizeof(struct keyring_list
));
980 rcu_assign_pointer(keyring
->payload
.subscriptions
,
984 up_write(&keyring
->sem
);
986 /* free the keys after the locks have been dropped */
988 call_rcu(&klist
->rcu
, keyring_clear_rcu_disposal
);
995 } /* end keyring_clear() */
997 EXPORT_SYMBOL(keyring_clear
);