keys: Break bits out of key_unlink()
[linux-block.git] / security / keys / keyring.c
CommitLineData
69664cf1 1/* Keyring handling
1da177e4 2 *
b2a4df20 3 * Copyright (C) 2004-2005, 2008, 2013 Red Hat, Inc. All Rights Reserved.
1da177e4
LT
4 * Written by David Howells (dhowells@redhat.com)
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 */
11
876979c9 12#include <linux/export.h>
1da177e4
LT
13#include <linux/init.h>
14#include <linux/sched.h>
15#include <linux/slab.h>
29db9190 16#include <linux/security.h>
1da177e4
LT
17#include <linux/seq_file.h>
18#include <linux/err.h>
e9e349b0 19#include <keys/keyring-type.h>
b2a4df20
DH
20#include <keys/user-type.h>
21#include <linux/assoc_array_priv.h>
512ea3bc 22#include <linux/uaccess.h>
1da177e4
LT
23#include "internal.h"
24
25/*
973c9f4f
DH
26 * When plumbing the depths of the key tree, this sets a hard limit
27 * set on how deep we're willing to go.
1da177e4
LT
28 */
29#define KEYRING_SEARCH_MAX_DEPTH 6
30
31/*
973c9f4f 32 * We keep all named keyrings in a hash to speed looking them up.
1da177e4
LT
33 */
34#define KEYRING_NAME_HASH_SIZE (1 << 5)
35
b2a4df20
DH
36/*
37 * We mark pointers we pass to the associative array with bit 1 set if
38 * they're keyrings and clear otherwise.
39 */
40#define KEYRING_PTR_SUBTYPE 0x2UL
41
42static inline bool keyring_ptr_is_keyring(const struct assoc_array_ptr *x)
43{
44 return (unsigned long)x & KEYRING_PTR_SUBTYPE;
45}
46static inline struct key *keyring_ptr_to_key(const struct assoc_array_ptr *x)
47{
48 void *object = assoc_array_ptr_to_leaf(x);
49 return (struct key *)((unsigned long)object & ~KEYRING_PTR_SUBTYPE);
50}
51static inline void *keyring_key_to_ptr(struct key *key)
52{
53 if (key->type == &key_type_keyring)
54 return (void *)((unsigned long)key | KEYRING_PTR_SUBTYPE);
55 return key;
56}
57
1da177e4
LT
58static struct list_head keyring_name_hash[KEYRING_NAME_HASH_SIZE];
59static DEFINE_RWLOCK(keyring_name_lock);
60
61static inline unsigned keyring_hash(const char *desc)
62{
63 unsigned bucket = 0;
64
65 for (; *desc; desc++)
c5b60b5e 66 bucket += (unsigned char)*desc;
1da177e4
LT
67
68 return bucket & (KEYRING_NAME_HASH_SIZE - 1);
69}
70
71/*
973c9f4f
DH
72 * The keyring key type definition. Keyrings are simply keys of this type and
73 * can be treated as ordinary keys in addition to having their own special
74 * operations.
1da177e4 75 */
5d19e20b
DH
76static int keyring_preparse(struct key_preparsed_payload *prep);
77static void keyring_free_preparse(struct key_preparsed_payload *prep);
1da177e4 78static int keyring_instantiate(struct key *keyring,
cf7f601c 79 struct key_preparsed_payload *prep);
31204ed9 80static void keyring_revoke(struct key *keyring);
1da177e4
LT
81static void keyring_destroy(struct key *keyring);
82static void keyring_describe(const struct key *keyring, struct seq_file *m);
83static long keyring_read(const struct key *keyring,
84 char __user *buffer, size_t buflen);
85
86struct key_type key_type_keyring = {
87 .name = "keyring",
b2a4df20 88 .def_datalen = 0,
5d19e20b
DH
89 .preparse = keyring_preparse,
90 .free_preparse = keyring_free_preparse,
1da177e4 91 .instantiate = keyring_instantiate,
31204ed9 92 .revoke = keyring_revoke,
1da177e4
LT
93 .destroy = keyring_destroy,
94 .describe = keyring_describe,
95 .read = keyring_read,
96};
7318226e
DH
97EXPORT_SYMBOL(key_type_keyring);
98
1da177e4 99/*
973c9f4f
DH
100 * Semaphore to serialise link/link calls to prevent two link calls in parallel
101 * introducing a cycle.
1da177e4 102 */
3be59f74 103static DEFINE_MUTEX(keyring_serialise_link_lock);
1da177e4 104
1da177e4 105/*
973c9f4f
DH
106 * Publish the name of a keyring so that it can be found by name (if it has
107 * one).
1da177e4 108 */
69664cf1 109static void keyring_publish_name(struct key *keyring)
1da177e4
LT
110{
111 int bucket;
112
113 if (keyring->description) {
114 bucket = keyring_hash(keyring->description);
115
116 write_lock(&keyring_name_lock);
117
118 if (!keyring_name_hash[bucket].next)
119 INIT_LIST_HEAD(&keyring_name_hash[bucket]);
120
146aa8b1 121 list_add_tail(&keyring->name_link,
1da177e4
LT
122 &keyring_name_hash[bucket]);
123
124 write_unlock(&keyring_name_lock);
125 }
a8b17ed0 126}
1da177e4 127
5d19e20b
DH
128/*
129 * Preparse a keyring payload
130 */
131static int keyring_preparse(struct key_preparsed_payload *prep)
132{
133 return prep->datalen != 0 ? -EINVAL : 0;
134}
135
136/*
137 * Free a preparse of a user defined key payload
138 */
139static void keyring_free_preparse(struct key_preparsed_payload *prep)
140{
141}
142
1da177e4 143/*
973c9f4f
DH
144 * Initialise a keyring.
145 *
146 * Returns 0 on success, -EINVAL if given any data.
1da177e4
LT
147 */
148static int keyring_instantiate(struct key *keyring,
cf7f601c 149 struct key_preparsed_payload *prep)
1da177e4 150{
5d19e20b
DH
151 assoc_array_init(&keyring->keys);
152 /* make the keyring available by name if it has one */
153 keyring_publish_name(keyring);
154 return 0;
a8b17ed0 155}
1da177e4 156
1da177e4 157/*
b2a4df20
DH
158 * Multiply 64-bits by 32-bits to 96-bits and fold back to 64-bit. Ideally we'd
159 * fold the carry back too, but that requires inline asm.
160 */
161static u64 mult_64x32_and_fold(u64 x, u32 y)
162{
163 u64 hi = (u64)(u32)(x >> 32) * y;
164 u64 lo = (u64)(u32)(x) * y;
165 return lo + ((u64)(u32)hi << 32) + (u32)(hi >> 32);
166}
167
168/*
169 * Hash a key type and description.
170 */
171static unsigned long hash_key_type_and_desc(const struct keyring_index_key *index_key)
172{
173 const unsigned level_shift = ASSOC_ARRAY_LEVEL_STEP;
d54e58b7 174 const unsigned long fan_mask = ASSOC_ARRAY_FAN_MASK;
b2a4df20
DH
175 const char *description = index_key->description;
176 unsigned long hash, type;
177 u32 piece;
178 u64 acc;
179 int n, desc_len = index_key->desc_len;
180
181 type = (unsigned long)index_key->type;
182
183 acc = mult_64x32_and_fold(type, desc_len + 13);
184 acc = mult_64x32_and_fold(acc, 9207);
185 for (;;) {
186 n = desc_len;
187 if (n <= 0)
188 break;
189 if (n > 4)
190 n = 4;
191 piece = 0;
192 memcpy(&piece, description, n);
193 description += n;
194 desc_len -= n;
195 acc = mult_64x32_and_fold(acc, piece);
196 acc = mult_64x32_and_fold(acc, 9207);
197 }
198
199 /* Fold the hash down to 32 bits if need be. */
200 hash = acc;
201 if (ASSOC_ARRAY_KEY_CHUNK_SIZE == 32)
202 hash ^= acc >> 32;
203
204 /* Squidge all the keyrings into a separate part of the tree to
205 * ordinary keys by making sure the lowest level segment in the hash is
206 * zero for keyrings and non-zero otherwise.
207 */
d54e58b7 208 if (index_key->type != &key_type_keyring && (hash & fan_mask) == 0)
b2a4df20 209 return hash | (hash >> (ASSOC_ARRAY_KEY_CHUNK_SIZE - level_shift)) | 1;
d54e58b7
DH
210 if (index_key->type == &key_type_keyring && (hash & fan_mask) != 0)
211 return (hash + (hash << level_shift)) & ~fan_mask;
b2a4df20
DH
212 return hash;
213}
214
215/*
216 * Build the next index key chunk.
217 *
218 * On 32-bit systems the index key is laid out as:
219 *
220 * 0 4 5 9...
221 * hash desclen typeptr desc[]
222 *
223 * On 64-bit systems:
224 *
225 * 0 8 9 17...
226 * hash desclen typeptr desc[]
227 *
228 * We return it one word-sized chunk at a time.
1da177e4 229 */
b2a4df20
DH
230static unsigned long keyring_get_key_chunk(const void *data, int level)
231{
232 const struct keyring_index_key *index_key = data;
233 unsigned long chunk = 0;
234 long offset = 0;
235 int desc_len = index_key->desc_len, n = sizeof(chunk);
236
237 level /= ASSOC_ARRAY_KEY_CHUNK_SIZE;
238 switch (level) {
239 case 0:
240 return hash_key_type_and_desc(index_key);
241 case 1:
242 return ((unsigned long)index_key->type << 8) | desc_len;
243 case 2:
244 if (desc_len == 0)
245 return (u8)((unsigned long)index_key->type >>
246 (ASSOC_ARRAY_KEY_CHUNK_SIZE - 8));
247 n--;
248 offset = 1;
5b73262a 249 /* fall through */
b2a4df20
DH
250 default:
251 offset += sizeof(chunk) - 1;
252 offset += (level - 3) * sizeof(chunk);
253 if (offset >= desc_len)
254 return 0;
255 desc_len -= offset;
256 if (desc_len > n)
257 desc_len = n;
258 offset += desc_len;
259 do {
260 chunk <<= 8;
261 chunk |= ((u8*)index_key->description)[--offset];
262 } while (--desc_len > 0);
263
264 if (level == 2) {
265 chunk <<= 8;
266 chunk |= (u8)((unsigned long)index_key->type >>
267 (ASSOC_ARRAY_KEY_CHUNK_SIZE - 8));
268 }
269 return chunk;
270 }
271}
272
273static unsigned long keyring_get_object_key_chunk(const void *object, int level)
274{
275 const struct key *key = keyring_ptr_to_key(object);
276 return keyring_get_key_chunk(&key->index_key, level);
277}
278
279static bool keyring_compare_object(const void *object, const void *data)
1da177e4 280{
b2a4df20
DH
281 const struct keyring_index_key *index_key = data;
282 const struct key *key = keyring_ptr_to_key(object);
283
284 return key->index_key.type == index_key->type &&
285 key->index_key.desc_len == index_key->desc_len &&
286 memcmp(key->index_key.description, index_key->description,
287 index_key->desc_len) == 0;
a8b17ed0 288}
1da177e4 289
b2a4df20
DH
290/*
291 * Compare the index keys of a pair of objects and determine the bit position
292 * at which they differ - if they differ.
293 */
23fd78d7 294static int keyring_diff_objects(const void *object, const void *data)
b2a4df20 295{
23fd78d7 296 const struct key *key_a = keyring_ptr_to_key(object);
b2a4df20 297 const struct keyring_index_key *a = &key_a->index_key;
23fd78d7 298 const struct keyring_index_key *b = data;
b2a4df20
DH
299 unsigned long seg_a, seg_b;
300 int level, i;
301
302 level = 0;
303 seg_a = hash_key_type_and_desc(a);
304 seg_b = hash_key_type_and_desc(b);
305 if ((seg_a ^ seg_b) != 0)
306 goto differ;
307
308 /* The number of bits contributed by the hash is controlled by a
309 * constant in the assoc_array headers. Everything else thereafter we
310 * can deal with as being machine word-size dependent.
311 */
312 level += ASSOC_ARRAY_KEY_CHUNK_SIZE / 8;
313 seg_a = a->desc_len;
314 seg_b = b->desc_len;
315 if ((seg_a ^ seg_b) != 0)
316 goto differ;
317
318 /* The next bit may not work on big endian */
319 level++;
320 seg_a = (unsigned long)a->type;
321 seg_b = (unsigned long)b->type;
322 if ((seg_a ^ seg_b) != 0)
323 goto differ;
324
325 level += sizeof(unsigned long);
326 if (a->desc_len == 0)
327 goto same;
328
329 i = 0;
330 if (((unsigned long)a->description | (unsigned long)b->description) &
331 (sizeof(unsigned long) - 1)) {
332 do {
333 seg_a = *(unsigned long *)(a->description + i);
334 seg_b = *(unsigned long *)(b->description + i);
335 if ((seg_a ^ seg_b) != 0)
336 goto differ_plus_i;
337 i += sizeof(unsigned long);
338 } while (i < (a->desc_len & (sizeof(unsigned long) - 1)));
339 }
340
341 for (; i < a->desc_len; i++) {
342 seg_a = *(unsigned char *)(a->description + i);
343 seg_b = *(unsigned char *)(b->description + i);
344 if ((seg_a ^ seg_b) != 0)
345 goto differ_plus_i;
346 }
347
348same:
349 return -1;
350
351differ_plus_i:
352 level += i;
353differ:
354 i = level * 8 + __ffs(seg_a ^ seg_b);
355 return i;
356}
357
358/*
359 * Free an object after stripping the keyring flag off of the pointer.
360 */
361static void keyring_free_object(void *object)
362{
363 key_put(keyring_ptr_to_key(object));
364}
365
366/*
367 * Operations for keyring management by the index-tree routines.
368 */
369static const struct assoc_array_ops keyring_assoc_array_ops = {
370 .get_key_chunk = keyring_get_key_chunk,
371 .get_object_key_chunk = keyring_get_object_key_chunk,
372 .compare_object = keyring_compare_object,
373 .diff_objects = keyring_diff_objects,
374 .free_object = keyring_free_object,
375};
376
1da177e4 377/*
973c9f4f
DH
378 * Clean up a keyring when it is destroyed. Unpublish its name if it had one
379 * and dispose of its data.
233e4735
DH
380 *
381 * The garbage collector detects the final key_put(), removes the keyring from
382 * the serial number tree and then does RCU synchronisation before coming here,
383 * so we shouldn't need to worry about code poking around here with the RCU
384 * readlock held by this time.
1da177e4
LT
385 */
386static void keyring_destroy(struct key *keyring)
387{
1da177e4
LT
388 if (keyring->description) {
389 write_lock(&keyring_name_lock);
94efe72f 390
146aa8b1
DH
391 if (keyring->name_link.next != NULL &&
392 !list_empty(&keyring->name_link))
393 list_del(&keyring->name_link);
94efe72f 394
1da177e4
LT
395 write_unlock(&keyring_name_lock);
396 }
397
2b6aa412
MM
398 if (keyring->restrict_link) {
399 struct key_restriction *keyres = keyring->restrict_link;
400
401 key_put(keyres->key);
402 kfree(keyres);
403 }
404
b2a4df20 405 assoc_array_destroy(&keyring->keys, &keyring_assoc_array_ops);
a8b17ed0 406}
1da177e4 407
1da177e4 408/*
973c9f4f 409 * Describe a keyring for /proc.
1da177e4
LT
410 */
411static void keyring_describe(const struct key *keyring, struct seq_file *m)
412{
c8563473 413 if (keyring->description)
1da177e4 414 seq_puts(m, keyring->description);
c8563473 415 else
1da177e4 416 seq_puts(m, "[anon]");
1da177e4 417
363b02da 418 if (key_is_positive(keyring)) {
b2a4df20
DH
419 if (keyring->keys.nr_leaves_on_tree != 0)
420 seq_printf(m, ": %lu", keyring->keys.nr_leaves_on_tree);
78b7280c
DH
421 else
422 seq_puts(m, ": empty");
78b7280c 423 }
a8b17ed0 424}
1da177e4 425
b2a4df20 426struct keyring_read_iterator_context {
e645016a 427 size_t buflen;
b2a4df20
DH
428 size_t count;
429 key_serial_t __user *buffer;
430};
431
432static int keyring_read_iterator(const void *object, void *data)
433{
434 struct keyring_read_iterator_context *ctx = data;
435 const struct key *key = keyring_ptr_to_key(object);
436 int ret;
437
438 kenter("{%s,%d},,{%zu/%zu}",
e645016a 439 key->type->name, key->serial, ctx->count, ctx->buflen);
b2a4df20 440
e645016a 441 if (ctx->count >= ctx->buflen)
b2a4df20
DH
442 return 1;
443
444 ret = put_user(key->serial, ctx->buffer);
445 if (ret < 0)
446 return ret;
447 ctx->buffer++;
448 ctx->count += sizeof(key->serial);
449 return 0;
450}
451
1da177e4 452/*
973c9f4f
DH
453 * Read a list of key IDs from the keyring's contents in binary form
454 *
b2a4df20
DH
455 * The keyring's semaphore is read-locked by the caller. This prevents someone
456 * from modifying it under us - which could cause us to read key IDs multiple
457 * times.
1da177e4
LT
458 */
459static long keyring_read(const struct key *keyring,
460 char __user *buffer, size_t buflen)
461{
b2a4df20 462 struct keyring_read_iterator_context ctx;
3239b6f2 463 long ret;
1da177e4 464
b2a4df20
DH
465 kenter("{%d},,%zu", key_serial(keyring), buflen);
466
467 if (buflen & (sizeof(key_serial_t) - 1))
468 return -EINVAL;
469
3239b6f2
EB
470 /* Copy as many key IDs as fit into the buffer */
471 if (buffer && buflen) {
472 ctx.buffer = (key_serial_t __user *)buffer;
473 ctx.buflen = buflen;
474 ctx.count = 0;
475 ret = assoc_array_iterate(&keyring->keys,
476 keyring_read_iterator, &ctx);
477 if (ret < 0) {
478 kleave(" = %ld [iterate]", ret);
479 return ret;
480 }
1da177e4
LT
481 }
482
3239b6f2
EB
483 /* Return the size of the buffer needed */
484 ret = keyring->keys.nr_leaves_on_tree * sizeof(key_serial_t);
485 if (ret <= buflen)
486 kleave("= %ld [ok]", ret);
487 else
488 kleave("= %ld [buffer too small]", ret);
489 return ret;
a8b17ed0 490}
1da177e4 491
1da177e4 492/*
973c9f4f 493 * Allocate a keyring and link into the destination keyring.
1da177e4 494 */
9a56c2db 495struct key *keyring_alloc(const char *description, kuid_t uid, kgid_t gid,
96b5c8fe 496 const struct cred *cred, key_perm_t perm,
5ac7eace 497 unsigned long flags,
2b6aa412 498 struct key_restriction *restrict_link,
5ac7eace 499 struct key *dest)
1da177e4
LT
500{
501 struct key *keyring;
502 int ret;
503
504 keyring = key_alloc(&key_type_keyring, description,
5ac7eace 505 uid, gid, cred, perm, flags, restrict_link);
1da177e4 506 if (!IS_ERR(keyring)) {
3e30148c 507 ret = key_instantiate_and_link(keyring, NULL, 0, dest, NULL);
1da177e4
LT
508 if (ret < 0) {
509 key_put(keyring);
510 keyring = ERR_PTR(ret);
511 }
512 }
513
514 return keyring;
a8b17ed0 515}
f8aa23a5 516EXPORT_SYMBOL(keyring_alloc);
1da177e4 517
5ac7eace
DH
518/**
519 * restrict_link_reject - Give -EPERM to restrict link
520 * @keyring: The keyring being added to.
521 * @type: The type of key being added.
5ac7eace 522 * @payload: The payload of the key intended to be added.
9fd16537 523 * @restriction_key: Keys providing additional data for evaluating restriction.
5ac7eace
DH
524 *
525 * Reject the addition of any links to a keyring. It can be overridden by
526 * passing KEY_ALLOC_BYPASS_RESTRICTION to key_instantiate_and_link() when
527 * adding a key to a keyring.
528 *
2b6aa412
MM
529 * This is meant to be stored in a key_restriction structure which is passed
530 * in the restrict_link parameter to keyring_alloc().
5ac7eace
DH
531 */
532int restrict_link_reject(struct key *keyring,
533 const struct key_type *type,
aaf66c88
MM
534 const union key_payload *payload,
535 struct key *restriction_key)
5ac7eace
DH
536{
537 return -EPERM;
538}
539
c06cfb08
DH
540/*
541 * By default, we keys found by getting an exact match on their descriptions.
542 */
0c903ab6
DH
543bool key_default_cmp(const struct key *key,
544 const struct key_match_data *match_data)
c06cfb08
DH
545{
546 return strcmp(key->description, match_data->raw_data) == 0;
547}
548
b2a4df20
DH
549/*
550 * Iteration function to consider each key found.
1da177e4 551 */
b2a4df20 552static int keyring_search_iterator(const void *object, void *iterator_data)
1da177e4 553{
b2a4df20
DH
554 struct keyring_search_context *ctx = iterator_data;
555 const struct key *key = keyring_ptr_to_key(object);
363b02da
DH
556 unsigned long kflags = READ_ONCE(key->flags);
557 short state = READ_ONCE(key->state);
1da177e4 558
b2a4df20 559 kenter("{%d}", key->serial);
1da177e4 560
b2a4df20
DH
561 /* ignore keys not of this type */
562 if (key->type != ctx->index_key.type) {
563 kleave(" = 0 [!type]");
564 return 0;
29db9190 565 }
1da177e4 566
b2a4df20
DH
567 /* skip invalidated, revoked and expired keys */
568 if (ctx->flags & KEYRING_SEARCH_DO_STATE_CHECK) {
074d5898 569 time64_t expiry = READ_ONCE(key->expiry);
9d6c8711 570
b2a4df20
DH
571 if (kflags & ((1 << KEY_FLAG_INVALIDATED) |
572 (1 << KEY_FLAG_REVOKED))) {
573 ctx->result = ERR_PTR(-EKEYREVOKED);
574 kleave(" = %d [invrev]", ctx->skipped_ret);
575 goto skipped;
576 }
1da177e4 577
074d5898 578 if (expiry && ctx->now >= expiry) {
0b0a8415
DH
579 if (!(ctx->flags & KEYRING_SEARCH_SKIP_EXPIRED))
580 ctx->result = ERR_PTR(-EKEYEXPIRED);
b2a4df20
DH
581 kleave(" = %d [expire]", ctx->skipped_ret);
582 goto skipped;
583 }
584 }
664cceb0 585
b2a4df20 586 /* keys that don't match */
46291959 587 if (!ctx->match_data.cmp(key, &ctx->match_data)) {
b2a4df20
DH
588 kleave(" = 0 [!match]");
589 return 0;
590 }
dceba994 591
b2a4df20
DH
592 /* key must have search permissions */
593 if (!(ctx->flags & KEYRING_SEARCH_NO_CHECK_PERM) &&
594 key_task_permission(make_key_ref(key, ctx->possessed),
f5895943 595 ctx->cred, KEY_NEED_SEARCH) < 0) {
b2a4df20
DH
596 ctx->result = ERR_PTR(-EACCES);
597 kleave(" = %d [!perm]", ctx->skipped_ret);
598 goto skipped;
dceba994
KC
599 }
600
b2a4df20
DH
601 if (ctx->flags & KEYRING_SEARCH_DO_STATE_CHECK) {
602 /* we set a different error code if we pass a negative key */
363b02da
DH
603 if (state < 0) {
604 ctx->result = ERR_PTR(state);
b2a4df20
DH
605 kleave(" = %d [neg]", ctx->skipped_ret);
606 goto skipped;
607 }
608 }
1da177e4 609
b2a4df20
DH
610 /* Found */
611 ctx->result = make_key_ref(key, ctx->possessed);
612 kleave(" = 1 [found]");
613 return 1;
1da177e4 614
b2a4df20
DH
615skipped:
616 return ctx->skipped_ret;
617}
1da177e4 618
b2a4df20
DH
619/*
620 * Search inside a keyring for a key. We can search by walking to it
621 * directly based on its index-key or we can iterate over the entire
622 * tree looking for it, based on the match function.
623 */
624static int search_keyring(struct key *keyring, struct keyring_search_context *ctx)
625{
46291959 626 if (ctx->match_data.lookup_type == KEYRING_SEARCH_LOOKUP_DIRECT) {
b2a4df20
DH
627 const void *object;
628
629 object = assoc_array_find(&keyring->keys,
630 &keyring_assoc_array_ops,
631 &ctx->index_key);
632 return object ? ctx->iterator(object, ctx) : 0;
633 }
634 return assoc_array_iterate(&keyring->keys, ctx->iterator, ctx);
635}
1da177e4 636
b2a4df20
DH
637/*
638 * Search a tree of keyrings that point to other keyrings up to the maximum
639 * depth.
640 */
641static bool search_nested_keyrings(struct key *keyring,
642 struct keyring_search_context *ctx)
643{
644 struct {
645 struct key *keyring;
646 struct assoc_array_node *node;
647 int slot;
648 } stack[KEYRING_SEARCH_MAX_DEPTH];
1da177e4 649
b2a4df20
DH
650 struct assoc_array_shortcut *shortcut;
651 struct assoc_array_node *node;
652 struct assoc_array_ptr *ptr;
653 struct key *key;
654 int sp = 0, slot;
1da177e4 655
b2a4df20
DH
656 kenter("{%d},{%s,%s}",
657 keyring->serial,
658 ctx->index_key.type->name,
659 ctx->index_key.description);
1da177e4 660
054f6180
DH
661#define STATE_CHECKS (KEYRING_SEARCH_NO_STATE_CHECK | KEYRING_SEARCH_DO_STATE_CHECK)
662 BUG_ON((ctx->flags & STATE_CHECKS) == 0 ||
663 (ctx->flags & STATE_CHECKS) == STATE_CHECKS);
664
b2a4df20
DH
665 /* Check to see if this top-level keyring is what we are looking for
666 * and whether it is valid or not.
667 */
46291959 668 if (ctx->match_data.lookup_type == KEYRING_SEARCH_LOOKUP_ITERATE ||
b2a4df20
DH
669 keyring_compare_object(keyring, &ctx->index_key)) {
670 ctx->skipped_ret = 2;
b2a4df20
DH
671 switch (ctx->iterator(keyring_key_to_ptr(keyring), ctx)) {
672 case 1:
78b7280c 673 goto found;
b2a4df20
DH
674 case 2:
675 return false;
676 default:
677 break;
1da177e4 678 }
b2a4df20 679 }
1da177e4 680
b2a4df20 681 ctx->skipped_ret = 0;
b2a4df20
DH
682
683 /* Start processing a new keyring */
684descend_to_keyring:
685 kdebug("descend to %d", keyring->serial);
686 if (keyring->flags & ((1 << KEY_FLAG_INVALIDATED) |
687 (1 << KEY_FLAG_REVOKED)))
688 goto not_this_keyring;
689
690 /* Search through the keys in this keyring before its searching its
691 * subtrees.
692 */
693 if (search_keyring(keyring, ctx))
1da177e4 694 goto found;
1da177e4 695
b2a4df20
DH
696 /* Then manually iterate through the keyrings nested in this one.
697 *
698 * Start from the root node of the index tree. Because of the way the
699 * hash function has been set up, keyrings cluster on the leftmost
700 * branch of the root node (root slot 0) or in the root node itself.
701 * Non-keyrings avoid the leftmost branch of the root entirely (root
702 * slots 1-15).
703 */
381f20fc 704 ptr = READ_ONCE(keyring->keys.root);
b2a4df20
DH
705 if (!ptr)
706 goto not_this_keyring;
1da177e4 707
b2a4df20
DH
708 if (assoc_array_ptr_is_shortcut(ptr)) {
709 /* If the root is a shortcut, either the keyring only contains
710 * keyring pointers (everything clusters behind root slot 0) or
711 * doesn't contain any keyring pointers.
1da177e4 712 */
b2a4df20 713 shortcut = assoc_array_ptr_to_shortcut(ptr);
b2a4df20
DH
714 if ((shortcut->index_key[0] & ASSOC_ARRAY_FAN_MASK) != 0)
715 goto not_this_keyring;
716
381f20fc 717 ptr = READ_ONCE(shortcut->next_node);
b2a4df20
DH
718 node = assoc_array_ptr_to_node(ptr);
719 goto begin_node;
720 }
721
722 node = assoc_array_ptr_to_node(ptr);
b2a4df20
DH
723 ptr = node->slots[0];
724 if (!assoc_array_ptr_is_meta(ptr))
725 goto begin_node;
726
727descend_to_node:
728 /* Descend to a more distal node in this keyring's content tree and go
729 * through that.
730 */
731 kdebug("descend");
732 if (assoc_array_ptr_is_shortcut(ptr)) {
733 shortcut = assoc_array_ptr_to_shortcut(ptr);
381f20fc 734 ptr = READ_ONCE(shortcut->next_node);
b2a4df20 735 BUG_ON(!assoc_array_ptr_is_node(ptr));
b2a4df20 736 }
9c5e45df 737 node = assoc_array_ptr_to_node(ptr);
b2a4df20
DH
738
739begin_node:
740 kdebug("begin_node");
b2a4df20
DH
741 slot = 0;
742ascend_to_node:
743 /* Go through the slots in a node */
744 for (; slot < ASSOC_ARRAY_FAN_OUT; slot++) {
381f20fc 745 ptr = READ_ONCE(node->slots[slot]);
b2a4df20
DH
746
747 if (assoc_array_ptr_is_meta(ptr) && node->back_pointer)
748 goto descend_to_node;
749
750 if (!keyring_ptr_is_keyring(ptr))
76d8aeab 751 continue;
1da177e4 752
b2a4df20
DH
753 key = keyring_ptr_to_key(ptr);
754
755 if (sp >= KEYRING_SEARCH_MAX_DEPTH) {
756 if (ctx->flags & KEYRING_SEARCH_DETECT_TOO_DEEP) {
757 ctx->result = ERR_PTR(-ELOOP);
758 return false;
759 }
760 goto not_this_keyring;
761 }
762
763 /* Search a nested keyring */
764 if (!(ctx->flags & KEYRING_SEARCH_NO_CHECK_PERM) &&
765 key_task_permission(make_key_ref(key, ctx->possessed),
f5895943 766 ctx->cred, KEY_NEED_SEARCH) < 0)
76d8aeab 767 continue;
1da177e4
LT
768
769 /* stack the current position */
31d5a79d 770 stack[sp].keyring = keyring;
b2a4df20
DH
771 stack[sp].node = node;
772 stack[sp].slot = slot;
1da177e4
LT
773 sp++;
774
775 /* begin again with the new keyring */
776 keyring = key;
b2a4df20
DH
777 goto descend_to_keyring;
778 }
779
780 /* We've dealt with all the slots in the current node, so now we need
781 * to ascend to the parent and continue processing there.
782 */
381f20fc 783 ptr = READ_ONCE(node->back_pointer);
b2a4df20
DH
784 slot = node->parent_slot;
785
786 if (ptr && assoc_array_ptr_is_shortcut(ptr)) {
787 shortcut = assoc_array_ptr_to_shortcut(ptr);
381f20fc 788 ptr = READ_ONCE(shortcut->back_pointer);
b2a4df20
DH
789 slot = shortcut->parent_slot;
790 }
791 if (!ptr)
792 goto not_this_keyring;
793 node = assoc_array_ptr_to_node(ptr);
b2a4df20
DH
794 slot++;
795
796 /* If we've ascended to the root (zero backpointer), we must have just
797 * finished processing the leftmost branch rather than the root slots -
798 * so there can't be any more keyrings for us to find.
799 */
800 if (node->back_pointer) {
801 kdebug("ascend %d", slot);
802 goto ascend_to_node;
1da177e4
LT
803 }
804
b2a4df20
DH
805 /* The keyring we're looking at was disqualified or didn't contain a
806 * matching key.
807 */
664cceb0 808not_this_keyring:
b2a4df20
DH
809 kdebug("not_this_keyring %d", sp);
810 if (sp <= 0) {
811 kleave(" = false");
812 return false;
1da177e4
LT
813 }
814
b2a4df20
DH
815 /* Resume the processing of a keyring higher up in the tree */
816 sp--;
817 keyring = stack[sp].keyring;
818 node = stack[sp].node;
819 slot = stack[sp].slot + 1;
820 kdebug("ascend to %d [%d]", keyring->serial, slot);
821 goto ascend_to_node;
1da177e4 822
b2a4df20 823 /* We found a viable match */
664cceb0 824found:
b2a4df20 825 key = key_ref_to_ptr(ctx->result);
1da177e4 826 key_check(key);
b2a4df20 827 if (!(ctx->flags & KEYRING_SEARCH_NO_UPDATE_TIME)) {
074d5898
BW
828 key->last_used_at = ctx->now;
829 keyring->last_used_at = ctx->now;
b2a4df20 830 while (sp > 0)
074d5898 831 stack[--sp].keyring->last_used_at = ctx->now;
b2a4df20
DH
832 }
833 kleave(" = true");
834 return true;
835}
836
837/**
838 * keyring_search_aux - Search a keyring tree for a key matching some criteria
839 * @keyring_ref: A pointer to the keyring with possession indicator.
840 * @ctx: The keyring search context.
841 *
842 * Search the supplied keyring tree for a key that matches the criteria given.
843 * The root keyring and any linked keyrings must grant Search permission to the
844 * caller to be searchable and keys can only be found if they too grant Search
845 * to the caller. The possession flag on the root keyring pointer controls use
846 * of the possessor bits in permissions checking of the entire tree. In
847 * addition, the LSM gets to forbid keyring searches and key matches.
848 *
849 * The search is performed as a breadth-then-depth search up to the prescribed
850 * limit (KEYRING_SEARCH_MAX_DEPTH).
851 *
852 * Keys are matched to the type provided and are then filtered by the match
853 * function, which is given the description to use in any way it sees fit. The
854 * match function may use any attributes of a key that it wishes to to
855 * determine the match. Normally the match function from the key type would be
856 * used.
857 *
858 * RCU can be used to prevent the keyring key lists from disappearing without
859 * the need to take lots of locks.
860 *
861 * Returns a pointer to the found key and increments the key usage count if
862 * successful; -EAGAIN if no matching keys were found, or if expired or revoked
863 * keys were found; -ENOKEY if only negative keys were found; -ENOTDIR if the
864 * specified keyring wasn't a keyring.
865 *
866 * In the case of a successful return, the possession attribute from
867 * @keyring_ref is propagated to the returned key reference.
868 */
869key_ref_t keyring_search_aux(key_ref_t keyring_ref,
870 struct keyring_search_context *ctx)
871{
872 struct key *keyring;
873 long err;
874
875 ctx->iterator = keyring_search_iterator;
876 ctx->possessed = is_key_possessed(keyring_ref);
877 ctx->result = ERR_PTR(-EAGAIN);
878
879 keyring = key_ref_to_ptr(keyring_ref);
880 key_check(keyring);
881
882 if (keyring->type != &key_type_keyring)
883 return ERR_PTR(-ENOTDIR);
884
885 if (!(ctx->flags & KEYRING_SEARCH_NO_CHECK_PERM)) {
f5895943 886 err = key_task_permission(keyring_ref, ctx->cred, KEY_NEED_SEARCH);
b2a4df20
DH
887 if (err < 0)
888 return ERR_PTR(err);
889 }
890
891 rcu_read_lock();
074d5898 892 ctx->now = ktime_get_real_seconds();
b2a4df20
DH
893 if (search_nested_keyrings(keyring, ctx))
894 __key_get(key_ref_to_ptr(ctx->result));
76d8aeab 895 rcu_read_unlock();
b2a4df20 896 return ctx->result;
a8b17ed0 897}
1da177e4 898
973c9f4f
DH
899/**
900 * keyring_search - Search the supplied keyring tree for a matching key
901 * @keyring: The root of the keyring tree to be searched.
902 * @type: The type of keyring we want to find.
903 * @description: The name of the keyring we want to find.
904 *
905 * As keyring_search_aux() above, but using the current task's credentials and
b2a4df20 906 * type's default matching function and preferred search method.
1da177e4 907 */
664cceb0
DH
908key_ref_t keyring_search(key_ref_t keyring,
909 struct key_type *type,
910 const char *description)
1da177e4 911{
4bdf0bc3
DH
912 struct keyring_search_context ctx = {
913 .index_key.type = type,
914 .index_key.description = description,
ede0fa98 915 .index_key.desc_len = strlen(description),
4bdf0bc3 916 .cred = current_cred(),
c06cfb08 917 .match_data.cmp = key_default_cmp,
46291959
DH
918 .match_data.raw_data = description,
919 .match_data.lookup_type = KEYRING_SEARCH_LOOKUP_DIRECT,
920 .flags = KEYRING_SEARCH_DO_STATE_CHECK,
4bdf0bc3 921 };
46291959
DH
922 key_ref_t key;
923 int ret;
4bdf0bc3 924
46291959
DH
925 if (type->match_preparse) {
926 ret = type->match_preparse(&ctx.match_data);
927 if (ret < 0)
928 return ERR_PTR(ret);
929 }
930
931 key = keyring_search_aux(keyring, &ctx);
932
933 if (type->match_free)
934 type->match_free(&ctx.match_data);
935 return key;
a8b17ed0 936}
1da177e4
LT
937EXPORT_SYMBOL(keyring_search);
938
6563c91f
MM
939static struct key_restriction *keyring_restriction_alloc(
940 key_restrict_link_func_t check)
941{
942 struct key_restriction *keyres =
943 kzalloc(sizeof(struct key_restriction), GFP_KERNEL);
944
945 if (!keyres)
946 return ERR_PTR(-ENOMEM);
947
948 keyres->check = check;
949
950 return keyres;
951}
952
953/*
954 * Semaphore to serialise restriction setup to prevent reference count
955 * cycles through restriction key pointers.
956 */
957static DECLARE_RWSEM(keyring_serialise_restrict_sem);
958
959/*
960 * Check for restriction cycles that would prevent keyring garbage collection.
961 * keyring_serialise_restrict_sem must be held.
962 */
963static bool keyring_detect_restriction_cycle(const struct key *dest_keyring,
964 struct key_restriction *keyres)
965{
966 while (keyres && keyres->key &&
967 keyres->key->type == &key_type_keyring) {
968 if (keyres->key == dest_keyring)
969 return true;
970
971 keyres = keyres->key->restrict_link;
972 }
973
974 return false;
975}
976
977/**
978 * keyring_restrict - Look up and apply a restriction to a keyring
9fd16537
DH
979 * @keyring_ref: The keyring to be restricted
980 * @type: The key type that will provide the restriction checker.
6563c91f 981 * @restriction: The restriction options to apply to the keyring
9fd16537
DH
982 *
983 * Look up a keyring and apply a restriction to it. The restriction is managed
984 * by the specific key type, but can be configured by the options specified in
985 * the restriction string.
6563c91f
MM
986 */
987int keyring_restrict(key_ref_t keyring_ref, const char *type,
988 const char *restriction)
989{
990 struct key *keyring;
991 struct key_type *restrict_type = NULL;
992 struct key_restriction *restrict_link;
993 int ret = 0;
994
995 keyring = key_ref_to_ptr(keyring_ref);
996 key_check(keyring);
997
998 if (keyring->type != &key_type_keyring)
999 return -ENOTDIR;
1000
1001 if (!type) {
1002 restrict_link = keyring_restriction_alloc(restrict_link_reject);
1003 } else {
1004 restrict_type = key_type_lookup(type);
1005
1006 if (IS_ERR(restrict_type))
1007 return PTR_ERR(restrict_type);
1008
1009 if (!restrict_type->lookup_restriction) {
1010 ret = -ENOENT;
1011 goto error;
1012 }
1013
1014 restrict_link = restrict_type->lookup_restriction(restriction);
1015 }
1016
1017 if (IS_ERR(restrict_link)) {
1018 ret = PTR_ERR(restrict_link);
1019 goto error;
1020 }
1021
1022 down_write(&keyring->sem);
1023 down_write(&keyring_serialise_restrict_sem);
1024
1025 if (keyring->restrict_link)
1026 ret = -EEXIST;
1027 else if (keyring_detect_restriction_cycle(keyring, restrict_link))
1028 ret = -EDEADLK;
1029 else
1030 keyring->restrict_link = restrict_link;
1031
1032 up_write(&keyring_serialise_restrict_sem);
1033 up_write(&keyring->sem);
1034
1035 if (ret < 0) {
1036 key_put(restrict_link->key);
1037 kfree(restrict_link);
1038 }
1039
1040error:
1041 if (restrict_type)
1042 key_type_put(restrict_type);
1043
1044 return ret;
1045}
1046EXPORT_SYMBOL(keyring_restrict);
1047
1da177e4 1048/*
b2a4df20 1049 * Search the given keyring for a key that might be updated.
973c9f4f
DH
1050 *
1051 * The caller must guarantee that the keyring is a keyring and that the
b2a4df20
DH
1052 * permission is granted to modify the keyring as no check is made here. The
1053 * caller must also hold a lock on the keyring semaphore.
973c9f4f
DH
1054 *
1055 * Returns a pointer to the found key with usage count incremented if
b2a4df20
DH
1056 * successful and returns NULL if not found. Revoked and invalidated keys are
1057 * skipped over.
973c9f4f
DH
1058 *
1059 * If successful, the possession indicator is propagated from the keyring ref
1060 * to the returned key reference.
1da177e4 1061 */
b2a4df20
DH
1062key_ref_t find_key_to_update(key_ref_t keyring_ref,
1063 const struct keyring_index_key *index_key)
1da177e4 1064{
664cceb0 1065 struct key *keyring, *key;
b2a4df20 1066 const void *object;
1da177e4 1067
664cceb0 1068 keyring = key_ref_to_ptr(keyring_ref);
664cceb0 1069
b2a4df20
DH
1070 kenter("{%d},{%s,%s}",
1071 keyring->serial, index_key->type->name, index_key->description);
76d8aeab 1072
b2a4df20
DH
1073 object = assoc_array_find(&keyring->keys, &keyring_assoc_array_ops,
1074 index_key);
1da177e4 1075
b2a4df20
DH
1076 if (object)
1077 goto found;
1078
1079 kleave(" = NULL");
1080 return NULL;
1da177e4 1081
c5b60b5e 1082found:
b2a4df20
DH
1083 key = keyring_ptr_to_key(object);
1084 if (key->flags & ((1 << KEY_FLAG_INVALIDATED) |
1085 (1 << KEY_FLAG_REVOKED))) {
1086 kleave(" = NULL [x]");
1087 return NULL;
1088 }
ccc3e6d9 1089 __key_get(key);
b2a4df20
DH
1090 kleave(" = {%d}", key->serial);
1091 return make_key_ref(key, is_key_possessed(keyring_ref));
a8b17ed0 1092}
1da177e4 1093
1da177e4 1094/*
973c9f4f
DH
1095 * Find a keyring with the specified name.
1096 *
237bbd29
EB
1097 * Only keyrings that have nonzero refcount, are not revoked, and are owned by a
1098 * user in the current user namespace are considered. If @uid_keyring is %true,
1099 * the keyring additionally must have been allocated as a user or user session
1100 * keyring; otherwise, it must grant Search permission directly to the caller.
973c9f4f
DH
1101 *
1102 * Returns a pointer to the keyring with the keyring's refcount having being
1103 * incremented on success. -ENOKEY is returned if a key could not be found.
1da177e4 1104 */
237bbd29 1105struct key *find_keyring_by_name(const char *name, bool uid_keyring)
1da177e4
LT
1106{
1107 struct key *keyring;
1108 int bucket;
1109
1da177e4 1110 if (!name)
cea7daa3 1111 return ERR_PTR(-EINVAL);
1da177e4
LT
1112
1113 bucket = keyring_hash(name);
1114
1115 read_lock(&keyring_name_lock);
1116
1117 if (keyring_name_hash[bucket].next) {
1118 /* search this hash bucket for a keyring with a matching name
1119 * that's readable and that hasn't been revoked */
1120 list_for_each_entry(keyring,
1121 &keyring_name_hash[bucket],
146aa8b1 1122 name_link
1da177e4 1123 ) {
9a56c2db 1124 if (!kuid_has_mapping(current_user_ns(), keyring->user->uid))
2ea190d0
SH
1125 continue;
1126
76d8aeab 1127 if (test_bit(KEY_FLAG_REVOKED, &keyring->flags))
1da177e4
LT
1128 continue;
1129
1130 if (strcmp(keyring->description, name) != 0)
1131 continue;
1132
237bbd29
EB
1133 if (uid_keyring) {
1134 if (!test_bit(KEY_FLAG_UID_KEYRING,
1135 &keyring->flags))
1136 continue;
1137 } else {
1138 if (key_permission(make_key_ref(keyring, 0),
1139 KEY_NEED_SEARCH) < 0)
1140 continue;
1141 }
1da177e4 1142
cea7daa3
TO
1143 /* we've got a match but we might end up racing with
1144 * key_cleanup() if the keyring is currently 'dead'
1145 * (ie. it has a zero usage count) */
fff29291 1146 if (!refcount_inc_not_zero(&keyring->usage))
cea7daa3 1147 continue;
074d5898 1148 keyring->last_used_at = ktime_get_real_seconds();
cea7daa3 1149 goto out;
1da177e4
LT
1150 }
1151 }
1152
1da177e4 1153 keyring = ERR_PTR(-ENOKEY);
cea7daa3
TO
1154out:
1155 read_unlock(&keyring_name_lock);
1da177e4 1156 return keyring;
a8b17ed0 1157}
1da177e4 1158
b2a4df20
DH
1159static int keyring_detect_cycle_iterator(const void *object,
1160 void *iterator_data)
1161{
1162 struct keyring_search_context *ctx = iterator_data;
1163 const struct key *key = keyring_ptr_to_key(object);
1164
1165 kenter("{%d}", key->serial);
1166
979e0d74
DH
1167 /* We might get a keyring with matching index-key that is nonetheless a
1168 * different keyring. */
46291959 1169 if (key != ctx->match_data.raw_data)
979e0d74
DH
1170 return 0;
1171
b2a4df20
DH
1172 ctx->result = ERR_PTR(-EDEADLK);
1173 return 1;
1174}
1175
1da177e4 1176/*
973c9f4f
DH
1177 * See if a cycle will will be created by inserting acyclic tree B in acyclic
1178 * tree A at the topmost level (ie: as a direct child of A).
1179 *
1180 * Since we are adding B to A at the top level, checking for cycles should just
1181 * be a matter of seeing if node A is somewhere in tree B.
1da177e4
LT
1182 */
1183static int keyring_detect_cycle(struct key *A, struct key *B)
1184{
b2a4df20 1185 struct keyring_search_context ctx = {
46291959
DH
1186 .index_key = A->index_key,
1187 .match_data.raw_data = A,
1188 .match_data.lookup_type = KEYRING_SEARCH_LOOKUP_DIRECT,
1189 .iterator = keyring_detect_cycle_iterator,
1190 .flags = (KEYRING_SEARCH_NO_STATE_CHECK |
1191 KEYRING_SEARCH_NO_UPDATE_TIME |
1192 KEYRING_SEARCH_NO_CHECK_PERM |
1193 KEYRING_SEARCH_DETECT_TOO_DEEP),
b2a4df20 1194 };
1da177e4 1195
76d8aeab 1196 rcu_read_lock();
b2a4df20 1197 search_nested_keyrings(B, &ctx);
76d8aeab 1198 rcu_read_unlock();
b2a4df20 1199 return PTR_ERR(ctx.result) == -EAGAIN ? 0 : PTR_ERR(ctx.result);
f70e2e06 1200}
cab8eb59 1201
1da177e4 1202/*
973c9f4f 1203 * Preallocate memory so that a key can be linked into to a keyring.
1da177e4 1204 */
b2a4df20
DH
1205int __key_link_begin(struct key *keyring,
1206 const struct keyring_index_key *index_key,
1207 struct assoc_array_edit **_edit)
f70e2e06 1208 __acquires(&keyring->sem)
3be59f74 1209 __acquires(&keyring_serialise_link_lock)
1da177e4 1210{
b2a4df20
DH
1211 struct assoc_array_edit *edit;
1212 int ret;
1da177e4 1213
16feef43 1214 kenter("%d,%s,%s,",
b2a4df20
DH
1215 keyring->serial, index_key->type->name, index_key->description);
1216
1217 BUG_ON(index_key->desc_len == 0);
1da177e4 1218
1da177e4 1219 if (keyring->type != &key_type_keyring)
f70e2e06
DH
1220 return -ENOTDIR;
1221
1222 down_write(&keyring->sem);
1223
1224 ret = -EKEYREVOKED;
1225 if (test_bit(KEY_FLAG_REVOKED, &keyring->flags))
1226 goto error_krsem;
1da177e4 1227
f70e2e06
DH
1228 /* serialise link/link calls to prevent parallel calls causing a cycle
1229 * when linking two keyring in opposite orders */
16feef43 1230 if (index_key->type == &key_type_keyring)
3be59f74 1231 mutex_lock(&keyring_serialise_link_lock);
553d603c 1232
b2a4df20
DH
1233 /* Create an edit script that will insert/replace the key in the
1234 * keyring tree.
1235 */
1236 edit = assoc_array_insert(&keyring->keys,
1237 &keyring_assoc_array_ops,
1238 index_key,
1239 NULL);
1240 if (IS_ERR(edit)) {
1241 ret = PTR_ERR(edit);
034faeb9
DH
1242 goto error_sem;
1243 }
1244
1245 /* If we're not replacing a link in-place then we're going to need some
1246 * extra quota.
1247 */
1248 if (!edit->dead_leaf) {
1249 ret = key_payload_reserve(keyring,
1250 keyring->datalen + KEYQUOTA_LINK_BYTES);
1251 if (ret < 0)
1252 goto error_cancel;
1da177e4
LT
1253 }
1254
b2a4df20 1255 *_edit = edit;
f70e2e06
DH
1256 kleave(" = 0");
1257 return 0;
1da177e4 1258
034faeb9
DH
1259error_cancel:
1260 assoc_array_cancel_edit(edit);
f70e2e06 1261error_sem:
16feef43 1262 if (index_key->type == &key_type_keyring)
3be59f74 1263 mutex_unlock(&keyring_serialise_link_lock);
f70e2e06
DH
1264error_krsem:
1265 up_write(&keyring->sem);
1266 kleave(" = %d", ret);
1267 return ret;
1268}
1da177e4 1269
f70e2e06 1270/*
973c9f4f
DH
1271 * Check already instantiated keys aren't going to be a problem.
1272 *
1273 * The caller must have called __key_link_begin(). Don't need to call this for
1274 * keys that were created since __key_link_begin() was called.
f70e2e06
DH
1275 */
1276int __key_link_check_live_key(struct key *keyring, struct key *key)
1277{
1278 if (key->type == &key_type_keyring)
1279 /* check that we aren't going to create a cycle by linking one
1280 * keyring to another */
1281 return keyring_detect_cycle(keyring, key);
1282 return 0;
1283}
1284
1285/*
973c9f4f
DH
1286 * Link a key into to a keyring.
1287 *
1288 * Must be called with __key_link_begin() having being called. Discards any
1289 * already extant link to matching key if there is one, so that each keyring
1290 * holds at most one link to any given key of a particular type+description
1291 * combination.
f70e2e06 1292 */
b2a4df20 1293void __key_link(struct key *key, struct assoc_array_edit **_edit)
f70e2e06 1294{
ccc3e6d9 1295 __key_get(key);
b2a4df20
DH
1296 assoc_array_insert_set_object(*_edit, keyring_key_to_ptr(key));
1297 assoc_array_apply_edit(*_edit);
1298 *_edit = NULL;
f70e2e06
DH
1299}
1300
1301/*
973c9f4f
DH
1302 * Finish linking a key into to a keyring.
1303 *
1304 * Must be called with __key_link_begin() having being called.
f70e2e06 1305 */
16feef43
DH
1306void __key_link_end(struct key *keyring,
1307 const struct keyring_index_key *index_key,
b2a4df20 1308 struct assoc_array_edit *edit)
f70e2e06 1309 __releases(&keyring->sem)
3be59f74 1310 __releases(&keyring_serialise_link_lock)
f70e2e06 1311{
16feef43 1312 BUG_ON(index_key->type == NULL);
b2a4df20 1313 kenter("%d,%s,", keyring->serial, index_key->type->name);
f70e2e06 1314
16feef43 1315 if (index_key->type == &key_type_keyring)
3be59f74 1316 mutex_unlock(&keyring_serialise_link_lock);
f70e2e06 1317
ca4da5dd
CIK
1318 if (edit) {
1319 if (!edit->dead_leaf) {
1320 key_payload_reserve(keyring,
1321 keyring->datalen - KEYQUOTA_LINK_BYTES);
1322 }
b2a4df20 1323 assoc_array_cancel_edit(edit);
f70e2e06
DH
1324 }
1325 up_write(&keyring->sem);
1326}
1da177e4 1327
5ac7eace
DH
1328/*
1329 * Check addition of keys to restricted keyrings.
1330 */
1331static int __key_link_check_restriction(struct key *keyring, struct key *key)
1332{
2b6aa412 1333 if (!keyring->restrict_link || !keyring->restrict_link->check)
5ac7eace 1334 return 0;
2b6aa412
MM
1335 return keyring->restrict_link->check(keyring, key->type, &key->payload,
1336 keyring->restrict_link->key);
5ac7eace
DH
1337}
1338
973c9f4f
DH
1339/**
1340 * key_link - Link a key to a keyring
1341 * @keyring: The keyring to make the link in.
1342 * @key: The key to link to.
1343 *
1344 * Make a link in a keyring to a key, such that the keyring holds a reference
1345 * on that key and the key can potentially be found by searching that keyring.
1346 *
1347 * This function will write-lock the keyring's semaphore and will consume some
1348 * of the user's key data quota to hold the link.
1349 *
1350 * Returns 0 if successful, -ENOTDIR if the keyring isn't a keyring,
1351 * -EKEYREVOKED if the keyring has been revoked, -ENFILE if the keyring is
1352 * full, -EDQUOT if there is insufficient key data quota remaining to add
1353 * another link or -ENOMEM if there's insufficient memory.
1354 *
1355 * It is assumed that the caller has checked that it is permitted for a link to
1356 * be made (the keyring should have Write permission and the key Link
1357 * permission).
1da177e4
LT
1358 */
1359int key_link(struct key *keyring, struct key *key)
1360{
b2a4df20 1361 struct assoc_array_edit *edit;
1da177e4
LT
1362 int ret;
1363
fff29291 1364 kenter("{%d,%d}", keyring->serial, refcount_read(&keyring->usage));
b2a4df20 1365
1da177e4
LT
1366 key_check(keyring);
1367 key_check(key);
1368
b2a4df20 1369 ret = __key_link_begin(keyring, &key->index_key, &edit);
f70e2e06 1370 if (ret == 0) {
fff29291 1371 kdebug("begun {%d,%d}", keyring->serial, refcount_read(&keyring->usage));
5ac7eace
DH
1372 ret = __key_link_check_restriction(keyring, key);
1373 if (ret == 0)
1374 ret = __key_link_check_live_key(keyring, key);
f70e2e06 1375 if (ret == 0)
b2a4df20
DH
1376 __key_link(key, &edit);
1377 __key_link_end(keyring, &key->index_key, edit);
f70e2e06 1378 }
1da177e4 1379
fff29291 1380 kleave(" = %d {%d,%d}", ret, keyring->serial, refcount_read(&keyring->usage));
1da177e4 1381 return ret;
f70e2e06 1382}
1da177e4
LT
1383EXPORT_SYMBOL(key_link);
1384
eb0f68cb
DH
1385/*
1386 * Lock a keyring for unlink.
1387 */
1388static int __key_unlink_lock(struct key *keyring)
1389 __acquires(&keyring->sem)
1390{
1391 if (keyring->type != &key_type_keyring)
1392 return -ENOTDIR;
1393
1394 down_write(&keyring->sem);
1395 return 0;
1396}
1397
1398/*
1399 * Begin the process of unlinking a key from a keyring.
1400 */
1401static int __key_unlink_begin(struct key *keyring, struct key *key,
1402 struct assoc_array_edit **_edit)
1403{
1404 struct assoc_array_edit *edit;
1405
1406 BUG_ON(*_edit != NULL);
1407
1408 edit = assoc_array_delete(&keyring->keys, &keyring_assoc_array_ops,
1409 &key->index_key);
1410 if (IS_ERR(edit))
1411 return PTR_ERR(edit);
1412
1413 if (!edit)
1414 return -ENOENT;
1415
1416 *_edit = edit;
1417 return 0;
1418}
1419
1420/*
1421 * Apply an unlink change.
1422 */
1423static void __key_unlink(struct key *keyring, struct key *key,
1424 struct assoc_array_edit **_edit)
1425{
1426 assoc_array_apply_edit(*_edit);
1427 *_edit = NULL;
1428 key_payload_reserve(keyring, keyring->datalen - KEYQUOTA_LINK_BYTES);
1429}
1430
1431/*
1432 * Finish unlinking a key from to a keyring.
1433 */
1434static void __key_unlink_end(struct key *keyring,
1435 struct key *key,
1436 struct assoc_array_edit *edit)
1437 __releases(&keyring->sem)
1438{
1439 if (edit)
1440 assoc_array_cancel_edit(edit);
1441 up_write(&keyring->sem);
1442}
1443
973c9f4f
DH
1444/**
1445 * key_unlink - Unlink the first link to a key from a keyring.
1446 * @keyring: The keyring to remove the link from.
1447 * @key: The key the link is to.
1448 *
1449 * Remove a link from a keyring to a key.
1450 *
1451 * This function will write-lock the keyring's semaphore.
1452 *
1453 * Returns 0 if successful, -ENOTDIR if the keyring isn't a keyring, -ENOENT if
1454 * the key isn't linked to by the keyring or -ENOMEM if there's insufficient
1455 * memory.
1456 *
1457 * It is assumed that the caller has checked that it is permitted for a link to
1458 * be removed (the keyring should have Write permission; no permissions are
1459 * required on the key).
1da177e4
LT
1460 */
1461int key_unlink(struct key *keyring, struct key *key)
1462{
eb0f68cb 1463 struct assoc_array_edit *edit = NULL;
b2a4df20 1464 int ret;
1da177e4
LT
1465
1466 key_check(keyring);
1467 key_check(key);
1468
eb0f68cb
DH
1469 ret = __key_unlink_lock(keyring);
1470 if (ret < 0)
1471 return ret;
1da177e4 1472
eb0f68cb
DH
1473 ret = __key_unlink_begin(keyring, key, &edit);
1474 if (ret == 0)
1475 __key_unlink(keyring, key, &edit);
1476 __key_unlink_end(keyring, key, edit);
b2a4df20 1477 return ret;
a8b17ed0 1478}
1da177e4
LT
1479EXPORT_SYMBOL(key_unlink);
1480
973c9f4f
DH
1481/**
1482 * keyring_clear - Clear a keyring
1483 * @keyring: The keyring to clear.
1484 *
1485 * Clear the contents of the specified keyring.
1486 *
1487 * Returns 0 if successful or -ENOTDIR if the keyring isn't a keyring.
1da177e4
LT
1488 */
1489int keyring_clear(struct key *keyring)
1490{
b2a4df20 1491 struct assoc_array_edit *edit;
76d8aeab 1492 int ret;
1da177e4 1493
b2a4df20
DH
1494 if (keyring->type != &key_type_keyring)
1495 return -ENOTDIR;
1da177e4 1496
b2a4df20 1497 down_write(&keyring->sem);
1da177e4 1498
b2a4df20
DH
1499 edit = assoc_array_clear(&keyring->keys, &keyring_assoc_array_ops);
1500 if (IS_ERR(edit)) {
1501 ret = PTR_ERR(edit);
1502 } else {
1503 if (edit)
1504 assoc_array_apply_edit(edit);
1505 key_payload_reserve(keyring, 0);
1da177e4
LT
1506 ret = 0;
1507 }
1508
b2a4df20 1509 up_write(&keyring->sem);
1da177e4 1510 return ret;
a8b17ed0 1511}
1da177e4 1512EXPORT_SYMBOL(keyring_clear);
31204ed9 1513
31204ed9 1514/*
973c9f4f
DH
1515 * Dispose of the links from a revoked keyring.
1516 *
1517 * This is called with the key sem write-locked.
31204ed9
DH
1518 */
1519static void keyring_revoke(struct key *keyring)
1520{
b2a4df20 1521 struct assoc_array_edit *edit;
f0641cba 1522
b2a4df20
DH
1523 edit = assoc_array_clear(&keyring->keys, &keyring_assoc_array_ops);
1524 if (!IS_ERR(edit)) {
1525 if (edit)
1526 assoc_array_apply_edit(edit);
1527 key_payload_reserve(keyring, 0);
1528 }
1529}
31204ed9 1530
62fe3182 1531static bool keyring_gc_select_iterator(void *object, void *iterator_data)
b2a4df20
DH
1532{
1533 struct key *key = keyring_ptr_to_key(object);
074d5898 1534 time64_t *limit = iterator_data;
31204ed9 1535
b2a4df20
DH
1536 if (key_is_dead(key, *limit))
1537 return false;
1538 key_get(key);
1539 return true;
a8b17ed0 1540}
5d135440 1541
62fe3182
DH
1542static int keyring_gc_check_iterator(const void *object, void *iterator_data)
1543{
1544 const struct key *key = keyring_ptr_to_key(object);
074d5898 1545 time64_t *limit = iterator_data;
62fe3182
DH
1546
1547 key_check(key);
1548 return key_is_dead(key, *limit);
1549}
1550
5d135440 1551/*
62fe3182 1552 * Garbage collect pointers from a keyring.
973c9f4f 1553 *
62fe3182
DH
1554 * Not called with any locks held. The keyring's key struct will not be
1555 * deallocated under us as only our caller may deallocate it.
5d135440 1556 */
074d5898 1557void keyring_gc(struct key *keyring, time64_t limit)
5d135440 1558{
62fe3182
DH
1559 int result;
1560
1561 kenter("%x{%s}", keyring->serial, keyring->description ?: "");
5d135440 1562
62fe3182
DH
1563 if (keyring->flags & ((1 << KEY_FLAG_INVALIDATED) |
1564 (1 << KEY_FLAG_REVOKED)))
1565 goto dont_gc;
1566
1567 /* scan the keyring looking for dead keys */
1568 rcu_read_lock();
1569 result = assoc_array_iterate(&keyring->keys,
1570 keyring_gc_check_iterator, &limit);
1571 rcu_read_unlock();
1572 if (result == true)
1573 goto do_gc;
1574
1575dont_gc:
1576 kleave(" [no gc]");
1577 return;
1578
1579do_gc:
5d135440 1580 down_write(&keyring->sem);
b2a4df20 1581 assoc_array_gc(&keyring->keys, &keyring_assoc_array_ops,
62fe3182 1582 keyring_gc_select_iterator, &limit);
c08ef808 1583 up_write(&keyring->sem);
62fe3182 1584 kleave(" [gc]");
5d135440 1585}
2b6aa412
MM
1586
1587/*
1588 * Garbage collect restriction pointers from a keyring.
1589 *
1590 * Keyring restrictions are associated with a key type, and must be cleaned
1591 * up if the key type is unregistered. The restriction is altered to always
1592 * reject additional keys so a keyring cannot be opened up by unregistering
1593 * a key type.
1594 *
1595 * Not called with any keyring locks held. The keyring's key struct will not
1596 * be deallocated under us as only our caller may deallocate it.
1597 *
1598 * The caller is required to hold key_types_sem and dead_type->sem. This is
1599 * fulfilled by key_gc_keytype() holding the locks on behalf of
1600 * key_garbage_collector(), which it invokes on a workqueue.
1601 */
1602void keyring_restriction_gc(struct key *keyring, struct key_type *dead_type)
1603{
1604 struct key_restriction *keyres;
1605
1606 kenter("%x{%s}", keyring->serial, keyring->description ?: "");
1607
1608 /*
1609 * keyring->restrict_link is only assigned at key allocation time
1610 * or with the key type locked, so the only values that could be
1611 * concurrently assigned to keyring->restrict_link are for key
1612 * types other than dead_type. Given this, it's ok to check
1613 * the key type before acquiring keyring->sem.
1614 */
1615 if (!dead_type || !keyring->restrict_link ||
1616 keyring->restrict_link->keytype != dead_type) {
1617 kleave(" [no restriction gc]");
1618 return;
1619 }
1620
1621 /* Lock the keyring to ensure that a link is not in progress */
1622 down_write(&keyring->sem);
1623
1624 keyres = keyring->restrict_link;
1625
1626 keyres->check = restrict_link_reject;
1627
1628 key_put(keyres->key);
1629 keyres->key = NULL;
1630 keyres->keytype = NULL;
1631
1632 up_write(&keyring->sem);
1633
1634 kleave(" [restriction gc]");
1635}