1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /* Authentication token and access key management
4 * Copyright (C) 2004, 2007 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
7 * See Documentation/security/keys/core.rst for information on keys/keyrings.
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>
25 #include <linux/uidgid.h>
27 /* key handle serial number */
28 typedef int32_t key_serial_t
;
30 /* key handle permissions mask */
31 typedef uint32_t key_perm_t
;
40 #define KEY_POS_VIEW 0x01000000 /* possessor can view a key's attributes */
41 #define KEY_POS_READ 0x02000000 /* possessor can read key payload / view keyring */
42 #define KEY_POS_WRITE 0x04000000 /* possessor can update key payload / add link to keyring */
43 #define KEY_POS_SEARCH 0x08000000 /* possessor can find a key in search / search a keyring */
44 #define KEY_POS_LINK 0x10000000 /* possessor can create a link to a key/keyring */
45 #define KEY_POS_SETATTR 0x20000000 /* possessor can set key attributes */
46 #define KEY_POS_ALL 0x3f000000
48 #define KEY_USR_VIEW 0x00010000 /* user permissions... */
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
56 #define KEY_GRP_VIEW 0x00000100 /* group permissions... */
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
64 #define KEY_OTH_VIEW 0x00000001 /* third party permissions... */
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
72 #define KEY_PERM_UNDEF 0xffffffff
88 bool removed
; /* T when subject removed */
91 struct keyring_index_key
{
92 /* [!] If this structure is altered, the union in struct key must change too! */
93 unsigned long hash
; /* Hash value */
96 #ifdef __LITTLE_ENDIAN /* Put desc_len at the LSB of x */
98 char desc
[sizeof(long) - 2]; /* First few chars of description */
100 char desc
[sizeof(long) - 2]; /* First few chars of description */
106 struct key_type
*type
;
107 struct key_tag
*domain_tag
; /* Domain of operation */
108 const char *description
;
112 void __rcu
*rcu_data0
;
116 /*****************************************************************************/
118 * key reference with possession attribute handling
120 * NOTE! key_ref_t is a typedef'd pointer to a type that is not actually
121 * defined. This is because we abuse the bottom bit of the reference to carry a
122 * flag to indicate whether the calling process possesses that key in one of
125 * the key_ref_t has been made a separate type so that the compiler can reject
126 * attempts to dereference it without proper conversion.
128 * the three functions are used to assemble and disassemble references
130 typedef struct __key_reference_with_attributes
*key_ref_t
;
132 static inline key_ref_t
make_key_ref(const struct key
*key
,
135 return (key_ref_t
) ((unsigned long) key
| possession
);
138 static inline struct key
*key_ref_to_ptr(const key_ref_t key_ref
)
140 return (struct key
*) ((unsigned long) key_ref
& ~1UL);
143 static inline bool is_key_possessed(const key_ref_t key_ref
)
145 return (unsigned long) key_ref
& 1UL;
148 typedef int (*key_restrict_link_func_t
)(struct key
*dest_keyring
,
149 const struct key_type
*type
,
150 const union key_payload
*payload
,
151 struct key
*restriction_key
);
153 struct key_restriction
{
154 key_restrict_link_func_t check
;
156 struct key_type
*keytype
;
160 KEY_IS_UNINSTANTIATED
,
161 KEY_IS_POSITIVE
, /* Positively instantiated */
164 /*****************************************************************************/
166 * authentication token / access credential / keyring
167 * - types of key include:
169 * - disk encryption IDs
170 * - Kerberos TGTs and tickets
173 refcount_t usage
; /* number of references */
174 key_serial_t serial
; /* key serial number */
176 struct list_head graveyard_link
;
177 struct rb_node serial_node
;
179 struct rw_semaphore sem
; /* change vs change sem */
180 struct key_user
*user
; /* owner of this key */
181 void *security
; /* security data for this key */
183 time64_t expiry
; /* time at which key expires (or 0) */
184 time64_t revoked_at
; /* time at which key was revoked */
186 time64_t last_used_at
; /* last time used for LRU keyring discard */
189 key_perm_t perm
; /* access permissions */
190 unsigned short quotalen
; /* length added to quota */
191 unsigned short datalen
; /* payload data length
192 * - may not match RCU dereferenced payload
193 * - payload should contain own length
195 short state
; /* Key state (+) or rejection error (-) */
199 #define KEY_DEBUG_MAGIC 0x18273645u
202 unsigned long flags
; /* status flags (change with bitops) */
203 #define KEY_FLAG_DEAD 0 /* set if key type has been deleted */
204 #define KEY_FLAG_REVOKED 1 /* set if key had been revoked */
205 #define KEY_FLAG_IN_QUOTA 2 /* set if key consumes quota */
206 #define KEY_FLAG_USER_CONSTRUCT 3 /* set if key is being constructed in userspace */
207 #define KEY_FLAG_ROOT_CAN_CLEAR 4 /* set if key can be cleared by root without permission */
208 #define KEY_FLAG_INVALIDATED 5 /* set if key has been invalidated */
209 #define KEY_FLAG_BUILTIN 6 /* set if key is built in to the kernel */
210 #define KEY_FLAG_ROOT_CAN_INVAL 7 /* set if key can be invalidated by root without permission */
211 #define KEY_FLAG_KEEP 8 /* set if key should not be removed */
212 #define KEY_FLAG_UID_KEYRING 9 /* set if key is a user or user session keyring */
214 /* the key type and key description string
215 * - the desc is used to match a key against search criteria
216 * - it should be a printable string
217 * - eg: for krb5 AFS, this might be "afs@REDHAT.COM"
220 struct keyring_index_key index_key
;
223 unsigned long len_desc
;
224 struct key_type
*type
; /* type of key */
225 struct key_tag
*domain_tag
; /* Domain of operation */
231 * - this is used to hold the data actually used in cryptography or
235 union key_payload payload
;
238 struct list_head name_link
;
239 struct assoc_array keys
;
243 /* This is set on a keyring to restrict the addition of a link to a key
244 * to it. If this structure isn't provided then it is assumed that the
245 * keyring is open to any addition. It is ignored for non-keyring
246 * keys. Only set this value using keyring_restrict(), keyring_alloc(),
249 * This is intended for use with rings of trusted keys whereby addition
250 * to the keyring needs to be controlled. KEY_ALLOC_BYPASS_RESTRICTION
251 * overrides this, allowing the kernel to add extra keys without
254 struct key_restriction
*restrict_link
;
257 extern struct key
*key_alloc(struct key_type
*type
,
259 kuid_t uid
, kgid_t gid
,
260 const struct cred
*cred
,
263 struct key_restriction
*restrict_link
);
266 #define KEY_ALLOC_IN_QUOTA 0x0000 /* add to quota, reject if would overrun */
267 #define KEY_ALLOC_QUOTA_OVERRUN 0x0001 /* add to quota, permit even if overrun */
268 #define KEY_ALLOC_NOT_IN_QUOTA 0x0002 /* not in quota */
269 #define KEY_ALLOC_BUILT_IN 0x0004 /* Key is built into kernel */
270 #define KEY_ALLOC_BYPASS_RESTRICTION 0x0008 /* Override the check on restricted keyrings */
271 #define KEY_ALLOC_UID_KEYRING 0x0010 /* allocating a user or user session keyring */
273 extern void key_revoke(struct key
*key
);
274 extern void key_invalidate(struct key
*key
);
275 extern void key_put(struct key
*key
);
276 extern bool key_put_tag(struct key_tag
*tag
);
277 extern void key_remove_domain(struct key_tag
*domain_tag
);
279 static inline struct key
*__key_get(struct key
*key
)
281 refcount_inc(&key
->usage
);
285 static inline struct key
*key_get(struct key
*key
)
287 return key
? __key_get(key
) : key
;
290 static inline void key_ref_put(key_ref_t key_ref
)
292 key_put(key_ref_to_ptr(key_ref
));
295 extern struct key
*request_key_tag(struct key_type
*type
,
296 const char *description
,
297 struct key_tag
*domain_tag
,
298 const char *callout_info
);
300 extern struct key
*request_key_rcu(struct key_type
*type
,
301 const char *description
,
302 struct key_tag
*domain_tag
);
304 extern struct key
*request_key_with_auxdata(struct key_type
*type
,
305 const char *description
,
306 struct key_tag
*domain_tag
,
307 const void *callout_info
,
312 * request_key - Request a key and wait for construction
313 * @type: Type of key.
314 * @description: The searchable description of the key.
315 * @callout_info: The data to pass to the instantiation upcall (or NULL).
317 * As for request_key_tag(), but with the default global domain tag.
319 static inline struct key
*request_key(struct key_type
*type
,
320 const char *description
,
321 const char *callout_info
)
323 return request_key_tag(type
, description
, NULL
, callout_info
);
328 * request_key_net - Request a key for a net namespace and wait for construction
329 * @type: Type of key.
330 * @description: The searchable description of the key.
331 * @net: The network namespace that is the key's domain of operation.
332 * @callout_info: The data to pass to the instantiation upcall (or NULL).
334 * As for request_key() except that it does not add the returned key to a
335 * keyring if found, new keys are always allocated in the user's quota, the
336 * callout_info must be a NUL-terminated string and no auxiliary data can be
337 * passed. Only keys that operate the specified network namespace are used.
339 * Furthermore, it then works as wait_for_key_construction() to wait for the
340 * completion of keys undergoing construction with a non-interruptible wait.
342 #define request_key_net(type, description, net, callout_info) \
343 request_key_tag(type, description, net->key_domain, callout_info);
344 #endif /* CONFIG_NET */
346 extern int wait_for_key_construction(struct key
*key
, bool intr
);
348 extern int key_validate(const struct key
*key
);
350 extern key_ref_t
key_create_or_update(key_ref_t keyring
,
352 const char *description
,
356 unsigned long flags
);
358 extern int key_update(key_ref_t key
,
362 extern int key_link(struct key
*keyring
,
365 extern int key_move(struct key
*key
,
366 struct key
*from_keyring
,
367 struct key
*to_keyring
,
370 extern int key_unlink(struct key
*keyring
,
373 extern struct key
*keyring_alloc(const char *description
, kuid_t uid
, kgid_t gid
,
374 const struct cred
*cred
,
377 struct key_restriction
*restrict_link
,
380 extern int restrict_link_reject(struct key
*keyring
,
381 const struct key_type
*type
,
382 const union key_payload
*payload
,
383 struct key
*restriction_key
);
385 extern int keyring_clear(struct key
*keyring
);
387 extern key_ref_t
keyring_search(key_ref_t keyring
,
388 struct key_type
*type
,
389 const char *description
,
392 extern int keyring_add_key(struct key
*keyring
,
395 extern int keyring_restrict(key_ref_t keyring
, const char *type
,
396 const char *restriction
);
398 extern struct key
*key_lookup(key_serial_t id
);
400 static inline key_serial_t
key_serial(const struct key
*key
)
402 return key
? key
->serial
: 0;
405 extern void key_set_timeout(struct key
*, unsigned);
407 extern key_ref_t
lookup_user_key(key_serial_t id
, unsigned long flags
,
409 extern void key_free_user_ns(struct user_namespace
*);
412 * The permissions required on a key that we're looking up.
414 #define KEY_NEED_VIEW 0x01 /* Require permission to view attributes */
415 #define KEY_NEED_READ 0x02 /* Require permission to read content */
416 #define KEY_NEED_WRITE 0x04 /* Require permission to update / modify */
417 #define KEY_NEED_SEARCH 0x08 /* Require permission to search (keyring) or find (key) */
418 #define KEY_NEED_LINK 0x10 /* Require permission to link */
419 #define KEY_NEED_SETATTR 0x20 /* Require permission to change attributes */
420 #define KEY_NEED_ALL 0x3f /* All the above permissions */
422 static inline short key_read_state(const struct key
*key
)
424 /* Barrier versus mark_key_instantiated(). */
425 return smp_load_acquire(&key
->state
);
429 * key_is_positive - Determine if a key has been positively instantiated
430 * @key: The key to check.
432 * Return true if the specified key has been positively instantiated, false
435 static inline bool key_is_positive(const struct key
*key
)
437 return key_read_state(key
) == KEY_IS_POSITIVE
;
440 static inline bool key_is_negative(const struct key
*key
)
442 return key_read_state(key
) < 0;
445 #define dereference_key_rcu(KEY) \
446 (rcu_dereference((KEY)->payload.rcu_data0))
448 #define dereference_key_locked(KEY) \
449 (rcu_dereference_protected((KEY)->payload.rcu_data0, \
450 rwsem_is_locked(&((struct key *)(KEY))->sem)))
452 #define rcu_assign_keypointer(KEY, PAYLOAD) \
454 rcu_assign_pointer((KEY)->payload.rcu_data0, (PAYLOAD)); \
458 extern struct ctl_table key_sysctls
[];
461 * the userspace interface
463 extern int install_thread_keyring_to_cred(struct cred
*cred
);
464 extern void key_fsuid_changed(struct cred
*new_cred
);
465 extern void key_fsgid_changed(struct cred
*new_cred
);
466 extern void key_init(void);
468 #else /* CONFIG_KEYS */
470 #define key_validate(k) 0
471 #define key_serial(k) 0
472 #define key_get(k) ({ NULL; })
473 #define key_revoke(k) do { } while(0)
474 #define key_invalidate(k) do { } while(0)
475 #define key_put(k) do { } while(0)
476 #define key_ref_put(k) do { } while(0)
477 #define make_key_ref(k, p) NULL
478 #define key_ref_to_ptr(k) NULL
479 #define is_key_possessed(k) 0
480 #define key_fsuid_changed(c) do { } while(0)
481 #define key_fsgid_changed(c) do { } while(0)
482 #define key_init() do { } while(0)
483 #define key_free_user_ns(ns) do { } while(0)
484 #define key_remove_domain(d) do { } while(0)
486 #endif /* CONFIG_KEYS */
487 #endif /* __KERNEL__ */
488 #endif /* _LINUX_KEY_H */