[mirror_ubuntu-bionic-kernel.git] / include / linux / key.h

/* Authentication token and access key management
 *
 * Copyright (C) 2004, 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.
 *
 *
 * See Documentation/security/keys/core.rst for information on keys/keyrings.
 */

#ifndef _LINUX_KEY_H
#define _LINUX_KEY_H

#include <linux/types.h>
#include <linux/list.h>
#include <linux/rbtree.h>
#include <linux/rcupdate.h>
#include <linux/sysctl.h>
#include <linux/rwsem.h>
#include <linux/atomic.h>
#include <linux/assoc_array.h>
#include <linux/refcount.h>
#include <linux/time64.h>

#ifdef __KERNEL__
#include <linux/uidgid.h>

/* key handle serial number */
typedef int32_t key_serial_t;

/* key handle permissions mask */
typedef uint32_t key_perm_t;

struct key;

#ifdef CONFIG_KEYS

#undef KEY_DEBUGGING

#define KEY_POS_VIEW	0x01000000	/* possessor can view a key's attributes */
#define KEY_POS_READ	0x02000000	/* possessor can read key payload / view keyring */
#define KEY_POS_WRITE	0x04000000	/* possessor can update key payload / add link to keyring */
#define KEY_POS_SEARCH	0x08000000	/* possessor can find a key in search / search a keyring */
#define KEY_POS_LINK	0x10000000	/* possessor can create a link to a key/keyring */
#define KEY_POS_SETATTR	0x20000000	/* possessor can set key attributes */
#define KEY_POS_ALL	0x3f000000

#define KEY_USR_VIEW	0x00010000	/* user permissions... */
#define KEY_USR_READ	0x00020000
#define KEY_USR_WRITE	0x00040000
#define KEY_USR_SEARCH	0x00080000
#define KEY_USR_LINK	0x00100000
#define KEY_USR_SETATTR	0x00200000
#define KEY_USR_ALL	0x003f0000

#define KEY_GRP_VIEW	0x00000100	/* group permissions... */
#define KEY_GRP_READ	0x00000200
#define KEY_GRP_WRITE	0x00000400
#define KEY_GRP_SEARCH	0x00000800
#define KEY_GRP_LINK	0x00001000
#define KEY_GRP_SETATTR	0x00002000
#define KEY_GRP_ALL	0x00003f00

#define KEY_OTH_VIEW	0x00000001	/* third party permissions... */
#define KEY_OTH_READ	0x00000002
#define KEY_OTH_WRITE	0x00000004
#define KEY_OTH_SEARCH	0x00000008
#define KEY_OTH_LINK	0x00000010
#define KEY_OTH_SETATTR	0x00000020
#define KEY_OTH_ALL	0x0000003f

#define KEY_PERM_UNDEF	0xffffffff

struct seq_file;
struct user_struct;
struct signal_struct;
struct cred;

struct key_type;
struct key_owner;
struct keyring_list;
struct keyring_name;

struct keyring_index_key {
	struct key_type		*type;
	const char		*description;
	size_t			desc_len;
};

union key_payload {
	void __rcu		*rcu_data0;
	void			*data[4];
};

/*****************************************************************************/
/*
 * key reference with possession attribute handling
 *
 * NOTE! key_ref_t is a typedef'd pointer to a type that is not actually
 * defined. This is because we abuse the bottom bit of the reference to carry a
 * flag to indicate whether the calling process possesses that key in one of
 * its keyrings.
 *
 * the key_ref_t has been made a separate type so that the compiler can reject
 * attempts to dereference it without proper conversion.
 *
 * the three functions are used to assemble and disassemble references
 */
typedef struct __key_reference_with_attributes *key_ref_t;

static inline key_ref_t make_key_ref(const struct key *key,
				     bool possession)
{
	return (key_ref_t) ((unsigned long) key | possession);
}

static inline struct key *key_ref_to_ptr(const key_ref_t key_ref)
{
	return (struct key *) ((unsigned long) key_ref & ~1UL);
}

static inline bool is_key_possessed(const key_ref_t key_ref)
{
	return (unsigned long) key_ref & 1UL;
}

typedef int (*key_restrict_link_func_t)(struct key *dest_keyring,
					const struct key_type *type,
					const union key_payload *payload,
					struct key *restriction_key);

struct key_restriction {
	key_restrict_link_func_t check;
	struct key *key;
	struct key_type *keytype;
};

enum key_state {
	KEY_IS_UNINSTANTIATED,
	KEY_IS_POSITIVE,		/* Positively instantiated */
};

/*****************************************************************************/
/*
 * authentication token / access credential / keyring
 * - types of key include:
 *   - keyrings
 *   - disk encryption IDs
 *   - Kerberos TGTs and tickets
 */
struct key {
	refcount_t		usage;		/* number of references */
	key_serial_t		serial;		/* key serial number */
	union {
		struct list_head graveyard_link;
		struct rb_node	serial_node;
	};
	struct rw_semaphore	sem;		/* change vs change sem */
	struct key_user		*user;		/* owner of this key */
	void			*security;	/* security data for this key */
	union {
		time64_t	expiry;		/* time at which key expires (or 0) */
		time64_t	revoked_at;	/* time at which key was revoked */
	};
	time64_t		last_used_at;	/* last time used for LRU keyring discard */
	kuid_t			uid;
	kgid_t			gid;
	key_perm_t		perm;		/* access permissions */
	unsigned short		quotalen;	/* length added to quota */
	unsigned short		datalen;	/* payload data length
						 * - may not match RCU dereferenced payload
						 * - payload should contain own length
						 */
	short			state;		/* Key state (+) or rejection error (-) */

#ifdef KEY_DEBUGGING
	unsigned		magic;
#define KEY_DEBUG_MAGIC		0x18273645u
#endif

	unsigned long		flags;		/* status flags (change with bitops) */
#define KEY_FLAG_DEAD		0	/* set if key type has been deleted */
#define KEY_FLAG_REVOKED	1	/* set if key had been revoked */
#define KEY_FLAG_IN_QUOTA	2	/* set if key consumes quota */
#define KEY_FLAG_USER_CONSTRUCT	3	/* set if key is being constructed in userspace */
#define KEY_FLAG_ROOT_CAN_CLEAR	4	/* set if key can be cleared by root without permission */
#define KEY_FLAG_INVALIDATED	5	/* set if key has been invalidated */
#define KEY_FLAG_BUILTIN	6	/* set if key is built in to the kernel */
#define KEY_FLAG_ROOT_CAN_INVAL	7	/* set if key can be invalidated by root without permission */
#define KEY_FLAG_KEEP		8	/* set if key should not be removed */
#define KEY_FLAG_UID_KEYRING	9	/* set if key is a user or user session keyring */

	/* the key type and key description string
	 * - the desc is used to match a key against search criteria
	 * - it should be a printable string
	 * - eg: for krb5 AFS, this might be "afs@REDHAT.COM"
	 */
	union {
		struct keyring_index_key index_key;
		struct {
			struct key_type	*type;		/* type of key */
			char		*description;
		};
	};

	/* key data
	 * - this is used to hold the data actually used in cryptography or
	 *   whatever
	 */
	union {
		union key_payload payload;
		struct {
			/* Keyring bits */
			struct list_head name_link;
			struct assoc_array keys;
		};
	};

	/* This is set on a keyring to restrict the addition of a link to a key
	 * to it.  If this structure isn't provided then it is assumed that the
	 * keyring is open to any addition.  It is ignored for non-keyring
	 * keys. Only set this value using keyring_restrict(), keyring_alloc(),
	 * or key_alloc().
	 *
	 * This is intended for use with rings of trusted keys whereby addition
	 * to the keyring needs to be controlled.  KEY_ALLOC_BYPASS_RESTRICTION
	 * overrides this, allowing the kernel to add extra keys without
	 * restriction.
	 */
	struct key_restriction *restrict_link;
};

extern struct key *key_alloc(struct key_type *type,
			     const char *desc,
			     kuid_t uid, kgid_t gid,
			     const struct cred *cred,
			     key_perm_t perm,
			     unsigned long flags,
			     struct key_restriction *restrict_link);


#define KEY_ALLOC_IN_QUOTA		0x0000	/* add to quota, reject if would overrun */
#define KEY_ALLOC_QUOTA_OVERRUN		0x0001	/* add to quota, permit even if overrun */
#define KEY_ALLOC_NOT_IN_QUOTA		0x0002	/* not in quota */
#define KEY_ALLOC_BUILT_IN		0x0004	/* Key is built into kernel */
#define KEY_ALLOC_BYPASS_RESTRICTION	0x0008	/* Override the check on restricted keyrings */
#define KEY_ALLOC_UID_KEYRING		0x0010	/* allocating a user or user session keyring */

extern void key_revoke(struct key *key);
extern void key_invalidate(struct key *key);
extern void key_put(struct key *key);

static inline struct key *__key_get(struct key *key)
{
	refcount_inc(&key->usage);
	return key;
}

static inline struct key *key_get(struct key *key)
{
	return key ? __key_get(key) : key;
}

static inline void key_ref_put(key_ref_t key_ref)
{
	key_put(key_ref_to_ptr(key_ref));
}

extern struct key *request_key(struct key_type *type,
			       const char *description,
			       const char *callout_info);

extern struct key *request_key_with_auxdata(struct key_type *type,
					    const char *description,
					    const void *callout_info,
					    size_t callout_len,
					    void *aux);

extern struct key *request_key_async(struct key_type *type,
				     const char *description,
				     const void *callout_info,
				     size_t callout_len);

extern struct key *request_key_async_with_auxdata(struct key_type *type,
						  const char *description,
						  const void *callout_info,
						  size_t callout_len,
						  void *aux);

extern int wait_for_key_construction(struct key *key, bool intr);

extern int key_validate(const struct key *key);

extern key_ref_t key_create_or_update(key_ref_t keyring,
				      const char *type,
				      const char *description,
				      const void *payload,
				      size_t plen,
				      key_perm_t perm,
				      unsigned long flags);

extern int key_update(key_ref_t key,
		      const void *payload,
		      size_t plen);

extern int key_link(struct key *keyring,
		    struct key *key);

extern int key_unlink(struct key *keyring,
		      struct key *key);

extern struct key *keyring_alloc(const char *description, kuid_t uid, kgid_t gid,
				 const struct cred *cred,
				 key_perm_t perm,
				 unsigned long flags,
				 struct key_restriction *restrict_link,
				 struct key *dest);

extern int restrict_link_reject(struct key *keyring,
				const struct key_type *type,
				const union key_payload *payload,
				struct key *restriction_key);

extern int keyring_clear(struct key *keyring);

extern key_ref_t keyring_search(key_ref_t keyring,
				struct key_type *type,
				const char *description);

extern int keyring_add_key(struct key *keyring,
			   struct key *key);

extern int keyring_restrict(key_ref_t keyring, const char *type,
			    const char *restriction);

extern struct key *key_lookup(key_serial_t id);

static inline key_serial_t key_serial(const struct key *key)
{
	return key ? key->serial : 0;
}

extern void key_set_timeout(struct key *, unsigned);

/*
 * The permissions required on a key that we're looking up.
 */
#define	KEY_NEED_VIEW	0x01	/* Require permission to view attributes */
#define	KEY_NEED_READ	0x02	/* Require permission to read content */
#define	KEY_NEED_WRITE	0x04	/* Require permission to update / modify */
#define	KEY_NEED_SEARCH	0x08	/* Require permission to search (keyring) or find (key) */
#define	KEY_NEED_LINK	0x10	/* Require permission to link */
#define	KEY_NEED_SETATTR 0x20	/* Require permission to change attributes */
#define	KEY_NEED_ALL	0x3f	/* All the above permissions */

static inline short key_read_state(const struct key *key)
{
	/* Barrier versus mark_key_instantiated(). */
	return smp_load_acquire(&key->state);
}

/**
 * key_is_positive - Determine if a key has been positively instantiated
 * @key: The key to check.
 *
 * Return true if the specified key has been positively instantiated, false
 * otherwise.
 */
static inline bool key_is_positive(const struct key *key)
{
	return key_read_state(key) == KEY_IS_POSITIVE;
}

static inline bool key_is_negative(const struct key *key)
{
	return key_read_state(key) < 0;
}

#define dereference_key_rcu(KEY)					\
	(rcu_dereference((KEY)->payload.rcu_data0))

#define dereference_key_locked(KEY)					\
	(rcu_dereference_protected((KEY)->payload.rcu_data0,		\
				   rwsem_is_locked(&((struct key *)(KEY))->sem)))

#define rcu_assign_keypointer(KEY, PAYLOAD)				\
do {									\
	rcu_assign_pointer((KEY)->payload.rcu_data0, (PAYLOAD));	\
} while (0)

#ifdef CONFIG_SYSCTL
extern struct ctl_table key_sysctls[];
#endif
/*
 * the userspace interface
 */
extern int install_thread_keyring_to_cred(struct cred *cred);
extern void key_fsuid_changed(struct task_struct *tsk);
extern void key_fsgid_changed(struct task_struct *tsk);
extern void key_init(void);

#else /* CONFIG_KEYS */

#define key_validate(k)			0
#define key_serial(k)			0
#define key_get(k) 			({ NULL; })
#define key_revoke(k)			do { } while(0)
#define key_invalidate(k)		do { } while(0)
#define key_put(k)			do { } while(0)
#define key_ref_put(k)			do { } while(0)
#define make_key_ref(k, p)		NULL
#define key_ref_to_ptr(k)		NULL
#define is_key_possessed(k)		0
#define key_fsuid_changed(t)		do { } while(0)
#define key_fsgid_changed(t)		do { } while(0)
#define key_init()			do { } while(0)

#endif /* CONFIG_KEYS */
#endif /* __KERNEL__ */
#endif /* _LINUX_KEY_H */
Commit	Line	Data
76181c13	1	/* Authentication token and access key management
1da177e4	2	*
76181c13	3	* Copyright (C) 2004, 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	*
b68101a1	12	* See Documentation/security/keys/core.rst for information on keys/keyrings.
1da177e4 LT	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>
76d8aeab	21	#include <linux/rcupdate.h>
0b77f5bf	22	#include <linux/sysctl.h>
aa84442d	23	#include <linux/rwsem.h>
60063497	24	#include <linux/atomic.h>
b2a4df20	25	#include <linux/assoc_array.h>
fff29291	26	#include <linux/refcount.h>
074d5898	27	#include <linux/time64.h>
1da177e4 LT	28
1da177e4 LT	29	#ifdef __KERNEL__
9a56c2db	30	#include <linux/uidgid.h>
1da177e4 LT	31
	32	/* key handle serial number */
	33	typedef int32_t key_serial_t;
	34
	35	/* key handle permissions mask */
	36	typedef uint32_t key_perm_t;
	37
	38	struct key;
	39
	40	#ifdef CONFIG_KEYS
	41
	42	#undef KEY_DEBUGGING
	43
664cceb0 DH	44	#define KEY_POS_VIEW 0x01000000 /* possessor can view a key's attributes */
	45	#define KEY_POS_READ 0x02000000 /* possessor can read key payload / view keyring */
	46	#define KEY_POS_WRITE 0x04000000 /* possessor can update key payload / add link to keyring */
	47	#define KEY_POS_SEARCH 0x08000000 /* possessor can find a key in search / search a keyring */
	48	#define KEY_POS_LINK 0x10000000 /* possessor can create a link to a key/keyring */
29db9190 DH	49	#define KEY_POS_SETATTR 0x20000000 /* possessor can set key attributes */
29db9190 DH	50	#define KEY_POS_ALL 0x3f000000
664cceb0 DH	51
	52	#define KEY_USR_VIEW 0x00010000 /* user permissions... */
	53	#define KEY_USR_READ 0x00020000
	54	#define KEY_USR_WRITE 0x00040000
	55	#define KEY_USR_SEARCH 0x00080000
	56	#define KEY_USR_LINK 0x00100000
29db9190 DH	57	#define KEY_USR_SETATTR 0x00200000
29db9190 DH	58	#define KEY_USR_ALL 0x003f0000
1da177e4 LT	59
	60	#define KEY_GRP_VIEW 0x00000100 /* group permissions... */
	61	#define KEY_GRP_READ 0x00000200
	62	#define KEY_GRP_WRITE 0x00000400
	63	#define KEY_GRP_SEARCH 0x00000800
	64	#define KEY_GRP_LINK 0x00001000
29db9190 DH	65	#define KEY_GRP_SETATTR 0x00002000
29db9190 DH	66	#define KEY_GRP_ALL 0x00003f00
1da177e4 LT	67
	68	#define KEY_OTH_VIEW 0x00000001 /* third party permissions... */
	69	#define KEY_OTH_READ 0x00000002
	70	#define KEY_OTH_WRITE 0x00000004
	71	#define KEY_OTH_SEARCH 0x00000008
	72	#define KEY_OTH_LINK 0x00000010
29db9190 DH	73	#define KEY_OTH_SETATTR 0x00000020
29db9190 DH	74	#define KEY_OTH_ALL 0x0000003f
1da177e4	75
6b79ccb5 AR	76	#define KEY_PERM_UNDEF 0xffffffff
6b79ccb5 AR	77
1da177e4 LT	78	struct seq_file;
	79	struct user_struct;
	80	struct signal_struct;
d84f4f99	81	struct cred;
1da177e4 LT	82
	83	struct key_type;
	84	struct key_owner;
	85	struct keyring_list;
	86	struct keyring_name;
	87
16feef43 DH	88	struct keyring_index_key {
	89	struct key_type *type;
	90	const char *description;
	91	size_t desc_len;
	92	};
	93
146aa8b1 DH	94	union key_payload {
	95	void __rcu *rcu_data0;
	96	void *data[4];
	97	};
	98
664cceb0 DH	99	/*****************************************************************************/
	100	/*
	101	* key reference with possession attribute handling
	102	*
	103	* NOTE! key_ref_t is a typedef'd pointer to a type that is not actually
	104	* defined. This is because we abuse the bottom bit of the reference to carry a
	105	* flag to indicate whether the calling process possesses that key in one of
	106	* its keyrings.
	107	*
	108	* the key_ref_t has been made a separate type so that the compiler can reject
	109	* attempts to dereference it without proper conversion.
	110	*
	111	* the three functions are used to assemble and disassemble references
	112	*/
	113	typedef struct __key_reference_with_attributes *key_ref_t;
	114
	115	static inline key_ref_t make_key_ref(const struct key *key,
a5b4bd28	116	bool possession)
664cceb0 DH	117	{
	118	return (key_ref_t) ((unsigned long) key \| possession);
	119	}
	120
	121	static inline struct key *key_ref_to_ptr(const key_ref_t key_ref)
	122	{
	123	return (struct key *) ((unsigned long) key_ref & ~1UL);
	124	}
	125
a5b4bd28	126	static inline bool is_key_possessed(const key_ref_t key_ref)
664cceb0 DH	127	{
	128	return (unsigned long) key_ref & 1UL;
	129	}
	130
aaf66c88	131	typedef int (key_restrict_link_func_t)(struct key dest_keyring,
469ff8f7	132	const struct key_type *type,
aaf66c88 MM	133	const union key_payload *payload,
aaf66c88 MM	134	struct key *restriction_key);
469ff8f7	135
e9cc0f68 MM	136	struct key_restriction {
	137	key_restrict_link_func_t check;
	138	struct key *key;
	139	struct key_type *keytype;
	140	};
	141
363b02da DH	142	enum key_state {
	143	KEY_IS_UNINSTANTIATED,
	144	KEY_IS_POSITIVE, /* Positively instantiated */
	145	};
	146
1da177e4 LT	147	/*****************************************************************************/
	148	/*
	149	* authentication token / access credential / keyring
	150	* - types of key include:
	151	* - keyrings
	152	* - disk encryption IDs
	153	* - Kerberos TGTs and tickets
	154	*/
	155	struct key {
fff29291	156	refcount_t usage; /* number of references */
1da177e4	157	key_serial_t serial; /* key serial number */
65d87fe6 DH	158	union {
	159	struct list_head graveyard_link;
	160	struct rb_node serial_node;
	161	};
1da177e4 LT	162	struct rw_semaphore sem; /* change vs change sem */
1da177e4 LT	163	struct key_user user; / owner of this key */
29db9190	164	void security; / security data for this key */
5d135440	165	union {
074d5898 BW	166	time64_t expiry; /* time at which key expires (or 0) */
074d5898 BW	167	time64_t revoked_at; /* time at which key was revoked */
5d135440	168	};
074d5898	169	time64_t last_used_at; /* last time used for LRU keyring discard */
9a56c2db EB	170	kuid_t uid;
9a56c2db EB	171	kgid_t gid;
1da177e4 LT	172	key_perm_t perm; /* access permissions */
1da177e4 LT	173	unsigned short quotalen; /* length added to quota */
76d8aeab DH	174	unsigned short datalen; /* payload data length
	175	* - may not match RCU dereferenced payload
	176	* - payload should contain own length
	177	*/
363b02da	178	short state; /* Key state (+) or rejection error (-) */
1da177e4 LT	179
	180	#ifdef KEY_DEBUGGING
	181	unsigned magic;
	182	#define KEY_DEBUG_MAGIC 0x18273645u
1da177e4 LT	183	#endif
1da177e4 LT	184
76d8aeab	185	unsigned long flags; /* status flags (change with bitops) */
363b02da DH	186	#define KEY_FLAG_DEAD 0 /* set if key type has been deleted */
	187	#define KEY_FLAG_REVOKED 1 /* set if key had been revoked */
	188	#define KEY_FLAG_IN_QUOTA 2 /* set if key consumes quota */
	189	#define KEY_FLAG_USER_CONSTRUCT 3 /* set if key is being constructed in userspace */
	190	#define KEY_FLAG_ROOT_CAN_CLEAR 4 /* set if key can be cleared by root without permission */
	191	#define KEY_FLAG_INVALIDATED 5 /* set if key has been invalidated */
	192	#define KEY_FLAG_BUILTIN 6 /* set if key is built in to the kernel */
	193	#define KEY_FLAG_ROOT_CAN_INVAL 7 /* set if key can be invalidated by root without permission */
	194	#define KEY_FLAG_KEEP 8 /* set if key should not be removed */
	195	#define KEY_FLAG_UID_KEYRING 9 /* set if key is a user or user session keyring */
76d8aeab	196
16feef43 DH	197	/* the key type and key description string
	198	* - the desc is used to match a key against search criteria
	199	* - it should be a printable string
1da177e4 LT	200	* - eg: for krb5 AFS, this might be "afs@REDHAT.COM"
1da177e4 LT	201	*/
16feef43 DH	202	union {
	203	struct keyring_index_key index_key;
	204	struct {
	205	struct key_type type; / type of key */
	206	char *description;
	207	};
	208	};
1da177e4	209
1da177e4 LT	210	/* key data
	211	* - this is used to hold the data actually used in cryptography or
	212	* whatever
	213	*/
	214	union {
146aa8b1 DH	215	union key_payload payload;
	216	struct {
	217	/* Keyring bits */
	218	struct list_head name_link;
	219	struct assoc_array keys;
	220	};
b2a4df20	221	};
5ac7eace DH	222
5ac7eace DH	223	/* This is set on a keyring to restrict the addition of a link to a key
2b6aa412	224	* to it. If this structure isn't provided then it is assumed that the
5ac7eace	225	* keyring is open to any addition. It is ignored for non-keyring
6563c91f MM	226	* keys. Only set this value using keyring_restrict(), keyring_alloc(),
6563c91f MM	227	* or key_alloc().
5ac7eace DH	228	*
	229	* This is intended for use with rings of trusted keys whereby addition
	230	* to the keyring needs to be controlled. KEY_ALLOC_BYPASS_RESTRICTION
	231	* overrides this, allowing the kernel to add extra keys without
	232	* restriction.
	233	*/
2b6aa412	234	struct key_restriction *restrict_link;
1da177e4 LT	235	};
1da177e4 LT	236
1da177e4 LT	237	extern struct key key_alloc(struct key_type type,
1da177e4 LT	238	const char *desc,
9a56c2db	239	kuid_t uid, kgid_t gid,
d84f4f99	240	const struct cred *cred,
7e047ef5	241	key_perm_t perm,
5ac7eace	242	unsigned long flags,
2b6aa412	243	struct key_restriction *restrict_link);
7e047ef5 DH	244
7e047ef5 DH	245
5ac7eace DH	246	#define KEY_ALLOC_IN_QUOTA 0x0000 /* add to quota, reject if would overrun */
	247	#define KEY_ALLOC_QUOTA_OVERRUN 0x0001 /* add to quota, permit even if overrun */
	248	#define KEY_ALLOC_NOT_IN_QUOTA 0x0002 /* not in quota */
77f68bac DH	249	#define KEY_ALLOC_BUILT_IN 0x0004 /* Key is built into kernel */
77f68bac DH	250	#define KEY_ALLOC_BYPASS_RESTRICTION 0x0008 /* Override the check on restricted keyrings */
237bbd29	251	#define KEY_ALLOC_UID_KEYRING 0x0010 /* allocating a user or user session keyring */
7e047ef5	252
1da177e4	253	extern void key_revoke(struct key *key);
fd75815f	254	extern void key_invalidate(struct key *key);
1da177e4 LT	255	extern void key_put(struct key *key);
1da177e4 LT	256
ccc3e6d9	257	static inline struct key __key_get(struct key key)
1da177e4	258	{
fff29291	259	refcount_inc(&key->usage);
1da177e4 LT	260	return key;
	261	}
	262
ccc3e6d9 DH	263	static inline struct key key_get(struct key key)
	264	{
	265	return key ? __key_get(key) : key;
	266	}
	267
664cceb0 DH	268	static inline void key_ref_put(key_ref_t key_ref)
	269	{
	270	key_put(key_ref_to_ptr(key_ref));
	271	}
	272
1da177e4 LT	273	extern struct key request_key(struct key_type type,
	274	const char *description,
	275	const char *callout_info);
	276
4e54f085 DH	277	extern struct key request_key_with_auxdata(struct key_type type,
4e54f085 DH	278	const char *description,
4a38e122 DH	279	const void *callout_info,
4a38e122 DH	280	size_t callout_len,
4e54f085 DH	281	void *aux);
4e54f085 DH	282
76181c13 DH	283	extern struct key request_key_async(struct key_type type,
76181c13 DH	284	const char *description,
4a38e122 DH	285	const void *callout_info,
4a38e122 DH	286	size_t callout_len);
76181c13 DH	287
	288	extern struct key request_key_async_with_auxdata(struct key_type type,
	289	const char *description,
4a38e122 DH	290	const void *callout_info,
4a38e122 DH	291	size_t callout_len,
76181c13 DH	292	void *aux);
	293
	294	extern int wait_for_key_construction(struct key *key, bool intr);
	295
b404aef7	296	extern int key_validate(const struct key *key);
1da177e4	297
664cceb0 DH	298	extern key_ref_t key_create_or_update(key_ref_t keyring,
	299	const char *type,
	300	const char *description,
	301	const void *payload,
	302	size_t plen,
6b79ccb5	303	key_perm_t perm,
7e047ef5	304	unsigned long flags);
1da177e4	305
664cceb0	306	extern int key_update(key_ref_t key,
1da177e4 LT	307	const void *payload,
	308	size_t plen);
	309
	310	extern int key_link(struct key *keyring,
	311	struct key *key);
	312
	313	extern int key_unlink(struct key *keyring,
	314	struct key *key);
	315
9a56c2db	316	extern struct key keyring_alloc(const char description, kuid_t uid, kgid_t gid,
d84f4f99	317	const struct cred *cred,
96b5c8fe	318	key_perm_t perm,
7e047ef5	319	unsigned long flags,
2b6aa412	320	struct key_restriction *restrict_link,
d720024e	321	struct key *dest);
1da177e4	322
5ac7eace DH	323	extern int restrict_link_reject(struct key *keyring,
5ac7eace DH	324	const struct key_type *type,
aaf66c88 MM	325	const union key_payload *payload,
aaf66c88 MM	326	struct key *restriction_key);
5ac7eace	327
1da177e4 LT	328	extern int keyring_clear(struct key *keyring);
1da177e4 LT	329
664cceb0 DH	330	extern key_ref_t keyring_search(key_ref_t keyring,
	331	struct key_type *type,
	332	const char *description);
1da177e4	333
1da177e4 LT	334	extern int keyring_add_key(struct key *keyring,
	335	struct key *key);
	336
6563c91f MM	337	extern int keyring_restrict(key_ref_t keyring, const char *type,
	338	const char *restriction);
	339
1da177e4 LT	340	extern struct key *key_lookup(key_serial_t id);
1da177e4 LT	341
456a8167	342	static inline key_serial_t key_serial(const struct key *key)
7249db2c DH	343	{
	344	return key ? key->serial : 0;
	345	}
1da177e4	346
59e6b9c1 BS	347	extern void key_set_timeout(struct key *, unsigned);
59e6b9c1 BS	348
f5895943 DH	349	/*
	350	* The permissions required on a key that we're looking up.
	351	*/
	352	#define KEY_NEED_VIEW 0x01 /* Require permission to view attributes */
	353	#define KEY_NEED_READ 0x02 /* Require permission to read content */
	354	#define KEY_NEED_WRITE 0x04 /* Require permission to update / modify */
	355	#define KEY_NEED_SEARCH 0x08 /* Require permission to search (keyring) or find (key) */
	356	#define KEY_NEED_LINK 0x10 /* Require permission to link */
	357	#define KEY_NEED_SETATTR 0x20 /* Require permission to change attributes */
	358	#define KEY_NEED_ALL 0x3f /* All the above permissions */
	359
363b02da DH	360	static inline short key_read_state(const struct key *key)
	361	{
	362	/* Barrier versus mark_key_instantiated(). */
	363	return smp_load_acquire(&key->state);
	364	}
	365
78b7280c	366	/**
363b02da	367	* key_is_positive - Determine if a key has been positively instantiated
78b7280c DH	368	* @key: The key to check.
	369	*
	370	* Return true if the specified key has been positively instantiated, false
	371	* otherwise.
	372	*/
363b02da DH	373	static inline bool key_is_positive(const struct key *key)
	374	{
	375	return key_read_state(key) == KEY_IS_POSITIVE;
	376	}
	377
	378	static inline bool key_is_negative(const struct key *key)
78b7280c	379	{
363b02da	380	return key_read_state(key) < 0;
78b7280c DH	381	}
78b7280c DH	382
0837e49a DH	383	#define dereference_key_rcu(KEY) \
	384	(rcu_dereference((KEY)->payload.rcu_data0))
	385
	386	#define dereference_key_locked(KEY) \
146aa8b1	387	(rcu_dereference_protected((KEY)->payload.rcu_data0, \
633e804e DH	388	rwsem_is_locked(&((struct key *)(KEY))->sem)))
633e804e DH	389
ee0b31a2	390	#define rcu_assign_keypointer(KEY, PAYLOAD) \
e5c1f444	391	do { \
146aa8b1	392	rcu_assign_pointer((KEY)->payload.rcu_data0, (PAYLOAD)); \
e5c1f444	393	} while (0)
ee0b31a2	394
0b77f5bf	395	#ifdef CONFIG_SYSCTL
d6f50c95	396	extern struct ctl_table key_sysctls[];
0b77f5bf	397	#endif
1da177e4 LT	398	/*
	399	* the userspace interface
	400	*/
d84f4f99	401	extern int install_thread_keyring_to_cred(struct cred *cred);
1da177e4 LT	402	extern void key_fsuid_changed(struct task_struct *tsk);
	403	extern void key_fsgid_changed(struct task_struct *tsk);
	404	extern void key_init(void);
	405
	406	#else /* CONFIG_KEYS */
	407
	408	#define key_validate(k) 0
	409	#define key_serial(k) 0
7888e7ff	410	#define key_get(k) ({ NULL; })
0dab9cfa	411	#define key_revoke(k) do { } while(0)
fd75815f	412	#define key_invalidate(k) do { } while(0)
1da177e4	413	#define key_put(k) do { } while(0)
664cceb0	414	#define key_ref_put(k) do { } while(0)
8bbf4976 DH	415	#define make_key_ref(k, p) NULL
8bbf4976 DH	416	#define key_ref_to_ptr(k) NULL
664cceb0	417	#define is_key_possessed(k) 0
1da177e4 LT	418	#define key_fsuid_changed(t) do { } while(0)
	419	#define key_fsgid_changed(t) do { } while(0)
	420	#define key_init() do { } while(0)
	421
	422	#endif /* CONFIG_KEYS */
	423	#endif /* __KERNEL__ */
	424	#endif /* _LINUX_KEY_H */