[mirror_ubuntu-jammy-kernel.git] / security / keys / internal.h

/* Authentication token and access key management internal defs
 *
 * Copyright (C) 2003-5, 2007 Red Hat, Inc. All Rights Reserved.
 * Written by David Howells (dhowells@redhat.com)
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version
 * 2 of the License, or (at your option) any later version.
 */

#ifndef _INTERNAL_H
#define _INTERNAL_H

#include <linux/sched.h>
#include <linux/key-type.h>
#include <linux/task_work.h>

struct iovec;

#ifdef __KDEBUG
#define kenter(FMT, ...) \
	printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
#define kleave(FMT, ...) \
	printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
#define kdebug(FMT, ...) \
	printk(KERN_DEBUG "   "FMT"\n", ##__VA_ARGS__)
#else
#define kenter(FMT, ...) \
	no_printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
#define kleave(FMT, ...) \
	no_printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
#define kdebug(FMT, ...) \
	no_printk(KERN_DEBUG FMT"\n", ##__VA_ARGS__)
#endif

extern struct key_type key_type_dead;
extern struct key_type key_type_user;
extern struct key_type key_type_logon;

/*****************************************************************************/
/*
 * Keep track of keys for a user.
 *
 * This needs to be separate to user_struct to avoid a refcount-loop
 * (user_struct pins some keyrings which pin this struct).
 *
 * We also keep track of keys under request from userspace for this UID here.
 */
struct key_user {
	struct rb_node		node;
	struct mutex		cons_lock;	/* construction initiation lock */
	spinlock_t		lock;
	atomic_t		usage;		/* for accessing qnkeys & qnbytes */
	atomic_t		nkeys;		/* number of keys */
	atomic_t		nikeys;		/* number of instantiated keys */
	kuid_t			uid;
	int			qnkeys;		/* number of keys allocated to this user */
	int			qnbytes;	/* number of bytes allocated to this user */
};

extern struct rb_root	key_user_tree;
extern spinlock_t	key_user_lock;
extern struct key_user	root_key_user;

extern struct key_user *key_user_lookup(kuid_t uid);
extern void key_user_put(struct key_user *user);

/*
 * Key quota limits.
 * - root has its own separate limits to everyone else
 */
extern unsigned key_quota_root_maxkeys;
extern unsigned key_quota_root_maxbytes;
extern unsigned key_quota_maxkeys;
extern unsigned key_quota_maxbytes;

#define KEYQUOTA_LINK_BYTES	4		/* a link in a keyring is worth 4 bytes */


extern struct kmem_cache *key_jar;
extern struct rb_root key_serial_tree;
extern spinlock_t key_serial_lock;
extern struct mutex key_construction_mutex;
extern wait_queue_head_t request_key_conswq;


extern struct key_type *key_type_lookup(const char *type);
extern void key_type_put(struct key_type *ktype);

extern int __key_link_begin(struct key *keyring,
			    const struct keyring_index_key *index_key,
			    unsigned long *_prealloc);
extern int __key_link_check_live_key(struct key *keyring, struct key *key);
extern void __key_link(struct key *keyring, struct key *key,
		       unsigned long *_prealloc);
extern void __key_link_end(struct key *keyring,
			   const struct keyring_index_key *index_key,
			   unsigned long prealloc);

extern key_ref_t __keyring_search_one(key_ref_t keyring_ref,
				      const struct keyring_index_key *index_key,
				      key_perm_t perm);

extern struct key *keyring_search_instkey(struct key *keyring,
					  key_serial_t target_id);

typedef int (*key_match_func_t)(const struct key *, const void *);

extern key_ref_t keyring_search_aux(key_ref_t keyring_ref,
				    const struct cred *cred,
				    struct key_type *type,
				    const void *description,
				    key_match_func_t match,
				    bool no_state_check);

extern key_ref_t search_my_process_keyrings(struct key_type *type,
					    const void *description,
					    key_match_func_t match,
					    bool no_state_check,
					    const struct cred *cred);
extern key_ref_t search_process_keyrings(struct key_type *type,
					 const void *description,
					 key_match_func_t match,
					 bool no_state_check,
					 const struct cred *cred);

extern struct key *find_keyring_by_name(const char *name, bool skip_perm_check);

extern int install_user_keyrings(void);
extern int install_thread_keyring_to_cred(struct cred *);
extern int install_process_keyring_to_cred(struct cred *);
extern int install_session_keyring_to_cred(struct cred *, struct key *);

extern struct key *request_key_and_link(struct key_type *type,
					const char *description,
					const void *callout_info,
					size_t callout_len,
					void *aux,
					struct key *dest_keyring,
					unsigned long flags);

extern int lookup_user_key_possessed(const struct key *key, const void *target);
extern key_ref_t lookup_user_key(key_serial_t id, unsigned long flags,
				 key_perm_t perm);
#define KEY_LOOKUP_CREATE	0x01
#define KEY_LOOKUP_PARTIAL	0x02
#define KEY_LOOKUP_FOR_UNLINK	0x04

extern long join_session_keyring(const char *name);
extern void key_change_session_keyring(struct callback_head *twork);

extern struct work_struct key_gc_work;
extern unsigned key_gc_delay;
extern void keyring_gc(struct key *keyring, time_t limit);
extern void key_schedule_gc(time_t gc_at);
extern void key_schedule_gc_links(void);
extern void key_gc_keytype(struct key_type *ktype);

extern int key_task_permission(const key_ref_t key_ref,
			       const struct cred *cred,
			       key_perm_t perm);

/*
 * Check to see whether permission is granted to use a key in the desired way.
 */
static inline int key_permission(const key_ref_t key_ref, key_perm_t perm)
{
	return key_task_permission(key_ref, current_cred(), perm);
}

/* required permissions */
#define	KEY_VIEW	0x01	/* require permission to view attributes */
#define	KEY_READ	0x02	/* require permission to read content */
#define	KEY_WRITE	0x04	/* require permission to update / modify */
#define	KEY_SEARCH	0x08	/* require permission to search (keyring) or find (key) */
#define	KEY_LINK	0x10	/* require permission to link */
#define	KEY_SETATTR	0x20	/* require permission to change attributes */
#define	KEY_ALL		0x3f	/* all the above permissions */

/*
 * Authorisation record for request_key().
 */
struct request_key_auth {
	struct key		*target_key;
	struct key		*dest_keyring;
	const struct cred	*cred;
	void			*callout_info;
	size_t			callout_len;
	pid_t			pid;
};

extern struct key_type key_type_request_key_auth;
extern struct key *request_key_auth_new(struct key *target,
					const void *callout_info,
					size_t callout_len,
					struct key *dest_keyring);

extern struct key *key_get_instantiation_authkey(key_serial_t target_id);

/*
 * Determine whether a key is dead.
 */
static inline bool key_is_dead(const struct key *key, time_t limit)
{
	return
		key->flags & ((1 << KEY_FLAG_DEAD) |
			      (1 << KEY_FLAG_INVALIDATED)) ||
		(key->expiry > 0 && key->expiry <= limit);
}

/*
 * keyctl() functions
 */
extern long keyctl_get_keyring_ID(key_serial_t, int);
extern long keyctl_join_session_keyring(const char __user *);
extern long keyctl_update_key(key_serial_t, const void __user *, size_t);
extern long keyctl_revoke_key(key_serial_t);
extern long keyctl_keyring_clear(key_serial_t);
extern long keyctl_keyring_link(key_serial_t, key_serial_t);
extern long keyctl_keyring_unlink(key_serial_t, key_serial_t);
extern long keyctl_describe_key(key_serial_t, char __user *, size_t);
extern long keyctl_keyring_search(key_serial_t, const char __user *,
				  const char __user *, key_serial_t);
extern long keyctl_read_key(key_serial_t, char __user *, size_t);
extern long keyctl_chown_key(key_serial_t, uid_t, gid_t);
extern long keyctl_setperm_key(key_serial_t, key_perm_t);
extern long keyctl_instantiate_key(key_serial_t, const void __user *,
				   size_t, key_serial_t);
extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t);
extern long keyctl_set_reqkey_keyring(int);
extern long keyctl_set_timeout(key_serial_t, unsigned);
extern long keyctl_assume_authority(key_serial_t);
extern long keyctl_get_security(key_serial_t keyid, char __user *buffer,
				size_t buflen);
extern long keyctl_session_to_parent(void);
extern long keyctl_reject_key(key_serial_t, unsigned, unsigned, key_serial_t);
extern long keyctl_instantiate_key_iov(key_serial_t,
				       const struct iovec __user *,
				       unsigned, key_serial_t);
extern long keyctl_invalidate_key(key_serial_t);

extern long keyctl_instantiate_key_common(key_serial_t,
					  const struct iovec *,
					  unsigned, size_t, key_serial_t);

/*
 * Debugging key validation
 */
#ifdef KEY_DEBUGGING
extern void __key_check(const struct key *);

static inline void key_check(const struct key *key)
{
	if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC))
		__key_check(key);
}

#else

#define key_check(key) do {} while(0)

#endif

#endif /* _INTERNAL_H */
Commit	Line	Data
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>
413cd3d9	17	#include <linux/task_work.h>
1da177e4	18
a27bb332 KO	19	struct iovec;
a27bb332 KO	20
76181c13 DH	21	#ifdef __KDEBUG
76181c13 DH	22	#define kenter(FMT, ...) \
dd6f953a	23	printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
76181c13	24	#define kleave(FMT, ...) \
dd6f953a	25	printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
76181c13	26	#define kdebug(FMT, ...) \
d84f4f99	27	printk(KERN_DEBUG " "FMT"\n", ##__VA_ARGS__)
3e30148c	28	#else
76181c13	29	#define kenter(FMT, ...) \
dd6f953a	30	no_printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
76181c13	31	#define kleave(FMT, ...) \
dd6f953a	32	no_printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
76181c13 DH	33	#define kdebug(FMT, ...) \
76181c13 DH	34	no_printk(KERN_DEBUG FMT"\n", ##__VA_ARGS__)
3e30148c DH	35	#endif
3e30148c DH	36
0c061b57	37	extern struct key_type key_type_dead;
1da177e4	38	extern struct key_type key_type_user;
9f6ed2ca	39	extern struct key_type key_type_logon;
1da177e4 LT	40
	41	/*****************************************************************************/
	42	/*
973c9f4f DH	43	* Keep track of keys for a user.
	44	*
	45	* This needs to be separate to user_struct to avoid a refcount-loop
	46	* (user_struct pins some keyrings which pin this struct).
	47	*
	48	* We also keep track of keys under request from userspace for this UID here.
1da177e4 LT	49	*/
	50	struct key_user {
	51	struct rb_node node;
76181c13	52	struct mutex cons_lock; /* construction initiation lock */
1da177e4 LT	53	spinlock_t lock;
	54	atomic_t usage; /* for accessing qnkeys & qnbytes */
	55	atomic_t nkeys; /* number of keys */
	56	atomic_t nikeys; /* number of instantiated keys */
9a56c2db	57	kuid_t uid;
1da177e4 LT	58	int qnkeys; /* number of keys allocated to this user */
	59	int qnbytes; /* number of bytes allocated to this user */
	60	};
	61
1da177e4 LT	62	extern struct rb_root key_user_tree;
	63	extern spinlock_t key_user_lock;
	64	extern struct key_user root_key_user;
	65
9a56c2db	66	extern struct key_user *key_user_lookup(kuid_t uid);
1da177e4 LT	67	extern void key_user_put(struct key_user *user);
1da177e4 LT	68
0b77f5bf	69	/*
973c9f4f	70	* Key quota limits.
0b77f5bf DH	71	* - root has its own separate limits to everyone else
	72	*/
	73	extern unsigned key_quota_root_maxkeys;
	74	extern unsigned key_quota_root_maxbytes;
	75	extern unsigned key_quota_maxkeys;
	76	extern unsigned key_quota_maxbytes;
	77
	78	#define KEYQUOTA_LINK_BYTES 4 /* a link in a keyring is worth 4 bytes */
1da177e4 LT	79
1da177e4 LT	80
8bc16dea	81	extern struct kmem_cache *key_jar;
1da177e4 LT	82	extern struct rb_root key_serial_tree;
1da177e4 LT	83	extern spinlock_t key_serial_lock;
76181c13	84	extern struct mutex key_construction_mutex;
1da177e4 LT	85	extern wait_queue_head_t request_key_conswq;
	86
	87
e9e349b0 DH	88	extern struct key_type key_type_lookup(const char type);
	89	extern void key_type_put(struct key_type *ktype);
	90
f70e2e06	91	extern int __key_link_begin(struct key *keyring,
16feef43	92	const struct keyring_index_key *index_key,
ceb73c12	93	unsigned long *_prealloc);
f70e2e06 DH	94	extern int __key_link_check_live_key(struct key keyring, struct key key);
f70e2e06 DH	95	extern void __key_link(struct key keyring, struct key key,
ceb73c12	96	unsigned long *_prealloc);
f70e2e06	97	extern void __key_link_end(struct key *keyring,
16feef43	98	const struct keyring_index_key *index_key,
ceb73c12	99	unsigned long prealloc);
1da177e4	100
664cceb0	101	extern key_ref_t __keyring_search_one(key_ref_t keyring_ref,
16feef43	102	const struct keyring_index_key *index_key,
664cceb0	103	key_perm_t perm);
1da177e4	104
3e30148c DH	105	extern struct key keyring_search_instkey(struct key keyring,
	106	key_serial_t target_id);
	107
1da177e4 LT	108	typedef int (key_match_func_t)(const struct key , const void *);
1da177e4 LT	109
664cceb0	110	extern key_ref_t keyring_search_aux(key_ref_t keyring_ref,
d84f4f99	111	const struct cred *cred,
664cceb0 DH	112	struct key_type *type,
664cceb0 DH	113	const void *description,
78b7280c DH	114	key_match_func_t match,
78b7280c DH	115	bool no_state_check);
1da177e4	116
927942aa DH	117	extern key_ref_t search_my_process_keyrings(struct key_type *type,
	118	const void *description,
	119	key_match_func_t match,
78b7280c	120	bool no_state_check,
927942aa	121	const struct cred *cred);
664cceb0 DH	122	extern key_ref_t search_process_keyrings(struct key_type *type,
	123	const void *description,
	124	key_match_func_t match,
61ea0c0b	125	bool no_state_check,
d84f4f99	126	const struct cred *cred);
1da177e4	127
69664cf1	128	extern struct key find_keyring_by_name(const char name, bool skip_perm_check);
1da177e4	129
8bbf4976	130	extern int install_user_keyrings(void);
d84f4f99 DH	131	extern int install_thread_keyring_to_cred(struct cred *);
d84f4f99 DH	132	extern int install_process_keyring_to_cred(struct cred *);
685bfd2c	133	extern int install_session_keyring_to_cred(struct cred , struct key );
3e30148c DH	134
	135	extern struct key request_key_and_link(struct key_type type,
	136	const char *description,
4a38e122 DH	137	const void *callout_info,
4a38e122 DH	138	size_t callout_len,
4e54f085	139	void *aux,
7e047ef5 DH	140	struct key *dest_keyring,
7e047ef5 DH	141	unsigned long flags);
3e30148c	142
927942aa	143	extern int lookup_user_key_possessed(const struct key key, const void target);
5593122e	144	extern key_ref_t lookup_user_key(key_serial_t id, unsigned long flags,
e9e349b0	145	key_perm_t perm);
5593122e DH	146	#define KEY_LOOKUP_CREATE 0x01
	147	#define KEY_LOOKUP_PARTIAL 0x02
	148	#define KEY_LOOKUP_FOR_UNLINK 0x04
e9e349b0 DH	149
e9e349b0 DH	150	extern long join_session_keyring(const char *name);
67d12145	151	extern void key_change_session_keyring(struct callback_head *twork);
e9e349b0	152
0c061b57	153	extern struct work_struct key_gc_work;
5d135440 DH	154	extern unsigned key_gc_delay;
5d135440 DH	155	extern void keyring_gc(struct key *keyring, time_t limit);
fd75815f DH	156	extern void key_schedule_gc(time_t gc_at);
fd75815f DH	157	extern void key_schedule_gc_links(void);
0c061b57	158	extern void key_gc_keytype(struct key_type *ktype);
5d135440	159
e9e349b0	160	extern int key_task_permission(const key_ref_t key_ref,
d84f4f99	161	const struct cred *cred,
e9e349b0 DH	162	key_perm_t perm);
e9e349b0 DH	163
973c9f4f DH	164	/*
	165	* Check to see whether permission is granted to use a key in the desired way.
	166	*/
e9e349b0 DH	167	static inline int key_permission(const key_ref_t key_ref, key_perm_t perm)
e9e349b0 DH	168	{
d84f4f99	169	return key_task_permission(key_ref, current_cred(), perm);
e9e349b0 DH	170	}
	171
	172	/* required permissions */
	173	#define KEY_VIEW 0x01 /* require permission to view attributes */
	174	#define KEY_READ 0x02 /* require permission to read content */
	175	#define KEY_WRITE 0x04 /* require permission to update / modify */
	176	#define KEY_SEARCH 0x08 /* require permission to search (keyring) or find (key) */
	177	#define KEY_LINK 0x10 /* require permission to link */
	178	#define KEY_SETATTR 0x20 /* require permission to change attributes */
	179	#define KEY_ALL 0x3f /* all the above permissions */
	180
3e30148c	181	/*
973c9f4f	182	* Authorisation record for request_key().
3e30148c DH	183	*/
	184	struct request_key_auth {
	185	struct key *target_key;
8bbf4976	186	struct key *dest_keyring;
d84f4f99	187	const struct cred *cred;
4a38e122 DH	188	void *callout_info;
4a38e122 DH	189	size_t callout_len;
3e30148c DH	190	pid_t pid;
	191	};
	192
	193	extern struct key_type key_type_request_key_auth;
	194	extern struct key request_key_auth_new(struct key target,
4a38e122	195	const void *callout_info,
8bbf4976 DH	196	size_t callout_len,
8bbf4976 DH	197	struct key *dest_keyring);
3e30148c DH	198
3e30148c DH	199	extern struct key *key_get_instantiation_authkey(key_serial_t target_id);
1da177e4	200
fd75815f DH	201	/*
	202	* Determine whether a key is dead.
	203	*/
7e55ca6d	204	static inline bool key_is_dead(const struct key *key, time_t limit)
fd75815f DH	205	{
	206	return
	207	key->flags & ((1 << KEY_FLAG_DEAD) \|
	208	(1 << KEY_FLAG_INVALIDATED)) \|\|
	209	(key->expiry > 0 && key->expiry <= limit);
	210	}
	211
1da177e4	212	/*
973c9f4f	213	* keyctl() functions
1da177e4 LT	214	*/
	215	extern long keyctl_get_keyring_ID(key_serial_t, int);
	216	extern long keyctl_join_session_keyring(const char __user *);
	217	extern long keyctl_update_key(key_serial_t, const void __user *, size_t);
	218	extern long keyctl_revoke_key(key_serial_t);
	219	extern long keyctl_keyring_clear(key_serial_t);
	220	extern long keyctl_keyring_link(key_serial_t, key_serial_t);
	221	extern long keyctl_keyring_unlink(key_serial_t, key_serial_t);
	222	extern long keyctl_describe_key(key_serial_t, char __user *, size_t);
	223	extern long keyctl_keyring_search(key_serial_t, const char __user *,
	224	const char __user *, key_serial_t);
	225	extern long keyctl_read_key(key_serial_t, char __user *, size_t);
	226	extern long keyctl_chown_key(key_serial_t, uid_t, gid_t);
	227	extern long keyctl_setperm_key(key_serial_t, key_perm_t);
	228	extern long keyctl_instantiate_key(key_serial_t, const void __user *,
	229	size_t, key_serial_t);
	230	extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t);
3e30148c	231	extern long keyctl_set_reqkey_keyring(int);
017679c4	232	extern long keyctl_set_timeout(key_serial_t, unsigned);
b5f545c8	233	extern long keyctl_assume_authority(key_serial_t);
70a5bb72 DH	234	extern long keyctl_get_security(key_serial_t keyid, char __user *buffer,
70a5bb72 DH	235	size_t buflen);
ee18d64c	236	extern long keyctl_session_to_parent(void);
fdd1b945	237	extern long keyctl_reject_key(key_serial_t, unsigned, unsigned, key_serial_t);
ee009e4a DH	238	extern long keyctl_instantiate_key_iov(key_serial_t,
	239	const struct iovec __user *,
	240	unsigned, key_serial_t);
fd75815f	241	extern long keyctl_invalidate_key(key_serial_t);
ee009e4a DH	242
ee009e4a DH	243	extern long keyctl_instantiate_key_common(key_serial_t,
423b9788	244	const struct iovec *,
ee009e4a	245	unsigned, size_t, key_serial_t);
1da177e4 LT	246
1da177e4 LT	247	/*
973c9f4f	248	* Debugging key validation
1da177e4 LT	249	*/
	250	#ifdef KEY_DEBUGGING
	251	extern void __key_check(const struct key *);
	252
	253	static inline void key_check(const struct key *key)
	254	{
	255	if (key && (IS_ERR(key) \|\| key->magic != KEY_DEBUG_MAGIC))
	256	__key_check(key);
	257	}
	258
	259	#else
	260
	261	#define key_check(key) do {} while(0)
	262
	263	#endif
	264
	265	#endif /* _INTERNAL_H */