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>
15 #define NFS_NGROUPS 16
18 struct rpc_cred uc_base;
20 gid_t uc_gids[NFS_NGROUPS];
22 #define uc_uid uc_base.cr_uid
24 #define UNX_CRED_EXPIRE (60 * HZ)
26 #define UNX_WRITESLACK (21 + (UNX_MAXNODENAME >> 2))
29 # define RPCDBG_FACILITY RPCDBG_AUTH
32 static struct rpc_auth unix_auth;
33 static struct rpc_cred_cache unix_cred_cache;
34 static const struct rpc_credops unix_credops;
36 static struct rpc_auth *
37 unx_create(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
39 dprintk("RPC: creating UNIX authenticator for client %p\n",
41 if (atomic_inc_return(&unix_auth.au_count) == 1)
42 unix_cred_cache.nextgc = jiffies + (unix_cred_cache.expire >> 1);
47 unx_destroy(struct rpc_auth *auth)
49 dprintk("RPC: destroying UNIX authenticator %p\n", auth);
50 rpcauth_clear_credcache(auth->au_credcache);
54 * Lookup AUTH_UNIX creds for current process
56 static struct rpc_cred *
57 unx_lookup_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
59 return rpcauth_lookup_credcache(auth, acred, flags);
62 static struct rpc_cred *
63 unx_create_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
65 struct unx_cred *cred;
68 dprintk("RPC: allocating UNIX cred for uid %d gid %d\n",
69 acred->uid, acred->gid);
71 if (!(cred = kmalloc(sizeof(*cred), GFP_KERNEL)))
72 return ERR_PTR(-ENOMEM);
74 rpcauth_init_cred(&cred->uc_base, acred, auth, &unix_credops);
75 cred->uc_base.cr_flags = 1UL << RPCAUTH_CRED_UPTODATE;
76 if (flags & RPCAUTH_LOOKUP_ROOTCREDS) {
79 cred->uc_gids[0] = NOGROUP;
81 int groups = acred->group_info->ngroups;
82 if (groups > NFS_NGROUPS)
85 cred->uc_gid = acred->gid;
86 for (i = 0; i < groups; i++)
87 cred->uc_gids[i] = GROUP_AT(acred->group_info, i);
89 cred->uc_gids[i] = NOGROUP;
92 return &cred->uc_base;
96 unx_destroy_cred(struct rpc_cred *rcred)
98 struct unx_cred *cred = container_of(rcred, struct unx_cred, uc_base);
104 * Match credentials against current process creds.
105 * The root_override argument takes care of cases where the caller may
106 * request root creds (e.g. for NFS swapping).
109 unx_match(struct auth_cred *acred, struct rpc_cred *rcred, int flags)
111 struct unx_cred *cred = container_of(rcred, struct unx_cred, uc_base);
114 if (!(flags & RPCAUTH_LOOKUP_ROOTCREDS)) {
117 if (cred->uc_uid != acred->uid
118 || cred->uc_gid != acred->gid)
121 groups = acred->group_info->ngroups;
122 if (groups > NFS_NGROUPS)
123 groups = NFS_NGROUPS;
124 for (i = 0; i < groups ; i++)
125 if (cred->uc_gids[i] != GROUP_AT(acred->group_info, i))
129 return (cred->uc_uid == 0
131 && cred->uc_gids[0] == (gid_t) NOGROUP);
135 * Marshal credentials.
136 * Maybe we should keep a cached credential for performance reasons.
139 unx_marshal(struct rpc_task *task, __be32 *p)
141 struct rpc_clnt *clnt = task->tk_client;
142 struct unx_cred *cred = container_of(task->tk_msg.rpc_cred, struct unx_cred, uc_base);
146 *p++ = htonl(RPC_AUTH_UNIX);
148 *p++ = htonl(jiffies/HZ);
151 * Copy the UTS nodename captured when the client was created.
153 p = xdr_encode_array(p, clnt->cl_nodename, clnt->cl_nodelen);
155 *p++ = htonl((u32) cred->uc_uid);
156 *p++ = htonl((u32) cred->uc_gid);
158 for (i = 0; i < 16 && cred->uc_gids[i] != (gid_t) NOGROUP; i++)
159 *p++ = htonl((u32) cred->uc_gids[i]);
160 *hold = htonl(p - hold - 1); /* gid array length */
161 *base = htonl((p - base - 1) << 2); /* cred length */
163 *p++ = htonl(RPC_AUTH_NULL);
170 * Refresh credentials. This is a no-op for AUTH_UNIX
173 unx_refresh(struct rpc_task *task)
175 set_bit(RPCAUTH_CRED_UPTODATE, &task->tk_msg.rpc_cred->cr_flags);
180 unx_validate(struct rpc_task *task, __be32 *p)
182 rpc_authflavor_t flavor;
185 flavor = ntohl(*p++);
186 if (flavor != RPC_AUTH_NULL &&
187 flavor != RPC_AUTH_UNIX &&
188 flavor != RPC_AUTH_SHORT) {
189 printk("RPC: bad verf flavor: %u\n", flavor);
194 if (size > RPC_MAX_AUTH_SIZE) {
195 printk("RPC: giant verf size: %u\n", size);
198 task->tk_auth->au_rslack = (size >> 2) + 2;
204 const struct rpc_authops authunix_ops = {
205 .owner = THIS_MODULE,
206 .au_flavor = RPC_AUTH_UNIX,
210 .create = unx_create,
211 .destroy = unx_destroy,
212 .lookup_cred = unx_lookup_cred,
213 .crcreate = unx_create_cred,
217 struct rpc_cred_cache unix_cred_cache = {
218 .expire = UNX_CRED_EXPIRE,
222 struct rpc_auth unix_auth = {
223 .au_cslack = UNX_WRITESLACK,
224 .au_rslack = 2, /* assume AUTH_NULL verf */
225 .au_ops = &authunix_ops,
226 .au_flavor = RPC_AUTH_UNIX,
227 .au_count = ATOMIC_INIT(0),
228 .au_credcache = &unix_cred_cache,
232 const struct rpc_credops unix_credops = {
233 .cr_name = "AUTH_UNIX",
234 .crdestroy = unx_destroy_cred,
235 .crmatch = unx_match,
236 .crmarshal = unx_marshal,
237 .crrefresh = unx_refresh,
238 .crvalidate = unx_validate,