2 * linux/net/sunrpc/auth_unix.c
4 * UNIX-style authentication; no AUTH_SHORT support
6 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
9 #include <linux/types.h>
10 #include <linux/sched.h>
11 #include <linux/module.h>
12 #include <linux/sunrpc/clnt.h>
13 #include <linux/sunrpc/auth.h>
14 #include <linux/vserver/xid.h>
16 #define NFS_NGROUPS 16
19 struct rpc_cred uc_base;
22 gid_t uc_gids[NFS_NGROUPS];
24 #define uc_uid uc_base.cr_uid
25 #define uc_count uc_base.cr_count
26 #define uc_flags uc_base.cr_flags
27 #define uc_expire uc_base.cr_expire
29 #define UNX_CRED_EXPIRE (60 * HZ)
31 #define UNX_WRITESLACK (21 + (UNX_MAXNODENAME >> 2))
34 # define RPCDBG_FACILITY RPCDBG_AUTH
37 static struct rpc_auth unix_auth;
38 static struct rpc_cred_cache unix_cred_cache;
39 static struct rpc_credops unix_credops;
41 static struct rpc_auth *
42 unx_create(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
44 dprintk("RPC: creating UNIX authenticator for client %p\n", clnt);
45 if (atomic_inc_return(&unix_auth.au_count) == 0)
46 unix_cred_cache.nextgc = jiffies + (unix_cred_cache.expire >> 1);
51 unx_destroy(struct rpc_auth *auth)
53 dprintk("RPC: destroying UNIX authenticator %p\n", auth);
54 rpcauth_free_credcache(auth);
58 * Lookup AUTH_UNIX creds for current process
60 static struct rpc_cred *
61 unx_lookup_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
63 return rpcauth_lookup_credcache(auth, acred, flags);
66 static struct rpc_cred *
67 unx_create_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
69 struct unx_cred *cred;
72 dprintk("RPC: allocating UNIX cred for uid %d gid %d\n",
73 acred->uid, acred->gid);
75 if (!(cred = kmalloc(sizeof(*cred), GFP_KERNEL)))
76 return ERR_PTR(-ENOMEM);
78 atomic_set(&cred->uc_count, 1);
79 cred->uc_flags = RPCAUTH_CRED_UPTODATE;
80 if (flags & RPCAUTH_LOOKUP_ROOTCREDS) {
83 cred->uc_xid = vx_current_xid();
84 cred->uc_gids[0] = NOGROUP;
86 int groups = acred->group_info->ngroups;
87 if (groups > NFS_NGROUPS)
90 cred->uc_uid = acred->uid;
91 cred->uc_gid = acred->gid;
92 cred->uc_xid = acred->xid;
93 for (i = 0; i < groups; i++)
94 cred->uc_gids[i] = GROUP_AT(acred->group_info, i);
96 cred->uc_gids[i] = NOGROUP;
98 cred->uc_base.cr_ops = &unix_credops;
100 return (struct rpc_cred *) cred;
104 unx_destroy_cred(struct rpc_cred *cred)
110 * Match credentials against current process creds.
111 * The root_override argument takes care of cases where the caller may
112 * request root creds (e.g. for NFS swapping).
115 unx_match(struct auth_cred *acred, struct rpc_cred *rcred, int flags)
117 struct unx_cred *cred = (struct unx_cred *) rcred;
120 if (!(flags & RPCAUTH_LOOKUP_ROOTCREDS)) {
123 if (cred->uc_uid != acred->uid
124 || cred->uc_gid != acred->gid
125 || cred->uc_xid != acred->xid)
128 groups = acred->group_info->ngroups;
129 if (groups > NFS_NGROUPS)
130 groups = NFS_NGROUPS;
131 for (i = 0; i < groups ; i++)
132 if (cred->uc_gids[i] != GROUP_AT(acred->group_info, i))
136 return (cred->uc_uid == 0
138 && cred->uc_gids[0] == (gid_t) NOGROUP);
142 * Marshal credentials.
143 * Maybe we should keep a cached credential for performance reasons.
146 unx_marshal(struct rpc_task *task, u32 *p)
148 struct rpc_clnt *clnt = task->tk_client;
149 struct unx_cred *cred = (struct unx_cred *) task->tk_msg.rpc_cred;
153 *p++ = htonl(RPC_AUTH_UNIX);
155 *p++ = htonl(jiffies/HZ);
158 * Copy the UTS nodename captured when the client was created.
160 p = xdr_encode_array(p, clnt->cl_nodename, clnt->cl_nodelen);
161 tagxid = task->tk_client->cl_tagxid;
163 *p++ = htonl((u32) XIDINO_UID(tagxid,
164 cred->uc_uid, cred->uc_xid));
165 *p++ = htonl((u32) XIDINO_GID(tagxid,
166 cred->uc_gid, cred->uc_xid));
168 for (i = 0; i < 16 && cred->uc_gids[i] != (gid_t) NOGROUP; i++)
169 *p++ = htonl((u32) cred->uc_gids[i]);
170 *hold = htonl(p - hold - 1); /* gid array length */
171 *base = htonl((p - base - 1) << 2); /* cred length */
173 *p++ = htonl(RPC_AUTH_NULL);
180 * Refresh credentials. This is a no-op for AUTH_UNIX
183 unx_refresh(struct rpc_task *task)
185 task->tk_msg.rpc_cred->cr_flags |= RPCAUTH_CRED_UPTODATE;
190 unx_validate(struct rpc_task *task, u32 *p)
192 rpc_authflavor_t flavor;
195 flavor = ntohl(*p++);
196 if (flavor != RPC_AUTH_NULL &&
197 flavor != RPC_AUTH_UNIX &&
198 flavor != RPC_AUTH_SHORT) {
199 printk("RPC: bad verf flavor: %u\n", flavor);
204 if (size > RPC_MAX_AUTH_SIZE) {
205 printk("RPC: giant verf size: %u\n", size);
208 task->tk_auth->au_rslack = (size >> 2) + 2;
214 struct rpc_authops authunix_ops = {
215 .owner = THIS_MODULE,
216 .au_flavor = RPC_AUTH_UNIX,
220 .create = unx_create,
221 .destroy = unx_destroy,
222 .lookup_cred = unx_lookup_cred,
223 .crcreate = unx_create_cred,
227 struct rpc_cred_cache unix_cred_cache = {
228 .expire = UNX_CRED_EXPIRE,
232 struct rpc_auth unix_auth = {
233 .au_cslack = UNX_WRITESLACK,
234 .au_rslack = 2, /* assume AUTH_NULL verf */
235 .au_ops = &authunix_ops,
236 .au_count = ATOMIC_INIT(0),
237 .au_credcache = &unix_cred_cache,
241 struct rpc_credops unix_credops = {
242 .cr_name = "AUTH_UNIX",
243 .crdestroy = unx_destroy_cred,
244 .crmatch = unx_match,
245 .crmarshal = unx_marshal,
246 .crrefresh = unx_refresh,
247 .crvalidate = unx_validate,