Loading...
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/* Authentication token and access key management internal defs
3 *
4 * Copyright (C) 2003-5, 2007 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
6 */
7
8#ifndef _INTERNAL_H
9#define _INTERNAL_H
10
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>
20#include <linux/mm.h>
21#include <linux/vmalloc.h>
22
23struct iovec;
24
25#ifdef __KDEBUG
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__)
32#else
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__)
39#endif
40
41extern struct key_type key_type_dead;
42extern struct key_type key_type_user;
43extern struct key_type key_type_logon;
44
45/*****************************************************************************/
46/*
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.
53 */
54struct key_user {
55 struct rb_node node;
56 struct mutex cons_lock; /* construction initiation lock */
57 spinlock_t lock;
58 refcount_t usage; /* for accessing qnkeys & qnbytes */
59 atomic_t nkeys; /* number of keys */
60 atomic_t nikeys; /* number of instantiated keys */
61 kuid_t uid;
62 int qnkeys; /* number of keys allocated to this user */
63 int qnbytes; /* number of bytes allocated to this user */
64};
65
66extern struct rb_root key_user_tree;
67extern spinlock_t key_user_lock;
68extern struct key_user root_key_user;
69
70extern struct key_user *key_user_lookup(kuid_t uid);
71extern void key_user_put(struct key_user *user);
72
73/*
74 * Key quota limits.
75 * - root has its own separate limits to everyone else
76 */
77extern unsigned key_quota_root_maxkeys;
78extern unsigned key_quota_root_maxbytes;
79extern unsigned key_quota_maxkeys;
80extern unsigned key_quota_maxbytes;
81
82#define KEYQUOTA_LINK_BYTES 4 /* a link in a keyring is worth 4 bytes */
83
84
85extern struct kmem_cache *key_jar;
86extern struct rb_root key_serial_tree;
87extern spinlock_t key_serial_lock;
88extern struct mutex key_construction_mutex;
89extern wait_queue_head_t request_key_conswq;
90
91extern void key_set_index_key(struct keyring_index_key *index_key);
92extern struct key_type *key_type_lookup(const char *type);
93extern void key_type_put(struct key_type *ktype);
94
95extern int __key_link_lock(struct key *keyring,
96 const struct keyring_index_key *index_key);
97extern int __key_move_lock(struct key *l_keyring, struct key *u_keyring,
98 const struct keyring_index_key *index_key);
99extern int __key_link_begin(struct key *keyring,
100 const struct keyring_index_key *index_key,
101 struct assoc_array_edit **_edit);
102extern int __key_link_check_live_key(struct key *keyring, struct key *key);
103extern void __key_link(struct key *keyring, struct key *key,
104 struct assoc_array_edit **_edit);
105extern void __key_link_end(struct key *keyring,
106 const struct keyring_index_key *index_key,
107 struct assoc_array_edit *edit);
108
109extern key_ref_t find_key_to_update(key_ref_t keyring_ref,
110 const struct keyring_index_key *index_key);
111
112extern struct key *keyring_search_instkey(struct key *keyring,
113 key_serial_t target_id);
114
115extern int iterate_over_keyring(const struct key *keyring,
116 int (*func)(const struct key *key, void *data),
117 void *data);
118
119struct keyring_search_context {
120 struct keyring_index_key index_key;
121 const struct cred *cred;
122 struct key_match_data match_data;
123 unsigned flags;
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 */
131
132 int (*iterator)(const void *object, void *iterator_data);
133
134 /* Internal stuff */
135 int skipped_ret;
136 bool possessed;
137 key_ref_t result;
138 time64_t now;
139};
140
141extern bool key_default_cmp(const struct key *key,
142 const struct key_match_data *match_data);
143extern key_ref_t keyring_search_rcu(key_ref_t keyring_ref,
144 struct keyring_search_context *ctx);
145
146extern key_ref_t search_cred_keyrings_rcu(struct keyring_search_context *ctx);
147extern key_ref_t search_process_keyrings_rcu(struct keyring_search_context *ctx);
148
149extern struct key *find_keyring_by_name(const char *name, bool uid_keyring);
150
151extern int look_up_user_keyrings(struct key **, struct key **);
152extern struct key *get_user_session_keyring_rcu(const struct cred *);
153extern int install_thread_keyring_to_cred(struct cred *);
154extern int install_process_keyring_to_cred(struct cred *);
155extern int install_session_keyring_to_cred(struct cred *, struct key *);
156
157extern 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,
161 size_t callout_len,
162 void *aux,
163 struct key *dest_keyring,
164 unsigned long flags);
165
166extern 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
170
171extern long join_session_keyring(const char *name);
172extern void key_change_session_keyring(struct callback_head *twork);
173
174extern struct work_struct key_gc_work;
175extern unsigned key_gc_delay;
176extern void keyring_gc(struct key *keyring, time64_t limit);
177extern void keyring_restriction_gc(struct key *keyring,
178 struct key_type *dead_type);
179extern void key_schedule_gc(time64_t gc_at);
180extern void key_schedule_gc_links(void);
181extern void key_gc_keytype(struct key_type *ktype);
182
183extern int key_task_permission(const key_ref_t key_ref,
184 const struct cred *cred,
185 enum key_need_perm need_perm);
186
187static 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}
203
204/*
205 * Check to see whether permission is granted to use a key in the desired way.
206 */
207static inline int key_permission(const key_ref_t key_ref,
208 enum key_need_perm need_perm)
209{
210 return key_task_permission(key_ref, current_cred(), need_perm);
211}
212
213extern struct key_type key_type_request_key_auth;
214extern struct key *request_key_auth_new(struct key *target,
215 const char *op,
216 const void *callout_info,
217 size_t callout_len,
218 struct key *dest_keyring);
219
220extern struct key *key_get_instantiation_authkey(key_serial_t target_id);
221
222/*
223 * Determine whether a key is dead.
224 */
225static inline bool key_is_dead(const struct key *key, time64_t limit)
226{
227 return
228 key->flags & ((1 << KEY_FLAG_DEAD) |
229 (1 << KEY_FLAG_INVALIDATED)) ||
230 (key->expiry > 0 && key->expiry <= limit) ||
231 key->domain_tag->removed;
232}
233
234/*
235 * keyctl() functions
236 */
237extern long keyctl_get_keyring_ID(key_serial_t, int);
238extern long keyctl_join_session_keyring(const char __user *);
239extern long keyctl_update_key(key_serial_t, const void __user *, size_t);
240extern long keyctl_revoke_key(key_serial_t);
241extern long keyctl_keyring_clear(key_serial_t);
242extern long keyctl_keyring_link(key_serial_t, key_serial_t);
243extern long keyctl_keyring_move(key_serial_t, key_serial_t, key_serial_t, unsigned int);
244extern long keyctl_keyring_unlink(key_serial_t, key_serial_t);
245extern long keyctl_describe_key(key_serial_t, char __user *, size_t);
246extern long keyctl_keyring_search(key_serial_t, const char __user *,
247 const char __user *, key_serial_t);
248extern long keyctl_read_key(key_serial_t, char __user *, size_t);
249extern long keyctl_chown_key(key_serial_t, uid_t, gid_t);
250extern long keyctl_setperm_key(key_serial_t, key_perm_t);
251extern long keyctl_instantiate_key(key_serial_t, const void __user *,
252 size_t, key_serial_t);
253extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t);
254extern long keyctl_set_reqkey_keyring(int);
255extern long keyctl_set_timeout(key_serial_t, unsigned);
256extern long keyctl_assume_authority(key_serial_t);
257extern long keyctl_get_security(key_serial_t keyid, char __user *buffer,
258 size_t buflen);
259extern long keyctl_session_to_parent(void);
260extern long keyctl_reject_key(key_serial_t, unsigned, unsigned, key_serial_t);
261extern long keyctl_instantiate_key_iov(key_serial_t,
262 const struct iovec __user *,
263 unsigned, key_serial_t);
264extern long keyctl_invalidate_key(key_serial_t);
265
266struct iov_iter;
267extern long keyctl_instantiate_key_common(key_serial_t,
268 struct iov_iter *,
269 key_serial_t);
270extern long keyctl_restrict_keyring(key_serial_t id,
271 const char __user *_type,
272 const char __user *_restriction);
273#ifdef CONFIG_PERSISTENT_KEYRINGS
274extern long keyctl_get_persistent(uid_t, key_serial_t);
275extern unsigned persistent_keyring_expiry;
276#else
277static inline long keyctl_get_persistent(uid_t uid, key_serial_t destring)
278{
279 return -EOPNOTSUPP;
280}
281#endif
282
283#ifdef CONFIG_KEY_DH_OPERATIONS
284extern long keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *,
285 size_t, struct keyctl_kdf_params __user *);
286extern long __keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *,
287 size_t, struct keyctl_kdf_params *);
288#ifdef CONFIG_COMPAT
289extern long compat_keyctl_dh_compute(struct keyctl_dh_params __user *params,
290 char __user *buffer, size_t buflen,
291 struct compat_keyctl_kdf_params __user *kdf);
292#endif
293#define KEYCTL_KDF_MAX_OUTPUT_LEN 1024 /* max length of KDF output */
294#define KEYCTL_KDF_MAX_OI_LEN 64 /* max length of otherinfo */
295#else
296static inline long keyctl_dh_compute(struct keyctl_dh_params __user *params,
297 char __user *buffer, size_t buflen,
298 struct keyctl_kdf_params __user *kdf)
299{
300 return -EOPNOTSUPP;
301}
302
303#ifdef CONFIG_COMPAT
304static inline long compat_keyctl_dh_compute(
305 struct keyctl_dh_params __user *params,
306 char __user *buffer, size_t buflen,
307 struct keyctl_kdf_params __user *kdf)
308{
309 return -EOPNOTSUPP;
310}
311#endif
312#endif
313
314#ifdef CONFIG_ASYMMETRIC_KEY_TYPE
315extern long keyctl_pkey_query(key_serial_t,
316 const char __user *,
317 struct keyctl_pkey_query __user *);
318
319extern long keyctl_pkey_verify(const struct keyctl_pkey_params __user *,
320 const char __user *,
321 const void __user *, const void __user *);
322
323extern long keyctl_pkey_e_d_s(int,
324 const struct keyctl_pkey_params __user *,
325 const char __user *,
326 const void __user *, void __user *);
327#else
328static inline long keyctl_pkey_query(key_serial_t id,
329 const char __user *_info,
330 struct keyctl_pkey_query __user *_res)
331{
332 return -EOPNOTSUPP;
333}
334
335static inline long keyctl_pkey_verify(const struct keyctl_pkey_params __user *params,
336 const char __user *_info,
337 const void __user *_in,
338 const void __user *_in2)
339{
340 return -EOPNOTSUPP;
341}
342
343static inline long keyctl_pkey_e_d_s(int op,
344 const struct keyctl_pkey_params __user *params,
345 const char __user *_info,
346 const void __user *_in,
347 void __user *_out)
348{
349 return -EOPNOTSUPP;
350}
351#endif
352
353extern long keyctl_capabilities(unsigned char __user *_buffer, size_t buflen);
354
355#ifdef CONFIG_KEY_NOTIFICATIONS
356extern long keyctl_watch_key(key_serial_t, int, int);
357#else
358static inline long keyctl_watch_key(key_serial_t key_id, int watch_fd, int watch_id)
359{
360 return -EOPNOTSUPP;
361}
362#endif
363
364/*
365 * Debugging key validation
366 */
367#ifdef KEY_DEBUGGING
368extern void __key_check(const struct key *);
369
370static inline void key_check(const struct key *key)
371{
372 if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC))
373 __key_check(key);
374}
375
376#else
377
378#define key_check(key) do {} while(0)
379
380#endif
381#endif /* _INTERNAL_H */
1/* Authentication token and access key management internal defs
2 *
3 * Copyright (C) 2003-5, 2007 Red Hat, Inc. All Rights Reserved.
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
15#include <linux/sched.h>
16#include <linux/key-type.h>
17
18#ifdef __KDEBUG
19#define kenter(FMT, ...) \
20 printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
21#define kleave(FMT, ...) \
22 printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
23#define kdebug(FMT, ...) \
24 printk(KERN_DEBUG " "FMT"\n", ##__VA_ARGS__)
25#else
26#define kenter(FMT, ...) \
27 no_printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
28#define kleave(FMT, ...) \
29 no_printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
30#define kdebug(FMT, ...) \
31 no_printk(KERN_DEBUG FMT"\n", ##__VA_ARGS__)
32#endif
33
34extern struct key_type key_type_user;
35
36/*****************************************************************************/
37/*
38 * Keep track of keys for a user.
39 *
40 * This needs to be separate to user_struct to avoid a refcount-loop
41 * (user_struct pins some keyrings which pin this struct).
42 *
43 * We also keep track of keys under request from userspace for this UID here.
44 */
45struct key_user {
46 struct rb_node node;
47 struct mutex cons_lock; /* construction initiation lock */
48 spinlock_t lock;
49 atomic_t usage; /* for accessing qnkeys & qnbytes */
50 atomic_t nkeys; /* number of keys */
51 atomic_t nikeys; /* number of instantiated keys */
52 uid_t uid;
53 struct user_namespace *user_ns;
54 int qnkeys; /* number of keys allocated to this user */
55 int qnbytes; /* number of bytes allocated to this user */
56};
57
58extern struct rb_root key_user_tree;
59extern spinlock_t key_user_lock;
60extern struct key_user root_key_user;
61
62extern struct key_user *key_user_lookup(uid_t uid,
63 struct user_namespace *user_ns);
64extern void key_user_put(struct key_user *user);
65
66/*
67 * Key quota limits.
68 * - root has its own separate limits to everyone else
69 */
70extern unsigned key_quota_root_maxkeys;
71extern unsigned key_quota_root_maxbytes;
72extern unsigned key_quota_maxkeys;
73extern unsigned key_quota_maxbytes;
74
75#define KEYQUOTA_LINK_BYTES 4 /* a link in a keyring is worth 4 bytes */
76
77
78extern struct rb_root key_serial_tree;
79extern spinlock_t key_serial_lock;
80extern struct mutex key_construction_mutex;
81extern wait_queue_head_t request_key_conswq;
82
83
84extern struct key_type *key_type_lookup(const char *type);
85extern void key_type_put(struct key_type *ktype);
86
87extern int __key_link_begin(struct key *keyring,
88 const struct key_type *type,
89 const char *description,
90 unsigned long *_prealloc);
91extern int __key_link_check_live_key(struct key *keyring, struct key *key);
92extern void __key_link(struct key *keyring, struct key *key,
93 unsigned long *_prealloc);
94extern void __key_link_end(struct key *keyring,
95 struct key_type *type,
96 unsigned long prealloc);
97
98extern key_ref_t __keyring_search_one(key_ref_t keyring_ref,
99 const struct key_type *type,
100 const char *description,
101 key_perm_t perm);
102
103extern struct key *keyring_search_instkey(struct key *keyring,
104 key_serial_t target_id);
105
106typedef int (*key_match_func_t)(const struct key *, const void *);
107
108extern key_ref_t keyring_search_aux(key_ref_t keyring_ref,
109 const struct cred *cred,
110 struct key_type *type,
111 const void *description,
112 key_match_func_t match,
113 bool no_state_check);
114
115extern key_ref_t search_my_process_keyrings(struct key_type *type,
116 const void *description,
117 key_match_func_t match,
118 bool no_state_check,
119 const struct cred *cred);
120extern key_ref_t search_process_keyrings(struct key_type *type,
121 const void *description,
122 key_match_func_t match,
123 const struct cred *cred);
124
125extern struct key *find_keyring_by_name(const char *name, bool skip_perm_check);
126
127extern int install_user_keyrings(void);
128extern int install_thread_keyring_to_cred(struct cred *);
129extern int install_process_keyring_to_cred(struct cred *);
130extern int install_session_keyring_to_cred(struct cred *, struct key *);
131
132extern struct key *request_key_and_link(struct key_type *type,
133 const char *description,
134 const void *callout_info,
135 size_t callout_len,
136 void *aux,
137 struct key *dest_keyring,
138 unsigned long flags);
139
140extern int lookup_user_key_possessed(const struct key *key, const void *target);
141extern key_ref_t lookup_user_key(key_serial_t id, unsigned long flags,
142 key_perm_t perm);
143#define KEY_LOOKUP_CREATE 0x01
144#define KEY_LOOKUP_PARTIAL 0x02
145#define KEY_LOOKUP_FOR_UNLINK 0x04
146
147extern long join_session_keyring(const char *name);
148
149extern unsigned key_gc_delay;
150extern void keyring_gc(struct key *keyring, time_t limit);
151extern void key_schedule_gc(time_t expiry_at);
152
153extern int key_task_permission(const key_ref_t key_ref,
154 const struct cred *cred,
155 key_perm_t perm);
156
157/*
158 * Check to see whether permission is granted to use a key in the desired way.
159 */
160static inline int key_permission(const key_ref_t key_ref, key_perm_t perm)
161{
162 return key_task_permission(key_ref, current_cred(), perm);
163}
164
165/* required permissions */
166#define KEY_VIEW 0x01 /* require permission to view attributes */
167#define KEY_READ 0x02 /* require permission to read content */
168#define KEY_WRITE 0x04 /* require permission to update / modify */
169#define KEY_SEARCH 0x08 /* require permission to search (keyring) or find (key) */
170#define KEY_LINK 0x10 /* require permission to link */
171#define KEY_SETATTR 0x20 /* require permission to change attributes */
172#define KEY_ALL 0x3f /* all the above permissions */
173
174/*
175 * Authorisation record for request_key().
176 */
177struct request_key_auth {
178 struct key *target_key;
179 struct key *dest_keyring;
180 const struct cred *cred;
181 void *callout_info;
182 size_t callout_len;
183 pid_t pid;
184};
185
186extern struct key_type key_type_request_key_auth;
187extern struct key *request_key_auth_new(struct key *target,
188 const void *callout_info,
189 size_t callout_len,
190 struct key *dest_keyring);
191
192extern struct key *key_get_instantiation_authkey(key_serial_t target_id);
193
194/*
195 * keyctl() functions
196 */
197extern long keyctl_get_keyring_ID(key_serial_t, int);
198extern long keyctl_join_session_keyring(const char __user *);
199extern long keyctl_update_key(key_serial_t, const void __user *, size_t);
200extern long keyctl_revoke_key(key_serial_t);
201extern long keyctl_keyring_clear(key_serial_t);
202extern long keyctl_keyring_link(key_serial_t, key_serial_t);
203extern long keyctl_keyring_unlink(key_serial_t, key_serial_t);
204extern long keyctl_describe_key(key_serial_t, char __user *, size_t);
205extern long keyctl_keyring_search(key_serial_t, const char __user *,
206 const char __user *, key_serial_t);
207extern long keyctl_read_key(key_serial_t, char __user *, size_t);
208extern long keyctl_chown_key(key_serial_t, uid_t, gid_t);
209extern long keyctl_setperm_key(key_serial_t, key_perm_t);
210extern long keyctl_instantiate_key(key_serial_t, const void __user *,
211 size_t, key_serial_t);
212extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t);
213extern long keyctl_set_reqkey_keyring(int);
214extern long keyctl_set_timeout(key_serial_t, unsigned);
215extern long keyctl_assume_authority(key_serial_t);
216extern long keyctl_get_security(key_serial_t keyid, char __user *buffer,
217 size_t buflen);
218extern long keyctl_session_to_parent(void);
219extern long keyctl_reject_key(key_serial_t, unsigned, unsigned, key_serial_t);
220extern long keyctl_instantiate_key_iov(key_serial_t,
221 const struct iovec __user *,
222 unsigned, key_serial_t);
223
224extern long keyctl_instantiate_key_common(key_serial_t,
225 const struct iovec __user *,
226 unsigned, size_t, key_serial_t);
227
228/*
229 * Debugging key validation
230 */
231#ifdef KEY_DEBUGGING
232extern void __key_check(const struct key *);
233
234static inline void key_check(const struct key *key)
235{
236 if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC))
237 __key_check(key);
238}
239
240#else
241
242#define key_check(key) do {} while(0)
243
244#endif
245
246#endif /* _INTERNAL_H */