]>
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> | |
19 | ||
20 | /* size of the nodename buffer */ | |
21 | #define UNX_MAXNODENAME 32 | |
22 | ||
1da177e4 LT |
23 | /* Work around the lack of a VFS credential */ |
24 | struct auth_cred { | |
25 | uid_t uid; | |
26 | gid_t gid; | |
27 | struct group_info *group_info; | |
28 | }; | |
29 | ||
30 | /* | |
31 | * Client user credentials | |
32 | */ | |
4a8c1344 TM |
33 | struct rpc_auth; |
34 | struct rpc_credops; | |
1da177e4 LT |
35 | struct rpc_cred { |
36 | struct hlist_node cr_hash; /* hash chain */ | |
4a8c1344 | 37 | struct rpc_auth * cr_auth; |
f1c0a861 | 38 | const struct rpc_credops *cr_ops; |
1da177e4 LT |
39 | #ifdef RPC_DEBUG |
40 | unsigned long cr_magic; /* 0x0f4aa4f0 */ | |
41 | #endif | |
fc432dd9 TM |
42 | unsigned long cr_expire; /* when to gc */ |
43 | unsigned long cr_flags; /* various flags */ | |
44 | atomic_t cr_count; /* ref count */ | |
1da177e4 LT |
45 | |
46 | uid_t cr_uid; | |
47 | ||
48 | /* per-flavor data */ | |
49 | }; | |
fc432dd9 TM |
50 | #define RPCAUTH_CRED_NEW 0 |
51 | #define RPCAUTH_CRED_UPTODATE 1 | |
1da177e4 LT |
52 | |
53 | #define RPCAUTH_CRED_MAGIC 0x0f4aa4f0 | |
54 | ||
55 | /* | |
56 | * Client authentication handle | |
57 | */ | |
58 | #define RPC_CREDCACHE_NR 8 | |
59 | #define RPC_CREDCACHE_MASK (RPC_CREDCACHE_NR - 1) | |
60 | struct rpc_cred_cache { | |
61 | struct hlist_head hashtable[RPC_CREDCACHE_NR]; | |
62 | unsigned long nextgc; /* next garbage collection */ | |
63 | unsigned long expire; /* cache expiry interval */ | |
64 | }; | |
65 | ||
4a8c1344 | 66 | struct rpc_authops; |
1da177e4 LT |
67 | struct rpc_auth { |
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() */ |
88 | #define RPCAUTH_LOOKUP_NEW 0x01 /* Accept an uninitialised cred */ | |
89 | #define RPCAUTH_LOOKUP_ROOTCREDS 0x02 /* This really ought to go! */ | |
90 | ||
1da177e4 LT |
91 | /* |
92 | * Client authentication ops | |
93 | */ | |
94 | struct rpc_authops { | |
95 | struct module *owner; | |
96 | rpc_authflavor_t au_flavor; /* flavor (RPC_AUTH_*) */ | |
97 | #ifdef RPC_DEBUG | |
98 | char * au_name; | |
99 | #endif | |
100 | struct rpc_auth * (*create)(struct rpc_clnt *, rpc_authflavor_t); | |
101 | void (*destroy)(struct rpc_auth *); | |
102 | ||
103 | struct rpc_cred * (*lookup_cred)(struct rpc_auth *, struct auth_cred *, int); | |
104 | struct rpc_cred * (*crcreate)(struct rpc_auth*, struct auth_cred *, int); | |
105 | }; | |
106 | ||
107 | struct rpc_credops { | |
108 | const char * cr_name; /* Name of the auth flavour */ | |
fba3bad4 | 109 | int (*cr_init)(struct rpc_auth *, struct rpc_cred *); |
1da177e4 LT |
110 | void (*crdestroy)(struct rpc_cred *); |
111 | ||
112 | int (*crmatch)(struct auth_cred *, struct rpc_cred *, int); | |
d8ed029d | 113 | __be32 * (*crmarshal)(struct rpc_task *, __be32 *); |
1da177e4 | 114 | int (*crrefresh)(struct rpc_task *); |
d8ed029d | 115 | __be32 * (*crvalidate)(struct rpc_task *, __be32 *); |
1da177e4 | 116 | int (*crwrap_req)(struct rpc_task *, kxdrproc_t, |
d8ed029d | 117 | void *, __be32 *, void *); |
1da177e4 | 118 | int (*crunwrap_resp)(struct rpc_task *, kxdrproc_t, |
d8ed029d | 119 | void *, __be32 *, void *); |
1da177e4 LT |
120 | }; |
121 | ||
f1c0a861 TM |
122 | extern const struct rpc_authops authunix_ops; |
123 | extern const struct rpc_authops authnull_ops; | |
1da177e4 | 124 | |
f1c0a861 TM |
125 | int rpcauth_register(const struct rpc_authops *); |
126 | int rpcauth_unregister(const struct rpc_authops *); | |
1da177e4 | 127 | struct rpc_auth * rpcauth_create(rpc_authflavor_t, struct rpc_clnt *); |
de7a8ce3 | 128 | void rpcauth_release(struct rpc_auth *); |
1da177e4 | 129 | struct rpc_cred * rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int); |
5fe4755e | 130 | void rpcauth_init_cred(struct rpc_cred *, const struct auth_cred *, struct rpc_auth *, const struct rpc_credops *); |
1da177e4 LT |
131 | struct rpc_cred * rpcauth_lookupcred(struct rpc_auth *, int); |
132 | struct rpc_cred * rpcauth_bindcred(struct rpc_task *); | |
133 | void rpcauth_holdcred(struct rpc_task *); | |
134 | void put_rpccred(struct rpc_cred *); | |
135 | void rpcauth_unbindcred(struct rpc_task *); | |
d8ed029d AD |
136 | __be32 * rpcauth_marshcred(struct rpc_task *, __be32 *); |
137 | __be32 * rpcauth_checkverf(struct rpc_task *, __be32 *); | |
138 | int rpcauth_wrap_req(struct rpc_task *task, kxdrproc_t encode, void *rqstp, __be32 *data, void *obj); | |
139 | int rpcauth_unwrap_resp(struct rpc_task *task, kxdrproc_t decode, void *rqstp, __be32 *data, void *obj); | |
1da177e4 LT |
140 | int rpcauth_refreshcred(struct rpc_task *); |
141 | void rpcauth_invalcred(struct rpc_task *); | |
142 | int rpcauth_uptodatecred(struct rpc_task *); | |
143 | int rpcauth_init_credcache(struct rpc_auth *, unsigned long); | |
3ab9bb72 TM |
144 | void rpcauth_destroy_credcache(struct rpc_auth *); |
145 | void rpcauth_clear_credcache(struct rpc_cred_cache *); | |
1da177e4 LT |
146 | |
147 | static inline | |
148 | struct rpc_cred * get_rpccred(struct rpc_cred *cred) | |
149 | { | |
150 | atomic_inc(&cred->cr_count); | |
151 | return cred; | |
152 | } | |
153 | ||
154 | #endif /* __KERNEL__ */ | |
155 | #endif /* _LINUX_SUNRPC_AUTH_H */ |