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/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;
65 * nfs_fattr_init_names - initialise the nfs_fattr owner_name/group_name fields
66 * @fattr: fully initialised struct nfs_fattr
67 * @owner_name: owner name string cache
68 * @group_name: group name string cache
70 void nfs_fattr_init_names(struct nfs_fattr *fattr,
71 struct nfs4_string *owner_name,
72 struct nfs4_string *group_name)
74 fattr->owner_name = owner_name;
75 fattr->group_name = group_name;
78 static void nfs_fattr_free_owner_name(struct nfs_fattr *fattr)
80 fattr->valid &= ~NFS_ATTR_FATTR_OWNER_NAME;
81 kfree(fattr->owner_name->data);
84 static void nfs_fattr_free_group_name(struct nfs_fattr *fattr)
86 fattr->valid &= ~NFS_ATTR_FATTR_GROUP_NAME;
87 kfree(fattr->group_name->data);
90 static bool nfs_fattr_map_owner_name(struct nfs_server *server, struct nfs_fattr *fattr)
92 struct nfs4_string *owner = fattr->owner_name;
95 if (!(fattr->valid & NFS_ATTR_FATTR_OWNER_NAME))
97 if (nfs_map_name_to_uid(server, owner->data, owner->len, &uid) == 0) {
99 fattr->valid |= NFS_ATTR_FATTR_OWNER;
104 static bool nfs_fattr_map_group_name(struct nfs_server *server, struct nfs_fattr *fattr)
106 struct nfs4_string *group = fattr->group_name;
109 if (!(fattr->valid & NFS_ATTR_FATTR_GROUP_NAME))
111 if (nfs_map_group_to_gid(server, group->data, group->len, &gid) == 0) {
113 fattr->valid |= NFS_ATTR_FATTR_GROUP;
119 * nfs_fattr_free_names - free up the NFSv4 owner and group strings
120 * @fattr: a fully initialised nfs_fattr structure
122 void nfs_fattr_free_names(struct nfs_fattr *fattr)
124 if (fattr->valid & NFS_ATTR_FATTR_OWNER_NAME)
125 nfs_fattr_free_owner_name(fattr);
126 if (fattr->valid & NFS_ATTR_FATTR_GROUP_NAME)
127 nfs_fattr_free_group_name(fattr);
131 * nfs_fattr_map_and_free_names - map owner/group strings into uid/gid and free
132 * @server: pointer to the filesystem nfs_server structure
133 * @fattr: a fully initialised nfs_fattr structure
135 * This helper maps the cached NFSv4 owner/group strings in fattr into
136 * their numeric uid/gid equivalents, and then frees the cached strings.
138 void nfs_fattr_map_and_free_names(struct nfs_server *server, struct nfs_fattr *fattr)
140 if (nfs_fattr_map_owner_name(server, fattr))
141 nfs_fattr_free_owner_name(fattr);
142 if (nfs_fattr_map_group_name(server, fattr))
143 nfs_fattr_free_group_name(fattr);
146 static int nfs_map_string_to_numeric(const char *name, size_t namelen, __u32 *res)
151 if (memchr(name, '@', namelen) != NULL || namelen >= sizeof(buf))
153 memcpy(buf, name, namelen);
155 if (strict_strtoul(buf, 0, &val) != 0)
161 static int nfs_map_numeric_to_string(__u32 id, char *buf, size_t buflen)
163 return snprintf(buf, buflen, "%u", id);
166 static struct key_type key_type_id_resolver = {
167 .name = "id_resolver",
168 .instantiate = user_instantiate,
170 .revoke = user_revoke,
171 .destroy = user_destroy,
172 .describe = user_describe,
176 static int nfs_idmap_init_keyring(void)
182 printk(KERN_NOTICE "NFS: Registering the %s key type\n",
183 key_type_id_resolver.name);
185 cred = prepare_kernel_cred(NULL);
189 keyring = key_alloc(&key_type_keyring, ".id_resolver", 0, 0, cred,
190 (KEY_POS_ALL & ~KEY_POS_SETATTR) |
191 KEY_USR_VIEW | KEY_USR_READ,
192 KEY_ALLOC_NOT_IN_QUOTA);
193 if (IS_ERR(keyring)) {
194 ret = PTR_ERR(keyring);
195 goto failed_put_cred;
198 ret = key_instantiate_and_link(keyring, NULL, 0, NULL, NULL);
202 ret = register_key_type(&key_type_id_resolver);
206 ret = register_key_type(&key_type_id_resolver_legacy);
208 goto failed_reg_legacy;
210 set_bit(KEY_FLAG_ROOT_CAN_CLEAR, &keyring->flags);
211 cred->thread_keyring = keyring;
212 cred->jit_keyring = KEY_REQKEY_DEFL_THREAD_KEYRING;
213 id_resolver_cache = cred;
217 unregister_key_type(&key_type_id_resolver);
225 static void nfs_idmap_quit_keyring(void)
227 key_revoke(id_resolver_cache->thread_keyring);
228 unregister_key_type(&key_type_id_resolver);
229 unregister_key_type(&key_type_id_resolver_legacy);
230 put_cred(id_resolver_cache);
234 * Assemble the description to pass to request_key()
235 * This function will allocate a new string and update dest to point
236 * at it. The caller is responsible for freeing dest.
238 * On error 0 is returned. Otherwise, the length of dest is returned.
240 static ssize_t nfs_idmap_get_desc(const char *name, size_t namelen,
241 const char *type, size_t typelen, char **desc)
244 size_t desclen = typelen + namelen + 2;
246 *desc = kmalloc(desclen, GFP_KERNEL);
251 memcpy(cp, type, typelen);
255 memcpy(cp, name, namelen);
261 static ssize_t nfs_idmap_request_key(struct key_type *key_type,
262 const char *name, size_t namelen,
263 const char *type, void *data,
264 size_t data_size, struct idmap *idmap)
266 const struct cred *saved_cred;
269 struct user_key_payload *payload;
272 ret = nfs_idmap_get_desc(name, namelen, type, strlen(type), &desc);
276 saved_cred = override_creds(id_resolver_cache);
278 rkey = request_key_with_auxdata(key_type, desc, "", 0, idmap);
280 rkey = request_key(&key_type_id_resolver, desc, "");
281 revert_creds(saved_cred);
290 rkey->perm |= KEY_USR_VIEW;
292 ret = key_validate(rkey);
296 payload = rcu_dereference(rkey->payload.data);
297 if (IS_ERR_OR_NULL(payload)) {
298 ret = PTR_ERR(payload);
302 ret = payload->datalen;
303 if (ret > 0 && ret <= data_size)
304 memcpy(data, payload->data, ret);
315 static ssize_t nfs_idmap_get_key(const char *name, size_t namelen,
316 const char *type, void *data,
317 size_t data_size, struct idmap *idmap)
319 ssize_t ret = nfs_idmap_request_key(&key_type_id_resolver,
320 name, namelen, type, data,
323 mutex_lock(&idmap->idmap_mutex);
324 ret = nfs_idmap_request_key(&key_type_id_resolver_legacy,
325 name, namelen, type, data,
327 mutex_unlock(&idmap->idmap_mutex);
333 static ssize_t nfs_idmap_lookup_name(__u32 id, const char *type, char *buf,
334 size_t buflen, struct idmap *idmap)
336 char id_str[NFS_UINT_MAXLEN];
340 id_len = snprintf(id_str, sizeof(id_str), "%u", id);
341 ret = nfs_idmap_get_key(id_str, id_len, type, buf, buflen, idmap);
348 static int nfs_idmap_lookup_id(const char *name, size_t namelen, const char *type,
349 __u32 *id, struct idmap *idmap)
351 char id_str[NFS_UINT_MAXLEN];
356 data_size = nfs_idmap_get_key(name, namelen, type, id_str, NFS_UINT_MAXLEN, idmap);
357 if (data_size <= 0) {
360 ret = strict_strtol(id_str, 10, &id_long);
361 *id = (__u32)id_long;
366 /* idmap classic begins here */
369 Opt_find_uid, Opt_find_gid, Opt_find_user, Opt_find_group, Opt_find_err
372 static const match_table_t nfs_idmap_tokens = {
373 { Opt_find_uid, "uid:%s" },
374 { Opt_find_gid, "gid:%s" },
375 { Opt_find_user, "user:%s" },
376 { Opt_find_group, "group:%s" },
377 { Opt_find_err, NULL }
380 static int nfs_idmap_legacy_upcall(struct key_construction *, const char *, void *);
381 static ssize_t idmap_pipe_downcall(struct file *, const char __user *,
383 static void idmap_pipe_destroy_msg(struct rpc_pipe_msg *);
385 static const struct rpc_pipe_ops idmap_upcall_ops = {
386 .upcall = rpc_pipe_generic_upcall,
387 .downcall = idmap_pipe_downcall,
388 .destroy_msg = idmap_pipe_destroy_msg,
391 static struct key_type key_type_id_resolver_legacy = {
393 .instantiate = user_instantiate,
395 .revoke = user_revoke,
396 .destroy = user_destroy,
397 .describe = user_describe,
399 .request_key = nfs_idmap_legacy_upcall,
402 static void __nfs_idmap_unregister(struct rpc_pipe *pipe)
405 rpc_unlink(pipe->dentry);
408 static int __nfs_idmap_register(struct dentry *dir,
410 struct rpc_pipe *pipe)
412 struct dentry *dentry;
414 dentry = rpc_mkpipe_dentry(dir, "idmap", idmap, pipe);
416 return PTR_ERR(dentry);
417 pipe->dentry = dentry;
421 static void nfs_idmap_unregister(struct nfs_client *clp,
422 struct rpc_pipe *pipe)
424 struct net *net = clp->cl_net;
425 struct super_block *pipefs_sb;
427 pipefs_sb = rpc_get_sb_net(net);
429 __nfs_idmap_unregister(pipe);
434 static int nfs_idmap_register(struct nfs_client *clp,
436 struct rpc_pipe *pipe)
438 struct net *net = clp->cl_net;
439 struct super_block *pipefs_sb;
442 pipefs_sb = rpc_get_sb_net(net);
444 if (clp->cl_rpcclient->cl_dentry)
445 err = __nfs_idmap_register(clp->cl_rpcclient->cl_dentry,
453 nfs_idmap_new(struct nfs_client *clp)
456 struct rpc_pipe *pipe;
459 BUG_ON(clp->cl_idmap != NULL);
461 idmap = kzalloc(sizeof(*idmap), GFP_KERNEL);
465 pipe = rpc_mkpipe_data(&idmap_upcall_ops, 0);
467 error = PTR_ERR(pipe);
471 error = nfs_idmap_register(clp, idmap, pipe);
473 rpc_destroy_pipe_data(pipe);
477 idmap->idmap_pipe = pipe;
478 mutex_init(&idmap->idmap_mutex);
480 clp->cl_idmap = idmap;
485 nfs_idmap_delete(struct nfs_client *clp)
487 struct idmap *idmap = clp->cl_idmap;
491 nfs_idmap_unregister(clp, idmap->idmap_pipe);
492 rpc_destroy_pipe_data(idmap->idmap_pipe);
493 clp->cl_idmap = NULL;
497 static int __rpc_pipefs_event(struct nfs_client *clp, unsigned long event,
498 struct super_block *sb)
503 case RPC_PIPEFS_MOUNT:
504 BUG_ON(clp->cl_rpcclient->cl_dentry == NULL);
505 err = __nfs_idmap_register(clp->cl_rpcclient->cl_dentry,
507 clp->cl_idmap->idmap_pipe);
509 case RPC_PIPEFS_UMOUNT:
510 if (clp->cl_idmap->idmap_pipe) {
511 struct dentry *parent;
513 parent = clp->cl_idmap->idmap_pipe->dentry->d_parent;
514 __nfs_idmap_unregister(clp->cl_idmap->idmap_pipe);
516 * Note: This is a dirty hack. SUNRPC hook has been
517 * called already but simple_rmdir() call for the
518 * directory returned with error because of idmap pipe
519 * inside. Thus now we have to remove this directory
522 if (rpc_rmdir(parent))
523 printk(KERN_ERR "NFS: %s: failed to remove "
524 "clnt dir!\n", __func__);
528 printk(KERN_ERR "NFS: %s: unknown event: %ld\n", __func__,
535 static struct nfs_client *nfs_get_client_for_event(struct net *net, int event)
537 struct nfs_net *nn = net_generic(net, nfs_net_id);
538 struct dentry *cl_dentry;
539 struct nfs_client *clp;
543 spin_lock(&nn->nfs_client_lock);
544 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
545 /* Wait for initialisation to finish */
546 if (clp->cl_cons_state == NFS_CS_INITING) {
547 atomic_inc(&clp->cl_count);
548 spin_unlock(&nn->nfs_client_lock);
549 err = nfs_wait_client_init_complete(clp);
555 /* Skip nfs_clients that failed to initialise */
556 if (clp->cl_cons_state < 0)
559 if (clp->rpc_ops != &nfs_v4_clientops)
561 cl_dentry = clp->cl_idmap->idmap_pipe->dentry;
562 if (((event == RPC_PIPEFS_MOUNT) && cl_dentry) ||
563 ((event == RPC_PIPEFS_UMOUNT) && !cl_dentry))
565 atomic_inc(&clp->cl_count);
566 spin_unlock(&nn->nfs_client_lock);
569 spin_unlock(&nn->nfs_client_lock);
573 static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
576 struct super_block *sb = ptr;
577 struct nfs_client *clp;
580 if (!try_module_get(THIS_MODULE))
583 while ((clp = nfs_get_client_for_event(sb->s_fs_info, event))) {
584 error = __rpc_pipefs_event(clp, event, sb);
589 module_put(THIS_MODULE);
593 #define PIPEFS_NFS_PRIO 1
595 static struct notifier_block nfs_idmap_block = {
596 .notifier_call = rpc_pipefs_event,
597 .priority = SUNRPC_PIPEFS_NFS_PRIO,
600 int nfs_idmap_init(void)
603 ret = nfs_idmap_init_keyring();
606 ret = rpc_pipefs_notifier_register(&nfs_idmap_block);
608 nfs_idmap_quit_keyring();
613 void nfs_idmap_quit(void)
615 rpc_pipefs_notifier_unregister(&nfs_idmap_block);
616 nfs_idmap_quit_keyring();
619 static int nfs_idmap_prepare_message(char *desc, struct idmap_msg *im,
620 struct rpc_pipe_msg *msg)
625 memset(im, 0, sizeof(*im));
626 memset(msg, 0, sizeof(*msg));
628 im->im_type = IDMAP_TYPE_GROUP;
629 token = match_token(desc, nfs_idmap_tokens, &substr);
633 im->im_type = IDMAP_TYPE_USER;
635 im->im_conv = IDMAP_CONV_NAMETOID;
636 ret = match_strlcpy(im->im_name, &substr, IDMAP_NAMESZ);
640 im->im_type = IDMAP_TYPE_USER;
642 im->im_conv = IDMAP_CONV_IDTONAME;
643 ret = match_int(&substr, &im->im_id);
652 msg->len = sizeof(struct idmap_msg);
658 static int nfs_idmap_legacy_upcall(struct key_construction *cons,
662 struct rpc_pipe_msg *msg;
663 struct idmap_msg *im;
664 struct idmap *idmap = (struct idmap *)aux;
665 struct key *key = cons->key;
668 /* msg and im are freed in idmap_pipe_destroy_msg */
669 msg = kmalloc(sizeof(*msg), GFP_KERNEL);
673 im = kmalloc(sizeof(*im), GFP_KERNEL);
677 ret = nfs_idmap_prepare_message(key->description, im, msg);
681 BUG_ON(idmap->idmap_key_cons != NULL);
682 idmap->idmap_key_cons = cons;
684 ret = rpc_queue_upcall(idmap->idmap_pipe, msg);
695 complete_request_key(cons, ret);
699 static int nfs_idmap_instantiate(struct key *key, struct key *authkey, char *data)
701 return key_instantiate_and_link(key, data, strlen(data) + 1,
702 id_resolver_cache->thread_keyring,
706 static int nfs_idmap_read_message(struct idmap_msg *im, struct key *key, struct key *authkey)
708 char id_str[NFS_UINT_MAXLEN];
711 switch (im->im_conv) {
712 case IDMAP_CONV_NAMETOID:
713 sprintf(id_str, "%d", im->im_id);
714 ret = nfs_idmap_instantiate(key, authkey, id_str);
716 case IDMAP_CONV_IDTONAME:
717 ret = nfs_idmap_instantiate(key, authkey, im->im_name);
725 idmap_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
727 struct rpc_inode *rpci = RPC_I(filp->f_path.dentry->d_inode);
728 struct idmap *idmap = (struct idmap *)rpci->private;
729 struct key_construction *cons;
734 /* If instantiation is successful, anyone waiting for key construction
735 * will have been woken up and someone else may now have used
736 * idmap_key_cons - so after this point we may no longer touch it.
738 cons = ACCESS_ONCE(idmap->idmap_key_cons);
739 idmap->idmap_key_cons = NULL;
741 if (mlen != sizeof(im)) {
746 if (copy_from_user(&im, src, mlen) != 0) {
751 if (!(im.im_status & IDMAP_STATUS_SUCCESS)) {
753 complete_request_key(cons, -ENOKEY);
757 namelen_in = strnlen(im.im_name, IDMAP_NAMESZ);
758 if (namelen_in == 0 || namelen_in == IDMAP_NAMESZ) {
763 ret = nfs_idmap_read_message(&im, cons->key, cons->authkey);
765 key_set_timeout(cons->key, nfs_idmap_cache_timeout);
770 complete_request_key(cons, ret);
776 idmap_pipe_destroy_msg(struct rpc_pipe_msg *msg)
778 /* Free memory allocated in nfs_idmap_legacy_upcall() */
783 int nfs_map_name_to_uid(const struct nfs_server *server, const char *name, size_t namelen, __u32 *uid)
785 struct idmap *idmap = server->nfs_client->cl_idmap;
787 if (nfs_map_string_to_numeric(name, namelen, uid))
789 return nfs_idmap_lookup_id(name, namelen, "uid", uid, idmap);
792 int nfs_map_group_to_gid(const struct nfs_server *server, const char *name, size_t namelen, __u32 *gid)
794 struct idmap *idmap = server->nfs_client->cl_idmap;
796 if (nfs_map_string_to_numeric(name, namelen, gid))
798 return nfs_idmap_lookup_id(name, namelen, "gid", gid, idmap);
801 int nfs_map_uid_to_name(const struct nfs_server *server, __u32 uid, 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(uid, "user", buf, buflen, idmap);
809 ret = nfs_map_numeric_to_string(uid, buf, buflen);
812 int nfs_map_gid_to_group(const struct nfs_server *server, __u32 gid, char *buf, size_t buflen)
814 struct idmap *idmap = server->nfs_client->cl_idmap;
817 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
818 ret = nfs_idmap_lookup_name(gid, "group", buf, buflen, idmap);
820 ret = nfs_map_numeric_to_string(gid, buf, buflen);