1 /* procfs files for key database enumeration
3 * Copyright (C) 2004 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/init.h>
13 #include <linux/sched.h>
15 #include <linux/proc_fs.h>
16 #include <linux/seq_file.h>
17 #include <asm/errno.h>
20 static void *proc_keys_start(struct seq_file *p, loff_t *_pos);
21 static void *proc_keys_next(struct seq_file *p, void *v, loff_t *_pos);
22 static void proc_keys_stop(struct seq_file *p, void *v);
23 static int proc_keys_show(struct seq_file *m, void *v);
25 static const struct seq_operations proc_keys_ops = {
26 .start = proc_keys_start,
27 .next = proc_keys_next,
28 .stop = proc_keys_stop,
29 .show = proc_keys_show,
32 static void *proc_key_users_start(struct seq_file *p, loff_t *_pos);
33 static void *proc_key_users_next(struct seq_file *p, void *v, loff_t *_pos);
34 static void proc_key_users_stop(struct seq_file *p, void *v);
35 static int proc_key_users_show(struct seq_file *m, void *v);
37 static const struct seq_operations proc_key_users_ops = {
38 .start = proc_key_users_start,
39 .next = proc_key_users_next,
40 .stop = proc_key_users_stop,
41 .show = proc_key_users_show,
45 * Declare the /proc files.
47 static int __init key_proc_init(void)
49 struct proc_dir_entry *p;
51 p = proc_create_seq("keys", 0, NULL, &proc_keys_ops);
53 panic("Cannot create /proc/keys\n");
55 p = proc_create_seq("key-users", 0, NULL, &proc_key_users_ops);
57 panic("Cannot create /proc/key-users\n");
62 __initcall(key_proc_init);
65 * Implement "/proc/keys" to provide a list of the keys on the system that
66 * grant View permission to the caller.
68 static struct rb_node *key_serial_next(struct seq_file *p, struct rb_node *n)
70 struct user_namespace *user_ns = seq_user_ns(p);
74 struct key *key = rb_entry(n, struct key, serial_node);
75 if (kuid_has_mapping(user_ns, key->user->uid))
82 static struct key *find_ge_key(struct seq_file *p, key_serial_t id)
84 struct user_namespace *user_ns = seq_user_ns(p);
85 struct rb_node *n = key_serial_tree.rb_node;
86 struct key *minkey = NULL;
89 struct key *key = rb_entry(n, struct key, serial_node);
90 if (id < key->serial) {
91 if (!minkey || minkey->serial > key->serial)
94 } else if (id > key->serial) {
107 if (kuid_has_mapping(user_ns, minkey->user->uid))
109 n = rb_next(&minkey->serial_node);
112 minkey = rb_entry(n, struct key, serial_node);
116 static void *proc_keys_start(struct seq_file *p, loff_t *_pos)
117 __acquires(key_serial_lock)
119 key_serial_t pos = *_pos;
122 spin_lock(&key_serial_lock);
126 key = find_ge_key(p, pos);
130 return &key->serial_node;
133 static inline key_serial_t key_node_serial(struct rb_node *n)
135 struct key *key = rb_entry(n, struct key, serial_node);
139 static void *proc_keys_next(struct seq_file *p, void *v, loff_t *_pos)
143 n = key_serial_next(p, v);
145 *_pos = key_node_serial(n);
149 static void proc_keys_stop(struct seq_file *p, void *v)
150 __releases(key_serial_lock)
152 spin_unlock(&key_serial_lock);
155 static int proc_keys_show(struct seq_file *m, void *v)
157 struct rb_node *_p = v;
158 struct key *key = rb_entry(_p, struct key, serial_node);
160 key_ref_t key_ref, skey_ref;
161 time64_t now, expiry;
167 struct keyring_search_context ctx = {
168 .index_key = key->index_key,
169 .cred = m->file->f_cred,
170 .match_data.cmp = lookup_user_key_possessed,
171 .match_data.raw_data = key,
172 .match_data.lookup_type = KEYRING_SEARCH_LOOKUP_DIRECT,
173 .flags = KEYRING_SEARCH_NO_STATE_CHECK,
176 key_ref = make_key_ref(key, 0);
178 /* determine if the key is possessed by this process (a test we can
179 * skip if the key does not indicate the possessor can view it
181 if (key->perm & KEY_POS_VIEW) {
182 skey_ref = search_my_process_keyrings(&ctx);
183 if (!IS_ERR(skey_ref)) {
184 key_ref_put(skey_ref);
185 key_ref = make_key_ref(key, 1);
189 /* check whether the current task is allowed to view the key */
190 rc = key_task_permission(key_ref, ctx.cred, KEY_NEED_VIEW);
194 now = ktime_get_real_seconds();
198 /* come up with a suitable timeout value */
199 expiry = READ_ONCE(key->expiry);
201 memcpy(xbuf, "perm", 5);
202 } else if (now >= expiry) {
203 memcpy(xbuf, "expd", 5);
208 sprintf(xbuf, "%llus", timo);
209 else if (timo < 60*60)
210 sprintf(xbuf, "%llum", div_u64(timo, 60));
211 else if (timo < 60*60*24)
212 sprintf(xbuf, "%lluh", div_u64(timo, 60 * 60));
213 else if (timo < 60*60*24*7)
214 sprintf(xbuf, "%llud", div_u64(timo, 60 * 60 * 24));
216 sprintf(xbuf, "%lluw", div_u64(timo, 60 * 60 * 24 * 7));
219 state = key_read_state(key);
221 #define showflag(FLAGS, LETTER, FLAG) \
222 ((FLAGS & (1 << FLAG)) ? LETTER : '-')
224 flags = READ_ONCE(key->flags);
225 seq_printf(m, "%08x %c%c%c%c%c%c%c %5d %4s %08x %5d %5d %-9.9s ",
227 state != KEY_IS_UNINSTANTIATED ? 'I' : '-',
228 showflag(flags, 'R', KEY_FLAG_REVOKED),
229 showflag(flags, 'D', KEY_FLAG_DEAD),
230 showflag(flags, 'Q', KEY_FLAG_IN_QUOTA),
231 showflag(flags, 'U', KEY_FLAG_USER_CONSTRUCT),
232 state < 0 ? 'N' : '-',
233 showflag(flags, 'i', KEY_FLAG_INVALIDATED),
234 refcount_read(&key->usage),
237 from_kuid_munged(seq_user_ns(m), key->uid),
238 from_kgid_munged(seq_user_ns(m), key->gid),
243 if (key->type->describe)
244 key->type->describe(key, m);
251 static struct rb_node *__key_user_next(struct user_namespace *user_ns, struct rb_node *n)
254 struct key_user *user = rb_entry(n, struct key_user, node);
255 if (kuid_has_mapping(user_ns, user->uid))
262 static struct rb_node *key_user_next(struct user_namespace *user_ns, struct rb_node *n)
264 return __key_user_next(user_ns, rb_next(n));
267 static struct rb_node *key_user_first(struct user_namespace *user_ns, struct rb_root *r)
269 struct rb_node *n = rb_first(r);
270 return __key_user_next(user_ns, n);
273 static void *proc_key_users_start(struct seq_file *p, loff_t *_pos)
274 __acquires(key_user_lock)
279 spin_lock(&key_user_lock);
281 _p = key_user_first(seq_user_ns(p), &key_user_tree);
282 while (pos > 0 && _p) {
284 _p = key_user_next(seq_user_ns(p), _p);
290 static void *proc_key_users_next(struct seq_file *p, void *v, loff_t *_pos)
293 return key_user_next(seq_user_ns(p), (struct rb_node *)v);
296 static void proc_key_users_stop(struct seq_file *p, void *v)
297 __releases(key_user_lock)
299 spin_unlock(&key_user_lock);
302 static int proc_key_users_show(struct seq_file *m, void *v)
304 struct rb_node *_p = v;
305 struct key_user *user = rb_entry(_p, struct key_user, node);
306 unsigned maxkeys = uid_eq(user->uid, GLOBAL_ROOT_UID) ?
307 key_quota_root_maxkeys : key_quota_maxkeys;
308 unsigned maxbytes = uid_eq(user->uid, GLOBAL_ROOT_UID) ?
309 key_quota_root_maxbytes : key_quota_maxbytes;
311 seq_printf(m, "%5u: %5d %d/%d %d/%d %d/%d\n",
312 from_kuid_munged(seq_user_ns(m), user->uid),
313 refcount_read(&user->usage),
314 atomic_read(&user->nkeys),
315 atomic_read(&user->nikeys),