[mirror_ubuntu-zesty-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 <linux/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;
	const char *principal;
	unsigned char machine_cred : 1;
};

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

#define RPCAUTH_CRED_MAGIC	0x0f4aa4f0

/*
 * Client authentication handle
 */
struct rpc_cred_cache;
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 */

/*
 * Client authentication ops
 */
struct rpc_authops {
	struct module		*owner;
	rpc_authflavor_t	au_flavor;	/* flavor (RPC_AUTH_*) */
	char *			au_name;
	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);
	struct rpc_cred *	(*crbind)(struct rpc_task *, 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 *, kxdreproc_t,
						void *, __be32 *, void *);
	int			(*crunwrap_resp)(struct rpc_task *, kxdrdproc_t,
						void *, __be32 *, void *);
};

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

int __init		rpc_init_authunix(void);
int __init		rpc_init_generic_auth(void);
int __init		rpcauth_init_module(void);
void			rpcauth_remove_module(void);
void			rpc_destroy_generic_auth(void);
void 			rpc_destroy_authunix(void);

struct rpc_cred *	rpc_lookup_cred(void);
struct rpc_cred *	rpc_lookup_machine_cred(const char *service_name);
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_generic_bind_cred(struct rpc_task *, struct rpc_cred *, int);
void			put_rpccred(struct rpc_cred *);
__be32 *		rpcauth_marshcred(struct rpc_task *, __be32 *);
__be32 *		rpcauth_checkverf(struct rpc_task *, __be32 *);
int			rpcauth_wrap_req(struct rpc_task *task, kxdreproc_t encode, void *rqstp, __be32 *data, void *obj);
int			rpcauth_unwrap_resp(struct rpc_task *task, kxdrdproc_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 *);
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
60063497	18	#include <linux/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;
68c97153	29	const char *principal;
7c67db3a	30	unsigned char machine_cred : 1;
1da177e4 LT	31	};
	32
	33	/*
	34	* Client user credentials
	35	*/
4a8c1344 TM	36	struct rpc_auth;
4a8c1344 TM	37	struct rpc_credops;
1da177e4 LT	38	struct rpc_cred {
1da177e4 LT	39	struct hlist_node cr_hash; /* hash chain */
e092bdcd	40	struct list_head cr_lru; /* lru garbage collection */
31be5bf1	41	struct rcu_head cr_rcu;
4a8c1344	42	struct rpc_auth * cr_auth;
f1c0a861	43	const struct rpc_credops *cr_ops;
1da177e4 LT	44	#ifdef RPC_DEBUG
	45	unsigned long cr_magic; /* 0x0f4aa4f0 */
	46	#endif
fc432dd9 TM	47	unsigned long cr_expire; /* when to gc */
	48	unsigned long cr_flags; /* various flags */
	49	atomic_t cr_count; /* ref count */
1da177e4 LT	50
	51	uid_t cr_uid;
	52
	53	/* per-flavor data */
	54	};
fc432dd9 TM	55	#define RPCAUTH_CRED_NEW 0
fc432dd9 TM	56	#define RPCAUTH_CRED_UPTODATE 1
31be5bf1	57	#define RPCAUTH_CRED_HASHED 2
126e216a	58	#define RPCAUTH_CRED_NEGATIVE 3
1da177e4 LT	59
	60	#define RPCAUTH_CRED_MAGIC 0x0f4aa4f0
	61
	62	/*
	63	* Client authentication handle
	64	*/
241269bd	65	struct rpc_cred_cache;
4a8c1344	66	struct rpc_authops;
1da177e4 LT	67	struct rpc_auth {
1da177e4 LT	68	unsigned int au_cslack; /* call cred size estimate */
24b2605b BF	69	/* guess at number of u32's auth adds before
	70	* reply data; normally the verifier size: */
	71	unsigned int au_rslack;
	72	/* for gss, used to calculate au_rslack: */
	73	unsigned int au_verfsize;
	74
1da177e4	75	unsigned int au_flags; /* various flags */
f1c0a861	76	const struct rpc_authops au_ops; / operations */
1da177e4 LT	77	rpc_authflavor_t au_flavor; /* pseudoflavor (note may
	78	* differ from the flavor in
	79	* au_ops->au_flavor in gss
	80	* case) */
	81	atomic_t au_count; /* Reference counter */
	82
	83	struct rpc_cred_cache * au_credcache;
	84	/* per-flavor data */
	85	};
1da177e4	86
8a317760 TM	87	/* Flags for rpcauth_lookupcred() */
8a317760 TM	88	#define RPCAUTH_LOOKUP_NEW 0x01 /* Accept an uninitialised cred */
8a317760	89
1da177e4 LT	90	/*
	91	* Client authentication ops
	92	*/
	93	struct rpc_authops {
	94	struct module *owner;
	95	rpc_authflavor_t au_flavor; /* flavor (RPC_AUTH_) /
1da177e4	96	char * au_name;
1da177e4 LT	97	struct rpc_auth * (create)(struct rpc_clnt , rpc_authflavor_t);
	98	void (destroy)(struct rpc_auth );
	99
	100	struct rpc_cred * (lookup_cred)(struct rpc_auth , struct auth_cred *, int);
	101	struct rpc_cred * (crcreate)(struct rpc_auth, struct auth_cred *, int);
	102	};
	103
	104	struct rpc_credops {
	105	const char * cr_name; /* Name of the auth flavour */
fba3bad4	106	int (cr_init)(struct rpc_auth , struct rpc_cred *);
1da177e4 LT	107	void (crdestroy)(struct rpc_cred );
	108
	109	int (crmatch)(struct auth_cred , struct rpc_cred *, int);
8572b8e2	110	struct rpc_cred * (crbind)(struct rpc_task , struct rpc_cred *, int);
d8ed029d	111	__be32 * (crmarshal)(struct rpc_task , __be32 *);
1da177e4	112	int (crrefresh)(struct rpc_task );
d8ed029d	113	__be32 * (crvalidate)(struct rpc_task , __be32 *);
9f06c719	114	int (crwrap_req)(struct rpc_task , kxdreproc_t,
d8ed029d	115	void , __be32 , void *);
bf269551	116	int (crunwrap_resp)(struct rpc_task , kxdrdproc_t,
d8ed029d	117	void , __be32 , void *);
1da177e4 LT	118	};
1da177e4 LT	119
f1c0a861 TM	120	extern const struct rpc_authops authunix_ops;
f1c0a861 TM	121	extern const struct rpc_authops authnull_ops;
1da177e4	122
5d8d9a4d TM	123	int __init rpc_init_authunix(void);
	124	int __init rpc_init_generic_auth(void);
	125	int __init rpcauth_init_module(void);
c135e84a SR	126	void rpcauth_remove_module(void);
c135e84a SR	127	void rpc_destroy_generic_auth(void);
5d8d9a4d	128	void rpc_destroy_authunix(void);
9499b434	129
9a559efd	130	struct rpc_cred * rpc_lookup_cred(void);
68c97153	131	struct rpc_cred * rpc_lookup_machine_cred(const char *service_name);
f1c0a861 TM	132	int rpcauth_register(const struct rpc_authops *);
f1c0a861 TM	133	int rpcauth_unregister(const struct rpc_authops *);
1da177e4	134	struct rpc_auth * rpcauth_create(rpc_authflavor_t, struct rpc_clnt *);
de7a8ce3	135	void rpcauth_release(struct rpc_auth *);
1da177e4	136	struct rpc_cred * rpcauth_lookup_credcache(struct rpc_auth , struct auth_cred , int);
5fe4755e	137	void rpcauth_init_cred(struct rpc_cred , const struct auth_cred , struct rpc_auth , const struct rpc_credops );
1da177e4	138	struct rpc_cred * rpcauth_lookupcred(struct rpc_auth *, int);
8572b8e2	139	struct rpc_cred * rpcauth_generic_bind_cred(struct rpc_task , struct rpc_cred , int);
1da177e4	140	void put_rpccred(struct rpc_cred *);
d8ed029d AD	141	__be32 * rpcauth_marshcred(struct rpc_task , __be32 );
d8ed029d AD	142	__be32 * rpcauth_checkverf(struct rpc_task , __be32 );
9f06c719	143	int rpcauth_wrap_req(struct rpc_task task, kxdreproc_t encode, void rqstp, __be32 data, void obj);
bf269551	144	int rpcauth_unwrap_resp(struct rpc_task task, kxdrdproc_t decode, void rqstp, __be32 data, void obj);
1da177e4 LT	145	int rpcauth_refreshcred(struct rpc_task *);
	146	void rpcauth_invalcred(struct rpc_task *);
	147	int rpcauth_uptodatecred(struct rpc_task *);
f5c2187c	148	int rpcauth_init_credcache(struct rpc_auth *);
3ab9bb72 TM	149	void rpcauth_destroy_credcache(struct rpc_auth *);
3ab9bb72 TM	150	void rpcauth_clear_credcache(struct rpc_cred_cache *);
1da177e4 LT	151
	152	static inline
	153	struct rpc_cred * get_rpccred(struct rpc_cred *cred)
	154	{
	155	atomic_inc(&cred->cr_count);
	156	return cred;
	157	}
	158
	159	#endif /* __KERNEL__ */
	160	#endif /* _LINUX_SUNRPC_AUTH_H */