4 * UID and GID to name mapping for clients.
6 * Copyright (c) 2002 The Regents of the University of Michigan.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
36 #include <linux/types.h>
37 #include <linux/string.h>
38 #include <linux/kernel.h>
40 static int nfs_map_string_to_numeric(const char *name, size_t namelen, __u32 *res)
45 if (memchr(name, '@', namelen) != NULL || namelen >= sizeof(buf))
47 memcpy(buf, name, namelen);
49 if (strict_strtoul(buf, 0, &val) != 0)
55 static int nfs_map_numeric_to_string(__u32 id, char *buf, size_t buflen)
57 return snprintf(buf, buflen, "%u", id);
60 #ifdef CONFIG_NFS_USE_NEW_IDMAPPER
62 #include <linux/slab.h>
63 #include <linux/cred.h>
64 #include <linux/sunrpc/sched.h>
65 #include <linux/nfs4.h>
66 #include <linux/nfs_fs_sb.h>
67 #include <linux/nfs_idmap.h>
68 #include <linux/keyctl.h>
69 #include <linux/key-type.h>
70 #include <linux/rcupdate.h>
71 #include <linux/err.h>
73 #include <keys/user-type.h>
75 #define NFS_UINT_MAXLEN 11
77 const struct cred *id_resolver_cache;
79 struct key_type key_type_id_resolver = {
80 .name = "id_resolver",
81 .instantiate = user_instantiate,
83 .revoke = user_revoke,
84 .destroy = user_destroy,
85 .describe = user_describe,
89 int nfs_idmap_init(void)
95 printk(KERN_NOTICE "Registering the %s key type\n", key_type_id_resolver.name);
97 cred = prepare_kernel_cred(NULL);
101 keyring = key_alloc(&key_type_keyring, ".id_resolver", 0, 0, cred,
102 (KEY_POS_ALL & ~KEY_POS_SETATTR) |
103 KEY_USR_VIEW | KEY_USR_READ,
104 KEY_ALLOC_NOT_IN_QUOTA);
105 if (IS_ERR(keyring)) {
106 ret = PTR_ERR(keyring);
107 goto failed_put_cred;
110 ret = key_instantiate_and_link(keyring, NULL, 0, NULL, NULL);
114 ret = register_key_type(&key_type_id_resolver);
118 cred->thread_keyring = keyring;
119 cred->jit_keyring = KEY_REQKEY_DEFL_THREAD_KEYRING;
120 id_resolver_cache = cred;
130 void nfs_idmap_quit(void)
132 key_revoke(id_resolver_cache->thread_keyring);
133 unregister_key_type(&key_type_id_resolver);
134 put_cred(id_resolver_cache);
138 * Assemble the description to pass to request_key()
139 * This function will allocate a new string and update dest to point
140 * at it. The caller is responsible for freeing dest.
142 * On error 0 is returned. Otherwise, the length of dest is returned.
144 static ssize_t nfs_idmap_get_desc(const char *name, size_t namelen,
145 const char *type, size_t typelen, char **desc)
148 size_t desclen = typelen + namelen + 2;
150 *desc = kmalloc(desclen, GFP_KERNEL);
155 memcpy(cp, type, typelen);
159 memcpy(cp, name, namelen);
165 static ssize_t nfs_idmap_request_key(const char *name, size_t namelen,
166 const char *type, void *data, size_t data_size)
168 const struct cred *saved_cred;
171 struct user_key_payload *payload;
174 ret = nfs_idmap_get_desc(name, namelen, type, strlen(type), &desc);
178 saved_cred = override_creds(id_resolver_cache);
179 rkey = request_key(&key_type_id_resolver, desc, "");
180 revert_creds(saved_cred);
188 rkey->perm |= KEY_USR_VIEW;
190 ret = key_validate(rkey);
194 payload = rcu_dereference(rkey->payload.data);
195 if (IS_ERR_OR_NULL(payload)) {
196 ret = PTR_ERR(payload);
200 ret = payload->datalen;
201 if (ret > 0 && ret <= data_size)
202 memcpy(data, payload->data, ret);
215 static ssize_t nfs_idmap_lookup_name(__u32 id, const char *type, char *buf, size_t buflen)
217 char id_str[NFS_UINT_MAXLEN];
221 id_len = snprintf(id_str, sizeof(id_str), "%u", id);
222 ret = nfs_idmap_request_key(id_str, id_len, type, buf, buflen);
229 static int nfs_idmap_lookup_id(const char *name, size_t namelen,
230 const char *type, __u32 *id)
232 char id_str[NFS_UINT_MAXLEN];
237 data_size = nfs_idmap_request_key(name, namelen, type, id_str, NFS_UINT_MAXLEN);
238 if (data_size <= 0) {
241 ret = strict_strtol(id_str, 10, &id_long);
242 *id = (__u32)id_long;
247 int nfs_map_name_to_uid(const struct nfs_server *server, const char *name, size_t namelen, __u32 *uid)
249 if (nfs_map_string_to_numeric(name, namelen, uid))
251 return nfs_idmap_lookup_id(name, namelen, "uid", uid);
254 int nfs_map_group_to_gid(const struct nfs_server *server, const char *name, size_t namelen, __u32 *gid)
256 if (nfs_map_string_to_numeric(name, namelen, gid))
258 return nfs_idmap_lookup_id(name, namelen, "gid", gid);
261 int nfs_map_uid_to_name(const struct nfs_server *server, __u32 uid, char *buf, size_t buflen)
265 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
266 ret = nfs_idmap_lookup_name(uid, "user", buf, buflen);
268 ret = nfs_map_numeric_to_string(uid, buf, buflen);
271 int nfs_map_gid_to_group(const struct nfs_server *server, __u32 gid, char *buf, size_t buflen)
275 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
276 ret = nfs_idmap_lookup_name(gid, "group", buf, buflen);
278 ret = nfs_map_numeric_to_string(gid, buf, buflen);
282 #else /* CONFIG_NFS_USE_NEW_IDMAPPER not defined */
284 #include <linux/module.h>
285 #include <linux/mutex.h>
286 #include <linux/init.h>
287 #include <linux/slab.h>
288 #include <linux/socket.h>
289 #include <linux/in.h>
290 #include <linux/sched.h>
292 #include <linux/sunrpc/clnt.h>
293 #include <linux/workqueue.h>
294 #include <linux/sunrpc/rpc_pipe_fs.h>
296 #include <linux/nfs_fs.h>
298 #include <linux/nfs_idmap.h>
301 #define IDMAP_HASH_SZ 128
303 /* Default cache timeout is 10 minutes */
304 unsigned int nfs_idmap_cache_timeout = 600 * HZ;
306 static int param_set_idmap_timeout(const char *val, struct kernel_param *kp)
309 int num = simple_strtol(val, &endp, 0);
311 if (endp == val || *endp || num < 0 || jif < num)
313 *((int *)kp->arg) = jif;
317 module_param_call(idmap_cache_timeout, param_set_idmap_timeout, param_get_int,
318 &nfs_idmap_cache_timeout, 0644);
320 struct idmap_hashent {
321 unsigned long ih_expires;
324 char ih_name[IDMAP_NAMESZ];
327 struct idmap_hashtable {
329 struct idmap_hashent h_entries[IDMAP_HASH_SZ];
333 struct dentry *idmap_dentry;
334 wait_queue_head_t idmap_wq;
335 struct idmap_msg idmap_im;
336 struct mutex idmap_lock; /* Serializes upcalls */
337 struct mutex idmap_im_lock; /* Protects the hashtable */
338 struct idmap_hashtable idmap_user_hash;
339 struct idmap_hashtable idmap_group_hash;
342 static ssize_t idmap_pipe_upcall(struct file *, struct rpc_pipe_msg *,
343 char __user *, size_t);
344 static ssize_t idmap_pipe_downcall(struct file *, const char __user *,
346 static void idmap_pipe_destroy_msg(struct rpc_pipe_msg *);
348 static unsigned int fnvhash32(const void *, size_t);
350 static const struct rpc_pipe_ops idmap_upcall_ops = {
351 .upcall = idmap_pipe_upcall,
352 .downcall = idmap_pipe_downcall,
353 .destroy_msg = idmap_pipe_destroy_msg,
357 nfs_idmap_new(struct nfs_client *clp)
362 BUG_ON(clp->cl_idmap != NULL);
364 idmap = kzalloc(sizeof(*idmap), GFP_KERNEL);
368 idmap->idmap_dentry = rpc_mkpipe(clp->cl_rpcclient->cl_path.dentry,
369 "idmap", idmap, &idmap_upcall_ops, 0);
370 if (IS_ERR(idmap->idmap_dentry)) {
371 error = PTR_ERR(idmap->idmap_dentry);
376 mutex_init(&idmap->idmap_lock);
377 mutex_init(&idmap->idmap_im_lock);
378 init_waitqueue_head(&idmap->idmap_wq);
379 idmap->idmap_user_hash.h_type = IDMAP_TYPE_USER;
380 idmap->idmap_group_hash.h_type = IDMAP_TYPE_GROUP;
382 clp->cl_idmap = idmap;
387 nfs_idmap_delete(struct nfs_client *clp)
389 struct idmap *idmap = clp->cl_idmap;
393 rpc_unlink(idmap->idmap_dentry);
394 clp->cl_idmap = NULL;
399 * Helper routines for manipulating the hashtable
401 static inline struct idmap_hashent *
402 idmap_name_hash(struct idmap_hashtable* h, const char *name, size_t len)
404 return &h->h_entries[fnvhash32(name, len) % IDMAP_HASH_SZ];
407 static struct idmap_hashent *
408 idmap_lookup_name(struct idmap_hashtable *h, const char *name, size_t len)
410 struct idmap_hashent *he = idmap_name_hash(h, name, len);
412 if (he->ih_namelen != len || memcmp(he->ih_name, name, len) != 0)
414 if (time_after(jiffies, he->ih_expires))
419 static inline struct idmap_hashent *
420 idmap_id_hash(struct idmap_hashtable* h, __u32 id)
422 return &h->h_entries[fnvhash32(&id, sizeof(id)) % IDMAP_HASH_SZ];
425 static struct idmap_hashent *
426 idmap_lookup_id(struct idmap_hashtable *h, __u32 id)
428 struct idmap_hashent *he = idmap_id_hash(h, id);
429 if (he->ih_id != id || he->ih_namelen == 0)
431 if (time_after(jiffies, he->ih_expires))
437 * Routines for allocating new entries in the hashtable.
438 * For now, we just have 1 entry per bucket, so it's all
441 static inline struct idmap_hashent *
442 idmap_alloc_name(struct idmap_hashtable *h, char *name, size_t len)
444 return idmap_name_hash(h, name, len);
447 static inline struct idmap_hashent *
448 idmap_alloc_id(struct idmap_hashtable *h, __u32 id)
450 return idmap_id_hash(h, id);
454 idmap_update_entry(struct idmap_hashent *he, const char *name,
455 size_t namelen, __u32 id)
458 memcpy(he->ih_name, name, namelen);
459 he->ih_name[namelen] = '\0';
460 he->ih_namelen = namelen;
461 he->ih_expires = jiffies + nfs_idmap_cache_timeout;
468 nfs_idmap_id(struct idmap *idmap, struct idmap_hashtable *h,
469 const char *name, size_t namelen, __u32 *id)
471 struct rpc_pipe_msg msg;
472 struct idmap_msg *im;
473 struct idmap_hashent *he;
474 DECLARE_WAITQUEUE(wq, current);
477 im = &idmap->idmap_im;
480 * String sanity checks
481 * Note that the userland daemon expects NUL terminated strings
486 if (name[namelen-1] != '\0')
490 if (namelen >= IDMAP_NAMESZ)
493 mutex_lock(&idmap->idmap_lock);
494 mutex_lock(&idmap->idmap_im_lock);
496 he = idmap_lookup_name(h, name, namelen);
503 memset(im, 0, sizeof(*im));
504 memcpy(im->im_name, name, namelen);
506 im->im_type = h->h_type;
507 im->im_conv = IDMAP_CONV_NAMETOID;
509 memset(&msg, 0, sizeof(msg));
511 msg.len = sizeof(*im);
513 add_wait_queue(&idmap->idmap_wq, &wq);
514 if (rpc_queue_upcall(idmap->idmap_dentry->d_inode, &msg) < 0) {
515 remove_wait_queue(&idmap->idmap_wq, &wq);
519 set_current_state(TASK_UNINTERRUPTIBLE);
520 mutex_unlock(&idmap->idmap_im_lock);
522 __set_current_state(TASK_RUNNING);
523 remove_wait_queue(&idmap->idmap_wq, &wq);
524 mutex_lock(&idmap->idmap_im_lock);
526 if (im->im_status & IDMAP_STATUS_SUCCESS) {
532 memset(im, 0, sizeof(*im));
533 mutex_unlock(&idmap->idmap_im_lock);
534 mutex_unlock(&idmap->idmap_lock);
542 nfs_idmap_name(struct idmap *idmap, struct idmap_hashtable *h,
543 __u32 id, char *name)
545 struct rpc_pipe_msg msg;
546 struct idmap_msg *im;
547 struct idmap_hashent *he;
548 DECLARE_WAITQUEUE(wq, current);
552 im = &idmap->idmap_im;
554 mutex_lock(&idmap->idmap_lock);
555 mutex_lock(&idmap->idmap_im_lock);
557 he = idmap_lookup_id(h, id);
559 memcpy(name, he->ih_name, he->ih_namelen);
560 ret = he->ih_namelen;
564 memset(im, 0, sizeof(*im));
565 im->im_type = h->h_type;
566 im->im_conv = IDMAP_CONV_IDTONAME;
569 memset(&msg, 0, sizeof(msg));
571 msg.len = sizeof(*im);
573 add_wait_queue(&idmap->idmap_wq, &wq);
575 if (rpc_queue_upcall(idmap->idmap_dentry->d_inode, &msg) < 0) {
576 remove_wait_queue(&idmap->idmap_wq, &wq);
580 set_current_state(TASK_UNINTERRUPTIBLE);
581 mutex_unlock(&idmap->idmap_im_lock);
583 __set_current_state(TASK_RUNNING);
584 remove_wait_queue(&idmap->idmap_wq, &wq);
585 mutex_lock(&idmap->idmap_im_lock);
587 if (im->im_status & IDMAP_STATUS_SUCCESS) {
588 if ((len = strnlen(im->im_name, IDMAP_NAMESZ)) == 0)
590 memcpy(name, im->im_name, len);
595 memset(im, 0, sizeof(*im));
596 mutex_unlock(&idmap->idmap_im_lock);
597 mutex_unlock(&idmap->idmap_lock);
601 /* RPC pipefs upcall/downcall routines */
603 idmap_pipe_upcall(struct file *filp, struct rpc_pipe_msg *msg,
604 char __user *dst, size_t buflen)
606 char *data = (char *)msg->data + msg->copied;
607 size_t mlen = min(msg->len, buflen);
610 left = copy_to_user(dst, data, mlen);
612 msg->errno = -EFAULT;
623 idmap_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
625 struct rpc_inode *rpci = RPC_I(filp->f_path.dentry->d_inode);
626 struct idmap *idmap = (struct idmap *)rpci->private;
627 struct idmap_msg im_in, *im = &idmap->idmap_im;
628 struct idmap_hashtable *h;
629 struct idmap_hashent *he = NULL;
633 if (mlen != sizeof(im_in))
636 if (copy_from_user(&im_in, src, mlen) != 0)
639 mutex_lock(&idmap->idmap_im_lock);
642 im->im_status = im_in.im_status;
643 /* If we got an error, terminate now, and wake up pending upcalls */
644 if (!(im_in.im_status & IDMAP_STATUS_SUCCESS)) {
645 wake_up(&idmap->idmap_wq);
649 /* Sanity checking of strings */
651 namelen_in = strnlen(im_in.im_name, IDMAP_NAMESZ);
652 if (namelen_in == 0 || namelen_in == IDMAP_NAMESZ)
655 switch (im_in.im_type) {
656 case IDMAP_TYPE_USER:
657 h = &idmap->idmap_user_hash;
659 case IDMAP_TYPE_GROUP:
660 h = &idmap->idmap_group_hash;
666 switch (im_in.im_conv) {
667 case IDMAP_CONV_IDTONAME:
668 /* Did we match the current upcall? */
669 if (im->im_conv == IDMAP_CONV_IDTONAME
670 && im->im_type == im_in.im_type
671 && im->im_id == im_in.im_id) {
672 /* Yes: copy string, including the terminating '\0' */
673 memcpy(im->im_name, im_in.im_name, namelen_in);
674 im->im_name[namelen_in] = '\0';
675 wake_up(&idmap->idmap_wq);
677 he = idmap_alloc_id(h, im_in.im_id);
679 case IDMAP_CONV_NAMETOID:
680 /* Did we match the current upcall? */
681 if (im->im_conv == IDMAP_CONV_NAMETOID
682 && im->im_type == im_in.im_type
683 && strnlen(im->im_name, IDMAP_NAMESZ) == namelen_in
684 && memcmp(im->im_name, im_in.im_name, namelen_in) == 0) {
685 im->im_id = im_in.im_id;
686 wake_up(&idmap->idmap_wq);
688 he = idmap_alloc_name(h, im_in.im_name, namelen_in);
694 /* If the entry is valid, also copy it to the cache */
696 idmap_update_entry(he, im_in.im_name, namelen_in, im_in.im_id);
699 mutex_unlock(&idmap->idmap_im_lock);
704 idmap_pipe_destroy_msg(struct rpc_pipe_msg *msg)
706 struct idmap_msg *im = msg->data;
707 struct idmap *idmap = container_of(im, struct idmap, idmap_im);
711 mutex_lock(&idmap->idmap_im_lock);
712 im->im_status = IDMAP_STATUS_LOOKUPFAIL;
713 wake_up(&idmap->idmap_wq);
714 mutex_unlock(&idmap->idmap_im_lock);
718 * Fowler/Noll/Vo hash
719 * http://www.isthe.com/chongo/tech/comp/fnv/
722 #define FNV_P_32 ((unsigned int)0x01000193) /* 16777619 */
723 #define FNV_1_32 ((unsigned int)0x811c9dc5) /* 2166136261 */
725 static unsigned int fnvhash32(const void *buf, size_t buflen)
727 const unsigned char *p, *end = (const unsigned char *)buf + buflen;
728 unsigned int hash = FNV_1_32;
730 for (p = buf; p < end; p++) {
732 hash ^= (unsigned int)*p;
738 int nfs_map_name_to_uid(const struct nfs_server *server, const char *name, size_t namelen, __u32 *uid)
740 struct idmap *idmap = server->nfs_client->cl_idmap;
742 if (nfs_map_string_to_numeric(name, namelen, uid))
744 return nfs_idmap_id(idmap, &idmap->idmap_user_hash, name, namelen, uid);
747 int nfs_map_group_to_gid(const struct nfs_server *server, const char *name, size_t namelen, __u32 *uid)
749 struct idmap *idmap = server->nfs_client->cl_idmap;
751 if (nfs_map_string_to_numeric(name, namelen, uid))
753 return nfs_idmap_id(idmap, &idmap->idmap_group_hash, name, namelen, uid);
756 int nfs_map_uid_to_name(const struct nfs_server *server, __u32 uid, char *buf, size_t buflen)
758 struct idmap *idmap = server->nfs_client->cl_idmap;
761 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
762 ret = nfs_idmap_name(idmap, &idmap->idmap_user_hash, uid, buf);
764 ret = nfs_map_numeric_to_string(uid, buf, buflen);
767 int nfs_map_gid_to_group(const struct nfs_server *server, __u32 uid, char *buf, size_t buflen)
769 struct idmap *idmap = server->nfs_client->cl_idmap;
772 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
773 ret = nfs_idmap_name(idmap, &idmap->idmap_group_hash, uid, buf);
775 ret = nfs_map_numeric_to_string(uid, buf, buflen);
779 #endif /* CONFIG_NFS_USE_NEW_IDMAPPER */