[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 <linux/atomic.h>
#include <linux/rcupdate.h>
#include <linux/uidgid.h>

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

struct rpcsec_gss_info;

/* auth_cred ac_flags bits */
enum {
	RPC_CRED_NO_CRKEY_TIMEOUT = 0, /* underlying cred has no key timeout */
	RPC_CRED_KEY_EXPIRE_SOON = 1, /* underlying cred key will expire soon */
	RPC_CRED_NOTIFY_TIMEOUT = 2,   /* nofity generic cred when underlying
					key will expire soon */
};

/* Work around the lack of a VFS credential */
struct auth_cred {
	kuid_t	uid;
	kgid_t	gid;
	struct group_info *group_info;
	const char *principal;
	unsigned long ac_flags;
	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 */

	kuid_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 */
};

struct rpc_auth_create_args {
	rpc_authflavor_t pseudoflavor;
	const char *target_name;
};

/* 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_auth_create_args *, struct rpc_clnt *);
	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);
	int			(*list_pseudoflavors)(rpc_authflavor_t *, int);
	rpc_authflavor_t	(*info2flavor)(struct rpcsec_gss_info *);
	int			(*flavor2info)(rpc_authflavor_t,
						struct rpcsec_gss_info *);
	int			(*key_timeout)(struct rpc_auth *,
						struct rpc_cred *);
};

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 *);
	int			(*crkey_timeout)(struct rpc_cred *);
	bool			(*crkey_to_expire)(struct rpc_cred *);
};

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(struct rpc_auth_create_args *,
				struct rpc_clnt *);
void			rpcauth_release(struct rpc_auth *);
rpc_authflavor_t	rpcauth_get_pseudoflavor(rpc_authflavor_t,
				struct rpcsec_gss_info *);
int			rpcauth_get_gssinfo(rpc_authflavor_t,
				struct rpcsec_gss_info *);
int			rpcauth_list_flavors(rpc_authflavor_t *, int);
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 *);
int			rpcauth_key_timeout_notify(struct rpc_auth *,
						struct rpc_cred *);
bool			rpcauth_cred_key_to_expire(struct rpc_cred *);

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>
7eaf040b	20	#include <linux/uidgid.h>
1da177e4 LT	21
	22	/* size of the nodename buffer */
	23	#define UNX_MAXNODENAME 32
	24
9568c5e9 CL	25	struct rpcsec_gss_info;
9568c5e9 CL	26
4de6caa2 AA	27	/* auth_cred ac_flags bits */
	28	enum {
	29	RPC_CRED_NO_CRKEY_TIMEOUT = 0, /* underlying cred has no key timeout */
	30	RPC_CRED_KEY_EXPIRE_SOON = 1, /* underlying cred key will expire soon */
	31	RPC_CRED_NOTIFY_TIMEOUT = 2, /* nofity generic cred when underlying
	32	key will expire soon */
	33	};
	34
1da177e4 LT	35	/* Work around the lack of a VFS credential */
1da177e4 LT	36	struct auth_cred {
7eaf040b EB	37	kuid_t uid;
7eaf040b EB	38	kgid_t gid;
1da177e4	39	struct group_info *group_info;
68c97153	40	const char *principal;
4de6caa2	41	unsigned long ac_flags;
7c67db3a	42	unsigned char machine_cred : 1;
1da177e4 LT	43	};
	44
	45	/*
	46	* Client user credentials
	47	*/
4a8c1344 TM	48	struct rpc_auth;
4a8c1344 TM	49	struct rpc_credops;
1da177e4 LT	50	struct rpc_cred {
1da177e4 LT	51	struct hlist_node cr_hash; /* hash chain */
e092bdcd	52	struct list_head cr_lru; /* lru garbage collection */
31be5bf1	53	struct rcu_head cr_rcu;
4a8c1344	54	struct rpc_auth * cr_auth;
f1c0a861	55	const struct rpc_credops *cr_ops;
1da177e4 LT	56	#ifdef RPC_DEBUG
	57	unsigned long cr_magic; /* 0x0f4aa4f0 */
	58	#endif
fc432dd9 TM	59	unsigned long cr_expire; /* when to gc */
	60	unsigned long cr_flags; /* various flags */
	61	atomic_t cr_count; /* ref count */
1da177e4	62
7eaf040b	63	kuid_t cr_uid;
1da177e4 LT	64
	65	/* per-flavor data */
	66	};
fc432dd9 TM	67	#define RPCAUTH_CRED_NEW 0
fc432dd9 TM	68	#define RPCAUTH_CRED_UPTODATE 1
31be5bf1	69	#define RPCAUTH_CRED_HASHED 2
126e216a	70	#define RPCAUTH_CRED_NEGATIVE 3
1da177e4 LT	71
	72	#define RPCAUTH_CRED_MAGIC 0x0f4aa4f0
	73
	74	/*
	75	* Client authentication handle
	76	*/
241269bd	77	struct rpc_cred_cache;
4a8c1344	78	struct rpc_authops;
1da177e4 LT	79	struct rpc_auth {
1da177e4 LT	80	unsigned int au_cslack; /* call cred size estimate */
24b2605b BF	81	/* guess at number of u32's auth adds before
	82	* reply data; normally the verifier size: */
	83	unsigned int au_rslack;
	84	/* for gss, used to calculate au_rslack: */
	85	unsigned int au_verfsize;
	86
1da177e4	87	unsigned int au_flags; /* various flags */
f1c0a861	88	const struct rpc_authops au_ops; / operations */
1da177e4 LT	89	rpc_authflavor_t au_flavor; /* pseudoflavor (note may
	90	* differ from the flavor in
	91	* au_ops->au_flavor in gss
	92	* case) */
	93	atomic_t au_count; /* Reference counter */
	94
	95	struct rpc_cred_cache * au_credcache;
	96	/* per-flavor data */
	97	};
1da177e4	98
c2190661 TM	99	struct rpc_auth_create_args {
	100	rpc_authflavor_t pseudoflavor;
	101	const char *target_name;
	102	};
	103
8a317760 TM	104	/* Flags for rpcauth_lookupcred() */
8a317760 TM	105	#define RPCAUTH_LOOKUP_NEW 0x01 /* Accept an uninitialised cred */
8a317760	106
1da177e4 LT	107	/*
	108	* Client authentication ops
	109	*/
	110	struct rpc_authops {
	111	struct module *owner;
	112	rpc_authflavor_t au_flavor; /* flavor (RPC_AUTH_) /
1da177e4	113	char * au_name;
c2190661	114	struct rpc_auth * (create)(struct rpc_auth_create_args , struct rpc_clnt *);
1da177e4 LT	115	void (destroy)(struct rpc_auth );
	116
	117	struct rpc_cred * (lookup_cred)(struct rpc_auth , struct auth_cred *, int);
	118	struct rpc_cred * (crcreate)(struct rpc_auth, struct auth_cred *, int);
6a1a1e34	119	int (list_pseudoflavors)(rpc_authflavor_t , int);
9568c5e9	120	rpc_authflavor_t (info2flavor)(struct rpcsec_gss_info );
a77c806f CL	121	int (*flavor2info)(rpc_authflavor_t,
a77c806f CL	122	struct rpcsec_gss_info *);
4de6caa2 AA	123	int (key_timeout)(struct rpc_auth ,
4de6caa2 AA	124	struct rpc_cred *);
1da177e4 LT	125	};
	126
	127	struct rpc_credops {
	128	const char * cr_name; /* Name of the auth flavour */
fba3bad4	129	int (cr_init)(struct rpc_auth , struct rpc_cred *);
1da177e4 LT	130	void (crdestroy)(struct rpc_cred );
	131
	132	int (crmatch)(struct auth_cred , struct rpc_cred *, int);
8572b8e2	133	struct rpc_cred * (crbind)(struct rpc_task , struct rpc_cred *, int);
d8ed029d	134	__be32 * (crmarshal)(struct rpc_task , __be32 *);
1da177e4	135	int (crrefresh)(struct rpc_task );
d8ed029d	136	__be32 * (crvalidate)(struct rpc_task , __be32 *);
9f06c719	137	int (crwrap_req)(struct rpc_task , kxdreproc_t,
d8ed029d	138	void , __be32 , void *);
bf269551	139	int (crunwrap_resp)(struct rpc_task , kxdrdproc_t,
d8ed029d	140	void , __be32 , void *);
4de6caa2 AA	141	int (crkey_timeout)(struct rpc_cred );
4de6caa2 AA	142	bool (crkey_to_expire)(struct rpc_cred );
1da177e4 LT	143	};
1da177e4 LT	144
f1c0a861 TM	145	extern const struct rpc_authops authunix_ops;
f1c0a861 TM	146	extern const struct rpc_authops authnull_ops;
1da177e4	147
5d8d9a4d TM	148	int __init rpc_init_authunix(void);
	149	int __init rpc_init_generic_auth(void);
	150	int __init rpcauth_init_module(void);
c135e84a SR	151	void rpcauth_remove_module(void);
c135e84a SR	152	void rpc_destroy_generic_auth(void);
5d8d9a4d	153	void rpc_destroy_authunix(void);
9499b434	154
9a559efd	155	struct rpc_cred * rpc_lookup_cred(void);
68c97153	156	struct rpc_cred * rpc_lookup_machine_cred(const char *service_name);
f1c0a861 TM	157	int rpcauth_register(const struct rpc_authops *);
f1c0a861 TM	158	int rpcauth_unregister(const struct rpc_authops *);
c2190661 TM	159	struct rpc_auth * rpcauth_create(struct rpc_auth_create_args *,
c2190661 TM	160	struct rpc_clnt *);
de7a8ce3	161	void rpcauth_release(struct rpc_auth *);
9568c5e9 CL	162	rpc_authflavor_t rpcauth_get_pseudoflavor(rpc_authflavor_t,
9568c5e9 CL	163	struct rpcsec_gss_info *);
a77c806f CL	164	int rpcauth_get_gssinfo(rpc_authflavor_t,
a77c806f CL	165	struct rpcsec_gss_info *);
6a1a1e34	166	int rpcauth_list_flavors(rpc_authflavor_t *, int);
1da177e4	167	struct rpc_cred * rpcauth_lookup_credcache(struct rpc_auth , struct auth_cred , int);
5fe4755e	168	void rpcauth_init_cred(struct rpc_cred , const struct auth_cred , struct rpc_auth , const struct rpc_credops );
1da177e4	169	struct rpc_cred * rpcauth_lookupcred(struct rpc_auth *, int);
8572b8e2	170	struct rpc_cred * rpcauth_generic_bind_cred(struct rpc_task , struct rpc_cred , int);
1da177e4	171	void put_rpccred(struct rpc_cred *);
d8ed029d AD	172	__be32 * rpcauth_marshcred(struct rpc_task , __be32 );
d8ed029d AD	173	__be32 * rpcauth_checkverf(struct rpc_task , __be32 );
9f06c719	174	int rpcauth_wrap_req(struct rpc_task task, kxdreproc_t encode, void rqstp, __be32 data, void obj);
bf269551	175	int rpcauth_unwrap_resp(struct rpc_task task, kxdrdproc_t decode, void rqstp, __be32 data, void obj);
1da177e4 LT	176	int rpcauth_refreshcred(struct rpc_task *);
	177	void rpcauth_invalcred(struct rpc_task *);
	178	int rpcauth_uptodatecred(struct rpc_task *);
f5c2187c	179	int rpcauth_init_credcache(struct rpc_auth *);
3ab9bb72 TM	180	void rpcauth_destroy_credcache(struct rpc_auth *);
3ab9bb72 TM	181	void rpcauth_clear_credcache(struct rpc_cred_cache *);
4de6caa2 AA	182	int rpcauth_key_timeout_notify(struct rpc_auth *,
	183	struct rpc_cred *);
	184	bool rpcauth_cred_key_to_expire(struct rpc_cred *);
1da177e4 LT	185
	186	static inline
	187	struct rpc_cred * get_rpccred(struct rpc_cred *cred)
	188	{
	189	atomic_inc(&cred->cr_count);
	190	return cred;
	191	}
	192
	193	#endif /* __KERNEL__ */
	194	#endif /* _LINUX_SUNRPC_AUTH_H */