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

/* SPDX-License-Identifier: GPL-2.0-or-later */
/* 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)
 */

#ifndef _INTERNAL_H
#define _INTERNAL_H

#include <linux/sched.h>
#include <linux/wait_bit.h>
#include <linux/cred.h>
#include <linux/key-type.h>
#include <linux/task_work.h>
#include <linux/keyctl.h>
#include <linux/refcount.h>
#include <linux/compat.h>
#include <linux/mm.h>
#include <linux/vmalloc.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;
	refcount_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 void key_set_index_key(struct keyring_index_key *index_key);
extern struct key_type *key_type_lookup(const char *type);
extern void key_type_put(struct key_type *ktype);

extern int __key_link_lock(struct key *keyring,
			   const struct keyring_index_key *index_key);
extern int __key_move_lock(struct key *l_keyring, struct key *u_keyring,
			   const struct keyring_index_key *index_key);
extern int __key_link_begin(struct key *keyring,
			    const struct keyring_index_key *index_key,
			    struct assoc_array_edit **_edit);
extern int __key_link_check_live_key(struct key *keyring, struct key *key);
extern void __key_link(struct key *key, struct assoc_array_edit **_edit);
extern void __key_link_end(struct key *keyring,
			   const struct keyring_index_key *index_key,
			   struct assoc_array_edit *edit);

extern key_ref_t find_key_to_update(key_ref_t keyring_ref,
				    const struct keyring_index_key *index_key);

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

extern int iterate_over_keyring(const struct key *keyring,
				int (*func)(const struct key *key, void *data),
				void *data);

struct keyring_search_context {
	struct keyring_index_key index_key;
	const struct cred	*cred;
	struct key_match_data	match_data;
	unsigned		flags;
#define KEYRING_SEARCH_NO_STATE_CHECK	0x0001	/* Skip state checks */
#define KEYRING_SEARCH_DO_STATE_CHECK	0x0002	/* Override NO_STATE_CHECK */
#define KEYRING_SEARCH_NO_UPDATE_TIME	0x0004	/* Don't update times */
#define KEYRING_SEARCH_NO_CHECK_PERM	0x0008	/* Don't check permissions */
#define KEYRING_SEARCH_DETECT_TOO_DEEP	0x0010	/* Give an error on excessive depth */
#define KEYRING_SEARCH_SKIP_EXPIRED	0x0020	/* Ignore expired keys (intention to replace) */
#define KEYRING_SEARCH_RECURSE		0x0040	/* Search child keyrings also */

	int (*iterator)(const void *object, void *iterator_data);

	/* Internal stuff */
	int			skipped_ret;
	bool			possessed;
	key_ref_t		result;
	time64_t		now;
};

extern bool key_default_cmp(const struct key *key,
			    const struct key_match_data *match_data);
extern key_ref_t keyring_search_rcu(key_ref_t keyring_ref,
				    struct keyring_search_context *ctx);

extern key_ref_t search_cred_keyrings_rcu(struct keyring_search_context *ctx);
extern key_ref_t search_process_keyrings_rcu(struct keyring_search_context *ctx);

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

extern int look_up_user_keyrings(struct key **, struct key **);
extern struct key *get_user_session_keyring_rcu(const struct cred *);
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,
					struct key_tag *domain_tag,
					const void *callout_info,
					size_t callout_len,
					void *aux,
					struct key *dest_keyring,
					unsigned long flags);

extern bool lookup_user_key_possessed(const struct key *key,
				      const struct key_match_data *match_data);
#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, time64_t limit);
extern void keyring_restriction_gc(struct key *keyring,
				   struct key_type *dead_type);
extern void key_schedule_gc(time64_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, unsigned perm)
{
	return key_task_permission(key_ref, current_cred(), perm);
}

extern struct key_type key_type_request_key_auth;
extern struct key *request_key_auth_new(struct key *target,
					const char *op,
					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, time64_t limit)
{
	return
		key->flags & ((1 << KEY_FLAG_DEAD) |
			      (1 << KEY_FLAG_INVALIDATED)) ||
		(key->expiry > 0 && key->expiry <= limit) ||
		key->domain_tag->removed;
}

/*
 * 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_move(key_serial_t, key_serial_t, key_serial_t, unsigned int);
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);

struct iov_iter;
extern long keyctl_instantiate_key_common(key_serial_t,
					  struct iov_iter *,
					  key_serial_t);
extern long keyctl_restrict_keyring(key_serial_t id,
				    const char __user *_type,
				    const char __user *_restriction);
#ifdef CONFIG_PERSISTENT_KEYRINGS
extern long keyctl_get_persistent(uid_t, key_serial_t);
extern unsigned persistent_keyring_expiry;
#else
static inline long keyctl_get_persistent(uid_t uid, key_serial_t destring)
{
	return -EOPNOTSUPP;
}
#endif

#ifdef CONFIG_KEY_DH_OPERATIONS
extern long keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *,
			      size_t, struct keyctl_kdf_params __user *);
extern long __keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *,
				size_t, struct keyctl_kdf_params *);
#ifdef CONFIG_COMPAT
extern long compat_keyctl_dh_compute(struct keyctl_dh_params __user *params,
				char __user *buffer, size_t buflen,
				struct compat_keyctl_kdf_params __user *kdf);
#endif
#define KEYCTL_KDF_MAX_OUTPUT_LEN	1024	/* max length of KDF output */
#define KEYCTL_KDF_MAX_OI_LEN		64	/* max length of otherinfo */
#else
static inline long keyctl_dh_compute(struct keyctl_dh_params __user *params,
				     char __user *buffer, size_t buflen,
				     struct keyctl_kdf_params __user *kdf)
{
	return -EOPNOTSUPP;
}

#ifdef CONFIG_COMPAT
static inline long compat_keyctl_dh_compute(
				struct keyctl_dh_params __user *params,
				char __user *buffer, size_t buflen,
				struct keyctl_kdf_params __user *kdf)
{
	return -EOPNOTSUPP;
}
#endif
#endif

#ifdef CONFIG_ASYMMETRIC_KEY_TYPE
extern long keyctl_pkey_query(key_serial_t,
			      const char __user *,
			      struct keyctl_pkey_query __user *);

extern long keyctl_pkey_verify(const struct keyctl_pkey_params __user *,
			       const char __user *,
			       const void __user *, const void __user *);

extern long keyctl_pkey_e_d_s(int,
			      const struct keyctl_pkey_params __user *,
			      const char __user *,
			      const void __user *, void __user *);
#else
static inline long keyctl_pkey_query(key_serial_t id,
				     const char __user *_info,
				     struct keyctl_pkey_query __user *_res)
{
	return -EOPNOTSUPP;
}

static inline long keyctl_pkey_verify(const struct keyctl_pkey_params __user *params,
				      const char __user *_info,
				      const void __user *_in,
				      const void __user *_in2)
{
	return -EOPNOTSUPP;
}

static inline long keyctl_pkey_e_d_s(int op,
				     const struct keyctl_pkey_params __user *params,
				     const char __user *_info,
				     const void __user *_in,
				     void __user *_out)
{
	return -EOPNOTSUPP;
}
#endif

extern long keyctl_capabilities(unsigned char __user *_buffer, size_t buflen);

/*
 * 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

/*
 * Helper function to clear and free a kvmalloc'ed memory object.
 */
static inline void __kvzfree(const void *addr, size_t len)
{
	if (addr) {
		memset((void *)addr, 0, len);
		kvfree(addr);
	}
}
#endif /* _INTERNAL_H */
Commit	Line	Data
2874c5fd	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
973c9f4f	2	/* Authentication token and access key management internal defs
1da177e4	3	*
76181c13	4	* Copyright (C) 2003-5, 2007 Red Hat, Inc. All Rights Reserved.
1da177e4	5	* Written by David Howells (dhowells@redhat.com)
1da177e4 LT	6	*/
	7
	8	#ifndef _INTERNAL_H
	9	#define _INTERNAL_H
	10
d84f4f99	11	#include <linux/sched.h>
5dd43ce2	12	#include <linux/wait_bit.h>
5b825c3a	13	#include <linux/cred.h>
76181c13	14	#include <linux/key-type.h>
413cd3d9	15	#include <linux/task_work.h>
ddbb4114	16	#include <linux/keyctl.h>
ddb99e11	17	#include <linux/refcount.h>
f1c316a3	18	#include <linux/compat.h>
4f088249 WL	19	#include <linux/mm.h>
4f088249 WL	20	#include <linux/vmalloc.h>
1da177e4	21
a27bb332 KO	22	struct iovec;
a27bb332 KO	23
76181c13 DH	24	#ifdef __KDEBUG
76181c13 DH	25	#define kenter(FMT, ...) \
dd6f953a	26	printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
76181c13	27	#define kleave(FMT, ...) \
dd6f953a	28	printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
76181c13	29	#define kdebug(FMT, ...) \
d84f4f99	30	printk(KERN_DEBUG " "FMT"\n", ##__VA_ARGS__)
3e30148c	31	#else
76181c13	32	#define kenter(FMT, ...) \
dd6f953a	33	no_printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
76181c13	34	#define kleave(FMT, ...) \
dd6f953a	35	no_printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
76181c13 DH	36	#define kdebug(FMT, ...) \
76181c13 DH	37	no_printk(KERN_DEBUG FMT"\n", ##__VA_ARGS__)
3e30148c DH	38	#endif
3e30148c DH	39
0c061b57	40	extern struct key_type key_type_dead;
1da177e4	41	extern struct key_type key_type_user;
9f6ed2ca	42	extern struct key_type key_type_logon;
1da177e4 LT	43
	44	/*****************************************************************************/
	45	/*
973c9f4f DH	46	* Keep track of keys for a user.
	47	*
	48	* This needs to be separate to user_struct to avoid a refcount-loop
	49	* (user_struct pins some keyrings which pin this struct).
	50	*
	51	* We also keep track of keys under request from userspace for this UID here.
1da177e4 LT	52	*/
	53	struct key_user {
	54	struct rb_node node;
76181c13	55	struct mutex cons_lock; /* construction initiation lock */
1da177e4	56	spinlock_t lock;
ddb99e11	57	refcount_t usage; /* for accessing qnkeys & qnbytes */
1da177e4 LT	58	atomic_t nkeys; /* number of keys */
1da177e4 LT	59	atomic_t nikeys; /* number of instantiated keys */
9a56c2db	60	kuid_t uid;
1da177e4 LT	61	int qnkeys; /* number of keys allocated to this user */
	62	int qnbytes; /* number of bytes allocated to this user */
	63	};
	64
1da177e4 LT	65	extern struct rb_root key_user_tree;
	66	extern spinlock_t key_user_lock;
	67	extern struct key_user root_key_user;
	68
9a56c2db	69	extern struct key_user *key_user_lookup(kuid_t uid);
1da177e4 LT	70	extern void key_user_put(struct key_user *user);
1da177e4 LT	71
0b77f5bf	72	/*
973c9f4f	73	* Key quota limits.
0b77f5bf DH	74	* - root has its own separate limits to everyone else
	75	*/
	76	extern unsigned key_quota_root_maxkeys;
	77	extern unsigned key_quota_root_maxbytes;
	78	extern unsigned key_quota_maxkeys;
	79	extern unsigned key_quota_maxbytes;
	80
	81	#define KEYQUOTA_LINK_BYTES 4 /* a link in a keyring is worth 4 bytes */
1da177e4 LT	82
1da177e4 LT	83
8bc16dea	84	extern struct kmem_cache *key_jar;
1da177e4 LT	85	extern struct rb_root key_serial_tree;
1da177e4 LT	86	extern spinlock_t key_serial_lock;
76181c13	87	extern struct mutex key_construction_mutex;
1da177e4 LT	88	extern wait_queue_head_t request_key_conswq;
1da177e4 LT	89
355ef8e1	90	extern void key_set_index_key(struct keyring_index_key *index_key);
e9e349b0 DH	91	extern struct key_type key_type_lookup(const char type);
	92	extern void key_type_put(struct key_type *ktype);
	93
df593ee2 DH	94	extern int __key_link_lock(struct key *keyring,
df593ee2 DH	95	const struct keyring_index_key *index_key);
ed0ac5c7 DH	96	extern int __key_move_lock(struct key l_keyring, struct key u_keyring,
ed0ac5c7 DH	97	const struct keyring_index_key *index_key);
f70e2e06	98	extern int __key_link_begin(struct key *keyring,
16feef43	99	const struct keyring_index_key *index_key,
b2a4df20	100	struct assoc_array_edit **_edit);
f70e2e06	101	extern int __key_link_check_live_key(struct key keyring, struct key key);
b2a4df20	102	extern void __key_link(struct key key, struct assoc_array_edit *_edit);
f70e2e06	103	extern void __key_link_end(struct key *keyring,
16feef43	104	const struct keyring_index_key *index_key,
b2a4df20	105	struct assoc_array_edit *edit);
1da177e4	106
b2a4df20 DH	107	extern key_ref_t find_key_to_update(key_ref_t keyring_ref,
b2a4df20 DH	108	const struct keyring_index_key *index_key);
1da177e4	109
3e30148c DH	110	extern struct key keyring_search_instkey(struct key keyring,
	111	key_serial_t target_id);
	112
b2a4df20 DH	113	extern int iterate_over_keyring(const struct key *keyring,
	114	int (func)(const struct key key, void *data),
	115	void *data);
	116
4bdf0bc3 DH	117	struct keyring_search_context {
	118	struct keyring_index_key index_key;
	119	const struct cred *cred;
46291959	120	struct key_match_data match_data;
4bdf0bc3	121	unsigned flags;
614d8c39 DH	122	#define KEYRING_SEARCH_NO_STATE_CHECK 0x0001 /* Skip state checks */
	123	#define KEYRING_SEARCH_DO_STATE_CHECK 0x0002 /* Override NO_STATE_CHECK */
	124	#define KEYRING_SEARCH_NO_UPDATE_TIME 0x0004 /* Don't update times */
	125	#define KEYRING_SEARCH_NO_CHECK_PERM 0x0008 /* Don't check permissions */
	126	#define KEYRING_SEARCH_DETECT_TOO_DEEP 0x0010 /* Give an error on excessive depth */
0b0a8415	127	#define KEYRING_SEARCH_SKIP_EXPIRED 0x0020 /* Ignore expired keys (intention to replace) */
dcf49dbc	128	#define KEYRING_SEARCH_RECURSE 0x0040 /* Search child keyrings also */
4bdf0bc3	129
b2a4df20 DH	130	int (iterator)(const void object, void *iterator_data);
b2a4df20 DH	131
4bdf0bc3 DH	132	/* Internal stuff */
	133	int skipped_ret;
	134	bool possessed;
	135	key_ref_t result;
074d5898	136	time64_t now;
4bdf0bc3 DH	137	};
4bdf0bc3 DH	138
0c903ab6 DH	139	extern bool key_default_cmp(const struct key *key,
0c903ab6 DH	140	const struct key_match_data *match_data);
e59428f7	141	extern key_ref_t keyring_search_rcu(key_ref_t keyring_ref,
4bdf0bc3 DH	142	struct keyring_search_context *ctx);
4bdf0bc3 DH	143
e59428f7 DH	144	extern key_ref_t search_cred_keyrings_rcu(struct keyring_search_context *ctx);
e59428f7 DH	145	extern key_ref_t search_process_keyrings_rcu(struct keyring_search_context *ctx);
1da177e4	146
237bbd29	147	extern struct key find_keyring_by_name(const char name, bool uid_keyring);
1da177e4	148
0f44e4d9 DH	149	extern int look_up_user_keyrings(struct key , struct key );
0f44e4d9 DH	150	extern struct key get_user_session_keyring_rcu(const struct cred );
d84f4f99 DH	151	extern int install_thread_keyring_to_cred(struct cred *);
d84f4f99 DH	152	extern int install_process_keyring_to_cred(struct cred *);
685bfd2c	153	extern int install_session_keyring_to_cred(struct cred , struct key );
3e30148c DH	154
	155	extern struct key request_key_and_link(struct key_type type,
	156	const char *description,
a58946c1	157	struct key_tag *domain_tag,
4a38e122 DH	158	const void *callout_info,
4a38e122 DH	159	size_t callout_len,
4e54f085	160	void *aux,
7e047ef5 DH	161	struct key *dest_keyring,
7e047ef5 DH	162	unsigned long flags);
3e30148c	163
0c903ab6 DH	164	extern bool lookup_user_key_possessed(const struct key *key,
0c903ab6 DH	165	const struct key_match_data *match_data);
5593122e DH	166	#define KEY_LOOKUP_CREATE 0x01
	167	#define KEY_LOOKUP_PARTIAL 0x02
	168	#define KEY_LOOKUP_FOR_UNLINK 0x04
e9e349b0 DH	169
e9e349b0 DH	170	extern long join_session_keyring(const char *name);
67d12145	171	extern void key_change_session_keyring(struct callback_head *twork);
e9e349b0	172
0c061b57	173	extern struct work_struct key_gc_work;
5d135440	174	extern unsigned key_gc_delay;
074d5898	175	extern void keyring_gc(struct key *keyring, time64_t limit);
2b6aa412 MM	176	extern void keyring_restriction_gc(struct key *keyring,
2b6aa412 MM	177	struct key_type *dead_type);
074d5898	178	extern void key_schedule_gc(time64_t gc_at);
fd75815f	179	extern void key_schedule_gc_links(void);
0c061b57	180	extern void key_gc_keytype(struct key_type *ktype);
5d135440	181
e9e349b0	182	extern int key_task_permission(const key_ref_t key_ref,
d84f4f99	183	const struct cred *cred,
028db3e2	184	key_perm_t perm);
e9e349b0	185
973c9f4f DH	186	/*
	187	* Check to see whether permission is granted to use a key in the desired way.
	188	*/
f5895943	189	static inline int key_permission(const key_ref_t key_ref, unsigned perm)
e9e349b0	190	{
d84f4f99	191	return key_task_permission(key_ref, current_cred(), perm);
e9e349b0 DH	192	}
e9e349b0 DH	193
3e30148c DH	194	extern struct key_type key_type_request_key_auth;
3e30148c DH	195	extern struct key request_key_auth_new(struct key target,
822ad64d	196	const char *op,
4a38e122	197	const void *callout_info,
8bbf4976 DH	198	size_t callout_len,
8bbf4976 DH	199	struct key *dest_keyring);
3e30148c DH	200
3e30148c DH	201	extern struct key *key_get_instantiation_authkey(key_serial_t target_id);
1da177e4	202
fd75815f DH	203	/*
	204	* Determine whether a key is dead.
	205	*/
074d5898	206	static inline bool key_is_dead(const struct key *key, time64_t limit)
fd75815f DH	207	{
	208	return
	209	key->flags & ((1 << KEY_FLAG_DEAD) \|
	210	(1 << KEY_FLAG_INVALIDATED)) \|\|
218e6424 DH	211	(key->expiry > 0 && key->expiry <= limit) \|\|
218e6424 DH	212	key->domain_tag->removed;
fd75815f DH	213	}
fd75815f DH	214
1da177e4	215	/*
973c9f4f	216	* keyctl() functions
1da177e4 LT	217	*/
	218	extern long keyctl_get_keyring_ID(key_serial_t, int);
	219	extern long keyctl_join_session_keyring(const char __user *);
	220	extern long keyctl_update_key(key_serial_t, const void __user *, size_t);
	221	extern long keyctl_revoke_key(key_serial_t);
	222	extern long keyctl_keyring_clear(key_serial_t);
	223	extern long keyctl_keyring_link(key_serial_t, key_serial_t);
ed0ac5c7	224	extern long keyctl_keyring_move(key_serial_t, key_serial_t, key_serial_t, unsigned int);
1da177e4 LT	225	extern long keyctl_keyring_unlink(key_serial_t, key_serial_t);
	226	extern long keyctl_describe_key(key_serial_t, char __user *, size_t);
	227	extern long keyctl_keyring_search(key_serial_t, const char __user *,
	228	const char __user *, key_serial_t);
	229	extern long keyctl_read_key(key_serial_t, char __user *, size_t);
	230	extern long keyctl_chown_key(key_serial_t, uid_t, gid_t);
028db3e2	231	extern long keyctl_setperm_key(key_serial_t, key_perm_t);
1da177e4 LT	232	extern long keyctl_instantiate_key(key_serial_t, const void __user *,
	233	size_t, key_serial_t);
	234	extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t);
3e30148c	235	extern long keyctl_set_reqkey_keyring(int);
017679c4	236	extern long keyctl_set_timeout(key_serial_t, unsigned);
b5f545c8	237	extern long keyctl_assume_authority(key_serial_t);
70a5bb72 DH	238	extern long keyctl_get_security(key_serial_t keyid, char __user *buffer,
70a5bb72 DH	239	size_t buflen);
ee18d64c	240	extern long keyctl_session_to_parent(void);
fdd1b945	241	extern long keyctl_reject_key(key_serial_t, unsigned, unsigned, key_serial_t);
ee009e4a DH	242	extern long keyctl_instantiate_key_iov(key_serial_t,
	243	const struct iovec __user *,
	244	unsigned, key_serial_t);
fd75815f	245	extern long keyctl_invalidate_key(key_serial_t);
ee009e4a	246
b353a1f7	247	struct iov_iter;
ee009e4a	248	extern long keyctl_instantiate_key_common(key_serial_t,
b353a1f7 AV	249	struct iov_iter *,
b353a1f7 AV	250	key_serial_t);
6563c91f MM	251	extern long keyctl_restrict_keyring(key_serial_t id,
	252	const char __user *_type,
	253	const char __user *_restriction);
f36f8c75 DH	254	#ifdef CONFIG_PERSISTENT_KEYRINGS
	255	extern long keyctl_get_persistent(uid_t, key_serial_t);
	256	extern unsigned persistent_keyring_expiry;
	257	#else
	258	static inline long keyctl_get_persistent(uid_t uid, key_serial_t destring)
	259	{
	260	return -EOPNOTSUPP;
	261	}
	262	#endif
1da177e4	263
ddbb4114 MM	264	#ifdef CONFIG_KEY_DH_OPERATIONS
ddbb4114 MM	265	extern long keyctl_dh_compute(struct keyctl_dh_params __user , char __user ,
f1c316a3 SM	266	size_t, struct keyctl_kdf_params __user *);
	267	extern long __keyctl_dh_compute(struct keyctl_dh_params __user , char __user ,
	268	size_t, struct keyctl_kdf_params *);
601f0093	269	#ifdef CONFIG_COMPAT
f1c316a3 SM	270	extern long compat_keyctl_dh_compute(struct keyctl_dh_params __user *params,
	271	char __user *buffer, size_t buflen,
	272	struct compat_keyctl_kdf_params __user *kdf);
	273	#endif
	274	#define KEYCTL_KDF_MAX_OUTPUT_LEN 1024 /* max length of KDF output */
	275	#define KEYCTL_KDF_MAX_OI_LEN 64 /* max length of otherinfo */
ddbb4114 MM	276	#else
ddbb4114 MM	277	static inline long keyctl_dh_compute(struct keyctl_dh_params __user *params,
4693fc73	278	char __user *buffer, size_t buflen,
f1c316a3 SM	279	struct keyctl_kdf_params __user *kdf)
	280	{
	281	return -EOPNOTSUPP;
	282	}
	283
601f0093	284	#ifdef CONFIG_COMPAT
f1c316a3 SM	285	static inline long compat_keyctl_dh_compute(
	286	struct keyctl_dh_params __user *params,
	287	char __user *buffer, size_t buflen,
	288	struct keyctl_kdf_params __user *kdf)
ddbb4114 MM	289	{
	290	return -EOPNOTSUPP;
	291	}
	292	#endif
f1c316a3	293	#endif
ddbb4114	294
00d60fd3 DH	295	#ifdef CONFIG_ASYMMETRIC_KEY_TYPE
	296	extern long keyctl_pkey_query(key_serial_t,
	297	const char __user *,
	298	struct keyctl_pkey_query __user *);
	299
	300	extern long keyctl_pkey_verify(const struct keyctl_pkey_params __user *,
	301	const char __user *,
	302	const void __user , const void __user );
	303
	304	extern long keyctl_pkey_e_d_s(int,
	305	const struct keyctl_pkey_params __user *,
	306	const char __user *,
	307	const void __user , void __user );
	308	#else
	309	static inline long keyctl_pkey_query(key_serial_t id,
	310	const char __user *_info,
	311	struct keyctl_pkey_query __user *_res)
	312	{
	313	return -EOPNOTSUPP;
	314	}
	315
	316	static inline long keyctl_pkey_verify(const struct keyctl_pkey_params __user *params,
	317	const char __user *_info,
	318	const void __user *_in,
	319	const void __user *_in2)
	320	{
	321	return -EOPNOTSUPP;
	322	}
	323
	324	static inline long keyctl_pkey_e_d_s(int op,
	325	const struct keyctl_pkey_params __user *params,
	326	const char __user *_info,
	327	const void __user *_in,
	328	void __user *_out)
	329	{
	330	return -EOPNOTSUPP;
	331	}
	332	#endif
	333
45e0f30c DH	334	extern long keyctl_capabilities(unsigned char __user *_buffer, size_t buflen);
45e0f30c DH	335
1da177e4	336	/*
973c9f4f	337	* Debugging key validation
1da177e4 LT	338	*/
	339	#ifdef KEY_DEBUGGING
	340	extern void __key_check(const struct key *);
	341
	342	static inline void key_check(const struct key *key)
	343	{
	344	if (key && (IS_ERR(key) \|\| key->magic != KEY_DEBUG_MAGIC))
	345	__key_check(key);
	346	}
	347
	348	#else
	349
	350	#define key_check(key) do {} while(0)
	351
	352	#endif
	353
4f088249 WL	354	/*
	355	* Helper function to clear and free a kvmalloc'ed memory object.
	356	*/
	357	static inline void __kvzfree(const void *addr, size_t len)
	358	{
	359	if (addr) {
	360	memset((void *)addr, 0, len);
	361	kvfree(addr);
	362	}
	363	}
1da177e4	364	#endif /* _INTERNAL_H */