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/parser.h>
39 #include <linux/nfs_idmap.h>
40 #include <net/net_namespace.h>
41 #include <linux/sunrpc/rpc_pipe_fs.h>
42 #include <linux/nfs_fs.h>
43 #include <linux/nfs_fs_sb.h>
44 #include <linux/key.h>
45 #include <linux/keyctl.h>
46 #include <linux/key-type.h>
47 #include <keys/user-type.h>
48 #include <linux/module.h>
53 #define NFS_UINT_MAXLEN 11
55 static const struct cred *id_resolver_cache;
56 static struct key_type key_type_id_resolver_legacy;
59 struct rpc_pipe *idmap_pipe;
60 struct key_construction *idmap_key_cons;
61 struct mutex idmap_mutex;
64 struct idmap_legacy_upcalldata {
65 struct rpc_pipe_msg pipe_msg;
66 struct idmap_msg idmap_msg;
71 * nfs_fattr_init_names - initialise the nfs_fattr owner_name/group_name fields
72 * @fattr: fully initialised struct nfs_fattr
73 * @owner_name: owner name string cache
74 * @group_name: group name string cache
76 void nfs_fattr_init_names(struct nfs_fattr *fattr,
77 struct nfs4_string *owner_name,
78 struct nfs4_string *group_name)
80 fattr->owner_name = owner_name;
81 fattr->group_name = group_name;
84 static void nfs_fattr_free_owner_name(struct nfs_fattr *fattr)
86 fattr->valid &= ~NFS_ATTR_FATTR_OWNER_NAME;
87 kfree(fattr->owner_name->data);
90 static void nfs_fattr_free_group_name(struct nfs_fattr *fattr)
92 fattr->valid &= ~NFS_ATTR_FATTR_GROUP_NAME;
93 kfree(fattr->group_name->data);
96 static bool nfs_fattr_map_owner_name(struct nfs_server *server, struct nfs_fattr *fattr)
98 struct nfs4_string *owner = fattr->owner_name;
101 if (!(fattr->valid & NFS_ATTR_FATTR_OWNER_NAME))
103 if (nfs_map_name_to_uid(server, owner->data, owner->len, &uid) == 0) {
105 fattr->valid |= NFS_ATTR_FATTR_OWNER;
110 static bool nfs_fattr_map_group_name(struct nfs_server *server, struct nfs_fattr *fattr)
112 struct nfs4_string *group = fattr->group_name;
115 if (!(fattr->valid & NFS_ATTR_FATTR_GROUP_NAME))
117 if (nfs_map_group_to_gid(server, group->data, group->len, &gid) == 0) {
119 fattr->valid |= NFS_ATTR_FATTR_GROUP;
125 * nfs_fattr_free_names - free up the NFSv4 owner and group strings
126 * @fattr: a fully initialised nfs_fattr structure
128 void nfs_fattr_free_names(struct nfs_fattr *fattr)
130 if (fattr->valid & NFS_ATTR_FATTR_OWNER_NAME)
131 nfs_fattr_free_owner_name(fattr);
132 if (fattr->valid & NFS_ATTR_FATTR_GROUP_NAME)
133 nfs_fattr_free_group_name(fattr);
137 * nfs_fattr_map_and_free_names - map owner/group strings into uid/gid and free
138 * @server: pointer to the filesystem nfs_server structure
139 * @fattr: a fully initialised nfs_fattr structure
141 * This helper maps the cached NFSv4 owner/group strings in fattr into
142 * their numeric uid/gid equivalents, and then frees the cached strings.
144 void nfs_fattr_map_and_free_names(struct nfs_server *server, struct nfs_fattr *fattr)
146 if (nfs_fattr_map_owner_name(server, fattr))
147 nfs_fattr_free_owner_name(fattr);
148 if (nfs_fattr_map_group_name(server, fattr))
149 nfs_fattr_free_group_name(fattr);
152 static int nfs_map_string_to_numeric(const char *name, size_t namelen, __u32 *res)
157 if (memchr(name, '@', namelen) != NULL || namelen >= sizeof(buf))
159 memcpy(buf, name, namelen);
161 if (strict_strtoul(buf, 0, &val) != 0)
167 static int nfs_map_numeric_to_string(__u32 id, char *buf, size_t buflen)
169 return snprintf(buf, buflen, "%u", id);
172 static struct key_type key_type_id_resolver = {
173 .name = "id_resolver",
174 .instantiate = user_instantiate,
176 .revoke = user_revoke,
177 .destroy = user_destroy,
178 .describe = user_describe,
182 static int nfs_idmap_init_keyring(void)
188 printk(KERN_NOTICE "NFS: Registering the %s key type\n",
189 key_type_id_resolver.name);
191 cred = prepare_kernel_cred(NULL);
195 keyring = keyring_alloc(".id_resolver", 0, 0, cred,
196 (KEY_POS_ALL & ~KEY_POS_SETATTR) |
197 KEY_USR_VIEW | KEY_USR_READ,
198 KEY_ALLOC_NOT_IN_QUOTA, NULL);
199 if (IS_ERR(keyring)) {
200 ret = PTR_ERR(keyring);
201 goto failed_put_cred;
204 ret = register_key_type(&key_type_id_resolver);
208 ret = register_key_type(&key_type_id_resolver_legacy);
210 goto failed_reg_legacy;
212 set_bit(KEY_FLAG_ROOT_CAN_CLEAR, &keyring->flags);
213 cred->thread_keyring = keyring;
214 cred->jit_keyring = KEY_REQKEY_DEFL_THREAD_KEYRING;
215 id_resolver_cache = cred;
219 unregister_key_type(&key_type_id_resolver);
227 static void nfs_idmap_quit_keyring(void)
229 key_revoke(id_resolver_cache->thread_keyring);
230 unregister_key_type(&key_type_id_resolver);
231 unregister_key_type(&key_type_id_resolver_legacy);
232 put_cred(id_resolver_cache);
236 * Assemble the description to pass to request_key()
237 * This function will allocate a new string and update dest to point
238 * at it. The caller is responsible for freeing dest.
240 * On error 0 is returned. Otherwise, the length of dest is returned.
242 static ssize_t nfs_idmap_get_desc(const char *name, size_t namelen,
243 const char *type, size_t typelen, char **desc)
246 size_t desclen = typelen + namelen + 2;
248 *desc = kmalloc(desclen, GFP_KERNEL);
253 memcpy(cp, type, typelen);
257 memcpy(cp, name, namelen);
263 static ssize_t nfs_idmap_request_key(struct key_type *key_type,
264 const char *name, size_t namelen,
265 const char *type, void *data,
266 size_t data_size, struct idmap *idmap)
268 const struct cred *saved_cred;
271 struct user_key_payload *payload;
274 ret = nfs_idmap_get_desc(name, namelen, type, strlen(type), &desc);
278 saved_cred = override_creds(id_resolver_cache);
280 rkey = request_key_with_auxdata(key_type, desc, "", 0, idmap);
282 rkey = request_key(&key_type_id_resolver, desc, "");
283 revert_creds(saved_cred);
292 rkey->perm |= KEY_USR_VIEW;
294 ret = key_validate(rkey);
298 payload = rcu_dereference(rkey->payload.data);
299 if (IS_ERR_OR_NULL(payload)) {
300 ret = PTR_ERR(payload);
304 ret = payload->datalen;
305 if (ret > 0 && ret <= data_size)
306 memcpy(data, payload->data, ret);
317 static ssize_t nfs_idmap_get_key(const char *name, size_t namelen,
318 const char *type, void *data,
319 size_t data_size, struct idmap *idmap)
321 ssize_t ret = nfs_idmap_request_key(&key_type_id_resolver,
322 name, namelen, type, data,
325 mutex_lock(&idmap->idmap_mutex);
326 ret = nfs_idmap_request_key(&key_type_id_resolver_legacy,
327 name, namelen, type, data,
329 idmap->idmap_key_cons = NULL;
330 mutex_unlock(&idmap->idmap_mutex);
336 static ssize_t nfs_idmap_lookup_name(__u32 id, const char *type, char *buf,
337 size_t buflen, struct idmap *idmap)
339 char id_str[NFS_UINT_MAXLEN];
343 id_len = snprintf(id_str, sizeof(id_str), "%u", id);
344 ret = nfs_idmap_get_key(id_str, id_len, type, buf, buflen, idmap);
351 static int nfs_idmap_lookup_id(const char *name, size_t namelen, const char *type,
352 __u32 *id, struct idmap *idmap)
354 char id_str[NFS_UINT_MAXLEN];
359 data_size = nfs_idmap_get_key(name, namelen, type, id_str, NFS_UINT_MAXLEN, idmap);
360 if (data_size <= 0) {
363 ret = strict_strtol(id_str, 10, &id_long);
364 *id = (__u32)id_long;
369 /* idmap classic begins here */
372 Opt_find_uid, Opt_find_gid, Opt_find_user, Opt_find_group, Opt_find_err
375 static const match_table_t nfs_idmap_tokens = {
376 { Opt_find_uid, "uid:%s" },
377 { Opt_find_gid, "gid:%s" },
378 { Opt_find_user, "user:%s" },
379 { Opt_find_group, "group:%s" },
380 { Opt_find_err, NULL }
383 static int nfs_idmap_legacy_upcall(struct key_construction *, const char *, void *);
384 static ssize_t idmap_pipe_downcall(struct file *, const char __user *,
386 static void idmap_release_pipe(struct inode *);
387 static void idmap_pipe_destroy_msg(struct rpc_pipe_msg *);
389 static const struct rpc_pipe_ops idmap_upcall_ops = {
390 .upcall = rpc_pipe_generic_upcall,
391 .downcall = idmap_pipe_downcall,
392 .release_pipe = idmap_release_pipe,
393 .destroy_msg = idmap_pipe_destroy_msg,
396 static struct key_type key_type_id_resolver_legacy = {
398 .instantiate = user_instantiate,
400 .revoke = user_revoke,
401 .destroy = user_destroy,
402 .describe = user_describe,
404 .request_key = nfs_idmap_legacy_upcall,
407 static void __nfs_idmap_unregister(struct rpc_pipe *pipe)
410 rpc_unlink(pipe->dentry);
413 static int __nfs_idmap_register(struct dentry *dir,
415 struct rpc_pipe *pipe)
417 struct dentry *dentry;
419 dentry = rpc_mkpipe_dentry(dir, "idmap", idmap, pipe);
421 return PTR_ERR(dentry);
422 pipe->dentry = dentry;
426 static void nfs_idmap_unregister(struct nfs_client *clp,
427 struct rpc_pipe *pipe)
429 struct net *net = clp->cl_net;
430 struct super_block *pipefs_sb;
432 pipefs_sb = rpc_get_sb_net(net);
434 __nfs_idmap_unregister(pipe);
439 static int nfs_idmap_register(struct nfs_client *clp,
441 struct rpc_pipe *pipe)
443 struct net *net = clp->cl_net;
444 struct super_block *pipefs_sb;
447 pipefs_sb = rpc_get_sb_net(net);
449 if (clp->cl_rpcclient->cl_dentry)
450 err = __nfs_idmap_register(clp->cl_rpcclient->cl_dentry,
458 nfs_idmap_new(struct nfs_client *clp)
461 struct rpc_pipe *pipe;
464 BUG_ON(clp->cl_idmap != NULL);
466 idmap = kzalloc(sizeof(*idmap), GFP_KERNEL);
470 pipe = rpc_mkpipe_data(&idmap_upcall_ops, 0);
472 error = PTR_ERR(pipe);
476 error = nfs_idmap_register(clp, idmap, pipe);
478 rpc_destroy_pipe_data(pipe);
482 idmap->idmap_pipe = pipe;
483 mutex_init(&idmap->idmap_mutex);
485 clp->cl_idmap = idmap;
490 nfs_idmap_delete(struct nfs_client *clp)
492 struct idmap *idmap = clp->cl_idmap;
496 nfs_idmap_unregister(clp, idmap->idmap_pipe);
497 rpc_destroy_pipe_data(idmap->idmap_pipe);
498 clp->cl_idmap = NULL;
502 static int __rpc_pipefs_event(struct nfs_client *clp, unsigned long event,
503 struct super_block *sb)
508 case RPC_PIPEFS_MOUNT:
509 BUG_ON(clp->cl_rpcclient->cl_dentry == NULL);
510 err = __nfs_idmap_register(clp->cl_rpcclient->cl_dentry,
512 clp->cl_idmap->idmap_pipe);
514 case RPC_PIPEFS_UMOUNT:
515 if (clp->cl_idmap->idmap_pipe) {
516 struct dentry *parent;
518 parent = clp->cl_idmap->idmap_pipe->dentry->d_parent;
519 __nfs_idmap_unregister(clp->cl_idmap->idmap_pipe);
521 * Note: This is a dirty hack. SUNRPC hook has been
522 * called already but simple_rmdir() call for the
523 * directory returned with error because of idmap pipe
524 * inside. Thus now we have to remove this directory
527 if (rpc_rmdir(parent))
528 printk(KERN_ERR "NFS: %s: failed to remove "
529 "clnt dir!\n", __func__);
533 printk(KERN_ERR "NFS: %s: unknown event: %ld\n", __func__,
540 static struct nfs_client *nfs_get_client_for_event(struct net *net, int event)
542 struct nfs_net *nn = net_generic(net, nfs_net_id);
543 struct dentry *cl_dentry;
544 struct nfs_client *clp;
548 spin_lock(&nn->nfs_client_lock);
549 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
550 /* Wait for initialisation to finish */
551 if (clp->cl_cons_state == NFS_CS_INITING) {
552 atomic_inc(&clp->cl_count);
553 spin_unlock(&nn->nfs_client_lock);
554 err = nfs_wait_client_init_complete(clp);
560 /* Skip nfs_clients that failed to initialise */
561 if (clp->cl_cons_state < 0)
564 if (clp->rpc_ops != &nfs_v4_clientops)
566 cl_dentry = clp->cl_idmap->idmap_pipe->dentry;
567 if (((event == RPC_PIPEFS_MOUNT) && cl_dentry) ||
568 ((event == RPC_PIPEFS_UMOUNT) && !cl_dentry))
570 atomic_inc(&clp->cl_count);
571 spin_unlock(&nn->nfs_client_lock);
574 spin_unlock(&nn->nfs_client_lock);
578 static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
581 struct super_block *sb = ptr;
582 struct nfs_client *clp;
585 if (!try_module_get(THIS_MODULE))
588 while ((clp = nfs_get_client_for_event(sb->s_fs_info, event))) {
589 error = __rpc_pipefs_event(clp, event, sb);
594 module_put(THIS_MODULE);
598 #define PIPEFS_NFS_PRIO 1
600 static struct notifier_block nfs_idmap_block = {
601 .notifier_call = rpc_pipefs_event,
602 .priority = SUNRPC_PIPEFS_NFS_PRIO,
605 int nfs_idmap_init(void)
608 ret = nfs_idmap_init_keyring();
611 ret = rpc_pipefs_notifier_register(&nfs_idmap_block);
613 nfs_idmap_quit_keyring();
618 void nfs_idmap_quit(void)
620 rpc_pipefs_notifier_unregister(&nfs_idmap_block);
621 nfs_idmap_quit_keyring();
624 static int nfs_idmap_prepare_message(char *desc, struct idmap *idmap,
625 struct idmap_msg *im,
626 struct rpc_pipe_msg *msg)
631 memset(im, 0, sizeof(*im));
632 memset(msg, 0, sizeof(*msg));
634 im->im_type = IDMAP_TYPE_GROUP;
635 token = match_token(desc, nfs_idmap_tokens, &substr);
639 im->im_type = IDMAP_TYPE_USER;
641 im->im_conv = IDMAP_CONV_NAMETOID;
642 ret = match_strlcpy(im->im_name, &substr, IDMAP_NAMESZ);
646 im->im_type = IDMAP_TYPE_USER;
648 im->im_conv = IDMAP_CONV_IDTONAME;
649 ret = match_int(&substr, &im->im_id);
658 msg->len = sizeof(struct idmap_msg);
664 static int nfs_idmap_legacy_upcall(struct key_construction *cons,
668 struct idmap_legacy_upcalldata *data;
669 struct rpc_pipe_msg *msg;
670 struct idmap_msg *im;
671 struct idmap *idmap = (struct idmap *)aux;
672 struct key *key = cons->key;
675 /* msg and im are freed in idmap_pipe_destroy_msg */
676 data = kmalloc(sizeof(*data), GFP_KERNEL);
680 msg = &data->pipe_msg;
681 im = &data->idmap_msg;
684 ret = nfs_idmap_prepare_message(key->description, idmap, im, msg);
688 BUG_ON(idmap->idmap_key_cons != NULL);
689 idmap->idmap_key_cons = cons;
691 ret = rpc_queue_upcall(idmap->idmap_pipe, msg);
698 idmap->idmap_key_cons = NULL;
702 complete_request_key(cons, ret);
706 static int nfs_idmap_instantiate(struct key *key, struct key *authkey, char *data)
708 return key_instantiate_and_link(key, data, strlen(data) + 1,
709 id_resolver_cache->thread_keyring,
713 static int nfs_idmap_read_message(struct idmap_msg *im, struct key *key, struct key *authkey)
715 char id_str[NFS_UINT_MAXLEN];
718 switch (im->im_conv) {
719 case IDMAP_CONV_NAMETOID:
720 sprintf(id_str, "%d", im->im_id);
721 ret = nfs_idmap_instantiate(key, authkey, id_str);
723 case IDMAP_CONV_IDTONAME:
724 ret = nfs_idmap_instantiate(key, authkey, im->im_name);
732 idmap_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
734 struct rpc_inode *rpci = RPC_I(filp->f_path.dentry->d_inode);
735 struct idmap *idmap = (struct idmap *)rpci->private;
736 struct key_construction *cons;
741 /* If instantiation is successful, anyone waiting for key construction
742 * will have been woken up and someone else may now have used
743 * idmap_key_cons - so after this point we may no longer touch it.
745 cons = ACCESS_ONCE(idmap->idmap_key_cons);
746 idmap->idmap_key_cons = NULL;
748 if (mlen != sizeof(im)) {
753 if (copy_from_user(&im, src, mlen) != 0) {
758 if (!(im.im_status & IDMAP_STATUS_SUCCESS)) {
763 namelen_in = strnlen(im.im_name, IDMAP_NAMESZ);
764 if (namelen_in == 0 || namelen_in == IDMAP_NAMESZ) {
769 ret = nfs_idmap_read_message(&im, cons->key, cons->authkey);
771 key_set_timeout(cons->key, nfs_idmap_cache_timeout);
776 complete_request_key(cons, ret);
781 idmap_pipe_destroy_msg(struct rpc_pipe_msg *msg)
783 struct idmap_legacy_upcalldata *data = container_of(msg,
784 struct idmap_legacy_upcalldata,
786 struct idmap *idmap = data->idmap;
787 struct key_construction *cons;
789 cons = ACCESS_ONCE(idmap->idmap_key_cons);
790 idmap->idmap_key_cons = NULL;
791 complete_request_key(cons, msg->errno);
793 /* Free memory allocated in nfs_idmap_legacy_upcall() */
798 idmap_release_pipe(struct inode *inode)
800 struct rpc_inode *rpci = RPC_I(inode);
801 struct idmap *idmap = (struct idmap *)rpci->private;
802 idmap->idmap_key_cons = NULL;
805 int nfs_map_name_to_uid(const struct nfs_server *server, const char *name, size_t namelen, __u32 *uid)
807 struct idmap *idmap = server->nfs_client->cl_idmap;
809 if (nfs_map_string_to_numeric(name, namelen, uid))
811 return nfs_idmap_lookup_id(name, namelen, "uid", uid, idmap);
814 int nfs_map_group_to_gid(const struct nfs_server *server, const char *name, size_t namelen, __u32 *gid)
816 struct idmap *idmap = server->nfs_client->cl_idmap;
818 if (nfs_map_string_to_numeric(name, namelen, gid))
820 return nfs_idmap_lookup_id(name, namelen, "gid", gid, idmap);
823 int nfs_map_uid_to_name(const struct nfs_server *server, __u32 uid, char *buf, size_t buflen)
825 struct idmap *idmap = server->nfs_client->cl_idmap;
828 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
829 ret = nfs_idmap_lookup_name(uid, "user", buf, buflen, idmap);
831 ret = nfs_map_numeric_to_string(uid, buf, buflen);
834 int nfs_map_gid_to_group(const struct nfs_server *server, __u32 gid, char *buf, size_t buflen)
836 struct idmap *idmap = server->nfs_client->cl_idmap;
839 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
840 ret = nfs_idmap_lookup_name(gid, "group", buf, buflen, idmap);
842 ret = nfs_map_numeric_to_string(gid, buf, buflen);