tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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/wait_bit.h>
17#include <linux/cred.h>
18#include <linux/key-type.h>
19#include <linux/task_work.h>
20#include <linux/keyctl.h>
21#include <linux/refcount.h>
22#include <linux/compat.h>
23
24struct iovec;
25
26#ifdef __KDEBUG
27#define kenter(FMT, ...) \
28 printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
29#define kleave(FMT, ...) \
30 printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
31#define kdebug(FMT, ...) \
32 printk(KERN_DEBUG " "FMT"\n", ##__VA_ARGS__)
33#else
34#define kenter(FMT, ...) \
35 no_printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
36#define kleave(FMT, ...) \
37 no_printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
38#define kdebug(FMT, ...) \
39 no_printk(KERN_DEBUG FMT"\n", ##__VA_ARGS__)
40#endif
41
42extern struct key_type key_type_dead;
43extern struct key_type key_type_user;
44extern struct key_type key_type_logon;
45
46/*****************************************************************************/
47/*
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.
54 */
55struct key_user {
56 struct rb_node node;
57 struct mutex cons_lock; /* construction initiation lock */
58 spinlock_t lock;
59 refcount_t usage; /* for accessing qnkeys & qnbytes */
60 atomic_t nkeys; /* number of keys */
61 atomic_t nikeys; /* number of instantiated keys */
62 kuid_t uid;
63 int qnkeys; /* number of keys allocated to this user */
64 int qnbytes; /* number of bytes allocated to this user */
65};
66
67extern struct rb_root key_user_tree;
68extern spinlock_t key_user_lock;
69extern struct key_user root_key_user;
70
71extern struct key_user *key_user_lookup(kuid_t uid);
72extern void key_user_put(struct key_user *user);
73
74/*
75 * Key quota limits.
76 * - root has its own separate limits to everyone else
77 */
78extern unsigned key_quota_root_maxkeys;
79extern unsigned key_quota_root_maxbytes;
80extern unsigned key_quota_maxkeys;
81extern unsigned key_quota_maxbytes;
82
83#define KEYQUOTA_LINK_BYTES 4 /* a link in a keyring is worth 4 bytes */
84
85
86extern struct kmem_cache *key_jar;
87extern struct rb_root key_serial_tree;
88extern spinlock_t key_serial_lock;
89extern struct mutex key_construction_mutex;
90extern wait_queue_head_t request_key_conswq;
91
92
93extern struct key_type *key_type_lookup(const char *type);
94extern void key_type_put(struct key_type *ktype);
95
96extern int __key_link_begin(struct key *keyring,
97 const struct keyring_index_key *index_key,
98 struct assoc_array_edit **_edit);
99extern int __key_link_check_live_key(struct key *keyring, struct key *key);
100extern void __key_link(struct key *key, struct assoc_array_edit **_edit);
101extern void __key_link_end(struct key *keyring,
102 const struct keyring_index_key *index_key,
103 struct assoc_array_edit *edit);
104
105extern key_ref_t find_key_to_update(key_ref_t keyring_ref,
106 const struct keyring_index_key *index_key);
107
108extern struct key *keyring_search_instkey(struct key *keyring,
109 key_serial_t target_id);
110
111extern int iterate_over_keyring(const struct key *keyring,
112 int (*func)(const struct key *key, void *data),
113 void *data);
114
115struct keyring_search_context {
116 struct keyring_index_key index_key;
117 const struct cred *cred;
118 struct key_match_data match_data;
119 unsigned flags;
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) */
126
127 int (*iterator)(const void *object, void *iterator_data);
128
129 /* Internal stuff */
130 int skipped_ret;
131 bool possessed;
132 key_ref_t result;
133 time64_t now;
134};
135
136extern bool key_default_cmp(const struct key *key,
137 const struct key_match_data *match_data);
138extern key_ref_t keyring_search_aux(key_ref_t keyring_ref,
139 struct keyring_search_context *ctx);
140
141extern key_ref_t search_my_process_keyrings(struct keyring_search_context *ctx);
142extern key_ref_t search_process_keyrings(struct keyring_search_context *ctx);
143
144extern struct key *find_keyring_by_name(const char *name, bool uid_keyring);
145
146extern int install_user_keyrings(void);
147extern int install_thread_keyring_to_cred(struct cred *);
148extern int install_process_keyring_to_cred(struct cred *);
149extern int install_session_keyring_to_cred(struct cred *, struct key *);
150
151extern struct key *request_key_and_link(struct key_type *type,
152 const char *description,
153 const void *callout_info,
154 size_t callout_len,
155 void *aux,
156 struct key *dest_keyring,
157 unsigned long flags);
158
159extern 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
164
165extern long join_session_keyring(const char *name);
166extern void key_change_session_keyring(struct callback_head *twork);
167
168extern struct work_struct key_gc_work;
169extern unsigned key_gc_delay;
170extern void keyring_gc(struct key *keyring, time64_t limit);
171extern void keyring_restriction_gc(struct key *keyring,
172 struct key_type *dead_type);
173extern void key_schedule_gc(time64_t gc_at);
174extern void key_schedule_gc_links(void);
175extern void key_gc_keytype(struct key_type *ktype);
176
177extern int key_task_permission(const key_ref_t key_ref,
178 const struct cred *cred,
179 key_perm_t perm);
180
181/*
182 * Check to see whether permission is granted to use a key in the desired way.
183 */
184static inline int key_permission(const key_ref_t key_ref, unsigned perm)
185{
186 return key_task_permission(key_ref, current_cred(), perm);
187}
188
189extern struct key_type key_type_request_key_auth;
190extern struct key *request_key_auth_new(struct key *target,
191 const char *op,
192 const void *callout_info,
193 size_t callout_len,
194 struct key *dest_keyring);
195
196extern struct key *key_get_instantiation_authkey(key_serial_t target_id);
197
198/*
199 * Determine whether a key is dead.
200 */
201static inline bool key_is_dead(const struct key *key, time64_t limit)
202{
203 return
204 key->flags & ((1 << KEY_FLAG_DEAD) |
205 (1 << KEY_FLAG_INVALIDATED)) ||
206 (key->expiry > 0 && key->expiry <= limit);
207}
208
209/*
210 * keyctl() functions
211 */
212extern long keyctl_get_keyring_ID(key_serial_t, int);
213extern long keyctl_join_session_keyring(const char __user *);
214extern long keyctl_update_key(key_serial_t, const void __user *, size_t);
215extern long keyctl_revoke_key(key_serial_t);
216extern long keyctl_keyring_clear(key_serial_t);
217extern long keyctl_keyring_link(key_serial_t, key_serial_t);
218extern long keyctl_keyring_unlink(key_serial_t, key_serial_t);
219extern long keyctl_describe_key(key_serial_t, char __user *, size_t);
220extern long keyctl_keyring_search(key_serial_t, const char __user *,
221 const char __user *, key_serial_t);
222extern long keyctl_read_key(key_serial_t, char __user *, size_t);
223extern long keyctl_chown_key(key_serial_t, uid_t, gid_t);
224extern long keyctl_setperm_key(key_serial_t, key_perm_t);
225extern long keyctl_instantiate_key(key_serial_t, const void __user *,
226 size_t, key_serial_t);
227extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t);
228extern long keyctl_set_reqkey_keyring(int);
229extern long keyctl_set_timeout(key_serial_t, unsigned);
230extern long keyctl_assume_authority(key_serial_t);
231extern long keyctl_get_security(key_serial_t keyid, char __user *buffer,
232 size_t buflen);
233extern long keyctl_session_to_parent(void);
234extern long keyctl_reject_key(key_serial_t, unsigned, unsigned, key_serial_t);
235extern long keyctl_instantiate_key_iov(key_serial_t,
236 const struct iovec __user *,
237 unsigned, key_serial_t);
238extern long keyctl_invalidate_key(key_serial_t);
239
240struct iov_iter;
241extern long keyctl_instantiate_key_common(key_serial_t,
242 struct iov_iter *,
243 key_serial_t);
244extern long keyctl_restrict_keyring(key_serial_t id,
245 const char __user *_type,
246 const char __user *_restriction);
247#ifdef CONFIG_PERSISTENT_KEYRINGS
248extern long keyctl_get_persistent(uid_t, key_serial_t);
249extern unsigned persistent_keyring_expiry;
250#else
251static inline long keyctl_get_persistent(uid_t uid, key_serial_t destring)
252{
253 return -EOPNOTSUPP;
254}
255#endif
256
257#ifdef CONFIG_KEY_DH_OPERATIONS
258extern long keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *,
259 size_t, struct keyctl_kdf_params __user *);
260extern long __keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *,
261 size_t, struct keyctl_kdf_params *);
262#ifdef CONFIG_KEYS_COMPAT
263extern long compat_keyctl_dh_compute(struct keyctl_dh_params __user *params,
264 char __user *buffer, size_t buflen,
265 struct compat_keyctl_kdf_params __user *kdf);
266#endif
267#define KEYCTL_KDF_MAX_OUTPUT_LEN 1024 /* max length of KDF output */
268#define KEYCTL_KDF_MAX_OI_LEN 64 /* max length of otherinfo */
269#else
270static inline long keyctl_dh_compute(struct keyctl_dh_params __user *params,
271 char __user *buffer, size_t buflen,
272 struct keyctl_kdf_params __user *kdf)
273{
274 return -EOPNOTSUPP;
275}
276
277#ifdef CONFIG_KEYS_COMPAT
278static inline long compat_keyctl_dh_compute(
279 struct keyctl_dh_params __user *params,
280 char __user *buffer, size_t buflen,
281 struct keyctl_kdf_params __user *kdf)
282{
283 return -EOPNOTSUPP;
284}
285#endif
286#endif
287
288#ifdef CONFIG_ASYMMETRIC_KEY_TYPE
289extern long keyctl_pkey_query(key_serial_t,
290 const char __user *,
291 struct keyctl_pkey_query __user *);
292
293extern long keyctl_pkey_verify(const struct keyctl_pkey_params __user *,
294 const char __user *,
295 const void __user *, const void __user *);
296
297extern long keyctl_pkey_e_d_s(int,
298 const struct keyctl_pkey_params __user *,
299 const char __user *,
300 const void __user *, void __user *);
301#else
302static inline long keyctl_pkey_query(key_serial_t id,
303 const char __user *_info,
304 struct keyctl_pkey_query __user *_res)
305{
306 return -EOPNOTSUPP;
307}
308
309static inline long keyctl_pkey_verify(const struct keyctl_pkey_params __user *params,
310 const char __user *_info,
311 const void __user *_in,
312 const void __user *_in2)
313{
314 return -EOPNOTSUPP;
315}
316
317static inline long keyctl_pkey_e_d_s(int op,
318 const struct keyctl_pkey_params __user *params,
319 const char __user *_info,
320 const void __user *_in,
321 void __user *_out)
322{
323 return -EOPNOTSUPP;
324}
325#endif
326
327/*
328 * Debugging key validation
329 */
330#ifdef KEY_DEBUGGING
331extern void __key_check(const struct key *);
332
333static inline void key_check(const struct key *key)
334{
335 if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC))
336 __key_check(key);
337}
338
339#else
340
341#define key_check(key) do {} while(0)
342
343#endif
344
345#endif /* _INTERNAL_H */