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