Commit | Line | Data |
---|---|---|
973c9f4f | 1 | /* Authentication token and access key management internal defs |
1da177e4 | 2 | * |
76181c13 | 3 | * Copyright (C) 2003-5, 2007 Red Hat, Inc. All Rights Reserved. |
1da177e4 LT |
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 | ||
d84f4f99 | 15 | #include <linux/sched.h> |
76181c13 | 16 | #include <linux/key-type.h> |
413cd3d9 | 17 | #include <linux/task_work.h> |
1da177e4 | 18 | |
a27bb332 KO |
19 | struct iovec; |
20 | ||
76181c13 DH |
21 | #ifdef __KDEBUG |
22 | #define kenter(FMT, ...) \ | |
dd6f953a | 23 | printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__) |
76181c13 | 24 | #define kleave(FMT, ...) \ |
dd6f953a | 25 | printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__) |
76181c13 | 26 | #define kdebug(FMT, ...) \ |
d84f4f99 | 27 | printk(KERN_DEBUG " "FMT"\n", ##__VA_ARGS__) |
3e30148c | 28 | #else |
76181c13 | 29 | #define kenter(FMT, ...) \ |
dd6f953a | 30 | no_printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__) |
76181c13 | 31 | #define kleave(FMT, ...) \ |
dd6f953a | 32 | no_printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__) |
76181c13 DH |
33 | #define kdebug(FMT, ...) \ |
34 | no_printk(KERN_DEBUG FMT"\n", ##__VA_ARGS__) | |
3e30148c DH |
35 | #endif |
36 | ||
0c061b57 | 37 | extern struct key_type key_type_dead; |
1da177e4 | 38 | extern struct key_type key_type_user; |
9f6ed2ca | 39 | extern struct key_type key_type_logon; |
1da177e4 LT |
40 | |
41 | /*****************************************************************************/ | |
42 | /* | |
973c9f4f DH |
43 | * Keep track of keys for a user. |
44 | * | |
45 | * This needs to be separate to user_struct to avoid a refcount-loop | |
46 | * (user_struct pins some keyrings which pin this struct). | |
47 | * | |
48 | * We also keep track of keys under request from userspace for this UID here. | |
1da177e4 LT |
49 | */ |
50 | struct key_user { | |
51 | struct rb_node node; | |
76181c13 | 52 | struct mutex cons_lock; /* construction initiation lock */ |
1da177e4 LT |
53 | spinlock_t lock; |
54 | atomic_t usage; /* for accessing qnkeys & qnbytes */ | |
55 | atomic_t nkeys; /* number of keys */ | |
56 | atomic_t nikeys; /* number of instantiated keys */ | |
9a56c2db | 57 | kuid_t uid; |
1da177e4 LT |
58 | int qnkeys; /* number of keys allocated to this user */ |
59 | int qnbytes; /* number of bytes allocated to this user */ | |
60 | }; | |
61 | ||
1da177e4 LT |
62 | extern struct rb_root key_user_tree; |
63 | extern spinlock_t key_user_lock; | |
64 | extern struct key_user root_key_user; | |
65 | ||
9a56c2db | 66 | extern struct key_user *key_user_lookup(kuid_t uid); |
1da177e4 LT |
67 | extern void key_user_put(struct key_user *user); |
68 | ||
0b77f5bf | 69 | /* |
973c9f4f | 70 | * Key quota limits. |
0b77f5bf DH |
71 | * - root has its own separate limits to everyone else |
72 | */ | |
73 | extern unsigned key_quota_root_maxkeys; | |
74 | extern unsigned key_quota_root_maxbytes; | |
75 | extern unsigned key_quota_maxkeys; | |
76 | extern unsigned key_quota_maxbytes; | |
77 | ||
78 | #define KEYQUOTA_LINK_BYTES 4 /* a link in a keyring is worth 4 bytes */ | |
1da177e4 LT |
79 | |
80 | ||
8bc16dea | 81 | extern struct kmem_cache *key_jar; |
1da177e4 LT |
82 | extern struct rb_root key_serial_tree; |
83 | extern spinlock_t key_serial_lock; | |
76181c13 | 84 | extern struct mutex key_construction_mutex; |
1da177e4 LT |
85 | extern wait_queue_head_t request_key_conswq; |
86 | ||
87 | ||
e9e349b0 DH |
88 | extern struct key_type *key_type_lookup(const char *type); |
89 | extern void key_type_put(struct key_type *ktype); | |
90 | ||
f70e2e06 | 91 | extern int __key_link_begin(struct key *keyring, |
16feef43 | 92 | const struct keyring_index_key *index_key, |
b2a4df20 | 93 | struct assoc_array_edit **_edit); |
f70e2e06 | 94 | extern int __key_link_check_live_key(struct key *keyring, struct key *key); |
b2a4df20 | 95 | extern void __key_link(struct key *key, struct assoc_array_edit **_edit); |
f70e2e06 | 96 | extern void __key_link_end(struct key *keyring, |
16feef43 | 97 | const struct keyring_index_key *index_key, |
b2a4df20 | 98 | struct assoc_array_edit *edit); |
1da177e4 | 99 | |
b2a4df20 DH |
100 | extern key_ref_t find_key_to_update(key_ref_t keyring_ref, |
101 | const struct keyring_index_key *index_key); | |
1da177e4 | 102 | |
3e30148c DH |
103 | extern struct key *keyring_search_instkey(struct key *keyring, |
104 | key_serial_t target_id); | |
105 | ||
b2a4df20 DH |
106 | extern int iterate_over_keyring(const struct key *keyring, |
107 | int (*func)(const struct key *key, void *data), | |
108 | void *data); | |
109 | ||
1da177e4 LT |
110 | typedef int (*key_match_func_t)(const struct key *, const void *); |
111 | ||
4bdf0bc3 DH |
112 | struct keyring_search_context { |
113 | struct keyring_index_key index_key; | |
114 | const struct cred *cred; | |
115 | key_match_func_t match; | |
116 | const void *match_data; | |
117 | unsigned flags; | |
118 | #define KEYRING_SEARCH_LOOKUP_TYPE 0x0001 /* [as type->def_lookup_type] */ | |
119 | #define KEYRING_SEARCH_NO_STATE_CHECK 0x0002 /* Skip state checks */ | |
120 | #define KEYRING_SEARCH_DO_STATE_CHECK 0x0004 /* Override NO_STATE_CHECK */ | |
121 | #define KEYRING_SEARCH_NO_UPDATE_TIME 0x0008 /* Don't update times */ | |
122 | #define KEYRING_SEARCH_NO_CHECK_PERM 0x0010 /* Don't check permissions */ | |
123 | #define KEYRING_SEARCH_DETECT_TOO_DEEP 0x0020 /* Give an error on excessive depth */ | |
124 | ||
b2a4df20 DH |
125 | int (*iterator)(const void *object, void *iterator_data); |
126 | ||
4bdf0bc3 DH |
127 | /* Internal stuff */ |
128 | int skipped_ret; | |
129 | bool possessed; | |
130 | key_ref_t result; | |
131 | struct timespec now; | |
132 | }; | |
133 | ||
664cceb0 | 134 | extern key_ref_t keyring_search_aux(key_ref_t keyring_ref, |
4bdf0bc3 DH |
135 | struct keyring_search_context *ctx); |
136 | ||
137 | extern key_ref_t search_my_process_keyrings(struct keyring_search_context *ctx); | |
138 | extern key_ref_t search_process_keyrings(struct keyring_search_context *ctx); | |
1da177e4 | 139 | |
69664cf1 | 140 | extern struct key *find_keyring_by_name(const char *name, bool skip_perm_check); |
1da177e4 | 141 | |
8bbf4976 | 142 | extern int install_user_keyrings(void); |
d84f4f99 DH |
143 | extern int install_thread_keyring_to_cred(struct cred *); |
144 | extern int install_process_keyring_to_cred(struct cred *); | |
685bfd2c | 145 | extern int install_session_keyring_to_cred(struct cred *, struct key *); |
3e30148c DH |
146 | |
147 | extern struct key *request_key_and_link(struct key_type *type, | |
148 | const char *description, | |
4a38e122 DH |
149 | const void *callout_info, |
150 | size_t callout_len, | |
4e54f085 | 151 | void *aux, |
7e047ef5 DH |
152 | struct key *dest_keyring, |
153 | unsigned long flags); | |
3e30148c | 154 | |
927942aa | 155 | extern int lookup_user_key_possessed(const struct key *key, const void *target); |
5593122e | 156 | extern key_ref_t lookup_user_key(key_serial_t id, unsigned long flags, |
e9e349b0 | 157 | key_perm_t perm); |
5593122e DH |
158 | #define KEY_LOOKUP_CREATE 0x01 |
159 | #define KEY_LOOKUP_PARTIAL 0x02 | |
160 | #define KEY_LOOKUP_FOR_UNLINK 0x04 | |
e9e349b0 DH |
161 | |
162 | extern long join_session_keyring(const char *name); | |
67d12145 | 163 | extern void key_change_session_keyring(struct callback_head *twork); |
e9e349b0 | 164 | |
0c061b57 | 165 | extern struct work_struct key_gc_work; |
5d135440 DH |
166 | extern unsigned key_gc_delay; |
167 | extern void keyring_gc(struct key *keyring, time_t limit); | |
fd75815f DH |
168 | extern void key_schedule_gc(time_t gc_at); |
169 | extern void key_schedule_gc_links(void); | |
0c061b57 | 170 | extern void key_gc_keytype(struct key_type *ktype); |
5d135440 | 171 | |
e9e349b0 | 172 | extern int key_task_permission(const key_ref_t key_ref, |
d84f4f99 | 173 | const struct cred *cred, |
e9e349b0 DH |
174 | key_perm_t perm); |
175 | ||
973c9f4f DH |
176 | /* |
177 | * Check to see whether permission is granted to use a key in the desired way. | |
178 | */ | |
e9e349b0 DH |
179 | static inline int key_permission(const key_ref_t key_ref, key_perm_t perm) |
180 | { | |
d84f4f99 | 181 | return key_task_permission(key_ref, current_cred(), perm); |
e9e349b0 DH |
182 | } |
183 | ||
184 | /* required permissions */ | |
185 | #define KEY_VIEW 0x01 /* require permission to view attributes */ | |
186 | #define KEY_READ 0x02 /* require permission to read content */ | |
187 | #define KEY_WRITE 0x04 /* require permission to update / modify */ | |
188 | #define KEY_SEARCH 0x08 /* require permission to search (keyring) or find (key) */ | |
189 | #define KEY_LINK 0x10 /* require permission to link */ | |
190 | #define KEY_SETATTR 0x20 /* require permission to change attributes */ | |
191 | #define KEY_ALL 0x3f /* all the above permissions */ | |
192 | ||
3e30148c | 193 | /* |
973c9f4f | 194 | * Authorisation record for request_key(). |
3e30148c DH |
195 | */ |
196 | struct request_key_auth { | |
197 | struct key *target_key; | |
8bbf4976 | 198 | struct key *dest_keyring; |
d84f4f99 | 199 | const struct cred *cred; |
4a38e122 DH |
200 | void *callout_info; |
201 | size_t callout_len; | |
3e30148c DH |
202 | pid_t pid; |
203 | }; | |
204 | ||
205 | extern struct key_type key_type_request_key_auth; | |
206 | extern struct key *request_key_auth_new(struct key *target, | |
4a38e122 | 207 | const void *callout_info, |
8bbf4976 DH |
208 | size_t callout_len, |
209 | struct key *dest_keyring); | |
3e30148c DH |
210 | |
211 | extern struct key *key_get_instantiation_authkey(key_serial_t target_id); | |
1da177e4 | 212 | |
fd75815f DH |
213 | /* |
214 | * Determine whether a key is dead. | |
215 | */ | |
7e55ca6d | 216 | static inline bool key_is_dead(const struct key *key, time_t limit) |
fd75815f DH |
217 | { |
218 | return | |
219 | key->flags & ((1 << KEY_FLAG_DEAD) | | |
220 | (1 << KEY_FLAG_INVALIDATED)) || | |
221 | (key->expiry > 0 && key->expiry <= limit); | |
222 | } | |
223 | ||
1da177e4 | 224 | /* |
973c9f4f | 225 | * keyctl() functions |
1da177e4 LT |
226 | */ |
227 | extern long keyctl_get_keyring_ID(key_serial_t, int); | |
228 | extern long keyctl_join_session_keyring(const char __user *); | |
229 | extern long keyctl_update_key(key_serial_t, const void __user *, size_t); | |
230 | extern long keyctl_revoke_key(key_serial_t); | |
231 | extern long keyctl_keyring_clear(key_serial_t); | |
232 | extern long keyctl_keyring_link(key_serial_t, key_serial_t); | |
233 | extern long keyctl_keyring_unlink(key_serial_t, key_serial_t); | |
234 | extern long keyctl_describe_key(key_serial_t, char __user *, size_t); | |
235 | extern long keyctl_keyring_search(key_serial_t, const char __user *, | |
236 | const char __user *, key_serial_t); | |
237 | extern long keyctl_read_key(key_serial_t, char __user *, size_t); | |
238 | extern long keyctl_chown_key(key_serial_t, uid_t, gid_t); | |
239 | extern long keyctl_setperm_key(key_serial_t, key_perm_t); | |
240 | extern long keyctl_instantiate_key(key_serial_t, const void __user *, | |
241 | size_t, key_serial_t); | |
242 | extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t); | |
3e30148c | 243 | extern long keyctl_set_reqkey_keyring(int); |
017679c4 | 244 | extern long keyctl_set_timeout(key_serial_t, unsigned); |
b5f545c8 | 245 | extern long keyctl_assume_authority(key_serial_t); |
70a5bb72 DH |
246 | extern long keyctl_get_security(key_serial_t keyid, char __user *buffer, |
247 | size_t buflen); | |
ee18d64c | 248 | extern long keyctl_session_to_parent(void); |
fdd1b945 | 249 | extern long keyctl_reject_key(key_serial_t, unsigned, unsigned, key_serial_t); |
ee009e4a DH |
250 | extern long keyctl_instantiate_key_iov(key_serial_t, |
251 | const struct iovec __user *, | |
252 | unsigned, key_serial_t); | |
fd75815f | 253 | extern long keyctl_invalidate_key(key_serial_t); |
ee009e4a DH |
254 | |
255 | extern long keyctl_instantiate_key_common(key_serial_t, | |
423b9788 | 256 | const struct iovec *, |
ee009e4a | 257 | unsigned, size_t, key_serial_t); |
f36f8c75 DH |
258 | #ifdef CONFIG_PERSISTENT_KEYRINGS |
259 | extern long keyctl_get_persistent(uid_t, key_serial_t); | |
260 | extern unsigned persistent_keyring_expiry; | |
261 | #else | |
262 | static inline long keyctl_get_persistent(uid_t uid, key_serial_t destring) | |
263 | { | |
264 | return -EOPNOTSUPP; | |
265 | } | |
266 | #endif | |
1da177e4 LT |
267 | |
268 | /* | |
973c9f4f | 269 | * Debugging key validation |
1da177e4 LT |
270 | */ |
271 | #ifdef KEY_DEBUGGING | |
272 | extern void __key_check(const struct key *); | |
273 | ||
274 | static inline void key_check(const struct key *key) | |
275 | { | |
276 | if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC)) | |
277 | __key_check(key); | |
278 | } | |
279 | ||
280 | #else | |
281 | ||
282 | #define key_check(key) do {} while(0) | |
283 | ||
284 | #endif | |
285 | ||
286 | #endif /* _INTERNAL_H */ |