KEYS: Make request_key() and co fundamentally asynchronous
[linux-2.6.git] / security / keys / internal.h
1 /* internal.h: authentication token and access key management internal defs
2  *
3  * Copyright (C) 2003-5, 2007 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 #ifndef _INTERNAL_H
13 #define _INTERNAL_H
14
15 #include <linux/key-type.h>
16 #include <linux/key-ui.h>
17
18 static inline __attribute__((format(printf, 1, 2)))
19 void no_printk(const char *fmt, ...)
20 {
21 }
22
23 #ifdef __KDEBUG
24 #define kenter(FMT, ...) \
25         printk(KERN_DEBUG "==> %s("FMT")\n", __FUNCTION__, ##__VA_ARGS__)
26 #define kleave(FMT, ...) \
27         printk(KERN_DEBUG "<== %s()"FMT"\n", __FUNCTION__, ##__VA_ARGS__)
28 #define kdebug(FMT, ...) \
29         printk(KERN_DEBUG "xxx" FMT"yyy\n", ##__VA_ARGS__)
30 #else
31 #define kenter(FMT, ...) \
32         no_printk(KERN_DEBUG "==> %s("FMT")\n", __FUNCTION__, ##__VA_ARGS__)
33 #define kleave(FMT, ...) \
34         no_printk(KERN_DEBUG "<== %s()"FMT"\n", __FUNCTION__, ##__VA_ARGS__)
35 #define kdebug(FMT, ...) \
36         no_printk(KERN_DEBUG FMT"\n", ##__VA_ARGS__)
37 #endif
38
39 extern struct key_type key_type_user;
40
41 /*****************************************************************************/
42 /*
43  * keep track of keys for a user
44  * - this needs to be separate to user_struct to avoid a refcount-loop
45  *   (user_struct pins some keyrings which pin this struct)
46  * - this also keeps track of keys under request from userspace for this UID
47  */
48 struct key_user {
49         struct rb_node          node;
50         struct mutex            cons_lock;      /* construction initiation lock */
51         spinlock_t              lock;
52         atomic_t                usage;          /* for accessing qnkeys & qnbytes */
53         atomic_t                nkeys;          /* number of keys */
54         atomic_t                nikeys;         /* number of instantiated keys */
55         uid_t                   uid;
56         int                     qnkeys;         /* number of keys allocated to this user */
57         int                     qnbytes;        /* number of bytes allocated to this user */
58 };
59
60 #define KEYQUOTA_MAX_KEYS       100
61 #define KEYQUOTA_MAX_BYTES      10000
62 #define KEYQUOTA_LINK_BYTES     4               /* a link in a keyring is worth 4 bytes */
63
64 extern struct rb_root   key_user_tree;
65 extern spinlock_t       key_user_lock;
66 extern struct key_user  root_key_user;
67
68 extern struct key_user *key_user_lookup(uid_t uid);
69 extern void key_user_put(struct key_user *user);
70
71
72
73 extern struct rb_root key_serial_tree;
74 extern spinlock_t key_serial_lock;
75 extern struct semaphore key_alloc_sem;
76 extern struct mutex key_construction_mutex;
77 extern wait_queue_head_t request_key_conswq;
78
79
80 extern void keyring_publish_name(struct key *keyring);
81
82 extern int __key_link(struct key *keyring, struct key *key);
83
84 extern key_ref_t __keyring_search_one(key_ref_t keyring_ref,
85                                       const struct key_type *type,
86                                       const char *description,
87                                       key_perm_t perm);
88
89 extern struct key *keyring_search_instkey(struct key *keyring,
90                                           key_serial_t target_id);
91
92 typedef int (*key_match_func_t)(const struct key *, const void *);
93
94 extern key_ref_t keyring_search_aux(key_ref_t keyring_ref,
95                                     struct task_struct *tsk,
96                                     struct key_type *type,
97                                     const void *description,
98                                     key_match_func_t match);
99
100 extern key_ref_t search_process_keyrings(struct key_type *type,
101                                          const void *description,
102                                          key_match_func_t match,
103                                          struct task_struct *tsk);
104
105 extern struct key *find_keyring_by_name(const char *name, key_serial_t bound);
106
107 extern int install_thread_keyring(struct task_struct *tsk);
108 extern int install_process_keyring(struct task_struct *tsk);
109
110 extern struct key *request_key_and_link(struct key_type *type,
111                                         const char *description,
112                                         const char *callout_info,
113                                         void *aux,
114                                         struct key *dest_keyring,
115                                         unsigned long flags);
116
117 /*
118  * request_key authorisation
119  */
120 struct request_key_auth {
121         struct key              *target_key;
122         struct task_struct      *context;
123         char                    *callout_info;
124         pid_t                   pid;
125 };
126
127 extern struct key_type key_type_request_key_auth;
128 extern struct key *request_key_auth_new(struct key *target,
129                                         const char *callout_info);
130
131 extern struct key *key_get_instantiation_authkey(key_serial_t target_id);
132
133 /*
134  * keyctl functions
135  */
136 extern long keyctl_get_keyring_ID(key_serial_t, int);
137 extern long keyctl_join_session_keyring(const char __user *);
138 extern long keyctl_update_key(key_serial_t, const void __user *, size_t);
139 extern long keyctl_revoke_key(key_serial_t);
140 extern long keyctl_keyring_clear(key_serial_t);
141 extern long keyctl_keyring_link(key_serial_t, key_serial_t);
142 extern long keyctl_keyring_unlink(key_serial_t, key_serial_t);
143 extern long keyctl_describe_key(key_serial_t, char __user *, size_t);
144 extern long keyctl_keyring_search(key_serial_t, const char __user *,
145                                   const char __user *, key_serial_t);
146 extern long keyctl_read_key(key_serial_t, char __user *, size_t);
147 extern long keyctl_chown_key(key_serial_t, uid_t, gid_t);
148 extern long keyctl_setperm_key(key_serial_t, key_perm_t);
149 extern long keyctl_instantiate_key(key_serial_t, const void __user *,
150                                    size_t, key_serial_t);
151 extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t);
152 extern long keyctl_set_reqkey_keyring(int);
153 extern long keyctl_set_timeout(key_serial_t, unsigned);
154 extern long keyctl_assume_authority(key_serial_t);
155
156
157 /*
158  * debugging key validation
159  */
160 #ifdef KEY_DEBUGGING
161 extern void __key_check(const struct key *);
162
163 static inline void key_check(const struct key *key)
164 {
165         if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC))
166                 __key_check(key);
167 }
168
169 #else
170
171 #define key_check(key) do {} while(0)
172
173 #endif
174
175 #endif /* _INTERNAL_H */