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>
52 #include "nfs4idmap.h"
53 #include "nfs4trace.h"
55 #define NFS_UINT_MAXLEN 11
57 static const struct cred
*id_resolver_cache
;
58 static struct key_type key_type_id_resolver_legacy
;
60 struct idmap_legacy_upcalldata
{
61 struct rpc_pipe_msg pipe_msg
;
62 struct idmap_msg idmap_msg
;
68 struct rpc_pipe_dir_object idmap_pdo
;
69 struct rpc_pipe
*idmap_pipe
;
70 struct idmap_legacy_upcalldata
*idmap_upcall_data
;
71 struct mutex idmap_mutex
;
72 const struct cred
*cred
;
75 static struct user_namespace
*idmap_userns(const struct idmap
*idmap
)
77 if (idmap
&& idmap
->cred
)
78 return idmap
->cred
->user_ns
;
83 * nfs_fattr_init_names - initialise the nfs_fattr owner_name/group_name fields
84 * @fattr: fully initialised struct nfs_fattr
85 * @owner_name: owner name string cache
86 * @group_name: group name string cache
88 void nfs_fattr_init_names(struct nfs_fattr
*fattr
,
89 struct nfs4_string
*owner_name
,
90 struct nfs4_string
*group_name
)
92 fattr
->owner_name
= owner_name
;
93 fattr
->group_name
= group_name
;
96 static void nfs_fattr_free_owner_name(struct nfs_fattr
*fattr
)
98 fattr
->valid
&= ~NFS_ATTR_FATTR_OWNER_NAME
;
99 kfree(fattr
->owner_name
->data
);
102 static void nfs_fattr_free_group_name(struct nfs_fattr
*fattr
)
104 fattr
->valid
&= ~NFS_ATTR_FATTR_GROUP_NAME
;
105 kfree(fattr
->group_name
->data
);
108 static bool nfs_fattr_map_owner_name(struct nfs_server
*server
, struct nfs_fattr
*fattr
)
110 struct nfs4_string
*owner
= fattr
->owner_name
;
113 if (!(fattr
->valid
& NFS_ATTR_FATTR_OWNER_NAME
))
115 if (nfs_map_name_to_uid(server
, owner
->data
, owner
->len
, &uid
) == 0) {
117 fattr
->valid
|= NFS_ATTR_FATTR_OWNER
;
122 static bool nfs_fattr_map_group_name(struct nfs_server
*server
, struct nfs_fattr
*fattr
)
124 struct nfs4_string
*group
= fattr
->group_name
;
127 if (!(fattr
->valid
& NFS_ATTR_FATTR_GROUP_NAME
))
129 if (nfs_map_group_to_gid(server
, group
->data
, group
->len
, &gid
) == 0) {
131 fattr
->valid
|= NFS_ATTR_FATTR_GROUP
;
137 * nfs_fattr_free_names - free up the NFSv4 owner and group strings
138 * @fattr: a fully initialised nfs_fattr structure
140 void nfs_fattr_free_names(struct nfs_fattr
*fattr
)
142 if (fattr
->valid
& NFS_ATTR_FATTR_OWNER_NAME
)
143 nfs_fattr_free_owner_name(fattr
);
144 if (fattr
->valid
& NFS_ATTR_FATTR_GROUP_NAME
)
145 nfs_fattr_free_group_name(fattr
);
149 * nfs_fattr_map_and_free_names - map owner/group strings into uid/gid and free
150 * @server: pointer to the filesystem nfs_server structure
151 * @fattr: a fully initialised nfs_fattr structure
153 * This helper maps the cached NFSv4 owner/group strings in fattr into
154 * their numeric uid/gid equivalents, and then frees the cached strings.
156 void nfs_fattr_map_and_free_names(struct nfs_server
*server
, struct nfs_fattr
*fattr
)
158 if (nfs_fattr_map_owner_name(server
, fattr
))
159 nfs_fattr_free_owner_name(fattr
);
160 if (nfs_fattr_map_group_name(server
, fattr
))
161 nfs_fattr_free_group_name(fattr
);
164 int nfs_map_string_to_numeric(const char *name
, size_t namelen
, __u32
*res
)
169 if (memchr(name
, '@', namelen
) != NULL
|| namelen
>= sizeof(buf
))
171 memcpy(buf
, name
, namelen
);
173 if (kstrtoul(buf
, 0, &val
) != 0)
178 EXPORT_SYMBOL_GPL(nfs_map_string_to_numeric
);
180 static int nfs_map_numeric_to_string(__u32 id
, char *buf
, size_t buflen
)
182 return snprintf(buf
, buflen
, "%u", id
);
185 static struct key_type key_type_id_resolver
= {
186 .name
= "id_resolver",
187 .preparse
= user_preparse
,
188 .free_preparse
= user_free_preparse
,
189 .instantiate
= generic_key_instantiate
,
190 .revoke
= user_revoke
,
191 .destroy
= user_destroy
,
192 .describe
= user_describe
,
196 int nfs_idmap_init(void)
202 printk(KERN_NOTICE
"NFS: Registering the %s key type\n",
203 key_type_id_resolver
.name
);
205 cred
= prepare_kernel_cred(NULL
);
209 keyring
= keyring_alloc(".id_resolver",
210 GLOBAL_ROOT_UID
, GLOBAL_ROOT_GID
, cred
,
211 (KEY_POS_ALL
& ~KEY_POS_SETATTR
) |
212 KEY_USR_VIEW
| KEY_USR_READ
,
213 KEY_ALLOC_NOT_IN_QUOTA
, NULL
, NULL
);
214 if (IS_ERR(keyring
)) {
215 ret
= PTR_ERR(keyring
);
216 goto failed_put_cred
;
219 ret
= register_key_type(&key_type_id_resolver
);
223 ret
= register_key_type(&key_type_id_resolver_legacy
);
225 goto failed_reg_legacy
;
227 set_bit(KEY_FLAG_ROOT_CAN_CLEAR
, &keyring
->flags
);
228 cred
->thread_keyring
= keyring
;
229 cred
->jit_keyring
= KEY_REQKEY_DEFL_THREAD_KEYRING
;
230 id_resolver_cache
= cred
;
234 unregister_key_type(&key_type_id_resolver
);
242 void nfs_idmap_quit(void)
244 key_revoke(id_resolver_cache
->thread_keyring
);
245 unregister_key_type(&key_type_id_resolver
);
246 unregister_key_type(&key_type_id_resolver_legacy
);
247 put_cred(id_resolver_cache
);
251 * Assemble the description to pass to request_key()
252 * This function will allocate a new string and update dest to point
253 * at it. The caller is responsible for freeing dest.
255 * On error 0 is returned. Otherwise, the length of dest is returned.
257 static ssize_t
nfs_idmap_get_desc(const char *name
, size_t namelen
,
258 const char *type
, size_t typelen
, char **desc
)
261 size_t desclen
= typelen
+ namelen
+ 2;
263 *desc
= kmalloc(desclen
, GFP_KERNEL
);
268 memcpy(cp
, type
, typelen
);
272 memcpy(cp
, name
, namelen
);
278 static struct key
*nfs_idmap_request_key(const char *name
, size_t namelen
,
279 const char *type
, struct idmap
*idmap
)
282 struct key
*rkey
= ERR_PTR(-EAGAIN
);
285 ret
= nfs_idmap_get_desc(name
, namelen
, type
, strlen(type
), &desc
);
289 if (!idmap
->cred
|| idmap
->cred
->user_ns
== &init_user_ns
)
290 rkey
= request_key(&key_type_id_resolver
, desc
, "");
292 mutex_lock(&idmap
->idmap_mutex
);
293 rkey
= request_key_with_auxdata(&key_type_id_resolver_legacy
,
294 desc
, NULL
, "", 0, idmap
);
295 mutex_unlock(&idmap
->idmap_mutex
);
298 set_bit(KEY_FLAG_ROOT_CAN_INVAL
, &rkey
->flags
);
304 static ssize_t
nfs_idmap_get_key(const char *name
, size_t namelen
,
305 const char *type
, void *data
,
306 size_t data_size
, struct idmap
*idmap
)
308 const struct cred
*saved_cred
;
310 const struct user_key_payload
*payload
;
313 saved_cred
= override_creds(id_resolver_cache
);
314 rkey
= nfs_idmap_request_key(name
, namelen
, type
, idmap
);
315 revert_creds(saved_cred
);
323 rkey
->perm
|= KEY_USR_VIEW
;
325 ret
= key_validate(rkey
);
329 payload
= user_key_payload_rcu(rkey
);
330 if (IS_ERR_OR_NULL(payload
)) {
331 ret
= PTR_ERR(payload
);
335 ret
= payload
->datalen
;
336 if (ret
> 0 && ret
<= data_size
)
337 memcpy(data
, payload
->data
, ret
);
349 static ssize_t
nfs_idmap_lookup_name(__u32 id
, const char *type
, char *buf
,
350 size_t buflen
, struct idmap
*idmap
)
352 char id_str
[NFS_UINT_MAXLEN
];
356 id_len
= nfs_map_numeric_to_string(id
, id_str
, sizeof(id_str
));
357 ret
= nfs_idmap_get_key(id_str
, id_len
, type
, buf
, buflen
, idmap
);
364 static int nfs_idmap_lookup_id(const char *name
, size_t namelen
, const char *type
,
365 __u32
*id
, struct idmap
*idmap
)
367 char id_str
[NFS_UINT_MAXLEN
];
372 data_size
= nfs_idmap_get_key(name
, namelen
, type
, id_str
, NFS_UINT_MAXLEN
, idmap
);
373 if (data_size
<= 0) {
376 ret
= kstrtol(id_str
, 10, &id_long
);
378 *id
= (__u32
)id_long
;
383 /* idmap classic begins here */
386 Opt_find_uid
, Opt_find_gid
, Opt_find_user
, Opt_find_group
, Opt_find_err
389 static const match_table_t nfs_idmap_tokens
= {
390 { Opt_find_uid
, "uid:%s" },
391 { Opt_find_gid
, "gid:%s" },
392 { Opt_find_user
, "user:%s" },
393 { Opt_find_group
, "group:%s" },
394 { Opt_find_err
, NULL
}
397 static int nfs_idmap_legacy_upcall(struct key
*, void *);
398 static ssize_t
idmap_pipe_downcall(struct file
*, const char __user
*,
400 static void idmap_release_pipe(struct inode
*);
401 static void idmap_pipe_destroy_msg(struct rpc_pipe_msg
*);
403 static const struct rpc_pipe_ops idmap_upcall_ops
= {
404 .upcall
= rpc_pipe_generic_upcall
,
405 .downcall
= idmap_pipe_downcall
,
406 .release_pipe
= idmap_release_pipe
,
407 .destroy_msg
= idmap_pipe_destroy_msg
,
410 static struct key_type key_type_id_resolver_legacy
= {
412 .preparse
= user_preparse
,
413 .free_preparse
= user_free_preparse
,
414 .instantiate
= generic_key_instantiate
,
415 .revoke
= user_revoke
,
416 .destroy
= user_destroy
,
417 .describe
= user_describe
,
419 .request_key
= nfs_idmap_legacy_upcall
,
422 static void nfs_idmap_pipe_destroy(struct dentry
*dir
,
423 struct rpc_pipe_dir_object
*pdo
)
425 struct idmap
*idmap
= pdo
->pdo_data
;
426 struct rpc_pipe
*pipe
= idmap
->idmap_pipe
;
429 rpc_unlink(pipe
->dentry
);
434 static int nfs_idmap_pipe_create(struct dentry
*dir
,
435 struct rpc_pipe_dir_object
*pdo
)
437 struct idmap
*idmap
= pdo
->pdo_data
;
438 struct rpc_pipe
*pipe
= idmap
->idmap_pipe
;
439 struct dentry
*dentry
;
441 dentry
= rpc_mkpipe_dentry(dir
, "idmap", idmap
, pipe
);
443 return PTR_ERR(dentry
);
444 pipe
->dentry
= dentry
;
448 static const struct rpc_pipe_dir_object_ops nfs_idmap_pipe_dir_object_ops
= {
449 .create
= nfs_idmap_pipe_create
,
450 .destroy
= nfs_idmap_pipe_destroy
,
454 nfs_idmap_new(struct nfs_client
*clp
)
457 struct rpc_pipe
*pipe
;
460 idmap
= kzalloc(sizeof(*idmap
), GFP_KERNEL
);
464 mutex_init(&idmap
->idmap_mutex
);
465 idmap
->cred
= get_cred(clp
->cl_rpcclient
->cl_cred
);
467 rpc_init_pipe_dir_object(&idmap
->idmap_pdo
,
468 &nfs_idmap_pipe_dir_object_ops
,
471 pipe
= rpc_mkpipe_data(&idmap_upcall_ops
, 0);
473 error
= PTR_ERR(pipe
);
476 idmap
->idmap_pipe
= pipe
;
478 error
= rpc_add_pipe_dir_object(clp
->cl_net
,
479 &clp
->cl_rpcclient
->cl_pipedir_objects
,
482 goto err_destroy_pipe
;
484 clp
->cl_idmap
= idmap
;
487 rpc_destroy_pipe_data(idmap
->idmap_pipe
);
489 put_cred(idmap
->cred
);
495 nfs_idmap_delete(struct nfs_client
*clp
)
497 struct idmap
*idmap
= clp
->cl_idmap
;
501 clp
->cl_idmap
= NULL
;
502 rpc_remove_pipe_dir_object(clp
->cl_net
,
503 &clp
->cl_rpcclient
->cl_pipedir_objects
,
505 rpc_destroy_pipe_data(idmap
->idmap_pipe
);
506 put_cred(idmap
->cred
);
510 static int nfs_idmap_prepare_message(char *desc
, struct idmap
*idmap
,
511 struct idmap_msg
*im
,
512 struct rpc_pipe_msg
*msg
)
517 im
->im_type
= IDMAP_TYPE_GROUP
;
518 token
= match_token(desc
, nfs_idmap_tokens
, &substr
);
522 im
->im_type
= IDMAP_TYPE_USER
;
525 im
->im_conv
= IDMAP_CONV_NAMETOID
;
526 ret
= match_strlcpy(im
->im_name
, &substr
, IDMAP_NAMESZ
);
530 im
->im_type
= IDMAP_TYPE_USER
;
533 im
->im_conv
= IDMAP_CONV_IDTONAME
;
534 ret
= match_int(&substr
, &im
->im_id
);
545 msg
->len
= sizeof(struct idmap_msg
);
552 nfs_idmap_prepare_pipe_upcall(struct idmap
*idmap
,
553 struct idmap_legacy_upcalldata
*data
)
555 if (idmap
->idmap_upcall_data
!= NULL
) {
559 idmap
->idmap_upcall_data
= data
;
564 nfs_idmap_complete_pipe_upcall_locked(struct idmap
*idmap
, int ret
)
566 struct key
*authkey
= idmap
->idmap_upcall_data
->authkey
;
568 kfree(idmap
->idmap_upcall_data
);
569 idmap
->idmap_upcall_data
= NULL
;
570 complete_request_key(authkey
, ret
);
575 nfs_idmap_abort_pipe_upcall(struct idmap
*idmap
, int ret
)
577 if (idmap
->idmap_upcall_data
!= NULL
)
578 nfs_idmap_complete_pipe_upcall_locked(idmap
, ret
);
581 static int nfs_idmap_legacy_upcall(struct key
*authkey
, void *aux
)
583 struct idmap_legacy_upcalldata
*data
;
584 struct request_key_auth
*rka
= get_request_key_auth(authkey
);
585 struct rpc_pipe_msg
*msg
;
586 struct idmap_msg
*im
;
587 struct idmap
*idmap
= (struct idmap
*)aux
;
588 struct key
*key
= rka
->target_key
;
594 /* msg and im are freed in idmap_pipe_destroy_msg */
596 data
= kzalloc(sizeof(*data
), GFP_KERNEL
);
600 msg
= &data
->pipe_msg
;
601 im
= &data
->idmap_msg
;
603 data
->authkey
= key_get(authkey
);
605 ret
= nfs_idmap_prepare_message(key
->description
, idmap
, im
, msg
);
610 if (!nfs_idmap_prepare_pipe_upcall(idmap
, data
))
613 ret
= rpc_queue_upcall(idmap
->idmap_pipe
, msg
);
615 nfs_idmap_abort_pipe_upcall(idmap
, ret
);
621 complete_request_key(authkey
, ret
);
625 static int nfs_idmap_instantiate(struct key
*key
, struct key
*authkey
, char *data
, size_t datalen
)
627 return key_instantiate_and_link(key
, data
, datalen
,
628 id_resolver_cache
->thread_keyring
,
632 static int nfs_idmap_read_and_verify_message(struct idmap_msg
*im
,
633 struct idmap_msg
*upcall
,
634 struct key
*key
, struct key
*authkey
)
636 char id_str
[NFS_UINT_MAXLEN
];
641 if (upcall
->im_type
!= im
->im_type
|| upcall
->im_conv
!= im
->im_conv
)
643 switch (im
->im_conv
) {
644 case IDMAP_CONV_NAMETOID
:
645 if (strcmp(upcall
->im_name
, im
->im_name
) != 0)
647 /* Note: here we store the NUL terminator too */
648 len
= 1 + nfs_map_numeric_to_string(im
->im_id
, id_str
,
650 ret
= nfs_idmap_instantiate(key
, authkey
, id_str
, len
);
652 case IDMAP_CONV_IDTONAME
:
653 if (upcall
->im_id
!= im
->im_id
)
655 len
= strlen(im
->im_name
);
656 ret
= nfs_idmap_instantiate(key
, authkey
, im
->im_name
, len
);
666 idmap_pipe_downcall(struct file
*filp
, const char __user
*src
, size_t mlen
)
668 struct request_key_auth
*rka
;
669 struct rpc_inode
*rpci
= RPC_I(file_inode(filp
));
670 struct idmap
*idmap
= (struct idmap
*)rpci
->private;
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 if (idmap
->idmap_upcall_data
== NULL
)
683 authkey
= idmap
->idmap_upcall_data
->authkey
;
684 rka
= get_request_key_auth(authkey
);
686 if (mlen
!= sizeof(im
)) {
691 if (copy_from_user(&im
, src
, mlen
) != 0) {
696 if (!(im
.im_status
& IDMAP_STATUS_SUCCESS
)) {
701 namelen_in
= strnlen(im
.im_name
, IDMAP_NAMESZ
);
702 if (namelen_in
== 0 || namelen_in
== IDMAP_NAMESZ
) {
707 ret
= nfs_idmap_read_and_verify_message(&im
,
708 &idmap
->idmap_upcall_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_locked(idmap
, 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
, 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;
739 nfs_idmap_abort_pipe_upcall(idmap
, -EPIPE
);
742 int nfs_map_name_to_uid(const struct nfs_server
*server
, const char *name
, size_t namelen
, kuid_t
*uid
)
744 struct idmap
*idmap
= server
->nfs_client
->cl_idmap
;
748 if (!nfs_map_string_to_numeric(name
, namelen
, &id
))
749 ret
= nfs_idmap_lookup_id(name
, namelen
, "uid", &id
, idmap
);
751 *uid
= make_kuid(idmap_userns(idmap
), id
);
752 if (!uid_valid(*uid
))
755 trace_nfs4_map_name_to_uid(name
, namelen
, id
, ret
);
759 int nfs_map_group_to_gid(const struct nfs_server
*server
, const char *name
, size_t namelen
, kgid_t
*gid
)
761 struct idmap
*idmap
= server
->nfs_client
->cl_idmap
;
765 if (!nfs_map_string_to_numeric(name
, namelen
, &id
))
766 ret
= nfs_idmap_lookup_id(name
, namelen
, "gid", &id
, idmap
);
768 *gid
= make_kgid(idmap_userns(idmap
), id
);
769 if (!gid_valid(*gid
))
772 trace_nfs4_map_group_to_gid(name
, namelen
, id
, ret
);
776 int nfs_map_uid_to_name(const struct nfs_server
*server
, kuid_t uid
, char *buf
, size_t buflen
)
778 struct idmap
*idmap
= server
->nfs_client
->cl_idmap
;
782 id
= from_kuid_munged(idmap_userns(idmap
), uid
);
783 if (!(server
->caps
& NFS_CAP_UIDGID_NOMAP
))
784 ret
= nfs_idmap_lookup_name(id
, "user", buf
, buflen
, idmap
);
786 ret
= nfs_map_numeric_to_string(id
, buf
, buflen
);
787 trace_nfs4_map_uid_to_name(buf
, ret
, id
, ret
);
790 int nfs_map_gid_to_group(const struct nfs_server
*server
, kgid_t gid
, char *buf
, size_t buflen
)
792 struct idmap
*idmap
= server
->nfs_client
->cl_idmap
;
796 id
= from_kgid_munged(idmap_userns(idmap
), gid
);
797 if (!(server
->caps
& NFS_CAP_UIDGID_NOMAP
))
798 ret
= nfs_idmap_lookup_name(id
, "group", buf
, buflen
, idmap
);
800 ret
= nfs_map_numeric_to_string(id
, buf
, buflen
);
801 trace_nfs4_map_gid_to_group(buf
, ret
, id
, ret
);