blob: 972eeb336b8145b0529001c38f64a53e2e8f8c5a [file] [log] [blame]
David Howells973c9f42011-01-20 16:38:33 +00001/* procfs files for key database enumeration
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 *
3 * Copyright (C) 2004 Red Hat, Inc. All Rights Reserved.
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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/fs.h>
16#include <linux/proc_fs.h>
17#include <linux/seq_file.h>
18#include <asm/errno.h>
19#include "internal.h"
20
21#ifdef CONFIG_KEYS_DEBUG_PROC_KEYS
22static int proc_keys_open(struct inode *inode, struct file *file);
23static void *proc_keys_start(struct seq_file *p, loff_t *_pos);
24static void *proc_keys_next(struct seq_file *p, void *v, loff_t *_pos);
25static void proc_keys_stop(struct seq_file *p, void *v);
26static int proc_keys_show(struct seq_file *m, void *v);
27
Jan Engelhardt1996a102008-01-23 00:02:58 +010028static const struct seq_operations proc_keys_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070029 .start = proc_keys_start,
30 .next = proc_keys_next,
31 .stop = proc_keys_stop,
32 .show = proc_keys_show,
33};
34
Arjan van de Ven9c2e08c2007-02-12 00:55:37 -080035static const struct file_operations proc_keys_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 .open = proc_keys_open,
37 .read = seq_read,
38 .llseek = seq_lseek,
39 .release = seq_release,
40};
41#endif
42
43static int proc_key_users_open(struct inode *inode, struct file *file);
44static void *proc_key_users_start(struct seq_file *p, loff_t *_pos);
45static void *proc_key_users_next(struct seq_file *p, void *v, loff_t *_pos);
46static void proc_key_users_stop(struct seq_file *p, void *v);
47static int proc_key_users_show(struct seq_file *m, void *v);
48
Jan Engelhardt1996a102008-01-23 00:02:58 +010049static const struct seq_operations proc_key_users_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 .start = proc_key_users_start,
51 .next = proc_key_users_next,
52 .stop = proc_key_users_stop,
53 .show = proc_key_users_show,
54};
55
Arjan van de Ven9c2e08c2007-02-12 00:55:37 -080056static const struct file_operations proc_key_users_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 .open = proc_key_users_open,
58 .read = seq_read,
59 .llseek = seq_lseek,
60 .release = seq_release,
61};
62
Linus Torvalds1da177e2005-04-16 15:20:36 -070063/*
David Howells973c9f42011-01-20 16:38:33 +000064 * Declare the /proc files.
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 */
66static int __init key_proc_init(void)
67{
68 struct proc_dir_entry *p;
69
70#ifdef CONFIG_KEYS_DEBUG_PROC_KEYS
Alexey Dobriyanda91d2e2008-04-29 01:01:27 -070071 p = proc_create("keys", 0, NULL, &proc_keys_fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 if (!p)
73 panic("Cannot create /proc/keys\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -070074#endif
75
Alexey Dobriyanda91d2e2008-04-29 01:01:27 -070076 p = proc_create("key-users", 0, NULL, &proc_key_users_fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 if (!p)
78 panic("Cannot create /proc/key-users\n");
79
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 return 0;
David Howellsa8b17ed2011-01-20 16:38:27 +000081}
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
83__initcall(key_proc_init);
84
Linus Torvalds1da177e2005-04-16 15:20:36 -070085/*
David Howells973c9f42011-01-20 16:38:33 +000086 * Implement "/proc/keys" to provide a list of the keys on the system that
87 * grant View permission to the caller.
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 */
89#ifdef CONFIG_KEYS_DEBUG_PROC_KEYS
90
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -080091static struct rb_node *key_serial_next(struct seq_file *p, struct rb_node *n)
Serge E. Hallyn454804a2009-02-26 18:28:04 -060092{
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -080093 struct user_namespace *user_ns = seq_user_ns(p);
Serge E. Hallynad73a712009-09-02 09:14:05 +010094
95 n = rb_next(n);
Serge E. Hallyn454804a2009-02-26 18:28:04 -060096 while (n) {
97 struct key *key = rb_entry(n, struct key, serial_node);
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -080098 if (kuid_has_mapping(user_ns, key->user->uid))
Serge E. Hallyn454804a2009-02-26 18:28:04 -060099 break;
100 n = rb_next(n);
101 }
102 return n;
103}
104
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105static int proc_keys_open(struct inode *inode, struct file *file)
106{
107 return seq_open(file, &proc_keys_ops);
Serge E. Hallynad73a712009-09-02 09:14:05 +0100108}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800110static struct key *find_ge_key(struct seq_file *p, key_serial_t id)
Serge E. Hallynad73a712009-09-02 09:14:05 +0100111{
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800112 struct user_namespace *user_ns = seq_user_ns(p);
Serge E. Hallynad73a712009-09-02 09:14:05 +0100113 struct rb_node *n = key_serial_tree.rb_node;
114 struct key *minkey = NULL;
115
116 while (n) {
117 struct key *key = rb_entry(n, struct key, serial_node);
118 if (id < key->serial) {
119 if (!minkey || minkey->serial > key->serial)
120 minkey = key;
121 n = n->rb_left;
122 } else if (id > key->serial) {
123 n = n->rb_right;
124 } else {
125 minkey = key;
126 break;
127 }
128 key = NULL;
129 }
130
131 if (!minkey)
132 return NULL;
133
134 for (;;) {
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800135 if (kuid_has_mapping(user_ns, minkey->user->uid))
Serge E. Hallynad73a712009-09-02 09:14:05 +0100136 return minkey;
137 n = rb_next(&minkey->serial_node);
138 if (!n)
139 return NULL;
140 minkey = rb_entry(n, struct key, serial_node);
141 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142}
143
144static void *proc_keys_start(struct seq_file *p, loff_t *_pos)
James Morris86abcf92009-06-18 22:00:05 +1000145 __acquires(key_serial_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146{
Serge E. Hallynad73a712009-09-02 09:14:05 +0100147 key_serial_t pos = *_pos;
148 struct key *key;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
150 spin_lock(&key_serial_lock);
151
Serge E. Hallynad73a712009-09-02 09:14:05 +0100152 if (*_pos > INT_MAX)
153 return NULL;
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800154 key = find_ge_key(p, pos);
Serge E. Hallynad73a712009-09-02 09:14:05 +0100155 if (!key)
156 return NULL;
157 *_pos = key->serial;
158 return &key->serial_node;
159}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
Serge E. Hallynad73a712009-09-02 09:14:05 +0100161static inline key_serial_t key_node_serial(struct rb_node *n)
162{
163 struct key *key = rb_entry(n, struct key, serial_node);
164 return key->serial;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165}
166
167static void *proc_keys_next(struct seq_file *p, void *v, loff_t *_pos)
168{
Serge E. Hallynad73a712009-09-02 09:14:05 +0100169 struct rb_node *n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800171 n = key_serial_next(p, v);
Serge E. Hallynad73a712009-09-02 09:14:05 +0100172 if (n)
173 *_pos = key_node_serial(n);
174 return n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175}
176
177static void proc_keys_stop(struct seq_file *p, void *v)
James Morris86abcf92009-06-18 22:00:05 +1000178 __releases(key_serial_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179{
180 spin_unlock(&key_serial_lock);
181}
182
183static int proc_keys_show(struct seq_file *m, void *v)
184{
185 struct rb_node *_p = v;
186 struct key *key = rb_entry(_p, struct key, serial_node);
187 struct timespec now;
188 unsigned long timo;
David Howells927942a2010-06-11 17:31:10 +0100189 key_ref_t key_ref, skey_ref;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 char xbuf[12];
Michael LeMay06ec7be2006-06-26 00:24:56 -0700191 int rc;
192
David Howells4bdf0bc2013-09-24 10:35:15 +0100193 struct keyring_search_context ctx = {
194 .index_key.type = key->type,
195 .index_key.description = key->description,
196 .cred = current_cred(),
David Howells46291952014-09-16 17:36:02 +0100197 .match_data.cmp = lookup_user_key_possessed,
198 .match_data.raw_data = key,
199 .match_data.lookup_type = KEYRING_SEARCH_LOOKUP_DIRECT,
200 .flags = KEYRING_SEARCH_NO_STATE_CHECK,
David Howells4bdf0bc2013-09-24 10:35:15 +0100201 };
202
David Howells927942a2010-06-11 17:31:10 +0100203 key_ref = make_key_ref(key, 0);
204
205 /* determine if the key is possessed by this process (a test we can
206 * skip if the key does not indicate the possessor can view it
207 */
208 if (key->perm & KEY_POS_VIEW) {
David Howells4bdf0bc2013-09-24 10:35:15 +0100209 skey_ref = search_my_process_keyrings(&ctx);
David Howells927942a2010-06-11 17:31:10 +0100210 if (!IS_ERR(skey_ref)) {
211 key_ref_put(skey_ref);
212 key_ref = make_key_ref(key, 1);
213 }
214 }
215
Michael LeMay06ec7be2006-06-26 00:24:56 -0700216 /* check whether the current task is allowed to view the key (assuming
David Howellsd84f4f92008-11-14 10:39:23 +1100217 * non-possession)
218 * - the caller holds a spinlock, and thus the RCU read lock, making our
219 * access to __current_cred() safe
220 */
David Howellsf5895942014-03-14 17:44:49 +0000221 rc = key_task_permission(key_ref, ctx.cred, KEY_NEED_VIEW);
Michael LeMay06ec7be2006-06-26 00:24:56 -0700222 if (rc < 0)
223 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
225 now = current_kernel_time();
226
David Howells76d8aea2005-06-23 22:00:49 -0700227 rcu_read_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
229 /* come up with a suitable timeout value */
230 if (key->expiry == 0) {
231 memcpy(xbuf, "perm", 5);
David Howells7b1b9162009-09-02 09:14:11 +0100232 } else if (now.tv_sec >= key->expiry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 memcpy(xbuf, "expd", 5);
David Howells7b1b9162009-09-02 09:14:11 +0100234 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 timo = key->expiry - now.tv_sec;
236
237 if (timo < 60)
238 sprintf(xbuf, "%lus", timo);
239 else if (timo < 60*60)
240 sprintf(xbuf, "%lum", timo / 60);
241 else if (timo < 60*60*24)
242 sprintf(xbuf, "%luh", timo / (60*60));
243 else if (timo < 60*60*24*7)
244 sprintf(xbuf, "%lud", timo / (60*60*24));
245 else
246 sprintf(xbuf, "%luw", timo / (60*60*24*7));
247 }
248
David Howells76d8aea2005-06-23 22:00:49 -0700249#define showflag(KEY, LETTER, FLAG) \
250 (test_bit(FLAG, &(KEY)->flags) ? LETTER : '-')
251
David Howellsfd758152012-05-11 10:56:56 +0100252 seq_printf(m, "%08x %c%c%c%c%c%c%c %5d %4s %08x %5d %5d %-9.9s ",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 key->serial,
David Howells76d8aea2005-06-23 22:00:49 -0700254 showflag(key, 'I', KEY_FLAG_INSTANTIATED),
255 showflag(key, 'R', KEY_FLAG_REVOKED),
256 showflag(key, 'D', KEY_FLAG_DEAD),
257 showflag(key, 'Q', KEY_FLAG_IN_QUOTA),
258 showflag(key, 'U', KEY_FLAG_USER_CONSTRUCT),
259 showflag(key, 'N', KEY_FLAG_NEGATIVE),
David Howellsfd758152012-05-11 10:56:56 +0100260 showflag(key, 'i', KEY_FLAG_INVALIDATED),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 atomic_read(&key->usage),
262 xbuf,
263 key->perm,
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800264 from_kuid_munged(seq_user_ns(m), key->uid),
265 from_kgid_munged(seq_user_ns(m), key->gid),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 key->type->name);
267
David Howells76d8aea2005-06-23 22:00:49 -0700268#undef showflag
269
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 if (key->type->describe)
271 key->type->describe(key, m);
272 seq_putc(m, '\n');
273
David Howells76d8aea2005-06-23 22:00:49 -0700274 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276}
277
278#endif /* CONFIG_KEYS_DEBUG_PROC_KEYS */
279
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800280static struct rb_node *__key_user_next(struct user_namespace *user_ns, struct rb_node *n)
Serge E. Hallyn454804a2009-02-26 18:28:04 -0600281{
282 while (n) {
283 struct key_user *user = rb_entry(n, struct key_user, node);
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800284 if (kuid_has_mapping(user_ns, user->uid))
Serge E. Hallyn454804a2009-02-26 18:28:04 -0600285 break;
286 n = rb_next(n);
287 }
288 return n;
289}
290
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800291static struct rb_node *key_user_next(struct user_namespace *user_ns, struct rb_node *n)
Serge E. Hallyn454804a2009-02-26 18:28:04 -0600292{
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800293 return __key_user_next(user_ns, rb_next(n));
Serge E. Hallyn454804a2009-02-26 18:28:04 -0600294}
295
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800296static struct rb_node *key_user_first(struct user_namespace *user_ns, struct rb_root *r)
Serge E. Hallyn454804a2009-02-26 18:28:04 -0600297{
298 struct rb_node *n = rb_first(r);
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800299 return __key_user_next(user_ns, n);
Serge E. Hallyn454804a2009-02-26 18:28:04 -0600300}
David Howells7b1b9162009-09-02 09:14:11 +0100301
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302/*
David Howells973c9f42011-01-20 16:38:33 +0000303 * Implement "/proc/key-users" to provides a list of the key users and their
304 * quotas.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 */
306static int proc_key_users_open(struct inode *inode, struct file *file)
307{
308 return seq_open(file, &proc_key_users_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309}
310
311static void *proc_key_users_start(struct seq_file *p, loff_t *_pos)
James Morris86abcf92009-06-18 22:00:05 +1000312 __acquires(key_user_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313{
314 struct rb_node *_p;
315 loff_t pos = *_pos;
316
317 spin_lock(&key_user_lock);
318
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800319 _p = key_user_first(seq_user_ns(p), &key_user_tree);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 while (pos > 0 && _p) {
321 pos--;
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800322 _p = key_user_next(seq_user_ns(p), _p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 }
324
325 return _p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326}
327
328static void *proc_key_users_next(struct seq_file *p, void *v, loff_t *_pos)
329{
330 (*_pos)++;
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800331 return key_user_next(seq_user_ns(p), (struct rb_node *)v);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332}
333
334static void proc_key_users_stop(struct seq_file *p, void *v)
James Morris86abcf92009-06-18 22:00:05 +1000335 __releases(key_user_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336{
337 spin_unlock(&key_user_lock);
338}
339
340static int proc_key_users_show(struct seq_file *m, void *v)
341{
342 struct rb_node *_p = v;
343 struct key_user *user = rb_entry(_p, struct key_user, node);
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800344 unsigned maxkeys = uid_eq(user->uid, GLOBAL_ROOT_UID) ?
David Howells0b77f5b2008-04-29 01:01:32 -0700345 key_quota_root_maxkeys : key_quota_maxkeys;
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800346 unsigned maxbytes = uid_eq(user->uid, GLOBAL_ROOT_UID) ?
David Howells0b77f5b2008-04-29 01:01:32 -0700347 key_quota_root_maxbytes : key_quota_maxbytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
349 seq_printf(m, "%5u: %5d %d/%d %d/%d %d/%d\n",
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800350 from_kuid_munged(seq_user_ns(m), user->uid),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 atomic_read(&user->usage),
352 atomic_read(&user->nkeys),
353 atomic_read(&user->nikeys),
354 user->qnkeys,
David Howells0b77f5b2008-04-29 01:01:32 -0700355 maxkeys,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 user->qnbytes,
David Howells0b77f5b2008-04-29 01:01:32 -0700357 maxbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
359 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360}