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

/* 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_auth;
struct rpc_credops;
struct rpc_cred {
	struct hlist_node	cr_hash;	/* hash chain */
	struct list_head	cr_lru;		/* lru garbage collection */
	struct rpc_auth *	cr_auth;
	const struct rpc_credops *cr_ops;
#ifdef RPC_DEBUG
	unsigned long		cr_magic;	/* 0x0f4aa4f0 */
#endif
	unsigned long		cr_expire;	/* when to gc */
	unsigned long		cr_flags;	/* various flags */
	atomic_t		cr_count;	/* ref count */

	uid_t			cr_uid;

	/* per-flavor data */
};
#define RPCAUTH_CRED_NEW	0
#define RPCAUTH_CRED_UPTODATE	1

#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_authops;
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 */
	const 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 */
};

/* 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 */
	int			(*cr_init)(struct rpc_auth *, struct rpc_cred *);
	void			(*crdestroy)(struct rpc_cred *);

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

extern const struct rpc_authops	authunix_ops;
extern const struct rpc_authops	authnull_ops;

int			rpcauth_register(const struct rpc_authops *);
int			rpcauth_unregister(const struct rpc_authops *);
struct rpc_auth *	rpcauth_create(rpc_authflavor_t, struct rpc_clnt *);
void			rpcauth_release(struct rpc_auth *);
struct rpc_cred *	rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int);
void			rpcauth_init_cred(struct rpc_cred *, const struct auth_cred *, struct rpc_auth *, const struct rpc_credops *);
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 *);
__be32 *		rpcauth_marshcred(struct rpc_task *, __be32 *);
__be32 *		rpcauth_checkverf(struct rpc_task *, __be32 *);
int			rpcauth_wrap_req(struct rpc_task *task, kxdrproc_t encode, void *rqstp, __be32 *data, void *obj);
int			rpcauth_unwrap_resp(struct rpc_task *task, kxdrproc_t decode, void *rqstp, __be32 *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_destroy_credcache(struct rpc_auth *);
void			rpcauth_clear_credcache(struct rpc_cred_cache *);

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
1da177e4 LT	14	#include <linux/sunrpc/sched.h>
	15	#include <linux/sunrpc/msg_prot.h>
	16	#include <linux/sunrpc/xdr.h>
	17
	18	#include <asm/atomic.h>
	19
	20	/* size of the nodename buffer */
	21	#define UNX_MAXNODENAME 32
	22
1da177e4 LT	23	/* Work around the lack of a VFS credential */
	24	struct auth_cred {
	25	uid_t uid;
	26	gid_t gid;
	27	struct group_info *group_info;
	28	};
	29
	30	/*
	31	* Client user credentials
	32	*/
4a8c1344 TM	33	struct rpc_auth;
4a8c1344 TM	34	struct rpc_credops;
1da177e4 LT	35	struct rpc_cred {
1da177e4 LT	36	struct hlist_node cr_hash; /* hash chain */
e092bdcd	37	struct list_head cr_lru; /* lru garbage collection */
4a8c1344	38	struct rpc_auth * cr_auth;
f1c0a861	39	const struct rpc_credops *cr_ops;
1da177e4 LT	40	#ifdef RPC_DEBUG
	41	unsigned long cr_magic; /* 0x0f4aa4f0 */
	42	#endif
fc432dd9 TM	43	unsigned long cr_expire; /* when to gc */
	44	unsigned long cr_flags; /* various flags */
	45	atomic_t cr_count; /* ref count */
1da177e4 LT	46
	47	uid_t cr_uid;
	48
	49	/* per-flavor data */
	50	};
fc432dd9 TM	51	#define RPCAUTH_CRED_NEW 0
fc432dd9 TM	52	#define RPCAUTH_CRED_UPTODATE 1
1da177e4 LT	53
	54	#define RPCAUTH_CRED_MAGIC 0x0f4aa4f0
	55
	56	/*
	57	* Client authentication handle
	58	*/
	59	#define RPC_CREDCACHE_NR 8
	60	#define RPC_CREDCACHE_MASK (RPC_CREDCACHE_NR - 1)
	61	struct rpc_cred_cache {
	62	struct hlist_head hashtable[RPC_CREDCACHE_NR];
	63	unsigned long nextgc; /* next garbage collection */
	64	unsigned long expire; /* cache expiry interval */
	65	};
	66
4a8c1344	67	struct rpc_authops;
1da177e4 LT	68	struct rpc_auth {
1da177e4 LT	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	76	unsigned int au_flags; /* various flags */
f1c0a861	77	const struct rpc_authops au_ops; / operations */
1da177e4 LT	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	};
1da177e4	87
8a317760 TM	88	/* Flags for rpcauth_lookupcred() */
	89	#define RPCAUTH_LOOKUP_NEW 0x01 /* Accept an uninitialised cred */
	90	#define RPCAUTH_LOOKUP_ROOTCREDS 0x02 /* This really ought to go! */
	91
1da177e4 LT	92	/*
	93	* Client authentication ops
	94	*/
	95	struct rpc_authops {
	96	struct module *owner;
	97	rpc_authflavor_t au_flavor; /* flavor (RPC_AUTH_) /
	98	#ifdef RPC_DEBUG
	99	char * au_name;
	100	#endif
	101	struct rpc_auth * (create)(struct rpc_clnt , rpc_authflavor_t);
	102	void (destroy)(struct rpc_auth );
	103
	104	struct rpc_cred * (lookup_cred)(struct rpc_auth , struct auth_cred *, int);
	105	struct rpc_cred * (crcreate)(struct rpc_auth, struct auth_cred *, int);
	106	};
	107
	108	struct rpc_credops {
	109	const char * cr_name; /* Name of the auth flavour */
fba3bad4	110	int (cr_init)(struct rpc_auth , struct rpc_cred *);
1da177e4 LT	111	void (crdestroy)(struct rpc_cred );
	112
	113	int (crmatch)(struct auth_cred , struct rpc_cred *, int);
d8ed029d	114	__be32 * (crmarshal)(struct rpc_task , __be32 *);
1da177e4	115	int (crrefresh)(struct rpc_task );
d8ed029d	116	__be32 * (crvalidate)(struct rpc_task , __be32 *);
1da177e4	117	int (crwrap_req)(struct rpc_task , kxdrproc_t,
d8ed029d	118	void , __be32 , void *);
1da177e4	119	int (crunwrap_resp)(struct rpc_task , kxdrproc_t,
d8ed029d	120	void , __be32 , void *);
1da177e4 LT	121	};
1da177e4 LT	122
f1c0a861 TM	123	extern const struct rpc_authops authunix_ops;
f1c0a861 TM	124	extern const struct rpc_authops authnull_ops;
1da177e4	125
f1c0a861 TM	126	int rpcauth_register(const struct rpc_authops *);
f1c0a861 TM	127	int rpcauth_unregister(const struct rpc_authops *);
1da177e4	128	struct rpc_auth * rpcauth_create(rpc_authflavor_t, struct rpc_clnt *);
de7a8ce3	129	void rpcauth_release(struct rpc_auth *);
1da177e4	130	struct rpc_cred * rpcauth_lookup_credcache(struct rpc_auth , struct auth_cred , int);
5fe4755e	131	void rpcauth_init_cred(struct rpc_cred , const struct auth_cred , struct rpc_auth , const struct rpc_credops );
1da177e4 LT	132	struct rpc_cred * rpcauth_lookupcred(struct rpc_auth *, int);
	133	struct rpc_cred * rpcauth_bindcred(struct rpc_task *);
	134	void rpcauth_holdcred(struct rpc_task *);
	135	void put_rpccred(struct rpc_cred *);
	136	void rpcauth_unbindcred(struct rpc_task *);
d8ed029d AD	137	__be32 * rpcauth_marshcred(struct rpc_task , __be32 );
	138	__be32 * rpcauth_checkverf(struct rpc_task , __be32 );
	139	int rpcauth_wrap_req(struct rpc_task task, kxdrproc_t encode, void rqstp, __be32 data, void obj);
	140	int rpcauth_unwrap_resp(struct rpc_task task, kxdrproc_t decode, void rqstp, __be32 data, void obj);
1da177e4 LT	141	int rpcauth_refreshcred(struct rpc_task *);
	142	void rpcauth_invalcred(struct rpc_task *);
	143	int rpcauth_uptodatecred(struct rpc_task *);
	144	int rpcauth_init_credcache(struct rpc_auth *, unsigned long);
3ab9bb72 TM	145	void rpcauth_destroy_credcache(struct rpc_auth *);
3ab9bb72 TM	146	void rpcauth_clear_credcache(struct rpc_cred_cache *);
1da177e4 LT	147
	148	static inline
	149	struct rpc_cred * get_rpccred(struct rpc_cred *cred)
	150	{
	151	atomic_inc(&cred->cr_count);
	152	return cred;
	153	}
	154
	155	#endif /* __KERNEL__ */
	156	#endif /* _LINUX_SUNRPC_AUTH_H */