[linux-2.6-block.git] / include / linux / sunrpc / auth.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * 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

#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>
#include <linux/utsname.h>

/*
 * Maximum size of AUTH_NONE authentication information, in XDR words.
 */
#define NUL_CALLSLACK	(4)
#define NUL_REPLYSLACK	(2)

/*
 * Size of the nodename buffer. RFC1831 specifies a hard limit of 255 bytes,
 * but Linux hostnames are actually limited to __NEW_UTS_LEN bytes.
 */
#define UNX_MAXNODENAME	__NEW_UTS_LEN
#define UNX_CALLSLACK	(21 + XDR_QUADLEN(UNX_MAXNODENAME))
#define UNX_NGROUPS	16

struct rpcsec_gss_info;

struct auth_cred {
	const struct cred *cred;
	const char *principal;	/* If present, this is a machine credential */
};

/*
 * 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;
	unsigned long		cr_expire;	/* when to gc */
	unsigned long		cr_flags;	/* various flags */
	refcount_t		cr_count;	/* ref count */
	const struct cred	*cr_cred;

	/* per-flavor data */
};
#define RPCAUTH_CRED_NEW	0
#define RPCAUTH_CRED_UPTODATE	1
#define RPCAUTH_CRED_HASHED	2
#define RPCAUTH_CRED_NEGATIVE	3

const struct cred *rpc_machine_cred(void);

/*
 * Client authentication handle
 */
struct rpc_cred_cache;
struct rpc_authops;
struct rpc_auth {
	unsigned int		au_cslack;	/* call cred size estimate */
	unsigned int		au_rslack;	/* reply cred size estimate */
	unsigned int		au_verfsize;	/* size of reply verifier */
	unsigned int		au_ralign;	/* words before UL header */

	unsigned long		au_flags;
	const struct rpc_authops *au_ops;
	rpc_authflavor_t	au_flavor;	/* pseudoflavor (note may
						 * differ from the flavor in
						 * au_ops->au_flavor in gss
						 * case) */
	refcount_t		au_count;	/* Reference counter */

	struct rpc_cred_cache *	au_credcache;
	/* per-flavor data */
};

/* rpc_auth au_flags */
#define RPCAUTH_AUTH_DATATOUCH		(1)
#define RPCAUTH_AUTH_UPDATE_SLACK	(2)

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 */
#define RPCAUTH_LOOKUP_ASYNC		0x02	/* Don't block waiting for memory */

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

	int			(*hash_cred)(struct auth_cred *, unsigned int);
	struct rpc_cred *	(*lookup_cred)(struct rpc_auth *, struct auth_cred *, int);
	struct rpc_cred *	(*crcreate)(struct rpc_auth*, struct auth_cred *, int, gfp_t);
	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 *);
	int			(*ping)(struct rpc_clnt *clnt);
};

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);
	int			(*crmarshal)(struct rpc_task *task,
					     struct xdr_stream *xdr);
	int			(*crrefresh)(struct rpc_task *);
	int			(*crvalidate)(struct rpc_task *task,
					      struct xdr_stream *xdr);
	int			(*crwrap_req)(struct rpc_task *task,
					      struct xdr_stream *xdr);
	int			(*crunwrap_resp)(struct rpc_task *task,
						 struct xdr_stream *xdr);
	int			(*crkey_timeout)(struct rpc_cred *);
	char *			(*crstringify_acceptor)(struct rpc_cred *);
	bool			(*crneed_reencode)(struct rpc_task *);
};

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

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

int			rpcauth_register(const struct rpc_authops *);
int			rpcauth_unregister(const struct rpc_authops *);
struct rpc_auth *	rpcauth_create(const 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 *);
struct rpc_cred *	rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int, gfp_t);
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);
void			put_rpccred(struct rpc_cred *);
int			rpcauth_marshcred(struct rpc_task *task,
					  struct xdr_stream *xdr);
int			rpcauth_checkverf(struct rpc_task *task,
					  struct xdr_stream *xdr);
int			rpcauth_wrap_req_encode(struct rpc_task *task,
						struct xdr_stream *xdr);
int			rpcauth_wrap_req(struct rpc_task *task,
					 struct xdr_stream *xdr);
int			rpcauth_unwrap_resp_decode(struct rpc_task *task,
						   struct xdr_stream *xdr);
int			rpcauth_unwrap_resp(struct rpc_task *task,
					    struct xdr_stream *xdr);
bool			rpcauth_xmit_need_reencode(struct rpc_task *task);
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 *);
char *			rpcauth_stringify_acceptor(struct rpc_cred *);

static inline
struct rpc_cred *get_rpccred(struct rpc_cred *cred)
{
	if (cred != NULL && refcount_inc_not_zero(&cred->cr_count))
		return cred;
	return NULL;
}

#endif /* _LINUX_SUNRPC_AUTH_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	/*
	3	* linux/include/linux/sunrpc/auth.h
	4	*
	5	* Declarations for the RPC client authentication machinery.
	6	*
	7	* Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
	8	*/
	9
	10	#ifndef _LINUX_SUNRPC_AUTH_H
	11	#define _LINUX_SUNRPC_AUTH_H
	12
1da177e4 LT	13	#include <linux/sunrpc/sched.h>
	14	#include <linux/sunrpc/msg_prot.h>
	15	#include <linux/sunrpc/xdr.h>
	16
60063497	17	#include <linux/atomic.h>
31be5bf1	18	#include <linux/rcupdate.h>
7eaf040b	19	#include <linux/uidgid.h>
24a9a961	20	#include <linux/utsname.h>
1da177e4	21
4500632f CL	22	/*
	23	* Maximum size of AUTH_NONE authentication information, in XDR words.
	24	*/
	25	#define NUL_CALLSLACK (4)
	26	#define NUL_REPLYSLACK (2)
	27
24a9a961 JL	28	/*
	29	* Size of the nodename buffer. RFC1831 specifies a hard limit of 255 bytes,
	30	* but Linux hostnames are actually limited to __NEW_UTS_LEN bytes.
	31	*/
	32	#define UNX_MAXNODENAME __NEW_UTS_LEN
4500632f	33	#define UNX_CALLSLACK (21 + XDR_QUADLEN(UNX_MAXNODENAME))
5786461b	34	#define UNX_NGROUPS 16
1da177e4	35
9568c5e9 CL	36	struct rpcsec_gss_info;
9568c5e9 CL	37
1da177e4	38	struct auth_cred {
97f68c6b	39	const struct cred *cred;
1a80810f	40	const char principal; / If present, this is a machine credential */
1da177e4 LT	41	};
	42
	43	/*
	44	* Client user credentials
	45	*/
4a8c1344 TM	46	struct rpc_auth;
4a8c1344 TM	47	struct rpc_credops;
1da177e4 LT	48	struct rpc_cred {
1da177e4 LT	49	struct hlist_node cr_hash; /* hash chain */
e092bdcd	50	struct list_head cr_lru; /* lru garbage collection */
31be5bf1	51	struct rcu_head cr_rcu;
4a8c1344	52	struct rpc_auth * cr_auth;
f1c0a861	53	const struct rpc_credops *cr_ops;
fc432dd9 TM	54	unsigned long cr_expire; /* when to gc */
fc432dd9 TM	55	unsigned long cr_flags; /* various flags */
79b18181	56	refcount_t cr_count; /* ref count */
97f68c6b	57	const struct cred *cr_cred;
1da177e4	58
1da177e4 LT	59	/* per-flavor data */
1da177e4 LT	60	};
fc432dd9 TM	61	#define RPCAUTH_CRED_NEW 0
fc432dd9 TM	62	#define RPCAUTH_CRED_UPTODATE 1
31be5bf1	63	#define RPCAUTH_CRED_HASHED 2
126e216a	64	#define RPCAUTH_CRED_NEGATIVE 3
1da177e4	65
a52458b4	66	const struct cred *rpc_machine_cred(void);
5e16923b	67
1da177e4 LT	68	/*
	69	* Client authentication handle
	70	*/
241269bd	71	struct rpc_cred_cache;
4a8c1344	72	struct rpc_authops;
1da177e4 LT	73	struct rpc_auth {
1da177e4 LT	74	unsigned int au_cslack; /* call cred size estimate */
35e77d21	75	unsigned int au_rslack; /* reply cred size estimate */
a00275ba	76	unsigned int au_verfsize; /* size of reply verifier */
35e77d21	77	unsigned int au_ralign; /* words before UL header */
24b2605b	78
53bc19f1	79	unsigned long au_flags;
35e77d21	80	const struct rpc_authops *au_ops;
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) */
331bc71c	85	refcount_t au_count; /* Reference counter */
1da177e4 LT	86
	87	struct rpc_cred_cache * au_credcache;
	88	/* per-flavor data */
	89	};
1da177e4	90
65b80179	91	/* rpc_auth au_flags */
53bc19f1 CL	92	#define RPCAUTH_AUTH_DATATOUCH (1)
53bc19f1 CL	93	#define RPCAUTH_AUTH_UPDATE_SLACK (2)
65b80179	94
c2190661 TM	95	struct rpc_auth_create_args {
	96	rpc_authflavor_t pseudoflavor;
	97	const char *target_name;
	98	};
	99
8a317760 TM	100	/* Flags for rpcauth_lookupcred() */
8a317760 TM	101	#define RPCAUTH_LOOKUP_NEW 0x01 /* Accept an uninitialised cred */
a41b05ed	102	#define RPCAUTH_LOOKUP_ASYNC 0x02 /* Don't block waiting for memory */
8a317760	103
1da177e4 LT	104	/*
	105	* Client authentication ops
	106	*/
	107	struct rpc_authops {
	108	struct module *owner;
	109	rpc_authflavor_t au_flavor; /* flavor (RPC_AUTH_) /
1da177e4	110	char * au_name;
82b98ca5 SD	111	struct rpc_auth * (create)(const struct rpc_auth_create_args ,
82b98ca5 SD	112	struct rpc_clnt *);
1da177e4 LT	113	void (destroy)(struct rpc_auth );
1da177e4 LT	114
e856a231	115	int (hash_cred)(struct auth_cred , unsigned int);
1da177e4	116	struct rpc_cred * (lookup_cred)(struct rpc_auth , struct auth_cred *, int);
3c6e0bc8	117	struct rpc_cred * (crcreate)(struct rpc_auth, struct auth_cred *, int, gfp_t);
9568c5e9	118	rpc_authflavor_t (info2flavor)(struct rpcsec_gss_info );
a77c806f CL	119	int (*flavor2info)(rpc_authflavor_t,
a77c806f CL	120	struct rpcsec_gss_info *);
4de6caa2 AA	121	int (key_timeout)(struct rpc_auth ,
4de6caa2 AA	122	struct rpc_cred *);
12072652	123	int (ping)(struct rpc_clnt clnt);
1da177e4 LT	124	};
	125
	126	struct rpc_credops {
	127	const char * cr_name; /* Name of the auth flavour */
fba3bad4	128	int (cr_init)(struct rpc_auth , struct rpc_cred *);
1da177e4 LT	129	void (crdestroy)(struct rpc_cred );
	130
	131	int (crmatch)(struct auth_cred , struct rpc_cred *, int);
e8680a24 CL	132	int (crmarshal)(struct rpc_task task,
e8680a24 CL	133	struct xdr_stream *xdr);
1da177e4	134	int (crrefresh)(struct rpc_task );
a0584ee9 CL	135	int (crvalidate)(struct rpc_task task,
a0584ee9 CL	136	struct xdr_stream *xdr);
e8680a24 CL	137	int (crwrap_req)(struct rpc_task task,
e8680a24 CL	138	struct xdr_stream *xdr);
a0584ee9 CL	139	int (crunwrap_resp)(struct rpc_task task,
a0584ee9 CL	140	struct xdr_stream *xdr);
4de6caa2	141	int (crkey_timeout)(struct rpc_cred );
a0337d1d	142	char * (crstringify_acceptor)(struct rpc_cred );
3021a5bb	143	bool (crneed_reencode)(struct rpc_task );
1da177e4 LT	144	};
1da177e4 LT	145
f1c0a861 TM	146	extern const struct rpc_authops authunix_ops;
f1c0a861 TM	147	extern const struct rpc_authops authnull_ops;
12072652	148	extern const struct rpc_authops authtls_ops;
1da177e4	149
5d8d9a4d	150	int __init rpc_init_authunix(void);
5d8d9a4d	151	int __init rpcauth_init_module(void);
c135e84a	152	void rpcauth_remove_module(void);
5d8d9a4d	153	void rpc_destroy_authunix(void);
9499b434	154
f1c0a861 TM	155	int rpcauth_register(const struct rpc_authops *);
f1c0a861 TM	156	int rpcauth_unregister(const struct rpc_authops *);
82b98ca5	157	struct rpc_auth * rpcauth_create(const struct rpc_auth_create_args *,
c2190661	158	struct rpc_clnt *);
de7a8ce3	159	void rpcauth_release(struct rpc_auth *);
9568c5e9 CL	160	rpc_authflavor_t rpcauth_get_pseudoflavor(rpc_authflavor_t,
9568c5e9 CL	161	struct rpcsec_gss_info *);
a77c806f CL	162	int rpcauth_get_gssinfo(rpc_authflavor_t,
a77c806f CL	163	struct rpcsec_gss_info *);
3c6e0bc8	164	struct rpc_cred * rpcauth_lookup_credcache(struct rpc_auth , struct auth_cred , int, gfp_t);
5fe4755e	165	void rpcauth_init_cred(struct rpc_cred , const struct auth_cred , struct rpc_auth , const struct rpc_credops );
1da177e4	166	struct rpc_cred * rpcauth_lookupcred(struct rpc_auth *, int);
1da177e4	167	void put_rpccred(struct rpc_cred *);
e8680a24 CL	168	int rpcauth_marshcred(struct rpc_task *task,
e8680a24 CL	169	struct xdr_stream *xdr);
a0584ee9 CL	170	int rpcauth_checkverf(struct rpc_task *task,
a0584ee9 CL	171	struct xdr_stream *xdr);
e8680a24 CL	172	int rpcauth_wrap_req_encode(struct rpc_task *task,
	173	struct xdr_stream *xdr);
	174	int rpcauth_wrap_req(struct rpc_task *task,
	175	struct xdr_stream *xdr);
a0584ee9 CL	176	int rpcauth_unwrap_resp_decode(struct rpc_task *task,
	177	struct xdr_stream *xdr);
	178	int rpcauth_unwrap_resp(struct rpc_task *task,
	179	struct xdr_stream *xdr);
3021a5bb	180	bool rpcauth_xmit_need_reencode(struct rpc_task *task);
1da177e4 LT	181	int rpcauth_refreshcred(struct rpc_task *);
	182	void rpcauth_invalcred(struct rpc_task *);
	183	int rpcauth_uptodatecred(struct rpc_task *);
f5c2187c	184	int rpcauth_init_credcache(struct rpc_auth *);
3ab9bb72 TM	185	void rpcauth_destroy_credcache(struct rpc_auth *);
3ab9bb72 TM	186	void rpcauth_clear_credcache(struct rpc_cred_cache *);
a0337d1d	187	char * rpcauth_stringify_acceptor(struct rpc_cred *);
1da177e4 LT	188
1da177e4 LT	189	static inline
07d02a67	190	struct rpc_cred get_rpccred(struct rpc_cred cred)
1da177e4	191	{
79b18181	192	if (cred != NULL && refcount_inc_not_zero(&cred->cr_count))
07d02a67 TM	193	return cred;
07d02a67 TM	194	return NULL;
1da177e4 LT	195	}
1da177e4 LT	196
1da177e4	197	#endif /* _LINUX_SUNRPC_AUTH_H */