2 /* Basic authentication token and access key management
26 unsigned int key_quota_root_maxkeys = 1000000;	/* root's key count quota */
27 unsigned int key_quota_root_maxbytes = 25000000; /* root's key space quota */
28 unsigned int key_quota_maxkeys = 200;		/* general key count quota */
29 unsigned int key_quota_maxbytes = 20000;	/* general key space quota */
34 /* We serialise key instantiation and link */
38 void __key_check(const struct key *key)  in __key_check()  argument
40 	printk("__key_check: key %p {%08x} should be {%08x}\n",  in __key_check()
41 	       key, key->magic, KEY_DEBUG_MAGIC);  in __key_check()
47  * Get the key quota record for a user, allocating a new record if one doesn't
130  * Allocate a serial number for a key.  These are assigned randomly to avoid
133 static inline void key_alloc_serial(struct key *key)  in key_alloc_serial()  argument
136 	struct key *xkey;  in key_alloc_serial()
141 		get_random_bytes(&key->serial, sizeof(key->serial));  in key_alloc_serial()
143 		key->serial >>= 1; /* negative numbers are not permitted */  in key_alloc_serial()
144 	} while (key->serial < 3);  in key_alloc_serial()
154 		xkey = rb_entry(parent, struct key, serial_node);  in key_alloc_serial()
156 		if (key->serial < xkey->serial)  in key_alloc_serial()
158 		else if (key->serial > xkey->serial)  in key_alloc_serial()
164 	/* we've found a suitable hole - arrange for this key to occupy it */  in key_alloc_serial()
165 	rb_link_node(&key->serial_node, parent, p);  in key_alloc_serial()
166 	rb_insert_color(&key->serial_node, &key_serial_tree);  in key_alloc_serial()
171 	/* we found a key with the proposed serial number - walk the tree from  in key_alloc_serial()
175 		key->serial++;  in key_alloc_serial()
176 		if (key->serial < 3) {  in key_alloc_serial()
177 			key->serial = 3;  in key_alloc_serial()
185 		xkey = rb_entry(parent, struct key, serial_node);  in key_alloc_serial()
186 		if (key->serial < xkey->serial)  in key_alloc_serial()
192  * key_alloc - Allocate a key of the specified type.
193  * @type: The type of key to allocate.
194  * @desc: The key description to allow the key to be searched out.
195  * @uid: The owner of the new key.
196  * @gid: The group ID for the new key's group permissions.
198  * @perm: The permissions mask of the new key.
202  * Allocate a key of the specified type with the attributes given.  The key is
204  * key before returning.
209  * The user's key count quota is updated to reflect the creation of the key and
210  * the user's key data quota has the default for the key type reserved.  The
214  * The LSM security modules can prevent a key being created, in which case
217  * Returns a pointer to the new key if successful and an error code otherwise.
219  * Note that the caller needs to ensure the key type isn't uninstantiated.
221  * be done by either never unregistering the key type, or making sure
224 struct key *key_alloc(struct key_type *type, const char *desc,  in key_alloc()
230 	struct key *key;  in key_alloc()  local
235 	key = ERR_PTR(-EINVAL);  in key_alloc()
242 			key = ERR_PTR(ret);  in key_alloc()
250 	/* get hold of the key tracking for this user */  in key_alloc()
255 	/* check that the user's quota permits allocation of another key and  in key_alloc()
276 	/* allocate and initialise the key and its description */  in key_alloc()
277 	key = kmem_cache_zalloc(key_jar, GFP_KERNEL);  in key_alloc()
278 	if (!key)  in key_alloc()
281 	key->index_key.desc_len = desclen;  in key_alloc()
282 	key->index_key.description = kmemdup(desc, desclen + 1, GFP_KERNEL);  in key_alloc()
283 	if (!key->index_key.description)  in key_alloc()
285 	key->index_key.type = type;  in key_alloc()
286 	key_set_index_key(&key->index_key);  in key_alloc()
288 	refcount_set(&key->usage, 1);  in key_alloc()
289 	init_rwsem(&key->sem);  in key_alloc()
290 	lockdep_set_class(&key->sem, &type->lock_class);  in key_alloc()
291 	key->user = user;  in key_alloc()
292 	key->quotalen = quotalen;  in key_alloc()
293 	key->datalen = type->def_datalen;  in key_alloc()
294 	key->uid = uid;  in key_alloc()
295 	key->gid = gid;  in key_alloc()
296 	key->perm = perm;  in key_alloc()
297 	key->expiry = TIME64_MAX;  in key_alloc()
298 	key->restrict_link = restrict_link;  in key_alloc()
299 	key->last_used_at = ktime_get_real_seconds();  in key_alloc()
301 	key->flags |= 1 << KEY_FLAG_USER_ALIVE;  in key_alloc()
303 		key->flags |= 1 << KEY_FLAG_IN_QUOTA;  in key_alloc()
305 		key->flags |= 1 << KEY_FLAG_BUILTIN;  in key_alloc()
307 		key->flags |= 1 << KEY_FLAG_UID_KEYRING;  in key_alloc()
309 		key->flags |= 1 << KEY_FLAG_KEEP;  in key_alloc()
312 	key->magic = KEY_DEBUG_MAGIC;  in key_alloc()
315 	/* let the security module know about the key */  in key_alloc()
316 	ret = security_key_alloc(key, cred, flags);  in key_alloc()
320 	/* publish the key by giving it a serial number */  in key_alloc()
321 	refcount_inc(&key->domain_tag->usage);  in key_alloc()
323 	key_alloc_serial(key);  in key_alloc()
326 	return key;  in key_alloc()
329 	kfree(key->description);  in key_alloc()
330 	kmem_cache_free(key_jar, key);  in key_alloc()
338 	key = ERR_PTR(ret);  in key_alloc()
342 	kmem_cache_free(key_jar, key);  in key_alloc()
352 	key = ERR_PTR(-ENOMEM);  in key_alloc()
358 	key = ERR_PTR(-EDQUOT);  in key_alloc()
364  * key_payload_reserve - Adjust data quota reservation for the key's payload
365  * @key: The key to make the reservation for.
368  * Adjust the amount of the owning user's key data quota that a key reserves.
374 int key_payload_reserve(struct key *key, size_t datalen)  in key_payload_reserve()  argument
376 	int delta = (int)datalen - key->datalen;  in key_payload_reserve()
379 	key_check(key);  in key_payload_reserve()
382 	if (delta != 0 && test_bit(KEY_FLAG_IN_QUOTA, &key->flags)) {  in key_payload_reserve()
383 		unsigned maxbytes = uid_eq(key->user->uid, GLOBAL_ROOT_UID) ?  in key_payload_reserve()
387 		spin_lock_irqsave(&key->user->lock, flags);  in key_payload_reserve()
390 		    (key->user->qnbytes + delta > maxbytes ||  in key_payload_reserve()
391 		     key->user->qnbytes + delta < key->user->qnbytes)) {  in key_payload_reserve()
395 			key->user->qnbytes += delta;  in key_payload_reserve()
396 			key->quotalen += delta;  in key_payload_reserve()
398 		spin_unlock_irqrestore(&key->user->lock, flags);  in key_payload_reserve()
403 		key->datalen = datalen;  in key_payload_reserve()
410  * Change the key state to being instantiated.
412 static void mark_key_instantiated(struct key *key, int reject_error)  in mark_key_instantiated()  argument
417 	smp_store_release(&key->state,  in mark_key_instantiated()
422  * Instantiate a key and link it into the target keyring atomically.  Must be
423  * called with the target keyring's semaphore writelocked.  The target key's
427 static int __key_instantiate_and_link(struct key *key,  in __key_instantiate_and_link()  argument
429 				      struct key *keyring,  in __key_instantiate_and_link()
430 				      struct key *authkey,  in __key_instantiate_and_link()
435 	key_check(key);  in __key_instantiate_and_link()
444 	if (key->state == KEY_IS_UNINSTANTIATED) {  in __key_instantiate_and_link()
445 		/* instantiate the key */  in __key_instantiate_and_link()
446 		ret = key->type->instantiate(key, prep);  in __key_instantiate_and_link()
449 			/* mark the key as being instantiated */  in __key_instantiate_and_link()
450 			atomic_inc(&key->user->nikeys);  in __key_instantiate_and_link()
451 			mark_key_instantiated(key, 0);  in __key_instantiate_and_link()
452 			notify_key(key, NOTIFY_KEY_INSTANTIATED, 0);  in __key_instantiate_and_link()
454 			if (test_and_clear_bit(KEY_FLAG_USER_CONSTRUCT, &key->flags))  in __key_instantiate_and_link()
460 					set_bit(KEY_FLAG_KEEP, &key->flags);  in __key_instantiate_and_link()
462 				__key_link(keyring, key, _edit);  in __key_instantiate_and_link()
465 			/* disable the authorisation key */  in __key_instantiate_and_link()
470 				key_set_expiry(key, prep->expiry);  in __key_instantiate_and_link()
476 	/* wake up anyone waiting for a key to be constructed */  in __key_instantiate_and_link()
478 		wake_up_bit(&key->flags, KEY_FLAG_USER_CONSTRUCT);  in __key_instantiate_and_link()
484  * key_instantiate_and_link - Instantiate a key and link it into the keyring.
485  * @key: The key to instantiate.
491  * Instantiate a key that's in the uninstantiated state using the provided data
496  * waiting for the key is woken up.  If the key was already instantiated,
499 int key_instantiate_and_link(struct key *key,  in key_instantiate_and_link()  argument
502 			     struct key *keyring,  in key_instantiate_and_link()
503 			     struct key *authkey)  in key_instantiate_and_link()
510 	prep.orig_description = key->description;  in key_instantiate_and_link()
513 	prep.quotalen = key->type->def_datalen;  in key_instantiate_and_link()
515 	if (key->type->preparse) {  in key_instantiate_and_link()
516 		ret = key->type->preparse(&prep);  in key_instantiate_and_link()
522 		ret = __key_link_lock(keyring, &key->index_key);  in key_instantiate_and_link()
526 		ret = __key_link_begin(keyring, &key->index_key, &edit);  in key_instantiate_and_link()
533 			ret = keyres->check(keyring, key->type, &prep.payload,  in key_instantiate_and_link()
534 					    keyres->key);  in key_instantiate_and_link()
540 	ret = __key_instantiate_and_link(key, &prep, keyring, authkey, &edit);  in key_instantiate_and_link()
544 		__key_link_end(keyring, &key->index_key, edit);  in key_instantiate_and_link()
547 	if (key->type->preparse)  in key_instantiate_and_link()
548 		key->type->free_preparse(&prep);  in key_instantiate_and_link()
555  * key_reject_and_link - Negatively instantiate a key and link it into the keyring.
556  * @key: The key to instantiate.
557  * @timeout: The timeout on the negative key.
558  * @error: The error to return when the key is hit.
562  * Negatively instantiate a key that's in the uninstantiated state and, if
564  * destination keyring if one is supplied.  The key and any links to the key
569  * key expires.
572  * waiting for the key is woken up.  If the key was already instantiated,
575 int key_reject_and_link(struct key *key,  in key_reject_and_link()  argument
578 			struct key *keyring,  in key_reject_and_link()
579 			struct key *authkey)  in key_reject_and_link()
584 	key_check(key);  in key_reject_and_link()
594 		link_ret = __key_link_lock(keyring, &key->index_key);  in key_reject_and_link()
596 			link_ret = __key_link_begin(keyring, &key->index_key, &edit);  in key_reject_and_link()
598 				__key_link_end(keyring, &key->index_key, edit);  in key_reject_and_link()
605 	if (key->state == KEY_IS_UNINSTANTIATED) {  in key_reject_and_link()
606 		/* mark the key as being negatively instantiated */  in key_reject_and_link()
607 		atomic_inc(&key->user->nikeys);  in key_reject_and_link()
608 		mark_key_instantiated(key, -error);  in key_reject_and_link()
609 		notify_key(key, NOTIFY_KEY_INSTANTIATED, -error);  in key_reject_and_link()
610 		key_set_expiry(key, ktime_get_real_seconds() + timeout);  in key_reject_and_link()
612 		if (test_and_clear_bit(KEY_FLAG_USER_CONSTRUCT, &key->flags))  in key_reject_and_link()
619 			__key_link(keyring, key, &edit);  in key_reject_and_link()
621 		/* disable the authorisation key */  in key_reject_and_link()
629 		__key_link_end(keyring, &key->index_key, edit);  in key_reject_and_link()
631 	/* wake up anyone waiting for a key to be constructed */  in key_reject_and_link()
633 		wake_up_bit(&key->flags, KEY_FLAG_USER_CONSTRUCT);  in key_reject_and_link()
640  * key_put - Discard a reference to a key.
641  * @key: The key to discard a reference from.
643  * Discard a reference to a key, and when all the references are gone, we
647 void key_put(struct key *key)  in key_put()  argument
649 	if (key) {  in key_put()
650 		key_check(key);  in key_put()
652 		if (refcount_dec_and_test(&key->usage)) {  in key_put()
655 			/* deal with the user's key tracking and quota */  in key_put()
656 			if (test_bit(KEY_FLAG_IN_QUOTA, &key->flags)) {  in key_put()
657 				spin_lock_irqsave(&key->user->lock, flags);  in key_put()
658 				key->user->qnkeys--;  in key_put()
659 				key->user->qnbytes -= key->quotalen;  in key_put()
660 				spin_unlock_irqrestore(&key->user->lock, flags);  in key_put()
662 			/* Mark key as safe for GC after key->user done. */  in key_put()
663 			clear_bit_unlock(KEY_FLAG_USER_ALIVE, &key->flags);  in key_put()
671  * Find a key by its serial number.
673 struct key *key_lookup(key_serial_t id)  in key_lookup()
676 	struct key *key;  in key_lookup()  local
680 	/* search the tree for the specified key */  in key_lookup()
683 		key = rb_entry(n, struct key, serial_node);  in key_lookup()
685 		if (id < key->serial)  in key_lookup()
687 		else if (id > key->serial)  in key_lookup()
694 	key = ERR_PTR(-ENOKEY);  in key_lookup()
698 	/* A key is allowed to be looked up only if someone still owns a  in key_lookup()
701 	if (!refcount_inc_not_zero(&key->usage))  in key_lookup()
706 	return key;  in key_lookup()
711  * Find and lock the specified key type against removal.
722 	/* look up the key type to see if it's one of the registered kernel  in key_type_lookup()
736 void key_set_timeout(struct key *key, unsigned timeout)  in key_set_timeout()  argument
741 	down_write(&key->sem);  in key_set_timeout()
745 	key_set_expiry(key, expiry);  in key_set_timeout()
747 	up_write(&key->sem);  in key_set_timeout()
752  * Unlock a key type locked by key_type_lookup().
760  * Attempt to update an existing key.
762  * The key is given to us with an incremented refcount that we need to discard
768 	struct key *key = key_ref_to_ptr(key_ref);  in __key_update()  local
771 	/* need write permission on the key to update it */  in __key_update()
777 	if (!key->type->update)  in __key_update()
780 	down_write(&key->sem);  in __key_update()
782 	ret = key->type->update(key, prep);  in __key_update()
784 		/* Updating a negative key positively instantiates it */  in __key_update()
785 		mark_key_instantiated(key, 0);  in __key_update()
786 		notify_key(key, NOTIFY_KEY_UPDATED, 0);  in __key_update()
789 	up_write(&key->sem);  in __key_update()
797 	key_put(key);  in __key_update()
803  * Create or potentially update a key. The combined logic behind
821 	struct key *keyring, *key = NULL;  in __key_create_or_update()  local
826 	/* look up the key type to see if it's one of the registered kernel  in __key_create_or_update()
885 					   &prep.payload, restrict_link->key);  in __key_create_or_update()
892 	/* if we're going to allocate a new key, we're going to have  in __key_create_or_update()
900 	/* if it's requested and possible to update this type of key, search  in __key_create_or_update()
901 	 * for an existing key of the same type and description in the  in __key_create_or_update()
932 	/* allocate a new key */  in __key_create_or_update()
933 	key = key_alloc(index_key.type, index_key.description,  in __key_create_or_update()
935 	if (IS_ERR(key)) {  in __key_create_or_update()
936 		key_ref = ERR_CAST(key);  in __key_create_or_update()
941 	ret = __key_instantiate_and_link(key, &prep, keyring, NULL, &edit);  in __key_create_or_update()
943 		key_put(key);  in __key_create_or_update()
948 	security_key_post_create_or_update(keyring, key, payload, plen, flags,  in __key_create_or_update()
951 	key_ref = make_key_ref(key, is_key_possessed(keyring_ref));  in __key_create_or_update()
964 	/* we found a matching key, so we're going to try to update it  in __key_create_or_update()
965 	 * - we can drop the locks first as we have the key pinned  in __key_create_or_update()
969 	key = key_ref_to_ptr(key_ref);  in __key_create_or_update()
970 	if (test_bit(KEY_FLAG_USER_CONSTRUCT, &key->flags)) {  in __key_create_or_update()
971 		ret = wait_for_key_construction(key, true);  in __key_create_or_update()
982 		security_key_post_create_or_update(keyring, key, payload, plen,  in __key_create_or_update()
989  * key_create_or_update - Update or create and instantiate a key.
991  * @type: The type of key.
992  * @description: The searchable description for the key.
993  * @payload: The data to use to instantiate or update the key.
995  * @perm: The permissions mask for a new key.
996  * @flags: The quota flags for a new key.
998  * Search the destination keyring for a key of the same description and if one
1002  * If perm is KEY_PERM_UNDEF then an appropriate key permissions mask will be
1005  * Returns a pointer to the new key if successful, -ENODEV if the key type
1008  * creation of the key.
1011  * the key ref before it is returned.
1027  * key_create - Create and instantiate a key.
1029  * @type: The type of key.
1030  * @description: The searchable description for the key.
1031  * @payload: The data to use to instantiate or update the key.
1033  * @perm: The permissions mask for a new key.
1034  * @flags: The quota flags for a new key.
1036  * Create and instantiate a new key and link to it from the destination keyring.
1038  * If perm is KEY_PERM_UNDEF then an appropriate key permissions mask will be
1041  * Returns a pointer to the new key if successful, -EEXIST if a key with the
1042  * same description already exists, -ENODEV if the key type wasn't available,
1045  * key.
1048  * the key ref before it is returned.
1064  * key_update - Update a key's contents.
1065  * @key_ref: The pointer (plus possession flag) to the key.
1066  * @payload: The data to be used to update the key.
1069  * Attempt to update the contents of a key with the given payload data.  The
1070  * caller must be granted Write permission on the key.  Negative keys can be
1073  * Returns 0 on success, -EACCES if not permitted and -EOPNOTSUPP if the key
1074  * type does not support updating.  The key type may return other errors.
1079 	struct key *key = key_ref_to_ptr(key_ref);  in key_update()  local
1082 	key_check(key);  in key_update()
1084 	/* the key must be writable */  in key_update()
1090 	if (!key->type->update)  in key_update()
1096 	prep.quotalen = key->type->def_datalen;  in key_update()
1098 	if (key->type->preparse) {  in key_update()
1099 		ret = key->type->preparse(&prep);  in key_update()
1104 	down_write(&key->sem);  in key_update()
1106 	ret = key->type->update(key, &prep);  in key_update()
1108 		/* Updating a negative key positively instantiates it */  in key_update()
1109 		mark_key_instantiated(key, 0);  in key_update()
1110 		notify_key(key, NOTIFY_KEY_UPDATED, 0);  in key_update()
1113 	up_write(&key->sem);  in key_update()
1116 	if (key->type->preparse)  in key_update()
1117 		key->type->free_preparse(&prep);  in key_update()
1123  * key_revoke - Revoke a key.
1124  * @key: The key to be revoked.
1126  * Mark a key as being revoked and ask the type to free up its resources.  The
1127  * revocation timeout is set and the key and all its links will be
1131 void key_revoke(struct key *key)  in key_revoke()  argument
1135 	key_check(key);  in key_revoke()
1137 	/* make sure no one's trying to change or use the key when we mark it  in key_revoke()
1139 	 *   authorisation key whilst holding the sem on a key we've just  in key_revoke()
1142 	down_write_nested(&key->sem, 1);  in key_revoke()
1143 	if (!test_and_set_bit(KEY_FLAG_REVOKED, &key->flags)) {  in key_revoke()
1144 		notify_key(key, NOTIFY_KEY_REVOKED, 0);  in key_revoke()
1145 		if (key->type->revoke)  in key_revoke()
1146 			key->type->revoke(key);  in key_revoke()
1150 		if (key->revoked_at == 0 || key->revoked_at > time) {  in key_revoke()
1151 			key->revoked_at = time;  in key_revoke()
1152 			key_schedule_gc(key->revoked_at + key_gc_delay);  in key_revoke()
1156 	up_write(&key->sem);  in key_revoke()
1161  * key_invalidate - Invalidate a key.
1162  * @key: The key to be invalidated.
1164  * Mark a key as being invalidated and have it cleaned up immediately.  The key
1167 void key_invalidate(struct key *key)  in key_invalidate()  argument
1169 	kenter("%d", key_serial(key));  in key_invalidate()
1171 	key_check(key);  in key_invalidate()
1173 	if (!test_bit(KEY_FLAG_INVALIDATED, &key->flags)) {  in key_invalidate()
1174 		down_write_nested(&key->sem, 1);  in key_invalidate()
1175 		if (!test_and_set_bit(KEY_FLAG_INVALIDATED, &key->flags)) {  in key_invalidate()
1176 			notify_key(key, NOTIFY_KEY_INVALIDATED, 0);  in key_invalidate()
1179 		up_write(&key->sem);  in key_invalidate()
1185  * generic_key_instantiate - Simple instantiation of a key from preparsed data
1186  * @key: The key to be instantiated
1189  * Instantiate a key from preparsed data.  We assume we can just copy the data
1192  * This can be pointed to directly by the key type instantiate op pointer.
1194 int generic_key_instantiate(struct key *key, struct key_preparsed_payload *prep)  in generic_key_instantiate()  argument
1200 	ret = key_payload_reserve(key, prep->quotalen);  in generic_key_instantiate()
1202 		rcu_assign_keypointer(key, prep->payload.data[0]);  in generic_key_instantiate()
1203 		key->payload.data[1] = prep->payload.data[1];  in generic_key_instantiate()
1204 		key->payload.data[2] = prep->payload.data[2];  in generic_key_instantiate()
1205 		key->payload.data[3] = prep->payload.data[3];  in generic_key_instantiate()
1217  * register_key_type - Register a type of key.
1218  * @ktype: The new key type.
1220  * Register a new key type.
1234 	/* disallow key types with the same name */  in register_key_type()
1243 	pr_notice("Key type %s registered\n", ktype->name);  in register_key_type()
1253  * unregister_key_type - Unregister a type of key.
1254  * @ktype: The key type.
1256  * Unregister a key type and mark all the extant keys of this type as dead.
1266 	pr_notice("Key type %s unregistered\n", ktype->name);  in unregister_key_type()
1272  * Initialise the key management state.
1277 	key_jar = kmem_cache_create("key_jar", sizeof(struct key),  in key_init()
1280 	/* add the special key types */  in key_init()