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 /* Default cache timeout is 10 minutes */
56 unsigned int nfs_idmap_cache_timeout = 600;
57 static const struct cred *id_resolver_cache;
58 static struct key_type key_type_id_resolver_legacy;
61 struct rpc_pipe *idmap_pipe;
62 struct key_construction *idmap_key_cons;
63 struct mutex idmap_mutex;
67 * nfs_fattr_init_names - initialise the nfs_fattr owner_name/group_name fields
68 * @fattr: fully initialised struct nfs_fattr
69 * @owner_name: owner name string cache
70 * @group_name: group name string cache
72 void nfs_fattr_init_names(struct nfs_fattr *fattr,
73 struct nfs4_string *owner_name,
74 struct nfs4_string *group_name)
76 fattr->owner_name = owner_name;
77 fattr->group_name = group_name;
80 static void nfs_fattr_free_owner_name(struct nfs_fattr *fattr)
82 fattr->valid &= ~NFS_ATTR_FATTR_OWNER_NAME;
83 kfree(fattr->owner_name->data);
86 static void nfs_fattr_free_group_name(struct nfs_fattr *fattr)
88 fattr->valid &= ~NFS_ATTR_FATTR_GROUP_NAME;
89 kfree(fattr->group_name->data);
92 static bool nfs_fattr_map_owner_name(struct nfs_server *server, struct nfs_fattr *fattr)
94 struct nfs4_string *owner = fattr->owner_name;
97 if (!(fattr->valid & NFS_ATTR_FATTR_OWNER_NAME))
99 if (nfs_map_name_to_uid(server, owner->data, owner->len, &uid) == 0) {
101 fattr->valid |= NFS_ATTR_FATTR_OWNER;
106 static bool nfs_fattr_map_group_name(struct nfs_server *server, struct nfs_fattr *fattr)
108 struct nfs4_string *group = fattr->group_name;
111 if (!(fattr->valid & NFS_ATTR_FATTR_GROUP_NAME))
113 if (nfs_map_group_to_gid(server, group->data, group->len, &gid) == 0) {
115 fattr->valid |= NFS_ATTR_FATTR_GROUP;
121 * nfs_fattr_free_names - free up the NFSv4 owner and group strings
122 * @fattr: a fully initialised nfs_fattr structure
124 void nfs_fattr_free_names(struct nfs_fattr *fattr)
126 if (fattr->valid & NFS_ATTR_FATTR_OWNER_NAME)
127 nfs_fattr_free_owner_name(fattr);
128 if (fattr->valid & NFS_ATTR_FATTR_GROUP_NAME)
129 nfs_fattr_free_group_name(fattr);
133 * nfs_fattr_map_and_free_names - map owner/group strings into uid/gid and free
134 * @server: pointer to the filesystem nfs_server structure
135 * @fattr: a fully initialised nfs_fattr structure
137 * This helper maps the cached NFSv4 owner/group strings in fattr into
138 * their numeric uid/gid equivalents, and then frees the cached strings.
140 void nfs_fattr_map_and_free_names(struct nfs_server *server, struct nfs_fattr *fattr)
142 if (nfs_fattr_map_owner_name(server, fattr))
143 nfs_fattr_free_owner_name(fattr);
144 if (nfs_fattr_map_group_name(server, fattr))
145 nfs_fattr_free_group_name(fattr);
148 static int nfs_map_string_to_numeric(const char *name, size_t namelen, __u32 *res)
153 if (memchr(name, '@', namelen) != NULL || namelen >= sizeof(buf))
155 memcpy(buf, name, namelen);
157 if (strict_strtoul(buf, 0, &val) != 0)
163 static int nfs_map_numeric_to_string(__u32 id, char *buf, size_t buflen)
165 return snprintf(buf, buflen, "%u", id);
168 static struct key_type key_type_id_resolver = {
169 .name = "id_resolver",
170 .instantiate = user_instantiate,
172 .revoke = user_revoke,
173 .destroy = user_destroy,
174 .describe = user_describe,
178 static int nfs_idmap_init_keyring(void)
184 printk(KERN_NOTICE "NFS: Registering the %s key type\n",
185 key_type_id_resolver.name);
187 cred = prepare_kernel_cred(NULL);
191 keyring = key_alloc(&key_type_keyring, ".id_resolver", 0, 0, cred,
192 (KEY_POS_ALL & ~KEY_POS_SETATTR) |
193 KEY_USR_VIEW | KEY_USR_READ,
194 KEY_ALLOC_NOT_IN_QUOTA);
195 if (IS_ERR(keyring)) {
196 ret = PTR_ERR(keyring);
197 goto failed_put_cred;
200 ret = key_instantiate_and_link(keyring, NULL, 0, NULL, NULL);
204 ret = register_key_type(&key_type_id_resolver);
208 set_bit(KEY_FLAG_ROOT_CAN_CLEAR, &keyring->flags);
209 cred->thread_keyring = keyring;
210 cred->jit_keyring = KEY_REQKEY_DEFL_THREAD_KEYRING;
211 id_resolver_cache = cred;
221 static void nfs_idmap_quit_keyring(void)
223 key_revoke(id_resolver_cache->thread_keyring);
224 unregister_key_type(&key_type_id_resolver);
225 put_cred(id_resolver_cache);
229 * Assemble the description to pass to request_key()
230 * This function will allocate a new string and update dest to point
231 * at it. The caller is responsible for freeing dest.
233 * On error 0 is returned. Otherwise, the length of dest is returned.
235 static ssize_t nfs_idmap_get_desc(const char *name, size_t namelen,
236 const char *type, size_t typelen, char **desc)
239 size_t desclen = typelen + namelen + 2;
241 *desc = kmalloc(desclen, GFP_KERNEL);
246 memcpy(cp, type, typelen);
250 memcpy(cp, name, namelen);
256 static ssize_t nfs_idmap_request_key(struct key_type *key_type,
257 const char *name, size_t namelen,
258 const char *type, void *data,
259 size_t data_size, struct idmap *idmap)
261 const struct cred *saved_cred;
264 struct user_key_payload *payload;
267 ret = nfs_idmap_get_desc(name, namelen, type, strlen(type), &desc);
271 saved_cred = override_creds(id_resolver_cache);
273 rkey = request_key_with_auxdata(key_type, desc, "", 0, idmap);
275 rkey = request_key(&key_type_id_resolver, desc, "");
276 revert_creds(saved_cred);
285 rkey->perm |= KEY_USR_VIEW;
287 ret = key_validate(rkey);
291 payload = rcu_dereference(rkey->payload.data);
292 if (IS_ERR_OR_NULL(payload)) {
293 ret = PTR_ERR(payload);
297 ret = payload->datalen;
298 if (ret > 0 && ret <= data_size)
299 memcpy(data, payload->data, ret);
310 static ssize_t nfs_idmap_get_key(const char *name, size_t namelen,
311 const char *type, void *data,
312 size_t data_size, struct idmap *idmap)
314 ssize_t ret = nfs_idmap_request_key(&key_type_id_resolver,
315 name, namelen, type, data,
318 mutex_lock(&idmap->idmap_mutex);
319 ret = nfs_idmap_request_key(&key_type_id_resolver_legacy,
320 name, namelen, type, data,
322 mutex_unlock(&idmap->idmap_mutex);
328 static ssize_t nfs_idmap_lookup_name(__u32 id, const char *type, char *buf,
329 size_t buflen, struct idmap *idmap)
331 char id_str[NFS_UINT_MAXLEN];
335 id_len = snprintf(id_str, sizeof(id_str), "%u", id);
336 ret = nfs_idmap_get_key(id_str, id_len, type, buf, buflen, idmap);
343 static int nfs_idmap_lookup_id(const char *name, size_t namelen, const char *type,
344 __u32 *id, struct idmap *idmap)
346 char id_str[NFS_UINT_MAXLEN];
351 data_size = nfs_idmap_get_key(name, namelen, type, id_str, NFS_UINT_MAXLEN, idmap);
352 if (data_size <= 0) {
355 ret = strict_strtol(id_str, 10, &id_long);
356 *id = (__u32)id_long;
361 /* idmap classic begins here */
362 module_param(nfs_idmap_cache_timeout, int, 0644);
365 Opt_find_uid, Opt_find_gid, Opt_find_user, Opt_find_group, Opt_find_err
368 static const match_table_t nfs_idmap_tokens = {
369 { Opt_find_uid, "uid:%s" },
370 { Opt_find_gid, "gid:%s" },
371 { Opt_find_user, "user:%s" },
372 { Opt_find_group, "group:%s" },
373 { Opt_find_err, NULL }
376 static int nfs_idmap_legacy_upcall(struct key_construction *, const char *, void *);
377 static ssize_t idmap_pipe_downcall(struct file *, const char __user *,
379 static void idmap_pipe_destroy_msg(struct rpc_pipe_msg *);
381 static const struct rpc_pipe_ops idmap_upcall_ops = {
382 .upcall = rpc_pipe_generic_upcall,
383 .downcall = idmap_pipe_downcall,
384 .destroy_msg = idmap_pipe_destroy_msg,
387 static struct key_type key_type_id_resolver_legacy = {
388 .name = "id_resolver",
389 .instantiate = user_instantiate,
391 .revoke = user_revoke,
392 .destroy = user_destroy,
393 .describe = user_describe,
395 .request_key = nfs_idmap_legacy_upcall,
398 static void __nfs_idmap_unregister(struct rpc_pipe *pipe)
401 rpc_unlink(pipe->dentry);
404 static int __nfs_idmap_register(struct dentry *dir,
406 struct rpc_pipe *pipe)
408 struct dentry *dentry;
410 dentry = rpc_mkpipe_dentry(dir, "idmap", idmap, pipe);
412 return PTR_ERR(dentry);
413 pipe->dentry = dentry;
417 static void nfs_idmap_unregister(struct nfs_client *clp,
418 struct rpc_pipe *pipe)
420 struct net *net = clp->cl_net;
421 struct super_block *pipefs_sb;
423 pipefs_sb = rpc_get_sb_net(net);
425 __nfs_idmap_unregister(pipe);
430 static int nfs_idmap_register(struct nfs_client *clp,
432 struct rpc_pipe *pipe)
434 struct net *net = clp->cl_net;
435 struct super_block *pipefs_sb;
438 pipefs_sb = rpc_get_sb_net(net);
440 if (clp->cl_rpcclient->cl_dentry)
441 err = __nfs_idmap_register(clp->cl_rpcclient->cl_dentry,
449 nfs_idmap_new(struct nfs_client *clp)
452 struct rpc_pipe *pipe;
455 BUG_ON(clp->cl_idmap != NULL);
457 idmap = kzalloc(sizeof(*idmap), GFP_KERNEL);
461 pipe = rpc_mkpipe_data(&idmap_upcall_ops, 0);
463 error = PTR_ERR(pipe);
467 error = nfs_idmap_register(clp, idmap, pipe);
469 rpc_destroy_pipe_data(pipe);
473 idmap->idmap_pipe = pipe;
474 mutex_init(&idmap->idmap_mutex);
476 clp->cl_idmap = idmap;
481 nfs_idmap_delete(struct nfs_client *clp)
483 struct idmap *idmap = clp->cl_idmap;
487 nfs_idmap_unregister(clp, idmap->idmap_pipe);
488 rpc_destroy_pipe_data(idmap->idmap_pipe);
489 clp->cl_idmap = NULL;
493 static int __rpc_pipefs_event(struct nfs_client *clp, unsigned long event,
494 struct super_block *sb)
499 case RPC_PIPEFS_MOUNT:
500 BUG_ON(clp->cl_rpcclient->cl_dentry == NULL);
501 err = __nfs_idmap_register(clp->cl_rpcclient->cl_dentry,
503 clp->cl_idmap->idmap_pipe);
505 case RPC_PIPEFS_UMOUNT:
506 if (clp->cl_idmap->idmap_pipe) {
507 struct dentry *parent;
509 parent = clp->cl_idmap->idmap_pipe->dentry->d_parent;
510 __nfs_idmap_unregister(clp->cl_idmap->idmap_pipe);
512 * Note: This is a dirty hack. SUNRPC hook has been
513 * called already but simple_rmdir() call for the
514 * directory returned with error because of idmap pipe
515 * inside. Thus now we have to remove this directory
518 if (rpc_rmdir(parent))
519 printk(KERN_ERR "NFS: %s: failed to remove "
520 "clnt dir!\n", __func__);
524 printk(KERN_ERR "NFS: %s: unknown event: %ld\n", __func__,
531 static struct nfs_client *nfs_get_client_for_event(struct net *net, int event)
533 struct nfs_net *nn = net_generic(net, nfs_net_id);
534 struct dentry *cl_dentry;
535 struct nfs_client *clp;
539 spin_lock(&nn->nfs_client_lock);
540 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
541 /* Wait for initialisation to finish */
542 if (clp->cl_cons_state == NFS_CS_INITING) {
543 atomic_inc(&clp->cl_count);
544 spin_unlock(&nn->nfs_client_lock);
545 err = nfs_wait_client_init_complete(clp);
551 /* Skip nfs_clients that failed to initialise */
552 if (clp->cl_cons_state < 0)
555 if (clp->rpc_ops != &nfs_v4_clientops)
557 cl_dentry = clp->cl_idmap->idmap_pipe->dentry;
558 if (((event == RPC_PIPEFS_MOUNT) && cl_dentry) ||
559 ((event == RPC_PIPEFS_UMOUNT) && !cl_dentry))
561 atomic_inc(&clp->cl_count);
562 spin_unlock(&nn->nfs_client_lock);
565 spin_unlock(&nn->nfs_client_lock);
569 static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
572 struct super_block *sb = ptr;
573 struct nfs_client *clp;
576 if (!try_module_get(THIS_MODULE))
579 while ((clp = nfs_get_client_for_event(sb->s_fs_info, event))) {
580 error = __rpc_pipefs_event(clp, event, sb);
585 module_put(THIS_MODULE);
589 #define PIPEFS_NFS_PRIO 1
591 static struct notifier_block nfs_idmap_block = {
592 .notifier_call = rpc_pipefs_event,
593 .priority = SUNRPC_PIPEFS_NFS_PRIO,
596 int nfs_idmap_init(void)
599 ret = nfs_idmap_init_keyring();
602 ret = rpc_pipefs_notifier_register(&nfs_idmap_block);
604 nfs_idmap_quit_keyring();
609 void nfs_idmap_quit(void)
611 rpc_pipefs_notifier_unregister(&nfs_idmap_block);
612 nfs_idmap_quit_keyring();
615 static int nfs_idmap_prepare_message(char *desc, struct idmap_msg *im,
616 struct rpc_pipe_msg *msg)
621 memset(im, 0, sizeof(*im));
622 memset(msg, 0, sizeof(*msg));
624 im->im_type = IDMAP_TYPE_GROUP;
625 token = match_token(desc, nfs_idmap_tokens, &substr);
629 im->im_type = IDMAP_TYPE_USER;
631 im->im_conv = IDMAP_CONV_NAMETOID;
632 ret = match_strlcpy(im->im_name, &substr, IDMAP_NAMESZ);
636 im->im_type = IDMAP_TYPE_USER;
638 im->im_conv = IDMAP_CONV_IDTONAME;
639 ret = match_int(&substr, &im->im_id);
648 msg->len = sizeof(struct idmap_msg);
654 static int nfs_idmap_legacy_upcall(struct key_construction *cons,
658 struct rpc_pipe_msg *msg;
659 struct idmap_msg *im;
660 struct idmap *idmap = (struct idmap *)aux;
661 struct key *key = cons->key;
664 /* msg and im are freed in idmap_pipe_destroy_msg */
665 msg = kmalloc(sizeof(*msg), GFP_KERNEL);
669 im = kmalloc(sizeof(*im), GFP_KERNEL);
673 ret = nfs_idmap_prepare_message(key->description, im, msg);
677 idmap->idmap_key_cons = cons;
679 ret = rpc_queue_upcall(idmap->idmap_pipe, msg);
690 key_revoke(cons->key);
691 key_revoke(cons->authkey);
695 static int nfs_idmap_instantiate(struct key *key, struct key *authkey, char *data)
697 return key_instantiate_and_link(key, data, strlen(data) + 1,
698 id_resolver_cache->thread_keyring,
702 static int nfs_idmap_read_message(struct idmap_msg *im, struct key *key, struct key *authkey)
704 char id_str[NFS_UINT_MAXLEN];
707 switch (im->im_conv) {
708 case IDMAP_CONV_NAMETOID:
709 sprintf(id_str, "%d", im->im_id);
710 ret = nfs_idmap_instantiate(key, authkey, id_str);
712 case IDMAP_CONV_IDTONAME:
713 ret = nfs_idmap_instantiate(key, authkey, im->im_name);
721 idmap_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
723 struct rpc_inode *rpci = RPC_I(filp->f_path.dentry->d_inode);
724 struct idmap *idmap = (struct idmap *)rpci->private;
725 struct key_construction *cons = idmap->idmap_key_cons;
730 if (mlen != sizeof(im)) {
735 if (copy_from_user(&im, src, mlen) != 0) {
740 if (!(im.im_status & IDMAP_STATUS_SUCCESS)) {
742 complete_request_key(idmap->idmap_key_cons, -ENOKEY);
746 namelen_in = strnlen(im.im_name, IDMAP_NAMESZ);
747 if (namelen_in == 0 || namelen_in == IDMAP_NAMESZ) {
752 ret = nfs_idmap_read_message(&im, cons->key, cons->authkey);
754 key_set_timeout(cons->key, nfs_idmap_cache_timeout);
759 complete_request_key(idmap->idmap_key_cons, ret);
765 idmap_pipe_destroy_msg(struct rpc_pipe_msg *msg)
767 /* Free memory allocated in nfs_idmap_legacy_upcall() */
772 int nfs_map_name_to_uid(const struct nfs_server *server, const char *name, size_t namelen, __u32 *uid)
774 struct idmap *idmap = server->nfs_client->cl_idmap;
776 if (nfs_map_string_to_numeric(name, namelen, uid))
778 return nfs_idmap_lookup_id(name, namelen, "uid", uid, idmap);
781 int nfs_map_group_to_gid(const struct nfs_server *server, const char *name, size_t namelen, __u32 *gid)
783 struct idmap *idmap = server->nfs_client->cl_idmap;
785 if (nfs_map_string_to_numeric(name, namelen, gid))
787 return nfs_idmap_lookup_id(name, namelen, "gid", gid, idmap);
790 int nfs_map_uid_to_name(const struct nfs_server *server, __u32 uid, char *buf, size_t buflen)
792 struct idmap *idmap = server->nfs_client->cl_idmap;
795 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
796 ret = nfs_idmap_lookup_name(uid, "user", buf, buflen, idmap);
798 ret = nfs_map_numeric_to_string(uid, buf, buflen);
801 int nfs_map_gid_to_group(const struct nfs_server *server, __u32 gid, char *buf, size_t buflen)
803 struct idmap *idmap = server->nfs_client->cl_idmap;
806 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
807 ret = nfs_idmap_lookup_name(gid, "group", buf, buflen, idmap);
809 ret = nfs_map_numeric_to_string(gid, buf, buflen);