1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /* Authentication token and access key management internal defs
4 * Copyright (C) 2003-5, 2007 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
11 #include <linux/sched.h>
12 #include <linux/wait_bit.h>
13 #include <linux/cred.h>
14 #include <linux/key-type.h>
15 #include <linux/task_work.h>
16 #include <linux/keyctl.h>
17 #include <linux/refcount.h>
18 #include <linux/compat.h>
23 #define kenter(FMT, ...) \
24 printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
25 #define kleave(FMT, ...) \
26 printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
27 #define kdebug(FMT, ...) \
28 printk(KERN_DEBUG " "FMT"\n", ##__VA_ARGS__)
30 #define kenter(FMT, ...) \
31 no_printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
32 #define kleave(FMT, ...) \
33 no_printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
34 #define kdebug(FMT, ...) \
35 no_printk(KERN_DEBUG FMT"\n", ##__VA_ARGS__)
38 extern struct key_type key_type_dead;
39 extern struct key_type key_type_user;
40 extern struct key_type key_type_logon;
42 /*****************************************************************************/
44 * Keep track of keys for a user.
46 * This needs to be separate to user_struct to avoid a refcount-loop
47 * (user_struct pins some keyrings which pin this struct).
49 * We also keep track of keys under request from userspace for this UID here.
53 struct mutex cons_lock; /* construction initiation lock */
55 refcount_t usage; /* for accessing qnkeys & qnbytes */
56 atomic_t nkeys; /* number of keys */
57 atomic_t nikeys; /* number of instantiated keys */
59 int qnkeys; /* number of keys allocated to this user */
60 int qnbytes; /* number of bytes allocated to this user */
63 extern struct rb_root key_user_tree;
64 extern spinlock_t key_user_lock;
65 extern struct key_user root_key_user;
67 extern struct key_user *key_user_lookup(kuid_t uid);
68 extern void key_user_put(struct key_user *user);
72 * - root has its own separate limits to everyone else
74 extern unsigned key_quota_root_maxkeys;
75 extern unsigned key_quota_root_maxbytes;
76 extern unsigned key_quota_maxkeys;
77 extern unsigned key_quota_maxbytes;
79 #define KEYQUOTA_LINK_BYTES 4 /* a link in a keyring is worth 4 bytes */
82 extern struct kmem_cache *key_jar;
83 extern struct rb_root key_serial_tree;
84 extern spinlock_t key_serial_lock;
85 extern struct mutex key_construction_mutex;
86 extern wait_queue_head_t request_key_conswq;
89 extern struct key_type *key_type_lookup(const char *type);
90 extern void key_type_put(struct key_type *ktype);
92 extern int __key_link_lock(struct key *keyring,
93 const struct keyring_index_key *index_key);
94 extern int __key_move_lock(struct key *l_keyring, struct key *u_keyring,
95 const struct keyring_index_key *index_key);
96 extern int __key_link_begin(struct key *keyring,
97 const struct keyring_index_key *index_key,
98 struct assoc_array_edit **_edit);
99 extern int __key_link_check_live_key(struct key *keyring, struct key *key);
100 extern void __key_link(struct key *key, struct assoc_array_edit **_edit);
101 extern void __key_link_end(struct key *keyring,
102 const struct keyring_index_key *index_key,
103 struct assoc_array_edit *edit);
105 extern key_ref_t find_key_to_update(key_ref_t keyring_ref,
106 const struct keyring_index_key *index_key);
108 extern struct key *keyring_search_instkey(struct key *keyring,
109 key_serial_t target_id);
111 extern int iterate_over_keyring(const struct key *keyring,
112 int (*func)(const struct key *key, void *data),
115 struct keyring_search_context {
116 struct keyring_index_key index_key;
117 const struct cred *cred;
118 struct key_match_data match_data;
120 #define KEYRING_SEARCH_NO_STATE_CHECK 0x0001 /* Skip state checks */
121 #define KEYRING_SEARCH_DO_STATE_CHECK 0x0002 /* Override NO_STATE_CHECK */
122 #define KEYRING_SEARCH_NO_UPDATE_TIME 0x0004 /* Don't update times */
123 #define KEYRING_SEARCH_NO_CHECK_PERM 0x0008 /* Don't check permissions */
124 #define KEYRING_SEARCH_DETECT_TOO_DEEP 0x0010 /* Give an error on excessive depth */
125 #define KEYRING_SEARCH_SKIP_EXPIRED 0x0020 /* Ignore expired keys (intention to replace) */
127 int (*iterator)(const void *object, void *iterator_data);
136 extern bool key_default_cmp(const struct key *key,
137 const struct key_match_data *match_data);
138 extern key_ref_t keyring_search_rcu(key_ref_t keyring_ref,
139 struct keyring_search_context *ctx);
141 extern key_ref_t search_cred_keyrings_rcu(struct keyring_search_context *ctx);
142 extern key_ref_t search_process_keyrings_rcu(struct keyring_search_context *ctx);
144 extern struct key *find_keyring_by_name(const char *name, bool uid_keyring);
146 extern int install_user_keyrings(void);
147 extern int install_thread_keyring_to_cred(struct cred *);
148 extern int install_process_keyring_to_cred(struct cred *);
149 extern int install_session_keyring_to_cred(struct cred *, struct key *);
151 extern struct key *request_key_and_link(struct key_type *type,
152 const char *description,
153 const void *callout_info,
156 struct key *dest_keyring,
157 unsigned long flags);
159 extern bool lookup_user_key_possessed(const struct key *key,
160 const struct key_match_data *match_data);
161 #define KEY_LOOKUP_CREATE 0x01
162 #define KEY_LOOKUP_PARTIAL 0x02
163 #define KEY_LOOKUP_FOR_UNLINK 0x04
165 extern long join_session_keyring(const char *name);
166 extern void key_change_session_keyring(struct callback_head *twork);
168 extern struct work_struct key_gc_work;
169 extern unsigned key_gc_delay;
170 extern void keyring_gc(struct key *keyring, time64_t limit);
171 extern void keyring_restriction_gc(struct key *keyring,
172 struct key_type *dead_type);
173 extern void key_schedule_gc(time64_t gc_at);
174 extern void key_schedule_gc_links(void);
175 extern void key_gc_keytype(struct key_type *ktype);
177 extern int key_task_permission(const key_ref_t key_ref,
178 const struct cred *cred,
182 * Check to see whether permission is granted to use a key in the desired way.
184 static inline int key_permission(const key_ref_t key_ref, unsigned perm)
186 return key_task_permission(key_ref, current_cred(), perm);
189 extern struct key_type key_type_request_key_auth;
190 extern struct key *request_key_auth_new(struct key *target,
192 const void *callout_info,
194 struct key *dest_keyring);
196 extern struct key *key_get_instantiation_authkey(key_serial_t target_id);
199 * Determine whether a key is dead.
201 static inline bool key_is_dead(const struct key *key, time64_t limit)
204 key->flags & ((1 << KEY_FLAG_DEAD) |
205 (1 << KEY_FLAG_INVALIDATED)) ||
206 (key->expiry > 0 && key->expiry <= limit);
212 extern long keyctl_get_keyring_ID(key_serial_t, int);
213 extern long keyctl_join_session_keyring(const char __user *);
214 extern long keyctl_update_key(key_serial_t, const void __user *, size_t);
215 extern long keyctl_revoke_key(key_serial_t);
216 extern long keyctl_keyring_clear(key_serial_t);
217 extern long keyctl_keyring_link(key_serial_t, key_serial_t);
218 extern long keyctl_keyring_move(key_serial_t, key_serial_t, key_serial_t, unsigned int);
219 extern long keyctl_keyring_unlink(key_serial_t, key_serial_t);
220 extern long keyctl_describe_key(key_serial_t, char __user *, size_t);
221 extern long keyctl_keyring_search(key_serial_t, const char __user *,
222 const char __user *, key_serial_t);
223 extern long keyctl_read_key(key_serial_t, char __user *, size_t);
224 extern long keyctl_chown_key(key_serial_t, uid_t, gid_t);
225 extern long keyctl_setperm_key(key_serial_t, key_perm_t);
226 extern long keyctl_instantiate_key(key_serial_t, const void __user *,
227 size_t, key_serial_t);
228 extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t);
229 extern long keyctl_set_reqkey_keyring(int);
230 extern long keyctl_set_timeout(key_serial_t, unsigned);
231 extern long keyctl_assume_authority(key_serial_t);
232 extern long keyctl_get_security(key_serial_t keyid, char __user *buffer,
234 extern long keyctl_session_to_parent(void);
235 extern long keyctl_reject_key(key_serial_t, unsigned, unsigned, key_serial_t);
236 extern long keyctl_instantiate_key_iov(key_serial_t,
237 const struct iovec __user *,
238 unsigned, key_serial_t);
239 extern long keyctl_invalidate_key(key_serial_t);
242 extern long keyctl_instantiate_key_common(key_serial_t,
245 extern long keyctl_restrict_keyring(key_serial_t id,
246 const char __user *_type,
247 const char __user *_restriction);
248 #ifdef CONFIG_PERSISTENT_KEYRINGS
249 extern long keyctl_get_persistent(uid_t, key_serial_t);
250 extern unsigned persistent_keyring_expiry;
252 static inline long keyctl_get_persistent(uid_t uid, key_serial_t destring)
258 #ifdef CONFIG_KEY_DH_OPERATIONS
259 extern long keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *,
260 size_t, struct keyctl_kdf_params __user *);
261 extern long __keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *,
262 size_t, struct keyctl_kdf_params *);
263 #ifdef CONFIG_KEYS_COMPAT
264 extern long compat_keyctl_dh_compute(struct keyctl_dh_params __user *params,
265 char __user *buffer, size_t buflen,
266 struct compat_keyctl_kdf_params __user *kdf);
268 #define KEYCTL_KDF_MAX_OUTPUT_LEN 1024 /* max length of KDF output */
269 #define KEYCTL_KDF_MAX_OI_LEN 64 /* max length of otherinfo */
271 static inline long keyctl_dh_compute(struct keyctl_dh_params __user *params,
272 char __user *buffer, size_t buflen,
273 struct keyctl_kdf_params __user *kdf)
278 #ifdef CONFIG_KEYS_COMPAT
279 static inline long compat_keyctl_dh_compute(
280 struct keyctl_dh_params __user *params,
281 char __user *buffer, size_t buflen,
282 struct keyctl_kdf_params __user *kdf)
289 #ifdef CONFIG_ASYMMETRIC_KEY_TYPE
290 extern long keyctl_pkey_query(key_serial_t,
292 struct keyctl_pkey_query __user *);
294 extern long keyctl_pkey_verify(const struct keyctl_pkey_params __user *,
296 const void __user *, const void __user *);
298 extern long keyctl_pkey_e_d_s(int,
299 const struct keyctl_pkey_params __user *,
301 const void __user *, void __user *);
303 static inline long keyctl_pkey_query(key_serial_t id,
304 const char __user *_info,
305 struct keyctl_pkey_query __user *_res)
310 static inline long keyctl_pkey_verify(const struct keyctl_pkey_params __user *params,
311 const char __user *_info,
312 const void __user *_in,
313 const void __user *_in2)
318 static inline long keyctl_pkey_e_d_s(int op,
319 const struct keyctl_pkey_params __user *params,
320 const char __user *_info,
321 const void __user *_in,
328 extern long keyctl_capabilities(unsigned char __user *_buffer, size_t buflen);
331 * Debugging key validation
334 extern void __key_check(const struct key *);
336 static inline void key_check(const struct key *key)
338 if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC))
344 #define key_check(key) do {} while(0)
348 #endif /* _INTERNAL_H */