Commit | Line | Data |
---|---|---|
973c9f4f | 1 | /* Manage a process's keyrings |
1da177e4 | 2 | * |
69664cf1 | 3 | * Copyright (C) 2004-2005, 2008 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> | |
1da177e4 LT |
15 | #include <linux/keyctl.h> |
16 | #include <linux/fs.h> | |
17 | #include <linux/err.h> | |
bb003079 | 18 | #include <linux/mutex.h> |
ee18d64c | 19 | #include <linux/security.h> |
1d1e9756 | 20 | #include <linux/user_namespace.h> |
1da177e4 LT |
21 | #include <asm/uaccess.h> |
22 | #include "internal.h" | |
23 | ||
973c9f4f | 24 | /* Session keyring create vs join semaphore */ |
bb003079 | 25 | static DEFINE_MUTEX(key_session_mutex); |
1da177e4 | 26 | |
973c9f4f | 27 | /* User keyring creation semaphore */ |
69664cf1 DH |
28 | static DEFINE_MUTEX(key_user_keyring_mutex); |
29 | ||
973c9f4f | 30 | /* The root user's tracking struct */ |
1da177e4 LT |
31 | struct key_user root_key_user = { |
32 | .usage = ATOMIC_INIT(3), | |
76181c13 | 33 | .cons_lock = __MUTEX_INITIALIZER(root_key_user.cons_lock), |
6cfd76a2 | 34 | .lock = __SPIN_LOCK_UNLOCKED(root_key_user.lock), |
1da177e4 LT |
35 | .nkeys = ATOMIC_INIT(2), |
36 | .nikeys = ATOMIC_INIT(2), | |
37 | .uid = 0, | |
1d1e9756 | 38 | .user_ns = &init_user_ns, |
1da177e4 LT |
39 | }; |
40 | ||
1da177e4 | 41 | /* |
973c9f4f | 42 | * Install the user and user session keyrings for the current process's UID. |
1da177e4 | 43 | */ |
8bbf4976 | 44 | int install_user_keyrings(void) |
1da177e4 | 45 | { |
d84f4f99 DH |
46 | struct user_struct *user; |
47 | const struct cred *cred; | |
1da177e4 LT |
48 | struct key *uid_keyring, *session_keyring; |
49 | char buf[20]; | |
50 | int ret; | |
51 | ||
d84f4f99 DH |
52 | cred = current_cred(); |
53 | user = cred->user; | |
54 | ||
69664cf1 | 55 | kenter("%p{%u}", user, user->uid); |
1da177e4 | 56 | |
69664cf1 DH |
57 | if (user->uid_keyring) { |
58 | kleave(" = 0 [exist]"); | |
59 | return 0; | |
1da177e4 LT |
60 | } |
61 | ||
69664cf1 DH |
62 | mutex_lock(&key_user_keyring_mutex); |
63 | ret = 0; | |
1da177e4 | 64 | |
69664cf1 DH |
65 | if (!user->uid_keyring) { |
66 | /* get the UID-specific keyring | |
67 | * - there may be one in existence already as it may have been | |
68 | * pinned by a session, but the user_struct pointing to it | |
69 | * may have been destroyed by setuid */ | |
70 | sprintf(buf, "_uid.%u", user->uid); | |
71 | ||
72 | uid_keyring = find_keyring_by_name(buf, true); | |
73 | if (IS_ERR(uid_keyring)) { | |
74 | uid_keyring = keyring_alloc(buf, user->uid, (gid_t) -1, | |
d84f4f99 | 75 | cred, KEY_ALLOC_IN_QUOTA, |
69664cf1 DH |
76 | NULL); |
77 | if (IS_ERR(uid_keyring)) { | |
78 | ret = PTR_ERR(uid_keyring); | |
79 | goto error; | |
80 | } | |
81 | } | |
82 | ||
83 | /* get a default session keyring (which might also exist | |
84 | * already) */ | |
85 | sprintf(buf, "_uid_ses.%u", user->uid); | |
86 | ||
87 | session_keyring = find_keyring_by_name(buf, true); | |
88 | if (IS_ERR(session_keyring)) { | |
89 | session_keyring = | |
90 | keyring_alloc(buf, user->uid, (gid_t) -1, | |
d84f4f99 | 91 | cred, KEY_ALLOC_IN_QUOTA, NULL); |
69664cf1 DH |
92 | if (IS_ERR(session_keyring)) { |
93 | ret = PTR_ERR(session_keyring); | |
94 | goto error_release; | |
95 | } | |
96 | ||
97 | /* we install a link from the user session keyring to | |
98 | * the user keyring */ | |
99 | ret = key_link(session_keyring, uid_keyring); | |
100 | if (ret < 0) | |
101 | goto error_release_both; | |
102 | } | |
103 | ||
104 | /* install the keyrings */ | |
105 | user->uid_keyring = uid_keyring; | |
106 | user->session_keyring = session_keyring; | |
1da177e4 LT |
107 | } |
108 | ||
69664cf1 DH |
109 | mutex_unlock(&key_user_keyring_mutex); |
110 | kleave(" = 0"); | |
111 | return 0; | |
1da177e4 | 112 | |
69664cf1 DH |
113 | error_release_both: |
114 | key_put(session_keyring); | |
115 | error_release: | |
116 | key_put(uid_keyring); | |
664cceb0 | 117 | error: |
69664cf1 DH |
118 | mutex_unlock(&key_user_keyring_mutex); |
119 | kleave(" = %d", ret); | |
1da177e4 | 120 | return ret; |
69664cf1 | 121 | } |
1da177e4 | 122 | |
1da177e4 | 123 | /* |
973c9f4f DH |
124 | * Install a fresh thread keyring directly to new credentials. This keyring is |
125 | * allowed to overrun the quota. | |
1da177e4 | 126 | */ |
d84f4f99 | 127 | int install_thread_keyring_to_cred(struct cred *new) |
1da177e4 | 128 | { |
d84f4f99 | 129 | struct key *keyring; |
1da177e4 | 130 | |
d84f4f99 DH |
131 | keyring = keyring_alloc("_tid", new->uid, new->gid, new, |
132 | KEY_ALLOC_QUOTA_OVERRUN, NULL); | |
133 | if (IS_ERR(keyring)) | |
134 | return PTR_ERR(keyring); | |
1da177e4 | 135 | |
d84f4f99 DH |
136 | new->thread_keyring = keyring; |
137 | return 0; | |
138 | } | |
1da177e4 | 139 | |
1da177e4 | 140 | /* |
973c9f4f | 141 | * Install a fresh thread keyring, discarding the old one. |
1da177e4 | 142 | */ |
d84f4f99 | 143 | static int install_thread_keyring(void) |
1da177e4 | 144 | { |
d84f4f99 | 145 | struct cred *new; |
1da177e4 LT |
146 | int ret; |
147 | ||
d84f4f99 DH |
148 | new = prepare_creds(); |
149 | if (!new) | |
150 | return -ENOMEM; | |
1da177e4 | 151 | |
d84f4f99 DH |
152 | BUG_ON(new->thread_keyring); |
153 | ||
154 | ret = install_thread_keyring_to_cred(new); | |
155 | if (ret < 0) { | |
156 | abort_creds(new); | |
157 | return ret; | |
1da177e4 LT |
158 | } |
159 | ||
d84f4f99 DH |
160 | return commit_creds(new); |
161 | } | |
1da177e4 | 162 | |
d84f4f99 | 163 | /* |
973c9f4f DH |
164 | * Install a process keyring directly to a credentials struct. |
165 | * | |
166 | * Returns -EEXIST if there was already a process keyring, 0 if one installed, | |
167 | * and other value on any other error | |
d84f4f99 DH |
168 | */ |
169 | int install_process_keyring_to_cred(struct cred *new) | |
170 | { | |
171 | struct key *keyring; | |
172 | int ret; | |
1da177e4 | 173 | |
d84f4f99 DH |
174 | if (new->tgcred->process_keyring) |
175 | return -EEXIST; | |
176 | ||
177 | keyring = keyring_alloc("_pid", new->uid, new->gid, | |
178 | new, KEY_ALLOC_QUOTA_OVERRUN, NULL); | |
179 | if (IS_ERR(keyring)) | |
180 | return PTR_ERR(keyring); | |
181 | ||
182 | spin_lock_irq(&new->tgcred->lock); | |
183 | if (!new->tgcred->process_keyring) { | |
184 | new->tgcred->process_keyring = keyring; | |
185 | keyring = NULL; | |
186 | ret = 0; | |
187 | } else { | |
188 | ret = -EEXIST; | |
189 | } | |
190 | spin_unlock_irq(&new->tgcred->lock); | |
191 | key_put(keyring); | |
1da177e4 | 192 | return ret; |
d84f4f99 | 193 | } |
1da177e4 | 194 | |
1da177e4 | 195 | /* |
973c9f4f DH |
196 | * Make sure a process keyring is installed for the current process. The |
197 | * existing process keyring is not replaced. | |
198 | * | |
199 | * Returns 0 if there is a process keyring by the end of this function, some | |
200 | * error otherwise. | |
1da177e4 | 201 | */ |
d84f4f99 | 202 | static int install_process_keyring(void) |
1da177e4 | 203 | { |
d84f4f99 | 204 | struct cred *new; |
1da177e4 LT |
205 | int ret; |
206 | ||
d84f4f99 DH |
207 | new = prepare_creds(); |
208 | if (!new) | |
209 | return -ENOMEM; | |
1da177e4 | 210 | |
d84f4f99 DH |
211 | ret = install_process_keyring_to_cred(new); |
212 | if (ret < 0) { | |
213 | abort_creds(new); | |
27d63798 | 214 | return ret != -EEXIST ? ret : 0; |
1da177e4 LT |
215 | } |
216 | ||
d84f4f99 DH |
217 | return commit_creds(new); |
218 | } | |
1da177e4 | 219 | |
1da177e4 | 220 | /* |
973c9f4f | 221 | * Install a session keyring directly to a credentials struct. |
1da177e4 | 222 | */ |
685bfd2c | 223 | int install_session_keyring_to_cred(struct cred *cred, struct key *keyring) |
1da177e4 | 224 | { |
7e047ef5 | 225 | unsigned long flags; |
1da177e4 | 226 | struct key *old; |
1a26feb9 DH |
227 | |
228 | might_sleep(); | |
1da177e4 LT |
229 | |
230 | /* create an empty session keyring */ | |
231 | if (!keyring) { | |
7e047ef5 | 232 | flags = KEY_ALLOC_QUOTA_OVERRUN; |
d84f4f99 | 233 | if (cred->tgcred->session_keyring) |
7e047ef5 DH |
234 | flags = KEY_ALLOC_IN_QUOTA; |
235 | ||
d84f4f99 DH |
236 | keyring = keyring_alloc("_ses", cred->uid, cred->gid, |
237 | cred, flags, NULL); | |
1a26feb9 DH |
238 | if (IS_ERR(keyring)) |
239 | return PTR_ERR(keyring); | |
d84f4f99 | 240 | } else { |
1da177e4 LT |
241 | atomic_inc(&keyring->usage); |
242 | } | |
243 | ||
244 | /* install the keyring */ | |
d84f4f99 DH |
245 | spin_lock_irq(&cred->tgcred->lock); |
246 | old = cred->tgcred->session_keyring; | |
247 | rcu_assign_pointer(cred->tgcred->session_keyring, keyring); | |
248 | spin_unlock_irq(&cred->tgcred->lock); | |
1da177e4 | 249 | |
1a26feb9 DH |
250 | /* we're using RCU on the pointer, but there's no point synchronising |
251 | * on it if it didn't previously point to anything */ | |
252 | if (old) { | |
253 | synchronize_rcu(); | |
254 | key_put(old); | |
255 | } | |
1da177e4 | 256 | |
1a26feb9 | 257 | return 0; |
d84f4f99 | 258 | } |
1da177e4 | 259 | |
1da177e4 | 260 | /* |
973c9f4f DH |
261 | * Install a session keyring, discarding the old one. If a keyring is not |
262 | * supplied, an empty one is invented. | |
1da177e4 | 263 | */ |
d84f4f99 | 264 | static int install_session_keyring(struct key *keyring) |
1da177e4 | 265 | { |
d84f4f99 DH |
266 | struct cred *new; |
267 | int ret; | |
1da177e4 | 268 | |
d84f4f99 DH |
269 | new = prepare_creds(); |
270 | if (!new) | |
271 | return -ENOMEM; | |
1da177e4 | 272 | |
99599537 | 273 | ret = install_session_keyring_to_cred(new, keyring); |
d84f4f99 DH |
274 | if (ret < 0) { |
275 | abort_creds(new); | |
276 | return ret; | |
277 | } | |
1da177e4 | 278 | |
d84f4f99 DH |
279 | return commit_creds(new); |
280 | } | |
1da177e4 | 281 | |
1da177e4 | 282 | /* |
973c9f4f | 283 | * Handle the fsuid changing. |
1da177e4 LT |
284 | */ |
285 | void key_fsuid_changed(struct task_struct *tsk) | |
286 | { | |
287 | /* update the ownership of the thread keyring */ | |
b6dff3ec DH |
288 | BUG_ON(!tsk->cred); |
289 | if (tsk->cred->thread_keyring) { | |
290 | down_write(&tsk->cred->thread_keyring->sem); | |
291 | tsk->cred->thread_keyring->uid = tsk->cred->fsuid; | |
292 | up_write(&tsk->cred->thread_keyring->sem); | |
1da177e4 | 293 | } |
a8b17ed0 | 294 | } |
1da177e4 | 295 | |
1da177e4 | 296 | /* |
973c9f4f | 297 | * Handle the fsgid changing. |
1da177e4 LT |
298 | */ |
299 | void key_fsgid_changed(struct task_struct *tsk) | |
300 | { | |
301 | /* update the ownership of the thread keyring */ | |
b6dff3ec DH |
302 | BUG_ON(!tsk->cred); |
303 | if (tsk->cred->thread_keyring) { | |
304 | down_write(&tsk->cred->thread_keyring->sem); | |
305 | tsk->cred->thread_keyring->gid = tsk->cred->fsgid; | |
306 | up_write(&tsk->cred->thread_keyring->sem); | |
1da177e4 | 307 | } |
a8b17ed0 | 308 | } |
1da177e4 | 309 | |
1da177e4 | 310 | /* |
973c9f4f DH |
311 | * Search the process keyrings attached to the supplied cred for the first |
312 | * matching key. | |
313 | * | |
314 | * The search criteria are the type and the match function. The description is | |
315 | * given to the match function as a parameter, but doesn't otherwise influence | |
316 | * the search. Typically the match function will compare the description | |
317 | * parameter to the key's description. | |
318 | * | |
319 | * This can only search keyrings that grant Search permission to the supplied | |
320 | * credentials. Keyrings linked to searched keyrings will also be searched if | |
321 | * they grant Search permission too. Keys can only be found if they grant | |
322 | * Search permission to the credentials. | |
323 | * | |
324 | * Returns a pointer to the key with the key usage count incremented if | |
325 | * successful, -EAGAIN if we didn't find any matching key or -ENOKEY if we only | |
326 | * matched negative keys. | |
327 | * | |
328 | * In the case of a successful return, the possession attribute is set on the | |
329 | * returned key reference. | |
1da177e4 | 330 | */ |
927942aa DH |
331 | key_ref_t search_my_process_keyrings(struct key_type *type, |
332 | const void *description, | |
333 | key_match_func_t match, | |
78b7280c | 334 | bool no_state_check, |
927942aa | 335 | const struct cred *cred) |
1da177e4 | 336 | { |
b5f545c8 | 337 | key_ref_t key_ref, ret, err; |
1da177e4 LT |
338 | |
339 | /* we want to return -EAGAIN or -ENOKEY if any of the keyrings were | |
340 | * searchable, but we failed to find a key or we found a negative key; | |
341 | * otherwise we want to return a sample error (probably -EACCES) if | |
342 | * none of the keyrings were searchable | |
343 | * | |
344 | * in terms of priority: success > -ENOKEY > -EAGAIN > other error | |
345 | */ | |
664cceb0 | 346 | key_ref = NULL; |
1da177e4 LT |
347 | ret = NULL; |
348 | err = ERR_PTR(-EAGAIN); | |
349 | ||
350 | /* search the thread keyring first */ | |
c69e8d9c | 351 | if (cred->thread_keyring) { |
664cceb0 | 352 | key_ref = keyring_search_aux( |
c69e8d9c | 353 | make_key_ref(cred->thread_keyring, 1), |
78b7280c | 354 | cred, type, description, match, no_state_check); |
664cceb0 | 355 | if (!IS_ERR(key_ref)) |
1da177e4 LT |
356 | goto found; |
357 | ||
664cceb0 | 358 | switch (PTR_ERR(key_ref)) { |
1da177e4 | 359 | case -EAGAIN: /* no key */ |
1da177e4 | 360 | case -ENOKEY: /* negative key */ |
664cceb0 | 361 | ret = key_ref; |
1da177e4 LT |
362 | break; |
363 | default: | |
664cceb0 | 364 | err = key_ref; |
1da177e4 LT |
365 | break; |
366 | } | |
367 | } | |
368 | ||
369 | /* search the process keyring second */ | |
bb952bb9 | 370 | if (cred->tgcred->process_keyring) { |
664cceb0 | 371 | key_ref = keyring_search_aux( |
bb952bb9 | 372 | make_key_ref(cred->tgcred->process_keyring, 1), |
78b7280c | 373 | cred, type, description, match, no_state_check); |
664cceb0 | 374 | if (!IS_ERR(key_ref)) |
1da177e4 LT |
375 | goto found; |
376 | ||
664cceb0 | 377 | switch (PTR_ERR(key_ref)) { |
1da177e4 LT |
378 | case -EAGAIN: /* no key */ |
379 | if (ret) | |
380 | break; | |
381 | case -ENOKEY: /* negative key */ | |
664cceb0 | 382 | ret = key_ref; |
1da177e4 LT |
383 | break; |
384 | default: | |
664cceb0 | 385 | err = key_ref; |
1da177e4 LT |
386 | break; |
387 | } | |
388 | } | |
389 | ||
3e30148c | 390 | /* search the session keyring */ |
bb952bb9 | 391 | if (cred->tgcred->session_keyring) { |
8589b4e0 | 392 | rcu_read_lock(); |
664cceb0 DH |
393 | key_ref = keyring_search_aux( |
394 | make_key_ref(rcu_dereference( | |
bb952bb9 | 395 | cred->tgcred->session_keyring), |
664cceb0 | 396 | 1), |
78b7280c | 397 | cred, type, description, match, no_state_check); |
8589b4e0 | 398 | rcu_read_unlock(); |
3e30148c | 399 | |
664cceb0 | 400 | if (!IS_ERR(key_ref)) |
3e30148c DH |
401 | goto found; |
402 | ||
664cceb0 | 403 | switch (PTR_ERR(key_ref)) { |
3e30148c DH |
404 | case -EAGAIN: /* no key */ |
405 | if (ret) | |
406 | break; | |
407 | case -ENOKEY: /* negative key */ | |
664cceb0 | 408 | ret = key_ref; |
3e30148c DH |
409 | break; |
410 | default: | |
664cceb0 | 411 | err = key_ref; |
3e30148c DH |
412 | break; |
413 | } | |
b5f545c8 DH |
414 | } |
415 | /* or search the user-session keyring */ | |
c69e8d9c | 416 | else if (cred->user->session_keyring) { |
b5f545c8 | 417 | key_ref = keyring_search_aux( |
c69e8d9c | 418 | make_key_ref(cred->user->session_keyring, 1), |
78b7280c | 419 | cred, type, description, match, no_state_check); |
664cceb0 | 420 | if (!IS_ERR(key_ref)) |
3e30148c DH |
421 | goto found; |
422 | ||
664cceb0 | 423 | switch (PTR_ERR(key_ref)) { |
3e30148c DH |
424 | case -EAGAIN: /* no key */ |
425 | if (ret) | |
426 | break; | |
427 | case -ENOKEY: /* negative key */ | |
664cceb0 | 428 | ret = key_ref; |
3e30148c DH |
429 | break; |
430 | default: | |
664cceb0 | 431 | err = key_ref; |
3e30148c DH |
432 | break; |
433 | } | |
8589b4e0 | 434 | } |
b5f545c8 | 435 | |
927942aa DH |
436 | /* no key - decide on the error we're going to go for */ |
437 | key_ref = ret ? ret : err; | |
438 | ||
439 | found: | |
440 | return key_ref; | |
441 | } | |
442 | ||
927942aa | 443 | /* |
973c9f4f DH |
444 | * Search the process keyrings attached to the supplied cred for the first |
445 | * matching key in the manner of search_my_process_keyrings(), but also search | |
446 | * the keys attached to the assumed authorisation key using its credentials if | |
447 | * one is available. | |
448 | * | |
449 | * Return same as search_my_process_keyrings(). | |
927942aa DH |
450 | */ |
451 | key_ref_t search_process_keyrings(struct key_type *type, | |
452 | const void *description, | |
453 | key_match_func_t match, | |
454 | const struct cred *cred) | |
455 | { | |
456 | struct request_key_auth *rka; | |
457 | key_ref_t key_ref, ret = ERR_PTR(-EACCES), err; | |
458 | ||
459 | might_sleep(); | |
460 | ||
78b7280c DH |
461 | key_ref = search_my_process_keyrings(type, description, match, |
462 | false, cred); | |
927942aa DH |
463 | if (!IS_ERR(key_ref)) |
464 | goto found; | |
465 | err = key_ref; | |
466 | ||
b5f545c8 DH |
467 | /* if this process has an instantiation authorisation key, then we also |
468 | * search the keyrings of the process mentioned there | |
469 | * - we don't permit access to request_key auth keys via this method | |
470 | */ | |
c69e8d9c | 471 | if (cred->request_key_auth && |
d84f4f99 | 472 | cred == current_cred() && |
04c567d9 | 473 | type != &key_type_request_key_auth |
b5f545c8 | 474 | ) { |
04c567d9 | 475 | /* defend against the auth key being revoked */ |
c69e8d9c | 476 | down_read(&cred->request_key_auth->sem); |
b5f545c8 | 477 | |
c69e8d9c DH |
478 | if (key_validate(cred->request_key_auth) == 0) { |
479 | rka = cred->request_key_auth->payload.data; | |
b5f545c8 | 480 | |
04c567d9 | 481 | key_ref = search_process_keyrings(type, description, |
d84f4f99 | 482 | match, rka->cred); |
1da177e4 | 483 | |
c69e8d9c | 484 | up_read(&cred->request_key_auth->sem); |
04c567d9 DH |
485 | |
486 | if (!IS_ERR(key_ref)) | |
487 | goto found; | |
488 | ||
927942aa | 489 | ret = key_ref; |
04c567d9 | 490 | } else { |
c69e8d9c | 491 | up_read(&cred->request_key_auth->sem); |
3e30148c | 492 | } |
1da177e4 LT |
493 | } |
494 | ||
495 | /* no key - decide on the error we're going to go for */ | |
927942aa DH |
496 | if (err == ERR_PTR(-ENOKEY) || ret == ERR_PTR(-ENOKEY)) |
497 | key_ref = ERR_PTR(-ENOKEY); | |
498 | else if (err == ERR_PTR(-EACCES)) | |
499 | key_ref = ret; | |
500 | else | |
501 | key_ref = err; | |
1da177e4 | 502 | |
3e30148c | 503 | found: |
664cceb0 | 504 | return key_ref; |
a8b17ed0 | 505 | } |
1da177e4 | 506 | |
664cceb0 | 507 | /* |
973c9f4f | 508 | * See if the key we're looking at is the target key. |
664cceb0 | 509 | */ |
927942aa | 510 | int lookup_user_key_possessed(const struct key *key, const void *target) |
664cceb0 DH |
511 | { |
512 | return key == target; | |
a8b17ed0 | 513 | } |
664cceb0 | 514 | |
1da177e4 | 515 | /* |
973c9f4f DH |
516 | * Look up a key ID given us by userspace with a given permissions mask to get |
517 | * the key it refers to. | |
518 | * | |
519 | * Flags can be passed to request that special keyrings be created if referred | |
520 | * to directly, to permit partially constructed keys to be found and to skip | |
521 | * validity and permission checks on the found key. | |
522 | * | |
523 | * Returns a pointer to the key with an incremented usage count if successful; | |
524 | * -EINVAL if the key ID is invalid; -ENOKEY if the key ID does not correspond | |
525 | * to a key or the best found key was a negative key; -EKEYREVOKED or | |
526 | * -EKEYEXPIRED if the best found key was revoked or expired; -EACCES if the | |
527 | * found key doesn't grant the requested permit or the LSM denied access to it; | |
528 | * or -ENOMEM if a special keyring couldn't be created. | |
529 | * | |
530 | * In the case of a successful return, the possession attribute is set on the | |
531 | * returned key reference. | |
1da177e4 | 532 | */ |
5593122e | 533 | key_ref_t lookup_user_key(key_serial_t id, unsigned long lflags, |
8bbf4976 | 534 | key_perm_t perm) |
1da177e4 | 535 | { |
8bbf4976 | 536 | struct request_key_auth *rka; |
d84f4f99 | 537 | const struct cred *cred; |
1da177e4 | 538 | struct key *key; |
b6dff3ec | 539 | key_ref_t key_ref, skey_ref; |
1da177e4 LT |
540 | int ret; |
541 | ||
bb952bb9 DH |
542 | try_again: |
543 | cred = get_current_cred(); | |
664cceb0 | 544 | key_ref = ERR_PTR(-ENOKEY); |
1da177e4 LT |
545 | |
546 | switch (id) { | |
547 | case KEY_SPEC_THREAD_KEYRING: | |
b6dff3ec | 548 | if (!cred->thread_keyring) { |
5593122e | 549 | if (!(lflags & KEY_LOOKUP_CREATE)) |
1da177e4 LT |
550 | goto error; |
551 | ||
8bbf4976 | 552 | ret = install_thread_keyring(); |
1da177e4 | 553 | if (ret < 0) { |
4d09ec0f | 554 | key_ref = ERR_PTR(ret); |
1da177e4 LT |
555 | goto error; |
556 | } | |
bb952bb9 | 557 | goto reget_creds; |
1da177e4 LT |
558 | } |
559 | ||
b6dff3ec | 560 | key = cred->thread_keyring; |
1da177e4 | 561 | atomic_inc(&key->usage); |
664cceb0 | 562 | key_ref = make_key_ref(key, 1); |
1da177e4 LT |
563 | break; |
564 | ||
565 | case KEY_SPEC_PROCESS_KEYRING: | |
bb952bb9 | 566 | if (!cred->tgcred->process_keyring) { |
5593122e | 567 | if (!(lflags & KEY_LOOKUP_CREATE)) |
1da177e4 LT |
568 | goto error; |
569 | ||
8bbf4976 | 570 | ret = install_process_keyring(); |
1da177e4 | 571 | if (ret < 0) { |
4d09ec0f | 572 | key_ref = ERR_PTR(ret); |
1da177e4 LT |
573 | goto error; |
574 | } | |
bb952bb9 | 575 | goto reget_creds; |
1da177e4 LT |
576 | } |
577 | ||
bb952bb9 | 578 | key = cred->tgcred->process_keyring; |
1da177e4 | 579 | atomic_inc(&key->usage); |
664cceb0 | 580 | key_ref = make_key_ref(key, 1); |
1da177e4 LT |
581 | break; |
582 | ||
583 | case KEY_SPEC_SESSION_KEYRING: | |
bb952bb9 | 584 | if (!cred->tgcred->session_keyring) { |
1da177e4 LT |
585 | /* always install a session keyring upon access if one |
586 | * doesn't exist yet */ | |
8bbf4976 | 587 | ret = install_user_keyrings(); |
69664cf1 DH |
588 | if (ret < 0) |
589 | goto error; | |
3ecf1b4f DH |
590 | if (lflags & KEY_LOOKUP_CREATE) |
591 | ret = join_session_keyring(NULL); | |
592 | else | |
593 | ret = install_session_keyring( | |
594 | cred->user->session_keyring); | |
d84f4f99 | 595 | |
1da177e4 LT |
596 | if (ret < 0) |
597 | goto error; | |
bb952bb9 | 598 | goto reget_creds; |
3ecf1b4f DH |
599 | } else if (cred->tgcred->session_keyring == |
600 | cred->user->session_keyring && | |
601 | lflags & KEY_LOOKUP_CREATE) { | |
602 | ret = join_session_keyring(NULL); | |
603 | if (ret < 0) | |
604 | goto error; | |
605 | goto reget_creds; | |
1da177e4 LT |
606 | } |
607 | ||
3e30148c | 608 | rcu_read_lock(); |
bb952bb9 | 609 | key = rcu_dereference(cred->tgcred->session_keyring); |
1da177e4 | 610 | atomic_inc(&key->usage); |
3e30148c | 611 | rcu_read_unlock(); |
664cceb0 | 612 | key_ref = make_key_ref(key, 1); |
1da177e4 LT |
613 | break; |
614 | ||
615 | case KEY_SPEC_USER_KEYRING: | |
b6dff3ec | 616 | if (!cred->user->uid_keyring) { |
8bbf4976 | 617 | ret = install_user_keyrings(); |
69664cf1 DH |
618 | if (ret < 0) |
619 | goto error; | |
620 | } | |
621 | ||
b6dff3ec | 622 | key = cred->user->uid_keyring; |
1da177e4 | 623 | atomic_inc(&key->usage); |
664cceb0 | 624 | key_ref = make_key_ref(key, 1); |
1da177e4 LT |
625 | break; |
626 | ||
627 | case KEY_SPEC_USER_SESSION_KEYRING: | |
b6dff3ec | 628 | if (!cred->user->session_keyring) { |
8bbf4976 | 629 | ret = install_user_keyrings(); |
69664cf1 DH |
630 | if (ret < 0) |
631 | goto error; | |
632 | } | |
633 | ||
b6dff3ec | 634 | key = cred->user->session_keyring; |
1da177e4 | 635 | atomic_inc(&key->usage); |
664cceb0 | 636 | key_ref = make_key_ref(key, 1); |
1da177e4 LT |
637 | break; |
638 | ||
639 | case KEY_SPEC_GROUP_KEYRING: | |
640 | /* group keyrings are not yet supported */ | |
4d09ec0f | 641 | key_ref = ERR_PTR(-EINVAL); |
1da177e4 LT |
642 | goto error; |
643 | ||
b5f545c8 | 644 | case KEY_SPEC_REQKEY_AUTH_KEY: |
b6dff3ec | 645 | key = cred->request_key_auth; |
b5f545c8 DH |
646 | if (!key) |
647 | goto error; | |
648 | ||
649 | atomic_inc(&key->usage); | |
650 | key_ref = make_key_ref(key, 1); | |
651 | break; | |
652 | ||
8bbf4976 | 653 | case KEY_SPEC_REQUESTOR_KEYRING: |
b6dff3ec | 654 | if (!cred->request_key_auth) |
8bbf4976 DH |
655 | goto error; |
656 | ||
b6dff3ec | 657 | down_read(&cred->request_key_auth->sem); |
f67dabbd DC |
658 | if (test_bit(KEY_FLAG_REVOKED, |
659 | &cred->request_key_auth->flags)) { | |
8bbf4976 DH |
660 | key_ref = ERR_PTR(-EKEYREVOKED); |
661 | key = NULL; | |
662 | } else { | |
b6dff3ec | 663 | rka = cred->request_key_auth->payload.data; |
8bbf4976 DH |
664 | key = rka->dest_keyring; |
665 | atomic_inc(&key->usage); | |
666 | } | |
b6dff3ec | 667 | up_read(&cred->request_key_auth->sem); |
8bbf4976 DH |
668 | if (!key) |
669 | goto error; | |
670 | key_ref = make_key_ref(key, 1); | |
671 | break; | |
672 | ||
1da177e4 | 673 | default: |
664cceb0 | 674 | key_ref = ERR_PTR(-EINVAL); |
1da177e4 LT |
675 | if (id < 1) |
676 | goto error; | |
677 | ||
678 | key = key_lookup(id); | |
664cceb0 | 679 | if (IS_ERR(key)) { |
e231c2ee | 680 | key_ref = ERR_CAST(key); |
1da177e4 | 681 | goto error; |
664cceb0 DH |
682 | } |
683 | ||
684 | key_ref = make_key_ref(key, 0); | |
685 | ||
686 | /* check to see if we possess the key */ | |
687 | skey_ref = search_process_keyrings(key->type, key, | |
688 | lookup_user_key_possessed, | |
d84f4f99 | 689 | cred); |
664cceb0 DH |
690 | |
691 | if (!IS_ERR(skey_ref)) { | |
692 | key_put(key); | |
693 | key_ref = skey_ref; | |
694 | } | |
695 | ||
1da177e4 LT |
696 | break; |
697 | } | |
698 | ||
5593122e DH |
699 | /* unlink does not use the nominated key in any way, so can skip all |
700 | * the permission checks as it is only concerned with the keyring */ | |
701 | if (lflags & KEY_LOOKUP_FOR_UNLINK) { | |
702 | ret = 0; | |
703 | goto error; | |
704 | } | |
705 | ||
706 | if (!(lflags & KEY_LOOKUP_PARTIAL)) { | |
76181c13 DH |
707 | ret = wait_for_key_construction(key, true); |
708 | switch (ret) { | |
709 | case -ERESTARTSYS: | |
710 | goto invalid_key; | |
711 | default: | |
712 | if (perm) | |
713 | goto invalid_key; | |
714 | case 0: | |
715 | break; | |
716 | } | |
717 | } else if (perm) { | |
1da177e4 LT |
718 | ret = key_validate(key); |
719 | if (ret < 0) | |
720 | goto invalid_key; | |
721 | } | |
722 | ||
723 | ret = -EIO; | |
5593122e DH |
724 | if (!(lflags & KEY_LOOKUP_PARTIAL) && |
725 | !test_bit(KEY_FLAG_INSTANTIATED, &key->flags)) | |
1da177e4 LT |
726 | goto invalid_key; |
727 | ||
3e30148c | 728 | /* check the permissions */ |
d84f4f99 | 729 | ret = key_task_permission(key_ref, cred, perm); |
29db9190 | 730 | if (ret < 0) |
1da177e4 LT |
731 | goto invalid_key; |
732 | ||
31d5a79d DH |
733 | key->last_used_at = current_kernel_time().tv_sec; |
734 | ||
664cceb0 | 735 | error: |
bb952bb9 | 736 | put_cred(cred); |
664cceb0 | 737 | return key_ref; |
1da177e4 | 738 | |
664cceb0 DH |
739 | invalid_key: |
740 | key_ref_put(key_ref); | |
741 | key_ref = ERR_PTR(ret); | |
1da177e4 LT |
742 | goto error; |
743 | ||
bb952bb9 DH |
744 | /* if we attempted to install a keyring, then it may have caused new |
745 | * creds to be installed */ | |
746 | reget_creds: | |
747 | put_cred(cred); | |
748 | goto try_again; | |
a8b17ed0 | 749 | } |
bb952bb9 | 750 | |
1da177e4 | 751 | /* |
973c9f4f DH |
752 | * Join the named keyring as the session keyring if possible else attempt to |
753 | * create a new one of that name and join that. | |
754 | * | |
755 | * If the name is NULL, an empty anonymous keyring will be installed as the | |
756 | * session keyring. | |
757 | * | |
758 | * Named session keyrings are joined with a semaphore held to prevent the | |
759 | * keyrings from going away whilst the attempt is made to going them and also | |
760 | * to prevent a race in creating compatible session keyrings. | |
1da177e4 LT |
761 | */ |
762 | long join_session_keyring(const char *name) | |
763 | { | |
d84f4f99 DH |
764 | const struct cred *old; |
765 | struct cred *new; | |
1da177e4 | 766 | struct key *keyring; |
d84f4f99 DH |
767 | long ret, serial; |
768 | ||
769 | /* only permit this if there's a single thread in the thread group - | |
770 | * this avoids us having to adjust the creds on all threads and risking | |
771 | * ENOMEM */ | |
5bb459bb | 772 | if (!current_is_single_threaded()) |
d84f4f99 DH |
773 | return -EMLINK; |
774 | ||
775 | new = prepare_creds(); | |
776 | if (!new) | |
777 | return -ENOMEM; | |
778 | old = current_cred(); | |
1da177e4 LT |
779 | |
780 | /* if no name is provided, install an anonymous keyring */ | |
781 | if (!name) { | |
d84f4f99 | 782 | ret = install_session_keyring_to_cred(new, NULL); |
1da177e4 LT |
783 | if (ret < 0) |
784 | goto error; | |
785 | ||
d84f4f99 DH |
786 | serial = new->tgcred->session_keyring->serial; |
787 | ret = commit_creds(new); | |
788 | if (ret == 0) | |
789 | ret = serial; | |
790 | goto okay; | |
1da177e4 LT |
791 | } |
792 | ||
793 | /* allow the user to join or create a named keyring */ | |
bb003079 | 794 | mutex_lock(&key_session_mutex); |
1da177e4 LT |
795 | |
796 | /* look for an existing keyring of this name */ | |
69664cf1 | 797 | keyring = find_keyring_by_name(name, false); |
1da177e4 LT |
798 | if (PTR_ERR(keyring) == -ENOKEY) { |
799 | /* not found - try and create a new one */ | |
d84f4f99 | 800 | keyring = keyring_alloc(name, old->uid, old->gid, old, |
7e047ef5 | 801 | KEY_ALLOC_IN_QUOTA, NULL); |
1da177e4 LT |
802 | if (IS_ERR(keyring)) { |
803 | ret = PTR_ERR(keyring); | |
bcf945d3 | 804 | goto error2; |
1da177e4 | 805 | } |
d84f4f99 | 806 | } else if (IS_ERR(keyring)) { |
1da177e4 LT |
807 | ret = PTR_ERR(keyring); |
808 | goto error2; | |
809 | } | |
810 | ||
811 | /* we've got a keyring - now to install it */ | |
d84f4f99 | 812 | ret = install_session_keyring_to_cred(new, keyring); |
1da177e4 LT |
813 | if (ret < 0) |
814 | goto error2; | |
815 | ||
d84f4f99 DH |
816 | commit_creds(new); |
817 | mutex_unlock(&key_session_mutex); | |
818 | ||
1da177e4 LT |
819 | ret = keyring->serial; |
820 | key_put(keyring); | |
d84f4f99 DH |
821 | okay: |
822 | return ret; | |
1da177e4 | 823 | |
664cceb0 | 824 | error2: |
bb003079 | 825 | mutex_unlock(&key_session_mutex); |
664cceb0 | 826 | error: |
d84f4f99 | 827 | abort_creds(new); |
1da177e4 | 828 | return ret; |
d84f4f99 | 829 | } |
ee18d64c DH |
830 | |
831 | /* | |
973c9f4f DH |
832 | * Replace a process's session keyring on behalf of one of its children when |
833 | * the target process is about to resume userspace execution. | |
ee18d64c | 834 | */ |
67d12145 | 835 | void key_change_session_keyring(struct callback_head *twork) |
ee18d64c | 836 | { |
413cd3d9 | 837 | const struct cred *old = current_cred(); |
67d12145 | 838 | struct cred *new = container_of(twork, struct cred, rcu); |
ee18d64c | 839 | |
413cd3d9 ON |
840 | if (unlikely(current->flags & PF_EXITING)) { |
841 | put_cred(new); | |
ee18d64c | 842 | return; |
413cd3d9 | 843 | } |
ee18d64c | 844 | |
ee18d64c DH |
845 | new-> uid = old-> uid; |
846 | new-> euid = old-> euid; | |
847 | new-> suid = old-> suid; | |
848 | new->fsuid = old->fsuid; | |
849 | new-> gid = old-> gid; | |
850 | new-> egid = old-> egid; | |
851 | new-> sgid = old-> sgid; | |
852 | new->fsgid = old->fsgid; | |
853 | new->user = get_uid(old->user); | |
0093ccb6 | 854 | new->user_ns = get_user_ns(new->user_ns); |
ee18d64c DH |
855 | new->group_info = get_group_info(old->group_info); |
856 | ||
857 | new->securebits = old->securebits; | |
858 | new->cap_inheritable = old->cap_inheritable; | |
859 | new->cap_permitted = old->cap_permitted; | |
860 | new->cap_effective = old->cap_effective; | |
861 | new->cap_bset = old->cap_bset; | |
862 | ||
863 | new->jit_keyring = old->jit_keyring; | |
864 | new->thread_keyring = key_get(old->thread_keyring); | |
865 | new->tgcred->tgid = old->tgcred->tgid; | |
866 | new->tgcred->process_keyring = key_get(old->tgcred->process_keyring); | |
867 | ||
868 | security_transfer_creds(new, old); | |
869 | ||
870 | commit_creds(new); | |
871 | } |