Commit | Line | Data |
---|---|---|
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 | ||
12 | #include <linux/module.h> | |
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 | ||
42 | static inline bool keyring_ptr_is_keyring(const struct assoc_array_ptr *x) | |
43 | { | |
44 | return (unsigned long)x & KEYRING_PTR_SUBTYPE; | |
45 | } | |
46 | static 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 | } | |
51 | static 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 |
58 | static struct list_head keyring_name_hash[KEYRING_NAME_HASH_SIZE]; |
59 | static DEFINE_RWLOCK(keyring_name_lock); | |
60 | ||
61 | static 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 LT |
75 | */ |
76 | static int keyring_instantiate(struct key *keyring, | |
cf7f601c | 77 | struct key_preparsed_payload *prep); |
31204ed9 | 78 | static void keyring_revoke(struct key *keyring); |
1da177e4 LT |
79 | static void keyring_destroy(struct key *keyring); |
80 | static void keyring_describe(const struct key *keyring, struct seq_file *m); | |
81 | static long keyring_read(const struct key *keyring, | |
82 | char __user *buffer, size_t buflen); | |
83 | ||
84 | struct key_type key_type_keyring = { | |
85 | .name = "keyring", | |
b2a4df20 | 86 | .def_datalen = 0, |
1da177e4 | 87 | .instantiate = keyring_instantiate, |
b2a4df20 | 88 | .match = user_match, |
31204ed9 | 89 | .revoke = keyring_revoke, |
1da177e4 LT |
90 | .destroy = keyring_destroy, |
91 | .describe = keyring_describe, | |
92 | .read = keyring_read, | |
93 | }; | |
7318226e DH |
94 | EXPORT_SYMBOL(key_type_keyring); |
95 | ||
1da177e4 | 96 | /* |
973c9f4f DH |
97 | * Semaphore to serialise link/link calls to prevent two link calls in parallel |
98 | * introducing a cycle. | |
1da177e4 | 99 | */ |
1ae8f407 | 100 | static DECLARE_RWSEM(keyring_serialise_link_sem); |
1da177e4 | 101 | |
1da177e4 | 102 | /* |
973c9f4f DH |
103 | * Publish the name of a keyring so that it can be found by name (if it has |
104 | * one). | |
1da177e4 | 105 | */ |
69664cf1 | 106 | static void keyring_publish_name(struct key *keyring) |
1da177e4 LT |
107 | { |
108 | int bucket; | |
109 | ||
110 | if (keyring->description) { | |
111 | bucket = keyring_hash(keyring->description); | |
112 | ||
113 | write_lock(&keyring_name_lock); | |
114 | ||
115 | if (!keyring_name_hash[bucket].next) | |
116 | INIT_LIST_HEAD(&keyring_name_hash[bucket]); | |
117 | ||
118 | list_add_tail(&keyring->type_data.link, | |
119 | &keyring_name_hash[bucket]); | |
120 | ||
121 | write_unlock(&keyring_name_lock); | |
122 | } | |
a8b17ed0 | 123 | } |
1da177e4 | 124 | |
1da177e4 | 125 | /* |
973c9f4f DH |
126 | * Initialise a keyring. |
127 | * | |
128 | * Returns 0 on success, -EINVAL if given any data. | |
1da177e4 LT |
129 | */ |
130 | static int keyring_instantiate(struct key *keyring, | |
cf7f601c | 131 | struct key_preparsed_payload *prep) |
1da177e4 LT |
132 | { |
133 | int ret; | |
134 | ||
135 | ret = -EINVAL; | |
cf7f601c | 136 | if (prep->datalen == 0) { |
b2a4df20 | 137 | assoc_array_init(&keyring->keys); |
1da177e4 LT |
138 | /* make the keyring available by name if it has one */ |
139 | keyring_publish_name(keyring); | |
140 | ret = 0; | |
141 | } | |
142 | ||
143 | return ret; | |
a8b17ed0 | 144 | } |
1da177e4 | 145 | |
1da177e4 | 146 | /* |
b2a4df20 DH |
147 | * Multiply 64-bits by 32-bits to 96-bits and fold back to 64-bit. Ideally we'd |
148 | * fold the carry back too, but that requires inline asm. | |
149 | */ | |
150 | static u64 mult_64x32_and_fold(u64 x, u32 y) | |
151 | { | |
152 | u64 hi = (u64)(u32)(x >> 32) * y; | |
153 | u64 lo = (u64)(u32)(x) * y; | |
154 | return lo + ((u64)(u32)hi << 32) + (u32)(hi >> 32); | |
155 | } | |
156 | ||
157 | /* | |
158 | * Hash a key type and description. | |
159 | */ | |
160 | static unsigned long hash_key_type_and_desc(const struct keyring_index_key *index_key) | |
161 | { | |
162 | const unsigned level_shift = ASSOC_ARRAY_LEVEL_STEP; | |
d54e58b7 | 163 | const unsigned long fan_mask = ASSOC_ARRAY_FAN_MASK; |
b2a4df20 DH |
164 | const char *description = index_key->description; |
165 | unsigned long hash, type; | |
166 | u32 piece; | |
167 | u64 acc; | |
168 | int n, desc_len = index_key->desc_len; | |
169 | ||
170 | type = (unsigned long)index_key->type; | |
171 | ||
172 | acc = mult_64x32_and_fold(type, desc_len + 13); | |
173 | acc = mult_64x32_and_fold(acc, 9207); | |
174 | for (;;) { | |
175 | n = desc_len; | |
176 | if (n <= 0) | |
177 | break; | |
178 | if (n > 4) | |
179 | n = 4; | |
180 | piece = 0; | |
181 | memcpy(&piece, description, n); | |
182 | description += n; | |
183 | desc_len -= n; | |
184 | acc = mult_64x32_and_fold(acc, piece); | |
185 | acc = mult_64x32_and_fold(acc, 9207); | |
186 | } | |
187 | ||
188 | /* Fold the hash down to 32 bits if need be. */ | |
189 | hash = acc; | |
190 | if (ASSOC_ARRAY_KEY_CHUNK_SIZE == 32) | |
191 | hash ^= acc >> 32; | |
192 | ||
193 | /* Squidge all the keyrings into a separate part of the tree to | |
194 | * ordinary keys by making sure the lowest level segment in the hash is | |
195 | * zero for keyrings and non-zero otherwise. | |
196 | */ | |
d54e58b7 | 197 | if (index_key->type != &key_type_keyring && (hash & fan_mask) == 0) |
b2a4df20 | 198 | return hash | (hash >> (ASSOC_ARRAY_KEY_CHUNK_SIZE - level_shift)) | 1; |
d54e58b7 DH |
199 | if (index_key->type == &key_type_keyring && (hash & fan_mask) != 0) |
200 | return (hash + (hash << level_shift)) & ~fan_mask; | |
b2a4df20 DH |
201 | return hash; |
202 | } | |
203 | ||
204 | /* | |
205 | * Build the next index key chunk. | |
206 | * | |
207 | * On 32-bit systems the index key is laid out as: | |
208 | * | |
209 | * 0 4 5 9... | |
210 | * hash desclen typeptr desc[] | |
211 | * | |
212 | * On 64-bit systems: | |
213 | * | |
214 | * 0 8 9 17... | |
215 | * hash desclen typeptr desc[] | |
216 | * | |
217 | * We return it one word-sized chunk at a time. | |
1da177e4 | 218 | */ |
b2a4df20 DH |
219 | static unsigned long keyring_get_key_chunk(const void *data, int level) |
220 | { | |
221 | const struct keyring_index_key *index_key = data; | |
222 | unsigned long chunk = 0; | |
223 | long offset = 0; | |
224 | int desc_len = index_key->desc_len, n = sizeof(chunk); | |
225 | ||
226 | level /= ASSOC_ARRAY_KEY_CHUNK_SIZE; | |
227 | switch (level) { | |
228 | case 0: | |
229 | return hash_key_type_and_desc(index_key); | |
230 | case 1: | |
231 | return ((unsigned long)index_key->type << 8) | desc_len; | |
232 | case 2: | |
233 | if (desc_len == 0) | |
234 | return (u8)((unsigned long)index_key->type >> | |
235 | (ASSOC_ARRAY_KEY_CHUNK_SIZE - 8)); | |
236 | n--; | |
237 | offset = 1; | |
238 | default: | |
239 | offset += sizeof(chunk) - 1; | |
240 | offset += (level - 3) * sizeof(chunk); | |
241 | if (offset >= desc_len) | |
242 | return 0; | |
243 | desc_len -= offset; | |
244 | if (desc_len > n) | |
245 | desc_len = n; | |
246 | offset += desc_len; | |
247 | do { | |
248 | chunk <<= 8; | |
249 | chunk |= ((u8*)index_key->description)[--offset]; | |
250 | } while (--desc_len > 0); | |
251 | ||
252 | if (level == 2) { | |
253 | chunk <<= 8; | |
254 | chunk |= (u8)((unsigned long)index_key->type >> | |
255 | (ASSOC_ARRAY_KEY_CHUNK_SIZE - 8)); | |
256 | } | |
257 | return chunk; | |
258 | } | |
259 | } | |
260 | ||
261 | static unsigned long keyring_get_object_key_chunk(const void *object, int level) | |
262 | { | |
263 | const struct key *key = keyring_ptr_to_key(object); | |
264 | return keyring_get_key_chunk(&key->index_key, level); | |
265 | } | |
266 | ||
267 | static bool keyring_compare_object(const void *object, const void *data) | |
1da177e4 | 268 | { |
b2a4df20 DH |
269 | const struct keyring_index_key *index_key = data; |
270 | const struct key *key = keyring_ptr_to_key(object); | |
271 | ||
272 | return key->index_key.type == index_key->type && | |
273 | key->index_key.desc_len == index_key->desc_len && | |
274 | memcmp(key->index_key.description, index_key->description, | |
275 | index_key->desc_len) == 0; | |
a8b17ed0 | 276 | } |
1da177e4 | 277 | |
b2a4df20 DH |
278 | /* |
279 | * Compare the index keys of a pair of objects and determine the bit position | |
280 | * at which they differ - if they differ. | |
281 | */ | |
23fd78d7 | 282 | static int keyring_diff_objects(const void *object, const void *data) |
b2a4df20 | 283 | { |
23fd78d7 | 284 | const struct key *key_a = keyring_ptr_to_key(object); |
b2a4df20 | 285 | const struct keyring_index_key *a = &key_a->index_key; |
23fd78d7 | 286 | const struct keyring_index_key *b = data; |
b2a4df20 DH |
287 | unsigned long seg_a, seg_b; |
288 | int level, i; | |
289 | ||
290 | level = 0; | |
291 | seg_a = hash_key_type_and_desc(a); | |
292 | seg_b = hash_key_type_and_desc(b); | |
293 | if ((seg_a ^ seg_b) != 0) | |
294 | goto differ; | |
295 | ||
296 | /* The number of bits contributed by the hash is controlled by a | |
297 | * constant in the assoc_array headers. Everything else thereafter we | |
298 | * can deal with as being machine word-size dependent. | |
299 | */ | |
300 | level += ASSOC_ARRAY_KEY_CHUNK_SIZE / 8; | |
301 | seg_a = a->desc_len; | |
302 | seg_b = b->desc_len; | |
303 | if ((seg_a ^ seg_b) != 0) | |
304 | goto differ; | |
305 | ||
306 | /* The next bit may not work on big endian */ | |
307 | level++; | |
308 | seg_a = (unsigned long)a->type; | |
309 | seg_b = (unsigned long)b->type; | |
310 | if ((seg_a ^ seg_b) != 0) | |
311 | goto differ; | |
312 | ||
313 | level += sizeof(unsigned long); | |
314 | if (a->desc_len == 0) | |
315 | goto same; | |
316 | ||
317 | i = 0; | |
318 | if (((unsigned long)a->description | (unsigned long)b->description) & | |
319 | (sizeof(unsigned long) - 1)) { | |
320 | do { | |
321 | seg_a = *(unsigned long *)(a->description + i); | |
322 | seg_b = *(unsigned long *)(b->description + i); | |
323 | if ((seg_a ^ seg_b) != 0) | |
324 | goto differ_plus_i; | |
325 | i += sizeof(unsigned long); | |
326 | } while (i < (a->desc_len & (sizeof(unsigned long) - 1))); | |
327 | } | |
328 | ||
329 | for (; i < a->desc_len; i++) { | |
330 | seg_a = *(unsigned char *)(a->description + i); | |
331 | seg_b = *(unsigned char *)(b->description + i); | |
332 | if ((seg_a ^ seg_b) != 0) | |
333 | goto differ_plus_i; | |
334 | } | |
335 | ||
336 | same: | |
337 | return -1; | |
338 | ||
339 | differ_plus_i: | |
340 | level += i; | |
341 | differ: | |
342 | i = level * 8 + __ffs(seg_a ^ seg_b); | |
343 | return i; | |
344 | } | |
345 | ||
346 | /* | |
347 | * Free an object after stripping the keyring flag off of the pointer. | |
348 | */ | |
349 | static void keyring_free_object(void *object) | |
350 | { | |
351 | key_put(keyring_ptr_to_key(object)); | |
352 | } | |
353 | ||
354 | /* | |
355 | * Operations for keyring management by the index-tree routines. | |
356 | */ | |
357 | static const struct assoc_array_ops keyring_assoc_array_ops = { | |
358 | .get_key_chunk = keyring_get_key_chunk, | |
359 | .get_object_key_chunk = keyring_get_object_key_chunk, | |
360 | .compare_object = keyring_compare_object, | |
361 | .diff_objects = keyring_diff_objects, | |
362 | .free_object = keyring_free_object, | |
363 | }; | |
364 | ||
1da177e4 | 365 | /* |
973c9f4f DH |
366 | * Clean up a keyring when it is destroyed. Unpublish its name if it had one |
367 | * and dispose of its data. | |
233e4735 DH |
368 | * |
369 | * The garbage collector detects the final key_put(), removes the keyring from | |
370 | * the serial number tree and then does RCU synchronisation before coming here, | |
371 | * so we shouldn't need to worry about code poking around here with the RCU | |
372 | * readlock held by this time. | |
1da177e4 LT |
373 | */ |
374 | static void keyring_destroy(struct key *keyring) | |
375 | { | |
1da177e4 LT |
376 | if (keyring->description) { |
377 | write_lock(&keyring_name_lock); | |
94efe72f DH |
378 | |
379 | if (keyring->type_data.link.next != NULL && | |
380 | !list_empty(&keyring->type_data.link)) | |
381 | list_del(&keyring->type_data.link); | |
382 | ||
1da177e4 LT |
383 | write_unlock(&keyring_name_lock); |
384 | } | |
385 | ||
b2a4df20 | 386 | assoc_array_destroy(&keyring->keys, &keyring_assoc_array_ops); |
a8b17ed0 | 387 | } |
1da177e4 | 388 | |
1da177e4 | 389 | /* |
973c9f4f | 390 | * Describe a keyring for /proc. |
1da177e4 LT |
391 | */ |
392 | static void keyring_describe(const struct key *keyring, struct seq_file *m) | |
393 | { | |
c8563473 | 394 | if (keyring->description) |
1da177e4 | 395 | seq_puts(m, keyring->description); |
c8563473 | 396 | else |
1da177e4 | 397 | seq_puts(m, "[anon]"); |
1da177e4 | 398 | |
78b7280c | 399 | if (key_is_instantiated(keyring)) { |
b2a4df20 DH |
400 | if (keyring->keys.nr_leaves_on_tree != 0) |
401 | seq_printf(m, ": %lu", keyring->keys.nr_leaves_on_tree); | |
78b7280c DH |
402 | else |
403 | seq_puts(m, ": empty"); | |
78b7280c | 404 | } |
a8b17ed0 | 405 | } |
1da177e4 | 406 | |
b2a4df20 DH |
407 | struct keyring_read_iterator_context { |
408 | size_t qty; | |
409 | size_t count; | |
410 | key_serial_t __user *buffer; | |
411 | }; | |
412 | ||
413 | static int keyring_read_iterator(const void *object, void *data) | |
414 | { | |
415 | struct keyring_read_iterator_context *ctx = data; | |
416 | const struct key *key = keyring_ptr_to_key(object); | |
417 | int ret; | |
418 | ||
419 | kenter("{%s,%d},,{%zu/%zu}", | |
420 | key->type->name, key->serial, ctx->count, ctx->qty); | |
421 | ||
422 | if (ctx->count >= ctx->qty) | |
423 | return 1; | |
424 | ||
425 | ret = put_user(key->serial, ctx->buffer); | |
426 | if (ret < 0) | |
427 | return ret; | |
428 | ctx->buffer++; | |
429 | ctx->count += sizeof(key->serial); | |
430 | return 0; | |
431 | } | |
432 | ||
1da177e4 | 433 | /* |
973c9f4f DH |
434 | * Read a list of key IDs from the keyring's contents in binary form |
435 | * | |
b2a4df20 DH |
436 | * The keyring's semaphore is read-locked by the caller. This prevents someone |
437 | * from modifying it under us - which could cause us to read key IDs multiple | |
438 | * times. | |
1da177e4 LT |
439 | */ |
440 | static long keyring_read(const struct key *keyring, | |
441 | char __user *buffer, size_t buflen) | |
442 | { | |
b2a4df20 DH |
443 | struct keyring_read_iterator_context ctx; |
444 | unsigned long nr_keys; | |
445 | int ret; | |
1da177e4 | 446 | |
b2a4df20 DH |
447 | kenter("{%d},,%zu", key_serial(keyring), buflen); |
448 | ||
449 | if (buflen & (sizeof(key_serial_t) - 1)) | |
450 | return -EINVAL; | |
451 | ||
452 | nr_keys = keyring->keys.nr_leaves_on_tree; | |
453 | if (nr_keys == 0) | |
454 | return 0; | |
1da177e4 | 455 | |
b2a4df20 DH |
456 | /* Calculate how much data we could return */ |
457 | ctx.qty = nr_keys * sizeof(key_serial_t); | |
458 | ||
459 | if (!buffer || !buflen) | |
460 | return ctx.qty; | |
461 | ||
462 | if (buflen > ctx.qty) | |
463 | ctx.qty = buflen; | |
464 | ||
465 | /* Copy the IDs of the subscribed keys into the buffer */ | |
466 | ctx.buffer = (key_serial_t __user *)buffer; | |
467 | ctx.count = 0; | |
468 | ret = assoc_array_iterate(&keyring->keys, keyring_read_iterator, &ctx); | |
469 | if (ret < 0) { | |
470 | kleave(" = %d [iterate]", ret); | |
471 | return ret; | |
1da177e4 LT |
472 | } |
473 | ||
b2a4df20 DH |
474 | kleave(" = %zu [ok]", ctx.count); |
475 | return ctx.count; | |
a8b17ed0 | 476 | } |
1da177e4 | 477 | |
1da177e4 | 478 | /* |
973c9f4f | 479 | * Allocate a keyring and link into the destination keyring. |
1da177e4 | 480 | */ |
9a56c2db | 481 | struct key *keyring_alloc(const char *description, kuid_t uid, kgid_t gid, |
96b5c8fe DH |
482 | const struct cred *cred, key_perm_t perm, |
483 | unsigned long flags, struct key *dest) | |
1da177e4 LT |
484 | { |
485 | struct key *keyring; | |
486 | int ret; | |
487 | ||
488 | keyring = key_alloc(&key_type_keyring, description, | |
96b5c8fe | 489 | uid, gid, cred, perm, flags); |
1da177e4 | 490 | if (!IS_ERR(keyring)) { |
3e30148c | 491 | ret = key_instantiate_and_link(keyring, NULL, 0, dest, NULL); |
1da177e4 LT |
492 | if (ret < 0) { |
493 | key_put(keyring); | |
494 | keyring = ERR_PTR(ret); | |
495 | } | |
496 | } | |
497 | ||
498 | return keyring; | |
a8b17ed0 | 499 | } |
f8aa23a5 | 500 | EXPORT_SYMBOL(keyring_alloc); |
1da177e4 | 501 | |
b2a4df20 DH |
502 | /* |
503 | * Iteration function to consider each key found. | |
1da177e4 | 504 | */ |
b2a4df20 | 505 | static int keyring_search_iterator(const void *object, void *iterator_data) |
1da177e4 | 506 | { |
b2a4df20 DH |
507 | struct keyring_search_context *ctx = iterator_data; |
508 | const struct key *key = keyring_ptr_to_key(object); | |
509 | unsigned long kflags = key->flags; | |
1da177e4 | 510 | |
b2a4df20 | 511 | kenter("{%d}", key->serial); |
1da177e4 | 512 | |
b2a4df20 DH |
513 | /* ignore keys not of this type */ |
514 | if (key->type != ctx->index_key.type) { | |
515 | kleave(" = 0 [!type]"); | |
516 | return 0; | |
29db9190 | 517 | } |
1da177e4 | 518 | |
b2a4df20 DH |
519 | /* skip invalidated, revoked and expired keys */ |
520 | if (ctx->flags & KEYRING_SEARCH_DO_STATE_CHECK) { | |
521 | if (kflags & ((1 << KEY_FLAG_INVALIDATED) | | |
522 | (1 << KEY_FLAG_REVOKED))) { | |
523 | ctx->result = ERR_PTR(-EKEYREVOKED); | |
524 | kleave(" = %d [invrev]", ctx->skipped_ret); | |
525 | goto skipped; | |
526 | } | |
1da177e4 | 527 | |
b2a4df20 DH |
528 | if (key->expiry && ctx->now.tv_sec >= key->expiry) { |
529 | ctx->result = ERR_PTR(-EKEYEXPIRED); | |
530 | kleave(" = %d [expire]", ctx->skipped_ret); | |
531 | goto skipped; | |
532 | } | |
533 | } | |
664cceb0 | 534 | |
b2a4df20 DH |
535 | /* keys that don't match */ |
536 | if (!ctx->match(key, ctx->match_data)) { | |
537 | kleave(" = 0 [!match]"); | |
538 | return 0; | |
539 | } | |
dceba994 | 540 | |
b2a4df20 DH |
541 | /* key must have search permissions */ |
542 | if (!(ctx->flags & KEYRING_SEARCH_NO_CHECK_PERM) && | |
543 | key_task_permission(make_key_ref(key, ctx->possessed), | |
544 | ctx->cred, KEY_SEARCH) < 0) { | |
545 | ctx->result = ERR_PTR(-EACCES); | |
546 | kleave(" = %d [!perm]", ctx->skipped_ret); | |
547 | goto skipped; | |
dceba994 KC |
548 | } |
549 | ||
b2a4df20 DH |
550 | if (ctx->flags & KEYRING_SEARCH_DO_STATE_CHECK) { |
551 | /* we set a different error code if we pass a negative key */ | |
552 | if (kflags & (1 << KEY_FLAG_NEGATIVE)) { | |
74792b00 | 553 | smp_rmb(); |
b2a4df20 DH |
554 | ctx->result = ERR_PTR(key->type_data.reject_error); |
555 | kleave(" = %d [neg]", ctx->skipped_ret); | |
556 | goto skipped; | |
557 | } | |
558 | } | |
1da177e4 | 559 | |
b2a4df20 DH |
560 | /* Found */ |
561 | ctx->result = make_key_ref(key, ctx->possessed); | |
562 | kleave(" = 1 [found]"); | |
563 | return 1; | |
1da177e4 | 564 | |
b2a4df20 DH |
565 | skipped: |
566 | return ctx->skipped_ret; | |
567 | } | |
1da177e4 | 568 | |
b2a4df20 DH |
569 | /* |
570 | * Search inside a keyring for a key. We can search by walking to it | |
571 | * directly based on its index-key or we can iterate over the entire | |
572 | * tree looking for it, based on the match function. | |
573 | */ | |
574 | static int search_keyring(struct key *keyring, struct keyring_search_context *ctx) | |
575 | { | |
576 | if ((ctx->flags & KEYRING_SEARCH_LOOKUP_TYPE) == | |
577 | KEYRING_SEARCH_LOOKUP_DIRECT) { | |
578 | const void *object; | |
579 | ||
580 | object = assoc_array_find(&keyring->keys, | |
581 | &keyring_assoc_array_ops, | |
582 | &ctx->index_key); | |
583 | return object ? ctx->iterator(object, ctx) : 0; | |
584 | } | |
585 | return assoc_array_iterate(&keyring->keys, ctx->iterator, ctx); | |
586 | } | |
1da177e4 | 587 | |
b2a4df20 DH |
588 | /* |
589 | * Search a tree of keyrings that point to other keyrings up to the maximum | |
590 | * depth. | |
591 | */ | |
592 | static bool search_nested_keyrings(struct key *keyring, | |
593 | struct keyring_search_context *ctx) | |
594 | { | |
595 | struct { | |
596 | struct key *keyring; | |
597 | struct assoc_array_node *node; | |
598 | int slot; | |
599 | } stack[KEYRING_SEARCH_MAX_DEPTH]; | |
1da177e4 | 600 | |
b2a4df20 DH |
601 | struct assoc_array_shortcut *shortcut; |
602 | struct assoc_array_node *node; | |
603 | struct assoc_array_ptr *ptr; | |
604 | struct key *key; | |
605 | int sp = 0, slot; | |
1da177e4 | 606 | |
b2a4df20 DH |
607 | kenter("{%d},{%s,%s}", |
608 | keyring->serial, | |
609 | ctx->index_key.type->name, | |
610 | ctx->index_key.description); | |
1da177e4 | 611 | |
b2a4df20 DH |
612 | if (ctx->index_key.description) |
613 | ctx->index_key.desc_len = strlen(ctx->index_key.description); | |
1da177e4 | 614 | |
b2a4df20 DH |
615 | /* Check to see if this top-level keyring is what we are looking for |
616 | * and whether it is valid or not. | |
617 | */ | |
618 | if (ctx->flags & KEYRING_SEARCH_LOOKUP_ITERATE || | |
619 | keyring_compare_object(keyring, &ctx->index_key)) { | |
620 | ctx->skipped_ret = 2; | |
621 | ctx->flags |= KEYRING_SEARCH_DO_STATE_CHECK; | |
622 | switch (ctx->iterator(keyring_key_to_ptr(keyring), ctx)) { | |
623 | case 1: | |
78b7280c | 624 | goto found; |
b2a4df20 DH |
625 | case 2: |
626 | return false; | |
627 | default: | |
628 | break; | |
1da177e4 | 629 | } |
b2a4df20 | 630 | } |
1da177e4 | 631 | |
b2a4df20 DH |
632 | ctx->skipped_ret = 0; |
633 | if (ctx->flags & KEYRING_SEARCH_NO_STATE_CHECK) | |
634 | ctx->flags &= ~KEYRING_SEARCH_DO_STATE_CHECK; | |
635 | ||
636 | /* Start processing a new keyring */ | |
637 | descend_to_keyring: | |
638 | kdebug("descend to %d", keyring->serial); | |
639 | if (keyring->flags & ((1 << KEY_FLAG_INVALIDATED) | | |
640 | (1 << KEY_FLAG_REVOKED))) | |
641 | goto not_this_keyring; | |
642 | ||
643 | /* Search through the keys in this keyring before its searching its | |
644 | * subtrees. | |
645 | */ | |
646 | if (search_keyring(keyring, ctx)) | |
1da177e4 | 647 | goto found; |
1da177e4 | 648 | |
b2a4df20 DH |
649 | /* Then manually iterate through the keyrings nested in this one. |
650 | * | |
651 | * Start from the root node of the index tree. Because of the way the | |
652 | * hash function has been set up, keyrings cluster on the leftmost | |
653 | * branch of the root node (root slot 0) or in the root node itself. | |
654 | * Non-keyrings avoid the leftmost branch of the root entirely (root | |
655 | * slots 1-15). | |
656 | */ | |
657 | ptr = ACCESS_ONCE(keyring->keys.root); | |
658 | if (!ptr) | |
659 | goto not_this_keyring; | |
1da177e4 | 660 | |
b2a4df20 DH |
661 | if (assoc_array_ptr_is_shortcut(ptr)) { |
662 | /* If the root is a shortcut, either the keyring only contains | |
663 | * keyring pointers (everything clusters behind root slot 0) or | |
664 | * doesn't contain any keyring pointers. | |
1da177e4 | 665 | */ |
b2a4df20 DH |
666 | shortcut = assoc_array_ptr_to_shortcut(ptr); |
667 | smp_read_barrier_depends(); | |
668 | if ((shortcut->index_key[0] & ASSOC_ARRAY_FAN_MASK) != 0) | |
669 | goto not_this_keyring; | |
670 | ||
671 | ptr = ACCESS_ONCE(shortcut->next_node); | |
672 | node = assoc_array_ptr_to_node(ptr); | |
673 | goto begin_node; | |
674 | } | |
675 | ||
676 | node = assoc_array_ptr_to_node(ptr); | |
677 | smp_read_barrier_depends(); | |
678 | ||
679 | ptr = node->slots[0]; | |
680 | if (!assoc_array_ptr_is_meta(ptr)) | |
681 | goto begin_node; | |
682 | ||
683 | descend_to_node: | |
684 | /* Descend to a more distal node in this keyring's content tree and go | |
685 | * through that. | |
686 | */ | |
687 | kdebug("descend"); | |
688 | if (assoc_array_ptr_is_shortcut(ptr)) { | |
689 | shortcut = assoc_array_ptr_to_shortcut(ptr); | |
690 | smp_read_barrier_depends(); | |
691 | ptr = ACCESS_ONCE(shortcut->next_node); | |
692 | BUG_ON(!assoc_array_ptr_is_node(ptr)); | |
b2a4df20 | 693 | } |
9c5e45df | 694 | node = assoc_array_ptr_to_node(ptr); |
b2a4df20 DH |
695 | |
696 | begin_node: | |
697 | kdebug("begin_node"); | |
698 | smp_read_barrier_depends(); | |
699 | slot = 0; | |
700 | ascend_to_node: | |
701 | /* Go through the slots in a node */ | |
702 | for (; slot < ASSOC_ARRAY_FAN_OUT; slot++) { | |
703 | ptr = ACCESS_ONCE(node->slots[slot]); | |
704 | ||
705 | if (assoc_array_ptr_is_meta(ptr) && node->back_pointer) | |
706 | goto descend_to_node; | |
707 | ||
708 | if (!keyring_ptr_is_keyring(ptr)) | |
76d8aeab | 709 | continue; |
1da177e4 | 710 | |
b2a4df20 DH |
711 | key = keyring_ptr_to_key(ptr); |
712 | ||
713 | if (sp >= KEYRING_SEARCH_MAX_DEPTH) { | |
714 | if (ctx->flags & KEYRING_SEARCH_DETECT_TOO_DEEP) { | |
715 | ctx->result = ERR_PTR(-ELOOP); | |
716 | return false; | |
717 | } | |
718 | goto not_this_keyring; | |
719 | } | |
720 | ||
721 | /* Search a nested keyring */ | |
722 | if (!(ctx->flags & KEYRING_SEARCH_NO_CHECK_PERM) && | |
723 | key_task_permission(make_key_ref(key, ctx->possessed), | |
4bdf0bc3 | 724 | ctx->cred, KEY_SEARCH) < 0) |
76d8aeab | 725 | continue; |
1da177e4 LT |
726 | |
727 | /* stack the current position */ | |
31d5a79d | 728 | stack[sp].keyring = keyring; |
b2a4df20 DH |
729 | stack[sp].node = node; |
730 | stack[sp].slot = slot; | |
1da177e4 LT |
731 | sp++; |
732 | ||
733 | /* begin again with the new keyring */ | |
734 | keyring = key; | |
b2a4df20 DH |
735 | goto descend_to_keyring; |
736 | } | |
737 | ||
738 | /* We've dealt with all the slots in the current node, so now we need | |
739 | * to ascend to the parent and continue processing there. | |
740 | */ | |
741 | ptr = ACCESS_ONCE(node->back_pointer); | |
742 | slot = node->parent_slot; | |
743 | ||
744 | if (ptr && assoc_array_ptr_is_shortcut(ptr)) { | |
745 | shortcut = assoc_array_ptr_to_shortcut(ptr); | |
746 | smp_read_barrier_depends(); | |
747 | ptr = ACCESS_ONCE(shortcut->back_pointer); | |
748 | slot = shortcut->parent_slot; | |
749 | } | |
750 | if (!ptr) | |
751 | goto not_this_keyring; | |
752 | node = assoc_array_ptr_to_node(ptr); | |
753 | smp_read_barrier_depends(); | |
754 | slot++; | |
755 | ||
756 | /* If we've ascended to the root (zero backpointer), we must have just | |
757 | * finished processing the leftmost branch rather than the root slots - | |
758 | * so there can't be any more keyrings for us to find. | |
759 | */ | |
760 | if (node->back_pointer) { | |
761 | kdebug("ascend %d", slot); | |
762 | goto ascend_to_node; | |
1da177e4 LT |
763 | } |
764 | ||
b2a4df20 DH |
765 | /* The keyring we're looking at was disqualified or didn't contain a |
766 | * matching key. | |
767 | */ | |
664cceb0 | 768 | not_this_keyring: |
b2a4df20 DH |
769 | kdebug("not_this_keyring %d", sp); |
770 | if (sp <= 0) { | |
771 | kleave(" = false"); | |
772 | return false; | |
1da177e4 LT |
773 | } |
774 | ||
b2a4df20 DH |
775 | /* Resume the processing of a keyring higher up in the tree */ |
776 | sp--; | |
777 | keyring = stack[sp].keyring; | |
778 | node = stack[sp].node; | |
779 | slot = stack[sp].slot + 1; | |
780 | kdebug("ascend to %d [%d]", keyring->serial, slot); | |
781 | goto ascend_to_node; | |
1da177e4 | 782 | |
b2a4df20 | 783 | /* We found a viable match */ |
664cceb0 | 784 | found: |
b2a4df20 | 785 | key = key_ref_to_ptr(ctx->result); |
1da177e4 | 786 | key_check(key); |
b2a4df20 DH |
787 | if (!(ctx->flags & KEYRING_SEARCH_NO_UPDATE_TIME)) { |
788 | key->last_used_at = ctx->now.tv_sec; | |
789 | keyring->last_used_at = ctx->now.tv_sec; | |
790 | while (sp > 0) | |
791 | stack[--sp].keyring->last_used_at = ctx->now.tv_sec; | |
792 | } | |
793 | kleave(" = true"); | |
794 | return true; | |
795 | } | |
796 | ||
797 | /** | |
798 | * keyring_search_aux - Search a keyring tree for a key matching some criteria | |
799 | * @keyring_ref: A pointer to the keyring with possession indicator. | |
800 | * @ctx: The keyring search context. | |
801 | * | |
802 | * Search the supplied keyring tree for a key that matches the criteria given. | |
803 | * The root keyring and any linked keyrings must grant Search permission to the | |
804 | * caller to be searchable and keys can only be found if they too grant Search | |
805 | * to the caller. The possession flag on the root keyring pointer controls use | |
806 | * of the possessor bits in permissions checking of the entire tree. In | |
807 | * addition, the LSM gets to forbid keyring searches and key matches. | |
808 | * | |
809 | * The search is performed as a breadth-then-depth search up to the prescribed | |
810 | * limit (KEYRING_SEARCH_MAX_DEPTH). | |
811 | * | |
812 | * Keys are matched to the type provided and are then filtered by the match | |
813 | * function, which is given the description to use in any way it sees fit. The | |
814 | * match function may use any attributes of a key that it wishes to to | |
815 | * determine the match. Normally the match function from the key type would be | |
816 | * used. | |
817 | * | |
818 | * RCU can be used to prevent the keyring key lists from disappearing without | |
819 | * the need to take lots of locks. | |
820 | * | |
821 | * Returns a pointer to the found key and increments the key usage count if | |
822 | * successful; -EAGAIN if no matching keys were found, or if expired or revoked | |
823 | * keys were found; -ENOKEY if only negative keys were found; -ENOTDIR if the | |
824 | * specified keyring wasn't a keyring. | |
825 | * | |
826 | * In the case of a successful return, the possession attribute from | |
827 | * @keyring_ref is propagated to the returned key reference. | |
828 | */ | |
829 | key_ref_t keyring_search_aux(key_ref_t keyring_ref, | |
830 | struct keyring_search_context *ctx) | |
831 | { | |
832 | struct key *keyring; | |
833 | long err; | |
834 | ||
835 | ctx->iterator = keyring_search_iterator; | |
836 | ctx->possessed = is_key_possessed(keyring_ref); | |
837 | ctx->result = ERR_PTR(-EAGAIN); | |
838 | ||
839 | keyring = key_ref_to_ptr(keyring_ref); | |
840 | key_check(keyring); | |
841 | ||
842 | if (keyring->type != &key_type_keyring) | |
843 | return ERR_PTR(-ENOTDIR); | |
844 | ||
845 | if (!(ctx->flags & KEYRING_SEARCH_NO_CHECK_PERM)) { | |
846 | err = key_task_permission(keyring_ref, ctx->cred, KEY_SEARCH); | |
847 | if (err < 0) | |
848 | return ERR_PTR(err); | |
849 | } | |
850 | ||
851 | rcu_read_lock(); | |
852 | ctx->now = current_kernel_time(); | |
853 | if (search_nested_keyrings(keyring, ctx)) | |
854 | __key_get(key_ref_to_ptr(ctx->result)); | |
76d8aeab | 855 | rcu_read_unlock(); |
b2a4df20 | 856 | return ctx->result; |
a8b17ed0 | 857 | } |
1da177e4 | 858 | |
973c9f4f DH |
859 | /** |
860 | * keyring_search - Search the supplied keyring tree for a matching key | |
861 | * @keyring: The root of the keyring tree to be searched. | |
862 | * @type: The type of keyring we want to find. | |
863 | * @description: The name of the keyring we want to find. | |
864 | * | |
865 | * As keyring_search_aux() above, but using the current task's credentials and | |
b2a4df20 | 866 | * type's default matching function and preferred search method. |
1da177e4 | 867 | */ |
664cceb0 DH |
868 | key_ref_t keyring_search(key_ref_t keyring, |
869 | struct key_type *type, | |
870 | const char *description) | |
1da177e4 | 871 | { |
4bdf0bc3 DH |
872 | struct keyring_search_context ctx = { |
873 | .index_key.type = type, | |
874 | .index_key.description = description, | |
875 | .cred = current_cred(), | |
876 | .match = type->match, | |
877 | .match_data = description, | |
878 | .flags = (type->def_lookup_type | | |
879 | KEYRING_SEARCH_DO_STATE_CHECK), | |
880 | }; | |
881 | ||
882 | if (!ctx.match) | |
3e30148c DH |
883 | return ERR_PTR(-ENOKEY); |
884 | ||
4bdf0bc3 | 885 | return keyring_search_aux(keyring, &ctx); |
a8b17ed0 | 886 | } |
1da177e4 LT |
887 | EXPORT_SYMBOL(keyring_search); |
888 | ||
1da177e4 | 889 | /* |
b2a4df20 | 890 | * Search the given keyring for a key that might be updated. |
973c9f4f DH |
891 | * |
892 | * The caller must guarantee that the keyring is a keyring and that the | |
b2a4df20 DH |
893 | * permission is granted to modify the keyring as no check is made here. The |
894 | * caller must also hold a lock on the keyring semaphore. | |
973c9f4f DH |
895 | * |
896 | * Returns a pointer to the found key with usage count incremented if | |
b2a4df20 DH |
897 | * successful and returns NULL if not found. Revoked and invalidated keys are |
898 | * skipped over. | |
973c9f4f DH |
899 | * |
900 | * If successful, the possession indicator is propagated from the keyring ref | |
901 | * to the returned key reference. | |
1da177e4 | 902 | */ |
b2a4df20 DH |
903 | key_ref_t find_key_to_update(key_ref_t keyring_ref, |
904 | const struct keyring_index_key *index_key) | |
1da177e4 | 905 | { |
664cceb0 | 906 | struct key *keyring, *key; |
b2a4df20 | 907 | const void *object; |
1da177e4 | 908 | |
664cceb0 | 909 | keyring = key_ref_to_ptr(keyring_ref); |
664cceb0 | 910 | |
b2a4df20 DH |
911 | kenter("{%d},{%s,%s}", |
912 | keyring->serial, index_key->type->name, index_key->description); | |
76d8aeab | 913 | |
b2a4df20 DH |
914 | object = assoc_array_find(&keyring->keys, &keyring_assoc_array_ops, |
915 | index_key); | |
1da177e4 | 916 | |
b2a4df20 DH |
917 | if (object) |
918 | goto found; | |
919 | ||
920 | kleave(" = NULL"); | |
921 | return NULL; | |
1da177e4 | 922 | |
c5b60b5e | 923 | found: |
b2a4df20 DH |
924 | key = keyring_ptr_to_key(object); |
925 | if (key->flags & ((1 << KEY_FLAG_INVALIDATED) | | |
926 | (1 << KEY_FLAG_REVOKED))) { | |
927 | kleave(" = NULL [x]"); | |
928 | return NULL; | |
929 | } | |
ccc3e6d9 | 930 | __key_get(key); |
b2a4df20 DH |
931 | kleave(" = {%d}", key->serial); |
932 | return make_key_ref(key, is_key_possessed(keyring_ref)); | |
a8b17ed0 | 933 | } |
1da177e4 | 934 | |
1da177e4 | 935 | /* |
973c9f4f DH |
936 | * Find a keyring with the specified name. |
937 | * | |
938 | * All named keyrings in the current user namespace are searched, provided they | |
939 | * grant Search permission directly to the caller (unless this check is | |
940 | * skipped). Keyrings whose usage points have reached zero or who have been | |
941 | * revoked are skipped. | |
942 | * | |
943 | * Returns a pointer to the keyring with the keyring's refcount having being | |
944 | * incremented on success. -ENOKEY is returned if a key could not be found. | |
1da177e4 | 945 | */ |
69664cf1 | 946 | struct key *find_keyring_by_name(const char *name, bool skip_perm_check) |
1da177e4 LT |
947 | { |
948 | struct key *keyring; | |
949 | int bucket; | |
950 | ||
1da177e4 | 951 | if (!name) |
cea7daa3 | 952 | return ERR_PTR(-EINVAL); |
1da177e4 LT |
953 | |
954 | bucket = keyring_hash(name); | |
955 | ||
956 | read_lock(&keyring_name_lock); | |
957 | ||
958 | if (keyring_name_hash[bucket].next) { | |
959 | /* search this hash bucket for a keyring with a matching name | |
960 | * that's readable and that hasn't been revoked */ | |
961 | list_for_each_entry(keyring, | |
962 | &keyring_name_hash[bucket], | |
963 | type_data.link | |
964 | ) { | |
9a56c2db | 965 | if (!kuid_has_mapping(current_user_ns(), keyring->user->uid)) |
2ea190d0 SH |
966 | continue; |
967 | ||
76d8aeab | 968 | if (test_bit(KEY_FLAG_REVOKED, &keyring->flags)) |
1da177e4 LT |
969 | continue; |
970 | ||
971 | if (strcmp(keyring->description, name) != 0) | |
972 | continue; | |
973 | ||
69664cf1 DH |
974 | if (!skip_perm_check && |
975 | key_permission(make_key_ref(keyring, 0), | |
0f6ed7c2 | 976 | KEY_SEARCH) < 0) |
1da177e4 LT |
977 | continue; |
978 | ||
cea7daa3 TO |
979 | /* we've got a match but we might end up racing with |
980 | * key_cleanup() if the keyring is currently 'dead' | |
981 | * (ie. it has a zero usage count) */ | |
982 | if (!atomic_inc_not_zero(&keyring->usage)) | |
983 | continue; | |
31d5a79d | 984 | keyring->last_used_at = current_kernel_time().tv_sec; |
cea7daa3 | 985 | goto out; |
1da177e4 LT |
986 | } |
987 | } | |
988 | ||
1da177e4 | 989 | keyring = ERR_PTR(-ENOKEY); |
cea7daa3 TO |
990 | out: |
991 | read_unlock(&keyring_name_lock); | |
1da177e4 | 992 | return keyring; |
a8b17ed0 | 993 | } |
1da177e4 | 994 | |
b2a4df20 DH |
995 | static int keyring_detect_cycle_iterator(const void *object, |
996 | void *iterator_data) | |
997 | { | |
998 | struct keyring_search_context *ctx = iterator_data; | |
999 | const struct key *key = keyring_ptr_to_key(object); | |
1000 | ||
1001 | kenter("{%d}", key->serial); | |
1002 | ||
1003 | BUG_ON(key != ctx->match_data); | |
1004 | ctx->result = ERR_PTR(-EDEADLK); | |
1005 | return 1; | |
1006 | } | |
1007 | ||
1da177e4 | 1008 | /* |
973c9f4f DH |
1009 | * See if a cycle will will be created by inserting acyclic tree B in acyclic |
1010 | * tree A at the topmost level (ie: as a direct child of A). | |
1011 | * | |
1012 | * Since we are adding B to A at the top level, checking for cycles should just | |
1013 | * be a matter of seeing if node A is somewhere in tree B. | |
1da177e4 LT |
1014 | */ |
1015 | static int keyring_detect_cycle(struct key *A, struct key *B) | |
1016 | { | |
b2a4df20 DH |
1017 | struct keyring_search_context ctx = { |
1018 | .index_key = A->index_key, | |
1019 | .match_data = A, | |
1020 | .iterator = keyring_detect_cycle_iterator, | |
1021 | .flags = (KEYRING_SEARCH_LOOKUP_DIRECT | | |
1022 | KEYRING_SEARCH_NO_STATE_CHECK | | |
1023 | KEYRING_SEARCH_NO_UPDATE_TIME | | |
1024 | KEYRING_SEARCH_NO_CHECK_PERM | | |
1025 | KEYRING_SEARCH_DETECT_TOO_DEEP), | |
1026 | }; | |
1da177e4 | 1027 | |
76d8aeab | 1028 | rcu_read_lock(); |
b2a4df20 | 1029 | search_nested_keyrings(B, &ctx); |
76d8aeab | 1030 | rcu_read_unlock(); |
b2a4df20 | 1031 | return PTR_ERR(ctx.result) == -EAGAIN ? 0 : PTR_ERR(ctx.result); |
f70e2e06 | 1032 | } |
cab8eb59 | 1033 | |
1da177e4 | 1034 | /* |
973c9f4f | 1035 | * Preallocate memory so that a key can be linked into to a keyring. |
1da177e4 | 1036 | */ |
b2a4df20 DH |
1037 | int __key_link_begin(struct key *keyring, |
1038 | const struct keyring_index_key *index_key, | |
1039 | struct assoc_array_edit **_edit) | |
f70e2e06 | 1040 | __acquires(&keyring->sem) |
423b9788 | 1041 | __acquires(&keyring_serialise_link_sem) |
1da177e4 | 1042 | { |
b2a4df20 DH |
1043 | struct assoc_array_edit *edit; |
1044 | int ret; | |
1da177e4 | 1045 | |
16feef43 | 1046 | kenter("%d,%s,%s,", |
b2a4df20 DH |
1047 | keyring->serial, index_key->type->name, index_key->description); |
1048 | ||
1049 | BUG_ON(index_key->desc_len == 0); | |
1da177e4 | 1050 | |
1da177e4 | 1051 | if (keyring->type != &key_type_keyring) |
f70e2e06 DH |
1052 | return -ENOTDIR; |
1053 | ||
1054 | down_write(&keyring->sem); | |
1055 | ||
1056 | ret = -EKEYREVOKED; | |
1057 | if (test_bit(KEY_FLAG_REVOKED, &keyring->flags)) | |
1058 | goto error_krsem; | |
1da177e4 | 1059 | |
f70e2e06 DH |
1060 | /* serialise link/link calls to prevent parallel calls causing a cycle |
1061 | * when linking two keyring in opposite orders */ | |
16feef43 | 1062 | if (index_key->type == &key_type_keyring) |
553d603c DH |
1063 | down_write(&keyring_serialise_link_sem); |
1064 | ||
b2a4df20 DH |
1065 | /* Create an edit script that will insert/replace the key in the |
1066 | * keyring tree. | |
1067 | */ | |
1068 | edit = assoc_array_insert(&keyring->keys, | |
1069 | &keyring_assoc_array_ops, | |
1070 | index_key, | |
1071 | NULL); | |
1072 | if (IS_ERR(edit)) { | |
1073 | ret = PTR_ERR(edit); | |
034faeb9 DH |
1074 | goto error_sem; |
1075 | } | |
1076 | ||
1077 | /* If we're not replacing a link in-place then we're going to need some | |
1078 | * extra quota. | |
1079 | */ | |
1080 | if (!edit->dead_leaf) { | |
1081 | ret = key_payload_reserve(keyring, | |
1082 | keyring->datalen + KEYQUOTA_LINK_BYTES); | |
1083 | if (ret < 0) | |
1084 | goto error_cancel; | |
1da177e4 LT |
1085 | } |
1086 | ||
b2a4df20 | 1087 | *_edit = edit; |
f70e2e06 DH |
1088 | kleave(" = 0"); |
1089 | return 0; | |
1da177e4 | 1090 | |
034faeb9 DH |
1091 | error_cancel: |
1092 | assoc_array_cancel_edit(edit); | |
f70e2e06 | 1093 | error_sem: |
16feef43 | 1094 | if (index_key->type == &key_type_keyring) |
f70e2e06 DH |
1095 | up_write(&keyring_serialise_link_sem); |
1096 | error_krsem: | |
1097 | up_write(&keyring->sem); | |
1098 | kleave(" = %d", ret); | |
1099 | return ret; | |
1100 | } | |
1da177e4 | 1101 | |
f70e2e06 | 1102 | /* |
973c9f4f DH |
1103 | * Check already instantiated keys aren't going to be a problem. |
1104 | * | |
1105 | * The caller must have called __key_link_begin(). Don't need to call this for | |
1106 | * keys that were created since __key_link_begin() was called. | |
f70e2e06 DH |
1107 | */ |
1108 | int __key_link_check_live_key(struct key *keyring, struct key *key) | |
1109 | { | |
1110 | if (key->type == &key_type_keyring) | |
1111 | /* check that we aren't going to create a cycle by linking one | |
1112 | * keyring to another */ | |
1113 | return keyring_detect_cycle(keyring, key); | |
1114 | return 0; | |
1115 | } | |
1116 | ||
1117 | /* | |
973c9f4f DH |
1118 | * Link a key into to a keyring. |
1119 | * | |
1120 | * Must be called with __key_link_begin() having being called. Discards any | |
1121 | * already extant link to matching key if there is one, so that each keyring | |
1122 | * holds at most one link to any given key of a particular type+description | |
1123 | * combination. | |
f70e2e06 | 1124 | */ |
b2a4df20 | 1125 | void __key_link(struct key *key, struct assoc_array_edit **_edit) |
f70e2e06 | 1126 | { |
ccc3e6d9 | 1127 | __key_get(key); |
b2a4df20 DH |
1128 | assoc_array_insert_set_object(*_edit, keyring_key_to_ptr(key)); |
1129 | assoc_array_apply_edit(*_edit); | |
1130 | *_edit = NULL; | |
f70e2e06 DH |
1131 | } |
1132 | ||
1133 | /* | |
973c9f4f DH |
1134 | * Finish linking a key into to a keyring. |
1135 | * | |
1136 | * Must be called with __key_link_begin() having being called. | |
f70e2e06 | 1137 | */ |
16feef43 DH |
1138 | void __key_link_end(struct key *keyring, |
1139 | const struct keyring_index_key *index_key, | |
b2a4df20 | 1140 | struct assoc_array_edit *edit) |
f70e2e06 | 1141 | __releases(&keyring->sem) |
423b9788 | 1142 | __releases(&keyring_serialise_link_sem) |
f70e2e06 | 1143 | { |
16feef43 | 1144 | BUG_ON(index_key->type == NULL); |
b2a4df20 | 1145 | kenter("%d,%s,", keyring->serial, index_key->type->name); |
f70e2e06 | 1146 | |
16feef43 | 1147 | if (index_key->type == &key_type_keyring) |
f70e2e06 DH |
1148 | up_write(&keyring_serialise_link_sem); |
1149 | ||
034faeb9 | 1150 | if (edit && !edit->dead_leaf) { |
b2a4df20 DH |
1151 | key_payload_reserve(keyring, |
1152 | keyring->datalen - KEYQUOTA_LINK_BYTES); | |
1153 | assoc_array_cancel_edit(edit); | |
f70e2e06 DH |
1154 | } |
1155 | up_write(&keyring->sem); | |
1156 | } | |
1da177e4 | 1157 | |
973c9f4f DH |
1158 | /** |
1159 | * key_link - Link a key to a keyring | |
1160 | * @keyring: The keyring to make the link in. | |
1161 | * @key: The key to link to. | |
1162 | * | |
1163 | * Make a link in a keyring to a key, such that the keyring holds a reference | |
1164 | * on that key and the key can potentially be found by searching that keyring. | |
1165 | * | |
1166 | * This function will write-lock the keyring's semaphore and will consume some | |
1167 | * of the user's key data quota to hold the link. | |
1168 | * | |
1169 | * Returns 0 if successful, -ENOTDIR if the keyring isn't a keyring, | |
1170 | * -EKEYREVOKED if the keyring has been revoked, -ENFILE if the keyring is | |
1171 | * full, -EDQUOT if there is insufficient key data quota remaining to add | |
1172 | * another link or -ENOMEM if there's insufficient memory. | |
1173 | * | |
1174 | * It is assumed that the caller has checked that it is permitted for a link to | |
1175 | * be made (the keyring should have Write permission and the key Link | |
1176 | * permission). | |
1da177e4 LT |
1177 | */ |
1178 | int key_link(struct key *keyring, struct key *key) | |
1179 | { | |
b2a4df20 | 1180 | struct assoc_array_edit *edit; |
1da177e4 LT |
1181 | int ret; |
1182 | ||
b2a4df20 DH |
1183 | kenter("{%d,%d}", keyring->serial, atomic_read(&keyring->usage)); |
1184 | ||
1da177e4 LT |
1185 | key_check(keyring); |
1186 | key_check(key); | |
1187 | ||
008643b8 DH |
1188 | if (test_bit(KEY_FLAG_TRUSTED_ONLY, &keyring->flags) && |
1189 | !test_bit(KEY_FLAG_TRUSTED, &key->flags)) | |
1190 | return -EPERM; | |
1191 | ||
b2a4df20 | 1192 | ret = __key_link_begin(keyring, &key->index_key, &edit); |
f70e2e06 | 1193 | if (ret == 0) { |
b2a4df20 | 1194 | kdebug("begun {%d,%d}", keyring->serial, atomic_read(&keyring->usage)); |
f70e2e06 DH |
1195 | ret = __key_link_check_live_key(keyring, key); |
1196 | if (ret == 0) | |
b2a4df20 DH |
1197 | __key_link(key, &edit); |
1198 | __key_link_end(keyring, &key->index_key, edit); | |
f70e2e06 | 1199 | } |
1da177e4 | 1200 | |
b2a4df20 | 1201 | kleave(" = %d {%d,%d}", ret, keyring->serial, atomic_read(&keyring->usage)); |
1da177e4 | 1202 | return ret; |
f70e2e06 | 1203 | } |
1da177e4 LT |
1204 | EXPORT_SYMBOL(key_link); |
1205 | ||
973c9f4f DH |
1206 | /** |
1207 | * key_unlink - Unlink the first link to a key from a keyring. | |
1208 | * @keyring: The keyring to remove the link from. | |
1209 | * @key: The key the link is to. | |
1210 | * | |
1211 | * Remove a link from a keyring to a key. | |
1212 | * | |
1213 | * This function will write-lock the keyring's semaphore. | |
1214 | * | |
1215 | * Returns 0 if successful, -ENOTDIR if the keyring isn't a keyring, -ENOENT if | |
1216 | * the key isn't linked to by the keyring or -ENOMEM if there's insufficient | |
1217 | * memory. | |
1218 | * | |
1219 | * It is assumed that the caller has checked that it is permitted for a link to | |
1220 | * be removed (the keyring should have Write permission; no permissions are | |
1221 | * required on the key). | |
1da177e4 LT |
1222 | */ |
1223 | int key_unlink(struct key *keyring, struct key *key) | |
1224 | { | |
b2a4df20 DH |
1225 | struct assoc_array_edit *edit; |
1226 | int ret; | |
1da177e4 LT |
1227 | |
1228 | key_check(keyring); | |
1229 | key_check(key); | |
1230 | ||
1da177e4 | 1231 | if (keyring->type != &key_type_keyring) |
b2a4df20 | 1232 | return -ENOTDIR; |
1da177e4 LT |
1233 | |
1234 | down_write(&keyring->sem); | |
1235 | ||
b2a4df20 DH |
1236 | edit = assoc_array_delete(&keyring->keys, &keyring_assoc_array_ops, |
1237 | &key->index_key); | |
1238 | if (IS_ERR(edit)) { | |
1239 | ret = PTR_ERR(edit); | |
1240 | goto error; | |
1da177e4 | 1241 | } |
1da177e4 | 1242 | ret = -ENOENT; |
b2a4df20 DH |
1243 | if (edit == NULL) |
1244 | goto error; | |
1da177e4 | 1245 | |
b2a4df20 | 1246 | assoc_array_apply_edit(edit); |
034faeb9 | 1247 | key_payload_reserve(keyring, keyring->datalen - KEYQUOTA_LINK_BYTES); |
1da177e4 LT |
1248 | ret = 0; |
1249 | ||
76d8aeab | 1250 | error: |
76d8aeab | 1251 | up_write(&keyring->sem); |
b2a4df20 | 1252 | return ret; |
a8b17ed0 | 1253 | } |
1da177e4 LT |
1254 | EXPORT_SYMBOL(key_unlink); |
1255 | ||
973c9f4f DH |
1256 | /** |
1257 | * keyring_clear - Clear a keyring | |
1258 | * @keyring: The keyring to clear. | |
1259 | * | |
1260 | * Clear the contents of the specified keyring. | |
1261 | * | |
1262 | * Returns 0 if successful or -ENOTDIR if the keyring isn't a keyring. | |
1da177e4 LT |
1263 | */ |
1264 | int keyring_clear(struct key *keyring) | |
1265 | { | |
b2a4df20 | 1266 | struct assoc_array_edit *edit; |
76d8aeab | 1267 | int ret; |
1da177e4 | 1268 | |
b2a4df20 DH |
1269 | if (keyring->type != &key_type_keyring) |
1270 | return -ENOTDIR; | |
1da177e4 | 1271 | |
b2a4df20 | 1272 | down_write(&keyring->sem); |
1da177e4 | 1273 | |
b2a4df20 DH |
1274 | edit = assoc_array_clear(&keyring->keys, &keyring_assoc_array_ops); |
1275 | if (IS_ERR(edit)) { | |
1276 | ret = PTR_ERR(edit); | |
1277 | } else { | |
1278 | if (edit) | |
1279 | assoc_array_apply_edit(edit); | |
1280 | key_payload_reserve(keyring, 0); | |
1da177e4 LT |
1281 | ret = 0; |
1282 | } | |
1283 | ||
b2a4df20 | 1284 | up_write(&keyring->sem); |
1da177e4 | 1285 | return ret; |
a8b17ed0 | 1286 | } |
1da177e4 | 1287 | EXPORT_SYMBOL(keyring_clear); |
31204ed9 | 1288 | |
31204ed9 | 1289 | /* |
973c9f4f DH |
1290 | * Dispose of the links from a revoked keyring. |
1291 | * | |
1292 | * This is called with the key sem write-locked. | |
31204ed9 DH |
1293 | */ |
1294 | static void keyring_revoke(struct key *keyring) | |
1295 | { | |
b2a4df20 | 1296 | struct assoc_array_edit *edit; |
f0641cba | 1297 | |
b2a4df20 DH |
1298 | edit = assoc_array_clear(&keyring->keys, &keyring_assoc_array_ops); |
1299 | if (!IS_ERR(edit)) { | |
1300 | if (edit) | |
1301 | assoc_array_apply_edit(edit); | |
1302 | key_payload_reserve(keyring, 0); | |
1303 | } | |
1304 | } | |
31204ed9 | 1305 | |
62fe3182 | 1306 | static bool keyring_gc_select_iterator(void *object, void *iterator_data) |
b2a4df20 DH |
1307 | { |
1308 | struct key *key = keyring_ptr_to_key(object); | |
1309 | time_t *limit = iterator_data; | |
31204ed9 | 1310 | |
b2a4df20 DH |
1311 | if (key_is_dead(key, *limit)) |
1312 | return false; | |
1313 | key_get(key); | |
1314 | return true; | |
a8b17ed0 | 1315 | } |
5d135440 | 1316 | |
62fe3182 DH |
1317 | static int keyring_gc_check_iterator(const void *object, void *iterator_data) |
1318 | { | |
1319 | const struct key *key = keyring_ptr_to_key(object); | |
1320 | time_t *limit = iterator_data; | |
1321 | ||
1322 | key_check(key); | |
1323 | return key_is_dead(key, *limit); | |
1324 | } | |
1325 | ||
5d135440 | 1326 | /* |
62fe3182 | 1327 | * Garbage collect pointers from a keyring. |
973c9f4f | 1328 | * |
62fe3182 DH |
1329 | * Not called with any locks held. The keyring's key struct will not be |
1330 | * deallocated under us as only our caller may deallocate it. | |
5d135440 DH |
1331 | */ |
1332 | void keyring_gc(struct key *keyring, time_t limit) | |
1333 | { | |
62fe3182 DH |
1334 | int result; |
1335 | ||
1336 | kenter("%x{%s}", keyring->serial, keyring->description ?: ""); | |
5d135440 | 1337 | |
62fe3182 DH |
1338 | if (keyring->flags & ((1 << KEY_FLAG_INVALIDATED) | |
1339 | (1 << KEY_FLAG_REVOKED))) | |
1340 | goto dont_gc; | |
1341 | ||
1342 | /* scan the keyring looking for dead keys */ | |
1343 | rcu_read_lock(); | |
1344 | result = assoc_array_iterate(&keyring->keys, | |
1345 | keyring_gc_check_iterator, &limit); | |
1346 | rcu_read_unlock(); | |
1347 | if (result == true) | |
1348 | goto do_gc; | |
1349 | ||
1350 | dont_gc: | |
1351 | kleave(" [no gc]"); | |
1352 | return; | |
1353 | ||
1354 | do_gc: | |
5d135440 | 1355 | down_write(&keyring->sem); |
b2a4df20 | 1356 | assoc_array_gc(&keyring->keys, &keyring_assoc_array_ops, |
62fe3182 | 1357 | keyring_gc_select_iterator, &limit); |
c08ef808 | 1358 | up_write(&keyring->sem); |
62fe3182 | 1359 | kleave(" [gc]"); |
5d135440 | 1360 | } |