keys: annotate seqfile ops with __releases and __acquires
[linux-3.10.git] / security / keys / proc.c
1 /* proc.c: proc files for key database enumeration
2  *
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>
15 #include <linux/slab.h>
16 #include <linux/fs.h>
17 #include <linux/proc_fs.h>
18 #include <linux/seq_file.h>
19 #include <asm/errno.h>
20 #include "internal.h"
21
22 #ifdef CONFIG_KEYS_DEBUG_PROC_KEYS
23 static int proc_keys_open(struct inode *inode, struct file *file);
24 static void *proc_keys_start(struct seq_file *p, loff_t *_pos);
25 static void *proc_keys_next(struct seq_file *p, void *v, loff_t *_pos);
26 static void proc_keys_stop(struct seq_file *p, void *v);
27 static int proc_keys_show(struct seq_file *m, void *v);
28
29 static const struct seq_operations proc_keys_ops = {
30         .start  = proc_keys_start,
31         .next   = proc_keys_next,
32         .stop   = proc_keys_stop,
33         .show   = proc_keys_show,
34 };
35
36 static const struct file_operations proc_keys_fops = {
37         .open           = proc_keys_open,
38         .read           = seq_read,
39         .llseek         = seq_lseek,
40         .release        = seq_release,
41 };
42 #endif
43
44 static int proc_key_users_open(struct inode *inode, struct file *file);
45 static void *proc_key_users_start(struct seq_file *p, loff_t *_pos);
46 static void *proc_key_users_next(struct seq_file *p, void *v, loff_t *_pos);
47 static void proc_key_users_stop(struct seq_file *p, void *v);
48 static int proc_key_users_show(struct seq_file *m, void *v);
49
50 static const struct seq_operations proc_key_users_ops = {
51         .start  = proc_key_users_start,
52         .next   = proc_key_users_next,
53         .stop   = proc_key_users_stop,
54         .show   = proc_key_users_show,
55 };
56
57 static const struct file_operations proc_key_users_fops = {
58         .open           = proc_key_users_open,
59         .read           = seq_read,
60         .llseek         = seq_lseek,
61         .release        = seq_release,
62 };
63
64 /*****************************************************************************/
65 /*
66  * declare the /proc files
67  */
68 static int __init key_proc_init(void)
69 {
70         struct proc_dir_entry *p;
71
72 #ifdef CONFIG_KEYS_DEBUG_PROC_KEYS
73         p = proc_create("keys", 0, NULL, &proc_keys_fops);
74         if (!p)
75                 panic("Cannot create /proc/keys\n");
76 #endif
77
78         p = proc_create("key-users", 0, NULL, &proc_key_users_fops);
79         if (!p)
80                 panic("Cannot create /proc/key-users\n");
81
82         return 0;
83
84 } /* end key_proc_init() */
85
86 __initcall(key_proc_init);
87
88 /*****************************************************************************/
89 /*
90  * implement "/proc/keys" to provides a list of the keys on the system
91  */
92 #ifdef CONFIG_KEYS_DEBUG_PROC_KEYS
93
94 static struct rb_node *__key_serial_next(struct rb_node *n)
95 {
96         while (n) {
97                 struct key *key = rb_entry(n, struct key, serial_node);
98                 if (key->user->user_ns == current_user_ns())
99                         break;
100                 n = rb_next(n);
101         }
102         return n;
103 }
104
105 static struct rb_node *key_serial_next(struct rb_node *n)
106 {
107         return __key_serial_next(rb_next(n));
108 }
109
110 static struct rb_node *key_serial_first(struct rb_root *r)
111 {
112         struct rb_node *n = rb_first(r);
113         return __key_serial_next(n);
114 }
115
116 static int proc_keys_open(struct inode *inode, struct file *file)
117 {
118         return seq_open(file, &proc_keys_ops);
119
120 }
121
122 static void *proc_keys_start(struct seq_file *p, loff_t *_pos)
123         __acquires(key_serial_lock)
124 {
125         struct rb_node *_p;
126         loff_t pos = *_pos;
127
128         spin_lock(&key_serial_lock);
129
130         _p = key_serial_first(&key_serial_tree);
131         while (pos > 0 && _p) {
132                 pos--;
133                 _p = key_serial_next(_p);
134         }
135
136         return _p;
137
138 }
139
140 static void *proc_keys_next(struct seq_file *p, void *v, loff_t *_pos)
141 {
142         (*_pos)++;
143         return key_serial_next((struct rb_node *) v);
144
145 }
146
147 static void proc_keys_stop(struct seq_file *p, void *v)
148         __releases(key_serial_lock)
149 {
150         spin_unlock(&key_serial_lock);
151 }
152
153 static int proc_keys_show(struct seq_file *m, void *v)
154 {
155         struct rb_node *_p = v;
156         struct key *key = rb_entry(_p, struct key, serial_node);
157         struct timespec now;
158         unsigned long timo;
159         char xbuf[12];
160         int rc;
161
162         /* check whether the current task is allowed to view the key (assuming
163          * non-possession)
164          * - the caller holds a spinlock, and thus the RCU read lock, making our
165          *   access to __current_cred() safe
166          */
167         rc = key_task_permission(make_key_ref(key, 0), current_cred(),
168                                  KEY_VIEW);
169         if (rc < 0)
170                 return 0;
171
172         now = current_kernel_time();
173
174         rcu_read_lock();
175
176         /* come up with a suitable timeout value */
177         if (key->expiry == 0) {
178                 memcpy(xbuf, "perm", 5);
179         }
180         else if (now.tv_sec >= key->expiry) {
181                 memcpy(xbuf, "expd", 5);
182         }
183         else {
184                 timo = key->expiry - now.tv_sec;
185
186                 if (timo < 60)
187                         sprintf(xbuf, "%lus", timo);
188                 else if (timo < 60*60)
189                         sprintf(xbuf, "%lum", timo / 60);
190                 else if (timo < 60*60*24)
191                         sprintf(xbuf, "%luh", timo / (60*60));
192                 else if (timo < 60*60*24*7)
193                         sprintf(xbuf, "%lud", timo / (60*60*24));
194                 else
195                         sprintf(xbuf, "%luw", timo / (60*60*24*7));
196         }
197
198 #define showflag(KEY, LETTER, FLAG) \
199         (test_bit(FLAG, &(KEY)->flags) ? LETTER : '-')
200
201         seq_printf(m, "%08x %c%c%c%c%c%c %5d %4s %08x %5d %5d %-9.9s ",
202                    key->serial,
203                    showflag(key, 'I', KEY_FLAG_INSTANTIATED),
204                    showflag(key, 'R', KEY_FLAG_REVOKED),
205                    showflag(key, 'D', KEY_FLAG_DEAD),
206                    showflag(key, 'Q', KEY_FLAG_IN_QUOTA),
207                    showflag(key, 'U', KEY_FLAG_USER_CONSTRUCT),
208                    showflag(key, 'N', KEY_FLAG_NEGATIVE),
209                    atomic_read(&key->usage),
210                    xbuf,
211                    key->perm,
212                    key->uid,
213                    key->gid,
214                    key->type->name);
215
216 #undef showflag
217
218         if (key->type->describe)
219                 key->type->describe(key, m);
220         seq_putc(m, '\n');
221
222         rcu_read_unlock();
223
224         return 0;
225
226 }
227
228 #endif /* CONFIG_KEYS_DEBUG_PROC_KEYS */
229
230 static struct rb_node *__key_user_next(struct rb_node *n)
231 {
232         while (n) {
233                 struct key_user *user = rb_entry(n, struct key_user, node);
234                 if (user->user_ns == current_user_ns())
235                         break;
236                 n = rb_next(n);
237         }
238         return n;
239 }
240
241 static struct rb_node *key_user_next(struct rb_node *n)
242 {
243         return __key_user_next(rb_next(n));
244 }
245
246 static struct rb_node *key_user_first(struct rb_root *r)
247 {
248         struct rb_node *n = rb_first(r);
249         return __key_user_next(n);
250 }
251 /*****************************************************************************/
252 /*
253  * implement "/proc/key-users" to provides a list of the key users
254  */
255 static int proc_key_users_open(struct inode *inode, struct file *file)
256 {
257         return seq_open(file, &proc_key_users_ops);
258
259 }
260
261 static void *proc_key_users_start(struct seq_file *p, loff_t *_pos)
262         __acquires(key_user_lock)
263 {
264         struct rb_node *_p;
265         loff_t pos = *_pos;
266
267         spin_lock(&key_user_lock);
268
269         _p = key_user_first(&key_user_tree);
270         while (pos > 0 && _p) {
271                 pos--;
272                 _p = key_user_next(_p);
273         }
274
275         return _p;
276
277 }
278
279 static void *proc_key_users_next(struct seq_file *p, void *v, loff_t *_pos)
280 {
281         (*_pos)++;
282         return key_user_next((struct rb_node *) v);
283
284 }
285
286 static void proc_key_users_stop(struct seq_file *p, void *v)
287         __releases(key_user_lock)
288 {
289         spin_unlock(&key_user_lock);
290 }
291
292 static int proc_key_users_show(struct seq_file *m, void *v)
293 {
294         struct rb_node *_p = v;
295         struct key_user *user = rb_entry(_p, struct key_user, node);
296         unsigned maxkeys = (user->uid == 0) ?
297                 key_quota_root_maxkeys : key_quota_maxkeys;
298         unsigned maxbytes = (user->uid == 0) ?
299                 key_quota_root_maxbytes : key_quota_maxbytes;
300
301         seq_printf(m, "%5u: %5d %d/%d %d/%d %d/%d\n",
302                    user->uid,
303                    atomic_read(&user->usage),
304                    atomic_read(&user->nkeys),
305                    atomic_read(&user->nikeys),
306                    user->qnkeys,
307                    maxkeys,
308                    user->qnbytes,
309                    maxbytes);
310
311         return 0;
312
313 }