1 /* Authentication token and access key management internal defs
3 * Copyright (C) 2003-5, 2007 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
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.
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>
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__)
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__)
42 extern struct key_type key_type_dead;
43 extern struct key_type key_type_user;
44 extern struct key_type key_type_logon;
46 /*****************************************************************************/
48 * Keep track of keys for a user.
50 * This needs to be separate to user_struct to avoid a refcount-loop
51 * (user_struct pins some keyrings which pin this struct).
53 * We also keep track of keys under request from userspace for this UID here.
57 struct mutex cons_lock; /* construction initiation lock */
59 refcount_t usage; /* for accessing qnkeys & qnbytes */
60 atomic_t nkeys; /* number of keys */
61 atomic_t nikeys; /* number of instantiated keys */
63 int qnkeys; /* number of keys allocated to this user */
64 int qnbytes; /* number of bytes allocated to this user */
67 extern struct rb_root key_user_tree;
68 extern spinlock_t key_user_lock;
69 extern struct key_user root_key_user;
71 extern struct key_user *key_user_lookup(kuid_t uid);
72 extern void key_user_put(struct key_user *user);
76 * - root has its own separate limits to everyone else
78 extern unsigned key_quota_root_maxkeys;
79 extern unsigned key_quota_root_maxbytes;
80 extern unsigned key_quota_maxkeys;
81 extern unsigned key_quota_maxbytes;
83 #define KEYQUOTA_LINK_BYTES 4 /* a link in a keyring is worth 4 bytes */
86 extern struct kmem_cache *key_jar;
87 extern struct rb_root key_serial_tree;
88 extern spinlock_t key_serial_lock;
89 extern struct mutex key_construction_mutex;
90 extern wait_queue_head_t request_key_conswq;
93 extern struct key_type *key_type_lookup(const char *type);
94 extern void key_type_put(struct key_type *ktype);
96 extern int __key_link_lock(struct key *keyring,
97 const struct keyring_index_key *index_key);
98 extern int __key_move_lock(struct key *l_keyring, struct key *u_keyring,
99 const struct keyring_index_key *index_key);
100 extern int __key_link_begin(struct key *keyring,
101 const struct keyring_index_key *index_key,
102 struct assoc_array_edit **_edit);
103 extern int __key_link_check_live_key(struct key *keyring, struct key *key);
104 extern void __key_link(struct key *key, 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) */
131 int (*iterator)(const void *object, void *iterator_data);
140 extern bool key_default_cmp(const struct key *key,
141 const struct key_match_data *match_data);
142 extern key_ref_t keyring_search_aux(key_ref_t keyring_ref,
143 struct keyring_search_context *ctx);
145 extern key_ref_t search_my_process_keyrings(struct keyring_search_context *ctx);
146 extern key_ref_t search_process_keyrings(struct keyring_search_context *ctx);
148 extern struct key *find_keyring_by_name(const char *name, bool uid_keyring);
150 extern int install_user_keyrings(void);
151 extern int install_thread_keyring_to_cred(struct cred *);
152 extern int install_process_keyring_to_cred(struct cred *);
153 extern int install_session_keyring_to_cred(struct cred *, struct key *);
155 extern struct key *request_key_and_link(struct key_type *type,
156 const char *description,
157 const void *callout_info,
160 struct key *dest_keyring,
161 unsigned long flags);
163 extern bool lookup_user_key_possessed(const struct key *key,
164 const struct key_match_data *match_data);
165 #define KEY_LOOKUP_CREATE 0x01
166 #define KEY_LOOKUP_PARTIAL 0x02
167 #define KEY_LOOKUP_FOR_UNLINK 0x04
169 extern long join_session_keyring(const char *name);
170 extern void key_change_session_keyring(struct callback_head *twork);
172 extern struct work_struct key_gc_work;
173 extern unsigned key_gc_delay;
174 extern void keyring_gc(struct key *keyring, time64_t limit);
175 extern void keyring_restriction_gc(struct key *keyring,
176 struct key_type *dead_type);
177 extern void key_schedule_gc(time64_t gc_at);
178 extern void key_schedule_gc_links(void);
179 extern void key_gc_keytype(struct key_type *ktype);
181 extern int key_task_permission(const key_ref_t key_ref,
182 const struct cred *cred,
186 * Check to see whether permission is granted to use a key in the desired way.
188 static inline int key_permission(const key_ref_t key_ref, unsigned perm)
190 return key_task_permission(key_ref, current_cred(), perm);
193 extern struct key_type key_type_request_key_auth;
194 extern struct key *request_key_auth_new(struct key *target,
196 const void *callout_info,
198 struct key *dest_keyring);
200 extern struct key *key_get_instantiation_authkey(key_serial_t target_id);
203 * Determine whether a key is dead.
205 static inline bool key_is_dead(const struct key *key, time64_t limit)
208 key->flags & ((1 << KEY_FLAG_DEAD) |
209 (1 << KEY_FLAG_INVALIDATED)) ||
210 (key->expiry > 0 && key->expiry <= limit);
216 extern long keyctl_get_keyring_ID(key_serial_t, int);
217 extern long keyctl_join_session_keyring(const char __user *);
218 extern long keyctl_update_key(key_serial_t, const void __user *, size_t);
219 extern long keyctl_revoke_key(key_serial_t);
220 extern long keyctl_keyring_clear(key_serial_t);
221 extern long keyctl_keyring_link(key_serial_t, key_serial_t);
222 extern long keyctl_keyring_move(key_serial_t, key_serial_t, key_serial_t, unsigned int);
223 extern long keyctl_keyring_unlink(key_serial_t, key_serial_t);
224 extern long keyctl_describe_key(key_serial_t, char __user *, size_t);
225 extern long keyctl_keyring_search(key_serial_t, const char __user *,
226 const char __user *, key_serial_t);
227 extern long keyctl_read_key(key_serial_t, char __user *, size_t);
228 extern long keyctl_chown_key(key_serial_t, uid_t, gid_t);
229 extern long keyctl_setperm_key(key_serial_t, key_perm_t);
230 extern long keyctl_instantiate_key(key_serial_t, const void __user *,
231 size_t, key_serial_t);
232 extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t);
233 extern long keyctl_set_reqkey_keyring(int);
234 extern long keyctl_set_timeout(key_serial_t, unsigned);
235 extern long keyctl_assume_authority(key_serial_t);
236 extern long keyctl_get_security(key_serial_t keyid, char __user *buffer,
238 extern long keyctl_session_to_parent(void);
239 extern long keyctl_reject_key(key_serial_t, unsigned, unsigned, key_serial_t);
240 extern long keyctl_instantiate_key_iov(key_serial_t,
241 const struct iovec __user *,
242 unsigned, key_serial_t);
243 extern long keyctl_invalidate_key(key_serial_t);
246 extern long keyctl_instantiate_key_common(key_serial_t,
249 extern long keyctl_restrict_keyring(key_serial_t id,
250 const char __user *_type,
251 const char __user *_restriction);
252 #ifdef CONFIG_PERSISTENT_KEYRINGS
253 extern long keyctl_get_persistent(uid_t, key_serial_t);
254 extern unsigned persistent_keyring_expiry;
256 static inline long keyctl_get_persistent(uid_t uid, key_serial_t destring)
262 #ifdef CONFIG_KEY_DH_OPERATIONS
263 extern long keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *,
264 size_t, struct keyctl_kdf_params __user *);
265 extern long __keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *,
266 size_t, struct keyctl_kdf_params *);
267 #ifdef CONFIG_KEYS_COMPAT
268 extern long compat_keyctl_dh_compute(struct keyctl_dh_params __user *params,
269 char __user *buffer, size_t buflen,
270 struct compat_keyctl_kdf_params __user *kdf);
272 #define KEYCTL_KDF_MAX_OUTPUT_LEN 1024 /* max length of KDF output */
273 #define KEYCTL_KDF_MAX_OI_LEN 64 /* max length of otherinfo */
275 static inline long keyctl_dh_compute(struct keyctl_dh_params __user *params,
276 char __user *buffer, size_t buflen,
277 struct keyctl_kdf_params __user *kdf)
282 #ifdef CONFIG_KEYS_COMPAT
283 static inline long compat_keyctl_dh_compute(
284 struct keyctl_dh_params __user *params,
285 char __user *buffer, size_t buflen,
286 struct keyctl_kdf_params __user *kdf)
293 #ifdef CONFIG_ASYMMETRIC_KEY_TYPE
294 extern long keyctl_pkey_query(key_serial_t,
296 struct keyctl_pkey_query __user *);
298 extern long keyctl_pkey_verify(const struct keyctl_pkey_params __user *,
300 const void __user *, const void __user *);
302 extern long keyctl_pkey_e_d_s(int,
303 const struct keyctl_pkey_params __user *,
305 const void __user *, void __user *);
307 static inline long keyctl_pkey_query(key_serial_t id,
308 const char __user *_info,
309 struct keyctl_pkey_query __user *_res)
314 static inline long keyctl_pkey_verify(const struct keyctl_pkey_params __user *params,
315 const char __user *_info,
316 const void __user *_in,
317 const void __user *_in2)
322 static inline long keyctl_pkey_e_d_s(int op,
323 const struct keyctl_pkey_params __user *params,
324 const char __user *_info,
325 const void __user *_in,
332 extern long keyctl_capabilities(unsigned char __user *_buffer, size_t buflen);
335 * Debugging key validation
338 extern void __key_check(const struct key *);
340 static inline void key_check(const struct key *key)
342 if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC))
348 #define key_check(key) do {} while(0)
352 #endif /* _INTERNAL_H */