user.c 5.59 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
/*
 * The "user cache".
 *
 * (C) Copyright 1991-2000 Linus Torvalds
 *
 * We have a per-user structure to keep track of how many
 * processes, files etc the user has claimed, in order to be
 * able to have per-user limits for system resources. 
 */

#include <linux/init.h>
#include <linux/sched.h>
#include <linux/slab.h>
#include <linux/bitops.h>
#include <linux/key.h>
16
#include <linux/sched/user.h>
17
#include <linux/interrupt.h>
18
#include <linux/export.h>
19
#include <linux/user_namespace.h>
20
#include <linux/proc_ns.h>
Linus Torvalds's avatar
Linus Torvalds committed
21

22 23 24 25
/*
 * userns count is 1 for root user, 1 for init_uts_ns,
 * and 1 for... ?
 */
26
struct user_namespace init_user_ns = {
27 28
	.uid_map = {
		.nr_extents = 1,
29 30 31 32 33 34
		{
			.extent[0] = {
				.first = 0,
				.lower_first = 0,
				.count = 4294967295U,
			},
35 36 37 38
		},
	},
	.gid_map = {
		.nr_extents = 1,
39 40 41 42 43 44
		{
			.extent[0] = {
				.first = 0,
				.lower_first = 0,
				.count = 4294967295U,
			},
45 46
		},
	},
47 48
	.projid_map = {
		.nr_extents = 1,
49 50 51 52 53 54
		{
			.extent[0] = {
				.first = 0,
				.lower_first = 0,
				.count = 4294967295U,
			},
55 56
		},
	},
57
	.count = ATOMIC_INIT(3),
58 59
	.owner = GLOBAL_ROOT_UID,
	.group = GLOBAL_ROOT_GID,
60
	.ns.inum = PROC_USER_INIT_INO,
61 62 63
#ifdef CONFIG_USER_NS
	.ns.ops = &userns_operations,
#endif
64
	.flags = USERNS_INIT_FLAGS,
65 66 67
#ifdef CONFIG_PERSISTENT_KEYRINGS
	.persistent_keyring_register_sem =
	__RWSEM_INITIALIZER(init_user_ns.persistent_keyring_register_sem),
68
#endif
69 70 71
};
EXPORT_SYMBOL_GPL(init_user_ns);

Linus Torvalds's avatar
Linus Torvalds committed
72 73 74 75 76
/*
 * UID task count cache, to get fast user lookup in "alloc_uid"
 * when changing user ID's (ie setuid() and friends).
 */

77 78
#define UIDHASH_BITS	(CONFIG_BASE_SMALL ? 3 : 7)
#define UIDHASH_SZ	(1 << UIDHASH_BITS)
Linus Torvalds's avatar
Linus Torvalds committed
79 80
#define UIDHASH_MASK		(UIDHASH_SZ - 1)
#define __uidhashfn(uid)	(((uid >> UIDHASH_BITS) + uid) & UIDHASH_MASK)
81
#define uidhashentry(uid)	(uidhash_table + __uidhashfn((__kuid_val(uid))))
Linus Torvalds's avatar
Linus Torvalds committed
82

83
static struct kmem_cache *uid_cachep;
84
struct hlist_head uidhash_table[UIDHASH_SZ];
85 86 87 88 89

/*
 * The uidhash_lock is mostly taken from process context, but it is
 * occasionally also taken from softirq/tasklet context, when
 * task-structs get RCU-freed. Hence all locking must be softirq-safe.
90 91 92 93
 * But free_uid() is also called with local interrupts disabled, and running
 * local_bh_enable() with local interrupts disabled is an error - we'll run
 * softirq callbacks, and they can unconditionally enable interrupts, and
 * the caller of free_uid() didn't expect that..
94
 */
Linus Torvalds's avatar
Linus Torvalds committed
95 96
static DEFINE_SPINLOCK(uidhash_lock);

97
/* root_user.__count is 1, for init task cred */
Linus Torvalds's avatar
Linus Torvalds committed
98
struct user_struct root_user = {
99
	.__count	= REFCOUNT_INIT(1),
Linus Torvalds's avatar
Linus Torvalds committed
100 101 102
	.processes	= ATOMIC_INIT(1),
	.sigpending	= ATOMIC_INIT(0),
	.locked_shm     = 0,
103
	.uid		= GLOBAL_ROOT_UID,
104
	.ratelimit	= RATELIMIT_STATE_INIT(root_user.ratelimit, 0, 0),
Linus Torvalds's avatar
Linus Torvalds committed
105 106
};

107 108 109
/*
 * These routines must be called with the uidhash spinlock held!
 */
Alexey Dobriyan's avatar
Alexey Dobriyan committed
110
static void uid_hash_insert(struct user_struct *up, struct hlist_head *hashent)
111 112 113 114
{
	hlist_add_head(&up->uidhash_node, hashent);
}

Alexey Dobriyan's avatar
Alexey Dobriyan committed
115
static void uid_hash_remove(struct user_struct *up)
116 117 118 119
{
	hlist_del_init(&up->uidhash_node);
}

120
static struct user_struct *uid_hash_find(kuid_t uid, struct hlist_head *hashent)
121 122 123
{
	struct user_struct *user;

124
	hlist_for_each_entry(user, hashent, uidhash_node) {
125
		if (uid_eq(user->uid, uid)) {
126
			refcount_inc(&user->__count);
127 128 129 130 131 132 133
			return user;
		}
	}

	return NULL;
}

134 135 136 137
/* IRQs are disabled and uidhash_lock is held upon function entry.
 * IRQ state (as stored in flags) is restored and uidhash_lock released
 * upon function exit.
 */
138
static void free_user(struct user_struct *up, unsigned long flags)
139
	__releases(&uidhash_lock)
140 141 142 143 144 145 146 147
{
	uid_hash_remove(up);
	spin_unlock_irqrestore(&uidhash_lock, flags);
	key_put(up->uid_keyring);
	key_put(up->session_keyring);
	kmem_cache_free(uid_cachep, up);
}

Linus Torvalds's avatar
Linus Torvalds committed
148 149 150 151 152 153
/*
 * Locate the user_struct for the passed UID.  If found, take a ref on it.  The
 * caller must undo that ref with free_uid().
 *
 * If the user_struct could not be found, return NULL.
 */
154
struct user_struct *find_user(kuid_t uid)
Linus Torvalds's avatar
Linus Torvalds committed
155 156
{
	struct user_struct *ret;
157
	unsigned long flags;
Linus Torvalds's avatar
Linus Torvalds committed
158

159
	spin_lock_irqsave(&uidhash_lock, flags);
160
	ret = uid_hash_find(uid, uidhashentry(uid));
161
	spin_unlock_irqrestore(&uidhash_lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
162 163 164 165 166
	return ret;
}

void free_uid(struct user_struct *up)
{
167 168
	unsigned long flags;

169 170 171
	if (!up)
		return;

172
	if (refcount_dec_and_lock_irqsave(&up->__count, &uidhash_lock, &flags))
173
		free_user(up, flags);
Linus Torvalds's avatar
Linus Torvalds committed
174 175
}

176
struct user_struct *alloc_uid(kuid_t uid)
Linus Torvalds's avatar
Linus Torvalds committed
177
{
178
	struct hlist_head *hashent = uidhashentry(uid);
179
	struct user_struct *up, *new;
Linus Torvalds's avatar
Linus Torvalds committed
180

181
	spin_lock_irq(&uidhash_lock);
Linus Torvalds's avatar
Linus Torvalds committed
182
	up = uid_hash_find(uid, hashent);
183
	spin_unlock_irq(&uidhash_lock);
Linus Torvalds's avatar
Linus Torvalds committed
184 185

	if (!up) {
Andrew Morton's avatar
Andrew Morton committed
186
		new = kmem_cache_zalloc(uid_cachep, GFP_KERNEL);
187 188
		if (!new)
			goto out_unlock;
189

Linus Torvalds's avatar
Linus Torvalds committed
190
		new->uid = uid;
191
		refcount_set(&new->__count, 1);
192 193
		ratelimit_state_init(&new->ratelimit, HZ, 100);
		ratelimit_set_flags(&new->ratelimit, RATELIMIT_MSG_ON_RELEASE);
Linus Torvalds's avatar
Linus Torvalds committed
194 195 196 197 198

		/*
		 * Before adding this, check whether we raced
		 * on adding the same user already..
		 */
199
		spin_lock_irq(&uidhash_lock);
Linus Torvalds's avatar
Linus Torvalds committed
200 201 202 203 204 205 206 207 208
		up = uid_hash_find(uid, hashent);
		if (up) {
			key_put(new->uid_keyring);
			key_put(new->session_keyring);
			kmem_cache_free(uid_cachep, new);
		} else {
			uid_hash_insert(new, hashent);
			up = new;
		}
209
		spin_unlock_irq(&uidhash_lock);
Linus Torvalds's avatar
Linus Torvalds committed
210
	}
211

Linus Torvalds's avatar
Linus Torvalds committed
212
	return up;
213 214 215

out_unlock:
	return NULL;
Linus Torvalds's avatar
Linus Torvalds committed
216 217 218 219 220 221 222
}

static int __init uid_cache_init(void)
{
	int n;

	uid_cachep = kmem_cache_create("uid_cache", sizeof(struct user_struct),
223
			0, SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
224 225

	for(n = 0; n < UIDHASH_SZ; ++n)
226
		INIT_HLIST_HEAD(uidhash_table + n);
Linus Torvalds's avatar
Linus Torvalds committed
227 228

	/* Insert the root user immediately (init already runs as root) */
229
	spin_lock_irq(&uidhash_lock);
230
	uid_hash_insert(&root_user, uidhashentry(GLOBAL_ROOT_UID));
231
	spin_unlock_irq(&uidhash_lock);
Linus Torvalds's avatar
Linus Torvalds committed
232 233 234

	return 0;
}
235
subsys_initcall(uid_cache_init);