[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/key-type.h>
#include <linux/key-ui.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 "xxx" FMT"yyy\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;
	int			qnkeys;		/* number of keys allocated to this user */
	int			qnbytes;	/* number of bytes allocated to this user */
};

#define KEYQUOTA_MAX_KEYS	100
#define KEYQUOTA_MAX_BYTES	10000
#define KEYQUOTA_LINK_BYTES	4		/* a link in a keyring is worth 4 bytes */

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);
extern void key_user_put(struct key_user *user);


extern struct rb_root key_serial_tree;
extern spinlock_t key_serial_lock;
extern struct semaphore key_alloc_sem;
extern struct mutex key_construction_mutex;
extern wait_queue_head_t request_key_conswq;


extern void keyring_publish_name(struct key *keyring);

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

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,
				    struct task_struct *tsk,
				    struct key_type *type,
				    const void *description,
				    key_match_func_t match);

extern key_ref_t search_process_keyrings(struct key_type *type,
					 const void *description,
					 key_match_func_t match,
					 struct task_struct *tsk);

extern struct key *find_keyring_by_name(const char *name, key_serial_t bound);

extern int install_thread_keyring(struct task_struct *tsk);
extern int install_process_keyring(struct task_struct *tsk);

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

/*
 * request_key authorisation
 */
struct request_key_auth {
	struct key		*target_key;
	struct task_struct	*context;
	char			*callout_info;
	pid_t			pid;
};

extern struct key_type key_type_request_key_auth;
extern struct key *request_key_auth_new(struct key *target,
					const char *callout_info);

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


/*
 * 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
76181c13	15	#include <linux/key-type.h>
1da177e4 LT	16	#include <linux/key-ui.h>
1da177e4 LT	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 DH	28	#define kdebug(FMT, ...) \
76181c13 DH	29	printk(KERN_DEBUG "xxx" FMT"yyy\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;
	56	int qnkeys; /* number of keys allocated to this user */
	57	int qnbytes; /* number of bytes allocated to this user */
	58	};
	59
	60	#define KEYQUOTA_MAX_KEYS 100
	61	#define KEYQUOTA_MAX_BYTES 10000
	62	#define KEYQUOTA_LINK_BYTES 4 /* a link in a keyring is worth 4 bytes */
	63
	64	extern struct rb_root key_user_tree;
	65	extern spinlock_t key_user_lock;
	66	extern struct key_user root_key_user;
	67
	68	extern struct key_user *key_user_lookup(uid_t uid);
	69	extern void key_user_put(struct key_user *user);
	70
	71
	72
	73	extern struct rb_root key_serial_tree;
	74	extern spinlock_t key_serial_lock;
	75	extern struct semaphore key_alloc_sem;
76181c13	76	extern struct mutex key_construction_mutex;
1da177e4 LT	77	extern wait_queue_head_t request_key_conswq;
	78
	79
	80	extern void keyring_publish_name(struct key *keyring);
	81
	82	extern int __key_link(struct key keyring, struct key key);
	83
664cceb0 DH	84	extern key_ref_t __keyring_search_one(key_ref_t keyring_ref,
	85	const struct key_type *type,
	86	const char *description,
	87	key_perm_t perm);
1da177e4	88
3e30148c DH	89	extern struct key keyring_search_instkey(struct key keyring,
	90	key_serial_t target_id);
	91
1da177e4 LT	92	typedef int (key_match_func_t)(const struct key , const void *);
1da177e4 LT	93
664cceb0 DH	94	extern key_ref_t keyring_search_aux(key_ref_t keyring_ref,
	95	struct task_struct *tsk,
	96	struct key_type *type,
	97	const void *description,
	98	key_match_func_t match);
1da177e4	99
664cceb0 DH	100	extern key_ref_t search_process_keyrings(struct key_type *type,
	101	const void *description,
	102	key_match_func_t match,
	103	struct task_struct *tsk);
1da177e4 LT	104
	105	extern struct key find_keyring_by_name(const char name, key_serial_t bound);
	106
	107	extern int install_thread_keyring(struct task_struct *tsk);
3e30148c DH	108	extern int install_process_keyring(struct task_struct *tsk);
	109
	110	extern struct key request_key_and_link(struct key_type type,
	111	const char *description,
	112	const char *callout_info,
4e54f085	113	void *aux,
7e047ef5 DH	114	struct key *dest_keyring,
7e047ef5 DH	115	unsigned long flags);
3e30148c DH	116
	117	/*
	118	* request_key authorisation
	119	*/
	120	struct request_key_auth {
	121	struct key *target_key;
	122	struct task_struct *context;
76181c13	123	char *callout_info;
3e30148c DH	124	pid_t pid;
	125	};
	126
	127	extern struct key_type key_type_request_key_auth;
	128	extern struct key request_key_auth_new(struct key target,
b5f545c8	129	const char *callout_info);
3e30148c DH	130
3e30148c DH	131	extern struct key *key_get_instantiation_authkey(key_serial_t target_id);
1da177e4 LT	132
	133	/*
	134	* keyctl functions
	135	*/
	136	extern long keyctl_get_keyring_ID(key_serial_t, int);
	137	extern long keyctl_join_session_keyring(const char __user *);
	138	extern long keyctl_update_key(key_serial_t, const void __user *, size_t);
	139	extern long keyctl_revoke_key(key_serial_t);
	140	extern long keyctl_keyring_clear(key_serial_t);
	141	extern long keyctl_keyring_link(key_serial_t, key_serial_t);
	142	extern long keyctl_keyring_unlink(key_serial_t, key_serial_t);
	143	extern long keyctl_describe_key(key_serial_t, char __user *, size_t);
	144	extern long keyctl_keyring_search(key_serial_t, const char __user *,
	145	const char __user *, key_serial_t);
	146	extern long keyctl_read_key(key_serial_t, char __user *, size_t);
	147	extern long keyctl_chown_key(key_serial_t, uid_t, gid_t);
	148	extern long keyctl_setperm_key(key_serial_t, key_perm_t);
	149	extern long keyctl_instantiate_key(key_serial_t, const void __user *,
	150	size_t, key_serial_t);
	151	extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t);
3e30148c	152	extern long keyctl_set_reqkey_keyring(int);
017679c4	153	extern long keyctl_set_timeout(key_serial_t, unsigned);
b5f545c8	154	extern long keyctl_assume_authority(key_serial_t);
1da177e4 LT	155
	156
	157	/*
	158	* debugging key validation
	159	*/
	160	#ifdef KEY_DEBUGGING
	161	extern void __key_check(const struct key *);
	162
	163	static inline void key_check(const struct key *key)
	164	{
	165	if (key && (IS_ERR(key) \|\| key->magic != KEY_DEBUG_MAGIC))
	166	__key_check(key);
	167	}
	168
	169	#else
	170
	171	#define key_check(key) do {} while(0)
	172
	173	#endif
	174
	175	#endif /* _INTERNAL_H */