[deliverable/linux.git] / security / keys / internal.h

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

static inline __attribute__((format(printf, 1, 2)))
void no_printk(const char *fmt, ...)
{
}

#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_user;

/*****************************************************************************/
/*
 * 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)
 * - this also keeps track of keys under request from userspace for this UID
 */
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 */
	uid_t			uid;
	struct user_namespace	*user_ns;
	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(uid_t uid,
					struct user_namespace *user_ns);
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 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 key_type *type,
			    const char *description,
			    struct keyring_list **_prealloc);
extern int __key_link_check_live_key(struct key *keyring, struct key *key);
extern void __key_link(struct key *keyring, struct key *key,
		       struct keyring_list **_prealloc);
extern void __key_link_end(struct key *keyring,
			   struct key_type *type,
			   struct keyring_list *prealloc);

extern key_ref_t __keyring_search_one(key_ref_t keyring_ref,
				      const struct key_type *type,
				      const char *description,
				      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);

extern key_ref_t search_my_process_keyrings(struct key_type *type,
					    const void *description,
					    key_match_func_t match,
					    const struct cred *cred);
extern key_ref_t search_process_keyrings(struct key_type *type,
					 const void *description,
					 key_match_func_t match,
					 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 unsigned key_gc_delay;
extern void keyring_gc(struct key *keyring, time_t limit);
extern void key_schedule_gc(time_t expiry_at);

/*
 * check to see whether permission is granted to use a key in the desired way
 */
extern int key_task_permission(const key_ref_t key_ref,
			       const struct cred *cred,
			       key_perm_t perm);

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

/*
 * request_key authorisation
 */
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);

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

/*
 * 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
1da177e4 LT	1	/* internal.h: authentication token and access key management internal defs
1da177e4 LT	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>
1da177e4	17
76181c13 DH	18	static inline __attribute__((format(printf, 1, 2)))
	19	void no_printk(const char *fmt, ...)
	20	{
	21	}
	22
	23	#ifdef __KDEBUG
	24	#define kenter(FMT, ...) \
dd6f953a	25	printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
76181c13	26	#define kleave(FMT, ...) \
dd6f953a	27	printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
76181c13	28	#define kdebug(FMT, ...) \
d84f4f99	29	printk(KERN_DEBUG " "FMT"\n", ##__VA_ARGS__)
3e30148c	30	#else
76181c13	31	#define kenter(FMT, ...) \
dd6f953a	32	no_printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
76181c13	33	#define kleave(FMT, ...) \
dd6f953a	34	no_printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
76181c13 DH	35	#define kdebug(FMT, ...) \
76181c13 DH	36	no_printk(KERN_DEBUG FMT"\n", ##__VA_ARGS__)
3e30148c DH	37	#endif
3e30148c DH	38
1da177e4 LT	39	extern struct key_type key_type_user;
	40
	41	/*****************************************************************************/
	42	/*
	43	* keep track of keys for a user
	44	* - this needs to be separate to user_struct to avoid a refcount-loop
	45	* (user_struct pins some keyrings which pin this struct)
	46	* - this also keeps track of keys under request from userspace for this UID
	47	*/
	48	struct key_user {
	49	struct rb_node node;
76181c13	50	struct mutex cons_lock; /* construction initiation lock */
1da177e4 LT	51	spinlock_t lock;
	52	atomic_t usage; /* for accessing qnkeys & qnbytes */
	53	atomic_t nkeys; /* number of keys */
	54	atomic_t nikeys; /* number of instantiated keys */
	55	uid_t uid;
1d1e9756	56	struct user_namespace *user_ns;
1da177e4 LT	57	int qnkeys; /* number of keys allocated to this user */
	58	int qnbytes; /* number of bytes allocated to this user */
	59	};
	60
1da177e4 LT	61	extern struct rb_root key_user_tree;
	62	extern spinlock_t key_user_lock;
	63	extern struct key_user root_key_user;
	64
1d1e9756 SH	65	extern struct key_user *key_user_lookup(uid_t uid,
1d1e9756 SH	66	struct user_namespace *user_ns);
1da177e4 LT	67	extern void key_user_put(struct key_user *user);
1da177e4 LT	68
0b77f5bf DH	69	/*
	70	* key quota limits
	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
	80
	81	extern struct rb_root key_serial_tree;
	82	extern spinlock_t key_serial_lock;
76181c13	83	extern struct mutex key_construction_mutex;
1da177e4 LT	84	extern wait_queue_head_t request_key_conswq;
	85
	86
e9e349b0 DH	87	extern struct key_type key_type_lookup(const char type);
	88	extern void key_type_put(struct key_type *ktype);
	89
f70e2e06 DH	90	extern int __key_link_begin(struct key *keyring,
	91	const struct key_type *type,
	92	const char *description,
	93	struct keyring_list **_prealloc);
	94	extern int __key_link_check_live_key(struct key keyring, struct key key);
	95	extern void __key_link(struct key keyring, struct key key,
	96	struct keyring_list **_prealloc);
	97	extern void __key_link_end(struct key *keyring,
	98	struct key_type *type,
	99	struct keyring_list *prealloc);
1da177e4	100
664cceb0 DH	101	extern key_ref_t __keyring_search_one(key_ref_t keyring_ref,
	102	const struct key_type *type,
	103	const char *description,
	104	key_perm_t perm);
1da177e4	105
3e30148c DH	106	extern struct key keyring_search_instkey(struct key keyring,
	107	key_serial_t target_id);
	108
1da177e4 LT	109	typedef int (key_match_func_t)(const struct key , const void *);
1da177e4 LT	110
664cceb0	111	extern key_ref_t keyring_search_aux(key_ref_t keyring_ref,
d84f4f99	112	const struct cred *cred,
664cceb0 DH	113	struct key_type *type,
	114	const void *description,
	115	key_match_func_t match);
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,
	120	const struct cred *cred);
664cceb0 DH	121	extern key_ref_t search_process_keyrings(struct key_type *type,
	122	const void *description,
	123	key_match_func_t match,
d84f4f99	124	const struct cred *cred);
1da177e4	125
69664cf1	126	extern struct key find_keyring_by_name(const char name, bool skip_perm_check);
1da177e4	127
8bbf4976	128	extern int install_user_keyrings(void);
d84f4f99 DH	129	extern int install_thread_keyring_to_cred(struct cred *);
d84f4f99 DH	130	extern int install_process_keyring_to_cred(struct cred *);
685bfd2c	131	extern int install_session_keyring_to_cred(struct cred , struct key );
3e30148c DH	132
	133	extern struct key request_key_and_link(struct key_type type,
	134	const char *description,
4a38e122 DH	135	const void *callout_info,
4a38e122 DH	136	size_t callout_len,
4e54f085	137	void *aux,
7e047ef5 DH	138	struct key *dest_keyring,
7e047ef5 DH	139	unsigned long flags);
3e30148c	140
927942aa	141	extern int lookup_user_key_possessed(const struct key key, const void target);
5593122e	142	extern key_ref_t lookup_user_key(key_serial_t id, unsigned long flags,
e9e349b0	143	key_perm_t perm);
5593122e DH	144	#define KEY_LOOKUP_CREATE 0x01
	145	#define KEY_LOOKUP_PARTIAL 0x02
	146	#define KEY_LOOKUP_FOR_UNLINK 0x04
e9e349b0 DH	147
	148	extern long join_session_keyring(const char *name);
	149
5d135440 DH	150	extern unsigned key_gc_delay;
	151	extern void keyring_gc(struct key *keyring, time_t limit);
	152	extern void key_schedule_gc(time_t expiry_at);
	153
e9e349b0 DH	154	/*
	155	* check to see whether permission is granted to use a key in the desired way
	156	*/
	157	extern int key_task_permission(const key_ref_t key_ref,
d84f4f99	158	const struct cred *cred,
e9e349b0 DH	159	key_perm_t perm);
	160
	161	static inline int key_permission(const key_ref_t key_ref, key_perm_t perm)
	162	{
d84f4f99	163	return key_task_permission(key_ref, current_cred(), perm);
e9e349b0 DH	164	}
	165
	166	/* required permissions */
	167	#define KEY_VIEW 0x01 /* require permission to view attributes */
	168	#define KEY_READ 0x02 /* require permission to read content */
	169	#define KEY_WRITE 0x04 /* require permission to update / modify */
	170	#define KEY_SEARCH 0x08 /* require permission to search (keyring) or find (key) */
	171	#define KEY_LINK 0x10 /* require permission to link */
	172	#define KEY_SETATTR 0x20 /* require permission to change attributes */
	173	#define KEY_ALL 0x3f /* all the above permissions */
	174
3e30148c DH	175	/*
	176	* request_key authorisation
	177	*/
	178	struct request_key_auth {
	179	struct key *target_key;
8bbf4976	180	struct key *dest_keyring;
d84f4f99	181	const struct cred *cred;
4a38e122 DH	182	void *callout_info;
4a38e122 DH	183	size_t callout_len;
3e30148c DH	184	pid_t pid;
	185	};
	186
	187	extern struct key_type key_type_request_key_auth;
	188	extern struct key request_key_auth_new(struct key target,
4a38e122	189	const void *callout_info,
8bbf4976 DH	190	size_t callout_len,
8bbf4976 DH	191	struct key *dest_keyring);
3e30148c DH	192
3e30148c DH	193	extern struct key *key_get_instantiation_authkey(key_serial_t target_id);
1da177e4 LT	194
	195	/*
	196	* keyctl functions
	197	*/
	198	extern long keyctl_get_keyring_ID(key_serial_t, int);
	199	extern long keyctl_join_session_keyring(const char __user *);
	200	extern long keyctl_update_key(key_serial_t, const void __user *, size_t);
	201	extern long keyctl_revoke_key(key_serial_t);
	202	extern long keyctl_keyring_clear(key_serial_t);
	203	extern long keyctl_keyring_link(key_serial_t, key_serial_t);
	204	extern long keyctl_keyring_unlink(key_serial_t, key_serial_t);
	205	extern long keyctl_describe_key(key_serial_t, char __user *, size_t);
	206	extern long keyctl_keyring_search(key_serial_t, const char __user *,
	207	const char __user *, key_serial_t);
	208	extern long keyctl_read_key(key_serial_t, char __user *, size_t);
	209	extern long keyctl_chown_key(key_serial_t, uid_t, gid_t);
	210	extern long keyctl_setperm_key(key_serial_t, key_perm_t);
	211	extern long keyctl_instantiate_key(key_serial_t, const void __user *,
	212	size_t, key_serial_t);
	213	extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t);
3e30148c	214	extern long keyctl_set_reqkey_keyring(int);
017679c4	215	extern long keyctl_set_timeout(key_serial_t, unsigned);
b5f545c8	216	extern long keyctl_assume_authority(key_serial_t);
70a5bb72 DH	217	extern long keyctl_get_security(key_serial_t keyid, char __user *buffer,
70a5bb72 DH	218	size_t buflen);
ee18d64c	219	extern long keyctl_session_to_parent(void);
1da177e4 LT	220
	221	/*
	222	* debugging key validation
	223	*/
	224	#ifdef KEY_DEBUGGING
	225	extern void __key_check(const struct key *);
	226
	227	static inline void key_check(const struct key *key)
	228	{
	229	if (key && (IS_ERR(key) \|\| key->magic != KEY_DEBUG_MAGIC))
	230	__key_check(key);
	231	}
	232
	233	#else
	234
	235	#define key_check(key) do {} while(0)
	236
	237	#endif
	238
	239	#endif /* _INTERNAL_H */