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