Commit | Line | Data |
---|---|---|
2874c5fd | 1 | // SPDX-License-Identifier: GPL-2.0-or-later |
76181c13 | 2 | /* Request a key from userspace |
1da177e4 | 3 | * |
76181c13 | 4 | * Copyright (C) 2004-2007 Red Hat, Inc. All Rights Reserved. |
1da177e4 LT |
5 | * Written by David Howells (dhowells@redhat.com) |
6 | * | |
3db38ed7 | 7 | * See Documentation/security/keys/request-key.rst |
1da177e4 LT |
8 | */ |
9 | ||
876979c9 | 10 | #include <linux/export.h> |
1da177e4 LT |
11 | #include <linux/sched.h> |
12 | #include <linux/kmod.h> | |
13 | #include <linux/err.h> | |
3e30148c | 14 | #include <linux/keyctl.h> |
fdb89bce | 15 | #include <linux/slab.h> |
a58946c1 | 16 | #include <net/net_namespace.h> |
1da177e4 | 17 | #include "internal.h" |
822ad64d | 18 | #include <keys/request_key_auth-type.h> |
1da177e4 | 19 | |
e9e349b0 DH |
20 | #define key_negative_timeout 60 /* default timeout on a negative key's existence */ |
21 | ||
7743c48e DH |
22 | static struct key *check_cached_key(struct keyring_search_context *ctx) |
23 | { | |
24 | #ifdef CONFIG_KEYS_REQUEST_CACHE | |
25 | struct key *key = current->cached_requested_key; | |
26 | ||
27 | if (key && | |
28 | ctx->match_data.cmp(key, &ctx->match_data) && | |
29 | !(key->flags & ((1 << KEY_FLAG_INVALIDATED) | | |
30 | (1 << KEY_FLAG_REVOKED)))) | |
31 | return key_get(key); | |
32 | #endif | |
33 | return NULL; | |
34 | } | |
35 | ||
36 | static void cache_requested_key(struct key *key) | |
37 | { | |
38 | #ifdef CONFIG_KEYS_REQUEST_CACHE | |
39 | struct task_struct *t = current; | |
40 | ||
47f9e4c9 DH |
41 | /* Do not cache key if it is a kernel thread */ |
42 | if (!(t->flags & PF_KTHREAD)) { | |
43 | key_put(t->cached_requested_key); | |
44 | t->cached_requested_key = key_get(key); | |
45 | set_tsk_thread_flag(t, TIF_NOTIFY_RESUME); | |
46 | } | |
7743c48e DH |
47 | #endif |
48 | } | |
49 | ||
973c9f4f DH |
50 | /** |
51 | * complete_request_key - Complete the construction of a key. | |
9fd16537 | 52 | * @authkey: The authorisation key. |
973c9f4f DH |
53 | * @error: The success or failute of the construction. |
54 | * | |
55 | * Complete the attempt to construct a key. The key will be negated | |
56 | * if an error is indicated. The authorisation key will be revoked | |
57 | * unconditionally. | |
76181c13 | 58 | */ |
822ad64d | 59 | void complete_request_key(struct key *authkey, int error) |
76181c13 | 60 | { |
822ad64d DH |
61 | struct request_key_auth *rka = get_request_key_auth(authkey); |
62 | struct key *key = rka->target_key; | |
63 | ||
64 | kenter("%d{%d},%d", authkey->serial, key->serial, error); | |
1da177e4 | 65 | |
76181c13 | 66 | if (error < 0) |
822ad64d | 67 | key_negate_and_link(key, key_negative_timeout, NULL, authkey); |
76181c13 | 68 | else |
822ad64d | 69 | key_revoke(authkey); |
76181c13 DH |
70 | } |
71 | EXPORT_SYMBOL(complete_request_key); | |
1da177e4 | 72 | |
973c9f4f DH |
73 | /* |
74 | * Initialise a usermode helper that is going to have a specific session | |
75 | * keyring. | |
76 | * | |
77 | * This is called in context of freshly forked kthread before kernel_execve(), | |
78 | * so we can simply install the desired session_keyring at this point. | |
79 | */ | |
87966996 | 80 | static int umh_keys_init(struct subprocess_info *info, struct cred *cred) |
685bfd2c | 81 | { |
685bfd2c | 82 | struct key *keyring = info->data; |
973c9f4f | 83 | |
685bfd2c ON |
84 | return install_session_keyring_to_cred(cred, keyring); |
85 | } | |
86 | ||
973c9f4f DH |
87 | /* |
88 | * Clean up a usermode helper with session keyring. | |
89 | */ | |
685bfd2c ON |
90 | static void umh_keys_cleanup(struct subprocess_info *info) |
91 | { | |
92 | struct key *keyring = info->data; | |
93 | key_put(keyring); | |
94 | } | |
95 | ||
973c9f4f DH |
96 | /* |
97 | * Call a usermode helper with a specific session keyring. | |
98 | */ | |
377e7a27 | 99 | static int call_usermodehelper_keys(const char *path, char **argv, char **envp, |
9d944ef3 | 100 | struct key *session_keyring, int wait) |
685bfd2c | 101 | { |
93997f6d LDM |
102 | struct subprocess_info *info; |
103 | ||
104 | info = call_usermodehelper_setup(path, argv, envp, GFP_KERNEL, | |
105 | umh_keys_init, umh_keys_cleanup, | |
106 | session_keyring); | |
107 | if (!info) | |
108 | return -ENOMEM; | |
109 | ||
110 | key_get(session_keyring); | |
111 | return call_usermodehelper_exec(info, wait); | |
685bfd2c ON |
112 | } |
113 | ||
1da177e4 | 114 | /* |
973c9f4f | 115 | * Request userspace finish the construction of a key |
b5f545c8 | 116 | * - execute "/sbin/request-key <op> <key> <uid> <gid> <keyring> <keyring> <keyring>" |
1da177e4 | 117 | */ |
822ad64d | 118 | static int call_sbin_request_key(struct key *authkey, void *aux) |
1da177e4 | 119 | { |
377e7a27 | 120 | static char const request_key[] = "/sbin/request-key"; |
822ad64d | 121 | struct request_key_auth *rka = get_request_key_auth(authkey); |
86a264ab | 122 | const struct cred *cred = current_cred(); |
1da177e4 | 123 | key_serial_t prkey, sskey; |
0f44e4d9 | 124 | struct key *key = rka->target_key, *keyring, *session, *user_session; |
b5f545c8 | 125 | char *argv[9], *envp[3], uid_str[12], gid_str[12]; |
1da177e4 | 126 | char key_str[12], keyring_str[3][12]; |
b5f545c8 | 127 | char desc[20]; |
3e30148c DH |
128 | int ret, i; |
129 | ||
822ad64d | 130 | kenter("{%d},{%d},%s", key->serial, authkey->serial, rka->op); |
3e30148c | 131 | |
0f44e4d9 | 132 | ret = look_up_user_keyrings(NULL, &user_session); |
8bbf4976 | 133 | if (ret < 0) |
0f44e4d9 | 134 | goto error_us; |
8bbf4976 | 135 | |
b5f545c8 DH |
136 | /* allocate a new session keyring */ |
137 | sprintf(desc, "_req.%u", key->serial); | |
138 | ||
d84f4f99 DH |
139 | cred = get_current_cred(); |
140 | keyring = keyring_alloc(desc, cred->fsuid, cred->fsgid, cred, | |
028db3e2 LT |
141 | KEY_POS_ALL | KEY_USR_VIEW | KEY_USR_READ, |
142 | KEY_ALLOC_QUOTA_OVERRUN, NULL, NULL); | |
d84f4f99 | 143 | put_cred(cred); |
b5f545c8 DH |
144 | if (IS_ERR(keyring)) { |
145 | ret = PTR_ERR(keyring); | |
146 | goto error_alloc; | |
3e30148c | 147 | } |
1da177e4 | 148 | |
b5f545c8 | 149 | /* attach the auth key to the session keyring */ |
896903c2 | 150 | ret = key_link(keyring, authkey); |
b5f545c8 DH |
151 | if (ret < 0) |
152 | goto error_link; | |
153 | ||
1da177e4 | 154 | /* record the UID and GID */ |
9a56c2db EB |
155 | sprintf(uid_str, "%d", from_kuid(&init_user_ns, cred->fsuid)); |
156 | sprintf(gid_str, "%d", from_kgid(&init_user_ns, cred->fsgid)); | |
1da177e4 LT |
157 | |
158 | /* we say which key is under construction */ | |
159 | sprintf(key_str, "%d", key->serial); | |
160 | ||
161 | /* we specify the process's default keyrings */ | |
162 | sprintf(keyring_str[0], "%d", | |
d84f4f99 | 163 | cred->thread_keyring ? cred->thread_keyring->serial : 0); |
1da177e4 LT |
164 | |
165 | prkey = 0; | |
3a50597d DH |
166 | if (cred->process_keyring) |
167 | prkey = cred->process_keyring->serial; | |
5ad18a0d | 168 | sprintf(keyring_str[1], "%d", prkey); |
1da177e4 | 169 | |
5c7e372c | 170 | session = cred->session_keyring; |
93b4a44f | 171 | if (!session) |
0f44e4d9 | 172 | session = user_session; |
93b4a44f | 173 | sskey = session->serial; |
1da177e4 | 174 | |
1da177e4 LT |
175 | sprintf(keyring_str[2], "%d", sskey); |
176 | ||
177 | /* set up a minimal environment */ | |
178 | i = 0; | |
179 | envp[i++] = "HOME=/"; | |
180 | envp[i++] = "PATH=/sbin:/bin:/usr/sbin:/usr/bin"; | |
181 | envp[i] = NULL; | |
182 | ||
183 | /* set up the argument list */ | |
184 | i = 0; | |
377e7a27 | 185 | argv[i++] = (char *)request_key; |
822ad64d | 186 | argv[i++] = (char *)rka->op; |
1da177e4 LT |
187 | argv[i++] = key_str; |
188 | argv[i++] = uid_str; | |
189 | argv[i++] = gid_str; | |
190 | argv[i++] = keyring_str[0]; | |
191 | argv[i++] = keyring_str[1]; | |
192 | argv[i++] = keyring_str[2]; | |
1da177e4 LT |
193 | argv[i] = NULL; |
194 | ||
195 | /* do it */ | |
377e7a27 | 196 | ret = call_usermodehelper_keys(request_key, argv, envp, keyring, |
86313c48 | 197 | UMH_WAIT_PROC); |
76181c13 DH |
198 | kdebug("usermode -> 0x%x", ret); |
199 | if (ret >= 0) { | |
200 | /* ret is the exit/wait code */ | |
201 | if (test_bit(KEY_FLAG_USER_CONSTRUCT, &key->flags) || | |
202 | key_validate(key) < 0) | |
203 | ret = -ENOKEY; | |
204 | else | |
205 | /* ignore any errors from userspace if the key was | |
206 | * instantiated */ | |
207 | ret = 0; | |
208 | } | |
3e30148c | 209 | |
b5f545c8 DH |
210 | error_link: |
211 | key_put(keyring); | |
3e30148c | 212 | |
b5f545c8 | 213 | error_alloc: |
0f44e4d9 DH |
214 | key_put(user_session); |
215 | error_us: | |
822ad64d | 216 | complete_request_key(authkey, ret); |
d84f4f99 | 217 | kleave(" = %d", ret); |
3e30148c | 218 | return ret; |
76181c13 | 219 | } |
1da177e4 | 220 | |
1da177e4 | 221 | /* |
973c9f4f DH |
222 | * Call out to userspace for key construction. |
223 | * | |
224 | * Program failure is ignored in favour of key status. | |
1da177e4 | 225 | */ |
4a38e122 | 226 | static int construct_key(struct key *key, const void *callout_info, |
8bbf4976 DH |
227 | size_t callout_len, void *aux, |
228 | struct key *dest_keyring) | |
1da177e4 | 229 | { |
b5f545c8 | 230 | request_key_actor_t actor; |
76181c13 DH |
231 | struct key *authkey; |
232 | int ret; | |
1da177e4 | 233 | |
4a38e122 | 234 | kenter("%d,%p,%zu,%p", key->serial, callout_info, callout_len, aux); |
3e30148c | 235 | |
b5f545c8 | 236 | /* allocate an authorisation key */ |
822ad64d | 237 | authkey = request_key_auth_new(key, "create", callout_info, callout_len, |
8bbf4976 | 238 | dest_keyring); |
822ad64d DH |
239 | if (IS_ERR(authkey)) |
240 | return PTR_ERR(authkey); | |
76181c13 | 241 | |
822ad64d DH |
242 | /* Make the call */ |
243 | actor = call_sbin_request_key; | |
244 | if (key->type->request_key) | |
245 | actor = key->type->request_key; | |
76181c13 | 246 | |
822ad64d | 247 | ret = actor(authkey, aux); |
76181c13 | 248 | |
822ad64d DH |
249 | /* check that the actor called complete_request_key() prior to |
250 | * returning an error */ | |
251 | WARN_ON(ret < 0 && | |
a09003b5 | 252 | !test_bit(KEY_FLAG_INVALIDATED, &authkey->flags)); |
1da177e4 | 253 | |
822ad64d | 254 | key_put(authkey); |
76181c13 DH |
255 | kleave(" = %d", ret); |
256 | return ret; | |
257 | } | |
1da177e4 | 258 | |
3e30148c | 259 | /* |
973c9f4f DH |
260 | * Get the appropriate destination keyring for the request. |
261 | * | |
262 | * The keyring selected is returned with an extra reference upon it which the | |
263 | * caller must release. | |
3e30148c | 264 | */ |
4dca6ea1 | 265 | static int construct_get_dest_keyring(struct key **_dest_keyring) |
3e30148c | 266 | { |
8bbf4976 | 267 | struct request_key_auth *rka; |
bb952bb9 | 268 | const struct cred *cred = current_cred(); |
8bbf4976 | 269 | struct key *dest_keyring = *_dest_keyring, *authkey; |
4dca6ea1 | 270 | int ret; |
3e30148c | 271 | |
8bbf4976 | 272 | kenter("%p", dest_keyring); |
3e30148c DH |
273 | |
274 | /* find the appropriate keyring */ | |
8bbf4976 DH |
275 | if (dest_keyring) { |
276 | /* the caller supplied one */ | |
277 | key_get(dest_keyring); | |
278 | } else { | |
4dca6ea1 EB |
279 | bool do_perm_check = true; |
280 | ||
8bbf4976 DH |
281 | /* use a default keyring; falling through the cases until we |
282 | * find one that we actually have */ | |
bb952bb9 | 283 | switch (cred->jit_keyring) { |
3e30148c | 284 | case KEY_REQKEY_DEFL_DEFAULT: |
8bbf4976 | 285 | case KEY_REQKEY_DEFL_REQUESTOR_KEYRING: |
bb952bb9 DH |
286 | if (cred->request_key_auth) { |
287 | authkey = cred->request_key_auth; | |
8bbf4976 | 288 | down_read(&authkey->sem); |
822ad64d | 289 | rka = get_request_key_auth(authkey); |
8bbf4976 DH |
290 | if (!test_bit(KEY_FLAG_REVOKED, |
291 | &authkey->flags)) | |
292 | dest_keyring = | |
293 | key_get(rka->dest_keyring); | |
294 | up_read(&authkey->sem); | |
4dca6ea1 EB |
295 | if (dest_keyring) { |
296 | do_perm_check = false; | |
8bbf4976 | 297 | break; |
4dca6ea1 | 298 | } |
8bbf4976 DH |
299 | } |
300 | ||
df561f66 | 301 | fallthrough; |
3e30148c | 302 | case KEY_REQKEY_DEFL_THREAD_KEYRING: |
bb952bb9 | 303 | dest_keyring = key_get(cred->thread_keyring); |
3e30148c DH |
304 | if (dest_keyring) |
305 | break; | |
306 | ||
df561f66 | 307 | fallthrough; |
3e30148c | 308 | case KEY_REQKEY_DEFL_PROCESS_KEYRING: |
3a50597d | 309 | dest_keyring = key_get(cred->process_keyring); |
3e30148c DH |
310 | if (dest_keyring) |
311 | break; | |
312 | ||
df561f66 | 313 | fallthrough; |
3e30148c | 314 | case KEY_REQKEY_DEFL_SESSION_KEYRING: |
5c7e372c | 315 | dest_keyring = key_get(cred->session_keyring); |
3e30148c DH |
316 | |
317 | if (dest_keyring) | |
318 | break; | |
319 | ||
df561f66 | 320 | fallthrough; |
3e30148c | 321 | case KEY_REQKEY_DEFL_USER_SESSION_KEYRING: |
0f44e4d9 DH |
322 | ret = look_up_user_keyrings(NULL, &dest_keyring); |
323 | if (ret < 0) | |
324 | return ret; | |
3e30148c DH |
325 | break; |
326 | ||
327 | case KEY_REQKEY_DEFL_USER_KEYRING: | |
0f44e4d9 DH |
328 | ret = look_up_user_keyrings(&dest_keyring, NULL); |
329 | if (ret < 0) | |
330 | return ret; | |
3e30148c DH |
331 | break; |
332 | ||
333 | case KEY_REQKEY_DEFL_GROUP_KEYRING: | |
334 | default: | |
335 | BUG(); | |
336 | } | |
4dca6ea1 EB |
337 | |
338 | /* | |
339 | * Require Write permission on the keyring. This is essential | |
340 | * because the default keyring may be the session keyring, and | |
341 | * joining a keyring only requires Search permission. | |
342 | * | |
343 | * However, this check is skipped for the "requestor keyring" so | |
344 | * that /sbin/request-key can itself use request_key() to add | |
345 | * keys to the original requestor's destination keyring. | |
346 | */ | |
347 | if (dest_keyring && do_perm_check) { | |
348 | ret = key_permission(make_key_ref(dest_keyring, 1), | |
349 | KEY_NEED_WRITE); | |
350 | if (ret) { | |
351 | key_put(dest_keyring); | |
352 | return ret; | |
353 | } | |
354 | } | |
3e30148c DH |
355 | } |
356 | ||
8bbf4976 DH |
357 | *_dest_keyring = dest_keyring; |
358 | kleave(" [dk %d]", key_serial(dest_keyring)); | |
4dca6ea1 | 359 | return 0; |
76181c13 | 360 | } |
3e30148c | 361 | |
76181c13 | 362 | /* |
973c9f4f DH |
363 | * Allocate a new key in under-construction state and attempt to link it in to |
364 | * the requested keyring. | |
365 | * | |
366 | * May return a key that's already under construction instead if there was a | |
367 | * race between two thread calling request_key(). | |
76181c13 | 368 | */ |
4bdf0bc3 | 369 | static int construct_alloc_key(struct keyring_search_context *ctx, |
76181c13 DH |
370 | struct key *dest_keyring, |
371 | unsigned long flags, | |
372 | struct key_user *user, | |
373 | struct key **_key) | |
374 | { | |
df593ee2 | 375 | struct assoc_array_edit *edit = NULL; |
76181c13 | 376 | struct key *key; |
028db3e2 | 377 | key_perm_t perm; |
76181c13 | 378 | key_ref_t key_ref; |
2b9e4688 | 379 | int ret; |
76181c13 | 380 | |
4bdf0bc3 DH |
381 | kenter("%s,%s,,,", |
382 | ctx->index_key.type->name, ctx->index_key.description); | |
76181c13 | 383 | |
f70e2e06 | 384 | *_key = NULL; |
76181c13 DH |
385 | mutex_lock(&user->cons_lock); |
386 | ||
028db3e2 LT |
387 | perm = KEY_POS_VIEW | KEY_POS_SEARCH | KEY_POS_LINK | KEY_POS_SETATTR; |
388 | perm |= KEY_USR_VIEW; | |
389 | if (ctx->index_key.type->read) | |
390 | perm |= KEY_POS_READ; | |
391 | if (ctx->index_key.type == &key_type_keyring || | |
392 | ctx->index_key.type->update) | |
393 | perm |= KEY_POS_WRITE; | |
394 | ||
4bdf0bc3 DH |
395 | key = key_alloc(ctx->index_key.type, ctx->index_key.description, |
396 | ctx->cred->fsuid, ctx->cred->fsgid, ctx->cred, | |
028db3e2 | 397 | perm, flags, NULL); |
76181c13 DH |
398 | if (IS_ERR(key)) |
399 | goto alloc_failed; | |
400 | ||
401 | set_bit(KEY_FLAG_USER_CONSTRUCT, &key->flags); | |
402 | ||
f70e2e06 | 403 | if (dest_keyring) { |
d5590152 | 404 | ret = __key_link_lock(dest_keyring, &key->index_key); |
df593ee2 DH |
405 | if (ret < 0) |
406 | goto link_lock_failed; | |
f70e2e06 | 407 | } |
76181c13 | 408 | |
d5590152 PP |
409 | /* |
410 | * Attach the key to the destination keyring under lock, but we do need | |
76181c13 | 411 | * to do another check just in case someone beat us to it whilst we |
d5590152 PP |
412 | * waited for locks. |
413 | * | |
414 | * The caller might specify a comparison function which looks for keys | |
415 | * that do not exactly match but are still equivalent from the caller's | |
416 | * perspective. The __key_link_begin() operation must be done only after | |
417 | * an actual key is determined. | |
418 | */ | |
76181c13 DH |
419 | mutex_lock(&key_construction_mutex); |
420 | ||
e59428f7 DH |
421 | rcu_read_lock(); |
422 | key_ref = search_process_keyrings_rcu(ctx); | |
423 | rcu_read_unlock(); | |
76181c13 DH |
424 | if (!IS_ERR(key_ref)) |
425 | goto key_already_present; | |
426 | ||
d5590152 PP |
427 | if (dest_keyring) { |
428 | ret = __key_link_begin(dest_keyring, &key->index_key, &edit); | |
429 | if (ret < 0) | |
430 | goto link_alloc_failed; | |
f7e47677 | 431 | __key_link(dest_keyring, key, &edit); |
d5590152 | 432 | } |
76181c13 DH |
433 | |
434 | mutex_unlock(&key_construction_mutex); | |
34574dd1 | 435 | if (dest_keyring) |
d5590152 | 436 | __key_link_end(dest_keyring, &key->index_key, edit); |
76181c13 DH |
437 | mutex_unlock(&user->cons_lock); |
438 | *_key = key; | |
439 | kleave(" = 0 [%d]", key_serial(key)); | |
440 | return 0; | |
441 | ||
2b9e4688 DH |
442 | /* the key is now present - we tell the caller that we found it by |
443 | * returning -EINPROGRESS */ | |
76181c13 | 444 | key_already_present: |
f70e2e06 | 445 | key_put(key); |
76181c13 | 446 | mutex_unlock(&key_construction_mutex); |
f70e2e06 | 447 | key = key_ref_to_ptr(key_ref); |
03449cd9 | 448 | if (dest_keyring) { |
d5590152 PP |
449 | ret = __key_link_begin(dest_keyring, &key->index_key, &edit); |
450 | if (ret < 0) | |
451 | goto link_alloc_failed_unlocked; | |
f70e2e06 DH |
452 | ret = __key_link_check_live_key(dest_keyring, key); |
453 | if (ret == 0) | |
f7e47677 | 454 | __key_link(dest_keyring, key, &edit); |
d5590152 | 455 | __key_link_end(dest_keyring, &key->index_key, edit); |
f70e2e06 DH |
456 | if (ret < 0) |
457 | goto link_check_failed; | |
03449cd9 | 458 | } |
76181c13 | 459 | mutex_unlock(&user->cons_lock); |
f70e2e06 | 460 | *_key = key; |
76181c13 DH |
461 | kleave(" = -EINPROGRESS [%d]", key_serial(key)); |
462 | return -EINPROGRESS; | |
463 | ||
f70e2e06 DH |
464 | link_check_failed: |
465 | mutex_unlock(&user->cons_lock); | |
466 | key_put(key); | |
467 | kleave(" = %d [linkcheck]", ret); | |
468 | return ret; | |
469 | ||
d5590152 PP |
470 | link_alloc_failed: |
471 | mutex_unlock(&key_construction_mutex); | |
472 | link_alloc_failed_unlocked: | |
473 | __key_link_end(dest_keyring, &key->index_key, edit); | |
df593ee2 | 474 | link_lock_failed: |
f70e2e06 | 475 | mutex_unlock(&user->cons_lock); |
d0709f1e | 476 | key_put(key); |
f70e2e06 DH |
477 | kleave(" = %d [prelink]", ret); |
478 | return ret; | |
479 | ||
76181c13 DH |
480 | alloc_failed: |
481 | mutex_unlock(&user->cons_lock); | |
76181c13 DH |
482 | kleave(" = %ld", PTR_ERR(key)); |
483 | return PTR_ERR(key); | |
484 | } | |
485 | ||
486 | /* | |
973c9f4f | 487 | * Commence key construction. |
76181c13 | 488 | */ |
4bdf0bc3 | 489 | static struct key *construct_key_and_link(struct keyring_search_context *ctx, |
76181c13 | 490 | const char *callout_info, |
4a38e122 | 491 | size_t callout_len, |
76181c13 DH |
492 | void *aux, |
493 | struct key *dest_keyring, | |
494 | unsigned long flags) | |
495 | { | |
496 | struct key_user *user; | |
497 | struct key *key; | |
498 | int ret; | |
499 | ||
d84f4f99 DH |
500 | kenter(""); |
501 | ||
911b79cd DH |
502 | if (ctx->index_key.type == &key_type_keyring) |
503 | return ERR_PTR(-EPERM); | |
965475ac | 504 | |
4dca6ea1 EB |
505 | ret = construct_get_dest_keyring(&dest_keyring); |
506 | if (ret) | |
507 | goto error; | |
76181c13 | 508 | |
4dca6ea1 EB |
509 | user = key_user_lookup(current_fsuid()); |
510 | if (!user) { | |
511 | ret = -ENOMEM; | |
512 | goto error_put_dest_keyring; | |
513 | } | |
8bbf4976 | 514 | |
028db3e2 | 515 | ret = construct_alloc_key(ctx, dest_keyring, flags, user, &key); |
76181c13 DH |
516 | key_user_put(user); |
517 | ||
518 | if (ret == 0) { | |
8bbf4976 DH |
519 | ret = construct_key(key, callout_info, callout_len, aux, |
520 | dest_keyring); | |
d84f4f99 DH |
521 | if (ret < 0) { |
522 | kdebug("cons failed"); | |
76181c13 | 523 | goto construction_failed; |
d84f4f99 | 524 | } |
2b9e4688 DH |
525 | } else if (ret == -EINPROGRESS) { |
526 | ret = 0; | |
527 | } else { | |
4dca6ea1 | 528 | goto error_put_dest_keyring; |
76181c13 DH |
529 | } |
530 | ||
8bbf4976 | 531 | key_put(dest_keyring); |
d84f4f99 | 532 | kleave(" = key %d", key_serial(key)); |
76181c13 DH |
533 | return key; |
534 | ||
535 | construction_failed: | |
536 | key_negate_and_link(key, key_negative_timeout, NULL, NULL); | |
537 | key_put(key); | |
4dca6ea1 | 538 | error_put_dest_keyring: |
8bbf4976 | 539 | key_put(dest_keyring); |
4dca6ea1 | 540 | error: |
d84f4f99 | 541 | kleave(" = %d", ret); |
76181c13 DH |
542 | return ERR_PTR(ret); |
543 | } | |
3e30148c | 544 | |
973c9f4f DH |
545 | /** |
546 | * request_key_and_link - Request a key and cache it in a keyring. | |
547 | * @type: The type of key we want. | |
548 | * @description: The searchable description of the key. | |
a58946c1 | 549 | * @domain_tag: The domain in which the key operates. |
973c9f4f DH |
550 | * @callout_info: The data to pass to the instantiation upcall (or NULL). |
551 | * @callout_len: The length of callout_info. | |
552 | * @aux: Auxiliary data for the upcall. | |
553 | * @dest_keyring: Where to cache the key. | |
554 | * @flags: Flags to key_alloc(). | |
555 | * | |
a58946c1 DH |
556 | * A key matching the specified criteria (type, description, domain_tag) is |
557 | * searched for in the process's keyrings and returned with its usage count | |
558 | * incremented if found. Otherwise, if callout_info is not NULL, a key will be | |
559 | * allocated and some service (probably in userspace) will be asked to | |
560 | * instantiate it. | |
973c9f4f DH |
561 | * |
562 | * If successfully found or created, the key will be linked to the destination | |
563 | * keyring if one is provided. | |
564 | * | |
565 | * Returns a pointer to the key if successful; -EACCES, -ENOKEY, -EKEYREVOKED | |
566 | * or -EKEYEXPIRED if an inaccessible, negative, revoked or expired key was | |
567 | * found; -ENOKEY if no key was found and no @callout_info was given; -EDQUOT | |
568 | * if insufficient key quota was available to create a new key; or -ENOMEM if | |
569 | * insufficient memory was available. | |
570 | * | |
571 | * If the returned key was created, then it may still be under construction, | |
572 | * and wait_for_key_construction() should be used to wait for that to complete. | |
1da177e4 | 573 | */ |
3e30148c DH |
574 | struct key *request_key_and_link(struct key_type *type, |
575 | const char *description, | |
a58946c1 | 576 | struct key_tag *domain_tag, |
4a38e122 DH |
577 | const void *callout_info, |
578 | size_t callout_len, | |
4e54f085 | 579 | void *aux, |
7e047ef5 DH |
580 | struct key *dest_keyring, |
581 | unsigned long flags) | |
1da177e4 | 582 | { |
4bdf0bc3 DH |
583 | struct keyring_search_context ctx = { |
584 | .index_key.type = type, | |
a58946c1 | 585 | .index_key.domain_tag = domain_tag, |
4bdf0bc3 | 586 | .index_key.description = description, |
ede0fa98 | 587 | .index_key.desc_len = strlen(description), |
4bdf0bc3 | 588 | .cred = current_cred(), |
c06cfb08 | 589 | .match_data.cmp = key_default_cmp, |
46291959 DH |
590 | .match_data.raw_data = description, |
591 | .match_data.lookup_type = KEYRING_SEARCH_LOOKUP_DIRECT, | |
0b0a8415 | 592 | .flags = (KEYRING_SEARCH_DO_STATE_CHECK | |
dcf49dbc DH |
593 | KEYRING_SEARCH_SKIP_EXPIRED | |
594 | KEYRING_SEARCH_RECURSE), | |
4bdf0bc3 | 595 | }; |
1da177e4 | 596 | struct key *key; |
664cceb0 | 597 | key_ref_t key_ref; |
2b9e4688 | 598 | int ret; |
1da177e4 | 599 | |
4a38e122 | 600 | kenter("%s,%s,%p,%zu,%p,%p,%lx", |
4bdf0bc3 DH |
601 | ctx.index_key.type->name, ctx.index_key.description, |
602 | callout_info, callout_len, aux, dest_keyring, flags); | |
3e30148c | 603 | |
46291959 DH |
604 | if (type->match_preparse) { |
605 | ret = type->match_preparse(&ctx.match_data); | |
606 | if (ret < 0) { | |
607 | key = ERR_PTR(ret); | |
608 | goto error; | |
609 | } | |
610 | } | |
611 | ||
7743c48e DH |
612 | key = check_cached_key(&ctx); |
613 | if (key) | |
846d2db3 | 614 | goto error_free; |
7743c48e | 615 | |
1da177e4 | 616 | /* search all the process keyrings for a key */ |
e59428f7 DH |
617 | rcu_read_lock(); |
618 | key_ref = search_process_keyrings_rcu(&ctx); | |
619 | rcu_read_unlock(); | |
1da177e4 | 620 | |
664cceb0 | 621 | if (!IS_ERR(key_ref)) { |
504b69eb DH |
622 | if (dest_keyring) { |
623 | ret = key_task_permission(key_ref, current_cred(), | |
624 | KEY_NEED_LINK); | |
625 | if (ret < 0) { | |
626 | key_ref_put(key_ref); | |
627 | key = ERR_PTR(ret); | |
628 | goto error_free; | |
629 | } | |
630 | } | |
631 | ||
664cceb0 | 632 | key = key_ref_to_ptr(key_ref); |
03449cd9 | 633 | if (dest_keyring) { |
2b9e4688 | 634 | ret = key_link(dest_keyring, key); |
2b9e4688 DH |
635 | if (ret < 0) { |
636 | key_put(key); | |
637 | key = ERR_PTR(ret); | |
46291959 | 638 | goto error_free; |
2b9e4688 | 639 | } |
03449cd9 | 640 | } |
7743c48e DH |
641 | |
642 | /* Only cache the key on immediate success */ | |
643 | cache_requested_key(key); | |
76181c13 | 644 | } else if (PTR_ERR(key_ref) != -EAGAIN) { |
e231c2ee | 645 | key = ERR_CAST(key_ref); |
76181c13 | 646 | } else { |
1da177e4 LT |
647 | /* the search failed, but the keyrings were searchable, so we |
648 | * should consult userspace if we can */ | |
649 | key = ERR_PTR(-ENOKEY); | |
650 | if (!callout_info) | |
46291959 | 651 | goto error_free; |
1da177e4 | 652 | |
4bdf0bc3 | 653 | key = construct_key_and_link(&ctx, callout_info, callout_len, |
028db3e2 | 654 | aux, dest_keyring, flags); |
1da177e4 LT |
655 | } |
656 | ||
46291959 DH |
657 | error_free: |
658 | if (type->match_free) | |
659 | type->match_free(&ctx.match_data); | |
3e30148c DH |
660 | error: |
661 | kleave(" = %p", key); | |
1da177e4 | 662 | return key; |
76181c13 | 663 | } |
1da177e4 | 664 | |
973c9f4f DH |
665 | /** |
666 | * wait_for_key_construction - Wait for construction of a key to complete | |
667 | * @key: The key being waited for. | |
668 | * @intr: Whether to wait interruptibly. | |
669 | * | |
670 | * Wait for a key to finish being constructed. | |
671 | * | |
672 | * Returns 0 if successful; -ERESTARTSYS if the wait was interrupted; -ENOKEY | |
673 | * if the key was negated; or -EKEYREVOKED or -EKEYEXPIRED if the key was | |
674 | * revoked or expired. | |
76181c13 DH |
675 | */ |
676 | int wait_for_key_construction(struct key *key, bool intr) | |
677 | { | |
678 | int ret; | |
3e30148c | 679 | |
76181c13 | 680 | ret = wait_on_bit(&key->flags, KEY_FLAG_USER_CONSTRUCT, |
76181c13 | 681 | intr ? TASK_INTERRUPTIBLE : TASK_UNINTERRUPTIBLE); |
74316201 N |
682 | if (ret) |
683 | return -ERESTARTSYS; | |
363b02da DH |
684 | ret = key_read_state(key); |
685 | if (ret < 0) | |
686 | return ret; | |
76181c13 DH |
687 | return key_validate(key); |
688 | } | |
689 | EXPORT_SYMBOL(wait_for_key_construction); | |
3e30148c | 690 | |
973c9f4f | 691 | /** |
a58946c1 | 692 | * request_key_tag - Request a key and wait for construction |
973c9f4f DH |
693 | * @type: Type of key. |
694 | * @description: The searchable description of the key. | |
a58946c1 | 695 | * @domain_tag: The domain in which the key operates. |
973c9f4f DH |
696 | * @callout_info: The data to pass to the instantiation upcall (or NULL). |
697 | * | |
698 | * As for request_key_and_link() except that it does not add the returned key | |
699 | * to a keyring if found, new keys are always allocated in the user's quota, | |
700 | * the callout_info must be a NUL-terminated string and no auxiliary data can | |
701 | * be passed. | |
702 | * | |
703 | * Furthermore, it then works as wait_for_key_construction() to wait for the | |
704 | * completion of keys undergoing construction with a non-interruptible wait. | |
3e30148c | 705 | */ |
a58946c1 DH |
706 | struct key *request_key_tag(struct key_type *type, |
707 | const char *description, | |
708 | struct key_tag *domain_tag, | |
028db3e2 | 709 | const char *callout_info) |
3e30148c | 710 | { |
76181c13 | 711 | struct key *key; |
4a38e122 | 712 | size_t callout_len = 0; |
76181c13 DH |
713 | int ret; |
714 | ||
4a38e122 DH |
715 | if (callout_info) |
716 | callout_len = strlen(callout_info); | |
a58946c1 DH |
717 | key = request_key_and_link(type, description, domain_tag, |
718 | callout_info, callout_len, | |
028db3e2 | 719 | NULL, NULL, KEY_ALLOC_IN_QUOTA); |
76181c13 DH |
720 | if (!IS_ERR(key)) { |
721 | ret = wait_for_key_construction(key, false); | |
722 | if (ret < 0) { | |
723 | key_put(key); | |
724 | return ERR_PTR(ret); | |
725 | } | |
726 | } | |
727 | return key; | |
728 | } | |
a58946c1 | 729 | EXPORT_SYMBOL(request_key_tag); |
4e54f085 | 730 | |
973c9f4f DH |
731 | /** |
732 | * request_key_with_auxdata - Request a key with auxiliary data for the upcaller | |
733 | * @type: The type of key we want. | |
734 | * @description: The searchable description of the key. | |
a58946c1 | 735 | * @domain_tag: The domain in which the key operates. |
973c9f4f DH |
736 | * @callout_info: The data to pass to the instantiation upcall (or NULL). |
737 | * @callout_len: The length of callout_info. | |
738 | * @aux: Auxiliary data for the upcall. | |
739 | * | |
740 | * As for request_key_and_link() except that it does not add the returned key | |
741 | * to a keyring if found and new keys are always allocated in the user's quota. | |
742 | * | |
743 | * Furthermore, it then works as wait_for_key_construction() to wait for the | |
744 | * completion of keys undergoing construction with a non-interruptible wait. | |
4e54f085 DH |
745 | */ |
746 | struct key *request_key_with_auxdata(struct key_type *type, | |
747 | const char *description, | |
a58946c1 | 748 | struct key_tag *domain_tag, |
4a38e122 DH |
749 | const void *callout_info, |
750 | size_t callout_len, | |
028db3e2 | 751 | void *aux) |
4e54f085 | 752 | { |
76181c13 DH |
753 | struct key *key; |
754 | int ret; | |
755 | ||
a58946c1 DH |
756 | key = request_key_and_link(type, description, domain_tag, |
757 | callout_info, callout_len, | |
028db3e2 | 758 | aux, NULL, KEY_ALLOC_IN_QUOTA); |
76181c13 DH |
759 | if (!IS_ERR(key)) { |
760 | ret = wait_for_key_construction(key, false); | |
761 | if (ret < 0) { | |
762 | key_put(key); | |
763 | return ERR_PTR(ret); | |
764 | } | |
765 | } | |
766 | return key; | |
767 | } | |
768 | EXPORT_SYMBOL(request_key_with_auxdata); | |
4e54f085 | 769 | |
896f1950 DH |
770 | /** |
771 | * request_key_rcu - Request key from RCU-read-locked context | |
772 | * @type: The type of key we want. | |
773 | * @description: The name of the key we want. | |
a58946c1 | 774 | * @domain_tag: The domain in which the key operates. |
973c9f4f | 775 | * |
896f1950 DH |
776 | * Request a key from a context that we may not sleep in (such as RCU-mode |
777 | * pathwalk). Keys under construction are ignored. | |
973c9f4f | 778 | * |
896f1950 DH |
779 | * Return a pointer to the found key if successful, -ENOKEY if we couldn't find |
780 | * a key or some other error if the key found was unsuitable or inaccessible. | |
76181c13 | 781 | */ |
a58946c1 DH |
782 | struct key *request_key_rcu(struct key_type *type, |
783 | const char *description, | |
784 | struct key_tag *domain_tag) | |
76181c13 | 785 | { |
896f1950 DH |
786 | struct keyring_search_context ctx = { |
787 | .index_key.type = type, | |
a58946c1 | 788 | .index_key.domain_tag = domain_tag, |
896f1950 DH |
789 | .index_key.description = description, |
790 | .index_key.desc_len = strlen(description), | |
791 | .cred = current_cred(), | |
792 | .match_data.cmp = key_default_cmp, | |
793 | .match_data.raw_data = description, | |
794 | .match_data.lookup_type = KEYRING_SEARCH_LOOKUP_DIRECT, | |
795 | .flags = (KEYRING_SEARCH_DO_STATE_CHECK | | |
796 | KEYRING_SEARCH_SKIP_EXPIRED), | |
797 | }; | |
798 | struct key *key; | |
799 | key_ref_t key_ref; | |
4e54f085 | 800 | |
896f1950 DH |
801 | kenter("%s,%s", type->name, description); |
802 | ||
7743c48e DH |
803 | key = check_cached_key(&ctx); |
804 | if (key) | |
805 | return key; | |
806 | ||
896f1950 DH |
807 | /* search all the process keyrings for a key */ |
808 | key_ref = search_process_keyrings_rcu(&ctx); | |
809 | if (IS_ERR(key_ref)) { | |
810 | key = ERR_CAST(key_ref); | |
811 | if (PTR_ERR(key_ref) == -EAGAIN) | |
812 | key = ERR_PTR(-ENOKEY); | |
813 | } else { | |
814 | key = key_ref_to_ptr(key_ref); | |
7743c48e | 815 | cache_requested_key(key); |
896f1950 DH |
816 | } |
817 | ||
818 | kleave(" = %p", key); | |
819 | return key; | |
76181c13 | 820 | } |
896f1950 | 821 | EXPORT_SYMBOL(request_key_rcu); |