1
2
3
4
5
6
7
8
9
10
11
12
13
14
15#ifndef _LINUX_KEY_H
16#define _LINUX_KEY_H
17
18#include <linux/types.h>
19#include <linux/list.h>
20#include <linux/rbtree.h>
21#include <linux/rcupdate.h>
22#include <linux/sysctl.h>
23#include <linux/rwsem.h>
24#include <asm/atomic.h>
25
26#ifdef __KERNEL__
27
28
29typedef int32_t key_serial_t;
30
31
32typedef uint32_t key_perm_t;
33
34struct key;
35
36#ifdef CONFIG_KEYS
37
38#undef KEY_DEBUGGING
39
40#define KEY_POS_VIEW 0x01000000
41#define KEY_POS_READ 0x02000000
42#define KEY_POS_WRITE 0x04000000
43#define KEY_POS_SEARCH 0x08000000
44#define KEY_POS_LINK 0x10000000
45#define KEY_POS_SETATTR 0x20000000
46#define KEY_POS_ALL 0x3f000000
47
48#define KEY_USR_VIEW 0x00010000
49#define KEY_USR_READ 0x00020000
50#define KEY_USR_WRITE 0x00040000
51#define KEY_USR_SEARCH 0x00080000
52#define KEY_USR_LINK 0x00100000
53#define KEY_USR_SETATTR 0x00200000
54#define KEY_USR_ALL 0x003f0000
55
56#define KEY_GRP_VIEW 0x00000100
57#define KEY_GRP_READ 0x00000200
58#define KEY_GRP_WRITE 0x00000400
59#define KEY_GRP_SEARCH 0x00000800
60#define KEY_GRP_LINK 0x00001000
61#define KEY_GRP_SETATTR 0x00002000
62#define KEY_GRP_ALL 0x00003f00
63
64#define KEY_OTH_VIEW 0x00000001
65#define KEY_OTH_READ 0x00000002
66#define KEY_OTH_WRITE 0x00000004
67#define KEY_OTH_SEARCH 0x00000008
68#define KEY_OTH_LINK 0x00000010
69#define KEY_OTH_SETATTR 0x00000020
70#define KEY_OTH_ALL 0x0000003f
71
72#define KEY_PERM_UNDEF 0xffffffff
73
74struct seq_file;
75struct user_struct;
76struct signal_struct;
77struct cred;
78
79struct key_type;
80struct key_owner;
81struct keyring_list;
82struct keyring_name;
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98typedef struct __key_reference_with_attributes *key_ref_t;
99
100static inline key_ref_t make_key_ref(const struct key *key,
101 unsigned long possession)
102{
103 return (key_ref_t) ((unsigned long) key | possession);
104}
105
106static inline struct key *key_ref_to_ptr(const key_ref_t key_ref)
107{
108 return (struct key *) ((unsigned long) key_ref & ~1UL);
109}
110
111static inline unsigned long is_key_possessed(const key_ref_t key_ref)
112{
113 return (unsigned long) key_ref & 1UL;
114}
115
116
117
118
119
120
121
122
123
124struct key {
125 atomic_t usage;
126 key_serial_t serial;
127 struct rb_node serial_node;
128 struct key_type *type;
129 struct rw_semaphore sem;
130 struct key_user *user;
131 void *security;
132 union {
133 time_t expiry;
134 time_t revoked_at;
135 };
136 uid_t uid;
137 gid_t gid;
138 key_perm_t perm;
139 unsigned short quotalen;
140 unsigned short datalen;
141
142
143
144
145#ifdef KEY_DEBUGGING
146 unsigned magic;
147#define KEY_DEBUG_MAGIC 0x18273645u
148#define KEY_DEBUG_MAGIC_X 0xf8e9dacbu
149#endif
150
151 unsigned long flags;
152#define KEY_FLAG_INSTANTIATED 0
153#define KEY_FLAG_DEAD 1
154#define KEY_FLAG_REVOKED 2
155#define KEY_FLAG_IN_QUOTA 3
156#define KEY_FLAG_USER_CONSTRUCT 4
157#define KEY_FLAG_NEGATIVE 5
158
159
160
161
162
163
164 char *description;
165
166
167
168
169 union {
170 struct list_head link;
171 unsigned long x[2];
172 void *p[2];
173 } type_data;
174
175
176
177
178
179 union {
180 unsigned long value;
181 void __rcu *rcudata;
182 void *data;
183 struct keyring_list __rcu *subscriptions;
184 } payload;
185};
186
187extern struct key *key_alloc(struct key_type *type,
188 const char *desc,
189 uid_t uid, gid_t gid,
190 const struct cred *cred,
191 key_perm_t perm,
192 unsigned long flags);
193
194
195#define KEY_ALLOC_IN_QUOTA 0x0000
196#define KEY_ALLOC_QUOTA_OVERRUN 0x0001
197#define KEY_ALLOC_NOT_IN_QUOTA 0x0002
198
199extern void key_revoke(struct key *key);
200extern void key_put(struct key *key);
201
202static inline struct key *key_get(struct key *key)
203{
204 if (key)
205 atomic_inc(&key->usage);
206 return key;
207}
208
209static inline void key_ref_put(key_ref_t key_ref)
210{
211 key_put(key_ref_to_ptr(key_ref));
212}
213
214extern struct key *request_key(struct key_type *type,
215 const char *description,
216 const char *callout_info);
217
218extern struct key *request_key_with_auxdata(struct key_type *type,
219 const char *description,
220 const void *callout_info,
221 size_t callout_len,
222 void *aux);
223
224extern struct key *request_key_async(struct key_type *type,
225 const char *description,
226 const void *callout_info,
227 size_t callout_len);
228
229extern struct key *request_key_async_with_auxdata(struct key_type *type,
230 const char *description,
231 const void *callout_info,
232 size_t callout_len,
233 void *aux);
234
235extern int wait_for_key_construction(struct key *key, bool intr);
236
237extern int key_validate(struct key *key);
238
239extern key_ref_t key_create_or_update(key_ref_t keyring,
240 const char *type,
241 const char *description,
242 const void *payload,
243 size_t plen,
244 key_perm_t perm,
245 unsigned long flags);
246
247extern int key_update(key_ref_t key,
248 const void *payload,
249 size_t plen);
250
251extern int key_link(struct key *keyring,
252 struct key *key);
253
254extern int key_unlink(struct key *keyring,
255 struct key *key);
256
257extern struct key *keyring_alloc(const char *description, uid_t uid, gid_t gid,
258 const struct cred *cred,
259 unsigned long flags,
260 struct key *dest);
261
262extern int keyring_clear(struct key *keyring);
263
264extern key_ref_t keyring_search(key_ref_t keyring,
265 struct key_type *type,
266 const char *description);
267
268extern int keyring_add_key(struct key *keyring,
269 struct key *key);
270
271extern struct key *key_lookup(key_serial_t id);
272
273static inline key_serial_t key_serial(struct key *key)
274{
275 return key ? key->serial : 0;
276}
277
278#ifdef CONFIG_SYSCTL
279extern ctl_table key_sysctls[];
280#endif
281
282extern void key_replace_session_keyring(void);
283
284
285
286
287extern int install_thread_keyring_to_cred(struct cred *cred);
288extern void key_fsuid_changed(struct task_struct *tsk);
289extern void key_fsgid_changed(struct task_struct *tsk);
290extern void key_init(void);
291
292#else
293
294#define key_validate(k) 0
295#define key_serial(k) 0
296#define key_get(k) ({ NULL; })
297#define key_revoke(k) do { } while(0)
298#define key_put(k) do { } while(0)
299#define key_ref_put(k) do { } while(0)
300#define make_key_ref(k, p) NULL
301#define key_ref_to_ptr(k) NULL
302#define is_key_possessed(k) 0
303#define key_fsuid_changed(t) do { } while(0)
304#define key_fsgid_changed(t) do { } while(0)
305#define key_init() do { } while(0)
306#define key_replace_session_keyring() do { } while(0)
307
308#endif
309#endif
310#endif
311