blob: 69b4c3d48cdee20fc94be4d2869e2e330ba0a7b2 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * The "user cache".
3 *
4 * (C) Copyright 1991-2000 Linus Torvalds
5 *
6 * We have a per-user structure to keep track of how many
7 * processes, files etc the user has claimed, in order to be
8 * able to have per-user limits for system resources.
9 */
10
11#include <linux/init.h>
12#include <linux/sched.h>
13#include <linux/slab.h>
14#include <linux/bitops.h>
15#include <linux/key.h>
Ingo Molnar4021cb22006-01-25 15:23:07 +010016#include <linux/interrupt.h>
Paul Gortmaker9984de12011-05-23 14:51:41 -040017#include <linux/export.h>
Cedric Le Goateracce2922007-07-15 23:40:59 -070018#include <linux/user_namespace.h>
David Howells0bb80f22013-04-12 01:50:06 +010019#include <linux/proc_ns.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
Serge E. Hallyn59607db2011-03-23 16:43:16 -070021/*
22 * userns count is 1 for root user, 1 for init_uts_ns,
23 * and 1 for... ?
24 */
Pavel Emelyanovaee16ce2008-02-08 04:18:23 -080025struct user_namespace init_user_ns = {
Eric W. Biederman22d917d2011-11-17 00:11:58 -080026 .uid_map = {
27 .nr_extents = 1,
28 .extent[0] = {
29 .first = 0,
30 .lower_first = 0,
Eric W. Biederman4b06a812012-05-19 15:44:06 -060031 .count = 4294967295U,
Eric W. Biederman22d917d2011-11-17 00:11:58 -080032 },
33 },
34 .gid_map = {
35 .nr_extents = 1,
36 .extent[0] = {
37 .first = 0,
38 .lower_first = 0,
Eric W. Biederman4b06a812012-05-19 15:44:06 -060039 .count = 4294967295U,
Eric W. Biederman22d917d2011-11-17 00:11:58 -080040 },
41 },
Eric W. Biedermanf76d2072012-08-30 01:24:05 -070042 .projid_map = {
43 .nr_extents = 1,
44 .extent[0] = {
45 .first = 0,
46 .lower_first = 0,
47 .count = 4294967295U,
48 },
49 },
Eric W. Biedermanc61a2812012-12-28 18:58:39 -080050 .count = ATOMIC_INIT(3),
Eric W. Biederman783291e2011-11-17 01:32:59 -080051 .owner = GLOBAL_ROOT_UID,
52 .group = GLOBAL_ROOT_GID,
Eric W. Biederman98f842e2011-06-15 10:21:48 -070053 .proc_inum = PROC_USER_INIT_INO,
Eric W. Biederman87a8ebd2013-03-24 14:28:27 -070054 .may_mount_sysfs = true,
55 .may_mount_proc = true,
Pavel Emelyanovaee16ce2008-02-08 04:18:23 -080056};
57EXPORT_SYMBOL_GPL(init_user_ns);
58
Linus Torvalds1da177e2005-04-16 15:20:36 -070059/*
60 * UID task count cache, to get fast user lookup in "alloc_uid"
61 * when changing user ID's (ie setuid() and friends).
62 */
63
Eric W. Biederman7b44ab92011-11-16 23:20:58 -080064#define UIDHASH_BITS (CONFIG_BASE_SMALL ? 3 : 7)
65#define UIDHASH_SZ (1 << UIDHASH_BITS)
Linus Torvalds1da177e2005-04-16 15:20:36 -070066#define UIDHASH_MASK (UIDHASH_SZ - 1)
67#define __uidhashfn(uid) (((uid >> UIDHASH_BITS) + uid) & UIDHASH_MASK)
Eric W. Biederman7b44ab92011-11-16 23:20:58 -080068#define uidhashentry(uid) (uidhash_table + __uidhashfn((__kuid_val(uid))))
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
Christoph Lametere18b8902006-12-06 20:33:20 -080070static struct kmem_cache *uid_cachep;
Eric W. Biederman7b44ab92011-11-16 23:20:58 -080071struct hlist_head uidhash_table[UIDHASH_SZ];
Ingo Molnar4021cb22006-01-25 15:23:07 +010072
73/*
74 * The uidhash_lock is mostly taken from process context, but it is
75 * occasionally also taken from softirq/tasklet context, when
76 * task-structs get RCU-freed. Hence all locking must be softirq-safe.
Andrew Morton3fa97c92006-01-31 16:34:26 -080077 * But free_uid() is also called with local interrupts disabled, and running
78 * local_bh_enable() with local interrupts disabled is an error - we'll run
79 * softirq callbacks, and they can unconditionally enable interrupts, and
80 * the caller of free_uid() didn't expect that..
Ingo Molnar4021cb22006-01-25 15:23:07 +010081 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070082static DEFINE_SPINLOCK(uidhash_lock);
83
Eric W. Biederman783291e2011-11-17 01:32:59 -080084/* root_user.__count is 1, for init task cred */
Linus Torvalds1da177e2005-04-16 15:20:36 -070085struct user_struct root_user = {
Eric W. Biederman783291e2011-11-17 01:32:59 -080086 .__count = ATOMIC_INIT(1),
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 .processes = ATOMIC_INIT(1),
88 .files = ATOMIC_INIT(0),
89 .sigpending = ATOMIC_INIT(0),
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 .locked_shm = 0,
Eric W. Biederman7b44ab92011-11-16 23:20:58 -080091 .uid = GLOBAL_ROOT_UID,
Linus Torvalds1da177e2005-04-16 15:20:36 -070092};
93
Dhaval Giani5cb350b2007-10-15 17:00:14 +020094/*
95 * These routines must be called with the uidhash spinlock held!
96 */
Alexey Dobriyan40aeb402007-10-16 23:30:09 -070097static void uid_hash_insert(struct user_struct *up, struct hlist_head *hashent)
Dhaval Giani5cb350b2007-10-15 17:00:14 +020098{
99 hlist_add_head(&up->uidhash_node, hashent);
100}
101
Alexey Dobriyan40aeb402007-10-16 23:30:09 -0700102static void uid_hash_remove(struct user_struct *up)
Dhaval Giani5cb350b2007-10-15 17:00:14 +0200103{
104 hlist_del_init(&up->uidhash_node);
105}
106
Eric W. Biederman7b44ab92011-11-16 23:20:58 -0800107static struct user_struct *uid_hash_find(kuid_t uid, struct hlist_head *hashent)
Kay Sievers39592142009-03-24 15:43:30 +0100108{
109 struct user_struct *user;
Kay Sievers39592142009-03-24 15:43:30 +0100110
Sasha Levinb67bfe02013-02-27 17:06:00 -0800111 hlist_for_each_entry(user, hashent, uidhash_node) {
Eric W. Biederman7b44ab92011-11-16 23:20:58 -0800112 if (uid_eq(user->uid, uid)) {
Kay Sievers39592142009-03-24 15:43:30 +0100113 atomic_inc(&user->__count);
114 return user;
115 }
116 }
117
118 return NULL;
119}
120
Dhaval Giani5cb350b2007-10-15 17:00:14 +0200121/* IRQs are disabled and uidhash_lock is held upon function entry.
122 * IRQ state (as stored in flags) is restored and uidhash_lock released
123 * upon function exit.
124 */
Serge Hallyn18b6e042008-10-15 16:38:45 -0500125static void free_user(struct user_struct *up, unsigned long flags)
Namhyung Kim571428b2010-10-26 14:22:43 -0700126 __releases(&uidhash_lock)
Dhaval Giani5cb350b2007-10-15 17:00:14 +0200127{
128 uid_hash_remove(up);
129 spin_unlock_irqrestore(&uidhash_lock, flags);
Dhaval Giani5cb350b2007-10-15 17:00:14 +0200130 key_put(up->uid_keyring);
131 key_put(up->session_keyring);
132 kmem_cache_free(uid_cachep, up);
133}
Srivatsa Vaddagiri24e377a2007-10-15 17:00:09 +0200134
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 * Locate the user_struct for the passed UID. If found, take a ref on it. The
137 * caller must undo that ref with free_uid().
138 *
139 * If the user_struct could not be found, return NULL.
140 */
Eric W. Biederman7b44ab92011-11-16 23:20:58 -0800141struct user_struct *find_user(kuid_t uid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142{
143 struct user_struct *ret;
Andrew Morton3fa97c92006-01-31 16:34:26 -0800144 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
Andrew Morton3fa97c92006-01-31 16:34:26 -0800146 spin_lock_irqsave(&uidhash_lock, flags);
Eric W. Biederman7b44ab92011-11-16 23:20:58 -0800147 ret = uid_hash_find(uid, uidhashentry(uid));
Andrew Morton3fa97c92006-01-31 16:34:26 -0800148 spin_unlock_irqrestore(&uidhash_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 return ret;
150}
151
152void free_uid(struct user_struct *up)
153{
Andrew Morton3fa97c92006-01-31 16:34:26 -0800154 unsigned long flags;
155
Andrew Morton36f57412006-03-24 03:15:47 -0800156 if (!up)
157 return;
158
Andrew Morton3fa97c92006-01-31 16:34:26 -0800159 local_irq_save(flags);
Dhaval Giani5cb350b2007-10-15 17:00:14 +0200160 if (atomic_dec_and_lock(&up->__count, &uidhash_lock))
161 free_user(up, flags);
162 else
Andrew Morton36f57412006-03-24 03:15:47 -0800163 local_irq_restore(flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164}
165
Eric W. Biederman7b44ab92011-11-16 23:20:58 -0800166struct user_struct *alloc_uid(kuid_t uid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167{
Eric W. Biederman7b44ab92011-11-16 23:20:58 -0800168 struct hlist_head *hashent = uidhashentry(uid);
Pavel Emelyanov8eb703e2008-01-25 21:08:26 +0100169 struct user_struct *up, *new;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
Andrew Morton3fa97c92006-01-31 16:34:26 -0800171 spin_lock_irq(&uidhash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 up = uid_hash_find(uid, hashent);
Andrew Morton3fa97c92006-01-31 16:34:26 -0800173 spin_unlock_irq(&uidhash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
175 if (!up) {
Andrew Morton354a1f42008-04-30 00:54:54 -0700176 new = kmem_cache_zalloc(uid_cachep, GFP_KERNEL);
Pavel Emelyanov8eb703e2008-01-25 21:08:26 +0100177 if (!new)
178 goto out_unlock;
Pavel Emelyanov5e8869b2007-11-26 21:21:49 +0100179
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 new->uid = uid;
181 atomic_set(&new->__count, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
183 /*
184 * Before adding this, check whether we raced
185 * on adding the same user already..
186 */
Andrew Morton3fa97c92006-01-31 16:34:26 -0800187 spin_lock_irq(&uidhash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 up = uid_hash_find(uid, hashent);
189 if (up) {
190 key_put(new->uid_keyring);
191 key_put(new->session_keyring);
192 kmem_cache_free(uid_cachep, new);
193 } else {
194 uid_hash_insert(new, hashent);
195 up = new;
196 }
Andrew Morton3fa97c92006-01-31 16:34:26 -0800197 spin_unlock_irq(&uidhash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 }
Dhaval Giani5cb350b2007-10-15 17:00:14 +0200199
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 return up;
Pavel Emelyanov8eb703e2008-01-25 21:08:26 +0100201
Pavel Emelyanov8eb703e2008-01-25 21:08:26 +0100202out_unlock:
Pavel Emelyanov8eb703e2008-01-25 21:08:26 +0100203 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204}
205
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206static int __init uid_cache_init(void)
207{
208 int n;
209
210 uid_cachep = kmem_cache_create("uid_cache", sizeof(struct user_struct),
Paul Mundt20c2df82007-07-20 10:11:58 +0900211 0, SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
213 for(n = 0; n < UIDHASH_SZ; ++n)
Eric W. Biederman7b44ab92011-11-16 23:20:58 -0800214 INIT_HLIST_HEAD(uidhash_table + n);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
216 /* Insert the root user immediately (init already runs as root) */
Andrew Morton3fa97c92006-01-31 16:34:26 -0800217 spin_lock_irq(&uidhash_lock);
Eric W. Biederman7b44ab92011-11-16 23:20:58 -0800218 uid_hash_insert(&root_user, uidhashentry(GLOBAL_ROOT_UID));
Andrew Morton3fa97c92006-01-31 16:34:26 -0800219 spin_unlock_irq(&uidhash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
221 return 0;
222}
223
224module_init(uid_cache_init);