blob: 769274ed51c4b2be88884ab6f6a392ddf5ccad6d [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * fs/nfs/idmap.c
3 *
4 * UID and GID to name mapping for clients.
5 *
6 * Copyright (c) 2002 The Regents of the University of Michigan.
7 * All rights reserved.
8 *
9 * Marius Aamodt Eriksen <marius@umich.edu>
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 *
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. Neither the name of the University nor the names of its
21 * contributors may be used to endorse or promote products derived
22 * from this software without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
25 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
26 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
31 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
32 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
33 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
34 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 */
Trond Myklebust5cf36cf2011-02-22 15:44:31 -080036#include <linux/types.h>
37#include <linux/string.h>
38#include <linux/kernel.h>
Vitaliy Ivanove44ba032011-06-20 16:08:07 +020039#include <linux/slab.h>
40#include <linux/nfs_idmap.h>
Trond Myklebust6926afd2012-01-07 13:22:46 -050041#include <linux/nfs_fs.h>
42
43/**
44 * nfs_fattr_init_names - initialise the nfs_fattr owner_name/group_name fields
45 * @fattr: fully initialised struct nfs_fattr
46 * @owner_name: owner name string cache
47 * @group_name: group name string cache
48 */
49void nfs_fattr_init_names(struct nfs_fattr *fattr,
50 struct nfs4_string *owner_name,
51 struct nfs4_string *group_name)
52{
53 fattr->owner_name = owner_name;
54 fattr->group_name = group_name;
55}
56
57static void nfs_fattr_free_owner_name(struct nfs_fattr *fattr)
58{
59 fattr->valid &= ~NFS_ATTR_FATTR_OWNER_NAME;
60 kfree(fattr->owner_name->data);
61}
62
63static void nfs_fattr_free_group_name(struct nfs_fattr *fattr)
64{
65 fattr->valid &= ~NFS_ATTR_FATTR_GROUP_NAME;
66 kfree(fattr->group_name->data);
67}
68
69static bool nfs_fattr_map_owner_name(struct nfs_server *server, struct nfs_fattr *fattr)
70{
71 struct nfs4_string *owner = fattr->owner_name;
72 __u32 uid;
73
74 if (!(fattr->valid & NFS_ATTR_FATTR_OWNER_NAME))
75 return false;
76 if (nfs_map_name_to_uid(server, owner->data, owner->len, &uid) == 0) {
77 fattr->uid = uid;
78 fattr->valid |= NFS_ATTR_FATTR_OWNER;
79 }
80 return true;
81}
82
83static bool nfs_fattr_map_group_name(struct nfs_server *server, struct nfs_fattr *fattr)
84{
85 struct nfs4_string *group = fattr->group_name;
86 __u32 gid;
87
88 if (!(fattr->valid & NFS_ATTR_FATTR_GROUP_NAME))
89 return false;
90 if (nfs_map_group_to_gid(server, group->data, group->len, &gid) == 0) {
91 fattr->gid = gid;
92 fattr->valid |= NFS_ATTR_FATTR_GROUP;
93 }
94 return true;
95}
96
97/**
98 * nfs_fattr_free_names - free up the NFSv4 owner and group strings
99 * @fattr: a fully initialised nfs_fattr structure
100 */
101void nfs_fattr_free_names(struct nfs_fattr *fattr)
102{
103 if (fattr->valid & NFS_ATTR_FATTR_OWNER_NAME)
104 nfs_fattr_free_owner_name(fattr);
105 if (fattr->valid & NFS_ATTR_FATTR_GROUP_NAME)
106 nfs_fattr_free_group_name(fattr);
107}
108
109/**
110 * nfs_fattr_map_and_free_names - map owner/group strings into uid/gid and free
111 * @server: pointer to the filesystem nfs_server structure
112 * @fattr: a fully initialised nfs_fattr structure
113 *
114 * This helper maps the cached NFSv4 owner/group strings in fattr into
115 * their numeric uid/gid equivalents, and then frees the cached strings.
116 */
117void nfs_fattr_map_and_free_names(struct nfs_server *server, struct nfs_fattr *fattr)
118{
119 if (nfs_fattr_map_owner_name(server, fattr))
120 nfs_fattr_free_owner_name(fattr);
121 if (nfs_fattr_map_group_name(server, fattr))
122 nfs_fattr_free_group_name(fattr);
123}
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800124
125static int nfs_map_string_to_numeric(const char *name, size_t namelen, __u32 *res)
126{
127 unsigned long val;
128 char buf[16];
129
130 if (memchr(name, '@', namelen) != NULL || namelen >= sizeof(buf))
131 return 0;
132 memcpy(buf, name, namelen);
133 buf[namelen] = '\0';
134 if (strict_strtoul(buf, 0, &val) != 0)
135 return 0;
136 *res = val;
137 return 1;
138}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
Trond Myklebustf0b85162011-02-22 15:44:31 -0800140static int nfs_map_numeric_to_string(__u32 id, char *buf, size_t buflen)
141{
142 return snprintf(buf, buflen, "%u", id);
143}
144
Bryan Schumaker955a8572010-09-29 15:41:49 -0400145#ifdef CONFIG_NFS_USE_NEW_IDMAPPER
146
Bryan Schumaker955a8572010-09-29 15:41:49 -0400147#include <linux/cred.h>
Trond Myklebustb064eca22011-02-22 15:44:32 -0800148#include <linux/sunrpc/sched.h>
149#include <linux/nfs4.h>
150#include <linux/nfs_fs_sb.h>
Bryan Schumaker955a8572010-09-29 15:41:49 -0400151#include <linux/keyctl.h>
152#include <linux/key-type.h>
153#include <linux/rcupdate.h>
Bryan Schumaker955a8572010-09-29 15:41:49 -0400154#include <linux/err.h>
155
156#include <keys/user-type.h>
157
158#define NFS_UINT_MAXLEN 11
159
160const struct cred *id_resolver_cache;
161
162struct key_type key_type_id_resolver = {
163 .name = "id_resolver",
164 .instantiate = user_instantiate,
165 .match = user_match,
166 .revoke = user_revoke,
167 .destroy = user_destroy,
168 .describe = user_describe,
169 .read = user_read,
170};
171
172int nfs_idmap_init(void)
173{
174 struct cred *cred;
175 struct key *keyring;
176 int ret = 0;
177
178 printk(KERN_NOTICE "Registering the %s key type\n", key_type_id_resolver.name);
179
180 cred = prepare_kernel_cred(NULL);
181 if (!cred)
182 return -ENOMEM;
183
184 keyring = key_alloc(&key_type_keyring, ".id_resolver", 0, 0, cred,
185 (KEY_POS_ALL & ~KEY_POS_SETATTR) |
186 KEY_USR_VIEW | KEY_USR_READ,
187 KEY_ALLOC_NOT_IN_QUOTA);
188 if (IS_ERR(keyring)) {
189 ret = PTR_ERR(keyring);
190 goto failed_put_cred;
191 }
192
193 ret = key_instantiate_and_link(keyring, NULL, 0, NULL, NULL);
194 if (ret < 0)
195 goto failed_put_key;
196
197 ret = register_key_type(&key_type_id_resolver);
198 if (ret < 0)
199 goto failed_put_key;
200
201 cred->thread_keyring = keyring;
202 cred->jit_keyring = KEY_REQKEY_DEFL_THREAD_KEYRING;
203 id_resolver_cache = cred;
204 return 0;
205
206failed_put_key:
207 key_put(keyring);
208failed_put_cred:
209 put_cred(cred);
210 return ret;
211}
212
213void nfs_idmap_quit(void)
214{
215 key_revoke(id_resolver_cache->thread_keyring);
216 unregister_key_type(&key_type_id_resolver);
217 put_cred(id_resolver_cache);
218}
219
220/*
221 * Assemble the description to pass to request_key()
222 * This function will allocate a new string and update dest to point
223 * at it. The caller is responsible for freeing dest.
224 *
225 * On error 0 is returned. Otherwise, the length of dest is returned.
226 */
227static ssize_t nfs_idmap_get_desc(const char *name, size_t namelen,
228 const char *type, size_t typelen, char **desc)
229{
230 char *cp;
231 size_t desclen = typelen + namelen + 2;
232
233 *desc = kmalloc(desclen, GFP_KERNEL);
Dan Carpenter8f0d97b2010-10-28 08:05:57 +0200234 if (!*desc)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400235 return -ENOMEM;
236
237 cp = *desc;
238 memcpy(cp, type, typelen);
239 cp += typelen;
240 *cp++ = ':';
241
242 memcpy(cp, name, namelen);
243 cp += namelen;
244 *cp = '\0';
245 return desclen;
246}
247
248static ssize_t nfs_idmap_request_key(const char *name, size_t namelen,
249 const char *type, void *data, size_t data_size)
250{
251 const struct cred *saved_cred;
252 struct key *rkey;
253 char *desc;
254 struct user_key_payload *payload;
255 ssize_t ret;
256
257 ret = nfs_idmap_get_desc(name, namelen, type, strlen(type), &desc);
258 if (ret <= 0)
259 goto out;
260
261 saved_cred = override_creds(id_resolver_cache);
262 rkey = request_key(&key_type_id_resolver, desc, "");
263 revert_creds(saved_cred);
264 kfree(desc);
265 if (IS_ERR(rkey)) {
266 ret = PTR_ERR(rkey);
267 goto out;
268 }
269
270 rcu_read_lock();
271 rkey->perm |= KEY_USR_VIEW;
272
273 ret = key_validate(rkey);
274 if (ret < 0)
275 goto out_up;
276
277 payload = rcu_dereference(rkey->payload.data);
278 if (IS_ERR_OR_NULL(payload)) {
279 ret = PTR_ERR(payload);
280 goto out_up;
281 }
282
283 ret = payload->datalen;
284 if (ret > 0 && ret <= data_size)
285 memcpy(data, payload->data, ret);
286 else
287 ret = -EINVAL;
288
289out_up:
290 rcu_read_unlock();
291 key_put(rkey);
292out:
293 return ret;
294}
295
296
297/* ID -> Name */
298static ssize_t nfs_idmap_lookup_name(__u32 id, const char *type, char *buf, size_t buflen)
299{
300 char id_str[NFS_UINT_MAXLEN];
301 int id_len;
302 ssize_t ret;
303
304 id_len = snprintf(id_str, sizeof(id_str), "%u", id);
305 ret = nfs_idmap_request_key(id_str, id_len, type, buf, buflen);
306 if (ret < 0)
307 return -EINVAL;
308 return ret;
309}
310
311/* Name -> ID */
312static int nfs_idmap_lookup_id(const char *name, size_t namelen,
313 const char *type, __u32 *id)
314{
315 char id_str[NFS_UINT_MAXLEN];
316 long id_long;
317 ssize_t data_size;
318 int ret = 0;
319
320 data_size = nfs_idmap_request_key(name, namelen, type, id_str, NFS_UINT_MAXLEN);
321 if (data_size <= 0) {
322 ret = -EINVAL;
323 } else {
324 ret = strict_strtol(id_str, 10, &id_long);
325 *id = (__u32)id_long;
326 }
327 return ret;
328}
329
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800330int nfs_map_name_to_uid(const struct nfs_server *server, const char *name, size_t namelen, __u32 *uid)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400331{
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800332 if (nfs_map_string_to_numeric(name, namelen, uid))
333 return 0;
Bryan Schumaker955a8572010-09-29 15:41:49 -0400334 return nfs_idmap_lookup_id(name, namelen, "uid", uid);
335}
336
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800337int nfs_map_group_to_gid(const struct nfs_server *server, const char *name, size_t namelen, __u32 *gid)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400338{
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800339 if (nfs_map_string_to_numeric(name, namelen, gid))
340 return 0;
Bryan Schumaker955a8572010-09-29 15:41:49 -0400341 return nfs_idmap_lookup_id(name, namelen, "gid", gid);
342}
343
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800344int nfs_map_uid_to_name(const struct nfs_server *server, __u32 uid, char *buf, size_t buflen)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400345{
Trond Myklebustb064eca22011-02-22 15:44:32 -0800346 int ret = -EINVAL;
347
348 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
349 ret = nfs_idmap_lookup_name(uid, "user", buf, buflen);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800350 if (ret < 0)
351 ret = nfs_map_numeric_to_string(uid, buf, buflen);
352 return ret;
Bryan Schumaker955a8572010-09-29 15:41:49 -0400353}
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800354int nfs_map_gid_to_group(const struct nfs_server *server, __u32 gid, char *buf, size_t buflen)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400355{
Trond Myklebustb064eca22011-02-22 15:44:32 -0800356 int ret = -EINVAL;
Trond Myklebustf0b85162011-02-22 15:44:31 -0800357
Trond Myklebustb064eca22011-02-22 15:44:32 -0800358 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
359 ret = nfs_idmap_lookup_name(gid, "group", buf, buflen);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800360 if (ret < 0)
361 ret = nfs_map_numeric_to_string(gid, buf, buflen);
362 return ret;
Bryan Schumaker955a8572010-09-29 15:41:49 -0400363}
364
J. Bruce Fields5f3e97c2010-12-21 23:49:34 +0000365#else /* CONFIG_NFS_USE_NEW_IDMAPPER not defined */
Bryan Schumaker955a8572010-09-29 15:41:49 -0400366
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367#include <linux/module.h>
Ingo Molnarc9d51282006-03-20 13:44:11 -0500368#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370#include <linux/socket.h>
371#include <linux/in.h>
372#include <linux/sched.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373#include <linux/sunrpc/clnt.h>
374#include <linux/workqueue.h>
375#include <linux/sunrpc/rpc_pipe_fs.h>
376
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377#include <linux/nfs_fs.h>
378
Trond Myklebust4ce79712005-06-22 17:16:21 +0000379#include "nfs4_fs.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380
381#define IDMAP_HASH_SZ 128
382
Trond Myklebust58df0952006-01-03 09:55:57 +0100383/* Default cache timeout is 10 minutes */
384unsigned int nfs_idmap_cache_timeout = 600 * HZ;
385
David Howells7d4e2742006-08-22 20:06:07 -0400386static int param_set_idmap_timeout(const char *val, struct kernel_param *kp)
387{
388 char *endp;
389 int num = simple_strtol(val, &endp, 0);
390 int jif = num * HZ;
391 if (endp == val || *endp || num < 0 || jif < num)
392 return -EINVAL;
393 *((int *)kp->arg) = jif;
394 return 0;
395}
396
397module_param_call(idmap_cache_timeout, param_set_idmap_timeout, param_get_int,
398 &nfs_idmap_cache_timeout, 0644);
399
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400struct idmap_hashent {
Chuck Lever369af0f2007-12-20 14:54:35 -0500401 unsigned long ih_expires;
402 __u32 ih_id;
Chuck Leverd24aae42007-12-20 14:54:49 -0500403 size_t ih_namelen;
Chuck Lever369af0f2007-12-20 14:54:35 -0500404 char ih_name[IDMAP_NAMESZ];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405};
406
407struct idmap_hashtable {
Chuck Lever369af0f2007-12-20 14:54:35 -0500408 __u8 h_type;
409 struct idmap_hashent h_entries[IDMAP_HASH_SZ];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410};
411
412struct idmap {
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300413 struct rpc_pipe *idmap_pipe;
Chuck Lever369af0f2007-12-20 14:54:35 -0500414 wait_queue_head_t idmap_wq;
415 struct idmap_msg idmap_im;
416 struct mutex idmap_lock; /* Serializes upcalls */
417 struct mutex idmap_im_lock; /* Protects the hashtable */
418 struct idmap_hashtable idmap_user_hash;
419 struct idmap_hashtable idmap_group_hash;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420};
421
Chuck Lever369af0f2007-12-20 14:54:35 -0500422static ssize_t idmap_pipe_downcall(struct file *, const char __user *,
423 size_t);
424static void idmap_pipe_destroy_msg(struct rpc_pipe_msg *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425
426static unsigned int fnvhash32(const void *, size_t);
427
Trond Myklebustb693ba42009-08-09 15:14:15 -0400428static const struct rpc_pipe_ops idmap_upcall_ops = {
Peng Taoc1225152011-09-22 21:50:10 -0400429 .upcall = rpc_pipe_generic_upcall,
Chuck Lever369af0f2007-12-20 14:54:35 -0500430 .downcall = idmap_pipe_downcall,
431 .destroy_msg = idmap_pipe_destroy_msg,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432};
433
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400434static void __nfs_idmap_unregister(struct rpc_pipe *pipe)
435{
436 if (pipe->dentry)
437 rpc_unlink(pipe->dentry);
438}
439
440static int __nfs_idmap_register(struct dentry *dir,
441 struct idmap *idmap,
442 struct rpc_pipe *pipe)
443{
444 struct dentry *dentry;
445
446 dentry = rpc_mkpipe_dentry(dir, "idmap", idmap, pipe);
447 if (IS_ERR(dentry))
448 return PTR_ERR(dentry);
449 pipe->dentry = dentry;
450 return 0;
451}
452
453static void nfs_idmap_unregister(struct nfs_client *clp,
454 struct rpc_pipe *pipe)
455{
456 struct net *net = clp->net;
457 struct super_block *pipefs_sb;
458
459 pipefs_sb = rpc_get_sb_net(net);
460 if (pipefs_sb) {
461 __nfs_idmap_unregister(pipe);
462 rpc_put_sb_net(net);
463 }
464}
465
466static int nfs_idmap_register(struct nfs_client *clp,
467 struct idmap *idmap,
468 struct rpc_pipe *pipe)
469{
470 struct net *net = clp->net;
471 struct super_block *pipefs_sb;
472 int err = 0;
473
474 pipefs_sb = rpc_get_sb_net(net);
475 if (pipefs_sb) {
476 if (clp->cl_rpcclient->cl_dentry)
477 err = __nfs_idmap_register(clp->cl_rpcclient->cl_dentry,
478 idmap, pipe);
479 rpc_put_sb_net(net);
480 }
481 return err;
482}
483
David Howellsb7162792006-08-22 20:06:09 -0400484int
David Howellsadfa6f92006-08-22 20:06:08 -0400485nfs_idmap_new(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486{
487 struct idmap *idmap;
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300488 struct rpc_pipe *pipe;
David Howellsb7162792006-08-22 20:06:09 -0400489 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490
David Howells54ceac42006-08-22 20:06:13 -0400491 BUG_ON(clp->cl_idmap != NULL);
David Howellsb7162792006-08-22 20:06:09 -0400492
Chuck Lever369af0f2007-12-20 14:54:35 -0500493 idmap = kzalloc(sizeof(*idmap), GFP_KERNEL);
494 if (idmap == NULL)
495 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300497 pipe = rpc_mkpipe_data(&idmap_upcall_ops, 0);
498 if (IS_ERR(pipe)) {
499 error = PTR_ERR(pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 kfree(idmap);
David Howellsb7162792006-08-22 20:06:09 -0400501 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 }
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400503 error = nfs_idmap_register(clp, idmap, pipe);
504 if (error) {
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300505 rpc_destroy_pipe_data(pipe);
506 kfree(idmap);
507 return error;
508 }
509 idmap->idmap_pipe = pipe;
Chuck Lever369af0f2007-12-20 14:54:35 -0500510 mutex_init(&idmap->idmap_lock);
511 mutex_init(&idmap->idmap_im_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 init_waitqueue_head(&idmap->idmap_wq);
513 idmap->idmap_user_hash.h_type = IDMAP_TYPE_USER;
514 idmap->idmap_group_hash.h_type = IDMAP_TYPE_GROUP;
515
516 clp->cl_idmap = idmap;
David Howellsb7162792006-08-22 20:06:09 -0400517 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518}
519
520void
David Howellsadfa6f92006-08-22 20:06:08 -0400521nfs_idmap_delete(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522{
523 struct idmap *idmap = clp->cl_idmap;
524
525 if (!idmap)
526 return;
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400527 nfs_idmap_unregister(clp, idmap->idmap_pipe);
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300528 rpc_destroy_pipe_data(idmap->idmap_pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 clp->cl_idmap = NULL;
530 kfree(idmap);
531}
532
533/*
534 * Helper routines for manipulating the hashtable
535 */
536static inline struct idmap_hashent *
537idmap_name_hash(struct idmap_hashtable* h, const char *name, size_t len)
538{
539 return &h->h_entries[fnvhash32(name, len) % IDMAP_HASH_SZ];
540}
541
542static struct idmap_hashent *
543idmap_lookup_name(struct idmap_hashtable *h, const char *name, size_t len)
544{
545 struct idmap_hashent *he = idmap_name_hash(h, name, len);
546
547 if (he->ih_namelen != len || memcmp(he->ih_name, name, len) != 0)
548 return NULL;
Trond Myklebust58df0952006-01-03 09:55:57 +0100549 if (time_after(jiffies, he->ih_expires))
550 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 return he;
552}
553
554static inline struct idmap_hashent *
555idmap_id_hash(struct idmap_hashtable* h, __u32 id)
556{
557 return &h->h_entries[fnvhash32(&id, sizeof(id)) % IDMAP_HASH_SZ];
558}
559
560static struct idmap_hashent *
561idmap_lookup_id(struct idmap_hashtable *h, __u32 id)
562{
563 struct idmap_hashent *he = idmap_id_hash(h, id);
564 if (he->ih_id != id || he->ih_namelen == 0)
565 return NULL;
Trond Myklebust58df0952006-01-03 09:55:57 +0100566 if (time_after(jiffies, he->ih_expires))
567 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 return he;
569}
570
571/*
572 * Routines for allocating new entries in the hashtable.
573 * For now, we just have 1 entry per bucket, so it's all
574 * pretty trivial.
575 */
576static inline struct idmap_hashent *
Chuck Leverd24aae42007-12-20 14:54:49 -0500577idmap_alloc_name(struct idmap_hashtable *h, char *name, size_t len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578{
579 return idmap_name_hash(h, name, len);
580}
581
582static inline struct idmap_hashent *
583idmap_alloc_id(struct idmap_hashtable *h, __u32 id)
584{
585 return idmap_id_hash(h, id);
586}
587
588static void
589idmap_update_entry(struct idmap_hashent *he, const char *name,
590 size_t namelen, __u32 id)
591{
592 he->ih_id = id;
593 memcpy(he->ih_name, name, namelen);
594 he->ih_name[namelen] = '\0';
595 he->ih_namelen = namelen;
Trond Myklebust58df0952006-01-03 09:55:57 +0100596 he->ih_expires = jiffies + nfs_idmap_cache_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597}
598
599/*
600 * Name -> ID
601 */
602static int
603nfs_idmap_id(struct idmap *idmap, struct idmap_hashtable *h,
604 const char *name, size_t namelen, __u32 *id)
605{
606 struct rpc_pipe_msg msg;
607 struct idmap_msg *im;
608 struct idmap_hashent *he;
609 DECLARE_WAITQUEUE(wq, current);
610 int ret = -EIO;
611
612 im = &idmap->idmap_im;
613
614 /*
615 * String sanity checks
616 * Note that the userland daemon expects NUL terminated strings
617 */
618 for (;;) {
619 if (namelen == 0)
620 return -EINVAL;
621 if (name[namelen-1] != '\0')
622 break;
623 namelen--;
624 }
625 if (namelen >= IDMAP_NAMESZ)
626 return -EINVAL;
627
Ingo Molnarc9d51282006-03-20 13:44:11 -0500628 mutex_lock(&idmap->idmap_lock);
629 mutex_lock(&idmap->idmap_im_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630
631 he = idmap_lookup_name(h, name, namelen);
632 if (he != NULL) {
633 *id = he->ih_id;
634 ret = 0;
635 goto out;
636 }
637
638 memset(im, 0, sizeof(*im));
639 memcpy(im->im_name, name, namelen);
640
641 im->im_type = h->h_type;
642 im->im_conv = IDMAP_CONV_NAMETOID;
643
644 memset(&msg, 0, sizeof(msg));
645 msg.data = im;
646 msg.len = sizeof(*im);
647
648 add_wait_queue(&idmap->idmap_wq, &wq);
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300649 if (rpc_queue_upcall(idmap->idmap_pipe, &msg) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 remove_wait_queue(&idmap->idmap_wq, &wq);
651 goto out;
652 }
653
654 set_current_state(TASK_UNINTERRUPTIBLE);
Ingo Molnarc9d51282006-03-20 13:44:11 -0500655 mutex_unlock(&idmap->idmap_im_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 schedule();
Milind Arun Choudharyfee7f232007-04-26 00:29:03 -0700657 __set_current_state(TASK_RUNNING);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 remove_wait_queue(&idmap->idmap_wq, &wq);
Ingo Molnarc9d51282006-03-20 13:44:11 -0500659 mutex_lock(&idmap->idmap_im_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660
661 if (im->im_status & IDMAP_STATUS_SUCCESS) {
662 *id = im->im_id;
663 ret = 0;
664 }
665
666 out:
667 memset(im, 0, sizeof(*im));
Ingo Molnarc9d51282006-03-20 13:44:11 -0500668 mutex_unlock(&idmap->idmap_im_lock);
669 mutex_unlock(&idmap->idmap_lock);
Chuck Lever369af0f2007-12-20 14:54:35 -0500670 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671}
672
673/*
674 * ID -> Name
675 */
676static int
677nfs_idmap_name(struct idmap *idmap, struct idmap_hashtable *h,
678 __u32 id, char *name)
679{
680 struct rpc_pipe_msg msg;
681 struct idmap_msg *im;
682 struct idmap_hashent *he;
683 DECLARE_WAITQUEUE(wq, current);
684 int ret = -EIO;
685 unsigned int len;
686
687 im = &idmap->idmap_im;
688
Ingo Molnarc9d51282006-03-20 13:44:11 -0500689 mutex_lock(&idmap->idmap_lock);
690 mutex_lock(&idmap->idmap_im_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691
692 he = idmap_lookup_id(h, id);
Harvey Harrison90dc7d22008-02-20 13:03:05 -0800693 if (he) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 memcpy(name, he->ih_name, he->ih_namelen);
695 ret = he->ih_namelen;
696 goto out;
697 }
698
699 memset(im, 0, sizeof(*im));
700 im->im_type = h->h_type;
701 im->im_conv = IDMAP_CONV_IDTONAME;
702 im->im_id = id;
703
704 memset(&msg, 0, sizeof(msg));
705 msg.data = im;
706 msg.len = sizeof(*im);
707
708 add_wait_queue(&idmap->idmap_wq, &wq);
709
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300710 if (rpc_queue_upcall(idmap->idmap_pipe, &msg) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 remove_wait_queue(&idmap->idmap_wq, &wq);
712 goto out;
713 }
714
715 set_current_state(TASK_UNINTERRUPTIBLE);
Ingo Molnarc9d51282006-03-20 13:44:11 -0500716 mutex_unlock(&idmap->idmap_im_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 schedule();
Milind Arun Choudharyfee7f232007-04-26 00:29:03 -0700718 __set_current_state(TASK_RUNNING);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 remove_wait_queue(&idmap->idmap_wq, &wq);
Ingo Molnarc9d51282006-03-20 13:44:11 -0500720 mutex_lock(&idmap->idmap_im_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721
722 if (im->im_status & IDMAP_STATUS_SUCCESS) {
723 if ((len = strnlen(im->im_name, IDMAP_NAMESZ)) == 0)
724 goto out;
725 memcpy(name, im->im_name, len);
726 ret = len;
727 }
728
729 out:
730 memset(im, 0, sizeof(*im));
Ingo Molnarc9d51282006-03-20 13:44:11 -0500731 mutex_unlock(&idmap->idmap_im_lock);
732 mutex_unlock(&idmap->idmap_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 return ret;
734}
735
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736static ssize_t
737idmap_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
738{
Chuck Lever369af0f2007-12-20 14:54:35 -0500739 struct rpc_inode *rpci = RPC_I(filp->f_path.dentry->d_inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 struct idmap *idmap = (struct idmap *)rpci->private;
741 struct idmap_msg im_in, *im = &idmap->idmap_im;
742 struct idmap_hashtable *h;
743 struct idmap_hashent *he = NULL;
Chuck Leverd24aae42007-12-20 14:54:49 -0500744 size_t namelen_in;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 int ret;
746
Chuck Lever369af0f2007-12-20 14:54:35 -0500747 if (mlen != sizeof(im_in))
748 return -ENOSPC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749
Chuck Lever369af0f2007-12-20 14:54:35 -0500750 if (copy_from_user(&im_in, src, mlen) != 0)
751 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752
Ingo Molnarc9d51282006-03-20 13:44:11 -0500753 mutex_lock(&idmap->idmap_im_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754
755 ret = mlen;
756 im->im_status = im_in.im_status;
757 /* If we got an error, terminate now, and wake up pending upcalls */
758 if (!(im_in.im_status & IDMAP_STATUS_SUCCESS)) {
759 wake_up(&idmap->idmap_wq);
760 goto out;
761 }
762
763 /* Sanity checking of strings */
764 ret = -EINVAL;
765 namelen_in = strnlen(im_in.im_name, IDMAP_NAMESZ);
766 if (namelen_in == 0 || namelen_in == IDMAP_NAMESZ)
767 goto out;
768
769 switch (im_in.im_type) {
770 case IDMAP_TYPE_USER:
771 h = &idmap->idmap_user_hash;
772 break;
773 case IDMAP_TYPE_GROUP:
774 h = &idmap->idmap_group_hash;
775 break;
776 default:
777 goto out;
778 }
779
780 switch (im_in.im_conv) {
781 case IDMAP_CONV_IDTONAME:
782 /* Did we match the current upcall? */
783 if (im->im_conv == IDMAP_CONV_IDTONAME
784 && im->im_type == im_in.im_type
785 && im->im_id == im_in.im_id) {
786 /* Yes: copy string, including the terminating '\0' */
787 memcpy(im->im_name, im_in.im_name, namelen_in);
788 im->im_name[namelen_in] = '\0';
789 wake_up(&idmap->idmap_wq);
790 }
791 he = idmap_alloc_id(h, im_in.im_id);
792 break;
793 case IDMAP_CONV_NAMETOID:
794 /* Did we match the current upcall? */
795 if (im->im_conv == IDMAP_CONV_NAMETOID
796 && im->im_type == im_in.im_type
797 && strnlen(im->im_name, IDMAP_NAMESZ) == namelen_in
798 && memcmp(im->im_name, im_in.im_name, namelen_in) == 0) {
799 im->im_id = im_in.im_id;
800 wake_up(&idmap->idmap_wq);
801 }
802 he = idmap_alloc_name(h, im_in.im_name, namelen_in);
803 break;
804 default:
805 goto out;
806 }
807
808 /* If the entry is valid, also copy it to the cache */
809 if (he != NULL)
810 idmap_update_entry(he, im_in.im_name, namelen_in, im_in.im_id);
811 ret = mlen;
812out:
Ingo Molnarc9d51282006-03-20 13:44:11 -0500813 mutex_unlock(&idmap->idmap_im_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 return ret;
815}
816
Adrian Bunk75c96f82005-05-05 16:16:09 -0700817static void
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818idmap_pipe_destroy_msg(struct rpc_pipe_msg *msg)
819{
820 struct idmap_msg *im = msg->data;
821 struct idmap *idmap = container_of(im, struct idmap, idmap_im);
822
823 if (msg->errno >= 0)
824 return;
Ingo Molnarc9d51282006-03-20 13:44:11 -0500825 mutex_lock(&idmap->idmap_im_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 im->im_status = IDMAP_STATUS_LOOKUPFAIL;
827 wake_up(&idmap->idmap_wq);
Ingo Molnarc9d51282006-03-20 13:44:11 -0500828 mutex_unlock(&idmap->idmap_im_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829}
830
831/*
832 * Fowler/Noll/Vo hash
833 * http://www.isthe.com/chongo/tech/comp/fnv/
834 */
835
836#define FNV_P_32 ((unsigned int)0x01000193) /* 16777619 */
837#define FNV_1_32 ((unsigned int)0x811c9dc5) /* 2166136261 */
838
839static unsigned int fnvhash32(const void *buf, size_t buflen)
840{
841 const unsigned char *p, *end = (const unsigned char *)buf + buflen;
842 unsigned int hash = FNV_1_32;
843
844 for (p = buf; p < end; p++) {
845 hash *= FNV_P_32;
846 hash ^= (unsigned int)*p;
847 }
848
Chuck Lever369af0f2007-12-20 14:54:35 -0500849 return hash;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850}
851
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800852int nfs_map_name_to_uid(const struct nfs_server *server, const char *name, size_t namelen, __u32 *uid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800854 struct idmap *idmap = server->nfs_client->cl_idmap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800856 if (nfs_map_string_to_numeric(name, namelen, uid))
857 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 return nfs_idmap_id(idmap, &idmap->idmap_user_hash, name, namelen, uid);
859}
860
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800861int nfs_map_group_to_gid(const struct nfs_server *server, const char *name, size_t namelen, __u32 *uid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800863 struct idmap *idmap = server->nfs_client->cl_idmap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800865 if (nfs_map_string_to_numeric(name, namelen, uid))
866 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 return nfs_idmap_id(idmap, &idmap->idmap_group_hash, name, namelen, uid);
868}
869
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800870int nfs_map_uid_to_name(const struct nfs_server *server, __u32 uid, char *buf, size_t buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800872 struct idmap *idmap = server->nfs_client->cl_idmap;
Trond Myklebustb064eca22011-02-22 15:44:32 -0800873 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
Trond Myklebustb064eca22011-02-22 15:44:32 -0800875 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
876 ret = nfs_idmap_name(idmap, &idmap->idmap_user_hash, uid, buf);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800877 if (ret < 0)
878 ret = nfs_map_numeric_to_string(uid, buf, buflen);
879 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880}
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800881int nfs_map_gid_to_group(const struct nfs_server *server, __u32 uid, char *buf, size_t buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800883 struct idmap *idmap = server->nfs_client->cl_idmap;
Trond Myklebustb064eca22011-02-22 15:44:32 -0800884 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885
Trond Myklebustb064eca22011-02-22 15:44:32 -0800886 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
887 ret = nfs_idmap_name(idmap, &idmap->idmap_group_hash, uid, buf);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800888 if (ret < 0)
889 ret = nfs_map_numeric_to_string(uid, buf, buflen);
890 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891}
892
Bryan Schumaker955a8572010-09-29 15:41:49 -0400893#endif /* CONFIG_NFS_USE_NEW_IDMAPPER */