2 * Mapping of UID/GIDs to name and vice versa.
4 * Copyright (c) 2002, 2003 The Regents of the University of
5 * Michigan. All rights reserved.
7 * Marius Aamodt Eriksen <marius@umich.edu>
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
23 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
24 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
29 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 #include <linux/module.h>
36 #include <linux/seq_file.h>
37 #include <linux/sched.h>
38 #include <linux/slab.h>
39 #include <linux/sunrpc/svc_xprt.h>
40 #include <net/net_namespace.h>
47 * Turn off idmapping when using AUTH_SYS.
49 static bool nfs4_disable_idmapping
= true;
50 module_param(nfs4_disable_idmapping
, bool, 0644);
51 MODULE_PARM_DESC(nfs4_disable_idmapping
,
52 "Turn off server's NFSv4 idmapping when using 'sec=sys'");
59 * XXX we know that IDMAP_NAMESZ < PAGE_SIZE, but it's ugly to rely on
65 int type
; /* User / Group */
67 char name
[IDMAP_NAMESZ
];
68 char authname
[IDMAP_NAMESZ
];
69 struct rcu_head rcu_head
;
72 /* Common entry handling */
74 #define ENT_HASHBITS 8
75 #define ENT_HASHMAX (1 << ENT_HASHBITS)
78 ent_init(struct cache_head
*cnew
, struct cache_head
*citm
)
80 struct ent
*new = container_of(cnew
, struct ent
, h
);
81 struct ent
*itm
= container_of(citm
, struct ent
, h
);
84 new->type
= itm
->type
;
86 strscpy(new->name
, itm
->name
, sizeof(new->name
));
87 strscpy(new->authname
, itm
->authname
, sizeof(new->authname
));
91 ent_put(struct kref
*ref
)
93 struct ent
*map
= container_of(ref
, struct ent
, h
.ref
);
94 kfree_rcu(map
, rcu_head
);
97 static struct cache_head
*
100 struct ent
*e
= kmalloc(sizeof(*e
), GFP_KERNEL
);
112 idtoname_hash(struct ent
*ent
)
116 hash
= hash_str(ent
->authname
, ENT_HASHBITS
);
117 hash
= hash_long(hash
^ ent
->id
, ENT_HASHBITS
);
119 /* Flip LSB for user/group */
120 if (ent
->type
== IDMAP_TYPE_GROUP
)
127 idtoname_upcall(struct cache_detail
*cd
, struct cache_head
*h
)
129 return sunrpc_cache_pipe_upcall_timeout(cd
, h
);
133 idtoname_request(struct cache_detail
*cd
, struct cache_head
*ch
, char **bpp
,
136 struct ent
*ent
= container_of(ch
, struct ent
, h
);
139 qword_add(bpp
, blen
, ent
->authname
);
140 snprintf(idstr
, sizeof(idstr
), "%u", ent
->id
);
141 qword_add(bpp
, blen
, ent
->type
== IDMAP_TYPE_GROUP
? "group" : "user");
142 qword_add(bpp
, blen
, idstr
);
148 idtoname_match(struct cache_head
*ca
, struct cache_head
*cb
)
150 struct ent
*a
= container_of(ca
, struct ent
, h
);
151 struct ent
*b
= container_of(cb
, struct ent
, h
);
153 return (a
->id
== b
->id
&& a
->type
== b
->type
&&
154 strcmp(a
->authname
, b
->authname
) == 0);
158 idtoname_show(struct seq_file
*m
, struct cache_detail
*cd
, struct cache_head
*h
)
163 seq_puts(m
, "#domain type id [name]\n");
166 ent
= container_of(h
, struct ent
, h
);
167 seq_printf(m
, "%s %s %u", ent
->authname
,
168 ent
->type
== IDMAP_TYPE_GROUP
? "group" : "user",
170 if (test_bit(CACHE_VALID
, &h
->flags
))
171 seq_printf(m
, " %s", ent
->name
);
177 warn_no_idmapd(struct cache_detail
*detail
, int has_died
)
179 printk("nfsd: nfsv4 idmapping failing: has idmapd %s?\n",
180 has_died
? "died" : "not been started");
184 static int idtoname_parse(struct cache_detail
*, char *, int);
185 static struct ent
*idtoname_lookup(struct cache_detail
*, struct ent
*);
186 static struct ent
*idtoname_update(struct cache_detail
*, struct ent
*,
189 static const struct cache_detail idtoname_cache_template
= {
190 .owner
= THIS_MODULE
,
191 .hash_size
= ENT_HASHMAX
,
192 .name
= "nfs4.idtoname",
193 .cache_put
= ent_put
,
194 .cache_upcall
= idtoname_upcall
,
195 .cache_request
= idtoname_request
,
196 .cache_parse
= idtoname_parse
,
197 .cache_show
= idtoname_show
,
198 .warn_no_listener
= warn_no_idmapd
,
199 .match
= idtoname_match
,
206 idtoname_parse(struct cache_detail
*cd
, char *buf
, int buflen
)
208 struct ent ent
, *res
;
213 if (buf
[buflen
- 1] != '\n')
215 buf
[buflen
- 1]= '\0';
217 buf1
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
221 memset(&ent
, 0, sizeof(ent
));
223 /* Authentication name */
224 len
= qword_get(&buf
, buf1
, PAGE_SIZE
);
225 if (len
<= 0 || len
>= IDMAP_NAMESZ
)
227 memcpy(ent
.authname
, buf1
, sizeof(ent
.authname
));
230 if (qword_get(&buf
, buf1
, PAGE_SIZE
) <= 0)
232 ent
.type
= strcmp(buf1
, "user") == 0 ?
233 IDMAP_TYPE_USER
: IDMAP_TYPE_GROUP
;
236 if (qword_get(&buf
, buf1
, PAGE_SIZE
) <= 0)
238 ent
.id
= simple_strtoul(buf1
, &bp
, 10);
243 error
= get_expiry(&buf
, &ent
.h
.expiry_time
);
248 res
= idtoname_lookup(cd
, &ent
);
254 len
= qword_get(&buf
, buf1
, PAGE_SIZE
);
255 if (len
< 0 || len
>= IDMAP_NAMESZ
)
258 set_bit(CACHE_NEGATIVE
, &ent
.h
.flags
);
260 memcpy(ent
.name
, buf1
, sizeof(ent
.name
));
262 res
= idtoname_update(cd
, &ent
, res
);
266 cache_put(&res
->h
, cd
);
274 idtoname_lookup(struct cache_detail
*cd
, struct ent
*item
)
276 struct cache_head
*ch
= sunrpc_cache_lookup_rcu(cd
, &item
->h
,
277 idtoname_hash(item
));
279 return container_of(ch
, struct ent
, h
);
285 idtoname_update(struct cache_detail
*cd
, struct ent
*new, struct ent
*old
)
287 struct cache_head
*ch
= sunrpc_cache_update(cd
, &new->h
, &old
->h
,
290 return container_of(ch
, struct ent
, h
);
301 nametoid_hash(struct ent
*ent
)
303 return hash_str(ent
->name
, ENT_HASHBITS
);
307 nametoid_upcall(struct cache_detail
*cd
, struct cache_head
*h
)
309 return sunrpc_cache_pipe_upcall_timeout(cd
, h
);
313 nametoid_request(struct cache_detail
*cd
, struct cache_head
*ch
, char **bpp
,
316 struct ent
*ent
= container_of(ch
, struct ent
, h
);
318 qword_add(bpp
, blen
, ent
->authname
);
319 qword_add(bpp
, blen
, ent
->type
== IDMAP_TYPE_GROUP
? "group" : "user");
320 qword_add(bpp
, blen
, ent
->name
);
326 nametoid_match(struct cache_head
*ca
, struct cache_head
*cb
)
328 struct ent
*a
= container_of(ca
, struct ent
, h
);
329 struct ent
*b
= container_of(cb
, struct ent
, h
);
331 return (a
->type
== b
->type
&& strcmp(a
->name
, b
->name
) == 0 &&
332 strcmp(a
->authname
, b
->authname
) == 0);
336 nametoid_show(struct seq_file
*m
, struct cache_detail
*cd
, struct cache_head
*h
)
341 seq_puts(m
, "#domain type name [id]\n");
344 ent
= container_of(h
, struct ent
, h
);
345 seq_printf(m
, "%s %s %s", ent
->authname
,
346 ent
->type
== IDMAP_TYPE_GROUP
? "group" : "user",
348 if (test_bit(CACHE_VALID
, &h
->flags
))
349 seq_printf(m
, " %u", ent
->id
);
354 static struct ent
*nametoid_lookup(struct cache_detail
*, struct ent
*);
355 static struct ent
*nametoid_update(struct cache_detail
*, struct ent
*,
357 static int nametoid_parse(struct cache_detail
*, char *, int);
359 static const struct cache_detail nametoid_cache_template
= {
360 .owner
= THIS_MODULE
,
361 .hash_size
= ENT_HASHMAX
,
362 .name
= "nfs4.nametoid",
363 .cache_put
= ent_put
,
364 .cache_upcall
= nametoid_upcall
,
365 .cache_request
= nametoid_request
,
366 .cache_parse
= nametoid_parse
,
367 .cache_show
= nametoid_show
,
368 .warn_no_listener
= warn_no_idmapd
,
369 .match
= nametoid_match
,
376 nametoid_parse(struct cache_detail
*cd
, char *buf
, int buflen
)
378 struct ent ent
, *res
;
380 int len
, error
= -EINVAL
;
382 if (buf
[buflen
- 1] != '\n')
384 buf
[buflen
- 1]= '\0';
386 buf1
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
390 memset(&ent
, 0, sizeof(ent
));
392 /* Authentication name */
393 len
= qword_get(&buf
, buf1
, PAGE_SIZE
);
394 if (len
<= 0 || len
>= IDMAP_NAMESZ
)
396 memcpy(ent
.authname
, buf1
, sizeof(ent
.authname
));
399 if (qword_get(&buf
, buf1
, PAGE_SIZE
) <= 0)
401 ent
.type
= strcmp(buf1
, "user") == 0 ?
402 IDMAP_TYPE_USER
: IDMAP_TYPE_GROUP
;
405 len
= qword_get(&buf
, buf1
, PAGE_SIZE
);
406 if (len
<= 0 || len
>= IDMAP_NAMESZ
)
408 memcpy(ent
.name
, buf1
, sizeof(ent
.name
));
411 error
= get_expiry(&buf
, &ent
.h
.expiry_time
);
416 error
= get_int(&buf
, &ent
.id
);
417 if (error
== -EINVAL
)
419 if (error
== -ENOENT
)
420 set_bit(CACHE_NEGATIVE
, &ent
.h
.flags
);
423 res
= nametoid_lookup(cd
, &ent
);
426 res
= nametoid_update(cd
, &ent
, res
);
430 cache_put(&res
->h
, cd
);
439 nametoid_lookup(struct cache_detail
*cd
, struct ent
*item
)
441 struct cache_head
*ch
= sunrpc_cache_lookup_rcu(cd
, &item
->h
,
442 nametoid_hash(item
));
444 return container_of(ch
, struct ent
, h
);
450 nametoid_update(struct cache_detail
*cd
, struct ent
*new, struct ent
*old
)
452 struct cache_head
*ch
= sunrpc_cache_update(cd
, &new->h
, &old
->h
,
455 return container_of(ch
, struct ent
, h
);
465 nfsd_idmap_init(struct net
*net
)
468 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
470 nn
->idtoname_cache
= cache_create_net(&idtoname_cache_template
, net
);
471 if (IS_ERR(nn
->idtoname_cache
))
472 return PTR_ERR(nn
->idtoname_cache
);
473 rv
= cache_register_net(nn
->idtoname_cache
, net
);
475 goto destroy_idtoname_cache
;
476 nn
->nametoid_cache
= cache_create_net(&nametoid_cache_template
, net
);
477 if (IS_ERR(nn
->nametoid_cache
)) {
478 rv
= PTR_ERR(nn
->nametoid_cache
);
479 goto unregister_idtoname_cache
;
481 rv
= cache_register_net(nn
->nametoid_cache
, net
);
483 goto destroy_nametoid_cache
;
486 destroy_nametoid_cache
:
487 cache_destroy_net(nn
->nametoid_cache
, net
);
488 unregister_idtoname_cache
:
489 cache_unregister_net(nn
->idtoname_cache
, net
);
490 destroy_idtoname_cache
:
491 cache_destroy_net(nn
->idtoname_cache
, net
);
496 nfsd_idmap_shutdown(struct net
*net
)
498 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
500 cache_unregister_net(nn
->idtoname_cache
, net
);
501 cache_unregister_net(nn
->nametoid_cache
, net
);
502 cache_destroy_net(nn
->idtoname_cache
, net
);
503 cache_destroy_net(nn
->nametoid_cache
, net
);
507 idmap_lookup(struct svc_rqst
*rqstp
,
508 struct ent
*(*lookup_fn
)(struct cache_detail
*, struct ent
*),
509 struct ent
*key
, struct cache_detail
*detail
, struct ent
**item
)
513 *item
= lookup_fn(detail
, key
);
517 ret
= cache_check(detail
, &(*item
)->h
, &rqstp
->rq_chandle
);
519 if (ret
== -ETIMEDOUT
) {
520 struct ent
*prev_item
= *item
;
521 *item
= lookup_fn(detail
, key
);
522 if (*item
!= prev_item
)
524 cache_put(&(*item
)->h
, detail
);
530 rqst_authname(struct svc_rqst
*rqstp
)
532 struct auth_domain
*clp
;
534 clp
= rqstp
->rq_gssclient
? rqstp
->rq_gssclient
: rqstp
->rq_client
;
539 idmap_name_to_id(struct svc_rqst
*rqstp
, int type
, const char *name
, u32 namelen
,
542 struct ent
*item
, key
= {
546 struct nfsd_net
*nn
= net_generic(SVC_NET(rqstp
), nfsd_net_id
);
548 if (namelen
+ 1 > sizeof(key
.name
))
549 return nfserr_badowner
;
550 memcpy(key
.name
, name
, namelen
);
551 key
.name
[namelen
] = '\0';
552 strscpy(key
.authname
, rqst_authname(rqstp
), sizeof(key
.authname
));
553 ret
= idmap_lookup(rqstp
, nametoid_lookup
, &key
, nn
->nametoid_cache
, &item
);
555 return nfserr_badowner
;
557 return nfserrno(ret
);
559 cache_put(&item
->h
, nn
->nametoid_cache
);
563 static __be32
encode_ascii_id(struct xdr_stream
*xdr
, u32 id
)
569 len
= sprintf(buf
, "%u", id
);
570 p
= xdr_reserve_space(xdr
, len
+ 4);
572 return nfserr_resource
;
573 p
= xdr_encode_opaque(p
, buf
, len
);
577 static __be32
idmap_id_to_name(struct xdr_stream
*xdr
,
578 struct svc_rqst
*rqstp
, int type
, u32 id
)
580 struct ent
*item
, key
= {
584 __be32 status
= nfs_ok
;
587 struct nfsd_net
*nn
= net_generic(SVC_NET(rqstp
), nfsd_net_id
);
589 strscpy(key
.authname
, rqst_authname(rqstp
), sizeof(key
.authname
));
590 ret
= idmap_lookup(rqstp
, idtoname_lookup
, &key
, nn
->idtoname_cache
, &item
);
592 return encode_ascii_id(xdr
, id
);
594 return nfserrno(ret
);
595 ret
= strlen(item
->name
);
596 WARN_ON_ONCE(ret
> IDMAP_NAMESZ
);
598 p
= xdr_reserve_space(xdr
, ret
+ 4);
600 status
= nfserr_resource
;
603 xdr_encode_opaque(p
, item
->name
, ret
);
605 cache_put(&item
->h
, nn
->idtoname_cache
);
610 numeric_name_to_id(struct svc_rqst
*rqstp
, int type
, const char *name
, u32 namelen
, u32
*id
)
615 if (namelen
+ 1 > sizeof(buf
))
616 /* too long to represent a 32-bit id: */
618 /* Just to make sure it's null-terminated: */
619 memcpy(buf
, name
, namelen
);
621 ret
= kstrtouint(buf
, 10, id
);
626 do_name_to_id(struct svc_rqst
*rqstp
, int type
, const char *name
, u32 namelen
, u32
*id
)
628 if (nfs4_disable_idmapping
&& rqstp
->rq_cred
.cr_flavor
< RPC_AUTH_GSS
)
629 if (numeric_name_to_id(rqstp
, type
, name
, namelen
, id
))
632 * otherwise, fall through and try idmapping, for
633 * backwards compatibility with clients sending names:
635 return idmap_name_to_id(rqstp
, type
, name
, namelen
, id
);
638 static __be32
encode_name_from_id(struct xdr_stream
*xdr
,
639 struct svc_rqst
*rqstp
, int type
, u32 id
)
641 if (nfs4_disable_idmapping
&& rqstp
->rq_cred
.cr_flavor
< RPC_AUTH_GSS
)
642 return encode_ascii_id(xdr
, id
);
643 return idmap_id_to_name(xdr
, rqstp
, type
, id
);
647 nfsd_map_name_to_uid(struct svc_rqst
*rqstp
, const char *name
, size_t namelen
,
653 if (name
== NULL
|| namelen
== 0)
656 status
= do_name_to_id(rqstp
, IDMAP_TYPE_USER
, name
, namelen
, &id
);
657 *uid
= make_kuid(nfsd_user_namespace(rqstp
), id
);
658 if (!uid_valid(*uid
))
659 status
= nfserr_badowner
;
664 nfsd_map_name_to_gid(struct svc_rqst
*rqstp
, const char *name
, size_t namelen
,
670 if (name
== NULL
|| namelen
== 0)
673 status
= do_name_to_id(rqstp
, IDMAP_TYPE_GROUP
, name
, namelen
, &id
);
674 *gid
= make_kgid(nfsd_user_namespace(rqstp
), id
);
675 if (!gid_valid(*gid
))
676 status
= nfserr_badowner
;
680 __be32
nfsd4_encode_user(struct xdr_stream
*xdr
, struct svc_rqst
*rqstp
,
683 u32 id
= from_kuid_munged(nfsd_user_namespace(rqstp
), uid
);
684 return encode_name_from_id(xdr
, rqstp
, IDMAP_TYPE_USER
, id
);
687 __be32
nfsd4_encode_group(struct xdr_stream
*xdr
, struct svc_rqst
*rqstp
,
690 u32 id
= from_kgid_munged(nfsd_user_namespace(rqstp
), gid
);
691 return encode_name_from_id(xdr
, rqstp
, IDMAP_TYPE_GROUP
, id
);