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>
46 * Turn off idmapping when using AUTH_SYS.
48 static bool nfs4_disable_idmapping = true;
49 module_param(nfs4_disable_idmapping, bool, 0644);
50 MODULE_PARM_DESC(nfs4_disable_idmapping,
51 "Turn off server's NFSv4 idmapping when using 'sec=sys'");
58 * XXX we know that IDMAP_NAMESZ < PAGE_SIZE, but it's ugly to rely on
62 #define IDMAP_TYPE_USER 0
63 #define IDMAP_TYPE_GROUP 1
67 int type; /* User / Group */
69 char name[IDMAP_NAMESZ];
70 char authname[IDMAP_NAMESZ];
73 /* Common entry handling */
75 #define ENT_HASHBITS 8
76 #define ENT_HASHMAX (1 << ENT_HASHBITS)
79 ent_init(struct cache_head *cnew, struct cache_head *citm)
81 struct ent *new = container_of(cnew, struct ent, h);
82 struct ent *itm = container_of(citm, struct ent, h);
85 new->type = itm->type;
87 strlcpy(new->name, itm->name, sizeof(new->name));
88 strlcpy(new->authname, itm->authname, sizeof(new->name));
92 ent_put(struct kref *ref)
94 struct ent *map = container_of(ref, struct ent, h.ref);
98 static struct cache_head *
101 struct ent *e = kmalloc(sizeof(*e), GFP_KERNEL);
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_match(struct cache_head *ca, struct cache_head *cb)
145 struct ent *a = container_of(ca, struct ent, h);
146 struct ent *b = container_of(cb, struct ent, h);
148 return (a->id == b->id && a->type == b->type &&
149 strcmp(a->authname, b->authname) == 0);
153 idtoname_show(struct seq_file *m, struct cache_detail *cd, struct cache_head *h)
158 seq_puts(m, "#domain type id [name]\n");
161 ent = container_of(h, struct ent, h);
162 seq_printf(m, "%s %s %u", ent->authname,
163 ent->type == IDMAP_TYPE_GROUP ? "group" : "user",
165 if (test_bit(CACHE_VALID, &h->flags))
166 seq_printf(m, " %s", ent->name);
172 warn_no_idmapd(struct cache_detail *detail, int has_died)
174 printk("nfsd: nfsv4 idmapping failing: has idmapd %s?\n",
175 has_died ? "died" : "not been started");
179 static int idtoname_parse(struct cache_detail *, char *, int);
180 static struct ent *idtoname_lookup(struct cache_detail *, struct ent *);
181 static struct ent *idtoname_update(struct cache_detail *, struct ent *,
184 static struct cache_detail idtoname_cache_template = {
185 .owner = THIS_MODULE,
186 .hash_size = ENT_HASHMAX,
187 .name = "nfs4.idtoname",
188 .cache_put = ent_put,
189 .cache_request = idtoname_request,
190 .cache_parse = idtoname_parse,
191 .cache_show = idtoname_show,
192 .warn_no_listener = warn_no_idmapd,
193 .match = idtoname_match,
200 idtoname_parse(struct cache_detail *cd, char *buf, int buflen)
202 struct ent ent, *res;
207 if (buf[buflen - 1] != '\n')
209 buf[buflen - 1]= '\0';
211 buf1 = kmalloc(PAGE_SIZE, GFP_KERNEL);
215 memset(&ent, 0, sizeof(ent));
217 /* Authentication name */
218 len = qword_get(&buf, buf1, PAGE_SIZE);
219 if (len <= 0 || len >= IDMAP_NAMESZ)
221 memcpy(ent.authname, buf1, sizeof(ent.authname));
224 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
226 ent.type = strcmp(buf1, "user") == 0 ?
227 IDMAP_TYPE_USER : IDMAP_TYPE_GROUP;
230 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
232 ent.id = simple_strtoul(buf1, &bp, 10);
237 ent.h.expiry_time = get_expiry(&buf);
238 if (ent.h.expiry_time == 0)
242 res = idtoname_lookup(cd, &ent);
248 len = qword_get(&buf, buf1, PAGE_SIZE);
249 if (len < 0 || len >= IDMAP_NAMESZ)
252 set_bit(CACHE_NEGATIVE, &ent.h.flags);
254 memcpy(ent.name, buf1, sizeof(ent.name));
256 res = idtoname_update(cd, &ent, res);
260 cache_put(&res->h, cd);
268 idtoname_lookup(struct cache_detail *cd, struct ent *item)
270 struct cache_head *ch = sunrpc_cache_lookup(cd, &item->h,
271 idtoname_hash(item));
273 return container_of(ch, struct ent, h);
279 idtoname_update(struct cache_detail *cd, struct ent *new, struct ent *old)
281 struct cache_head *ch = sunrpc_cache_update(cd, &new->h, &old->h,
284 return container_of(ch, struct ent, h);
295 nametoid_hash(struct ent *ent)
297 return hash_str(ent->name, ENT_HASHBITS);
301 nametoid_request(struct cache_detail *cd, struct cache_head *ch, char **bpp,
304 struct ent *ent = container_of(ch, struct ent, h);
306 qword_add(bpp, blen, ent->authname);
307 qword_add(bpp, blen, ent->type == IDMAP_TYPE_GROUP ? "group" : "user");
308 qword_add(bpp, blen, ent->name);
314 nametoid_match(struct cache_head *ca, struct cache_head *cb)
316 struct ent *a = container_of(ca, struct ent, h);
317 struct ent *b = container_of(cb, struct ent, h);
319 return (a->type == b->type && strcmp(a->name, b->name) == 0 &&
320 strcmp(a->authname, b->authname) == 0);
324 nametoid_show(struct seq_file *m, struct cache_detail *cd, struct cache_head *h)
329 seq_puts(m, "#domain type name [id]\n");
332 ent = container_of(h, struct ent, h);
333 seq_printf(m, "%s %s %s", ent->authname,
334 ent->type == IDMAP_TYPE_GROUP ? "group" : "user",
336 if (test_bit(CACHE_VALID, &h->flags))
337 seq_printf(m, " %u", ent->id);
342 static struct ent *nametoid_lookup(struct cache_detail *, struct ent *);
343 static struct ent *nametoid_update(struct cache_detail *, struct ent *,
345 static int nametoid_parse(struct cache_detail *, char *, int);
347 static struct cache_detail nametoid_cache_template = {
348 .owner = THIS_MODULE,
349 .hash_size = ENT_HASHMAX,
350 .name = "nfs4.nametoid",
351 .cache_put = ent_put,
352 .cache_request = nametoid_request,
353 .cache_parse = nametoid_parse,
354 .cache_show = nametoid_show,
355 .warn_no_listener = warn_no_idmapd,
356 .match = nametoid_match,
363 nametoid_parse(struct cache_detail *cd, char *buf, int buflen)
365 struct ent ent, *res;
367 int len, error = -EINVAL;
369 if (buf[buflen - 1] != '\n')
371 buf[buflen - 1]= '\0';
373 buf1 = kmalloc(PAGE_SIZE, GFP_KERNEL);
377 memset(&ent, 0, sizeof(ent));
379 /* Authentication name */
380 len = qword_get(&buf, buf1, PAGE_SIZE);
381 if (len <= 0 || len >= IDMAP_NAMESZ)
383 memcpy(ent.authname, buf1, sizeof(ent.authname));
386 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
388 ent.type = strcmp(buf1, "user") == 0 ?
389 IDMAP_TYPE_USER : IDMAP_TYPE_GROUP;
392 len = qword_get(&buf, buf1, PAGE_SIZE);
393 if (len <= 0 || len >= IDMAP_NAMESZ)
395 memcpy(ent.name, buf1, sizeof(ent.name));
398 ent.h.expiry_time = get_expiry(&buf);
399 if (ent.h.expiry_time == 0)
403 error = get_int(&buf, &ent.id);
404 if (error == -EINVAL)
406 if (error == -ENOENT)
407 set_bit(CACHE_NEGATIVE, &ent.h.flags);
410 res = nametoid_lookup(cd, &ent);
413 res = nametoid_update(cd, &ent, res);
417 cache_put(&res->h, cd);
426 nametoid_lookup(struct cache_detail *cd, struct ent *item)
428 struct cache_head *ch = sunrpc_cache_lookup(cd, &item->h,
429 nametoid_hash(item));
431 return container_of(ch, struct ent, h);
437 nametoid_update(struct cache_detail *cd, struct ent *new, struct ent *old)
439 struct cache_head *ch = sunrpc_cache_update(cd, &new->h, &old->h,
442 return container_of(ch, struct ent, h);
452 nfsd_idmap_init(struct net *net)
455 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
457 nn->idtoname_cache = cache_create_net(&idtoname_cache_template, net);
458 if (IS_ERR(nn->idtoname_cache))
459 return PTR_ERR(nn->idtoname_cache);
460 rv = cache_register_net(nn->idtoname_cache, net);
462 goto destroy_idtoname_cache;
463 nn->nametoid_cache = cache_create_net(&nametoid_cache_template, net);
464 if (IS_ERR(nn->nametoid_cache)) {
465 rv = PTR_ERR(nn->nametoid_cache);
466 goto unregister_idtoname_cache;
468 rv = cache_register_net(nn->nametoid_cache, net);
470 goto destroy_nametoid_cache;
473 destroy_nametoid_cache:
474 cache_destroy_net(nn->nametoid_cache, net);
475 unregister_idtoname_cache:
476 cache_unregister_net(nn->idtoname_cache, net);
477 destroy_idtoname_cache:
478 cache_destroy_net(nn->idtoname_cache, net);
483 nfsd_idmap_shutdown(struct net *net)
485 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
487 cache_unregister_net(nn->idtoname_cache, net);
488 cache_unregister_net(nn->nametoid_cache, net);
489 cache_destroy_net(nn->idtoname_cache, net);
490 cache_destroy_net(nn->nametoid_cache, net);
494 idmap_lookup(struct svc_rqst *rqstp,
495 struct ent *(*lookup_fn)(struct cache_detail *, struct ent *),
496 struct ent *key, struct cache_detail *detail, struct ent **item)
500 *item = lookup_fn(detail, key);
504 ret = cache_check(detail, &(*item)->h, &rqstp->rq_chandle);
506 if (ret == -ETIMEDOUT) {
507 struct ent *prev_item = *item;
508 *item = lookup_fn(detail, key);
509 if (*item != prev_item)
511 cache_put(&(*item)->h, detail);
517 rqst_authname(struct svc_rqst *rqstp)
519 struct auth_domain *clp;
521 clp = rqstp->rq_gssclient ? rqstp->rq_gssclient : rqstp->rq_client;
526 idmap_name_to_id(struct svc_rqst *rqstp, int type, const char *name, u32 namelen,
529 struct ent *item, key = {
533 struct nfsd_net *nn = net_generic(SVC_NET(rqstp), nfsd_net_id);
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, nn->nametoid_cache, &item);
542 return nfserr_badowner;
544 return nfserrno(ret);
546 cache_put(&item->h, nn->nametoid_cache);
550 static __be32 encode_ascii_id(struct xdr_stream *xdr, u32 id)
556 len = sprintf(buf, "%u", id);
557 p = xdr_reserve_space(xdr, len + 4);
559 return nfserr_resource;
560 p = xdr_encode_opaque(p, buf, len);
564 static __be32 idmap_id_to_name(struct xdr_stream *xdr,
565 struct svc_rqst *rqstp, int type, u32 id)
567 struct ent *item, key = {
573 struct nfsd_net *nn = net_generic(SVC_NET(rqstp), nfsd_net_id);
575 strlcpy(key.authname, rqst_authname(rqstp), sizeof(key.authname));
576 ret = idmap_lookup(rqstp, idtoname_lookup, &key, nn->idtoname_cache, &item);
578 return encode_ascii_id(xdr, id);
580 return nfserrno(ret);
581 ret = strlen(item->name);
582 WARN_ON_ONCE(ret > IDMAP_NAMESZ);
583 p = xdr_reserve_space(xdr, ret + 4);
585 return nfserr_resource;
586 p = xdr_encode_opaque(p, item->name, ret);
587 cache_put(&item->h, nn->idtoname_cache);
592 numeric_name_to_id(struct svc_rqst *rqstp, int type, const char *name, u32 namelen, u32 *id)
597 if (namelen + 1 > sizeof(buf))
598 /* too long to represent a 32-bit id: */
600 /* Just to make sure it's null-terminated: */
601 memcpy(buf, name, namelen);
603 ret = kstrtouint(buf, 10, id);
608 do_name_to_id(struct svc_rqst *rqstp, int type, const char *name, u32 namelen, u32 *id)
610 if (nfs4_disable_idmapping && rqstp->rq_cred.cr_flavor < RPC_AUTH_GSS)
611 if (numeric_name_to_id(rqstp, type, name, namelen, id))
614 * otherwise, fall through and try idmapping, for
615 * backwards compatibility with clients sending names:
617 return idmap_name_to_id(rqstp, type, name, namelen, id);
620 static __be32 encode_name_from_id(struct xdr_stream *xdr,
621 struct svc_rqst *rqstp, int type, u32 id)
623 if (nfs4_disable_idmapping && rqstp->rq_cred.cr_flavor < RPC_AUTH_GSS)
624 return encode_ascii_id(xdr, id);
625 return idmap_id_to_name(xdr, rqstp, type, id);
629 nfsd_map_name_to_uid(struct svc_rqst *rqstp, const char *name, size_t namelen,
634 status = do_name_to_id(rqstp, IDMAP_TYPE_USER, name, namelen, &id);
635 *uid = make_kuid(&init_user_ns, id);
636 if (!uid_valid(*uid))
637 status = nfserr_badowner;
642 nfsd_map_name_to_gid(struct svc_rqst *rqstp, const char *name, size_t namelen,
647 status = do_name_to_id(rqstp, IDMAP_TYPE_GROUP, name, namelen, &id);
648 *gid = make_kgid(&init_user_ns, id);
649 if (!gid_valid(*gid))
650 status = nfserr_badowner;
654 __be32 nfsd4_encode_user(struct xdr_stream *xdr, struct svc_rqst *rqstp,
657 u32 id = from_kuid(&init_user_ns, uid);
658 return encode_name_from_id(xdr, rqstp, IDMAP_TYPE_USER, id);
661 __be32 nfsd4_encode_group(struct xdr_stream *xdr, struct svc_rqst *rqstp,
664 u32 id = from_kgid(&init_user_ns, gid);
665 return encode_name_from_id(xdr, rqstp, IDMAP_TYPE_GROUP, id);