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;
91 extern struct key_acl default_key_acl;
92 extern struct key_acl joinable_keyring_acl;
94 extern void key_set_index_key(struct keyring_index_key *index_key);
96 extern struct key_type *key_type_lookup(const char *type);
97 extern void key_type_put(struct key_type *ktype);
99 extern int __key_link_lock(struct key *keyring,
100 const struct keyring_index_key *index_key);
101 extern int __key_move_lock(struct key *l_keyring, struct key *u_keyring,
102 const struct keyring_index_key *index_key);
103 extern int __key_link_begin(struct key *keyring,
104 const struct keyring_index_key *index_key,
105 struct assoc_array_edit **_edit);
106 extern int __key_link_check_live_key(struct key *keyring, struct key *key);
107 extern void __key_link(struct key *key, struct assoc_array_edit **_edit);
108 extern void __key_link_end(struct key *keyring,
109 const struct keyring_index_key *index_key,
110 struct assoc_array_edit *edit);
112 extern key_ref_t find_key_to_update(key_ref_t keyring_ref,
113 const struct keyring_index_key *index_key);
115 extern struct key *keyring_search_instkey(struct key *keyring,
116 key_serial_t target_id);
118 extern int iterate_over_keyring(const struct key *keyring,
119 int (*func)(const struct key *key, void *data),
122 struct keyring_search_context {
123 struct keyring_index_key index_key;
124 const struct cred *cred;
125 struct key_match_data match_data;
127 #define KEYRING_SEARCH_NO_STATE_CHECK 0x0001 /* Skip state checks */
128 #define KEYRING_SEARCH_DO_STATE_CHECK 0x0002 /* Override NO_STATE_CHECK */
129 #define KEYRING_SEARCH_NO_UPDATE_TIME 0x0004 /* Don't update times */
130 #define KEYRING_SEARCH_NO_CHECK_PERM 0x0008 /* Don't check permissions */
131 #define KEYRING_SEARCH_DETECT_TOO_DEEP 0x0010 /* Give an error on excessive depth */
132 #define KEYRING_SEARCH_SKIP_EXPIRED 0x0020 /* Ignore expired keys (intention to replace) */
133 #define KEYRING_SEARCH_RECURSE 0x0040 /* Search child keyrings also */
135 int (*iterator)(const void *object, void *iterator_data);
144 extern bool key_default_cmp(const struct key *key,
145 const struct key_match_data *match_data);
146 extern key_ref_t keyring_search_rcu(key_ref_t keyring_ref,
147 struct keyring_search_context *ctx);
149 extern key_ref_t search_cred_keyrings_rcu(struct keyring_search_context *ctx);
150 extern key_ref_t search_process_keyrings_rcu(struct keyring_search_context *ctx);
152 extern struct key *find_keyring_by_name(const char *name, bool uid_keyring);
154 extern int look_up_user_keyrings(struct key **, struct key **);
155 extern struct key *get_user_session_keyring_rcu(const struct cred *);
156 extern int install_thread_keyring_to_cred(struct cred *);
157 extern int install_process_keyring_to_cred(struct cred *);
158 extern int install_session_keyring_to_cred(struct cred *, struct key *);
160 extern struct key *request_key_and_link(struct key_type *type,
161 const char *description,
162 struct key_tag *domain_tag,
163 const void *callout_info,
167 struct key *dest_keyring,
168 unsigned long flags);
170 extern bool lookup_user_key_possessed(const struct key *key,
171 const struct key_match_data *match_data);
172 #define KEY_LOOKUP_CREATE 0x01
173 #define KEY_LOOKUP_PARTIAL 0x02
174 #define KEY_LOOKUP_FOR_UNLINK 0x04
176 extern long join_session_keyring(const char *name);
177 extern void key_change_session_keyring(struct callback_head *twork);
179 extern struct work_struct key_gc_work;
180 extern unsigned key_gc_delay;
181 extern void keyring_gc(struct key *keyring, time64_t limit);
182 extern void keyring_restriction_gc(struct key *keyring,
183 struct key_type *dead_type);
184 extern void key_schedule_gc(time64_t gc_at);
185 extern void key_schedule_gc_links(void);
186 extern void key_gc_keytype(struct key_type *ktype);
188 extern int key_task_permission(const key_ref_t key_ref,
189 const struct cred *cred,
191 extern unsigned int key_acl_to_perm(const struct key_acl *acl);
192 extern long key_set_acl(struct key *key, struct key_acl *acl);
193 extern void key_put_acl(struct key_acl *acl);
196 * Check to see whether permission is granted to use a key in the desired way.
198 static inline int key_permission(const key_ref_t key_ref, unsigned perm)
200 return key_task_permission(key_ref, current_cred(), perm);
203 extern struct key_type key_type_request_key_auth;
204 extern struct key *request_key_auth_new(struct key *target,
206 const void *callout_info,
208 struct key *dest_keyring);
210 extern struct key *key_get_instantiation_authkey(key_serial_t target_id);
213 * Determine whether a key is dead.
215 static inline bool key_is_dead(const struct key *key, time64_t limit)
218 key->flags & ((1 << KEY_FLAG_DEAD) |
219 (1 << KEY_FLAG_INVALIDATED)) ||
220 (key->expiry > 0 && key->expiry <= limit) ||
221 key->domain_tag->removed;
227 extern long keyctl_get_keyring_ID(key_serial_t, int);
228 extern long keyctl_join_session_keyring(const char __user *);
229 extern long keyctl_update_key(key_serial_t, const void __user *, size_t);
230 extern long keyctl_revoke_key(key_serial_t);
231 extern long keyctl_keyring_clear(key_serial_t);
232 extern long keyctl_keyring_link(key_serial_t, key_serial_t);
233 extern long keyctl_keyring_move(key_serial_t, key_serial_t, key_serial_t, unsigned int);
234 extern long keyctl_keyring_unlink(key_serial_t, key_serial_t);
235 extern long keyctl_describe_key(key_serial_t, char __user *, size_t);
236 extern long keyctl_keyring_search(key_serial_t, const char __user *,
237 const char __user *, key_serial_t);
238 extern long keyctl_read_key(key_serial_t, char __user *, size_t);
239 extern long keyctl_chown_key(key_serial_t, uid_t, gid_t);
240 extern long keyctl_setperm_key(key_serial_t, unsigned int);
241 extern long keyctl_instantiate_key(key_serial_t, const void __user *,
242 size_t, key_serial_t);
243 extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t);
244 extern long keyctl_set_reqkey_keyring(int);
245 extern long keyctl_set_timeout(key_serial_t, unsigned);
246 extern long keyctl_assume_authority(key_serial_t);
247 extern long keyctl_get_security(key_serial_t keyid, char __user *buffer,
249 extern long keyctl_session_to_parent(void);
250 extern long keyctl_reject_key(key_serial_t, unsigned, unsigned, key_serial_t);
251 extern long keyctl_instantiate_key_iov(key_serial_t,
252 const struct iovec __user *,
253 unsigned, key_serial_t);
254 extern long keyctl_invalidate_key(key_serial_t);
257 extern long keyctl_instantiate_key_common(key_serial_t,
260 extern long keyctl_restrict_keyring(key_serial_t id,
261 const char __user *_type,
262 const char __user *_restriction);
263 #ifdef CONFIG_PERSISTENT_KEYRINGS
264 extern long keyctl_get_persistent(uid_t, key_serial_t);
265 extern unsigned persistent_keyring_expiry;
267 static inline long keyctl_get_persistent(uid_t uid, key_serial_t destring)
273 #ifdef CONFIG_KEY_DH_OPERATIONS
274 extern long keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *,
275 size_t, struct keyctl_kdf_params __user *);
276 extern long __keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *,
277 size_t, struct keyctl_kdf_params *);
278 #ifdef CONFIG_KEYS_COMPAT
279 extern long compat_keyctl_dh_compute(struct keyctl_dh_params __user *params,
280 char __user *buffer, size_t buflen,
281 struct compat_keyctl_kdf_params __user *kdf);
283 #define KEYCTL_KDF_MAX_OUTPUT_LEN 1024 /* max length of KDF output */
284 #define KEYCTL_KDF_MAX_OI_LEN 64 /* max length of otherinfo */
286 static inline long keyctl_dh_compute(struct keyctl_dh_params __user *params,
287 char __user *buffer, size_t buflen,
288 struct keyctl_kdf_params __user *kdf)
293 #ifdef CONFIG_KEYS_COMPAT
294 static inline long compat_keyctl_dh_compute(
295 struct keyctl_dh_params __user *params,
296 char __user *buffer, size_t buflen,
297 struct keyctl_kdf_params __user *kdf)
304 #ifdef CONFIG_ASYMMETRIC_KEY_TYPE
305 extern long keyctl_pkey_query(key_serial_t,
307 struct keyctl_pkey_query __user *);
309 extern long keyctl_pkey_verify(const struct keyctl_pkey_params __user *,
311 const void __user *, const void __user *);
313 extern long keyctl_pkey_e_d_s(int,
314 const struct keyctl_pkey_params __user *,
316 const void __user *, void __user *);
318 static inline long keyctl_pkey_query(key_serial_t id,
319 const char __user *_info,
320 struct keyctl_pkey_query __user *_res)
325 static inline long keyctl_pkey_verify(const struct keyctl_pkey_params __user *params,
326 const char __user *_info,
327 const void __user *_in,
328 const void __user *_in2)
333 static inline long keyctl_pkey_e_d_s(int op,
334 const struct keyctl_pkey_params __user *params,
335 const char __user *_info,
336 const void __user *_in,
343 extern long keyctl_capabilities(unsigned char __user *_buffer, size_t buflen);
346 * Debugging key validation
349 extern void __key_check(const struct key *);
351 static inline void key_check(const struct key *key)
353 if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC))
359 #define key_check(key) do {} while(0)
363 #endif /* _INTERNAL_H */