blob: 996df4dac7d47860731ec76537720289593e1f65 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/sunrpc/sched.h>
15#include <linux/sunrpc/msg_prot.h>
16#include <linux/sunrpc/xdr.h>
17
18#include <asm/atomic.h>
Trond Myklebust31be5bf2007-06-24 15:55:26 -040019#include <linux/rcupdate.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21/* size of the nodename buffer */
22#define UNX_MAXNODENAME 32
23
Linus Torvalds1da177e2005-04-16 15:20:36 -070024/* Work around the lack of a VFS credential */
25struct auth_cred {
26 uid_t uid;
27 gid_t gid;
28 struct group_info *group_info;
Trond Myklebust7c67db32008-04-07 20:50:11 -040029 unsigned char machine_cred : 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070030};
31
32/*
33 * Client user credentials
34 */
Trond Myklebust4a8c1342007-06-07 10:14:14 -040035struct rpc_auth;
36struct rpc_credops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070037struct rpc_cred {
38 struct hlist_node cr_hash; /* hash chain */
Trond Myklebuste092bdc2007-06-23 19:45:36 -040039 struct list_head cr_lru; /* lru garbage collection */
Trond Myklebust31be5bf2007-06-24 15:55:26 -040040 struct rcu_head cr_rcu;
Trond Myklebust4a8c1342007-06-07 10:14:14 -040041 struct rpc_auth * cr_auth;
Trond Myklebustf1c0a862007-06-23 20:17:58 -040042 const struct rpc_credops *cr_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070043#ifdef RPC_DEBUG
44 unsigned long cr_magic; /* 0x0f4aa4f0 */
45#endif
Trond Myklebustfc432dd2007-06-25 10:15:15 -040046 unsigned long cr_expire; /* when to gc */
47 unsigned long cr_flags; /* various flags */
48 atomic_t cr_count; /* ref count */
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
50 uid_t cr_uid;
51
52 /* per-flavor data */
53};
Trond Myklebustfc432dd2007-06-25 10:15:15 -040054#define RPCAUTH_CRED_NEW 0
55#define RPCAUTH_CRED_UPTODATE 1
Trond Myklebust31be5bf2007-06-24 15:55:26 -040056#define RPCAUTH_CRED_HASHED 2
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
58#define RPCAUTH_CRED_MAGIC 0x0f4aa4f0
59
60/*
61 * Client authentication handle
62 */
Trond Myklebust25337fd2008-03-12 14:40:14 -040063#define RPC_CREDCACHE_HASHBITS 4
64#define RPC_CREDCACHE_NR (1 << RPC_CREDCACHE_HASHBITS)
Linus Torvalds1da177e2005-04-16 15:20:36 -070065struct rpc_cred_cache {
66 struct hlist_head hashtable[RPC_CREDCACHE_NR];
Trond Myklebust9499b432007-06-24 15:57:57 -040067 spinlock_t lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -070068};
69
Trond Myklebust4a8c1342007-06-07 10:14:14 -040070struct rpc_authops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070071struct rpc_auth {
72 unsigned int au_cslack; /* call cred size estimate */
J. Bruce Fields24b26052005-10-13 16:54:53 -040073 /* 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 unsigned int au_flags; /* various flags */
Trond Myklebustf1c0a862007-06-23 20:17:58 -040080 const struct rpc_authops *au_ops; /* operations */
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 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};
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Trond Myklebust8a317762006-02-01 12:18:36 -050091/* Flags for rpcauth_lookupcred() */
92#define RPCAUTH_LOOKUP_NEW 0x01 /* Accept an uninitialised cred */
Trond Myklebust8a317762006-02-01 12:18:36 -050093
Linus Torvalds1da177e2005-04-16 15:20:36 -070094/*
95 * Client authentication ops
96 */
97struct rpc_authops {
98 struct module *owner;
99 rpc_authflavor_t au_flavor; /* flavor (RPC_AUTH_*) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 char * au_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 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
108struct rpc_credops {
109 const char * cr_name; /* Name of the auth flavour */
Trond Myklebustfba3bad2006-02-01 12:19:27 -0500110 int (*cr_init)(struct rpc_auth *, struct rpc_cred *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 void (*crdestroy)(struct rpc_cred *);
112
113 int (*crmatch)(struct auth_cred *, struct rpc_cred *, int);
Trond Myklebust5d351752009-09-15 13:32:13 -0400114 void (*crbind)(struct rpc_task *, struct rpc_cred *, int);
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700115 __be32 * (*crmarshal)(struct rpc_task *, __be32 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 int (*crrefresh)(struct rpc_task *);
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700117 __be32 * (*crvalidate)(struct rpc_task *, __be32 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 int (*crwrap_req)(struct rpc_task *, kxdrproc_t,
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700119 void *, __be32 *, void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 int (*crunwrap_resp)(struct rpc_task *, kxdrproc_t,
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700121 void *, __be32 *, void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122};
123
Trond Myklebustf1c0a862007-06-23 20:17:58 -0400124extern const struct rpc_authops authunix_ops;
125extern const struct rpc_authops authnull_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
Trond Myklebust9499b432007-06-24 15:57:57 -0400127void __init rpc_init_authunix(void);
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400128void __init rpc_init_generic_auth(void);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400129void __init rpcauth_init_module(void);
130void __exit rpcauth_remove_module(void);
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400131void __exit rpc_destroy_generic_auth(void);
Trond Myklebust9499b432007-06-24 15:57:57 -0400132
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400133struct rpc_cred * rpc_lookup_cred(void);
Trond Myklebust7c67db32008-04-07 20:50:11 -0400134struct rpc_cred * rpc_lookup_machine_cred(void);
Trond Myklebustf1c0a862007-06-23 20:17:58 -0400135int rpcauth_register(const struct rpc_authops *);
136int rpcauth_unregister(const struct rpc_authops *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137struct rpc_auth * rpcauth_create(rpc_authflavor_t, struct rpc_clnt *);
Trond Myklebustde7a8ce2007-06-23 10:46:47 -0400138void rpcauth_release(struct rpc_auth *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139struct rpc_cred * rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int);
Trond Myklebust5fe47552007-06-23 19:55:31 -0400140void rpcauth_init_cred(struct rpc_cred *, const struct auth_cred *, struct rpc_auth *, const struct rpc_credops *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141struct rpc_cred * rpcauth_lookupcred(struct rpc_auth *, int);
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400142void rpcauth_bindcred(struct rpc_task *, struct rpc_cred *, int);
Trond Myklebust5d351752009-09-15 13:32:13 -0400143void rpcauth_generic_bind_cred(struct rpc_task *, struct rpc_cred *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144void put_rpccred(struct rpc_cred *);
145void rpcauth_unbindcred(struct rpc_task *);
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700146__be32 * rpcauth_marshcred(struct rpc_task *, __be32 *);
147__be32 * rpcauth_checkverf(struct rpc_task *, __be32 *);
148int rpcauth_wrap_req(struct rpc_task *task, kxdrproc_t encode, void *rqstp, __be32 *data, void *obj);
149int rpcauth_unwrap_resp(struct rpc_task *task, kxdrproc_t decode, void *rqstp, __be32 *data, void *obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150int rpcauth_refreshcred(struct rpc_task *);
151void rpcauth_invalcred(struct rpc_task *);
152int rpcauth_uptodatecred(struct rpc_task *);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400153int rpcauth_init_credcache(struct rpc_auth *);
Trond Myklebust3ab9bb72007-06-09 15:41:42 -0400154void rpcauth_destroy_credcache(struct rpc_auth *);
155void rpcauth_clear_credcache(struct rpc_cred_cache *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
157static inline
158struct rpc_cred * get_rpccred(struct rpc_cred *cred)
159{
160 atomic_inc(&cred->cr_count);
161 return cred;
162}
163
164#endif /* __KERNEL__ */
165#endif /* _LINUX_SUNRPC_AUTH_H */