4 * UID and GID to name mapping for clients.
6 * Copyright (c) 2002 The Regents of the University of Michigan.
9 * Marius Aamodt Eriksen <marius@umich.edu>
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>
39 #include <linux/slab.h>
40 #include <linux/nfs_idmap.h>
42 static int nfs_map_string_to_numeric(const char *name
, size_t namelen
, __u32
*res
)
47 if (memchr(name
, '@', namelen
) != NULL
|| namelen
>= sizeof(buf
))
49 memcpy(buf
, name
, namelen
);
51 if (strict_strtoul(buf
, 0, &val
) != 0)
57 static int nfs_map_numeric_to_string(__u32 id
, char *buf
, size_t buflen
)
59 return snprintf(buf
, buflen
, "%u", id
);
62 #ifdef CONFIG_NFS_USE_NEW_IDMAPPER
64 #include <linux/cred.h>
65 #include <linux/sunrpc/sched.h>
66 #include <linux/nfs4.h>
67 #include <linux/nfs_fs_sb.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/socket.h>
288 #include <linux/in.h>
289 #include <linux/sched.h>
290 #include <linux/sunrpc/clnt.h>
291 #include <linux/workqueue.h>
292 #include <linux/sunrpc/rpc_pipe_fs.h>
294 #include <linux/nfs_fs.h>
298 #define IDMAP_HASH_SZ 128
300 /* Default cache timeout is 10 minutes */
301 unsigned int nfs_idmap_cache_timeout
= 600 * HZ
;
303 static int param_set_idmap_timeout(const char *val
, struct kernel_param
*kp
)
306 int num
= simple_strtol(val
, &endp
, 0);
308 if (endp
== val
|| *endp
|| num
< 0 || jif
< num
)
310 *((int *)kp
->arg
) = jif
;
314 module_param_call(idmap_cache_timeout
, param_set_idmap_timeout
, param_get_int
,
315 &nfs_idmap_cache_timeout
, 0644);
317 struct idmap_hashent
{
318 unsigned long ih_expires
;
321 char ih_name
[IDMAP_NAMESZ
];
324 struct idmap_hashtable
{
326 struct idmap_hashent h_entries
[IDMAP_HASH_SZ
];
330 struct dentry
*idmap_dentry
;
331 wait_queue_head_t idmap_wq
;
332 struct idmap_msg idmap_im
;
333 struct mutex idmap_lock
; /* Serializes upcalls */
334 struct mutex idmap_im_lock
; /* Protects the hashtable */
335 struct idmap_hashtable idmap_user_hash
;
336 struct idmap_hashtable idmap_group_hash
;
339 static ssize_t
idmap_pipe_upcall(struct file
*, struct rpc_pipe_msg
*,
340 char __user
*, size_t);
341 static ssize_t
idmap_pipe_downcall(struct file
*, const char __user
*,
343 static void idmap_pipe_destroy_msg(struct rpc_pipe_msg
*);
345 static unsigned int fnvhash32(const void *, size_t);
347 static const struct rpc_pipe_ops idmap_upcall_ops
= {
348 .upcall
= idmap_pipe_upcall
,
349 .downcall
= idmap_pipe_downcall
,
350 .destroy_msg
= idmap_pipe_destroy_msg
,
354 nfs_idmap_new(struct nfs_client
*clp
)
359 BUG_ON(clp
->cl_idmap
!= NULL
);
361 idmap
= kzalloc(sizeof(*idmap
), GFP_KERNEL
);
365 idmap
->idmap_dentry
= rpc_mkpipe(clp
->cl_rpcclient
->cl_path
.dentry
,
366 "idmap", idmap
, &idmap_upcall_ops
, 0);
367 if (IS_ERR(idmap
->idmap_dentry
)) {
368 error
= PTR_ERR(idmap
->idmap_dentry
);
373 mutex_init(&idmap
->idmap_lock
);
374 mutex_init(&idmap
->idmap_im_lock
);
375 init_waitqueue_head(&idmap
->idmap_wq
);
376 idmap
->idmap_user_hash
.h_type
= IDMAP_TYPE_USER
;
377 idmap
->idmap_group_hash
.h_type
= IDMAP_TYPE_GROUP
;
379 clp
->cl_idmap
= idmap
;
384 nfs_idmap_delete(struct nfs_client
*clp
)
386 struct idmap
*idmap
= clp
->cl_idmap
;
390 rpc_unlink(idmap
->idmap_dentry
);
391 clp
->cl_idmap
= NULL
;
396 * Helper routines for manipulating the hashtable
398 static inline struct idmap_hashent
*
399 idmap_name_hash(struct idmap_hashtable
* h
, const char *name
, size_t len
)
401 return &h
->h_entries
[fnvhash32(name
, len
) % IDMAP_HASH_SZ
];
404 static struct idmap_hashent
*
405 idmap_lookup_name(struct idmap_hashtable
*h
, const char *name
, size_t len
)
407 struct idmap_hashent
*he
= idmap_name_hash(h
, name
, len
);
409 if (he
->ih_namelen
!= len
|| memcmp(he
->ih_name
, name
, len
) != 0)
411 if (time_after(jiffies
, he
->ih_expires
))
416 static inline struct idmap_hashent
*
417 idmap_id_hash(struct idmap_hashtable
* h
, __u32 id
)
419 return &h
->h_entries
[fnvhash32(&id
, sizeof(id
)) % IDMAP_HASH_SZ
];
422 static struct idmap_hashent
*
423 idmap_lookup_id(struct idmap_hashtable
*h
, __u32 id
)
425 struct idmap_hashent
*he
= idmap_id_hash(h
, id
);
426 if (he
->ih_id
!= id
|| he
->ih_namelen
== 0)
428 if (time_after(jiffies
, he
->ih_expires
))
434 * Routines for allocating new entries in the hashtable.
435 * For now, we just have 1 entry per bucket, so it's all
438 static inline struct idmap_hashent
*
439 idmap_alloc_name(struct idmap_hashtable
*h
, char *name
, size_t len
)
441 return idmap_name_hash(h
, name
, len
);
444 static inline struct idmap_hashent
*
445 idmap_alloc_id(struct idmap_hashtable
*h
, __u32 id
)
447 return idmap_id_hash(h
, id
);
451 idmap_update_entry(struct idmap_hashent
*he
, const char *name
,
452 size_t namelen
, __u32 id
)
455 memcpy(he
->ih_name
, name
, namelen
);
456 he
->ih_name
[namelen
] = '\0';
457 he
->ih_namelen
= namelen
;
458 he
->ih_expires
= jiffies
+ nfs_idmap_cache_timeout
;
465 nfs_idmap_id(struct idmap
*idmap
, struct idmap_hashtable
*h
,
466 const char *name
, size_t namelen
, __u32
*id
)
468 struct rpc_pipe_msg msg
;
469 struct idmap_msg
*im
;
470 struct idmap_hashent
*he
;
471 DECLARE_WAITQUEUE(wq
, current
);
474 im
= &idmap
->idmap_im
;
477 * String sanity checks
478 * Note that the userland daemon expects NUL terminated strings
483 if (name
[namelen
-1] != '\0')
487 if (namelen
>= IDMAP_NAMESZ
)
490 mutex_lock(&idmap
->idmap_lock
);
491 mutex_lock(&idmap
->idmap_im_lock
);
493 he
= idmap_lookup_name(h
, name
, namelen
);
500 memset(im
, 0, sizeof(*im
));
501 memcpy(im
->im_name
, name
, namelen
);
503 im
->im_type
= h
->h_type
;
504 im
->im_conv
= IDMAP_CONV_NAMETOID
;
506 memset(&msg
, 0, sizeof(msg
));
508 msg
.len
= sizeof(*im
);
510 add_wait_queue(&idmap
->idmap_wq
, &wq
);
511 if (rpc_queue_upcall(idmap
->idmap_dentry
->d_inode
, &msg
) < 0) {
512 remove_wait_queue(&idmap
->idmap_wq
, &wq
);
516 set_current_state(TASK_UNINTERRUPTIBLE
);
517 mutex_unlock(&idmap
->idmap_im_lock
);
519 __set_current_state(TASK_RUNNING
);
520 remove_wait_queue(&idmap
->idmap_wq
, &wq
);
521 mutex_lock(&idmap
->idmap_im_lock
);
523 if (im
->im_status
& IDMAP_STATUS_SUCCESS
) {
529 memset(im
, 0, sizeof(*im
));
530 mutex_unlock(&idmap
->idmap_im_lock
);
531 mutex_unlock(&idmap
->idmap_lock
);
539 nfs_idmap_name(struct idmap
*idmap
, struct idmap_hashtable
*h
,
540 __u32 id
, char *name
)
542 struct rpc_pipe_msg msg
;
543 struct idmap_msg
*im
;
544 struct idmap_hashent
*he
;
545 DECLARE_WAITQUEUE(wq
, current
);
549 im
= &idmap
->idmap_im
;
551 mutex_lock(&idmap
->idmap_lock
);
552 mutex_lock(&idmap
->idmap_im_lock
);
554 he
= idmap_lookup_id(h
, id
);
556 memcpy(name
, he
->ih_name
, he
->ih_namelen
);
557 ret
= he
->ih_namelen
;
561 memset(im
, 0, sizeof(*im
));
562 im
->im_type
= h
->h_type
;
563 im
->im_conv
= IDMAP_CONV_IDTONAME
;
566 memset(&msg
, 0, sizeof(msg
));
568 msg
.len
= sizeof(*im
);
570 add_wait_queue(&idmap
->idmap_wq
, &wq
);
572 if (rpc_queue_upcall(idmap
->idmap_dentry
->d_inode
, &msg
) < 0) {
573 remove_wait_queue(&idmap
->idmap_wq
, &wq
);
577 set_current_state(TASK_UNINTERRUPTIBLE
);
578 mutex_unlock(&idmap
->idmap_im_lock
);
580 __set_current_state(TASK_RUNNING
);
581 remove_wait_queue(&idmap
->idmap_wq
, &wq
);
582 mutex_lock(&idmap
->idmap_im_lock
);
584 if (im
->im_status
& IDMAP_STATUS_SUCCESS
) {
585 if ((len
= strnlen(im
->im_name
, IDMAP_NAMESZ
)) == 0)
587 memcpy(name
, im
->im_name
, len
);
592 memset(im
, 0, sizeof(*im
));
593 mutex_unlock(&idmap
->idmap_im_lock
);
594 mutex_unlock(&idmap
->idmap_lock
);
598 /* RPC pipefs upcall/downcall routines */
600 idmap_pipe_upcall(struct file
*filp
, struct rpc_pipe_msg
*msg
,
601 char __user
*dst
, size_t buflen
)
603 char *data
= (char *)msg
->data
+ msg
->copied
;
604 size_t mlen
= min(msg
->len
, buflen
);
607 left
= copy_to_user(dst
, data
, mlen
);
609 msg
->errno
= -EFAULT
;
620 idmap_pipe_downcall(struct file
*filp
, const char __user
*src
, size_t mlen
)
622 struct rpc_inode
*rpci
= RPC_I(filp
->f_path
.dentry
->d_inode
);
623 struct idmap
*idmap
= (struct idmap
*)rpci
->private;
624 struct idmap_msg im_in
, *im
= &idmap
->idmap_im
;
625 struct idmap_hashtable
*h
;
626 struct idmap_hashent
*he
= NULL
;
630 if (mlen
!= sizeof(im_in
))
633 if (copy_from_user(&im_in
, src
, mlen
) != 0)
636 mutex_lock(&idmap
->idmap_im_lock
);
639 im
->im_status
= im_in
.im_status
;
640 /* If we got an error, terminate now, and wake up pending upcalls */
641 if (!(im_in
.im_status
& IDMAP_STATUS_SUCCESS
)) {
642 wake_up(&idmap
->idmap_wq
);
646 /* Sanity checking of strings */
648 namelen_in
= strnlen(im_in
.im_name
, IDMAP_NAMESZ
);
649 if (namelen_in
== 0 || namelen_in
== IDMAP_NAMESZ
)
652 switch (im_in
.im_type
) {
653 case IDMAP_TYPE_USER
:
654 h
= &idmap
->idmap_user_hash
;
656 case IDMAP_TYPE_GROUP
:
657 h
= &idmap
->idmap_group_hash
;
663 switch (im_in
.im_conv
) {
664 case IDMAP_CONV_IDTONAME
:
665 /* Did we match the current upcall? */
666 if (im
->im_conv
== IDMAP_CONV_IDTONAME
667 && im
->im_type
== im_in
.im_type
668 && im
->im_id
== im_in
.im_id
) {
669 /* Yes: copy string, including the terminating '\0' */
670 memcpy(im
->im_name
, im_in
.im_name
, namelen_in
);
671 im
->im_name
[namelen_in
] = '\0';
672 wake_up(&idmap
->idmap_wq
);
674 he
= idmap_alloc_id(h
, im_in
.im_id
);
676 case IDMAP_CONV_NAMETOID
:
677 /* Did we match the current upcall? */
678 if (im
->im_conv
== IDMAP_CONV_NAMETOID
679 && im
->im_type
== im_in
.im_type
680 && strnlen(im
->im_name
, IDMAP_NAMESZ
) == namelen_in
681 && memcmp(im
->im_name
, im_in
.im_name
, namelen_in
) == 0) {
682 im
->im_id
= im_in
.im_id
;
683 wake_up(&idmap
->idmap_wq
);
685 he
= idmap_alloc_name(h
, im_in
.im_name
, namelen_in
);
691 /* If the entry is valid, also copy it to the cache */
693 idmap_update_entry(he
, im_in
.im_name
, namelen_in
, im_in
.im_id
);
696 mutex_unlock(&idmap
->idmap_im_lock
);
701 idmap_pipe_destroy_msg(struct rpc_pipe_msg
*msg
)
703 struct idmap_msg
*im
= msg
->data
;
704 struct idmap
*idmap
= container_of(im
, struct idmap
, idmap_im
);
708 mutex_lock(&idmap
->idmap_im_lock
);
709 im
->im_status
= IDMAP_STATUS_LOOKUPFAIL
;
710 wake_up(&idmap
->idmap_wq
);
711 mutex_unlock(&idmap
->idmap_im_lock
);
715 * Fowler/Noll/Vo hash
716 * http://www.isthe.com/chongo/tech/comp/fnv/
719 #define FNV_P_32 ((unsigned int)0x01000193) /* 16777619 */
720 #define FNV_1_32 ((unsigned int)0x811c9dc5) /* 2166136261 */
722 static unsigned int fnvhash32(const void *buf
, size_t buflen
)
724 const unsigned char *p
, *end
= (const unsigned char *)buf
+ buflen
;
725 unsigned int hash
= FNV_1_32
;
727 for (p
= buf
; p
< end
; p
++) {
729 hash
^= (unsigned int)*p
;
735 int nfs_map_name_to_uid(const struct nfs_server
*server
, const char *name
, size_t namelen
, __u32
*uid
)
737 struct idmap
*idmap
= server
->nfs_client
->cl_idmap
;
739 if (nfs_map_string_to_numeric(name
, namelen
, uid
))
741 return nfs_idmap_id(idmap
, &idmap
->idmap_user_hash
, name
, namelen
, uid
);
744 int nfs_map_group_to_gid(const struct nfs_server
*server
, const char *name
, size_t namelen
, __u32
*uid
)
746 struct idmap
*idmap
= server
->nfs_client
->cl_idmap
;
748 if (nfs_map_string_to_numeric(name
, namelen
, uid
))
750 return nfs_idmap_id(idmap
, &idmap
->idmap_group_hash
, name
, namelen
, uid
);
753 int nfs_map_uid_to_name(const struct nfs_server
*server
, __u32 uid
, char *buf
, size_t buflen
)
755 struct idmap
*idmap
= server
->nfs_client
->cl_idmap
;
758 if (!(server
->caps
& NFS_CAP_UIDGID_NOMAP
))
759 ret
= nfs_idmap_name(idmap
, &idmap
->idmap_user_hash
, uid
, buf
);
761 ret
= nfs_map_numeric_to_string(uid
, buf
, buflen
);
764 int nfs_map_gid_to_group(const struct nfs_server
*server
, __u32 uid
, char *buf
, size_t buflen
)
766 struct idmap
*idmap
= server
->nfs_client
->cl_idmap
;
769 if (!(server
->caps
& NFS_CAP_UIDGID_NOMAP
))
770 ret
= nfs_idmap_name(idmap
, &idmap
->idmap_group_hash
, uid
, buf
);
772 ret
= nfs_map_numeric_to_string(uid
, buf
, buflen
);
776 #endif /* CONFIG_NFS_USE_NEW_IDMAPPER */