blob: e50502d8ceb777a6c6795e22673753c4eea6e538 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/net/sunrpc/auth_unix.c
3 *
4 * UNIX-style authentication; no AUTH_SHORT support
5 *
6 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
7 */
8
Tejun Heo5a0e3ad2010-03-24 17:04:11 +09009#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010#include <linux/types.h>
11#include <linux/sched.h>
12#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/sunrpc/clnt.h>
14#include <linux/sunrpc/auth.h>
15
16#define NFS_NGROUPS 16
17
18struct unx_cred {
19 struct rpc_cred uc_base;
20 gid_t uc_gid;
21 gid_t uc_gids[NFS_NGROUPS];
22};
23#define uc_uid uc_base.cr_uid
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#define UNX_WRITESLACK (21 + (UNX_MAXNODENAME >> 2))
26
27#ifdef RPC_DEBUG
28# define RPCDBG_FACILITY RPCDBG_AUTH
29#endif
30
31static struct rpc_auth unix_auth;
Trond Myklebustf1c0a862007-06-23 20:17:58 -040032static const struct rpc_credops unix_credops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
34static struct rpc_auth *
35unx_create(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
36{
Chuck Lever46121cf2007-01-31 12:14:08 -050037 dprintk("RPC: creating UNIX authenticator for client %p\n",
38 clnt);
Trond Myklebustf5c21872007-06-25 17:11:20 -040039 atomic_inc(&unix_auth.au_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -070040 return &unix_auth;
41}
42
43static void
44unx_destroy(struct rpc_auth *auth)
45{
Chuck Lever46121cf2007-01-31 12:14:08 -050046 dprintk("RPC: destroying UNIX authenticator %p\n", auth);
Trond Myklebust3ab9bb72007-06-09 15:41:42 -040047 rpcauth_clear_credcache(auth->au_credcache);
Linus Torvalds1da177e2005-04-16 15:20:36 -070048}
49
50/*
51 * Lookup AUTH_UNIX creds for current process
52 */
53static struct rpc_cred *
54unx_lookup_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
55{
56 return rpcauth_lookup_credcache(auth, acred, flags);
57}
58
59static struct rpc_cred *
60unx_create_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
61{
62 struct unx_cred *cred;
Trond Myklebustaf093832008-03-12 12:12:16 -040063 unsigned int groups = 0;
64 unsigned int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
Chuck Lever46121cf2007-01-31 12:14:08 -050066 dprintk("RPC: allocating UNIX cred for uid %d gid %d\n",
67 acred->uid, acred->gid);
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
Trond Myklebust0f38b872008-06-10 18:31:01 -040069 if (!(cred = kmalloc(sizeof(*cred), GFP_NOFS)))
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 return ERR_PTR(-ENOMEM);
71
Trond Myklebust5fe47552007-06-23 19:55:31 -040072 rpcauth_init_cred(&cred->uc_base, acred, auth, &unix_credops);
Trond Myklebustfc432dd2007-06-25 10:15:15 -040073 cred->uc_base.cr_flags = 1UL << RPCAUTH_CRED_UPTODATE;
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
Trond Myklebustaf093832008-03-12 12:12:16 -040075 if (acred->group_info != NULL)
76 groups = acred->group_info->ngroups;
77 if (groups > NFS_NGROUPS)
78 groups = NFS_NGROUPS;
79
80 cred->uc_gid = acred->gid;
81 for (i = 0; i < groups; i++)
82 cred->uc_gids[i] = GROUP_AT(acred->group_info, i);
83 if (i < NFS_NGROUPS)
84 cred->uc_gids[i] = NOGROUP;
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Trond Myklebust696e38d2007-06-25 09:48:25 -040086 return &cred->uc_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -070087}
88
89static void
Trond Myklebust31be5bf2007-06-24 15:55:26 -040090unx_free_cred(struct unx_cred *unx_cred)
Linus Torvalds1da177e2005-04-16 15:20:36 -070091{
Trond Myklebust31be5bf2007-06-24 15:55:26 -040092 dprintk("RPC: unx_free_cred %p\n", unx_cred);
93 kfree(unx_cred);
94}
Trond Myklebust696e38d2007-06-25 09:48:25 -040095
Trond Myklebust31be5bf2007-06-24 15:55:26 -040096static void
97unx_free_cred_callback(struct rcu_head *head)
98{
99 struct unx_cred *unx_cred = container_of(head, struct unx_cred, uc_base.cr_rcu);
100 unx_free_cred(unx_cred);
101}
102
103static void
104unx_destroy_cred(struct rpc_cred *cred)
105{
106 call_rcu(&cred->cr_rcu, unx_free_cred_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107}
108
109/*
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).
113 */
114static int
Trond Myklebust8a317762006-02-01 12:18:36 -0500115unx_match(struct auth_cred *acred, struct rpc_cred *rcred, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116{
Trond Myklebust696e38d2007-06-25 09:48:25 -0400117 struct unx_cred *cred = container_of(rcred, struct unx_cred, uc_base);
Trond Myklebustaf093832008-03-12 12:12:16 -0400118 unsigned int groups = 0;
119 unsigned int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
Trond Myklebustaf093832008-03-12 12:12:16 -0400122 if (cred->uc_uid != acred->uid || cred->uc_gid != acred->gid)
123 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
Trond Myklebustaf093832008-03-12 12:12:16 -0400125 if (acred->group_info != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 groups = acred->group_info->ngroups;
Trond Myklebustaf093832008-03-12 12:12:16 -0400127 if (groups > NFS_NGROUPS)
128 groups = NFS_NGROUPS;
129 for (i = 0; i < groups ; i++)
130 if (cred->uc_gids[i] != GROUP_AT(acred->group_info, i))
131 return 0;
NeilBrowndc6f55e2011-10-25 10:25:49 +1100132 if (groups < NFS_NGROUPS &&
133 cred->uc_gids[groups] != NOGROUP)
134 return 0;
Trond Myklebustaf093832008-03-12 12:12:16 -0400135 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136}
137
138/*
139 * Marshal credentials.
140 * Maybe we should keep a cached credential for performance reasons.
141 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700142static __be32 *
143unx_marshal(struct rpc_task *task, __be32 *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144{
145 struct rpc_clnt *clnt = task->tk_client;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400146 struct unx_cred *cred = container_of(task->tk_rqstp->rq_cred, struct unx_cred, uc_base);
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700147 __be32 *base, *hold;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 int i;
149
150 *p++ = htonl(RPC_AUTH_UNIX);
151 base = p++;
152 *p++ = htonl(jiffies/HZ);
153
154 /*
155 * Copy the UTS nodename captured when the client was created.
156 */
157 p = xdr_encode_array(p, clnt->cl_nodename, clnt->cl_nodelen);
158
159 *p++ = htonl((u32) cred->uc_uid);
160 *p++ = htonl((u32) cred->uc_gid);
161 hold = p++;
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 */
166
167 *p++ = htonl(RPC_AUTH_NULL);
168 *p++ = htonl(0);
169
170 return p;
171}
172
173/*
174 * Refresh credentials. This is a no-op for AUTH_UNIX
175 */
176static int
177unx_refresh(struct rpc_task *task)
178{
Trond Myklebusta17c2152010-07-31 14:29:08 -0400179 set_bit(RPCAUTH_CRED_UPTODATE, &task->tk_rqstp->rq_cred->cr_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 return 0;
181}
182
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700183static __be32 *
184unx_validate(struct rpc_task *task, __be32 *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185{
186 rpc_authflavor_t flavor;
187 u32 size;
188
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);
194 return NULL;
195 }
196
197 size = ntohl(*p++);
198 if (size > RPC_MAX_AUTH_SIZE) {
199 printk("RPC: giant verf size: %u\n", size);
200 return NULL;
201 }
Trond Myklebusta17c2152010-07-31 14:29:08 -0400202 task->tk_rqstp->rq_cred->cr_auth->au_rslack = (size >> 2) + 2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 p += (size >> 2);
204
205 return p;
206}
207
Trond Myklebust5d8d9a4d2010-07-31 14:29:07 -0400208int __init rpc_init_authunix(void)
Trond Myklebust9499b432007-06-24 15:57:57 -0400209{
Trond Myklebust5d8d9a4d2010-07-31 14:29:07 -0400210 return rpcauth_init_credcache(&unix_auth);
211}
212
213void rpc_destroy_authunix(void)
214{
215 rpcauth_destroy_credcache(&unix_auth);
Trond Myklebust9499b432007-06-24 15:57:57 -0400216}
217
Trond Myklebustf1c0a862007-06-23 20:17:58 -0400218const struct rpc_authops authunix_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 .owner = THIS_MODULE,
220 .au_flavor = RPC_AUTH_UNIX,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 .au_name = "UNIX",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 .create = unx_create,
223 .destroy = unx_destroy,
224 .lookup_cred = unx_lookup_cred,
225 .crcreate = unx_create_cred,
226};
227
228static
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229struct rpc_auth unix_auth = {
230 .au_cslack = UNX_WRITESLACK,
231 .au_rslack = 2, /* assume AUTH_NULL verf */
232 .au_ops = &authunix_ops,
Trond Myklebust81039f12006-06-09 09:34:34 -0400233 .au_flavor = RPC_AUTH_UNIX,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 .au_count = ATOMIC_INIT(0),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235};
236
237static
Trond Myklebustf1c0a862007-06-23 20:17:58 -0400238const struct rpc_credops unix_credops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 .cr_name = "AUTH_UNIX",
240 .crdestroy = unx_destroy_cred,
Trond Myklebust5c691042008-03-12 16:21:07 -0400241 .crbind = rpcauth_generic_bind_cred,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 .crmatch = unx_match,
243 .crmarshal = unx_marshal,
244 .crrefresh = unx_refresh,
245 .crvalidate = unx_validate,
246};