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> |
5dd43ce2 | 16 | #include <linux/wait_bit.h> |
5b825c3a | 17 | #include <linux/cred.h> |
76181c13 | 18 | #include <linux/key-type.h> |
413cd3d9 | 19 | #include <linux/task_work.h> |
ddbb4114 | 20 | #include <linux/keyctl.h> |
ddb99e11 | 21 | #include <linux/refcount.h> |
f1c316a3 | 22 | #include <linux/compat.h> |
1da177e4 | 23 | |
a27bb332 KO |
24 | struct iovec; |
25 | ||
76181c13 DH |
26 | #ifdef __KDEBUG |
27 | #define kenter(FMT, ...) \ | |
dd6f953a | 28 | printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__) |
76181c13 | 29 | #define kleave(FMT, ...) \ |
dd6f953a | 30 | printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__) |
76181c13 | 31 | #define kdebug(FMT, ...) \ |
d84f4f99 | 32 | printk(KERN_DEBUG " "FMT"\n", ##__VA_ARGS__) |
3e30148c | 33 | #else |
76181c13 | 34 | #define kenter(FMT, ...) \ |
dd6f953a | 35 | no_printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__) |
76181c13 | 36 | #define kleave(FMT, ...) \ |
dd6f953a | 37 | no_printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__) |
76181c13 DH |
38 | #define kdebug(FMT, ...) \ |
39 | no_printk(KERN_DEBUG FMT"\n", ##__VA_ARGS__) | |
3e30148c DH |
40 | #endif |
41 | ||
0c061b57 | 42 | extern struct key_type key_type_dead; |
1da177e4 | 43 | extern struct key_type key_type_user; |
9f6ed2ca | 44 | extern struct key_type key_type_logon; |
1da177e4 LT |
45 | |
46 | /*****************************************************************************/ | |
47 | /* | |
973c9f4f DH |
48 | * Keep track of keys for a user. |
49 | * | |
50 | * This needs to be separate to user_struct to avoid a refcount-loop | |
51 | * (user_struct pins some keyrings which pin this struct). | |
52 | * | |
53 | * We also keep track of keys under request from userspace for this UID here. | |
1da177e4 LT |
54 | */ |
55 | struct key_user { | |
56 | struct rb_node node; | |
76181c13 | 57 | struct mutex cons_lock; /* construction initiation lock */ |
1da177e4 | 58 | spinlock_t lock; |
ddb99e11 | 59 | refcount_t usage; /* for accessing qnkeys & qnbytes */ |
1da177e4 LT |
60 | atomic_t nkeys; /* number of keys */ |
61 | atomic_t nikeys; /* number of instantiated keys */ | |
9a56c2db | 62 | kuid_t uid; |
1da177e4 LT |
63 | int qnkeys; /* number of keys allocated to this user */ |
64 | int qnbytes; /* number of bytes allocated to this user */ | |
65 | }; | |
66 | ||
1da177e4 LT |
67 | extern struct rb_root key_user_tree; |
68 | extern spinlock_t key_user_lock; | |
69 | extern struct key_user root_key_user; | |
70 | ||
9a56c2db | 71 | extern struct key_user *key_user_lookup(kuid_t uid); |
1da177e4 LT |
72 | extern void key_user_put(struct key_user *user); |
73 | ||
0b77f5bf | 74 | /* |
973c9f4f | 75 | * Key quota limits. |
0b77f5bf DH |
76 | * - root has its own separate limits to everyone else |
77 | */ | |
78 | extern unsigned key_quota_root_maxkeys; | |
79 | extern unsigned key_quota_root_maxbytes; | |
80 | extern unsigned key_quota_maxkeys; | |
81 | extern unsigned key_quota_maxbytes; | |
82 | ||
83 | #define KEYQUOTA_LINK_BYTES 4 /* a link in a keyring is worth 4 bytes */ | |
1da177e4 LT |
84 | |
85 | ||
8bc16dea | 86 | extern struct kmem_cache *key_jar; |
1da177e4 LT |
87 | extern struct rb_root key_serial_tree; |
88 | extern spinlock_t key_serial_lock; | |
76181c13 | 89 | extern struct mutex key_construction_mutex; |
1da177e4 LT |
90 | extern wait_queue_head_t request_key_conswq; |
91 | ||
92 | ||
e9e349b0 DH |
93 | extern struct key_type *key_type_lookup(const char *type); |
94 | extern void key_type_put(struct key_type *ktype); | |
95 | ||
df593ee2 DH |
96 | extern int __key_link_lock(struct key *keyring, |
97 | const struct keyring_index_key *index_key); | |
f70e2e06 | 98 | extern int __key_link_begin(struct key *keyring, |
16feef43 | 99 | const struct keyring_index_key *index_key, |
b2a4df20 | 100 | struct assoc_array_edit **_edit); |
f70e2e06 | 101 | extern int __key_link_check_live_key(struct key *keyring, struct key *key); |
b2a4df20 | 102 | extern void __key_link(struct key *key, struct assoc_array_edit **_edit); |
f70e2e06 | 103 | extern void __key_link_end(struct key *keyring, |
16feef43 | 104 | const struct keyring_index_key *index_key, |
b2a4df20 | 105 | struct assoc_array_edit *edit); |
1da177e4 | 106 | |
b2a4df20 DH |
107 | extern key_ref_t find_key_to_update(key_ref_t keyring_ref, |
108 | const struct keyring_index_key *index_key); | |
1da177e4 | 109 | |
3e30148c DH |
110 | extern struct key *keyring_search_instkey(struct key *keyring, |
111 | key_serial_t target_id); | |
112 | ||
b2a4df20 DH |
113 | extern int iterate_over_keyring(const struct key *keyring, |
114 | int (*func)(const struct key *key, void *data), | |
115 | void *data); | |
116 | ||
4bdf0bc3 DH |
117 | struct keyring_search_context { |
118 | struct keyring_index_key index_key; | |
119 | const struct cred *cred; | |
46291959 | 120 | struct key_match_data match_data; |
4bdf0bc3 | 121 | unsigned flags; |
614d8c39 DH |
122 | #define KEYRING_SEARCH_NO_STATE_CHECK 0x0001 /* Skip state checks */ |
123 | #define KEYRING_SEARCH_DO_STATE_CHECK 0x0002 /* Override NO_STATE_CHECK */ | |
124 | #define KEYRING_SEARCH_NO_UPDATE_TIME 0x0004 /* Don't update times */ | |
125 | #define KEYRING_SEARCH_NO_CHECK_PERM 0x0008 /* Don't check permissions */ | |
126 | #define KEYRING_SEARCH_DETECT_TOO_DEEP 0x0010 /* Give an error on excessive depth */ | |
0b0a8415 | 127 | #define KEYRING_SEARCH_SKIP_EXPIRED 0x0020 /* Ignore expired keys (intention to replace) */ |
4bdf0bc3 | 128 | |
b2a4df20 DH |
129 | int (*iterator)(const void *object, void *iterator_data); |
130 | ||
4bdf0bc3 DH |
131 | /* Internal stuff */ |
132 | int skipped_ret; | |
133 | bool possessed; | |
134 | key_ref_t result; | |
074d5898 | 135 | time64_t now; |
4bdf0bc3 DH |
136 | }; |
137 | ||
0c903ab6 DH |
138 | extern bool key_default_cmp(const struct key *key, |
139 | const struct key_match_data *match_data); | |
664cceb0 | 140 | extern key_ref_t keyring_search_aux(key_ref_t keyring_ref, |
4bdf0bc3 DH |
141 | struct keyring_search_context *ctx); |
142 | ||
143 | extern key_ref_t search_my_process_keyrings(struct keyring_search_context *ctx); | |
144 | extern key_ref_t search_process_keyrings(struct keyring_search_context *ctx); | |
1da177e4 | 145 | |
237bbd29 | 146 | extern struct key *find_keyring_by_name(const char *name, bool uid_keyring); |
1da177e4 | 147 | |
8bbf4976 | 148 | extern int install_user_keyrings(void); |
d84f4f99 DH |
149 | extern int install_thread_keyring_to_cred(struct cred *); |
150 | extern int install_process_keyring_to_cred(struct cred *); | |
685bfd2c | 151 | extern int install_session_keyring_to_cred(struct cred *, struct key *); |
3e30148c DH |
152 | |
153 | extern struct key *request_key_and_link(struct key_type *type, | |
154 | const char *description, | |
4a38e122 DH |
155 | const void *callout_info, |
156 | size_t callout_len, | |
4e54f085 | 157 | void *aux, |
7e047ef5 DH |
158 | struct key *dest_keyring, |
159 | unsigned long flags); | |
3e30148c | 160 | |
0c903ab6 DH |
161 | extern bool lookup_user_key_possessed(const struct key *key, |
162 | const struct key_match_data *match_data); | |
5593122e DH |
163 | #define KEY_LOOKUP_CREATE 0x01 |
164 | #define KEY_LOOKUP_PARTIAL 0x02 | |
165 | #define KEY_LOOKUP_FOR_UNLINK 0x04 | |
e9e349b0 DH |
166 | |
167 | extern long join_session_keyring(const char *name); | |
67d12145 | 168 | extern void key_change_session_keyring(struct callback_head *twork); |
e9e349b0 | 169 | |
0c061b57 | 170 | extern struct work_struct key_gc_work; |
5d135440 | 171 | extern unsigned key_gc_delay; |
074d5898 | 172 | extern void keyring_gc(struct key *keyring, time64_t limit); |
2b6aa412 MM |
173 | extern void keyring_restriction_gc(struct key *keyring, |
174 | struct key_type *dead_type); | |
074d5898 | 175 | extern void key_schedule_gc(time64_t gc_at); |
fd75815f | 176 | extern void key_schedule_gc_links(void); |
0c061b57 | 177 | extern void key_gc_keytype(struct key_type *ktype); |
5d135440 | 178 | |
e9e349b0 | 179 | extern int key_task_permission(const key_ref_t key_ref, |
d84f4f99 | 180 | const struct cred *cred, |
e9e349b0 DH |
181 | key_perm_t perm); |
182 | ||
973c9f4f DH |
183 | /* |
184 | * Check to see whether permission is granted to use a key in the desired way. | |
185 | */ | |
f5895943 | 186 | static inline int key_permission(const key_ref_t key_ref, unsigned perm) |
e9e349b0 | 187 | { |
d84f4f99 | 188 | return key_task_permission(key_ref, current_cred(), perm); |
e9e349b0 DH |
189 | } |
190 | ||
3e30148c DH |
191 | extern struct key_type key_type_request_key_auth; |
192 | extern struct key *request_key_auth_new(struct key *target, | |
822ad64d | 193 | const char *op, |
4a38e122 | 194 | const void *callout_info, |
8bbf4976 DH |
195 | size_t callout_len, |
196 | struct key *dest_keyring); | |
3e30148c DH |
197 | |
198 | extern struct key *key_get_instantiation_authkey(key_serial_t target_id); | |
1da177e4 | 199 | |
fd75815f DH |
200 | /* |
201 | * Determine whether a key is dead. | |
202 | */ | |
074d5898 | 203 | static inline bool key_is_dead(const struct key *key, time64_t limit) |
fd75815f DH |
204 | { |
205 | return | |
206 | key->flags & ((1 << KEY_FLAG_DEAD) | | |
207 | (1 << KEY_FLAG_INVALIDATED)) || | |
208 | (key->expiry > 0 && key->expiry <= limit); | |
209 | } | |
210 | ||
1da177e4 | 211 | /* |
973c9f4f | 212 | * keyctl() functions |
1da177e4 LT |
213 | */ |
214 | extern long keyctl_get_keyring_ID(key_serial_t, int); | |
215 | extern long keyctl_join_session_keyring(const char __user *); | |
216 | extern long keyctl_update_key(key_serial_t, const void __user *, size_t); | |
217 | extern long keyctl_revoke_key(key_serial_t); | |
218 | extern long keyctl_keyring_clear(key_serial_t); | |
219 | extern long keyctl_keyring_link(key_serial_t, key_serial_t); | |
220 | extern long keyctl_keyring_unlink(key_serial_t, key_serial_t); | |
221 | extern long keyctl_describe_key(key_serial_t, char __user *, size_t); | |
222 | extern long keyctl_keyring_search(key_serial_t, const char __user *, | |
223 | const char __user *, key_serial_t); | |
224 | extern long keyctl_read_key(key_serial_t, char __user *, size_t); | |
225 | extern long keyctl_chown_key(key_serial_t, uid_t, gid_t); | |
226 | extern long keyctl_setperm_key(key_serial_t, key_perm_t); | |
227 | extern long keyctl_instantiate_key(key_serial_t, const void __user *, | |
228 | size_t, key_serial_t); | |
229 | extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t); | |
3e30148c | 230 | extern long keyctl_set_reqkey_keyring(int); |
017679c4 | 231 | extern long keyctl_set_timeout(key_serial_t, unsigned); |
b5f545c8 | 232 | extern long keyctl_assume_authority(key_serial_t); |
70a5bb72 DH |
233 | extern long keyctl_get_security(key_serial_t keyid, char __user *buffer, |
234 | size_t buflen); | |
ee18d64c | 235 | extern long keyctl_session_to_parent(void); |
fdd1b945 | 236 | extern long keyctl_reject_key(key_serial_t, unsigned, unsigned, key_serial_t); |
ee009e4a DH |
237 | extern long keyctl_instantiate_key_iov(key_serial_t, |
238 | const struct iovec __user *, | |
239 | unsigned, key_serial_t); | |
fd75815f | 240 | extern long keyctl_invalidate_key(key_serial_t); |
ee009e4a | 241 | |
b353a1f7 | 242 | struct iov_iter; |
ee009e4a | 243 | extern long keyctl_instantiate_key_common(key_serial_t, |
b353a1f7 AV |
244 | struct iov_iter *, |
245 | key_serial_t); | |
6563c91f MM |
246 | extern long keyctl_restrict_keyring(key_serial_t id, |
247 | const char __user *_type, | |
248 | const char __user *_restriction); | |
f36f8c75 DH |
249 | #ifdef CONFIG_PERSISTENT_KEYRINGS |
250 | extern long keyctl_get_persistent(uid_t, key_serial_t); | |
251 | extern unsigned persistent_keyring_expiry; | |
252 | #else | |
253 | static inline long keyctl_get_persistent(uid_t uid, key_serial_t destring) | |
254 | { | |
255 | return -EOPNOTSUPP; | |
256 | } | |
257 | #endif | |
1da177e4 | 258 | |
ddbb4114 MM |
259 | #ifdef CONFIG_KEY_DH_OPERATIONS |
260 | extern long keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *, | |
f1c316a3 SM |
261 | size_t, struct keyctl_kdf_params __user *); |
262 | extern long __keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *, | |
263 | size_t, struct keyctl_kdf_params *); | |
264 | #ifdef CONFIG_KEYS_COMPAT | |
265 | extern long compat_keyctl_dh_compute(struct keyctl_dh_params __user *params, | |
266 | char __user *buffer, size_t buflen, | |
267 | struct compat_keyctl_kdf_params __user *kdf); | |
268 | #endif | |
269 | #define KEYCTL_KDF_MAX_OUTPUT_LEN 1024 /* max length of KDF output */ | |
270 | #define KEYCTL_KDF_MAX_OI_LEN 64 /* max length of otherinfo */ | |
ddbb4114 MM |
271 | #else |
272 | static inline long keyctl_dh_compute(struct keyctl_dh_params __user *params, | |
4693fc73 | 273 | char __user *buffer, size_t buflen, |
f1c316a3 SM |
274 | struct keyctl_kdf_params __user *kdf) |
275 | { | |
276 | return -EOPNOTSUPP; | |
277 | } | |
278 | ||
279 | #ifdef CONFIG_KEYS_COMPAT | |
280 | static inline long compat_keyctl_dh_compute( | |
281 | struct keyctl_dh_params __user *params, | |
282 | char __user *buffer, size_t buflen, | |
283 | struct keyctl_kdf_params __user *kdf) | |
ddbb4114 MM |
284 | { |
285 | return -EOPNOTSUPP; | |
286 | } | |
287 | #endif | |
f1c316a3 | 288 | #endif |
ddbb4114 | 289 | |
00d60fd3 DH |
290 | #ifdef CONFIG_ASYMMETRIC_KEY_TYPE |
291 | extern long keyctl_pkey_query(key_serial_t, | |
292 | const char __user *, | |
293 | struct keyctl_pkey_query __user *); | |
294 | ||
295 | extern long keyctl_pkey_verify(const struct keyctl_pkey_params __user *, | |
296 | const char __user *, | |
297 | const void __user *, const void __user *); | |
298 | ||
299 | extern long keyctl_pkey_e_d_s(int, | |
300 | const struct keyctl_pkey_params __user *, | |
301 | const char __user *, | |
302 | const void __user *, void __user *); | |
303 | #else | |
304 | static inline long keyctl_pkey_query(key_serial_t id, | |
305 | const char __user *_info, | |
306 | struct keyctl_pkey_query __user *_res) | |
307 | { | |
308 | return -EOPNOTSUPP; | |
309 | } | |
310 | ||
311 | static inline long keyctl_pkey_verify(const struct keyctl_pkey_params __user *params, | |
312 | const char __user *_info, | |
313 | const void __user *_in, | |
314 | const void __user *_in2) | |
315 | { | |
316 | return -EOPNOTSUPP; | |
317 | } | |
318 | ||
319 | static inline long keyctl_pkey_e_d_s(int op, | |
320 | const struct keyctl_pkey_params __user *params, | |
321 | const char __user *_info, | |
322 | const void __user *_in, | |
323 | void __user *_out) | |
324 | { | |
325 | return -EOPNOTSUPP; | |
326 | } | |
327 | #endif | |
328 | ||
1da177e4 | 329 | /* |
973c9f4f | 330 | * Debugging key validation |
1da177e4 LT |
331 | */ |
332 | #ifdef KEY_DEBUGGING | |
333 | extern void __key_check(const struct key *); | |
334 | ||
335 | static inline void key_check(const struct key *key) | |
336 | { | |
337 | if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC)) | |
338 | __key_check(key); | |
339 | } | |
340 | ||
341 | #else | |
342 | ||
343 | #define key_check(key) do {} while(0) | |
344 | ||
345 | #endif | |
346 | ||
347 | #endif /* _INTERNAL_H */ |