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/socket.h>
14 #include <linux/sunrpc/clnt.h>
15 #include <linux/sunrpc/auth.h>
17 #define NFS_NGROUPS 16
20 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 = (struct unx_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 & RPC_TASK_ROOTCREDS) {
83 cred->uc_gids[0] = NOGROUP;
85 int groups = acred->group_info->ngroups;
86 if (groups > NFS_NGROUPS)
89 cred->uc_uid = acred->uid;
90 cred->uc_gid = acred->gid;
91 for (i = 0; i < groups; i++)
92 cred->uc_gids[i] = GROUP_AT(acred->group_info, i);
94 cred->uc_gids[i] = NOGROUP;
96 cred->uc_base.cr_ops = &unix_credops;
98 return (struct rpc_cred *) cred;
102 unx_destroy_cred(struct rpc_cred *cred)
108 * Match credentials against current process creds.
109 * The root_override argument takes care of cases where the caller may
110 * request root creds (e.g. for NFS swapping).
113 unx_match(struct auth_cred *acred, struct rpc_cred *rcred, int taskflags)
115 struct unx_cred *cred = (struct unx_cred *) rcred;
118 if (!(taskflags & RPC_TASK_ROOTCREDS)) {
121 if (cred->uc_uid != acred->uid
122 || cred->uc_gid != acred->gid)
125 groups = acred->group_info->ngroups;
126 if (groups > NFS_NGROUPS)
127 groups = NFS_NGROUPS;
128 for (i = 0; i < groups ; i++)
129 if (cred->uc_gids[i] != GROUP_AT(acred->group_info, i))
133 return (cred->uc_uid == 0
135 && cred->uc_gids[0] == (gid_t) NOGROUP);
139 * Marshal credentials.
140 * Maybe we should keep a cached credential for performance reasons.
143 unx_marshal(struct rpc_task *task, u32 *p)
145 struct rpc_clnt *clnt = task->tk_client;
146 struct unx_cred *cred = (struct unx_cred *) task->tk_msg.rpc_cred;
150 *p++ = htonl(RPC_AUTH_UNIX);
152 *p++ = htonl(jiffies/HZ);
155 * Copy the UTS nodename captured when the client was created.
157 p = xdr_encode_array(p, clnt->cl_nodename, clnt->cl_nodelen);
159 *p++ = htonl((u32) cred->uc_uid);
160 *p++ = htonl((u32) cred->uc_gid);
162 for (i = 0; i < 16 && cred->uc_gids[i] != (gid_t) NOGROUP; i++)
163 *p++ = htonl((u32) cred->uc_gids[i]);
164 *hold = htonl(p - hold - 1); /* gid array length */
165 *base = htonl((p - base - 1) << 2); /* cred length */
167 *p++ = htonl(RPC_AUTH_NULL);
174 * Refresh credentials. This is a no-op for AUTH_UNIX
177 unx_refresh(struct rpc_task *task)
179 task->tk_msg.rpc_cred->cr_flags |= RPCAUTH_CRED_UPTODATE;
184 unx_validate(struct rpc_task *task, u32 *p)
186 rpc_authflavor_t flavor;
189 flavor = ntohl(*p++);
190 if (flavor != RPC_AUTH_NULL &&
191 flavor != RPC_AUTH_UNIX &&
192 flavor != RPC_AUTH_SHORT) {
193 printk("RPC: bad verf flavor: %u\n", flavor);
198 if (size > RPC_MAX_AUTH_SIZE) {
199 printk("RPC: giant verf size: %u\n", size);
202 task->tk_auth->au_rslack = (size >> 2) + 2;
208 struct rpc_authops authunix_ops = {
209 .owner = THIS_MODULE,
210 .au_flavor = RPC_AUTH_UNIX,
214 .create = unx_create,
215 .destroy = unx_destroy,
216 .lookup_cred = unx_lookup_cred,
217 .crcreate = unx_create_cred,
221 struct rpc_cred_cache unix_cred_cache = {
222 .expire = UNX_CRED_EXPIRE,
226 struct rpc_auth unix_auth = {
227 .au_cslack = UNX_WRITESLACK,
228 .au_rslack = 2, /* assume AUTH_NULL verf */
229 .au_ops = &authunix_ops,
230 .au_count = ATOMIC_INIT(0),
231 .au_credcache = &unix_cred_cache,
235 struct rpc_credops unix_credops = {
236 .cr_name = "AUTH_UNIX",
237 .crdestroy = unx_destroy_cred,
238 .crmatch = unx_match,
239 .crmarshal = unx_marshal,
240 .crrefresh = unx_refresh,
241 .crvalidate = unx_validate,