blob: b9f531c9e4fa753d326752b63dc2cf599579ffeb [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
Linus Torvalds1da177e2005-04-16 15:20:36 -070021static int proc_keys_open(struct inode *inode, struct file *file);
22static void *proc_keys_start(struct seq_file *p, loff_t *_pos);
23static void *proc_keys_next(struct seq_file *p, void *v, loff_t *_pos);
24static void proc_keys_stop(struct seq_file *p, void *v);
25static int proc_keys_show(struct seq_file *m, void *v);
26
Jan Engelhardt1996a102008-01-23 00:02:58 +010027static const struct seq_operations proc_keys_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070028 .start = proc_keys_start,
29 .next = proc_keys_next,
30 .stop = proc_keys_stop,
31 .show = proc_keys_show,
32};
33
Arjan van de Ven9c2e08c2007-02-12 00:55:37 -080034static const struct file_operations proc_keys_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070035 .open = proc_keys_open,
36 .read = seq_read,
37 .llseek = seq_lseek,
38 .release = seq_release,
39};
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
41static int proc_key_users_open(struct inode *inode, struct file *file);
42static void *proc_key_users_start(struct seq_file *p, loff_t *_pos);
43static void *proc_key_users_next(struct seq_file *p, void *v, loff_t *_pos);
44static void proc_key_users_stop(struct seq_file *p, void *v);
45static int proc_key_users_show(struct seq_file *m, void *v);
46
Jan Engelhardt1996a102008-01-23 00:02:58 +010047static const struct seq_operations proc_key_users_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 .start = proc_key_users_start,
49 .next = proc_key_users_next,
50 .stop = proc_key_users_stop,
51 .show = proc_key_users_show,
52};
53
Arjan van de Ven9c2e08c2007-02-12 00:55:37 -080054static const struct file_operations proc_key_users_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 .open = proc_key_users_open,
56 .read = seq_read,
57 .llseek = seq_lseek,
58 .release = seq_release,
59};
60
Linus Torvalds1da177e2005-04-16 15:20:36 -070061/*
David Howells973c9f42011-01-20 16:38:33 +000062 * Declare the /proc files.
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 */
64static int __init key_proc_init(void)
65{
66 struct proc_dir_entry *p;
67
Alexey Dobriyanda91d2e2008-04-29 01:01:27 -070068 p = proc_create("keys", 0, NULL, &proc_keys_fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -070069 if (!p)
70 panic("Cannot create /proc/keys\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
Alexey Dobriyanda91d2e2008-04-29 01:01:27 -070072 p = proc_create("key-users", 0, NULL, &proc_key_users_fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 if (!p)
74 panic("Cannot create /proc/key-users\n");
75
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 return 0;
David Howellsa8b17ed2011-01-20 16:38:27 +000077}
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
79__initcall(key_proc_init);
80
Linus Torvalds1da177e2005-04-16 15:20:36 -070081/*
David Howells973c9f42011-01-20 16:38:33 +000082 * Implement "/proc/keys" to provide a list of the keys on the system that
83 * grant View permission to the caller.
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 */
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -080085static struct rb_node *key_serial_next(struct seq_file *p, struct rb_node *n)
Serge E. Hallyn454804a2009-02-26 18:28:04 -060086{
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -080087 struct user_namespace *user_ns = seq_user_ns(p);
Serge E. Hallynad73a712009-09-02 09:14:05 +010088
89 n = rb_next(n);
Serge E. Hallyn454804a2009-02-26 18:28:04 -060090 while (n) {
91 struct key *key = rb_entry(n, struct key, serial_node);
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -080092 if (kuid_has_mapping(user_ns, key->user->uid))
Serge E. Hallyn454804a2009-02-26 18:28:04 -060093 break;
94 n = rb_next(n);
95 }
96 return n;
97}
98
Linus Torvalds1da177e2005-04-16 15:20:36 -070099static int proc_keys_open(struct inode *inode, struct file *file)
100{
101 return seq_open(file, &proc_keys_ops);
Serge E. Hallynad73a712009-09-02 09:14:05 +0100102}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800104static struct key *find_ge_key(struct seq_file *p, key_serial_t id)
Serge E. Hallynad73a712009-09-02 09:14:05 +0100105{
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800106 struct user_namespace *user_ns = seq_user_ns(p);
Serge E. Hallynad73a712009-09-02 09:14:05 +0100107 struct rb_node *n = key_serial_tree.rb_node;
108 struct key *minkey = NULL;
109
110 while (n) {
111 struct key *key = rb_entry(n, struct key, serial_node);
112 if (id < key->serial) {
113 if (!minkey || minkey->serial > key->serial)
114 minkey = key;
115 n = n->rb_left;
116 } else if (id > key->serial) {
117 n = n->rb_right;
118 } else {
119 minkey = key;
120 break;
121 }
122 key = NULL;
123 }
124
125 if (!minkey)
126 return NULL;
127
128 for (;;) {
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800129 if (kuid_has_mapping(user_ns, minkey->user->uid))
Serge E. Hallynad73a712009-09-02 09:14:05 +0100130 return minkey;
131 n = rb_next(&minkey->serial_node);
132 if (!n)
133 return NULL;
134 minkey = rb_entry(n, struct key, serial_node);
135 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136}
137
138static void *proc_keys_start(struct seq_file *p, loff_t *_pos)
James Morris86abcf92009-06-18 22:00:05 +1000139 __acquires(key_serial_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140{
Serge E. Hallynad73a712009-09-02 09:14:05 +0100141 key_serial_t pos = *_pos;
142 struct key *key;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
144 spin_lock(&key_serial_lock);
145
Serge E. Hallynad73a712009-09-02 09:14:05 +0100146 if (*_pos > INT_MAX)
147 return NULL;
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800148 key = find_ge_key(p, pos);
Serge E. Hallynad73a712009-09-02 09:14:05 +0100149 if (!key)
150 return NULL;
151 *_pos = key->serial;
152 return &key->serial_node;
153}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
Serge E. Hallynad73a712009-09-02 09:14:05 +0100155static inline key_serial_t key_node_serial(struct rb_node *n)
156{
157 struct key *key = rb_entry(n, struct key, serial_node);
158 return key->serial;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159}
160
161static void *proc_keys_next(struct seq_file *p, void *v, loff_t *_pos)
162{
Serge E. Hallynad73a712009-09-02 09:14:05 +0100163 struct rb_node *n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800165 n = key_serial_next(p, v);
Serge E. Hallynad73a712009-09-02 09:14:05 +0100166 if (n)
167 *_pos = key_node_serial(n);
168 return n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169}
170
171static void proc_keys_stop(struct seq_file *p, void *v)
James Morris86abcf92009-06-18 22:00:05 +1000172 __releases(key_serial_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173{
174 spin_unlock(&key_serial_lock);
175}
176
177static int proc_keys_show(struct seq_file *m, void *v)
178{
179 struct rb_node *_p = v;
180 struct key *key = rb_entry(_p, struct key, serial_node);
181 struct timespec now;
182 unsigned long timo;
David Howells927942a2010-06-11 17:31:10 +0100183 key_ref_t key_ref, skey_ref;
David Howells03dab862016-10-26 15:01:54 +0100184 char xbuf[16];
Michael LeMay06ec7be2006-06-26 00:24:56 -0700185 int rc;
186
David Howells4bdf0bc2013-09-24 10:35:15 +0100187 struct keyring_search_context ctx = {
188 .index_key.type = key->type,
189 .index_key.description = key->description,
190 .cred = current_cred(),
David Howells46291952014-09-16 17:36:02 +0100191 .match_data.cmp = lookup_user_key_possessed,
192 .match_data.raw_data = key,
193 .match_data.lookup_type = KEYRING_SEARCH_LOOKUP_DIRECT,
194 .flags = KEYRING_SEARCH_NO_STATE_CHECK,
David Howells4bdf0bc2013-09-24 10:35:15 +0100195 };
196
David Howells927942a2010-06-11 17:31:10 +0100197 key_ref = make_key_ref(key, 0);
198
199 /* determine if the key is possessed by this process (a test we can
200 * skip if the key does not indicate the possessor can view it
201 */
202 if (key->perm & KEY_POS_VIEW) {
David Howells4bdf0bc2013-09-24 10:35:15 +0100203 skey_ref = search_my_process_keyrings(&ctx);
David Howells927942a2010-06-11 17:31:10 +0100204 if (!IS_ERR(skey_ref)) {
205 key_ref_put(skey_ref);
206 key_ref = make_key_ref(key, 1);
207 }
208 }
209
Michael LeMay06ec7be2006-06-26 00:24:56 -0700210 /* check whether the current task is allowed to view the key (assuming
David Howellsd84f4f92008-11-14 10:39:23 +1100211 * non-possession)
212 * - the caller holds a spinlock, and thus the RCU read lock, making our
213 * access to __current_cred() safe
214 */
David Howellsf5895942014-03-14 17:44:49 +0000215 rc = key_task_permission(key_ref, ctx.cred, KEY_NEED_VIEW);
Michael LeMay06ec7be2006-06-26 00:24:56 -0700216 if (rc < 0)
217 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
219 now = current_kernel_time();
220
David Howells76d8aea2005-06-23 22:00:49 -0700221 rcu_read_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
223 /* come up with a suitable timeout value */
224 if (key->expiry == 0) {
225 memcpy(xbuf, "perm", 5);
David Howells7b1b9162009-09-02 09:14:11 +0100226 } else if (now.tv_sec >= key->expiry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 memcpy(xbuf, "expd", 5);
David Howells7b1b9162009-09-02 09:14:11 +0100228 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 timo = key->expiry - now.tv_sec;
230
231 if (timo < 60)
232 sprintf(xbuf, "%lus", timo);
233 else if (timo < 60*60)
234 sprintf(xbuf, "%lum", timo / 60);
235 else if (timo < 60*60*24)
236 sprintf(xbuf, "%luh", timo / (60*60));
237 else if (timo < 60*60*24*7)
238 sprintf(xbuf, "%lud", timo / (60*60*24));
239 else
240 sprintf(xbuf, "%luw", timo / (60*60*24*7));
241 }
242
David Howells76d8aea2005-06-23 22:00:49 -0700243#define showflag(KEY, LETTER, FLAG) \
244 (test_bit(FLAG, &(KEY)->flags) ? LETTER : '-')
245
David Howellsfd758152012-05-11 10:56:56 +0100246 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 -0700247 key->serial,
David Howells76d8aea2005-06-23 22:00:49 -0700248 showflag(key, 'I', KEY_FLAG_INSTANTIATED),
249 showflag(key, 'R', KEY_FLAG_REVOKED),
250 showflag(key, 'D', KEY_FLAG_DEAD),
251 showflag(key, 'Q', KEY_FLAG_IN_QUOTA),
252 showflag(key, 'U', KEY_FLAG_USER_CONSTRUCT),
253 showflag(key, 'N', KEY_FLAG_NEGATIVE),
David Howellsfd758152012-05-11 10:56:56 +0100254 showflag(key, 'i', KEY_FLAG_INVALIDATED),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 atomic_read(&key->usage),
256 xbuf,
257 key->perm,
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800258 from_kuid_munged(seq_user_ns(m), key->uid),
259 from_kgid_munged(seq_user_ns(m), key->gid),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 key->type->name);
261
David Howells76d8aea2005-06-23 22:00:49 -0700262#undef showflag
263
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 if (key->type->describe)
265 key->type->describe(key, m);
266 seq_putc(m, '\n');
267
David Howells76d8aea2005-06-23 22:00:49 -0700268 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270}
271
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800272static struct rb_node *__key_user_next(struct user_namespace *user_ns, struct rb_node *n)
Serge E. Hallyn454804a2009-02-26 18:28:04 -0600273{
274 while (n) {
275 struct key_user *user = rb_entry(n, struct key_user, node);
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800276 if (kuid_has_mapping(user_ns, user->uid))
Serge E. Hallyn454804a2009-02-26 18:28:04 -0600277 break;
278 n = rb_next(n);
279 }
280 return n;
281}
282
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800283static struct rb_node *key_user_next(struct user_namespace *user_ns, struct rb_node *n)
Serge E. Hallyn454804a2009-02-26 18:28:04 -0600284{
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800285 return __key_user_next(user_ns, rb_next(n));
Serge E. Hallyn454804a2009-02-26 18:28:04 -0600286}
287
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800288static struct rb_node *key_user_first(struct user_namespace *user_ns, struct rb_root *r)
Serge E. Hallyn454804a2009-02-26 18:28:04 -0600289{
290 struct rb_node *n = rb_first(r);
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800291 return __key_user_next(user_ns, n);
Serge E. Hallyn454804a2009-02-26 18:28:04 -0600292}
David Howells7b1b9162009-09-02 09:14:11 +0100293
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294/*
David Howells973c9f42011-01-20 16:38:33 +0000295 * Implement "/proc/key-users" to provides a list of the key users and their
296 * quotas.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 */
298static int proc_key_users_open(struct inode *inode, struct file *file)
299{
300 return seq_open(file, &proc_key_users_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301}
302
303static void *proc_key_users_start(struct seq_file *p, loff_t *_pos)
James Morris86abcf92009-06-18 22:00:05 +1000304 __acquires(key_user_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305{
306 struct rb_node *_p;
307 loff_t pos = *_pos;
308
309 spin_lock(&key_user_lock);
310
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800311 _p = key_user_first(seq_user_ns(p), &key_user_tree);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312 while (pos > 0 && _p) {
313 pos--;
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800314 _p = key_user_next(seq_user_ns(p), _p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 }
316
317 return _p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318}
319
320static void *proc_key_users_next(struct seq_file *p, void *v, loff_t *_pos)
321{
322 (*_pos)++;
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800323 return key_user_next(seq_user_ns(p), (struct rb_node *)v);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324}
325
326static void proc_key_users_stop(struct seq_file *p, void *v)
James Morris86abcf92009-06-18 22:00:05 +1000327 __releases(key_user_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328{
329 spin_unlock(&key_user_lock);
330}
331
332static int proc_key_users_show(struct seq_file *m, void *v)
333{
334 struct rb_node *_p = v;
335 struct key_user *user = rb_entry(_p, struct key_user, node);
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800336 unsigned maxkeys = uid_eq(user->uid, GLOBAL_ROOT_UID) ?
David Howells0b77f5b2008-04-29 01:01:32 -0700337 key_quota_root_maxkeys : key_quota_maxkeys;
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800338 unsigned maxbytes = uid_eq(user->uid, GLOBAL_ROOT_UID) ?
David Howells0b77f5b2008-04-29 01:01:32 -0700339 key_quota_root_maxbytes : key_quota_maxbytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340
341 seq_printf(m, "%5u: %5d %d/%d %d/%d %d/%d\n",
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -0800342 from_kuid_munged(seq_user_ns(m), user->uid),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 atomic_read(&user->usage),
344 atomic_read(&user->nkeys),
345 atomic_read(&user->nikeys),
346 user->qnkeys,
David Howells0b77f5b2008-04-29 01:01:32 -0700347 maxkeys,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 user->qnbytes,
David Howells0b77f5b2008-04-29 01:01:32 -0700349 maxbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350
351 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352}