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/cred.h>
17 #include <linux/key-type.h>
18 #include <linux/task_work.h>
19 #include <linux/keyctl.h>
20 #include <linux/refcount.h>
21 #include <linux/compat.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;
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_begin(struct key *keyring,
96 const struct keyring_index_key *index_key,
97 struct assoc_array_edit **_edit);
98 extern int __key_link_check_live_key(struct key *keyring, struct key *key);
99 extern void __key_link(struct key *key, struct assoc_array_edit **_edit);
100 extern void __key_link_end(struct key *keyring,
101 const struct keyring_index_key *index_key,
102 struct assoc_array_edit *edit);
104 extern key_ref_t find_key_to_update(key_ref_t keyring_ref,
105 const struct keyring_index_key *index_key);
107 extern struct key *keyring_search_instkey(struct key *keyring,
108 key_serial_t target_id);
110 extern int iterate_over_keyring(const struct key *keyring,
111 int (*func)(const struct key *key, void *data),
114 struct keyring_search_context {
115 struct keyring_index_key index_key;
116 const struct cred *cred;
117 struct key_match_data match_data;
119 #define KEYRING_SEARCH_NO_STATE_CHECK 0x0001 /* Skip state checks */
120 #define KEYRING_SEARCH_DO_STATE_CHECK 0x0002 /* Override NO_STATE_CHECK */
121 #define KEYRING_SEARCH_NO_UPDATE_TIME 0x0004 /* Don't update times */
122 #define KEYRING_SEARCH_NO_CHECK_PERM 0x0008 /* Don't check permissions */
123 #define KEYRING_SEARCH_DETECT_TOO_DEEP 0x0010 /* Give an error on excessive depth */
124 #define KEYRING_SEARCH_SKIP_EXPIRED 0x0020 /* Ignore expired keys (intention to replace) */
126 int (*iterator)(const void *object, void *iterator_data);
135 extern bool key_default_cmp(const struct key *key,
136 const struct key_match_data *match_data);
137 extern key_ref_t keyring_search_aux(key_ref_t keyring_ref,
138 struct keyring_search_context *ctx);
140 extern key_ref_t search_my_process_keyrings(struct keyring_search_context *ctx);
141 extern key_ref_t search_process_keyrings(struct keyring_search_context *ctx);
143 extern struct key *find_keyring_by_name(const char *name, bool skip_perm_check);
145 extern int install_user_keyrings(void);
146 extern int install_thread_keyring_to_cred(struct cred *);
147 extern int install_process_keyring_to_cred(struct cred *);
148 extern int install_session_keyring_to_cred(struct cred *, struct key *);
150 extern struct key *request_key_and_link(struct key_type *type,
151 const char *description,
152 const void *callout_info,
155 struct key *dest_keyring,
156 unsigned long flags);
158 extern bool lookup_user_key_possessed(const struct key *key,
159 const struct key_match_data *match_data);
160 extern key_ref_t lookup_user_key(key_serial_t id, unsigned long flags,
162 #define KEY_LOOKUP_CREATE 0x01
163 #define KEY_LOOKUP_PARTIAL 0x02
164 #define KEY_LOOKUP_FOR_UNLINK 0x04
166 extern long join_session_keyring(const char *name);
167 extern void key_change_session_keyring(struct callback_head *twork);
169 extern struct work_struct key_gc_work;
170 extern unsigned key_gc_delay;
171 extern void keyring_gc(struct key *keyring, time_t limit);
172 extern void keyring_restriction_gc(struct key *keyring,
173 struct key_type *dead_type);
174 extern void key_schedule_gc(time_t gc_at);
175 extern void key_schedule_gc_links(void);
176 extern void key_gc_keytype(struct key_type *ktype);
178 extern int key_task_permission(const key_ref_t key_ref,
179 const struct cred *cred,
183 * Check to see whether permission is granted to use a key in the desired way.
185 static inline int key_permission(const key_ref_t key_ref, unsigned perm)
187 return key_task_permission(key_ref, current_cred(), perm);
191 * Authorisation record for request_key().
193 struct request_key_auth {
194 struct key *target_key;
195 struct key *dest_keyring;
196 const struct cred *cred;
202 extern struct key_type key_type_request_key_auth;
203 extern struct key *request_key_auth_new(struct key *target,
204 const void *callout_info,
206 struct key *dest_keyring);
208 extern struct key *key_get_instantiation_authkey(key_serial_t target_id);
211 * Determine whether a key is dead.
213 static inline bool key_is_dead(const struct key *key, time_t limit)
216 key->flags & ((1 << KEY_FLAG_DEAD) |
217 (1 << KEY_FLAG_INVALIDATED)) ||
218 (key->expiry > 0 && key->expiry <= limit);
224 extern long keyctl_get_keyring_ID(key_serial_t, int);
225 extern long keyctl_join_session_keyring(const char __user *);
226 extern long keyctl_update_key(key_serial_t, const void __user *, size_t);
227 extern long keyctl_revoke_key(key_serial_t);
228 extern long keyctl_keyring_clear(key_serial_t);
229 extern long keyctl_keyring_link(key_serial_t, key_serial_t);
230 extern long keyctl_keyring_unlink(key_serial_t, key_serial_t);
231 extern long keyctl_describe_key(key_serial_t, char __user *, size_t);
232 extern long keyctl_keyring_search(key_serial_t, const char __user *,
233 const char __user *, key_serial_t);
234 extern long keyctl_read_key(key_serial_t, char __user *, size_t);
235 extern long keyctl_chown_key(key_serial_t, uid_t, gid_t);
236 extern long keyctl_setperm_key(key_serial_t, key_perm_t);
237 extern long keyctl_instantiate_key(key_serial_t, const void __user *,
238 size_t, key_serial_t);
239 extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t);
240 extern long keyctl_set_reqkey_keyring(int);
241 extern long keyctl_set_timeout(key_serial_t, unsigned);
242 extern long keyctl_assume_authority(key_serial_t);
243 extern long keyctl_get_security(key_serial_t keyid, char __user *buffer,
245 extern long keyctl_session_to_parent(void);
246 extern long keyctl_reject_key(key_serial_t, unsigned, unsigned, key_serial_t);
247 extern long keyctl_instantiate_key_iov(key_serial_t,
248 const struct iovec __user *,
249 unsigned, key_serial_t);
250 extern long keyctl_invalidate_key(key_serial_t);
253 extern long keyctl_instantiate_key_common(key_serial_t,
256 extern long keyctl_restrict_keyring(key_serial_t id,
257 const char __user *_type,
258 const char __user *_restriction);
259 #ifdef CONFIG_PERSISTENT_KEYRINGS
260 extern long keyctl_get_persistent(uid_t, key_serial_t);
261 extern unsigned persistent_keyring_expiry;
263 static inline long keyctl_get_persistent(uid_t uid, key_serial_t destring)
269 #ifdef CONFIG_KEY_DH_OPERATIONS
270 extern long keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *,
271 size_t, struct keyctl_kdf_params __user *);
272 extern long __keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *,
273 size_t, struct keyctl_kdf_params *);
274 #ifdef CONFIG_KEYS_COMPAT
275 extern long compat_keyctl_dh_compute(struct keyctl_dh_params __user *params,
276 char __user *buffer, size_t buflen,
277 struct compat_keyctl_kdf_params __user *kdf);
279 #define KEYCTL_KDF_MAX_OUTPUT_LEN 1024 /* max length of KDF output */
280 #define KEYCTL_KDF_MAX_OI_LEN 64 /* max length of otherinfo */
282 static inline long keyctl_dh_compute(struct keyctl_dh_params __user *params,
283 char __user *buffer, size_t buflen,
284 struct keyctl_kdf_params __user *kdf)
289 #ifdef CONFIG_KEYS_COMPAT
290 static inline long compat_keyctl_dh_compute(
291 struct keyctl_dh_params __user *params,
292 char __user *buffer, size_t buflen,
293 struct keyctl_kdf_params __user *kdf)
301 * Debugging key validation
304 extern void __key_check(const struct key *);
306 static inline void key_check(const struct key *key)
308 if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC))
314 #define key_check(key) do {} while(0)
318 #endif /* _INTERNAL_H */