[deliverable/linux.git] / include / linux / sunrpc / auth.h

/*
 * linux/include/linux/sunrpc/auth.h
 *
 * Declarations for the RPC client authentication machinery.
 *
 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
 */

#ifndef _LINUX_SUNRPC_AUTH_H
#define _LINUX_SUNRPC_AUTH_H

#ifdef __KERNEL__

#include <linux/config.h>
#include <linux/sunrpc/sched.h>
#include <linux/sunrpc/msg_prot.h>
#include <linux/sunrpc/xdr.h>

#include <asm/atomic.h>

/* size of the nodename buffer */
#define UNX_MAXNODENAME	32

/* Maximum size (in bytes) of an rpc credential or verifier */
#define RPC_MAX_AUTH_SIZE (400)

/* Work around the lack of a VFS credential */
struct auth_cred {
	uid_t	uid;
	gid_t	gid;
	struct group_info *group_info;
};

/*
 * Client user credentials
 */
struct rpc_cred {
	struct hlist_node	cr_hash;	/* hash chain */
	struct rpc_credops *	cr_ops;
	unsigned long		cr_expire;	/* when to gc */
	atomic_t		cr_count;	/* ref count */
	unsigned short		cr_flags;	/* various flags */
#ifdef RPC_DEBUG
	unsigned long		cr_magic;	/* 0x0f4aa4f0 */
#endif

	uid_t			cr_uid;

	/* per-flavor data */
};
#define RPCAUTH_CRED_LOCKED	0x0001
#define RPCAUTH_CRED_UPTODATE	0x0002
#define RPCAUTH_CRED_NEW	0x0004

#define RPCAUTH_CRED_MAGIC	0x0f4aa4f0

/*
 * Client authentication handle
 */
#define RPC_CREDCACHE_NR	8
#define RPC_CREDCACHE_MASK	(RPC_CREDCACHE_NR - 1)
struct rpc_cred_cache {
	struct hlist_head	hashtable[RPC_CREDCACHE_NR];
	unsigned long		nextgc;		/* next garbage collection */
	unsigned long		expire;		/* cache expiry interval */
};

struct rpc_auth {
	unsigned int		au_cslack;	/* call cred size estimate */
				/* guess at number of u32's auth adds before
				 * reply data; normally the verifier size: */
	unsigned int		au_rslack;
				/* for gss, used to calculate au_rslack: */
	unsigned int		au_verfsize;

	unsigned int		au_flags;	/* various flags */
	struct rpc_authops *	au_ops;		/* operations */
	rpc_authflavor_t	au_flavor;	/* pseudoflavor (note may
						 * differ from the flavor in
						 * au_ops->au_flavor in gss
						 * case) */
	atomic_t		au_count;	/* Reference counter */

	struct rpc_cred_cache *	au_credcache;
	/* per-flavor data */
};
#define RPC_AUTH_PROC_CREDS	0x0010		/* process creds (including
						 * uid/gid, fs[ug]id, gids)
						 */

/* Flags for rpcauth_lookupcred() */
#define RPCAUTH_LOOKUP_NEW		0x01	/* Accept an uninitialised cred */
#define RPCAUTH_LOOKUP_ROOTCREDS	0x02	/* This really ought to go! */

/*
 * Client authentication ops
 */
struct rpc_authops {
	struct module		*owner;
	rpc_authflavor_t	au_flavor;	/* flavor (RPC_AUTH_*) */
#ifdef RPC_DEBUG
	char *			au_name;
#endif
	struct rpc_auth *	(*create)(struct rpc_clnt *, rpc_authflavor_t);
	void			(*destroy)(struct rpc_auth *);

	struct rpc_cred *	(*lookup_cred)(struct rpc_auth *, struct auth_cred *, int);
	struct rpc_cred *	(*crcreate)(struct rpc_auth*, struct auth_cred *, int);
};

struct rpc_credops {
	const char *		cr_name;	/* Name of the auth flavour */
	void			(*crdestroy)(struct rpc_cred *);

	int			(*crmatch)(struct auth_cred *, struct rpc_cred *, int);
	u32 *			(*crmarshal)(struct rpc_task *, u32 *);
	int			(*crrefresh)(struct rpc_task *);
	u32 *			(*crvalidate)(struct rpc_task *, u32 *);
	int			(*crwrap_req)(struct rpc_task *, kxdrproc_t,
						void *, u32 *, void *);
	int			(*crunwrap_resp)(struct rpc_task *, kxdrproc_t,
						void *, u32 *, void *);
};

extern struct rpc_authops	authunix_ops;
extern struct rpc_authops	authnull_ops;
#ifdef CONFIG_SUNRPC_SECURE
extern struct rpc_authops	authdes_ops;
#endif

int			rpcauth_register(struct rpc_authops *);
int			rpcauth_unregister(struct rpc_authops *);
struct rpc_auth *	rpcauth_create(rpc_authflavor_t, struct rpc_clnt *);
void			rpcauth_destroy(struct rpc_auth *);
struct rpc_cred *	rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int);
struct rpc_cred *	rpcauth_lookupcred(struct rpc_auth *, int);
struct rpc_cred *	rpcauth_bindcred(struct rpc_task *);
void			rpcauth_holdcred(struct rpc_task *);
void			put_rpccred(struct rpc_cred *);
void			rpcauth_unbindcred(struct rpc_task *);
u32 *			rpcauth_marshcred(struct rpc_task *, u32 *);
u32 *			rpcauth_checkverf(struct rpc_task *, u32 *);
int			rpcauth_wrap_req(struct rpc_task *task, kxdrproc_t encode, void *rqstp, u32 *data, void *obj);
int			rpcauth_unwrap_resp(struct rpc_task *task, kxdrproc_t decode, void *rqstp, u32 *data, void *obj);
int			rpcauth_refreshcred(struct rpc_task *);
void			rpcauth_invalcred(struct rpc_task *);
int			rpcauth_uptodatecred(struct rpc_task *);
int			rpcauth_init_credcache(struct rpc_auth *, unsigned long);
void			rpcauth_free_credcache(struct rpc_auth *);

static inline
struct rpc_cred *	get_rpccred(struct rpc_cred *cred)
{
	atomic_inc(&cred->cr_count);
	return cred;
}

#endif /* __KERNEL__ */
#endif /* _LINUX_SUNRPC_AUTH_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/include/linux/sunrpc/auth.h
	3	*
	4	* Declarations for the RPC client authentication machinery.
	5	*
	6	* Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
	7	*/
	8
	9	#ifndef _LINUX_SUNRPC_AUTH_H
	10	#define _LINUX_SUNRPC_AUTH_H
	11
	12	#ifdef __KERNEL__
	13
	14	#include <linux/config.h>
	15	#include <linux/sunrpc/sched.h>
	16	#include <linux/sunrpc/msg_prot.h>
	17	#include <linux/sunrpc/xdr.h>
	18
	19	#include <asm/atomic.h>
	20
	21	/* size of the nodename buffer */
	22	#define UNX_MAXNODENAME 32
	23
	24	/* Maximum size (in bytes) of an rpc credential or verifier */
	25	#define RPC_MAX_AUTH_SIZE (400)
	26
	27	/* Work around the lack of a VFS credential */
	28	struct auth_cred {
	29	uid_t uid;
	30	gid_t gid;
	31	struct group_info *group_info;
	32	};
	33
	34	/*
	35	* Client user credentials
	36	*/
	37	struct rpc_cred {
	38	struct hlist_node cr_hash; /* hash chain */
	39	struct rpc_credops * cr_ops;
	40	unsigned long cr_expire; /* when to gc */
	41	atomic_t cr_count; /* ref count */
	42	unsigned short cr_flags; /* various flags */
	43	#ifdef RPC_DEBUG
	44	unsigned long cr_magic; /* 0x0f4aa4f0 */
	45	#endif
	46
	47	uid_t cr_uid;
	48
	49	/* per-flavor data */
	50	};
	51	#define RPCAUTH_CRED_LOCKED 0x0001
	52	#define RPCAUTH_CRED_UPTODATE 0x0002
8a317760	53	#define RPCAUTH_CRED_NEW 0x0004
1da177e4 LT	54
	55	#define RPCAUTH_CRED_MAGIC 0x0f4aa4f0
	56
	57	/*
	58	* Client authentication handle
	59	*/
	60	#define RPC_CREDCACHE_NR 8
	61	#define RPC_CREDCACHE_MASK (RPC_CREDCACHE_NR - 1)
	62	struct rpc_cred_cache {
	63	struct hlist_head hashtable[RPC_CREDCACHE_NR];
	64	unsigned long nextgc; /* next garbage collection */
	65	unsigned long expire; /* cache expiry interval */
	66	};
	67
	68	struct rpc_auth {
	69	unsigned int au_cslack; /* call cred size estimate */
24b2605b BF	70	/* guess at number of u32's auth adds before
	71	* reply data; normally the verifier size: */
	72	unsigned int au_rslack;
	73	/* for gss, used to calculate au_rslack: */
	74	unsigned int au_verfsize;
	75
1da177e4 LT	76	unsigned int au_flags; /* various flags */
	77	struct rpc_authops * au_ops; /* operations */
	78	rpc_authflavor_t au_flavor; /* pseudoflavor (note may
	79	* differ from the flavor in
	80	* au_ops->au_flavor in gss
	81	* case) */
	82	atomic_t au_count; /* Reference counter */
	83
	84	struct rpc_cred_cache * au_credcache;
	85	/* per-flavor data */
	86	};
	87	#define RPC_AUTH_PROC_CREDS 0x0010 /* process creds (including
	88	* uid/gid, fs[ug]id, gids)
	89	*/
	90
8a317760 TM	91	/* Flags for rpcauth_lookupcred() */
	92	#define RPCAUTH_LOOKUP_NEW 0x01 /* Accept an uninitialised cred */
	93	#define RPCAUTH_LOOKUP_ROOTCREDS 0x02 /* This really ought to go! */
	94
1da177e4 LT	95	/*
	96	* Client authentication ops
	97	*/
	98	struct rpc_authops {
	99	struct module *owner;
	100	rpc_authflavor_t au_flavor; /* flavor (RPC_AUTH_) /
	101	#ifdef RPC_DEBUG
	102	char * au_name;
	103	#endif
	104	struct rpc_auth * (create)(struct rpc_clnt , rpc_authflavor_t);
	105	void (destroy)(struct rpc_auth );
	106
	107	struct rpc_cred * (lookup_cred)(struct rpc_auth , struct auth_cred *, int);
	108	struct rpc_cred * (crcreate)(struct rpc_auth, struct auth_cred *, int);
	109	};
	110
	111	struct rpc_credops {
	112	const char * cr_name; /* Name of the auth flavour */
	113	void (crdestroy)(struct rpc_cred );
	114
	115	int (crmatch)(struct auth_cred , struct rpc_cred *, int);
	116	u32 * (crmarshal)(struct rpc_task , u32 *);
	117	int (crrefresh)(struct rpc_task );
	118	u32 * (crvalidate)(struct rpc_task , u32 *);
	119	int (crwrap_req)(struct rpc_task , kxdrproc_t,
	120	void , u32 , void *);
	121	int (crunwrap_resp)(struct rpc_task , kxdrproc_t,
	122	void , u32 , void *);
	123	};
	124
	125	extern struct rpc_authops authunix_ops;
	126	extern struct rpc_authops authnull_ops;
	127	#ifdef CONFIG_SUNRPC_SECURE
	128	extern struct rpc_authops authdes_ops;
	129	#endif
	130
	131	int rpcauth_register(struct rpc_authops *);
	132	int rpcauth_unregister(struct rpc_authops *);
	133	struct rpc_auth * rpcauth_create(rpc_authflavor_t, struct rpc_clnt *);
	134	void rpcauth_destroy(struct rpc_auth *);
	135	struct rpc_cred * rpcauth_lookup_credcache(struct rpc_auth , struct auth_cred , int);
	136	struct rpc_cred * rpcauth_lookupcred(struct rpc_auth *, int);
	137	struct rpc_cred * rpcauth_bindcred(struct rpc_task *);
	138	void rpcauth_holdcred(struct rpc_task *);
	139	void put_rpccred(struct rpc_cred *);
	140	void rpcauth_unbindcred(struct rpc_task *);
	141	u32 * rpcauth_marshcred(struct rpc_task , u32 );
	142	u32 * rpcauth_checkverf(struct rpc_task , u32 );
	143	int rpcauth_wrap_req(struct rpc_task task, kxdrproc_t encode, void rqstp, u32 data, void obj);
	144	int rpcauth_unwrap_resp(struct rpc_task task, kxdrproc_t decode, void rqstp, u32 data, void obj);
	145	int rpcauth_refreshcred(struct rpc_task *);
	146	void rpcauth_invalcred(struct rpc_task *);
	147	int rpcauth_uptodatecred(struct rpc_task *);
	148	int rpcauth_init_credcache(struct rpc_auth *, unsigned long);
	149	void rpcauth_free_credcache(struct rpc_auth *);
	150
	151	static inline
	152	struct rpc_cred * get_rpccred(struct rpc_cred *cred)
	153	{
	154	atomic_inc(&cred->cr_count);
	155	return cred;
	156	}
	157
	158	#endif /* __KERNEL__ */
159	#endif /* _LINUX_SUNRPC_AUTH_H */