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