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>
52 #include "nfs4trace.h"
54 #define NFS_UINT_MAXLEN 11
56 static const struct cred
*id_resolver_cache
;
57 static struct key_type key_type_id_resolver_legacy
;
59 struct idmap_legacy_upcalldata
{
60 struct rpc_pipe_msg pipe_msg
;
61 struct idmap_msg idmap_msg
;
62 struct key_construction
*key_cons
;
67 struct rpc_pipe_dir_object idmap_pdo
;
68 struct rpc_pipe
*idmap_pipe
;
69 struct idmap_legacy_upcalldata
*idmap_upcall_data
;
70 struct mutex idmap_mutex
;
74 * nfs_fattr_init_names - initialise the nfs_fattr owner_name/group_name fields
75 * @fattr: fully initialised struct nfs_fattr
76 * @owner_name: owner name string cache
77 * @group_name: group name string cache
79 void nfs_fattr_init_names(struct nfs_fattr
*fattr
,
80 struct nfs4_string
*owner_name
,
81 struct nfs4_string
*group_name
)
83 fattr
->owner_name
= owner_name
;
84 fattr
->group_name
= group_name
;
87 static void nfs_fattr_free_owner_name(struct nfs_fattr
*fattr
)
89 fattr
->valid
&= ~NFS_ATTR_FATTR_OWNER_NAME
;
90 kfree(fattr
->owner_name
->data
);
93 static void nfs_fattr_free_group_name(struct nfs_fattr
*fattr
)
95 fattr
->valid
&= ~NFS_ATTR_FATTR_GROUP_NAME
;
96 kfree(fattr
->group_name
->data
);
99 static bool nfs_fattr_map_owner_name(struct nfs_server
*server
, struct nfs_fattr
*fattr
)
101 struct nfs4_string
*owner
= fattr
->owner_name
;
104 if (!(fattr
->valid
& NFS_ATTR_FATTR_OWNER_NAME
))
106 if (nfs_map_name_to_uid(server
, owner
->data
, owner
->len
, &uid
) == 0) {
108 fattr
->valid
|= NFS_ATTR_FATTR_OWNER
;
113 static bool nfs_fattr_map_group_name(struct nfs_server
*server
, struct nfs_fattr
*fattr
)
115 struct nfs4_string
*group
= fattr
->group_name
;
118 if (!(fattr
->valid
& NFS_ATTR_FATTR_GROUP_NAME
))
120 if (nfs_map_group_to_gid(server
, group
->data
, group
->len
, &gid
) == 0) {
122 fattr
->valid
|= NFS_ATTR_FATTR_GROUP
;
128 * nfs_fattr_free_names - free up the NFSv4 owner and group strings
129 * @fattr: a fully initialised nfs_fattr structure
131 void nfs_fattr_free_names(struct nfs_fattr
*fattr
)
133 if (fattr
->valid
& NFS_ATTR_FATTR_OWNER_NAME
)
134 nfs_fattr_free_owner_name(fattr
);
135 if (fattr
->valid
& NFS_ATTR_FATTR_GROUP_NAME
)
136 nfs_fattr_free_group_name(fattr
);
140 * nfs_fattr_map_and_free_names - map owner/group strings into uid/gid and free
141 * @server: pointer to the filesystem nfs_server structure
142 * @fattr: a fully initialised nfs_fattr structure
144 * This helper maps the cached NFSv4 owner/group strings in fattr into
145 * their numeric uid/gid equivalents, and then frees the cached strings.
147 void nfs_fattr_map_and_free_names(struct nfs_server
*server
, struct nfs_fattr
*fattr
)
149 if (nfs_fattr_map_owner_name(server
, fattr
))
150 nfs_fattr_free_owner_name(fattr
);
151 if (nfs_fattr_map_group_name(server
, fattr
))
152 nfs_fattr_free_group_name(fattr
);
155 static int nfs_map_string_to_numeric(const char *name
, size_t namelen
, __u32
*res
)
160 if (memchr(name
, '@', namelen
) != NULL
|| namelen
>= sizeof(buf
))
162 memcpy(buf
, name
, namelen
);
164 if (kstrtoul(buf
, 0, &val
) != 0)
170 static int nfs_map_numeric_to_string(__u32 id
, char *buf
, size_t buflen
)
172 return snprintf(buf
, buflen
, "%u", id
);
175 static struct key_type key_type_id_resolver
= {
176 .name
= "id_resolver",
177 .instantiate
= user_instantiate
,
179 .revoke
= user_revoke
,
180 .destroy
= user_destroy
,
181 .describe
= user_describe
,
185 static int nfs_idmap_init_keyring(void)
191 printk(KERN_NOTICE
"NFS: Registering the %s key type\n",
192 key_type_id_resolver
.name
);
194 cred
= prepare_kernel_cred(NULL
);
198 keyring
= keyring_alloc(".id_resolver",
199 GLOBAL_ROOT_UID
, GLOBAL_ROOT_GID
, cred
,
200 (KEY_POS_ALL
& ~KEY_POS_SETATTR
) |
201 KEY_USR_VIEW
| KEY_USR_READ
,
202 KEY_ALLOC_NOT_IN_QUOTA
, NULL
);
203 if (IS_ERR(keyring
)) {
204 ret
= PTR_ERR(keyring
);
205 goto failed_put_cred
;
208 ret
= register_key_type(&key_type_id_resolver
);
212 ret
= register_key_type(&key_type_id_resolver_legacy
);
214 goto failed_reg_legacy
;
216 set_bit(KEY_FLAG_ROOT_CAN_CLEAR
, &keyring
->flags
);
217 cred
->thread_keyring
= keyring
;
218 cred
->jit_keyring
= KEY_REQKEY_DEFL_THREAD_KEYRING
;
219 id_resolver_cache
= cred
;
223 unregister_key_type(&key_type_id_resolver
);
231 static void nfs_idmap_quit_keyring(void)
233 key_revoke(id_resolver_cache
->thread_keyring
);
234 unregister_key_type(&key_type_id_resolver
);
235 unregister_key_type(&key_type_id_resolver_legacy
);
236 put_cred(id_resolver_cache
);
240 * Assemble the description to pass to request_key()
241 * This function will allocate a new string and update dest to point
242 * at it. The caller is responsible for freeing dest.
244 * On error 0 is returned. Otherwise, the length of dest is returned.
246 static ssize_t
nfs_idmap_get_desc(const char *name
, size_t namelen
,
247 const char *type
, size_t typelen
, char **desc
)
250 size_t desclen
= typelen
+ namelen
+ 2;
252 *desc
= kmalloc(desclen
, GFP_KERNEL
);
257 memcpy(cp
, type
, typelen
);
261 memcpy(cp
, name
, namelen
);
267 static struct key
*nfs_idmap_request_key(const char *name
, size_t namelen
,
268 const char *type
, struct idmap
*idmap
)
274 ret
= nfs_idmap_get_desc(name
, namelen
, type
, strlen(type
), &desc
);
278 rkey
= request_key(&key_type_id_resolver
, desc
, "");
280 mutex_lock(&idmap
->idmap_mutex
);
281 rkey
= request_key_with_auxdata(&key_type_id_resolver_legacy
,
283 mutex_unlock(&idmap
->idmap_mutex
);
290 static ssize_t
nfs_idmap_get_key(const char *name
, size_t namelen
,
291 const char *type
, void *data
,
292 size_t data_size
, struct idmap
*idmap
)
294 const struct cred
*saved_cred
;
296 struct user_key_payload
*payload
;
299 saved_cred
= override_creds(id_resolver_cache
);
300 rkey
= nfs_idmap_request_key(name
, namelen
, type
, idmap
);
301 revert_creds(saved_cred
);
309 rkey
->perm
|= KEY_USR_VIEW
;
311 ret
= key_validate(rkey
);
315 payload
= rcu_dereference(rkey
->payload
.rcudata
);
316 if (IS_ERR_OR_NULL(payload
)) {
317 ret
= PTR_ERR(payload
);
321 ret
= payload
->datalen
;
322 if (ret
> 0 && ret
<= data_size
)
323 memcpy(data
, payload
->data
, ret
);
335 static ssize_t
nfs_idmap_lookup_name(__u32 id
, const char *type
, char *buf
,
336 size_t buflen
, struct idmap
*idmap
)
338 char id_str
[NFS_UINT_MAXLEN
];
342 id_len
= snprintf(id_str
, sizeof(id_str
), "%u", id
);
343 ret
= nfs_idmap_get_key(id_str
, id_len
, type
, buf
, buflen
, idmap
);
350 static int nfs_idmap_lookup_id(const char *name
, size_t namelen
, const char *type
,
351 __u32
*id
, struct idmap
*idmap
)
353 char id_str
[NFS_UINT_MAXLEN
];
358 data_size
= nfs_idmap_get_key(name
, namelen
, type
, id_str
, NFS_UINT_MAXLEN
, idmap
);
359 if (data_size
<= 0) {
362 ret
= kstrtol(id_str
, 10, &id_long
);
363 *id
= (__u32
)id_long
;
368 /* idmap classic begins here */
371 Opt_find_uid
, Opt_find_gid
, Opt_find_user
, Opt_find_group
, Opt_find_err
374 static const match_table_t nfs_idmap_tokens
= {
375 { Opt_find_uid
, "uid:%s" },
376 { Opt_find_gid
, "gid:%s" },
377 { Opt_find_user
, "user:%s" },
378 { Opt_find_group
, "group:%s" },
379 { Opt_find_err
, NULL
}
382 static int nfs_idmap_legacy_upcall(struct key_construction
*, const char *, void *);
383 static ssize_t
idmap_pipe_downcall(struct file
*, const char __user
*,
385 static void idmap_release_pipe(struct inode
*);
386 static void idmap_pipe_destroy_msg(struct rpc_pipe_msg
*);
388 static const struct rpc_pipe_ops idmap_upcall_ops
= {
389 .upcall
= rpc_pipe_generic_upcall
,
390 .downcall
= idmap_pipe_downcall
,
391 .release_pipe
= idmap_release_pipe
,
392 .destroy_msg
= idmap_pipe_destroy_msg
,
395 static struct key_type key_type_id_resolver_legacy
= {
397 .instantiate
= user_instantiate
,
399 .revoke
= user_revoke
,
400 .destroy
= user_destroy
,
401 .describe
= user_describe
,
403 .request_key
= nfs_idmap_legacy_upcall
,
406 static void nfs_idmap_pipe_destroy(struct dentry
*dir
,
407 struct rpc_pipe_dir_object
*pdo
)
409 struct idmap
*idmap
= pdo
->pdo_data
;
410 struct rpc_pipe
*pipe
= idmap
->idmap_pipe
;
413 rpc_unlink(pipe
->dentry
);
418 static int nfs_idmap_pipe_create(struct dentry
*dir
,
419 struct rpc_pipe_dir_object
*pdo
)
421 struct idmap
*idmap
= pdo
->pdo_data
;
422 struct rpc_pipe
*pipe
= idmap
->idmap_pipe
;
423 struct dentry
*dentry
;
425 dentry
= rpc_mkpipe_dentry(dir
, "idmap", idmap
, pipe
);
427 return PTR_ERR(dentry
);
428 pipe
->dentry
= dentry
;
432 static const struct rpc_pipe_dir_object_ops nfs_idmap_pipe_dir_object_ops
= {
433 .create
= nfs_idmap_pipe_create
,
434 .destroy
= nfs_idmap_pipe_destroy
,
438 nfs_idmap_new(struct nfs_client
*clp
)
441 struct rpc_pipe
*pipe
;
444 idmap
= kzalloc(sizeof(*idmap
), GFP_KERNEL
);
448 rpc_init_pipe_dir_object(&idmap
->idmap_pdo
,
449 &nfs_idmap_pipe_dir_object_ops
,
452 pipe
= rpc_mkpipe_data(&idmap_upcall_ops
, 0);
454 error
= PTR_ERR(pipe
);
457 idmap
->idmap_pipe
= pipe
;
458 mutex_init(&idmap
->idmap_mutex
);
460 error
= rpc_add_pipe_dir_object(clp
->cl_net
,
461 &clp
->cl_rpcclient
->cl_pipedir_objects
,
464 goto err_destroy_pipe
;
466 clp
->cl_idmap
= idmap
;
469 rpc_destroy_pipe_data(idmap
->idmap_pipe
);
476 nfs_idmap_delete(struct nfs_client
*clp
)
478 struct idmap
*idmap
= clp
->cl_idmap
;
482 clp
->cl_idmap
= NULL
;
483 rpc_remove_pipe_dir_object(clp
->cl_net
,
484 &clp
->cl_rpcclient
->cl_pipedir_objects
,
486 rpc_destroy_pipe_data(idmap
->idmap_pipe
);
490 int nfs_idmap_init(void)
493 ret
= nfs_idmap_init_keyring();
500 void nfs_idmap_quit(void)
502 nfs_idmap_quit_keyring();
505 static int nfs_idmap_prepare_message(char *desc
, struct idmap
*idmap
,
506 struct idmap_msg
*im
,
507 struct rpc_pipe_msg
*msg
)
512 im
->im_type
= IDMAP_TYPE_GROUP
;
513 token
= match_token(desc
, nfs_idmap_tokens
, &substr
);
517 im
->im_type
= IDMAP_TYPE_USER
;
519 im
->im_conv
= IDMAP_CONV_NAMETOID
;
520 ret
= match_strlcpy(im
->im_name
, &substr
, IDMAP_NAMESZ
);
524 im
->im_type
= IDMAP_TYPE_USER
;
526 im
->im_conv
= IDMAP_CONV_IDTONAME
;
527 ret
= match_int(&substr
, &im
->im_id
);
536 msg
->len
= sizeof(struct idmap_msg
);
543 nfs_idmap_prepare_pipe_upcall(struct idmap
*idmap
,
544 struct idmap_legacy_upcalldata
*data
)
546 if (idmap
->idmap_upcall_data
!= NULL
) {
550 idmap
->idmap_upcall_data
= data
;
555 nfs_idmap_complete_pipe_upcall_locked(struct idmap
*idmap
, int ret
)
557 struct key_construction
*cons
= idmap
->idmap_upcall_data
->key_cons
;
559 kfree(idmap
->idmap_upcall_data
);
560 idmap
->idmap_upcall_data
= NULL
;
561 complete_request_key(cons
, ret
);
565 nfs_idmap_abort_pipe_upcall(struct idmap
*idmap
, int ret
)
567 if (idmap
->idmap_upcall_data
!= NULL
)
568 nfs_idmap_complete_pipe_upcall_locked(idmap
, ret
);
571 static int nfs_idmap_legacy_upcall(struct key_construction
*cons
,
575 struct idmap_legacy_upcalldata
*data
;
576 struct rpc_pipe_msg
*msg
;
577 struct idmap_msg
*im
;
578 struct idmap
*idmap
= (struct idmap
*)aux
;
579 struct key
*key
= cons
->key
;
582 /* msg and im are freed in idmap_pipe_destroy_msg */
583 data
= kzalloc(sizeof(*data
), GFP_KERNEL
);
587 msg
= &data
->pipe_msg
;
588 im
= &data
->idmap_msg
;
590 data
->key_cons
= cons
;
592 ret
= nfs_idmap_prepare_message(key
->description
, idmap
, im
, msg
);
597 if (!nfs_idmap_prepare_pipe_upcall(idmap
, data
))
600 ret
= rpc_queue_upcall(idmap
->idmap_pipe
, msg
);
602 nfs_idmap_abort_pipe_upcall(idmap
, ret
);
608 complete_request_key(cons
, ret
);
612 static int nfs_idmap_instantiate(struct key
*key
, struct key
*authkey
, char *data
, size_t datalen
)
614 return key_instantiate_and_link(key
, data
, datalen
,
615 id_resolver_cache
->thread_keyring
,
619 static int nfs_idmap_read_and_verify_message(struct idmap_msg
*im
,
620 struct idmap_msg
*upcall
,
621 struct key
*key
, struct key
*authkey
)
623 char id_str
[NFS_UINT_MAXLEN
];
628 if (upcall
->im_type
!= im
->im_type
|| upcall
->im_conv
!= im
->im_conv
)
630 switch (im
->im_conv
) {
631 case IDMAP_CONV_NAMETOID
:
632 if (strcmp(upcall
->im_name
, im
->im_name
) != 0)
634 /* Note: here we store the NUL terminator too */
635 len
= sprintf(id_str
, "%d", im
->im_id
) + 1;
636 ret
= nfs_idmap_instantiate(key
, authkey
, id_str
, len
);
638 case IDMAP_CONV_IDTONAME
:
639 if (upcall
->im_id
!= im
->im_id
)
641 len
= strlen(im
->im_name
);
642 ret
= nfs_idmap_instantiate(key
, authkey
, im
->im_name
, len
);
652 idmap_pipe_downcall(struct file
*filp
, const char __user
*src
, size_t mlen
)
654 struct rpc_inode
*rpci
= RPC_I(file_inode(filp
));
655 struct idmap
*idmap
= (struct idmap
*)rpci
->private;
656 struct key_construction
*cons
;
661 /* If instantiation is successful, anyone waiting for key construction
662 * will have been woken up and someone else may now have used
663 * idmap_key_cons - so after this point we may no longer touch it.
665 if (idmap
->idmap_upcall_data
== NULL
)
668 cons
= idmap
->idmap_upcall_data
->key_cons
;
670 if (mlen
!= sizeof(im
)) {
675 if (copy_from_user(&im
, src
, mlen
) != 0) {
680 if (!(im
.im_status
& IDMAP_STATUS_SUCCESS
)) {
685 namelen_in
= strnlen(im
.im_name
, IDMAP_NAMESZ
);
686 if (namelen_in
== 0 || namelen_in
== IDMAP_NAMESZ
) {
691 ret
= nfs_idmap_read_and_verify_message(&im
,
692 &idmap
->idmap_upcall_data
->idmap_msg
,
693 cons
->key
, cons
->authkey
);
695 key_set_timeout(cons
->key
, nfs_idmap_cache_timeout
);
700 nfs_idmap_complete_pipe_upcall_locked(idmap
, ret
);
706 idmap_pipe_destroy_msg(struct rpc_pipe_msg
*msg
)
708 struct idmap_legacy_upcalldata
*data
= container_of(msg
,
709 struct idmap_legacy_upcalldata
,
711 struct idmap
*idmap
= data
->idmap
;
714 nfs_idmap_abort_pipe_upcall(idmap
, msg
->errno
);
718 idmap_release_pipe(struct inode
*inode
)
720 struct rpc_inode
*rpci
= RPC_I(inode
);
721 struct idmap
*idmap
= (struct idmap
*)rpci
->private;
723 nfs_idmap_abort_pipe_upcall(idmap
, -EPIPE
);
726 int nfs_map_name_to_uid(const struct nfs_server
*server
, const char *name
, size_t namelen
, kuid_t
*uid
)
728 struct idmap
*idmap
= server
->nfs_client
->cl_idmap
;
732 if (!nfs_map_string_to_numeric(name
, namelen
, &id
))
733 ret
= nfs_idmap_lookup_id(name
, namelen
, "uid", &id
, idmap
);
735 *uid
= make_kuid(&init_user_ns
, id
);
736 if (!uid_valid(*uid
))
739 trace_nfs4_map_name_to_uid(name
, namelen
, id
, ret
);
743 int nfs_map_group_to_gid(const struct nfs_server
*server
, const char *name
, size_t namelen
, kgid_t
*gid
)
745 struct idmap
*idmap
= server
->nfs_client
->cl_idmap
;
749 if (!nfs_map_string_to_numeric(name
, namelen
, &id
))
750 ret
= nfs_idmap_lookup_id(name
, namelen
, "gid", &id
, idmap
);
752 *gid
= make_kgid(&init_user_ns
, id
);
753 if (!gid_valid(*gid
))
756 trace_nfs4_map_group_to_gid(name
, namelen
, id
, ret
);
760 int nfs_map_uid_to_name(const struct nfs_server
*server
, kuid_t uid
, char *buf
, size_t buflen
)
762 struct idmap
*idmap
= server
->nfs_client
->cl_idmap
;
766 id
= from_kuid(&init_user_ns
, uid
);
767 if (!(server
->caps
& NFS_CAP_UIDGID_NOMAP
))
768 ret
= nfs_idmap_lookup_name(id
, "user", buf
, buflen
, idmap
);
770 ret
= nfs_map_numeric_to_string(id
, buf
, buflen
);
771 trace_nfs4_map_uid_to_name(buf
, ret
, id
, ret
);
774 int nfs_map_gid_to_group(const struct nfs_server
*server
, kgid_t gid
, char *buf
, size_t buflen
)
776 struct idmap
*idmap
= server
->nfs_client
->cl_idmap
;
780 id
= from_kgid(&init_user_ns
, gid
);
781 if (!(server
->caps
& NFS_CAP_UIDGID_NOMAP
))
782 ret
= nfs_idmap_lookup_name(id
, "group", buf
, buflen
, idmap
);
784 ret
= nfs_map_numeric_to_string(id
, buf
, buflen
);
785 trace_nfs4_map_gid_to_group(buf
, ret
, id
, ret
);