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/watch_queue.h>
19 #include <linux/compat.h>
21 #include <linux/vmalloc.h>
26 #define kenter(FMT, ...) \
27 printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
28 #define kleave(FMT, ...) \
29 printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
30 #define kdebug(FMT, ...) \
31 printk(KERN_DEBUG " "FMT"\n", ##__VA_ARGS__)
33 #define kenter(FMT, ...) \
34 no_printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
35 #define kleave(FMT, ...) \
36 no_printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
37 #define kdebug(FMT, ...) \
38 no_printk(KERN_DEBUG FMT"\n", ##__VA_ARGS__)
41 extern struct key_type key_type_dead;
42 extern struct key_type key_type_user;
43 extern struct key_type key_type_logon;
45 /*****************************************************************************/
47 * Keep track of keys for a user.
49 * This needs to be separate to user_struct to avoid a refcount-loop
50 * (user_struct pins some keyrings which pin this struct).
52 * We also keep track of keys under request from userspace for this UID here.
56 struct mutex cons_lock; /* construction initiation lock */
58 refcount_t usage; /* for accessing qnkeys & qnbytes */
59 atomic_t nkeys; /* number of keys */
60 atomic_t nikeys; /* number of instantiated keys */
62 int qnkeys; /* number of keys allocated to this user */
63 int qnbytes; /* number of bytes allocated to this user */
66 extern struct rb_root key_user_tree;
67 extern spinlock_t key_user_lock;
68 extern struct key_user root_key_user;
70 extern struct key_user *key_user_lookup(kuid_t uid);
71 extern void key_user_put(struct key_user *user);
75 * - root has its own separate limits to everyone else
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;
82 #define KEYQUOTA_LINK_BYTES 4 /* a link in a keyring is worth 4 bytes */
85 extern struct kmem_cache *key_jar;
86 extern struct rb_root key_serial_tree;
87 extern spinlock_t key_serial_lock;
88 extern struct mutex key_construction_mutex;
89 extern wait_queue_head_t request_key_conswq;
91 extern void key_set_index_key(struct keyring_index_key *index_key);
92 extern struct key_type *key_type_lookup(const char *type);
93 extern void key_type_put(struct key_type *ktype);
95 extern int __key_link_lock(struct key *keyring,
96 const struct keyring_index_key *index_key);
97 extern int __key_move_lock(struct key *l_keyring, struct key *u_keyring,
98 const struct keyring_index_key *index_key);
99 extern int __key_link_begin(struct key *keyring,
100 const struct keyring_index_key *index_key,
101 struct assoc_array_edit **_edit);
102 extern int __key_link_check_live_key(struct key *keyring, struct key *key);
103 extern void __key_link(struct key *keyring, struct key *key,
104 struct assoc_array_edit **_edit);
105 extern void __key_link_end(struct key *keyring,
106 const struct keyring_index_key *index_key,
107 struct assoc_array_edit *edit);
109 extern key_ref_t find_key_to_update(key_ref_t keyring_ref,
110 const struct keyring_index_key *index_key);
112 extern struct key *keyring_search_instkey(struct key *keyring,
113 key_serial_t target_id);
115 extern int iterate_over_keyring(const struct key *keyring,
116 int (*func)(const struct key *key, void *data),
119 struct keyring_search_context {
120 struct keyring_index_key index_key;
121 const struct cred *cred;
122 struct key_match_data match_data;
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 */
129 #define KEYRING_SEARCH_SKIP_EXPIRED 0x0020 /* Ignore expired keys (intention to replace) */
130 #define KEYRING_SEARCH_RECURSE 0x0040 /* Search child keyrings also */
132 int (*iterator)(const void *object, void *iterator_data);
141 extern bool key_default_cmp(const struct key *key,
142 const struct key_match_data *match_data);
143 extern key_ref_t keyring_search_rcu(key_ref_t keyring_ref,
144 struct keyring_search_context *ctx);
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);
149 extern struct key *find_keyring_by_name(const char *name, bool uid_keyring);
151 extern int look_up_user_keyrings(struct key **, struct key **);
152 extern struct key *get_user_session_keyring_rcu(const struct cred *);
153 extern int install_thread_keyring_to_cred(struct cred *);
154 extern int install_process_keyring_to_cred(struct cred *);
155 extern int install_session_keyring_to_cred(struct cred *, struct key *);
157 extern struct key *request_key_and_link(struct key_type *type,
158 const char *description,
159 struct key_tag *domain_tag,
160 const void *callout_info,
163 struct key *dest_keyring,
164 unsigned long flags);
166 extern bool lookup_user_key_possessed(const struct key *key,
167 const struct key_match_data *match_data);
168 #define KEY_LOOKUP_CREATE 0x01
169 #define KEY_LOOKUP_PARTIAL 0x02
171 extern long join_session_keyring(const char *name);
172 extern void key_change_session_keyring(struct callback_head *twork);
174 extern struct work_struct key_gc_work;
175 extern unsigned key_gc_delay;
176 extern void keyring_gc(struct key *keyring, time64_t limit);
177 extern void keyring_restriction_gc(struct key *keyring,
178 struct key_type *dead_type);
179 void key_set_expiry(struct key *key, time64_t expiry);
180 extern void key_schedule_gc(time64_t gc_at);
181 extern void key_schedule_gc_links(void);
182 extern void key_gc_keytype(struct key_type *ktype);
184 extern int key_task_permission(const key_ref_t key_ref,
185 const struct cred *cred,
186 enum key_need_perm need_perm);
188 static inline void notify_key(struct key *key,
189 enum key_notification_subtype subtype, u32 aux)
191 #ifdef CONFIG_KEY_NOTIFICATIONS
192 struct key_notification n = {
193 .watch.type = WATCH_TYPE_KEY_NOTIFY,
194 .watch.subtype = subtype,
195 .watch.info = watch_sizeof(n),
196 .key_id = key_serial(key),
200 post_watch_notification(key->watchers, &n.watch, current_cred(),
206 * Check to see whether permission is granted to use a key in the desired way.
208 static inline int key_permission(const key_ref_t key_ref,
209 enum key_need_perm need_perm)
211 return key_task_permission(key_ref, current_cred(), need_perm);
214 extern struct key_type key_type_request_key_auth;
215 extern struct key *request_key_auth_new(struct key *target,
217 const void *callout_info,
219 struct key *dest_keyring);
221 extern struct key *key_get_instantiation_authkey(key_serial_t target_id);
224 * Determine whether a key is dead.
226 static inline bool key_is_dead(const struct key *key, time64_t limit)
228 time64_t expiry = key->expiry;
230 if (expiry != TIME64_MAX) {
231 if (!(key->type->flags & KEY_TYPE_INSTANT_REAP))
232 expiry += key_gc_delay;
238 key->flags & ((1 << KEY_FLAG_DEAD) |
239 (1 << KEY_FLAG_INVALIDATED)) ||
240 key->domain_tag->removed;
246 extern long keyctl_get_keyring_ID(key_serial_t, int);
247 extern long keyctl_join_session_keyring(const char __user *);
248 extern long keyctl_update_key(key_serial_t, const void __user *, size_t);
249 extern long keyctl_revoke_key(key_serial_t);
250 extern long keyctl_keyring_clear(key_serial_t);
251 extern long keyctl_keyring_link(key_serial_t, key_serial_t);
252 extern long keyctl_keyring_move(key_serial_t, key_serial_t, key_serial_t, unsigned int);
253 extern long keyctl_keyring_unlink(key_serial_t, key_serial_t);
254 extern long keyctl_describe_key(key_serial_t, char __user *, size_t);
255 extern long keyctl_keyring_search(key_serial_t, const char __user *,
256 const char __user *, key_serial_t);
257 extern long keyctl_read_key(key_serial_t, char __user *, size_t);
258 extern long keyctl_chown_key(key_serial_t, uid_t, gid_t);
259 extern long keyctl_setperm_key(key_serial_t, key_perm_t);
260 extern long keyctl_instantiate_key(key_serial_t, const void __user *,
261 size_t, key_serial_t);
262 extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t);
263 extern long keyctl_set_reqkey_keyring(int);
264 extern long keyctl_set_timeout(key_serial_t, unsigned);
265 extern long keyctl_assume_authority(key_serial_t);
266 extern long keyctl_get_security(key_serial_t keyid, char __user *buffer,
268 extern long keyctl_session_to_parent(void);
269 extern long keyctl_reject_key(key_serial_t, unsigned, unsigned, key_serial_t);
270 extern long keyctl_instantiate_key_iov(key_serial_t,
271 const struct iovec __user *,
272 unsigned, key_serial_t);
273 extern long keyctl_invalidate_key(key_serial_t);
274 extern long keyctl_restrict_keyring(key_serial_t id,
275 const char __user *_type,
276 const char __user *_restriction);
277 #ifdef CONFIG_PERSISTENT_KEYRINGS
278 extern long keyctl_get_persistent(uid_t, key_serial_t);
279 extern unsigned persistent_keyring_expiry;
281 static inline long keyctl_get_persistent(uid_t uid, key_serial_t destring)
287 #ifdef CONFIG_KEY_DH_OPERATIONS
288 extern long keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *,
289 size_t, struct keyctl_kdf_params __user *);
290 extern long __keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *,
291 size_t, struct keyctl_kdf_params *);
293 extern long compat_keyctl_dh_compute(struct keyctl_dh_params __user *params,
294 char __user *buffer, size_t buflen,
295 struct compat_keyctl_kdf_params __user *kdf);
297 #define KEYCTL_KDF_MAX_OUTPUT_LEN 1024 /* max length of KDF output */
298 #define KEYCTL_KDF_MAX_OI_LEN 64 /* max length of otherinfo */
300 static inline long keyctl_dh_compute(struct keyctl_dh_params __user *params,
301 char __user *buffer, size_t buflen,
302 struct keyctl_kdf_params __user *kdf)
308 static inline long compat_keyctl_dh_compute(
309 struct keyctl_dh_params __user *params,
310 char __user *buffer, size_t buflen,
311 struct keyctl_kdf_params __user *kdf)
318 #ifdef CONFIG_ASYMMETRIC_KEY_TYPE
319 extern long keyctl_pkey_query(key_serial_t,
321 struct keyctl_pkey_query __user *);
323 extern long keyctl_pkey_verify(const struct keyctl_pkey_params __user *,
325 const void __user *, const void __user *);
327 extern long keyctl_pkey_e_d_s(int,
328 const struct keyctl_pkey_params __user *,
330 const void __user *, void __user *);
332 static inline long keyctl_pkey_query(key_serial_t id,
333 const char __user *_info,
334 struct keyctl_pkey_query __user *_res)
339 static inline long keyctl_pkey_verify(const struct keyctl_pkey_params __user *params,
340 const char __user *_info,
341 const void __user *_in,
342 const void __user *_in2)
347 static inline long keyctl_pkey_e_d_s(int op,
348 const struct keyctl_pkey_params __user *params,
349 const char __user *_info,
350 const void __user *_in,
357 extern long keyctl_capabilities(unsigned char __user *_buffer, size_t buflen);
359 #ifdef CONFIG_KEY_NOTIFICATIONS
360 extern long keyctl_watch_key(key_serial_t, int, int);
362 static inline long keyctl_watch_key(key_serial_t key_id, int watch_fd, int watch_id)
369 * Debugging key validation
372 extern void __key_check(const struct key *);
374 static inline void key_check(const struct key *key)
376 if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC))
382 #define key_check(key) do {} while(0)
385 #endif /* _INTERNAL_H */