blob: a1bbf7780dfcec3e1a1dd0c608d3e88842db8820 [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
David Howells700920e2012-01-18 15:31:45 +0000201 set_bit(KEY_FLAG_ROOT_CAN_CLEAR, &keyring->flags);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400202 cred->thread_keyring = keyring;
203 cred->jit_keyring = KEY_REQKEY_DEFL_THREAD_KEYRING;
204 id_resolver_cache = cred;
205 return 0;
206
207failed_put_key:
208 key_put(keyring);
209failed_put_cred:
210 put_cred(cred);
211 return ret;
212}
213
214void nfs_idmap_quit(void)
215{
216 key_revoke(id_resolver_cache->thread_keyring);
217 unregister_key_type(&key_type_id_resolver);
218 put_cred(id_resolver_cache);
219}
220
221/*
222 * Assemble the description to pass to request_key()
223 * This function will allocate a new string and update dest to point
224 * at it. The caller is responsible for freeing dest.
225 *
226 * On error 0 is returned. Otherwise, the length of dest is returned.
227 */
228static ssize_t nfs_idmap_get_desc(const char *name, size_t namelen,
229 const char *type, size_t typelen, char **desc)
230{
231 char *cp;
232 size_t desclen = typelen + namelen + 2;
233
234 *desc = kmalloc(desclen, GFP_KERNEL);
Dan Carpenter8f0d97b2010-10-28 08:05:57 +0200235 if (!*desc)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400236 return -ENOMEM;
237
238 cp = *desc;
239 memcpy(cp, type, typelen);
240 cp += typelen;
241 *cp++ = ':';
242
243 memcpy(cp, name, namelen);
244 cp += namelen;
245 *cp = '\0';
246 return desclen;
247}
248
249static ssize_t nfs_idmap_request_key(const char *name, size_t namelen,
250 const char *type, void *data, size_t data_size)
251{
252 const struct cred *saved_cred;
253 struct key *rkey;
254 char *desc;
255 struct user_key_payload *payload;
256 ssize_t ret;
257
258 ret = nfs_idmap_get_desc(name, namelen, type, strlen(type), &desc);
259 if (ret <= 0)
260 goto out;
261
262 saved_cred = override_creds(id_resolver_cache);
263 rkey = request_key(&key_type_id_resolver, desc, "");
264 revert_creds(saved_cred);
265 kfree(desc);
266 if (IS_ERR(rkey)) {
267 ret = PTR_ERR(rkey);
268 goto out;
269 }
270
271 rcu_read_lock();
272 rkey->perm |= KEY_USR_VIEW;
273
274 ret = key_validate(rkey);
275 if (ret < 0)
276 goto out_up;
277
278 payload = rcu_dereference(rkey->payload.data);
279 if (IS_ERR_OR_NULL(payload)) {
280 ret = PTR_ERR(payload);
281 goto out_up;
282 }
283
284 ret = payload->datalen;
285 if (ret > 0 && ret <= data_size)
286 memcpy(data, payload->data, ret);
287 else
288 ret = -EINVAL;
289
290out_up:
291 rcu_read_unlock();
292 key_put(rkey);
293out:
294 return ret;
295}
296
297
298/* ID -> Name */
299static ssize_t nfs_idmap_lookup_name(__u32 id, const char *type, char *buf, size_t buflen)
300{
301 char id_str[NFS_UINT_MAXLEN];
302 int id_len;
303 ssize_t ret;
304
305 id_len = snprintf(id_str, sizeof(id_str), "%u", id);
306 ret = nfs_idmap_request_key(id_str, id_len, type, buf, buflen);
307 if (ret < 0)
308 return -EINVAL;
309 return ret;
310}
311
312/* Name -> ID */
313static int nfs_idmap_lookup_id(const char *name, size_t namelen,
314 const char *type, __u32 *id)
315{
316 char id_str[NFS_UINT_MAXLEN];
317 long id_long;
318 ssize_t data_size;
319 int ret = 0;
320
321 data_size = nfs_idmap_request_key(name, namelen, type, id_str, NFS_UINT_MAXLEN);
322 if (data_size <= 0) {
323 ret = -EINVAL;
324 } else {
325 ret = strict_strtol(id_str, 10, &id_long);
326 *id = (__u32)id_long;
327 }
328 return ret;
329}
330
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800331int 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 -0400332{
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800333 if (nfs_map_string_to_numeric(name, namelen, uid))
334 return 0;
Bryan Schumaker955a8572010-09-29 15:41:49 -0400335 return nfs_idmap_lookup_id(name, namelen, "uid", uid);
336}
337
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800338int 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 -0400339{
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800340 if (nfs_map_string_to_numeric(name, namelen, gid))
341 return 0;
Bryan Schumaker955a8572010-09-29 15:41:49 -0400342 return nfs_idmap_lookup_id(name, namelen, "gid", gid);
343}
344
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800345int nfs_map_uid_to_name(const struct nfs_server *server, __u32 uid, char *buf, size_t buflen)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400346{
Trond Myklebustb064eca22011-02-22 15:44:32 -0800347 int ret = -EINVAL;
348
349 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
350 ret = nfs_idmap_lookup_name(uid, "user", buf, buflen);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800351 if (ret < 0)
352 ret = nfs_map_numeric_to_string(uid, buf, buflen);
353 return ret;
Bryan Schumaker955a8572010-09-29 15:41:49 -0400354}
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800355int nfs_map_gid_to_group(const struct nfs_server *server, __u32 gid, char *buf, size_t buflen)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400356{
Trond Myklebustb064eca22011-02-22 15:44:32 -0800357 int ret = -EINVAL;
Trond Myklebustf0b85162011-02-22 15:44:31 -0800358
Trond Myklebustb064eca22011-02-22 15:44:32 -0800359 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
360 ret = nfs_idmap_lookup_name(gid, "group", buf, buflen);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800361 if (ret < 0)
362 ret = nfs_map_numeric_to_string(gid, buf, buflen);
363 return ret;
Bryan Schumaker955a8572010-09-29 15:41:49 -0400364}
365
J. Bruce Fields5f3e97c2010-12-21 23:49:34 +0000366#else /* CONFIG_NFS_USE_NEW_IDMAPPER not defined */
Bryan Schumaker955a8572010-09-29 15:41:49 -0400367
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368#include <linux/module.h>
Ingo Molnarc9d51282006-03-20 13:44:11 -0500369#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371#include <linux/socket.h>
372#include <linux/in.h>
373#include <linux/sched.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374#include <linux/sunrpc/clnt.h>
375#include <linux/workqueue.h>
376#include <linux/sunrpc/rpc_pipe_fs.h>
377
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378#include <linux/nfs_fs.h>
379
Trond Myklebust4ce79712005-06-22 17:16:21 +0000380#include "nfs4_fs.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381
382#define IDMAP_HASH_SZ 128
383
Trond Myklebust58df0952006-01-03 09:55:57 +0100384/* Default cache timeout is 10 minutes */
385unsigned int nfs_idmap_cache_timeout = 600 * HZ;
386
David Howells7d4e2742006-08-22 20:06:07 -0400387static int param_set_idmap_timeout(const char *val, struct kernel_param *kp)
388{
389 char *endp;
390 int num = simple_strtol(val, &endp, 0);
391 int jif = num * HZ;
392 if (endp == val || *endp || num < 0 || jif < num)
393 return -EINVAL;
394 *((int *)kp->arg) = jif;
395 return 0;
396}
397
398module_param_call(idmap_cache_timeout, param_set_idmap_timeout, param_get_int,
399 &nfs_idmap_cache_timeout, 0644);
400
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401struct idmap_hashent {
Chuck Lever369af0f2007-12-20 14:54:35 -0500402 unsigned long ih_expires;
403 __u32 ih_id;
Chuck Leverd24aae42007-12-20 14:54:49 -0500404 size_t ih_namelen;
Chuck Lever369af0f2007-12-20 14:54:35 -0500405 char ih_name[IDMAP_NAMESZ];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406};
407
408struct idmap_hashtable {
Chuck Lever369af0f2007-12-20 14:54:35 -0500409 __u8 h_type;
410 struct idmap_hashent h_entries[IDMAP_HASH_SZ];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411};
412
413struct idmap {
Chuck Lever369af0f2007-12-20 14:54:35 -0500414 struct dentry *idmap_dentry;
415 wait_queue_head_t idmap_wq;
416 struct idmap_msg idmap_im;
417 struct mutex idmap_lock; /* Serializes upcalls */
418 struct mutex idmap_im_lock; /* Protects the hashtable */
419 struct idmap_hashtable idmap_user_hash;
420 struct idmap_hashtable idmap_group_hash;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421};
422
Chuck Lever369af0f2007-12-20 14:54:35 -0500423static ssize_t idmap_pipe_downcall(struct file *, const char __user *,
424 size_t);
425static void idmap_pipe_destroy_msg(struct rpc_pipe_msg *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426
427static unsigned int fnvhash32(const void *, size_t);
428
Trond Myklebustb693ba42009-08-09 15:14:15 -0400429static const struct rpc_pipe_ops idmap_upcall_ops = {
Peng Taoc1225152011-09-22 21:50:10 -0400430 .upcall = rpc_pipe_generic_upcall,
Chuck Lever369af0f2007-12-20 14:54:35 -0500431 .downcall = idmap_pipe_downcall,
432 .destroy_msg = idmap_pipe_destroy_msg,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433};
434
David Howellsb7162792006-08-22 20:06:09 -0400435int
David Howellsadfa6f92006-08-22 20:06:08 -0400436nfs_idmap_new(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437{
438 struct idmap *idmap;
David Howellsb7162792006-08-22 20:06:09 -0400439 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440
David Howells54ceac42006-08-22 20:06:13 -0400441 BUG_ON(clp->cl_idmap != NULL);
David Howellsb7162792006-08-22 20:06:09 -0400442
Chuck Lever369af0f2007-12-20 14:54:35 -0500443 idmap = kzalloc(sizeof(*idmap), GFP_KERNEL);
444 if (idmap == NULL)
445 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446
Trond Myklebust7d217ca2009-08-09 15:14:24 -0400447 idmap->idmap_dentry = rpc_mkpipe(clp->cl_rpcclient->cl_path.dentry,
448 "idmap", idmap, &idmap_upcall_ops, 0);
Chuck Lever369af0f2007-12-20 14:54:35 -0500449 if (IS_ERR(idmap->idmap_dentry)) {
David Howellsb7162792006-08-22 20:06:09 -0400450 error = PTR_ERR(idmap->idmap_dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 kfree(idmap);
David Howellsb7162792006-08-22 20:06:09 -0400452 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 }
454
Chuck Lever369af0f2007-12-20 14:54:35 -0500455 mutex_init(&idmap->idmap_lock);
456 mutex_init(&idmap->idmap_im_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 init_waitqueue_head(&idmap->idmap_wq);
458 idmap->idmap_user_hash.h_type = IDMAP_TYPE_USER;
459 idmap->idmap_group_hash.h_type = IDMAP_TYPE_GROUP;
460
461 clp->cl_idmap = idmap;
David Howellsb7162792006-08-22 20:06:09 -0400462 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463}
464
465void
David Howellsadfa6f92006-08-22 20:06:08 -0400466nfs_idmap_delete(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467{
468 struct idmap *idmap = clp->cl_idmap;
469
470 if (!idmap)
471 return;
Trond Myklebust5d674762006-07-31 14:11:48 -0700472 rpc_unlink(idmap->idmap_dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 clp->cl_idmap = NULL;
474 kfree(idmap);
475}
476
477/*
478 * Helper routines for manipulating the hashtable
479 */
480static inline struct idmap_hashent *
481idmap_name_hash(struct idmap_hashtable* h, const char *name, size_t len)
482{
483 return &h->h_entries[fnvhash32(name, len) % IDMAP_HASH_SZ];
484}
485
486static struct idmap_hashent *
487idmap_lookup_name(struct idmap_hashtable *h, const char *name, size_t len)
488{
489 struct idmap_hashent *he = idmap_name_hash(h, name, len);
490
491 if (he->ih_namelen != len || memcmp(he->ih_name, name, len) != 0)
492 return NULL;
Trond Myklebust58df0952006-01-03 09:55:57 +0100493 if (time_after(jiffies, he->ih_expires))
494 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 return he;
496}
497
498static inline struct idmap_hashent *
499idmap_id_hash(struct idmap_hashtable* h, __u32 id)
500{
501 return &h->h_entries[fnvhash32(&id, sizeof(id)) % IDMAP_HASH_SZ];
502}
503
504static struct idmap_hashent *
505idmap_lookup_id(struct idmap_hashtable *h, __u32 id)
506{
507 struct idmap_hashent *he = idmap_id_hash(h, id);
508 if (he->ih_id != id || he->ih_namelen == 0)
509 return NULL;
Trond Myklebust58df0952006-01-03 09:55:57 +0100510 if (time_after(jiffies, he->ih_expires))
511 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 return he;
513}
514
515/*
516 * Routines for allocating new entries in the hashtable.
517 * For now, we just have 1 entry per bucket, so it's all
518 * pretty trivial.
519 */
520static inline struct idmap_hashent *
Chuck Leverd24aae42007-12-20 14:54:49 -0500521idmap_alloc_name(struct idmap_hashtable *h, char *name, size_t len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522{
523 return idmap_name_hash(h, name, len);
524}
525
526static inline struct idmap_hashent *
527idmap_alloc_id(struct idmap_hashtable *h, __u32 id)
528{
529 return idmap_id_hash(h, id);
530}
531
532static void
533idmap_update_entry(struct idmap_hashent *he, const char *name,
534 size_t namelen, __u32 id)
535{
536 he->ih_id = id;
537 memcpy(he->ih_name, name, namelen);
538 he->ih_name[namelen] = '\0';
539 he->ih_namelen = namelen;
Trond Myklebust58df0952006-01-03 09:55:57 +0100540 he->ih_expires = jiffies + nfs_idmap_cache_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541}
542
543/*
544 * Name -> ID
545 */
546static int
547nfs_idmap_id(struct idmap *idmap, struct idmap_hashtable *h,
548 const char *name, size_t namelen, __u32 *id)
549{
550 struct rpc_pipe_msg msg;
551 struct idmap_msg *im;
552 struct idmap_hashent *he;
553 DECLARE_WAITQUEUE(wq, current);
554 int ret = -EIO;
555
556 im = &idmap->idmap_im;
557
558 /*
559 * String sanity checks
560 * Note that the userland daemon expects NUL terminated strings
561 */
562 for (;;) {
563 if (namelen == 0)
564 return -EINVAL;
565 if (name[namelen-1] != '\0')
566 break;
567 namelen--;
568 }
569 if (namelen >= IDMAP_NAMESZ)
570 return -EINVAL;
571
Ingo Molnarc9d51282006-03-20 13:44:11 -0500572 mutex_lock(&idmap->idmap_lock);
573 mutex_lock(&idmap->idmap_im_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574
575 he = idmap_lookup_name(h, name, namelen);
576 if (he != NULL) {
577 *id = he->ih_id;
578 ret = 0;
579 goto out;
580 }
581
582 memset(im, 0, sizeof(*im));
583 memcpy(im->im_name, name, namelen);
584
585 im->im_type = h->h_type;
586 im->im_conv = IDMAP_CONV_NAMETOID;
587
588 memset(&msg, 0, sizeof(msg));
589 msg.data = im;
590 msg.len = sizeof(*im);
591
592 add_wait_queue(&idmap->idmap_wq, &wq);
593 if (rpc_queue_upcall(idmap->idmap_dentry->d_inode, &msg) < 0) {
594 remove_wait_queue(&idmap->idmap_wq, &wq);
595 goto out;
596 }
597
598 set_current_state(TASK_UNINTERRUPTIBLE);
Ingo Molnarc9d51282006-03-20 13:44:11 -0500599 mutex_unlock(&idmap->idmap_im_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 schedule();
Milind Arun Choudharyfee7f232007-04-26 00:29:03 -0700601 __set_current_state(TASK_RUNNING);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 remove_wait_queue(&idmap->idmap_wq, &wq);
Ingo Molnarc9d51282006-03-20 13:44:11 -0500603 mutex_lock(&idmap->idmap_im_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604
605 if (im->im_status & IDMAP_STATUS_SUCCESS) {
606 *id = im->im_id;
607 ret = 0;
608 }
609
610 out:
611 memset(im, 0, sizeof(*im));
Ingo Molnarc9d51282006-03-20 13:44:11 -0500612 mutex_unlock(&idmap->idmap_im_lock);
613 mutex_unlock(&idmap->idmap_lock);
Chuck Lever369af0f2007-12-20 14:54:35 -0500614 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615}
616
617/*
618 * ID -> Name
619 */
620static int
621nfs_idmap_name(struct idmap *idmap, struct idmap_hashtable *h,
622 __u32 id, char *name)
623{
624 struct rpc_pipe_msg msg;
625 struct idmap_msg *im;
626 struct idmap_hashent *he;
627 DECLARE_WAITQUEUE(wq, current);
628 int ret = -EIO;
629 unsigned int len;
630
631 im = &idmap->idmap_im;
632
Ingo Molnarc9d51282006-03-20 13:44:11 -0500633 mutex_lock(&idmap->idmap_lock);
634 mutex_lock(&idmap->idmap_im_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635
636 he = idmap_lookup_id(h, id);
Harvey Harrison90dc7d22008-02-20 13:03:05 -0800637 if (he) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 memcpy(name, he->ih_name, he->ih_namelen);
639 ret = he->ih_namelen;
640 goto out;
641 }
642
643 memset(im, 0, sizeof(*im));
644 im->im_type = h->h_type;
645 im->im_conv = IDMAP_CONV_IDTONAME;
646 im->im_id = id;
647
648 memset(&msg, 0, sizeof(msg));
649 msg.data = im;
650 msg.len = sizeof(*im);
651
652 add_wait_queue(&idmap->idmap_wq, &wq);
653
654 if (rpc_queue_upcall(idmap->idmap_dentry->d_inode, &msg) < 0) {
655 remove_wait_queue(&idmap->idmap_wq, &wq);
656 goto out;
657 }
658
659 set_current_state(TASK_UNINTERRUPTIBLE);
Ingo Molnarc9d51282006-03-20 13:44:11 -0500660 mutex_unlock(&idmap->idmap_im_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 schedule();
Milind Arun Choudharyfee7f232007-04-26 00:29:03 -0700662 __set_current_state(TASK_RUNNING);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 remove_wait_queue(&idmap->idmap_wq, &wq);
Ingo Molnarc9d51282006-03-20 13:44:11 -0500664 mutex_lock(&idmap->idmap_im_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665
666 if (im->im_status & IDMAP_STATUS_SUCCESS) {
667 if ((len = strnlen(im->im_name, IDMAP_NAMESZ)) == 0)
668 goto out;
669 memcpy(name, im->im_name, len);
670 ret = len;
671 }
672
673 out:
674 memset(im, 0, sizeof(*im));
Ingo Molnarc9d51282006-03-20 13:44:11 -0500675 mutex_unlock(&idmap->idmap_im_lock);
676 mutex_unlock(&idmap->idmap_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 return ret;
678}
679
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680static ssize_t
681idmap_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
682{
Chuck Lever369af0f2007-12-20 14:54:35 -0500683 struct rpc_inode *rpci = RPC_I(filp->f_path.dentry->d_inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 struct idmap *idmap = (struct idmap *)rpci->private;
685 struct idmap_msg im_in, *im = &idmap->idmap_im;
686 struct idmap_hashtable *h;
687 struct idmap_hashent *he = NULL;
Chuck Leverd24aae42007-12-20 14:54:49 -0500688 size_t namelen_in;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 int ret;
690
Chuck Lever369af0f2007-12-20 14:54:35 -0500691 if (mlen != sizeof(im_in))
692 return -ENOSPC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693
Chuck Lever369af0f2007-12-20 14:54:35 -0500694 if (copy_from_user(&im_in, src, mlen) != 0)
695 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696
Ingo Molnarc9d51282006-03-20 13:44:11 -0500697 mutex_lock(&idmap->idmap_im_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698
699 ret = mlen;
700 im->im_status = im_in.im_status;
701 /* If we got an error, terminate now, and wake up pending upcalls */
702 if (!(im_in.im_status & IDMAP_STATUS_SUCCESS)) {
703 wake_up(&idmap->idmap_wq);
704 goto out;
705 }
706
707 /* Sanity checking of strings */
708 ret = -EINVAL;
709 namelen_in = strnlen(im_in.im_name, IDMAP_NAMESZ);
710 if (namelen_in == 0 || namelen_in == IDMAP_NAMESZ)
711 goto out;
712
713 switch (im_in.im_type) {
714 case IDMAP_TYPE_USER:
715 h = &idmap->idmap_user_hash;
716 break;
717 case IDMAP_TYPE_GROUP:
718 h = &idmap->idmap_group_hash;
719 break;
720 default:
721 goto out;
722 }
723
724 switch (im_in.im_conv) {
725 case IDMAP_CONV_IDTONAME:
726 /* Did we match the current upcall? */
727 if (im->im_conv == IDMAP_CONV_IDTONAME
728 && im->im_type == im_in.im_type
729 && im->im_id == im_in.im_id) {
730 /* Yes: copy string, including the terminating '\0' */
731 memcpy(im->im_name, im_in.im_name, namelen_in);
732 im->im_name[namelen_in] = '\0';
733 wake_up(&idmap->idmap_wq);
734 }
735 he = idmap_alloc_id(h, im_in.im_id);
736 break;
737 case IDMAP_CONV_NAMETOID:
738 /* Did we match the current upcall? */
739 if (im->im_conv == IDMAP_CONV_NAMETOID
740 && im->im_type == im_in.im_type
741 && strnlen(im->im_name, IDMAP_NAMESZ) == namelen_in
742 && memcmp(im->im_name, im_in.im_name, namelen_in) == 0) {
743 im->im_id = im_in.im_id;
744 wake_up(&idmap->idmap_wq);
745 }
746 he = idmap_alloc_name(h, im_in.im_name, namelen_in);
747 break;
748 default:
749 goto out;
750 }
751
752 /* If the entry is valid, also copy it to the cache */
753 if (he != NULL)
754 idmap_update_entry(he, im_in.im_name, namelen_in, im_in.im_id);
755 ret = mlen;
756out:
Ingo Molnarc9d51282006-03-20 13:44:11 -0500757 mutex_unlock(&idmap->idmap_im_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 return ret;
759}
760
Adrian Bunk75c96f82005-05-05 16:16:09 -0700761static void
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762idmap_pipe_destroy_msg(struct rpc_pipe_msg *msg)
763{
764 struct idmap_msg *im = msg->data;
765 struct idmap *idmap = container_of(im, struct idmap, idmap_im);
766
767 if (msg->errno >= 0)
768 return;
Ingo Molnarc9d51282006-03-20 13:44:11 -0500769 mutex_lock(&idmap->idmap_im_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 im->im_status = IDMAP_STATUS_LOOKUPFAIL;
771 wake_up(&idmap->idmap_wq);
Ingo Molnarc9d51282006-03-20 13:44:11 -0500772 mutex_unlock(&idmap->idmap_im_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773}
774
775/*
776 * Fowler/Noll/Vo hash
777 * http://www.isthe.com/chongo/tech/comp/fnv/
778 */
779
780#define FNV_P_32 ((unsigned int)0x01000193) /* 16777619 */
781#define FNV_1_32 ((unsigned int)0x811c9dc5) /* 2166136261 */
782
783static unsigned int fnvhash32(const void *buf, size_t buflen)
784{
785 const unsigned char *p, *end = (const unsigned char *)buf + buflen;
786 unsigned int hash = FNV_1_32;
787
788 for (p = buf; p < end; p++) {
789 hash *= FNV_P_32;
790 hash ^= (unsigned int)*p;
791 }
792
Chuck Lever369af0f2007-12-20 14:54:35 -0500793 return hash;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794}
795
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800796int 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 -0700797{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800798 struct idmap *idmap = server->nfs_client->cl_idmap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800800 if (nfs_map_string_to_numeric(name, namelen, uid))
801 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 return nfs_idmap_id(idmap, &idmap->idmap_user_hash, name, namelen, uid);
803}
804
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800805int 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 -0700806{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800807 struct idmap *idmap = server->nfs_client->cl_idmap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800809 if (nfs_map_string_to_numeric(name, namelen, uid))
810 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 return nfs_idmap_id(idmap, &idmap->idmap_group_hash, name, namelen, uid);
812}
813
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800814int nfs_map_uid_to_name(const struct nfs_server *server, __u32 uid, char *buf, size_t buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800816 struct idmap *idmap = server->nfs_client->cl_idmap;
Trond Myklebustb064eca22011-02-22 15:44:32 -0800817 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818
Trond Myklebustb064eca22011-02-22 15:44:32 -0800819 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
820 ret = nfs_idmap_name(idmap, &idmap->idmap_user_hash, uid, buf);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800821 if (ret < 0)
822 ret = nfs_map_numeric_to_string(uid, buf, buflen);
823 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824}
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800825int nfs_map_gid_to_group(const struct nfs_server *server, __u32 uid, char *buf, size_t buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800827 struct idmap *idmap = server->nfs_client->cl_idmap;
Trond Myklebustb064eca22011-02-22 15:44:32 -0800828 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829
Trond Myklebustb064eca22011-02-22 15:44:32 -0800830 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
831 ret = nfs_idmap_name(idmap, &idmap->idmap_group_hash, uid, buf);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800832 if (ret < 0)
833 ret = nfs_map_numeric_to_string(uid, buf, buflen);
834 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835}
836
Bryan Schumaker955a8572010-09-29 15:41:49 -0400837#endif /* CONFIG_NFS_USE_NEW_IDMAPPER */