1 /* process_keys.c: management of a process's keyrings
3 * Copyright (C) 2004-5 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
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.
12 #include <linux/module.h>
13 #include <linux/init.h>
14 #include <linux/sched.h>
15 #include <linux/slab.h>
16 #include <linux/keyctl.h>
18 #include <linux/err.h>
19 #include <linux/mutex.h>
20 #include <asm/uaccess.h>
23 /* session keyring create vs join semaphore */
24 static DEFINE_MUTEX(key_session_mutex
);
26 /* the root user's tracking struct */
27 struct key_user root_key_user
= {
28 .usage
= ATOMIC_INIT(3),
29 .cons_lock
= __MUTEX_INITIALIZER(root_key_user
.cons_lock
),
30 .lock
= __SPIN_LOCK_UNLOCKED(root_key_user
.lock
),
31 .nkeys
= ATOMIC_INIT(2),
32 .nikeys
= ATOMIC_INIT(2),
36 /* the root user's UID keyring */
37 struct key root_user_keyring
= {
38 .usage
= ATOMIC_INIT(1),
40 .type
= &key_type_keyring
,
41 .user
= &root_key_user
,
42 .sem
= __RWSEM_INITIALIZER(root_user_keyring
.sem
),
43 .perm
= (KEY_POS_ALL
& ~KEY_POS_SETATTR
) | KEY_USR_ALL
,
44 .flags
= 1 << KEY_FLAG_INSTANTIATED
,
45 .description
= "_uid.0",
47 .magic
= KEY_DEBUG_MAGIC
,
51 /* the root user's default session keyring */
52 struct key root_session_keyring
= {
53 .usage
= ATOMIC_INIT(1),
55 .type
= &key_type_keyring
,
56 .user
= &root_key_user
,
57 .sem
= __RWSEM_INITIALIZER(root_session_keyring
.sem
),
58 .perm
= (KEY_POS_ALL
& ~KEY_POS_SETATTR
) | KEY_USR_ALL
,
59 .flags
= 1 << KEY_FLAG_INSTANTIATED
,
60 .description
= "_uid_ses.0",
62 .magic
= KEY_DEBUG_MAGIC
,
66 /*****************************************************************************/
68 * allocate the keyrings to be associated with a UID
70 int alloc_uid_keyring(struct user_struct
*user
,
71 struct task_struct
*ctx
)
73 struct key
*uid_keyring
, *session_keyring
;
77 /* concoct a default session keyring */
78 sprintf(buf
, "_uid_ses.%u", user
->uid
);
80 session_keyring
= keyring_alloc(buf
, user
->uid
, (gid_t
) -1, ctx
,
81 KEY_ALLOC_IN_QUOTA
, NULL
);
82 if (IS_ERR(session_keyring
)) {
83 ret
= PTR_ERR(session_keyring
);
87 /* and a UID specific keyring, pointed to by the default session
89 sprintf(buf
, "_uid.%u", user
->uid
);
91 uid_keyring
= keyring_alloc(buf
, user
->uid
, (gid_t
) -1, ctx
,
92 KEY_ALLOC_IN_QUOTA
, session_keyring
);
93 if (IS_ERR(uid_keyring
)) {
94 key_put(session_keyring
);
95 ret
= PTR_ERR(uid_keyring
);
99 /* install the keyrings */
100 user
->uid_keyring
= uid_keyring
;
101 user
->session_keyring
= session_keyring
;
107 } /* end alloc_uid_keyring() */
109 /*****************************************************************************/
111 * deal with the UID changing
113 void switch_uid_keyring(struct user_struct
*new_user
)
115 #if 0 /* do nothing for now */
118 /* switch to the new user's session keyring if we were running under
119 * root's default session keyring */
120 if (new_user
->uid
!= 0 &&
121 current
->session_keyring
== &root_session_keyring
123 atomic_inc(&new_user
->session_keyring
->usage
);
126 old
= current
->session_keyring
;
127 current
->session_keyring
= new_user
->session_keyring
;
128 task_unlock(current
);
134 } /* end switch_uid_keyring() */
136 /*****************************************************************************/
138 * install a fresh thread keyring, discarding the old one
140 int install_thread_keyring(struct task_struct
*tsk
)
142 struct key
*keyring
, *old
;
146 sprintf(buf
, "_tid.%u", tsk
->pid
);
148 keyring
= keyring_alloc(buf
, tsk
->uid
, tsk
->gid
, tsk
,
149 KEY_ALLOC_QUOTA_OVERRUN
, NULL
);
150 if (IS_ERR(keyring
)) {
151 ret
= PTR_ERR(keyring
);
156 old
= tsk
->thread_keyring
;
157 tsk
->thread_keyring
= keyring
;
166 } /* end install_thread_keyring() */
168 /*****************************************************************************/
170 * make sure a process keyring is installed
172 int install_process_keyring(struct task_struct
*tsk
)
180 if (!tsk
->signal
->process_keyring
) {
181 sprintf(buf
, "_pid.%u", tsk
->tgid
);
183 keyring
= keyring_alloc(buf
, tsk
->uid
, tsk
->gid
, tsk
,
184 KEY_ALLOC_QUOTA_OVERRUN
, NULL
);
185 if (IS_ERR(keyring
)) {
186 ret
= PTR_ERR(keyring
);
191 spin_lock_irq(&tsk
->sighand
->siglock
);
192 if (!tsk
->signal
->process_keyring
) {
193 tsk
->signal
->process_keyring
= keyring
;
196 spin_unlock_irq(&tsk
->sighand
->siglock
);
205 } /* end install_process_keyring() */
207 /*****************************************************************************/
209 * install a session keyring, discarding the old one
210 * - if a keyring is not supplied, an empty one is invented
212 static int install_session_keyring(struct task_struct
*tsk
,
221 /* create an empty session keyring */
223 sprintf(buf
, "_ses.%u", tsk
->tgid
);
225 flags
= KEY_ALLOC_QUOTA_OVERRUN
;
226 if (tsk
->signal
->session_keyring
)
227 flags
= KEY_ALLOC_IN_QUOTA
;
229 keyring
= keyring_alloc(buf
, tsk
->uid
, tsk
->gid
, tsk
,
232 return PTR_ERR(keyring
);
235 atomic_inc(&keyring
->usage
);
238 /* install the keyring */
239 spin_lock_irq(&tsk
->sighand
->siglock
);
240 old
= tsk
->signal
->session_keyring
;
241 rcu_assign_pointer(tsk
->signal
->session_keyring
, keyring
);
242 spin_unlock_irq(&tsk
->sighand
->siglock
);
244 /* we're using RCU on the pointer, but there's no point synchronising
245 * on it if it didn't previously point to anything */
253 } /* end install_session_keyring() */
255 /*****************************************************************************/
257 * copy the keys in a thread group for fork without CLONE_THREAD
259 int copy_thread_group_keys(struct task_struct
*tsk
)
261 key_check(current
->thread_group
->session_keyring
);
262 key_check(current
->thread_group
->process_keyring
);
264 /* no process keyring yet */
265 tsk
->signal
->process_keyring
= NULL
;
267 /* same session keyring */
269 tsk
->signal
->session_keyring
=
270 key_get(rcu_dereference(current
->signal
->session_keyring
));
275 } /* end copy_thread_group_keys() */
277 /*****************************************************************************/
279 * copy the keys for fork
281 int copy_keys(unsigned long clone_flags
, struct task_struct
*tsk
)
283 key_check(tsk
->thread_keyring
);
284 key_check(tsk
->request_key_auth
);
286 /* no thread keyring yet */
287 tsk
->thread_keyring
= NULL
;
289 /* copy the request_key() authorisation for this thread */
290 key_get(tsk
->request_key_auth
);
294 } /* end copy_keys() */
296 /*****************************************************************************/
298 * dispose of thread group keys upon thread group destruction
300 void exit_thread_group_keys(struct signal_struct
*tg
)
302 key_put(tg
->session_keyring
);
303 key_put(tg
->process_keyring
);
305 } /* end exit_thread_group_keys() */
307 /*****************************************************************************/
309 * dispose of per-thread keys upon thread exit
311 void exit_keys(struct task_struct
*tsk
)
313 key_put(tsk
->thread_keyring
);
314 key_put(tsk
->request_key_auth
);
316 } /* end exit_keys() */
318 /*****************************************************************************/
322 int exec_keys(struct task_struct
*tsk
)
326 /* newly exec'd tasks don't get a thread keyring */
328 old
= tsk
->thread_keyring
;
329 tsk
->thread_keyring
= NULL
;
334 /* discard the process keyring from a newly exec'd task */
335 spin_lock_irq(&tsk
->sighand
->siglock
);
336 old
= tsk
->signal
->process_keyring
;
337 tsk
->signal
->process_keyring
= NULL
;
338 spin_unlock_irq(&tsk
->sighand
->siglock
);
344 } /* end exec_keys() */
346 /*****************************************************************************/
348 * deal with SUID programs
349 * - we might want to make this invent a new session keyring
351 int suid_keys(struct task_struct
*tsk
)
355 } /* end suid_keys() */
357 /*****************************************************************************/
359 * the filesystem user ID changed
361 void key_fsuid_changed(struct task_struct
*tsk
)
363 /* update the ownership of the thread keyring */
364 if (tsk
->thread_keyring
) {
365 down_write(&tsk
->thread_keyring
->sem
);
366 tsk
->thread_keyring
->uid
= tsk
->fsuid
;
367 up_write(&tsk
->thread_keyring
->sem
);
370 } /* end key_fsuid_changed() */
372 /*****************************************************************************/
374 * the filesystem group ID changed
376 void key_fsgid_changed(struct task_struct
*tsk
)
378 /* update the ownership of the thread keyring */
379 if (tsk
->thread_keyring
) {
380 down_write(&tsk
->thread_keyring
->sem
);
381 tsk
->thread_keyring
->gid
= tsk
->fsgid
;
382 up_write(&tsk
->thread_keyring
->sem
);
385 } /* end key_fsgid_changed() */
387 /*****************************************************************************/
389 * search the process keyrings for the first matching key
390 * - we use the supplied match function to see if the description (or other
391 * feature of interest) matches
392 * - we return -EAGAIN if we didn't find any matching key
393 * - we return -ENOKEY if we found only negative matching keys
395 key_ref_t
search_process_keyrings(struct key_type
*type
,
396 const void *description
,
397 key_match_func_t match
,
398 struct task_struct
*context
)
400 struct request_key_auth
*rka
;
401 key_ref_t key_ref
, ret
, err
;
405 /* we want to return -EAGAIN or -ENOKEY if any of the keyrings were
406 * searchable, but we failed to find a key or we found a negative key;
407 * otherwise we want to return a sample error (probably -EACCES) if
408 * none of the keyrings were searchable
410 * in terms of priority: success > -ENOKEY > -EAGAIN > other error
414 err
= ERR_PTR(-EAGAIN
);
416 /* search the thread keyring first */
417 if (context
->thread_keyring
) {
418 key_ref
= keyring_search_aux(
419 make_key_ref(context
->thread_keyring
, 1),
420 context
, type
, description
, match
);
421 if (!IS_ERR(key_ref
))
424 switch (PTR_ERR(key_ref
)) {
425 case -EAGAIN
: /* no key */
428 case -ENOKEY
: /* negative key */
437 /* search the process keyring second */
438 if (context
->signal
->process_keyring
) {
439 key_ref
= keyring_search_aux(
440 make_key_ref(context
->signal
->process_keyring
, 1),
441 context
, type
, description
, match
);
442 if (!IS_ERR(key_ref
))
445 switch (PTR_ERR(key_ref
)) {
446 case -EAGAIN
: /* no key */
449 case -ENOKEY
: /* negative key */
458 /* search the session keyring */
459 if (context
->signal
->session_keyring
) {
461 key_ref
= keyring_search_aux(
462 make_key_ref(rcu_dereference(
463 context
->signal
->session_keyring
),
465 context
, type
, description
, match
);
468 if (!IS_ERR(key_ref
))
471 switch (PTR_ERR(key_ref
)) {
472 case -EAGAIN
: /* no key */
475 case -ENOKEY
: /* negative key */
483 /* or search the user-session keyring */
485 key_ref
= keyring_search_aux(
486 make_key_ref(context
->user
->session_keyring
, 1),
487 context
, type
, description
, match
);
488 if (!IS_ERR(key_ref
))
491 switch (PTR_ERR(key_ref
)) {
492 case -EAGAIN
: /* no key */
495 case -ENOKEY
: /* negative key */
504 /* if this process has an instantiation authorisation key, then we also
505 * search the keyrings of the process mentioned there
506 * - we don't permit access to request_key auth keys via this method
508 if (context
->request_key_auth
&&
509 context
== current
&&
510 type
!= &key_type_request_key_auth
512 /* defend against the auth key being revoked */
513 down_read(&context
->request_key_auth
->sem
);
515 if (key_validate(context
->request_key_auth
) == 0) {
516 rka
= context
->request_key_auth
->payload
.data
;
518 key_ref
= search_process_keyrings(type
, description
,
519 match
, rka
->context
);
521 up_read(&context
->request_key_auth
->sem
);
523 if (!IS_ERR(key_ref
))
526 switch (PTR_ERR(key_ref
)) {
527 case -EAGAIN
: /* no key */
530 case -ENOKEY
: /* negative key */
538 up_read(&context
->request_key_auth
->sem
);
542 /* no key - decide on the error we're going to go for */
543 key_ref
= ret
? ret
: err
;
548 } /* end search_process_keyrings() */
550 /*****************************************************************************/
552 * see if the key we're looking at is the target key
554 static int lookup_user_key_possessed(const struct key
*key
, const void *target
)
556 return key
== target
;
558 } /* end lookup_user_key_possessed() */
560 /*****************************************************************************/
562 * lookup a key given a key ID from userspace with a given permissions mask
563 * - don't create special keyrings unless so requested
564 * - partially constructed keys aren't found unless requested
566 key_ref_t
lookup_user_key(struct task_struct
*context
, key_serial_t id
,
567 int create
, int partial
, key_perm_t perm
)
569 key_ref_t key_ref
, skey_ref
;
576 key_ref
= ERR_PTR(-ENOKEY
);
579 case KEY_SPEC_THREAD_KEYRING
:
580 if (!context
->thread_keyring
) {
584 ret
= install_thread_keyring(context
);
591 key
= context
->thread_keyring
;
592 atomic_inc(&key
->usage
);
593 key_ref
= make_key_ref(key
, 1);
596 case KEY_SPEC_PROCESS_KEYRING
:
597 if (!context
->signal
->process_keyring
) {
601 ret
= install_process_keyring(context
);
608 key
= context
->signal
->process_keyring
;
609 atomic_inc(&key
->usage
);
610 key_ref
= make_key_ref(key
, 1);
613 case KEY_SPEC_SESSION_KEYRING
:
614 if (!context
->signal
->session_keyring
) {
615 /* always install a session keyring upon access if one
616 * doesn't exist yet */
617 ret
= install_session_keyring(
618 context
, context
->user
->session_keyring
);
624 key
= rcu_dereference(context
->signal
->session_keyring
);
625 atomic_inc(&key
->usage
);
627 key_ref
= make_key_ref(key
, 1);
630 case KEY_SPEC_USER_KEYRING
:
631 key
= context
->user
->uid_keyring
;
632 atomic_inc(&key
->usage
);
633 key_ref
= make_key_ref(key
, 1);
636 case KEY_SPEC_USER_SESSION_KEYRING
:
637 key
= context
->user
->session_keyring
;
638 atomic_inc(&key
->usage
);
639 key_ref
= make_key_ref(key
, 1);
642 case KEY_SPEC_GROUP_KEYRING
:
643 /* group keyrings are not yet supported */
644 key
= ERR_PTR(-EINVAL
);
647 case KEY_SPEC_REQKEY_AUTH_KEY
:
648 key
= context
->request_key_auth
;
652 atomic_inc(&key
->usage
);
653 key_ref
= make_key_ref(key
, 1);
657 key_ref
= ERR_PTR(-EINVAL
);
661 key
= key_lookup(id
);
663 key_ref
= ERR_CAST(key
);
667 key_ref
= make_key_ref(key
, 0);
669 /* check to see if we possess the key */
670 skey_ref
= search_process_keyrings(key
->type
, key
,
671 lookup_user_key_possessed
,
674 if (!IS_ERR(skey_ref
)) {
683 ret
= wait_for_key_construction(key
, true);
694 ret
= key_validate(key
);
700 if (!partial
&& !test_bit(KEY_FLAG_INSTANTIATED
, &key
->flags
))
703 /* check the permissions */
704 ret
= key_task_permission(key_ref
, context
, perm
);
712 key_ref_put(key_ref
);
713 key_ref
= ERR_PTR(ret
);
716 } /* end lookup_user_key() */
718 /*****************************************************************************/
720 * join the named keyring as the session keyring if possible, or attempt to
721 * create a new one of that name if not
722 * - if the name is NULL, an empty anonymous keyring is installed instead
723 * - named session keyring joining is done with a semaphore held
725 long join_session_keyring(const char *name
)
727 struct task_struct
*tsk
= current
;
731 /* if no name is provided, install an anonymous keyring */
733 ret
= install_session_keyring(tsk
, NULL
);
738 ret
= rcu_dereference(tsk
->signal
->session_keyring
)->serial
;
743 /* allow the user to join or create a named keyring */
744 mutex_lock(&key_session_mutex
);
746 /* look for an existing keyring of this name */
747 keyring
= find_keyring_by_name(name
, 0);
748 if (PTR_ERR(keyring
) == -ENOKEY
) {
749 /* not found - try and create a new one */
750 keyring
= keyring_alloc(name
, tsk
->uid
, tsk
->gid
, tsk
,
751 KEY_ALLOC_IN_QUOTA
, NULL
);
752 if (IS_ERR(keyring
)) {
753 ret
= PTR_ERR(keyring
);
757 else if (IS_ERR(keyring
)) {
758 ret
= PTR_ERR(keyring
);
762 /* we've got a keyring - now to install it */
763 ret
= install_session_keyring(tsk
, keyring
);
767 ret
= keyring
->serial
;
771 mutex_unlock(&key_session_mutex
);
775 } /* end join_session_keyring() */