[linux-2.6-block.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.txt 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>

#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 *keyring,
					const struct key_type *type,
					const union key_payload *payload);

/*****************************************************************************/
/*
 * 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 {
		time_t		expiry;		/* time at which key expires (or 0) */
		time_t		revoked_at;	/* time at which key was revoked */
	};
	time_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
						 */

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

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

	/* 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;
		};
		int reject_error;
	};

	/* This is set on a keyring to restrict the addition of a link to a key
	 * to it.  If this method isn't provided then it is assumed that the
	 * keyring is open to any addition.  It is ignored for non-keyring
	 * keys.
	 *
	 * 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.
	 */
	key_restrict_link_func_t 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,
			     key_restrict_link_func_t 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 */

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,
				 key_restrict_link_func_t restrict_link,
				 struct key *dest);

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

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

/**
 * key_is_instantiated - 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_instantiated(const struct key *key)
{
	return test_bit(KEY_FLAG_INSTANTIATED, &key->flags) &&
		!test_bit(KEY_FLAG_NEGATIVE, &key->flags);
}

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