Commit | Line | Data |
---|---|---|
2874c5fd | 1 | // SPDX-License-Identifier: GPL-2.0-or-later |
973c9f4f | 2 | /* procfs files for key database enumeration |
1da177e4 LT |
3 | * |
4 | * Copyright (C) 2004 Red Hat, Inc. All Rights Reserved. | |
5 | * Written by David Howells (dhowells@redhat.com) | |
1da177e4 LT |
6 | */ |
7 | ||
1da177e4 LT |
8 | #include <linux/init.h> |
9 | #include <linux/sched.h> | |
1da177e4 LT |
10 | #include <linux/fs.h> |
11 | #include <linux/proc_fs.h> | |
12 | #include <linux/seq_file.h> | |
13 | #include <asm/errno.h> | |
14 | #include "internal.h" | |
15 | ||
1da177e4 LT |
16 | static void *proc_keys_start(struct seq_file *p, loff_t *_pos); |
17 | static void *proc_keys_next(struct seq_file *p, void *v, loff_t *_pos); | |
18 | static void proc_keys_stop(struct seq_file *p, void *v); | |
19 | static int proc_keys_show(struct seq_file *m, void *v); | |
20 | ||
1996a109 | 21 | static const struct seq_operations proc_keys_ops = { |
1da177e4 LT |
22 | .start = proc_keys_start, |
23 | .next = proc_keys_next, | |
24 | .stop = proc_keys_stop, | |
25 | .show = proc_keys_show, | |
26 | }; | |
27 | ||
1da177e4 LT |
28 | static void *proc_key_users_start(struct seq_file *p, loff_t *_pos); |
29 | static void *proc_key_users_next(struct seq_file *p, void *v, loff_t *_pos); | |
30 | static void proc_key_users_stop(struct seq_file *p, void *v); | |
31 | static int proc_key_users_show(struct seq_file *m, void *v); | |
32 | ||
1996a109 | 33 | static const struct seq_operations proc_key_users_ops = { |
1da177e4 LT |
34 | .start = proc_key_users_start, |
35 | .next = proc_key_users_next, | |
36 | .stop = proc_key_users_stop, | |
37 | .show = proc_key_users_show, | |
38 | }; | |
39 | ||
1da177e4 | 40 | /* |
973c9f4f | 41 | * Declare the /proc files. |
1da177e4 LT |
42 | */ |
43 | static int __init key_proc_init(void) | |
44 | { | |
45 | struct proc_dir_entry *p; | |
46 | ||
fddda2b7 | 47 | p = proc_create_seq("keys", 0, NULL, &proc_keys_ops); |
1da177e4 LT |
48 | if (!p) |
49 | panic("Cannot create /proc/keys\n"); | |
1da177e4 | 50 | |
fddda2b7 | 51 | p = proc_create_seq("key-users", 0, NULL, &proc_key_users_ops); |
1da177e4 LT |
52 | if (!p) |
53 | panic("Cannot create /proc/key-users\n"); | |
54 | ||
1da177e4 | 55 | return 0; |
a8b17ed0 | 56 | } |
1da177e4 LT |
57 | |
58 | __initcall(key_proc_init); | |
59 | ||
1da177e4 | 60 | /* |
973c9f4f DH |
61 | * Implement "/proc/keys" to provide a list of the keys on the system that |
62 | * grant View permission to the caller. | |
1da177e4 | 63 | */ |
9a56c2db | 64 | static struct rb_node *key_serial_next(struct seq_file *p, struct rb_node *n) |
454804ab | 65 | { |
9a56c2db | 66 | struct user_namespace *user_ns = seq_user_ns(p); |
ad73a717 SH |
67 | |
68 | n = rb_next(n); | |
454804ab SH |
69 | while (n) { |
70 | struct key *key = rb_entry(n, struct key, serial_node); | |
9a56c2db | 71 | if (kuid_has_mapping(user_ns, key->user->uid)) |
454804ab SH |
72 | break; |
73 | n = rb_next(n); | |
74 | } | |
75 | return n; | |
76 | } | |
77 | ||
9a56c2db | 78 | static struct key *find_ge_key(struct seq_file *p, key_serial_t id) |
454804ab | 79 | { |
9a56c2db | 80 | struct user_namespace *user_ns = seq_user_ns(p); |
ad73a717 SH |
81 | struct rb_node *n = key_serial_tree.rb_node; |
82 | struct key *minkey = NULL; | |
454804ab | 83 | |
ad73a717 SH |
84 | while (n) { |
85 | struct key *key = rb_entry(n, struct key, serial_node); | |
86 | if (id < key->serial) { | |
87 | if (!minkey || minkey->serial > key->serial) | |
88 | minkey = key; | |
89 | n = n->rb_left; | |
90 | } else if (id > key->serial) { | |
91 | n = n->rb_right; | |
92 | } else { | |
93 | minkey = key; | |
94 | break; | |
95 | } | |
96 | key = NULL; | |
97 | } | |
1da177e4 | 98 | |
ad73a717 SH |
99 | if (!minkey) |
100 | return NULL; | |
101 | ||
102 | for (;;) { | |
9a56c2db | 103 | if (kuid_has_mapping(user_ns, minkey->user->uid)) |
ad73a717 SH |
104 | return minkey; |
105 | n = rb_next(&minkey->serial_node); | |
106 | if (!n) | |
107 | return NULL; | |
108 | minkey = rb_entry(n, struct key, serial_node); | |
109 | } | |
1da177e4 LT |
110 | } |
111 | ||
112 | static void *proc_keys_start(struct seq_file *p, loff_t *_pos) | |
86abcf9c | 113 | __acquires(key_serial_lock) |
1da177e4 | 114 | { |
ad73a717 SH |
115 | key_serial_t pos = *_pos; |
116 | struct key *key; | |
1da177e4 LT |
117 | |
118 | spin_lock(&key_serial_lock); | |
119 | ||
ad73a717 SH |
120 | if (*_pos > INT_MAX) |
121 | return NULL; | |
9a56c2db | 122 | key = find_ge_key(p, pos); |
ad73a717 SH |
123 | if (!key) |
124 | return NULL; | |
125 | *_pos = key->serial; | |
126 | return &key->serial_node; | |
127 | } | |
1da177e4 | 128 | |
ad73a717 SH |
129 | static inline key_serial_t key_node_serial(struct rb_node *n) |
130 | { | |
131 | struct key *key = rb_entry(n, struct key, serial_node); | |
132 | return key->serial; | |
1da177e4 LT |
133 | } |
134 | ||
135 | static void *proc_keys_next(struct seq_file *p, void *v, loff_t *_pos) | |
136 | { | |
ad73a717 | 137 | struct rb_node *n; |
1da177e4 | 138 | |
9a56c2db | 139 | n = key_serial_next(p, v); |
ad73a717 SH |
140 | if (n) |
141 | *_pos = key_node_serial(n); | |
142 | return n; | |
1da177e4 LT |
143 | } |
144 | ||
145 | static void proc_keys_stop(struct seq_file *p, void *v) | |
86abcf9c | 146 | __releases(key_serial_lock) |
1da177e4 LT |
147 | { |
148 | spin_unlock(&key_serial_lock); | |
149 | } | |
150 | ||
151 | static int proc_keys_show(struct seq_file *m, void *v) | |
152 | { | |
153 | struct rb_node *_p = v; | |
154 | struct key *key = rb_entry(_p, struct key, serial_node); | |
ab5c69f0 | 155 | unsigned long flags; |
927942aa | 156 | key_ref_t key_ref, skey_ref; |
074d5898 | 157 | time64_t now, expiry; |
03dab869 | 158 | char xbuf[16]; |
363b02da | 159 | short state; |
074d5898 | 160 | u64 timo; |
06ec7be5 ML |
161 | int rc; |
162 | ||
4bdf0bc3 | 163 | struct keyring_search_context ctx = { |
ede0fa98 | 164 | .index_key = key->index_key, |
4aa68e07 | 165 | .cred = m->file->f_cred, |
46291959 DH |
166 | .match_data.cmp = lookup_user_key_possessed, |
167 | .match_data.raw_data = key, | |
168 | .match_data.lookup_type = KEYRING_SEARCH_LOOKUP_DIRECT, | |
dcf49dbc DH |
169 | .flags = (KEYRING_SEARCH_NO_STATE_CHECK | |
170 | KEYRING_SEARCH_RECURSE), | |
4bdf0bc3 DH |
171 | }; |
172 | ||
028db3e2 | 173 | key_ref = make_key_ref(key, 0); |
927942aa DH |
174 | |
175 | /* determine if the key is possessed by this process (a test we can | |
176 | * skip if the key does not indicate the possessor can view it | |
177 | */ | |
028db3e2 LT |
178 | if (key->perm & KEY_POS_VIEW) { |
179 | rcu_read_lock(); | |
e59428f7 | 180 | skey_ref = search_cred_keyrings_rcu(&ctx); |
028db3e2 | 181 | rcu_read_unlock(); |
927942aa DH |
182 | if (!IS_ERR(skey_ref)) { |
183 | key_ref_put(skey_ref); | |
184 | key_ref = make_key_ref(key, 1); | |
185 | } | |
186 | } | |
187 | ||
4aa68e07 | 188 | /* check whether the current task is allowed to view the key */ |
f5895943 | 189 | rc = key_task_permission(key_ref, ctx.cred, KEY_NEED_VIEW); |
06ec7be5 | 190 | if (rc < 0) |
028db3e2 | 191 | return 0; |
1da177e4 | 192 | |
074d5898 | 193 | now = ktime_get_real_seconds(); |
1da177e4 | 194 | |
028db3e2 LT |
195 | rcu_read_lock(); |
196 | ||
1da177e4 | 197 | /* come up with a suitable timeout value */ |
ab5c69f0 EB |
198 | expiry = READ_ONCE(key->expiry); |
199 | if (expiry == 0) { | |
1da177e4 | 200 | memcpy(xbuf, "perm", 5); |
074d5898 | 201 | } else if (now >= expiry) { |
1da177e4 | 202 | memcpy(xbuf, "expd", 5); |
7b1b9164 | 203 | } else { |
074d5898 | 204 | timo = expiry - now; |
1da177e4 LT |
205 | |
206 | if (timo < 60) | |
074d5898 | 207 | sprintf(xbuf, "%llus", timo); |
1da177e4 | 208 | else if (timo < 60*60) |
074d5898 | 209 | sprintf(xbuf, "%llum", div_u64(timo, 60)); |
1da177e4 | 210 | else if (timo < 60*60*24) |
074d5898 | 211 | sprintf(xbuf, "%lluh", div_u64(timo, 60 * 60)); |
1da177e4 | 212 | else if (timo < 60*60*24*7) |
074d5898 | 213 | sprintf(xbuf, "%llud", div_u64(timo, 60 * 60 * 24)); |
1da177e4 | 214 | else |
074d5898 | 215 | sprintf(xbuf, "%lluw", div_u64(timo, 60 * 60 * 24 * 7)); |
1da177e4 LT |
216 | } |
217 | ||
363b02da DH |
218 | state = key_read_state(key); |
219 | ||
ab5c69f0 EB |
220 | #define showflag(FLAGS, LETTER, FLAG) \ |
221 | ((FLAGS & (1 << FLAG)) ? LETTER : '-') | |
76d8aeab | 222 | |
ab5c69f0 | 223 | flags = READ_ONCE(key->flags); |
fd75815f | 224 | seq_printf(m, "%08x %c%c%c%c%c%c%c %5d %4s %08x %5d %5d %-9.9s ", |
1da177e4 | 225 | key->serial, |
363b02da | 226 | state != KEY_IS_UNINSTANTIATED ? 'I' : '-', |
ab5c69f0 EB |
227 | showflag(flags, 'R', KEY_FLAG_REVOKED), |
228 | showflag(flags, 'D', KEY_FLAG_DEAD), | |
229 | showflag(flags, 'Q', KEY_FLAG_IN_QUOTA), | |
230 | showflag(flags, 'U', KEY_FLAG_USER_CONSTRUCT), | |
363b02da | 231 | state < 0 ? 'N' : '-', |
ab5c69f0 | 232 | showflag(flags, 'i', KEY_FLAG_INVALIDATED), |
fff29291 | 233 | refcount_read(&key->usage), |
1da177e4 | 234 | xbuf, |
028db3e2 | 235 | key->perm, |
9a56c2db EB |
236 | from_kuid_munged(seq_user_ns(m), key->uid), |
237 | from_kgid_munged(seq_user_ns(m), key->gid), | |
1da177e4 LT |
238 | key->type->name); |
239 | ||
76d8aeab DH |
240 | #undef showflag |
241 | ||
1da177e4 LT |
242 | if (key->type->describe) |
243 | key->type->describe(key, m); | |
244 | seq_putc(m, '\n'); | |
245 | ||
028db3e2 | 246 | rcu_read_unlock(); |
1da177e4 | 247 | return 0; |
1da177e4 LT |
248 | } |
249 | ||
9a56c2db | 250 | static struct rb_node *__key_user_next(struct user_namespace *user_ns, struct rb_node *n) |
454804ab SH |
251 | { |
252 | while (n) { | |
253 | struct key_user *user = rb_entry(n, struct key_user, node); | |
9a56c2db | 254 | if (kuid_has_mapping(user_ns, user->uid)) |
454804ab SH |
255 | break; |
256 | n = rb_next(n); | |
257 | } | |
258 | return n; | |
259 | } | |
260 | ||
9a56c2db | 261 | static struct rb_node *key_user_next(struct user_namespace *user_ns, struct rb_node *n) |
454804ab | 262 | { |
9a56c2db | 263 | return __key_user_next(user_ns, rb_next(n)); |
454804ab SH |
264 | } |
265 | ||
9a56c2db | 266 | static struct rb_node *key_user_first(struct user_namespace *user_ns, struct rb_root *r) |
454804ab SH |
267 | { |
268 | struct rb_node *n = rb_first(r); | |
9a56c2db | 269 | return __key_user_next(user_ns, n); |
454804ab | 270 | } |
7b1b9164 | 271 | |
1da177e4 | 272 | static void *proc_key_users_start(struct seq_file *p, loff_t *_pos) |
86abcf9c | 273 | __acquires(key_user_lock) |
1da177e4 LT |
274 | { |
275 | struct rb_node *_p; | |
276 | loff_t pos = *_pos; | |
277 | ||
278 | spin_lock(&key_user_lock); | |
279 | ||
9a56c2db | 280 | _p = key_user_first(seq_user_ns(p), &key_user_tree); |
1da177e4 LT |
281 | while (pos > 0 && _p) { |
282 | pos--; | |
9a56c2db | 283 | _p = key_user_next(seq_user_ns(p), _p); |
1da177e4 LT |
284 | } |
285 | ||
286 | return _p; | |
1da177e4 LT |
287 | } |
288 | ||
289 | static void *proc_key_users_next(struct seq_file *p, void *v, loff_t *_pos) | |
290 | { | |
291 | (*_pos)++; | |
9a56c2db | 292 | return key_user_next(seq_user_ns(p), (struct rb_node *)v); |
1da177e4 LT |
293 | } |
294 | ||
295 | static void proc_key_users_stop(struct seq_file *p, void *v) | |
86abcf9c | 296 | __releases(key_user_lock) |
1da177e4 LT |
297 | { |
298 | spin_unlock(&key_user_lock); | |
299 | } | |
300 | ||
301 | static int proc_key_users_show(struct seq_file *m, void *v) | |
302 | { | |
303 | struct rb_node *_p = v; | |
304 | struct key_user *user = rb_entry(_p, struct key_user, node); | |
9a56c2db | 305 | unsigned maxkeys = uid_eq(user->uid, GLOBAL_ROOT_UID) ? |
0b77f5bf | 306 | key_quota_root_maxkeys : key_quota_maxkeys; |
9a56c2db | 307 | unsigned maxbytes = uid_eq(user->uid, GLOBAL_ROOT_UID) ? |
0b77f5bf | 308 | key_quota_root_maxbytes : key_quota_maxbytes; |
1da177e4 LT |
309 | |
310 | seq_printf(m, "%5u: %5d %d/%d %d/%d %d/%d\n", | |
9a56c2db | 311 | from_kuid_munged(seq_user_ns(m), user->uid), |
ddb99e11 | 312 | refcount_read(&user->usage), |
1da177e4 LT |
313 | atomic_read(&user->nkeys), |
314 | atomic_read(&user->nikeys), | |
315 | user->qnkeys, | |
0b77f5bf | 316 | maxkeys, |
1da177e4 | 317 | user->qnbytes, |
0b77f5bf | 318 | maxbytes); |
1da177e4 LT |
319 | |
320 | return 0; | |
1da177e4 | 321 | } |