projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
KEYS: The dead key link reaper should be non-reentrant
[linux-2.6-block.git] / security / keys / internal.h
CommitLineData
973c9f4f 1/* Authentication token and access key management internal defs
1da177e4 2 *
76181c13 3 * Copyright (C) 2003-5, 2007 Red Hat, Inc. All Rights Reserved.
1da177e4
LT		 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
d84f4f99 15#include <linux/sched.h>
76181c13 16#include <linux/key-type.h>
1da177e4 17
76181c13
DH		 18#ifdef __KDEBUG
19#define kenter(FMT, ...) \
dd6f953a 20 printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
76181c13 21#define kleave(FMT, ...) \
dd6f953a 22 printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
76181c13 23#define kdebug(FMT, ...) \
d84f4f99 24 printk(KERN_DEBUG " "FMT"\n", ##__VA_ARGS__)
3e30148c 25#else
76181c13 26#define kenter(FMT, ...) \
dd6f953a 27 no_printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
76181c13 28#define kleave(FMT, ...) \
dd6f953a 29 no_printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
76181c13
DH		 30#define kdebug(FMT, ...) \
31 no_printk(KERN_DEBUG FMT"\n", ##__VA_ARGS__)
3e30148c
DH		 32#endif
33
1da177e4
LT		 34extern struct key_type key_type_user;
35
36/*****************************************************************************/
37/*
973c9f4f
DH		 38 * Keep track of keys for a user.
39 *
40 * This needs to be separate to user_struct to avoid a refcount-loop
41 * (user_struct pins some keyrings which pin this struct).
42 *
43 * We also keep track of keys under request from userspace for this UID here.
1da177e4
LT		 44 */
45struct key_user {
46 struct rb_node node;
76181c13 47 struct mutex cons_lock; /* construction initiation lock */
1da177e4
LT		 48 spinlock_t lock;
49 atomic_t usage; /* for accessing qnkeys & qnbytes */
50 atomic_t nkeys; /* number of keys */
51 atomic_t nikeys; /* number of instantiated keys */
52 uid_t uid;
1d1e9756 53 struct user_namespace *user_ns;
1da177e4
LT		 54 int qnkeys; /* number of keys allocated to this user */
55 int qnbytes; /* number of bytes allocated to this user */
56};
57
1da177e4
LT		 58extern struct rb_root key_user_tree;
59extern spinlock_t key_user_lock;
60extern struct key_user root_key_user;
61
1d1e9756
SH		 62extern struct key_user *key_user_lookup(uid_t uid,
63 struct user_namespace *user_ns);
1da177e4
LT		 64extern void key_user_put(struct key_user *user);
65
0b77f5bf 66/*
973c9f4f 67 * Key quota limits.
0b77f5bf
DH		 68 * - root has its own separate limits to everyone else
69 */
70extern unsigned key_quota_root_maxkeys;
71extern unsigned key_quota_root_maxbytes;
72extern unsigned key_quota_maxkeys;
73extern unsigned key_quota_maxbytes;
74
75#define KEYQUOTA_LINK_BYTES 4 /* a link in a keyring is worth 4 bytes */
1da177e4
LT		 76
77
8bc16dea 78extern struct kmem_cache *key_jar;
1da177e4
LT		 79extern struct rb_root key_serial_tree;
80extern spinlock_t key_serial_lock;
76181c13 81extern struct mutex key_construction_mutex;
1da177e4
LT		 82extern wait_queue_head_t request_key_conswq;
83
84
e9e349b0
DH		 85extern struct key_type *key_type_lookup(const char *type);
86extern void key_type_put(struct key_type *ktype);
87
f70e2e06
DH		 88extern int __key_link_begin(struct key *keyring,
89 const struct key_type *type,
90 const char *description,
ceb73c12 91 unsigned long *_prealloc);
f70e2e06
DH		 92extern int __key_link_check_live_key(struct key *keyring, struct key *key);
93extern void __key_link(struct key *keyring, struct key *key,
ceb73c12 94 unsigned long *_prealloc);
f70e2e06
DH		 95extern void __key_link_end(struct key *keyring,
96 struct key_type *type,
ceb73c12 97 unsigned long prealloc);
1da177e4 98
664cceb0
DH		 99extern key_ref_t __keyring_search_one(key_ref_t keyring_ref,
100 const struct key_type *type,
101 const char *description,
102 key_perm_t perm);
1da177e4 103
3e30148c
DH		 104extern struct key *keyring_search_instkey(struct key *keyring,
105 key_serial_t target_id);
106
1da177e4
LT		 107typedef int (*key_match_func_t)(const struct key *, const void *);
108
664cceb0 109extern key_ref_t keyring_search_aux(key_ref_t keyring_ref,
d84f4f99 110 const struct cred *cred,
664cceb0
DH		 111 struct key_type *type,
112 const void *description,
78b7280c
DH		 113 key_match_func_t match,
114 bool no_state_check);
1da177e4 115
927942aa
DH		 116extern key_ref_t search_my_process_keyrings(struct key_type *type,
117 const void *description,
118 key_match_func_t match,
78b7280c 119 bool no_state_check,
927942aa 120 const struct cred *cred);
664cceb0
DH		 121extern key_ref_t search_process_keyrings(struct key_type *type,
122 const void *description,
123 key_match_func_t match,
d84f4f99 124 const struct cred *cred);
1da177e4 125
69664cf1 126extern struct key *find_keyring_by_name(const char *name, bool skip_perm_check);
1da177e4 127
8bbf4976 128extern int install_user_keyrings(void);
d84f4f99
DH		 129extern int install_thread_keyring_to_cred(struct cred *);
130extern int install_process_keyring_to_cred(struct cred *);
685bfd2c 131extern int install_session_keyring_to_cred(struct cred *, struct key *);
3e30148c
DH		 132
133extern struct key *request_key_and_link(struct key_type *type,
134 const char *description,
4a38e122
DH		 135 const void *callout_info,
136 size_t callout_len,
4e54f085 137 void *aux,
7e047ef5
DH		 138 struct key *dest_keyring,
139 unsigned long flags);
3e30148c 140
927942aa 141extern int lookup_user_key_possessed(const struct key *key, const void *target);
5593122e 142extern key_ref_t lookup_user_key(key_serial_t id, unsigned long flags,
e9e349b0 143 key_perm_t perm);
5593122e
DH		 144#define KEY_LOOKUP_CREATE 0x01
145#define KEY_LOOKUP_PARTIAL 0x02
146#define KEY_LOOKUP_FOR_UNLINK 0x04
e9e349b0
DH		 147
148extern long join_session_keyring(const char *name);
149
8bc16dea 150extern struct work_struct key_gc_unused_work;
5d135440
DH		 151extern unsigned key_gc_delay;
152extern void keyring_gc(struct key *keyring, time_t limit);
153extern void key_schedule_gc(time_t expiry_at);
154
e9e349b0 155extern int key_task_permission(const key_ref_t key_ref,
d84f4f99 156 const struct cred *cred,
e9e349b0
DH		 157 key_perm_t perm);
158
973c9f4f
DH		 159/*
160 * Check to see whether permission is granted to use a key in the desired way.
161 */
e9e349b0
DH		 162static inline int key_permission(const key_ref_t key_ref, key_perm_t perm)
163{
d84f4f99 164 return key_task_permission(key_ref, current_cred(), perm);
e9e349b0
DH		 165}
166
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 */
175
3e30148c 176/*
973c9f4f 177 * Authorisation record for request_key().
3e30148c
DH		 178 */
179struct request_key_auth {
180 struct key *target_key;
8bbf4976 181 struct key *dest_keyring;
d84f4f99 182 const struct cred *cred;
4a38e122
DH		 183 void *callout_info;
184 size_t callout_len;
3e30148c
DH		 185 pid_t pid;
186};
187
188extern struct key_type key_type_request_key_auth;
189extern struct key *request_key_auth_new(struct key *target,
4a38e122 190 const void *callout_info,
8bbf4976
DH		 191 size_t callout_len,
192 struct key *dest_keyring);
3e30148c
DH		 193
194extern struct key *key_get_instantiation_authkey(key_serial_t target_id);
1da177e4
LT		 195
196/*
973c9f4f 197 * keyctl() functions
1da177e4
LT		 198 */
199extern long keyctl_get_keyring_ID(key_serial_t, int);
200extern long keyctl_join_session_keyring(const char __user *);
201extern long keyctl_update_key(key_serial_t, const void __user *, size_t);
202extern long keyctl_revoke_key(key_serial_t);
203extern long keyctl_keyring_clear(key_serial_t);
204extern long keyctl_keyring_link(key_serial_t, key_serial_t);
205extern long keyctl_keyring_unlink(key_serial_t, key_serial_t);
206extern long keyctl_describe_key(key_serial_t, char __user *, size_t);
207extern long keyctl_keyring_search(key_serial_t, const char __user *,
208 const char __user *, key_serial_t);
209extern long keyctl_read_key(key_serial_t, char __user *, size_t);
210extern long keyctl_chown_key(key_serial_t, uid_t, gid_t);
211extern long keyctl_setperm_key(key_serial_t, key_perm_t);
212extern long keyctl_instantiate_key(key_serial_t, const void __user *,
213 size_t, key_serial_t);
214extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t);
3e30148c 215extern long keyctl_set_reqkey_keyring(int);
017679c4 216extern long keyctl_set_timeout(key_serial_t, unsigned);
b5f545c8 217extern long keyctl_assume_authority(key_serial_t);
70a5bb72
DH		 218extern long keyctl_get_security(key_serial_t keyid, char __user *buffer,
219 size_t buflen);
ee18d64c 220extern long keyctl_session_to_parent(void);
fdd1b945 221extern long keyctl_reject_key(key_serial_t, unsigned, unsigned, key_serial_t);
ee009e4a
DH		 222extern long keyctl_instantiate_key_iov(key_serial_t,
223 const struct iovec __user *,
224 unsigned, key_serial_t);
225
226extern long keyctl_instantiate_key_common(key_serial_t,
227 const struct iovec __user *,
228 unsigned, size_t, key_serial_t);
1da177e4
LT		 229
230/*
973c9f4f 231 * Debugging key validation
1da177e4
LT		 232 */
233#ifdef KEY_DEBUGGING
234extern void __key_check(const struct key *);
235
236static inline void key_check(const struct key *key)
237{
238 if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC))
239 __key_check(key);
240}
241
242#else
243
244#define key_check(key) do {} while(0)
245
246#endif
247
248#endif /* _INTERNAL_H */
Linux 6.x block layer and io_uring tree(s)