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