1
2
3
4
5
6
7
8
9
10#ifndef _LINUX_KEY_H
11#define _LINUX_KEY_H
12
13#include <linux/types.h>
14#include <linux/list.h>
15#include <linux/rbtree.h>
16#include <linux/rcupdate.h>
17#include <linux/sysctl.h>
18#include <linux/rwsem.h>
19#include <linux/atomic.h>
20#include <linux/assoc_array.h>
21#include <linux/refcount.h>
22#include <linux/time64.h>
23
24#ifdef __KERNEL__
25#include <linux/uidgid.h>
26
27
28typedef int32_t key_serial_t;
29
30
31typedef uint32_t key_perm_t;
32
33struct key;
34
35#ifdef CONFIG_KEYS
36
37#undef KEY_DEBUGGING
38
39#define KEY_POS_VIEW 0x01000000
40#define KEY_POS_READ 0x02000000
41#define KEY_POS_WRITE 0x04000000
42#define KEY_POS_SEARCH 0x08000000
43#define KEY_POS_LINK 0x10000000
44#define KEY_POS_SETATTR 0x20000000
45#define KEY_POS_ALL 0x3f000000
46
47#define KEY_USR_VIEW 0x00010000
48#define KEY_USR_READ 0x00020000
49#define KEY_USR_WRITE 0x00040000
50#define KEY_USR_SEARCH 0x00080000
51#define KEY_USR_LINK 0x00100000
52#define KEY_USR_SETATTR 0x00200000
53#define KEY_USR_ALL 0x003f0000
54
55#define KEY_GRP_VIEW 0x00000100
56#define KEY_GRP_READ 0x00000200
57#define KEY_GRP_WRITE 0x00000400
58#define KEY_GRP_SEARCH 0x00000800
59#define KEY_GRP_LINK 0x00001000
60#define KEY_GRP_SETATTR 0x00002000
61#define KEY_GRP_ALL 0x00003f00
62
63#define KEY_OTH_VIEW 0x00000001
64#define KEY_OTH_READ 0x00000002
65#define KEY_OTH_WRITE 0x00000004
66#define KEY_OTH_SEARCH 0x00000008
67#define KEY_OTH_LINK 0x00000010
68#define KEY_OTH_SETATTR 0x00000020
69#define KEY_OTH_ALL 0x0000003f
70
71#define KEY_PERM_UNDEF 0xffffffff
72
73struct seq_file;
74struct user_struct;
75struct signal_struct;
76struct cred;
77
78struct key_type;
79struct key_owner;
80struct keyring_list;
81struct keyring_name;
82
83struct keyring_index_key {
84 struct key_type *type;
85 const char *description;
86 size_t desc_len;
87};
88
89union key_payload {
90 void __rcu *rcu_data0;
91 void *data[4];
92};
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108typedef struct __key_reference_with_attributes *key_ref_t;
109
110static inline key_ref_t make_key_ref(const struct key *key,
111 bool possession)
112{
113 return (key_ref_t) ((unsigned long) key | possession);
114}
115
116static inline struct key *key_ref_to_ptr(const key_ref_t key_ref)
117{
118 return (struct key *) ((unsigned long) key_ref & ~1UL);
119}
120
121static inline bool is_key_possessed(const key_ref_t key_ref)
122{
123 return (unsigned long) key_ref & 1UL;
124}
125
126typedef int (*key_restrict_link_func_t)(struct key *dest_keyring,
127 const struct key_type *type,
128 const union key_payload *payload,
129 struct key *restriction_key);
130
131struct key_restriction {
132 key_restrict_link_func_t check;
133 struct key *key;
134 struct key_type *keytype;
135};
136
137enum key_state {
138 KEY_IS_UNINSTANTIATED,
139 KEY_IS_POSITIVE,
140};
141
142
143
144
145
146
147
148
149
150struct key {
151 refcount_t usage;
152 key_serial_t serial;
153 union {
154 struct list_head graveyard_link;
155 struct rb_node serial_node;
156 };
157 struct rw_semaphore sem;
158 struct key_user *user;
159 void *security;
160 union {
161 time64_t expiry;
162 time64_t revoked_at;
163 };
164 time64_t last_used_at;
165 kuid_t uid;
166 kgid_t gid;
167 key_perm_t perm;
168 unsigned short quotalen;
169 unsigned short datalen;
170
171
172
173 short state;
174
175#ifdef KEY_DEBUGGING
176 unsigned magic;
177#define KEY_DEBUG_MAGIC 0x18273645u
178#endif
179
180 unsigned long flags;
181#define KEY_FLAG_DEAD 0
182#define KEY_FLAG_REVOKED 1
183#define KEY_FLAG_IN_QUOTA 2
184#define KEY_FLAG_USER_CONSTRUCT 3
185#define KEY_FLAG_ROOT_CAN_CLEAR 4
186#define KEY_FLAG_INVALIDATED 5
187#define KEY_FLAG_BUILTIN 6
188#define KEY_FLAG_ROOT_CAN_INVAL 7
189#define KEY_FLAG_KEEP 8
190#define KEY_FLAG_UID_KEYRING 9
191
192
193
194
195
196
197 union {
198 struct keyring_index_key index_key;
199 struct {
200 struct key_type *type;
201 char *description;
202 };
203 };
204
205
206
207
208
209 union {
210 union key_payload payload;
211 struct {
212
213 struct list_head name_link;
214 struct assoc_array keys;
215 };
216 };
217
218
219
220
221
222
223
224
225
226
227
228
229 struct key_restriction *restrict_link;
230};
231
232extern struct key *key_alloc(struct key_type *type,
233 const char *desc,
234 kuid_t uid, kgid_t gid,
235 const struct cred *cred,
236 key_perm_t perm,
237 unsigned long flags,
238 struct key_restriction *restrict_link);
239
240
241#define KEY_ALLOC_IN_QUOTA 0x0000
242#define KEY_ALLOC_QUOTA_OVERRUN 0x0001
243#define KEY_ALLOC_NOT_IN_QUOTA 0x0002
244#define KEY_ALLOC_BUILT_IN 0x0004
245#define KEY_ALLOC_BYPASS_RESTRICTION 0x0008
246#define KEY_ALLOC_UID_KEYRING 0x0010
247
248extern void key_revoke(struct key *key);
249extern void key_invalidate(struct key *key);
250extern void key_put(struct key *key);
251
252static inline struct key *__key_get(struct key *key)
253{
254 refcount_inc(&key->usage);
255 return key;
256}
257
258static inline struct key *key_get(struct key *key)
259{
260 return key ? __key_get(key) : key;
261}
262
263static inline void key_ref_put(key_ref_t key_ref)
264{
265 key_put(key_ref_to_ptr(key_ref));
266}
267
268extern struct key *request_key(struct key_type *type,
269 const char *description,
270 const char *callout_info);
271
272extern struct key *request_key_with_auxdata(struct key_type *type,
273 const char *description,
274 const void *callout_info,
275 size_t callout_len,
276 void *aux);
277
278extern struct key *request_key_async(struct key_type *type,
279 const char *description,
280 const void *callout_info,
281 size_t callout_len);
282
283extern struct key *request_key_async_with_auxdata(struct key_type *type,
284 const char *description,
285 const void *callout_info,
286 size_t callout_len,
287 void *aux);
288
289extern int wait_for_key_construction(struct key *key, bool intr);
290
291extern int key_validate(const struct key *key);
292
293extern key_ref_t key_create_or_update(key_ref_t keyring,
294 const char *type,
295 const char *description,
296 const void *payload,
297 size_t plen,
298 key_perm_t perm,
299 unsigned long flags);
300
301extern int key_update(key_ref_t key,
302 const void *payload,
303 size_t plen);
304
305extern int key_link(struct key *keyring,
306 struct key *key);
307
308extern int key_unlink(struct key *keyring,
309 struct key *key);
310
311extern struct key *keyring_alloc(const char *description, kuid_t uid, kgid_t gid,
312 const struct cred *cred,
313 key_perm_t perm,
314 unsigned long flags,
315 struct key_restriction *restrict_link,
316 struct key *dest);
317
318extern int restrict_link_reject(struct key *keyring,
319 const struct key_type *type,
320 const union key_payload *payload,
321 struct key *restriction_key);
322
323extern int keyring_clear(struct key *keyring);
324
325extern key_ref_t keyring_search(key_ref_t keyring,
326 struct key_type *type,
327 const char *description);
328
329extern int keyring_add_key(struct key *keyring,
330 struct key *key);
331
332extern int keyring_restrict(key_ref_t keyring, const char *type,
333 const char *restriction);
334
335extern struct key *key_lookup(key_serial_t id);
336
337static inline key_serial_t key_serial(const struct key *key)
338{
339 return key ? key->serial : 0;
340}
341
342extern void key_set_timeout(struct key *, unsigned);
343
344extern key_ref_t lookup_user_key(key_serial_t id, unsigned long flags,
345 key_perm_t perm);
346
347
348
349
350#define KEY_NEED_VIEW 0x01
351#define KEY_NEED_READ 0x02
352#define KEY_NEED_WRITE 0x04
353#define KEY_NEED_SEARCH 0x08
354#define KEY_NEED_LINK 0x10
355#define KEY_NEED_SETATTR 0x20
356#define KEY_NEED_ALL 0x3f
357
358static inline short key_read_state(const struct key *key)
359{
360
361 return smp_load_acquire(&key->state);
362}
363
364
365
366
367
368
369
370
371static inline bool key_is_positive(const struct key *key)
372{
373 return key_read_state(key) == KEY_IS_POSITIVE;
374}
375
376static inline bool key_is_negative(const struct key *key)
377{
378 return key_read_state(key) < 0;
379}
380
381#define dereference_key_rcu(KEY) \
382 (rcu_dereference((KEY)->payload.rcu_data0))
383
384#define dereference_key_locked(KEY) \
385 (rcu_dereference_protected((KEY)->payload.rcu_data0, \
386 rwsem_is_locked(&((struct key *)(KEY))->sem)))
387
388#define rcu_assign_keypointer(KEY, PAYLOAD) \
389do { \
390 rcu_assign_pointer((KEY)->payload.rcu_data0, (PAYLOAD)); \
391} while (0)
392
393#ifdef CONFIG_SYSCTL
394extern struct ctl_table key_sysctls[];
395#endif
396
397
398
399extern int install_thread_keyring_to_cred(struct cred *cred);
400extern void key_fsuid_changed(struct task_struct *tsk);
401extern void key_fsgid_changed(struct task_struct *tsk);
402extern void key_init(void);
403
404#else
405
406#define key_validate(k) 0
407#define key_serial(k) 0
408#define key_get(k) ({ NULL; })
409#define key_revoke(k) do { } while(0)
410#define key_invalidate(k) do { } while(0)
411#define key_put(k) do { } while(0)
412#define key_ref_put(k) do { } while(0)
413#define make_key_ref(k, p) NULL
414#define key_ref_to_ptr(k) NULL
415#define is_key_possessed(k) 0
416#define key_fsuid_changed(t) do { } while(0)
417#define key_fsgid_changed(t) do { } while(0)
418#define key_init() do { } while(0)
419
420#endif
421#endif
422#endif
423