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 <net/net_namespace.h>
44 * Turn off idmapping when using AUTH_SYS.
46 static bool nfs4_disable_idmapping
= true;
47 module_param(nfs4_disable_idmapping
, bool, 0644);
48 MODULE_PARM_DESC(nfs4_disable_idmapping
,
49 "Turn off server's NFSv4 idmapping when using 'sec=sys'");
56 * XXX we know that IDMAP_NAMESZ < PAGE_SIZE, but it's ugly to rely on
60 #define IDMAP_TYPE_USER 0
61 #define IDMAP_TYPE_GROUP 1
65 int type
; /* User / Group */
67 char name
[IDMAP_NAMESZ
];
68 char authname
[IDMAP_NAMESZ
];
71 /* Common entry handling */
73 #define ENT_HASHBITS 8
74 #define ENT_HASHMAX (1 << ENT_HASHBITS)
77 ent_init(struct cache_head
*cnew
, struct cache_head
*citm
)
79 struct ent
*new = container_of(cnew
, struct ent
, h
);
80 struct ent
*itm
= container_of(citm
, struct ent
, h
);
83 new->type
= itm
->type
;
85 strlcpy(new->name
, itm
->name
, sizeof(new->name
));
86 strlcpy(new->authname
, itm
->authname
, sizeof(new->name
));
90 ent_put(struct kref
*ref
)
92 struct ent
*map
= container_of(ref
, struct ent
, h
.ref
);
96 static struct cache_head
*
99 struct ent
*e
= kmalloc(sizeof(*e
), GFP_KERNEL
);
110 static struct cache_head
*idtoname_table
[ENT_HASHMAX
];
113 idtoname_hash(struct ent
*ent
)
117 hash
= hash_str(ent
->authname
, ENT_HASHBITS
);
118 hash
= hash_long(hash
^ ent
->id
, ENT_HASHBITS
);
120 /* Flip LSB for user/group */
121 if (ent
->type
== IDMAP_TYPE_GROUP
)
128 idtoname_request(struct cache_detail
*cd
, struct cache_head
*ch
, char **bpp
,
131 struct ent
*ent
= container_of(ch
, struct ent
, h
);
134 qword_add(bpp
, blen
, ent
->authname
);
135 snprintf(idstr
, sizeof(idstr
), "%u", ent
->id
);
136 qword_add(bpp
, blen
, ent
->type
== IDMAP_TYPE_GROUP
? "group" : "user");
137 qword_add(bpp
, blen
, idstr
);
143 idtoname_upcall(struct cache_detail
*cd
, struct cache_head
*ch
)
145 return sunrpc_cache_pipe_upcall(cd
, ch
, idtoname_request
);
149 idtoname_match(struct cache_head
*ca
, struct cache_head
*cb
)
151 struct ent
*a
= container_of(ca
, struct ent
, h
);
152 struct ent
*b
= container_of(cb
, struct ent
, h
);
154 return (a
->id
== b
->id
&& a
->type
== b
->type
&&
155 strcmp(a
->authname
, b
->authname
) == 0);
159 idtoname_show(struct seq_file
*m
, struct cache_detail
*cd
, struct cache_head
*h
)
164 seq_puts(m
, "#domain type id [name]\n");
167 ent
= container_of(h
, struct ent
, h
);
168 seq_printf(m
, "%s %s %u", ent
->authname
,
169 ent
->type
== IDMAP_TYPE_GROUP
? "group" : "user",
171 if (test_bit(CACHE_VALID
, &h
->flags
))
172 seq_printf(m
, " %s", ent
->name
);
178 warn_no_idmapd(struct cache_detail
*detail
, int has_died
)
180 printk("nfsd: nfsv4 idmapping failing: has idmapd %s?\n",
181 has_died
? "died" : "not been started");
185 static int idtoname_parse(struct cache_detail
*, char *, int);
186 static struct ent
*idtoname_lookup(struct ent
*);
187 static struct ent
*idtoname_update(struct ent
*, struct ent
*);
189 static struct cache_detail idtoname_cache
= {
190 .owner
= THIS_MODULE
,
191 .hash_size
= ENT_HASHMAX
,
192 .hash_table
= idtoname_table
,
193 .name
= "nfs4.idtoname",
194 .cache_put
= ent_put
,
195 .cache_upcall
= idtoname_upcall
,
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 if (qword_get(&buf
, buf1
, PAGE_SIZE
) <= 0)
226 memcpy(ent
.authname
, buf1
, sizeof(ent
.authname
));
229 if (qword_get(&buf
, buf1
, PAGE_SIZE
) <= 0)
231 ent
.type
= strcmp(buf1
, "user") == 0 ?
232 IDMAP_TYPE_USER
: IDMAP_TYPE_GROUP
;
235 if (qword_get(&buf
, buf1
, PAGE_SIZE
) <= 0)
237 ent
.id
= simple_strtoul(buf1
, &bp
, 10);
242 ent
.h
.expiry_time
= get_expiry(&buf
);
243 if (ent
.h
.expiry_time
== 0)
247 res
= idtoname_lookup(&ent
);
253 len
= qword_get(&buf
, buf1
, PAGE_SIZE
);
257 set_bit(CACHE_NEGATIVE
, &ent
.h
.flags
);
258 else if (len
>= IDMAP_NAMESZ
)
261 memcpy(ent
.name
, buf1
, sizeof(ent
.name
));
263 res
= idtoname_update(&ent
, res
);
267 cache_put(&res
->h
, &idtoname_cache
);
278 idtoname_lookup(struct ent
*item
)
280 struct cache_head
*ch
= sunrpc_cache_lookup(&idtoname_cache
,
282 idtoname_hash(item
));
284 return container_of(ch
, struct ent
, h
);
290 idtoname_update(struct ent
*new, struct ent
*old
)
292 struct cache_head
*ch
= sunrpc_cache_update(&idtoname_cache
,
296 return container_of(ch
, struct ent
, h
);
306 static struct cache_head
*nametoid_table
[ENT_HASHMAX
];
309 nametoid_hash(struct ent
*ent
)
311 return hash_str(ent
->name
, ENT_HASHBITS
);
315 nametoid_request(struct cache_detail
*cd
, struct cache_head
*ch
, char **bpp
,
318 struct ent
*ent
= container_of(ch
, struct ent
, h
);
320 qword_add(bpp
, blen
, ent
->authname
);
321 qword_add(bpp
, blen
, ent
->type
== IDMAP_TYPE_GROUP
? "group" : "user");
322 qword_add(bpp
, blen
, ent
->name
);
328 nametoid_upcall(struct cache_detail
*cd
, struct cache_head
*ch
)
330 return sunrpc_cache_pipe_upcall(cd
, ch
, nametoid_request
);
334 nametoid_match(struct cache_head
*ca
, struct cache_head
*cb
)
336 struct ent
*a
= container_of(ca
, struct ent
, h
);
337 struct ent
*b
= container_of(cb
, struct ent
, h
);
339 return (a
->type
== b
->type
&& strcmp(a
->name
, b
->name
) == 0 &&
340 strcmp(a
->authname
, b
->authname
) == 0);
344 nametoid_show(struct seq_file
*m
, struct cache_detail
*cd
, struct cache_head
*h
)
349 seq_puts(m
, "#domain type name [id]\n");
352 ent
= container_of(h
, struct ent
, h
);
353 seq_printf(m
, "%s %s %s", ent
->authname
,
354 ent
->type
== IDMAP_TYPE_GROUP
? "group" : "user",
356 if (test_bit(CACHE_VALID
, &h
->flags
))
357 seq_printf(m
, " %u", ent
->id
);
362 static struct ent
*nametoid_lookup(struct ent
*);
363 static struct ent
*nametoid_update(struct ent
*, struct ent
*);
364 static int nametoid_parse(struct cache_detail
*, char *, int);
366 static struct cache_detail nametoid_cache
= {
367 .owner
= THIS_MODULE
,
368 .hash_size
= ENT_HASHMAX
,
369 .hash_table
= nametoid_table
,
370 .name
= "nfs4.nametoid",
371 .cache_put
= ent_put
,
372 .cache_upcall
= nametoid_upcall
,
373 .cache_parse
= nametoid_parse
,
374 .cache_show
= nametoid_show
,
375 .warn_no_listener
= warn_no_idmapd
,
376 .match
= nametoid_match
,
383 nametoid_parse(struct cache_detail
*cd
, char *buf
, int buflen
)
385 struct ent ent
, *res
;
389 if (buf
[buflen
- 1] != '\n')
391 buf
[buflen
- 1]= '\0';
393 buf1
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
397 memset(&ent
, 0, sizeof(ent
));
399 /* Authentication name */
400 if (qword_get(&buf
, buf1
, PAGE_SIZE
) <= 0)
402 memcpy(ent
.authname
, buf1
, sizeof(ent
.authname
));
405 if (qword_get(&buf
, buf1
, PAGE_SIZE
) <= 0)
407 ent
.type
= strcmp(buf1
, "user") == 0 ?
408 IDMAP_TYPE_USER
: IDMAP_TYPE_GROUP
;
411 error
= qword_get(&buf
, buf1
, PAGE_SIZE
);
412 if (error
<= 0 || error
>= IDMAP_NAMESZ
)
414 memcpy(ent
.name
, buf1
, sizeof(ent
.name
));
417 ent
.h
.expiry_time
= get_expiry(&buf
);
418 if (ent
.h
.expiry_time
== 0)
422 error
= get_int(&buf
, &ent
.id
);
423 if (error
== -EINVAL
)
425 if (error
== -ENOENT
)
426 set_bit(CACHE_NEGATIVE
, &ent
.h
.flags
);
429 res
= nametoid_lookup(&ent
);
432 res
= nametoid_update(&ent
, res
);
436 cache_put(&res
->h
, &nametoid_cache
);
446 nametoid_lookup(struct ent
*item
)
448 struct cache_head
*ch
= sunrpc_cache_lookup(&nametoid_cache
,
450 nametoid_hash(item
));
452 return container_of(ch
, struct ent
, h
);
458 nametoid_update(struct ent
*new, struct ent
*old
)
460 struct cache_head
*ch
= sunrpc_cache_update(&nametoid_cache
,
464 return container_of(ch
, struct ent
, h
);
474 nfsd_idmap_init(void)
478 rv
= cache_register_net(&idtoname_cache
, &init_net
);
481 rv
= cache_register_net(&nametoid_cache
, &init_net
);
483 cache_unregister_net(&idtoname_cache
, &init_net
);
488 nfsd_idmap_shutdown(void)
490 cache_unregister_net(&idtoname_cache
, &init_net
);
491 cache_unregister_net(&nametoid_cache
, &init_net
);
495 idmap_lookup(struct svc_rqst
*rqstp
,
496 struct ent
*(*lookup_fn
)(struct ent
*), struct ent
*key
,
497 struct cache_detail
*detail
, struct ent
**item
)
501 *item
= lookup_fn(key
);
505 ret
= cache_check(detail
, &(*item
)->h
, &rqstp
->rq_chandle
);
507 if (ret
== -ETIMEDOUT
) {
508 struct ent
*prev_item
= *item
;
509 *item
= lookup_fn(key
);
510 if (*item
!= prev_item
)
512 cache_put(&(*item
)->h
, detail
);
518 rqst_authname(struct svc_rqst
*rqstp
)
520 struct auth_domain
*clp
;
522 clp
= rqstp
->rq_gssclient
? rqstp
->rq_gssclient
: rqstp
->rq_client
;
527 idmap_name_to_id(struct svc_rqst
*rqstp
, int type
, const char *name
, u32 namelen
,
530 struct ent
*item
, key
= {
535 if (namelen
+ 1 > sizeof(key
.name
))
536 return nfserr_badowner
;
537 memcpy(key
.name
, name
, namelen
);
538 key
.name
[namelen
] = '\0';
539 strlcpy(key
.authname
, rqst_authname(rqstp
), sizeof(key
.authname
));
540 ret
= idmap_lookup(rqstp
, nametoid_lookup
, &key
, &nametoid_cache
, &item
);
542 return nfserr_badowner
;
544 return nfserrno(ret
);
546 cache_put(&item
->h
, &nametoid_cache
);
551 idmap_id_to_name(struct svc_rqst
*rqstp
, int type
, uid_t id
, char *name
)
553 struct ent
*item
, key
= {
559 strlcpy(key
.authname
, rqst_authname(rqstp
), sizeof(key
.authname
));
560 ret
= idmap_lookup(rqstp
, idtoname_lookup
, &key
, &idtoname_cache
, &item
);
562 return sprintf(name
, "%u", id
);
565 ret
= strlen(item
->name
);
566 BUG_ON(ret
> IDMAP_NAMESZ
);
567 memcpy(name
, item
->name
, ret
);
568 cache_put(&item
->h
, &idtoname_cache
);
573 numeric_name_to_id(struct svc_rqst
*rqstp
, int type
, const char *name
, u32 namelen
, uid_t
*id
)
578 if (namelen
+ 1 > sizeof(buf
))
579 /* too long to represent a 32-bit id: */
581 /* Just to make sure it's null-terminated: */
582 memcpy(buf
, name
, namelen
);
584 ret
= kstrtouint(name
, 10, id
);
589 do_name_to_id(struct svc_rqst
*rqstp
, int type
, const char *name
, u32 namelen
, uid_t
*id
)
591 if (nfs4_disable_idmapping
&& rqstp
->rq_flavor
< RPC_AUTH_GSS
)
592 if (numeric_name_to_id(rqstp
, type
, name
, namelen
, id
))
595 * otherwise, fall through and try idmapping, for
596 * backwards compatibility with clients sending names:
598 return idmap_name_to_id(rqstp
, type
, name
, namelen
, id
);
602 do_id_to_name(struct svc_rqst
*rqstp
, int type
, uid_t id
, char *name
)
604 if (nfs4_disable_idmapping
&& rqstp
->rq_flavor
< RPC_AUTH_GSS
)
605 return sprintf(name
, "%u", id
);
606 return idmap_id_to_name(rqstp
, type
, id
, name
);
610 nfsd_map_name_to_uid(struct svc_rqst
*rqstp
, const char *name
, size_t namelen
,
613 return do_name_to_id(rqstp
, IDMAP_TYPE_USER
, name
, namelen
, id
);
617 nfsd_map_name_to_gid(struct svc_rqst
*rqstp
, const char *name
, size_t namelen
,
620 return do_name_to_id(rqstp
, IDMAP_TYPE_GROUP
, name
, namelen
, id
);
624 nfsd_map_uid_to_name(struct svc_rqst
*rqstp
, __u32 id
, char *name
)
626 return do_id_to_name(rqstp
, IDMAP_TYPE_USER
, id
, name
);
630 nfsd_map_gid_to_name(struct svc_rqst
*rqstp
, __u32 id
, char *name
)
632 return do_id_to_name(rqstp
, IDMAP_TYPE_GROUP
, id
, name
);