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 <net/net_namespace.h>
40 #include <linux/sunrpc/rpc_pipe_fs.h>
41 #include <linux/nfs_fs.h>
42 #include <linux/nfs_fs_sb.h>
43 #include <linux/key.h>
44 #include <linux/keyctl.h>
45 #include <linux/key-type.h>
46 #include <keys/user-type.h>
47 #include <keys/request_key_auth-type.h>
48 #include <linux/module.h>
49 #include <linux/user_namespace.h>
53 #include "nfs4idmap.h"
54 #include "nfs4trace.h"
56 #define NFS_UINT_MAXLEN 11
58 static const struct cred *id_resolver_cache;
59 static struct key_type key_type_id_resolver_legacy;
61 struct idmap_legacy_upcalldata {
62 struct rpc_pipe_msg pipe_msg;
63 struct idmap_msg idmap_msg;
69 struct rpc_pipe_dir_object idmap_pdo;
70 struct rpc_pipe *idmap_pipe;
71 struct idmap_legacy_upcalldata *idmap_upcall_data;
72 struct mutex idmap_mutex;
73 struct user_namespace *user_ns;
76 static struct user_namespace *idmap_userns(const struct idmap *idmap)
78 if (idmap && idmap->user_ns)
79 return idmap->user_ns;
84 * nfs_fattr_init_names - initialise the nfs_fattr owner_name/group_name fields
85 * @fattr: fully initialised struct nfs_fattr
86 * @owner_name: owner name string cache
87 * @group_name: group name string cache
89 void nfs_fattr_init_names(struct nfs_fattr *fattr,
90 struct nfs4_string *owner_name,
91 struct nfs4_string *group_name)
93 fattr->owner_name = owner_name;
94 fattr->group_name = group_name;
97 static void nfs_fattr_free_owner_name(struct nfs_fattr *fattr)
99 fattr->valid &= ~NFS_ATTR_FATTR_OWNER_NAME;
100 kfree(fattr->owner_name->data);
103 static void nfs_fattr_free_group_name(struct nfs_fattr *fattr)
105 fattr->valid &= ~NFS_ATTR_FATTR_GROUP_NAME;
106 kfree(fattr->group_name->data);
109 static bool nfs_fattr_map_owner_name(struct nfs_server *server, struct nfs_fattr *fattr)
111 struct nfs4_string *owner = fattr->owner_name;
114 if (!(fattr->valid & NFS_ATTR_FATTR_OWNER_NAME))
116 if (nfs_map_name_to_uid(server, owner->data, owner->len, &uid) == 0) {
118 fattr->valid |= NFS_ATTR_FATTR_OWNER;
123 static bool nfs_fattr_map_group_name(struct nfs_server *server, struct nfs_fattr *fattr)
125 struct nfs4_string *group = fattr->group_name;
128 if (!(fattr->valid & NFS_ATTR_FATTR_GROUP_NAME))
130 if (nfs_map_group_to_gid(server, group->data, group->len, &gid) == 0) {
132 fattr->valid |= NFS_ATTR_FATTR_GROUP;
138 * nfs_fattr_free_names - free up the NFSv4 owner and group strings
139 * @fattr: a fully initialised nfs_fattr structure
141 void nfs_fattr_free_names(struct nfs_fattr *fattr)
143 if (fattr->valid & NFS_ATTR_FATTR_OWNER_NAME)
144 nfs_fattr_free_owner_name(fattr);
145 if (fattr->valid & NFS_ATTR_FATTR_GROUP_NAME)
146 nfs_fattr_free_group_name(fattr);
150 * nfs_fattr_map_and_free_names - map owner/group strings into uid/gid and free
151 * @server: pointer to the filesystem nfs_server structure
152 * @fattr: a fully initialised nfs_fattr structure
154 * This helper maps the cached NFSv4 owner/group strings in fattr into
155 * their numeric uid/gid equivalents, and then frees the cached strings.
157 void nfs_fattr_map_and_free_names(struct nfs_server *server, struct nfs_fattr *fattr)
159 if (nfs_fattr_map_owner_name(server, fattr))
160 nfs_fattr_free_owner_name(fattr);
161 if (nfs_fattr_map_group_name(server, fattr))
162 nfs_fattr_free_group_name(fattr);
165 int nfs_map_string_to_numeric(const char *name, size_t namelen, __u32 *res)
170 if (memchr(name, '@', namelen) != NULL || namelen >= sizeof(buf))
172 memcpy(buf, name, namelen);
174 if (kstrtoul(buf, 0, &val) != 0)
179 EXPORT_SYMBOL_GPL(nfs_map_string_to_numeric);
181 static int nfs_map_numeric_to_string(__u32 id, char *buf, size_t buflen)
183 return snprintf(buf, buflen, "%u", id);
186 static struct key_type key_type_id_resolver = {
187 .name = "id_resolver",
188 .preparse = user_preparse,
189 .free_preparse = user_free_preparse,
190 .instantiate = generic_key_instantiate,
191 .revoke = user_revoke,
192 .destroy = user_destroy,
193 .describe = user_describe,
197 int nfs_idmap_init(void)
203 printk(KERN_NOTICE "NFS: Registering the %s key type\n",
204 key_type_id_resolver.name);
206 cred = prepare_kernel_cred(NULL);
210 keyring = keyring_alloc(".id_resolver",
211 GLOBAL_ROOT_UID, GLOBAL_ROOT_GID, cred,
212 (KEY_POS_ALL & ~KEY_POS_SETATTR) |
213 KEY_USR_VIEW | KEY_USR_READ,
214 KEY_ALLOC_NOT_IN_QUOTA, NULL, NULL);
215 if (IS_ERR(keyring)) {
216 ret = PTR_ERR(keyring);
217 goto failed_put_cred;
220 ret = register_key_type(&key_type_id_resolver);
224 ret = register_key_type(&key_type_id_resolver_legacy);
226 goto failed_reg_legacy;
228 set_bit(KEY_FLAG_ROOT_CAN_CLEAR, &keyring->flags);
229 cred->thread_keyring = keyring;
230 cred->jit_keyring = KEY_REQKEY_DEFL_THREAD_KEYRING;
231 id_resolver_cache = cred;
235 unregister_key_type(&key_type_id_resolver);
243 void nfs_idmap_quit(void)
245 key_revoke(id_resolver_cache->thread_keyring);
246 unregister_key_type(&key_type_id_resolver);
247 unregister_key_type(&key_type_id_resolver_legacy);
248 put_cred(id_resolver_cache);
252 * Assemble the description to pass to request_key()
253 * This function will allocate a new string and update dest to point
254 * at it. The caller is responsible for freeing dest.
256 * On error 0 is returned. Otherwise, the length of dest is returned.
258 static ssize_t nfs_idmap_get_desc(const char *name, size_t namelen,
259 const char *type, size_t typelen, char **desc)
262 size_t desclen = typelen + namelen + 2;
264 *desc = kmalloc(desclen, GFP_KERNEL);
269 memcpy(cp, type, typelen);
273 memcpy(cp, name, namelen);
279 static struct key *nfs_idmap_request_key(const char *name, size_t namelen,
280 const char *type, struct idmap *idmap)
283 struct key *rkey = ERR_PTR(-EAGAIN);
286 ret = nfs_idmap_get_desc(name, namelen, type, strlen(type), &desc);
290 if (!idmap->user_ns || idmap->user_ns == &init_user_ns)
291 rkey = request_key(&key_type_id_resolver, desc, "");
293 mutex_lock(&idmap->idmap_mutex);
294 rkey = request_key_with_auxdata(&key_type_id_resolver_legacy,
295 desc, NULL, "", 0, idmap);
296 mutex_unlock(&idmap->idmap_mutex);
299 set_bit(KEY_FLAG_ROOT_CAN_INVAL, &rkey->flags);
305 static ssize_t nfs_idmap_get_key(const char *name, size_t namelen,
306 const char *type, void *data,
307 size_t data_size, struct idmap *idmap)
309 const struct cred *saved_cred;
311 const struct user_key_payload *payload;
314 saved_cred = override_creds(id_resolver_cache);
315 rkey = nfs_idmap_request_key(name, namelen, type, idmap);
316 revert_creds(saved_cred);
324 rkey->perm |= KEY_USR_VIEW;
326 ret = key_validate(rkey);
330 payload = user_key_payload_rcu(rkey);
331 if (IS_ERR_OR_NULL(payload)) {
332 ret = PTR_ERR(payload);
336 ret = payload->datalen;
337 if (ret > 0 && ret <= data_size)
338 memcpy(data, payload->data, ret);
350 static ssize_t nfs_idmap_lookup_name(__u32 id, const char *type, char *buf,
351 size_t buflen, struct idmap *idmap)
353 char id_str[NFS_UINT_MAXLEN];
357 id_len = nfs_map_numeric_to_string(id, id_str, sizeof(id_str));
358 ret = nfs_idmap_get_key(id_str, id_len, type, buf, buflen, idmap);
365 static int nfs_idmap_lookup_id(const char *name, size_t namelen, const char *type,
366 __u32 *id, struct idmap *idmap)
368 char id_str[NFS_UINT_MAXLEN];
373 data_size = nfs_idmap_get_key(name, namelen, type, id_str, NFS_UINT_MAXLEN, idmap);
374 if (data_size <= 0) {
377 ret = kstrtol(id_str, 10, &id_long);
379 *id = (__u32)id_long;
384 /* idmap classic begins here */
387 Opt_find_uid, Opt_find_gid, Opt_find_user, Opt_find_group, Opt_find_err
390 static const match_table_t nfs_idmap_tokens = {
391 { Opt_find_uid, "uid:%s" },
392 { Opt_find_gid, "gid:%s" },
393 { Opt_find_user, "user:%s" },
394 { Opt_find_group, "group:%s" },
395 { Opt_find_err, NULL }
398 static int nfs_idmap_legacy_upcall(struct key *, void *);
399 static ssize_t idmap_pipe_downcall(struct file *, const char __user *,
401 static void idmap_release_pipe(struct inode *);
402 static void idmap_pipe_destroy_msg(struct rpc_pipe_msg *);
404 static const struct rpc_pipe_ops idmap_upcall_ops = {
405 .upcall = rpc_pipe_generic_upcall,
406 .downcall = idmap_pipe_downcall,
407 .release_pipe = idmap_release_pipe,
408 .destroy_msg = idmap_pipe_destroy_msg,
411 static struct key_type key_type_id_resolver_legacy = {
413 .preparse = user_preparse,
414 .free_preparse = user_free_preparse,
415 .instantiate = generic_key_instantiate,
416 .revoke = user_revoke,
417 .destroy = user_destroy,
418 .describe = user_describe,
420 .request_key = nfs_idmap_legacy_upcall,
423 static void nfs_idmap_pipe_destroy(struct dentry *dir,
424 struct rpc_pipe_dir_object *pdo)
426 struct idmap *idmap = pdo->pdo_data;
427 struct rpc_pipe *pipe = idmap->idmap_pipe;
430 rpc_unlink(pipe->dentry);
435 static int nfs_idmap_pipe_create(struct dentry *dir,
436 struct rpc_pipe_dir_object *pdo)
438 struct idmap *idmap = pdo->pdo_data;
439 struct rpc_pipe *pipe = idmap->idmap_pipe;
440 struct dentry *dentry;
442 dentry = rpc_mkpipe_dentry(dir, "idmap", idmap, pipe);
444 return PTR_ERR(dentry);
445 pipe->dentry = dentry;
449 static const struct rpc_pipe_dir_object_ops nfs_idmap_pipe_dir_object_ops = {
450 .create = nfs_idmap_pipe_create,
451 .destroy = nfs_idmap_pipe_destroy,
455 nfs_idmap_new(struct nfs_client *clp)
458 struct rpc_pipe *pipe;
461 idmap = kzalloc(sizeof(*idmap), GFP_KERNEL);
465 mutex_init(&idmap->idmap_mutex);
466 idmap->user_ns = get_user_ns(clp->cl_rpcclient->cl_cred->user_ns);
468 rpc_init_pipe_dir_object(&idmap->idmap_pdo,
469 &nfs_idmap_pipe_dir_object_ops,
472 pipe = rpc_mkpipe_data(&idmap_upcall_ops, 0);
474 error = PTR_ERR(pipe);
477 idmap->idmap_pipe = pipe;
479 error = rpc_add_pipe_dir_object(clp->cl_net,
480 &clp->cl_rpcclient->cl_pipedir_objects,
483 goto err_destroy_pipe;
485 clp->cl_idmap = idmap;
488 rpc_destroy_pipe_data(idmap->idmap_pipe);
490 put_user_ns(idmap->user_ns);
496 nfs_idmap_delete(struct nfs_client *clp)
498 struct idmap *idmap = clp->cl_idmap;
502 clp->cl_idmap = NULL;
503 rpc_remove_pipe_dir_object(clp->cl_net,
504 &clp->cl_rpcclient->cl_pipedir_objects,
506 rpc_destroy_pipe_data(idmap->idmap_pipe);
507 put_user_ns(idmap->user_ns);
511 static int nfs_idmap_prepare_message(char *desc, struct idmap *idmap,
512 struct idmap_msg *im,
513 struct rpc_pipe_msg *msg)
518 im->im_type = IDMAP_TYPE_GROUP;
519 token = match_token(desc, nfs_idmap_tokens, &substr);
523 im->im_type = IDMAP_TYPE_USER;
526 im->im_conv = IDMAP_CONV_NAMETOID;
527 ret = match_strlcpy(im->im_name, &substr, IDMAP_NAMESZ);
531 im->im_type = IDMAP_TYPE_USER;
534 im->im_conv = IDMAP_CONV_IDTONAME;
535 ret = match_int(&substr, &im->im_id);
546 msg->len = sizeof(struct idmap_msg);
553 nfs_idmap_prepare_pipe_upcall(struct idmap *idmap,
554 struct idmap_legacy_upcalldata *data)
556 if (idmap->idmap_upcall_data != NULL) {
560 idmap->idmap_upcall_data = data;
564 static void nfs_idmap_complete_pipe_upcall(struct idmap_legacy_upcalldata *data,
567 complete_request_key(data->authkey, ret);
568 key_put(data->authkey);
572 static void nfs_idmap_abort_pipe_upcall(struct idmap *idmap,
573 struct idmap_legacy_upcalldata *data,
576 if (cmpxchg(&idmap->idmap_upcall_data, data, NULL) == data)
577 nfs_idmap_complete_pipe_upcall(data, ret);
580 static int nfs_idmap_legacy_upcall(struct key *authkey, void *aux)
582 struct idmap_legacy_upcalldata *data;
583 struct request_key_auth *rka = get_request_key_auth(authkey);
584 struct rpc_pipe_msg *msg;
585 struct idmap_msg *im;
586 struct idmap *idmap = aux;
587 struct key *key = rka->target_key;
593 /* msg and im are freed in idmap_pipe_destroy_msg */
595 data = kzalloc(sizeof(*data), GFP_KERNEL);
599 msg = &data->pipe_msg;
600 im = &data->idmap_msg;
602 data->authkey = key_get(authkey);
604 ret = nfs_idmap_prepare_message(key->description, idmap, im, msg);
609 if (!nfs_idmap_prepare_pipe_upcall(idmap, data))
612 ret = rpc_queue_upcall(idmap->idmap_pipe, msg);
614 nfs_idmap_abort_pipe_upcall(idmap, data, ret);
620 complete_request_key(authkey, ret);
624 static int nfs_idmap_instantiate(struct key *key, struct key *authkey, char *data, size_t datalen)
626 return key_instantiate_and_link(key, data, datalen,
627 id_resolver_cache->thread_keyring,
631 static int nfs_idmap_read_and_verify_message(struct idmap_msg *im,
632 struct idmap_msg *upcall,
633 struct key *key, struct key *authkey)
635 char id_str[NFS_UINT_MAXLEN];
640 if (upcall->im_type != im->im_type || upcall->im_conv != im->im_conv)
642 switch (im->im_conv) {
643 case IDMAP_CONV_NAMETOID:
644 if (strcmp(upcall->im_name, im->im_name) != 0)
646 /* Note: here we store the NUL terminator too */
647 len = 1 + nfs_map_numeric_to_string(im->im_id, id_str,
649 ret = nfs_idmap_instantiate(key, authkey, id_str, len);
651 case IDMAP_CONV_IDTONAME:
652 if (upcall->im_id != im->im_id)
654 len = strlen(im->im_name);
655 ret = nfs_idmap_instantiate(key, authkey, im->im_name, len);
665 idmap_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
667 struct request_key_auth *rka;
668 struct rpc_inode *rpci = RPC_I(file_inode(filp));
669 struct idmap *idmap = (struct idmap *)rpci->private;
670 struct idmap_legacy_upcalldata *data;
676 /* If instantiation is successful, anyone waiting for key construction
677 * will have been woken up and someone else may now have used
678 * idmap_key_cons - so after this point we may no longer touch it.
680 data = xchg(&idmap->idmap_upcall_data, NULL);
684 authkey = data->authkey;
685 rka = get_request_key_auth(authkey);
687 if (mlen != sizeof(im)) {
692 if (copy_from_user(&im, src, mlen) != 0) {
697 if (!(im.im_status & IDMAP_STATUS_SUCCESS)) {
702 namelen_in = strnlen(im.im_name, IDMAP_NAMESZ);
703 if (namelen_in == 0 || namelen_in == IDMAP_NAMESZ) {
708 ret = nfs_idmap_read_and_verify_message(&im, &data->idmap_msg,
709 rka->target_key, authkey);
711 key_set_timeout(rka->target_key, nfs_idmap_cache_timeout);
716 nfs_idmap_complete_pipe_upcall(data, ret);
722 idmap_pipe_destroy_msg(struct rpc_pipe_msg *msg)
724 struct idmap_legacy_upcalldata *data = container_of(msg,
725 struct idmap_legacy_upcalldata,
727 struct idmap *idmap = data->idmap;
730 nfs_idmap_abort_pipe_upcall(idmap, data, msg->errno);
734 idmap_release_pipe(struct inode *inode)
736 struct rpc_inode *rpci = RPC_I(inode);
737 struct idmap *idmap = (struct idmap *)rpci->private;
738 struct idmap_legacy_upcalldata *data;
740 data = xchg(&idmap->idmap_upcall_data, NULL);
742 nfs_idmap_complete_pipe_upcall(data, -EPIPE);
745 int nfs_map_name_to_uid(const struct nfs_server *server, const char *name, size_t namelen, kuid_t *uid)
747 struct idmap *idmap = server->nfs_client->cl_idmap;
751 if (!nfs_map_string_to_numeric(name, namelen, &id))
752 ret = nfs_idmap_lookup_id(name, namelen, "uid", &id, idmap);
754 *uid = make_kuid(idmap_userns(idmap), id);
755 if (!uid_valid(*uid))
758 trace_nfs4_map_name_to_uid(name, namelen, id, ret);
762 int nfs_map_group_to_gid(const struct nfs_server *server, const char *name, size_t namelen, kgid_t *gid)
764 struct idmap *idmap = server->nfs_client->cl_idmap;
768 if (!nfs_map_string_to_numeric(name, namelen, &id))
769 ret = nfs_idmap_lookup_id(name, namelen, "gid", &id, idmap);
771 *gid = make_kgid(idmap_userns(idmap), id);
772 if (!gid_valid(*gid))
775 trace_nfs4_map_group_to_gid(name, namelen, id, ret);
779 int nfs_map_uid_to_name(const struct nfs_server *server, kuid_t uid, char *buf, size_t buflen)
781 struct idmap *idmap = server->nfs_client->cl_idmap;
785 id = from_kuid_munged(idmap_userns(idmap), uid);
786 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
787 ret = nfs_idmap_lookup_name(id, "user", buf, buflen, idmap);
789 ret = nfs_map_numeric_to_string(id, buf, buflen);
790 trace_nfs4_map_uid_to_name(buf, ret, id, ret);
793 int nfs_map_gid_to_group(const struct nfs_server *server, kgid_t gid, char *buf, size_t buflen)
795 struct idmap *idmap = server->nfs_client->cl_idmap;
799 id = from_kgid_munged(idmap_userns(idmap), gid);
800 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
801 ret = nfs_idmap_lookup_name(id, "group", buf, buflen, idmap);
803 ret = nfs_map_numeric_to_string(id, buf, buflen);
804 trace_nfs4_map_gid_to_group(buf, ret, id, ret);