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/key-type.h>
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__)
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__)
34 extern struct key_type key_type_user;
36 /*****************************************************************************/
38 * Keep track of keys for a user.
40 * This needs to be separate to user_struct to avoid a refcount-loop
41 * (user_struct pins some keyrings which pin this struct).
43 * We also keep track of keys under request from userspace for this UID here.
47 struct mutex cons_lock; /* construction initiation lock */
49 atomic_t usage; /* for accessing qnkeys & qnbytes */
50 atomic_t nkeys; /* number of keys */
51 atomic_t nikeys; /* number of instantiated keys */
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 */
58 extern struct rb_root key_user_tree;
59 extern spinlock_t key_user_lock;
60 extern struct key_user root_key_user;
62 extern struct key_user *key_user_lookup(uid_t uid,
63 struct user_namespace *user_ns);
64 extern void key_user_put(struct key_user *user);
68 * - root has its own separate limits to everyone else
70 extern unsigned key_quota_root_maxkeys;
71 extern unsigned key_quota_root_maxbytes;
72 extern unsigned key_quota_maxkeys;
73 extern unsigned key_quota_maxbytes;
75 #define KEYQUOTA_LINK_BYTES 4 /* a link in a keyring is worth 4 bytes */
78 extern struct kmem_cache *key_jar;
79 extern struct rb_root key_serial_tree;
80 extern spinlock_t key_serial_lock;
81 extern struct mutex key_construction_mutex;
82 extern wait_queue_head_t request_key_conswq;
85 extern struct key_type *key_type_lookup(const char *type);
86 extern void key_type_put(struct key_type *ktype);
88 extern int __key_link_begin(struct key *keyring,
89 const struct key_type *type,
90 const char *description,
91 unsigned long *_prealloc);
92 extern int __key_link_check_live_key(struct key *keyring, struct key *key);
93 extern void __key_link(struct key *keyring, struct key *key,
94 unsigned long *_prealloc);
95 extern void __key_link_end(struct key *keyring,
96 struct key_type *type,
97 unsigned long prealloc);
99 extern key_ref_t __keyring_search_one(key_ref_t keyring_ref,
100 const struct key_type *type,
101 const char *description,
104 extern struct key *keyring_search_instkey(struct key *keyring,
105 key_serial_t target_id);
107 typedef int (*key_match_func_t)(const struct key *, const void *);
109 extern key_ref_t keyring_search_aux(key_ref_t keyring_ref,
110 const struct cred *cred,
111 struct key_type *type,
112 const void *description,
113 key_match_func_t match,
114 bool no_state_check);
116 extern key_ref_t search_my_process_keyrings(struct key_type *type,
117 const void *description,
118 key_match_func_t match,
120 const struct cred *cred);
121 extern key_ref_t search_process_keyrings(struct key_type *type,
122 const void *description,
123 key_match_func_t match,
124 const struct cred *cred);
126 extern struct key *find_keyring_by_name(const char *name, bool skip_perm_check);
128 extern int install_user_keyrings(void);
129 extern int install_thread_keyring_to_cred(struct cred *);
130 extern int install_process_keyring_to_cred(struct cred *);
131 extern int install_session_keyring_to_cred(struct cred *, struct key *);
133 extern struct key *request_key_and_link(struct key_type *type,
134 const char *description,
135 const void *callout_info,
138 struct key *dest_keyring,
139 unsigned long flags);
141 extern int lookup_user_key_possessed(const struct key *key, const void *target);
142 extern key_ref_t lookup_user_key(key_serial_t id, unsigned long flags,
144 #define KEY_LOOKUP_CREATE 0x01
145 #define KEY_LOOKUP_PARTIAL 0x02
146 #define KEY_LOOKUP_FOR_UNLINK 0x04
148 extern long join_session_keyring(const char *name);
150 extern struct work_struct key_gc_unused_work;
151 extern unsigned key_gc_delay;
152 extern void keyring_gc(struct key *keyring, time_t limit);
153 extern void key_schedule_gc(time_t expiry_at);
155 extern int key_task_permission(const key_ref_t key_ref,
156 const struct cred *cred,
160 * Check to see whether permission is granted to use a key in the desired way.
162 static inline int key_permission(const key_ref_t key_ref, key_perm_t perm)
164 return key_task_permission(key_ref, current_cred(), perm);
167 /* required permissions */
168 #define KEY_VIEW 0x01 /* require permission to view attributes */
169 #define KEY_READ 0x02 /* require permission to read content */
170 #define KEY_WRITE 0x04 /* require permission to update / modify */
171 #define KEY_SEARCH 0x08 /* require permission to search (keyring) or find (key) */
172 #define KEY_LINK 0x10 /* require permission to link */
173 #define KEY_SETATTR 0x20 /* require permission to change attributes */
174 #define KEY_ALL 0x3f /* all the above permissions */
177 * Authorisation record for request_key().
179 struct request_key_auth {
180 struct key *target_key;
181 struct key *dest_keyring;
182 const struct cred *cred;
188 extern struct key_type key_type_request_key_auth;
189 extern struct key *request_key_auth_new(struct key *target,
190 const void *callout_info,
192 struct key *dest_keyring);
194 extern struct key *key_get_instantiation_authkey(key_serial_t target_id);
199 extern long keyctl_get_keyring_ID(key_serial_t, int);
200 extern long keyctl_join_session_keyring(const char __user *);
201 extern long keyctl_update_key(key_serial_t, const void __user *, size_t);
202 extern long keyctl_revoke_key(key_serial_t);
203 extern long keyctl_keyring_clear(key_serial_t);
204 extern long keyctl_keyring_link(key_serial_t, key_serial_t);
205 extern long keyctl_keyring_unlink(key_serial_t, key_serial_t);
206 extern long keyctl_describe_key(key_serial_t, char __user *, size_t);
207 extern long keyctl_keyring_search(key_serial_t, const char __user *,
208 const char __user *, key_serial_t);
209 extern long keyctl_read_key(key_serial_t, char __user *, size_t);
210 extern long keyctl_chown_key(key_serial_t, uid_t, gid_t);
211 extern long keyctl_setperm_key(key_serial_t, key_perm_t);
212 extern long keyctl_instantiate_key(key_serial_t, const void __user *,
213 size_t, key_serial_t);
214 extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t);
215 extern long keyctl_set_reqkey_keyring(int);
216 extern long keyctl_set_timeout(key_serial_t, unsigned);
217 extern long keyctl_assume_authority(key_serial_t);
218 extern long keyctl_get_security(key_serial_t keyid, char __user *buffer,
220 extern long keyctl_session_to_parent(void);
221 extern long keyctl_reject_key(key_serial_t, unsigned, unsigned, key_serial_t);
222 extern long keyctl_instantiate_key_iov(key_serial_t,
223 const struct iovec __user *,
224 unsigned, key_serial_t);
226 extern long keyctl_instantiate_key_common(key_serial_t,
227 const struct iovec __user *,
228 unsigned, size_t, key_serial_t);
231 * Debugging key validation
234 extern void __key_check(const struct key *);
236 static inline void key_check(const struct key *key)
238 if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC))
244 #define key_check(key) do {} while(0)
248 #endif /* _INTERNAL_H */