[mirror_ubuntu-eoan-kernel.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>
#include <linux/rcupdate.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 rcu_head		cr_rcu;
	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_HASHED	2

#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>
31be5bf1	19	#include <linux/rcupdate.h>
1da177e4 LT	20
	21	/* size of the nodename buffer */
	22	#define UNX_MAXNODENAME 32
	23
1da177e4 LT	24	/* Work around the lack of a VFS credential */
	25	struct auth_cred {
	26	uid_t uid;
	27	gid_t gid;
	28	struct group_info *group_info;
	29	};
	30
	31	/*
	32	* Client user credentials
	33	*/
4a8c1344 TM	34	struct rpc_auth;
4a8c1344 TM	35	struct rpc_credops;
1da177e4 LT	36	struct rpc_cred {
1da177e4 LT	37	struct hlist_node cr_hash; /* hash chain */
e092bdcd	38	struct list_head cr_lru; /* lru garbage collection */
31be5bf1	39	struct rcu_head cr_rcu;
4a8c1344	40	struct rpc_auth * cr_auth;
f1c0a861	41	const struct rpc_credops *cr_ops;
1da177e4 LT	42	#ifdef RPC_DEBUG
	43	unsigned long cr_magic; /* 0x0f4aa4f0 */
	44	#endif
fc432dd9 TM	45	unsigned long cr_expire; /* when to gc */
	46	unsigned long cr_flags; /* various flags */
	47	atomic_t cr_count; /* ref count */
1da177e4 LT	48
	49	uid_t cr_uid;
	50
	51	/* per-flavor data */
	52	};
fc432dd9 TM	53	#define RPCAUTH_CRED_NEW 0
fc432dd9 TM	54	#define RPCAUTH_CRED_UPTODATE 1
31be5bf1	55	#define RPCAUTH_CRED_HASHED 2
1da177e4 LT	56
	57	#define RPCAUTH_CRED_MAGIC 0x0f4aa4f0
	58
	59	/*
	60	* Client authentication handle
	61	*/
	62	#define RPC_CREDCACHE_NR 8
	63	#define RPC_CREDCACHE_MASK (RPC_CREDCACHE_NR - 1)
	64	struct rpc_cred_cache {
	65	struct hlist_head hashtable[RPC_CREDCACHE_NR];
	66	unsigned long nextgc; /* next garbage collection */
	67	unsigned long expire; /* cache expiry interval */
	68	};
	69
4a8c1344	70	struct rpc_authops;
1da177e4 LT	71	struct rpc_auth {
1da177e4 LT	72	unsigned int au_cslack; /* call cred size estimate */
24b2605b BF	73	/* guess at number of u32's auth adds before
	74	* reply data; normally the verifier size: */
	75	unsigned int au_rslack;
	76	/* for gss, used to calculate au_rslack: */
	77	unsigned int au_verfsize;
	78
1da177e4	79	unsigned int au_flags; /* various flags */
f1c0a861	80	const struct rpc_authops au_ops; / operations */
1da177e4 LT	81	rpc_authflavor_t au_flavor; /* pseudoflavor (note may
	82	* differ from the flavor in
	83	* au_ops->au_flavor in gss
	84	* case) */
	85	atomic_t au_count; /* Reference counter */
	86
	87	struct rpc_cred_cache * au_credcache;
	88	/* per-flavor data */
	89	};
1da177e4	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 */
fba3bad4	113	int (cr_init)(struct rpc_auth , struct rpc_cred *);
1da177e4 LT	114	void (crdestroy)(struct rpc_cred );
	115
	116	int (crmatch)(struct auth_cred , struct rpc_cred *, int);
d8ed029d	117	__be32 * (crmarshal)(struct rpc_task , __be32 *);
1da177e4	118	int (crrefresh)(struct rpc_task );
d8ed029d	119	__be32 * (crvalidate)(struct rpc_task , __be32 *);
1da177e4	120	int (crwrap_req)(struct rpc_task , kxdrproc_t,
d8ed029d	121	void , __be32 , void *);
1da177e4	122	int (crunwrap_resp)(struct rpc_task , kxdrproc_t,
d8ed029d	123	void , __be32 , void *);
1da177e4 LT	124	};
1da177e4 LT	125
f1c0a861 TM	126	extern const struct rpc_authops authunix_ops;
f1c0a861 TM	127	extern const struct rpc_authops authnull_ops;
1da177e4	128
f1c0a861 TM	129	int rpcauth_register(const struct rpc_authops *);
f1c0a861 TM	130	int rpcauth_unregister(const struct rpc_authops *);
1da177e4	131	struct rpc_auth * rpcauth_create(rpc_authflavor_t, struct rpc_clnt *);
de7a8ce3	132	void rpcauth_release(struct rpc_auth *);
1da177e4	133	struct rpc_cred * rpcauth_lookup_credcache(struct rpc_auth , struct auth_cred , int);
5fe4755e	134	void rpcauth_init_cred(struct rpc_cred , const struct auth_cred , struct rpc_auth , const struct rpc_credops );
1da177e4 LT	135	struct rpc_cred * rpcauth_lookupcred(struct rpc_auth *, int);
	136	struct rpc_cred * rpcauth_bindcred(struct rpc_task *);
	137	void rpcauth_holdcred(struct rpc_task *);
	138	void put_rpccred(struct rpc_cred *);
	139	void rpcauth_unbindcred(struct rpc_task *);
d8ed029d AD	140	__be32 * rpcauth_marshcred(struct rpc_task , __be32 );
	141	__be32 * rpcauth_checkverf(struct rpc_task , __be32 );
	142	int rpcauth_wrap_req(struct rpc_task task, kxdrproc_t encode, void rqstp, __be32 data, void obj);
	143	int rpcauth_unwrap_resp(struct rpc_task task, kxdrproc_t decode, void rqstp, __be32 data, void obj);
1da177e4 LT	144	int rpcauth_refreshcred(struct rpc_task *);
	145	void rpcauth_invalcred(struct rpc_task *);
	146	int rpcauth_uptodatecred(struct rpc_task *);
	147	int rpcauth_init_credcache(struct rpc_auth *, unsigned long);
3ab9bb72 TM	148	void rpcauth_destroy_credcache(struct rpc_auth *);
3ab9bb72 TM	149	void rpcauth_clear_credcache(struct rpc_cred_cache *);
1da177e4 LT	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 */