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