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.
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
64 int type; /* User / Group */
66 char name[IDMAP_NAMESZ];
67 char authname[IDMAP_NAMESZ];
68 struct rcu_head rcu_head;
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);
93 kfree_rcu(map, rcu_head);
96 static struct cache_head *
99 struct ent *e = kmalloc(sizeof(*e), GFP_KERNEL);
111 idtoname_hash(struct ent *ent)
115 hash = hash_str(ent->authname, ENT_HASHBITS);
116 hash = hash_long(hash ^ ent->id, ENT_HASHBITS);
118 /* Flip LSB for user/group */
119 if (ent->type == IDMAP_TYPE_GROUP)
126 idtoname_request(struct cache_detail *cd, struct cache_head *ch, char **bpp,
129 struct ent *ent = container_of(ch, struct ent, h);
132 qword_add(bpp, blen, ent->authname);
133 snprintf(idstr, sizeof(idstr), "%u", ent->id);
134 qword_add(bpp, blen, ent->type == IDMAP_TYPE_GROUP ? "group" : "user");
135 qword_add(bpp, blen, idstr);
141 idtoname_match(struct cache_head *ca, struct cache_head *cb)
143 struct ent *a = container_of(ca, struct ent, h);
144 struct ent *b = container_of(cb, struct ent, h);
146 return (a->id == b->id && a->type == b->type &&
147 strcmp(a->authname, b->authname) == 0);
151 idtoname_show(struct seq_file *m, struct cache_detail *cd, struct cache_head *h)
156 seq_puts(m, "#domain type id [name]\n");
159 ent = container_of(h, struct ent, h);
160 seq_printf(m, "%s %s %u", ent->authname,
161 ent->type == IDMAP_TYPE_GROUP ? "group" : "user",
163 if (test_bit(CACHE_VALID, &h->flags))
164 seq_printf(m, " %s", ent->name);
170 warn_no_idmapd(struct cache_detail *detail, int has_died)
172 printk("nfsd: nfsv4 idmapping failing: has idmapd %s?\n",
173 has_died ? "died" : "not been started");
177 static int idtoname_parse(struct cache_detail *, char *, int);
178 static struct ent *idtoname_lookup(struct cache_detail *, struct ent *);
179 static struct ent *idtoname_update(struct cache_detail *, struct ent *,
182 static const struct cache_detail idtoname_cache_template = {
183 .owner = THIS_MODULE,
184 .hash_size = ENT_HASHMAX,
185 .name = "nfs4.idtoname",
186 .cache_put = ent_put,
187 .cache_request = idtoname_request,
188 .cache_parse = idtoname_parse,
189 .cache_show = idtoname_show,
190 .warn_no_listener = warn_no_idmapd,
191 .match = idtoname_match,
198 idtoname_parse(struct cache_detail *cd, char *buf, int buflen)
200 struct ent ent, *res;
205 if (buf[buflen - 1] != '\n')
207 buf[buflen - 1]= '\0';
209 buf1 = kmalloc(PAGE_SIZE, GFP_KERNEL);
213 memset(&ent, 0, sizeof(ent));
215 /* Authentication name */
216 len = qword_get(&buf, buf1, PAGE_SIZE);
217 if (len <= 0 || len >= IDMAP_NAMESZ)
219 memcpy(ent.authname, buf1, sizeof(ent.authname));
222 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
224 ent.type = strcmp(buf1, "user") == 0 ?
225 IDMAP_TYPE_USER : IDMAP_TYPE_GROUP;
228 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
230 ent.id = simple_strtoul(buf1, &bp, 10);
235 ent.h.expiry_time = get_expiry(&buf);
236 if (ent.h.expiry_time == 0)
240 res = idtoname_lookup(cd, &ent);
246 len = qword_get(&buf, buf1, PAGE_SIZE);
247 if (len < 0 || len >= IDMAP_NAMESZ)
250 set_bit(CACHE_NEGATIVE, &ent.h.flags);
252 memcpy(ent.name, buf1, sizeof(ent.name));
254 res = idtoname_update(cd, &ent, res);
258 cache_put(&res->h, cd);
266 idtoname_lookup(struct cache_detail *cd, struct ent *item)
268 struct cache_head *ch = sunrpc_cache_lookup_rcu(cd, &item->h,
269 idtoname_hash(item));
271 return container_of(ch, struct ent, h);
277 idtoname_update(struct cache_detail *cd, struct ent *new, struct ent *old)
279 struct cache_head *ch = sunrpc_cache_update(cd, &new->h, &old->h,
282 return container_of(ch, struct ent, h);
293 nametoid_hash(struct ent *ent)
295 return hash_str(ent->name, ENT_HASHBITS);
299 nametoid_request(struct cache_detail *cd, struct cache_head *ch, char **bpp,
302 struct ent *ent = container_of(ch, struct ent, h);
304 qword_add(bpp, blen, ent->authname);
305 qword_add(bpp, blen, ent->type == IDMAP_TYPE_GROUP ? "group" : "user");
306 qword_add(bpp, blen, ent->name);
312 nametoid_match(struct cache_head *ca, struct cache_head *cb)
314 struct ent *a = container_of(ca, struct ent, h);
315 struct ent *b = container_of(cb, struct ent, h);
317 return (a->type == b->type && strcmp(a->name, b->name) == 0 &&
318 strcmp(a->authname, b->authname) == 0);
322 nametoid_show(struct seq_file *m, struct cache_detail *cd, struct cache_head *h)
327 seq_puts(m, "#domain type name [id]\n");
330 ent = container_of(h, struct ent, h);
331 seq_printf(m, "%s %s %s", ent->authname,
332 ent->type == IDMAP_TYPE_GROUP ? "group" : "user",
334 if (test_bit(CACHE_VALID, &h->flags))
335 seq_printf(m, " %u", ent->id);
340 static struct ent *nametoid_lookup(struct cache_detail *, struct ent *);
341 static struct ent *nametoid_update(struct cache_detail *, struct ent *,
343 static int nametoid_parse(struct cache_detail *, char *, int);
345 static const struct cache_detail nametoid_cache_template = {
346 .owner = THIS_MODULE,
347 .hash_size = ENT_HASHMAX,
348 .name = "nfs4.nametoid",
349 .cache_put = ent_put,
350 .cache_request = nametoid_request,
351 .cache_parse = nametoid_parse,
352 .cache_show = nametoid_show,
353 .warn_no_listener = warn_no_idmapd,
354 .match = nametoid_match,
361 nametoid_parse(struct cache_detail *cd, char *buf, int buflen)
363 struct ent ent, *res;
365 int len, error = -EINVAL;
367 if (buf[buflen - 1] != '\n')
369 buf[buflen - 1]= '\0';
371 buf1 = kmalloc(PAGE_SIZE, GFP_KERNEL);
375 memset(&ent, 0, sizeof(ent));
377 /* Authentication name */
378 len = qword_get(&buf, buf1, PAGE_SIZE);
379 if (len <= 0 || len >= IDMAP_NAMESZ)
381 memcpy(ent.authname, buf1, sizeof(ent.authname));
384 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
386 ent.type = strcmp(buf1, "user") == 0 ?
387 IDMAP_TYPE_USER : IDMAP_TYPE_GROUP;
390 len = qword_get(&buf, buf1, PAGE_SIZE);
391 if (len <= 0 || len >= IDMAP_NAMESZ)
393 memcpy(ent.name, buf1, sizeof(ent.name));
396 ent.h.expiry_time = get_expiry(&buf);
397 if (ent.h.expiry_time == 0)
401 error = get_int(&buf, &ent.id);
402 if (error == -EINVAL)
404 if (error == -ENOENT)
405 set_bit(CACHE_NEGATIVE, &ent.h.flags);
408 res = nametoid_lookup(cd, &ent);
411 res = nametoid_update(cd, &ent, res);
415 cache_put(&res->h, cd);
424 nametoid_lookup(struct cache_detail *cd, struct ent *item)
426 struct cache_head *ch = sunrpc_cache_lookup_rcu(cd, &item->h,
427 nametoid_hash(item));
429 return container_of(ch, struct ent, h);
435 nametoid_update(struct cache_detail *cd, struct ent *new, struct ent *old)
437 struct cache_head *ch = sunrpc_cache_update(cd, &new->h, &old->h,
440 return container_of(ch, struct ent, h);
450 nfsd_idmap_init(struct net *net)
453 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
455 nn->idtoname_cache = cache_create_net(&idtoname_cache_template, net);
456 if (IS_ERR(nn->idtoname_cache))
457 return PTR_ERR(nn->idtoname_cache);
458 rv = cache_register_net(nn->idtoname_cache, net);
460 goto destroy_idtoname_cache;
461 nn->nametoid_cache = cache_create_net(&nametoid_cache_template, net);
462 if (IS_ERR(nn->nametoid_cache)) {
463 rv = PTR_ERR(nn->nametoid_cache);
464 goto unregister_idtoname_cache;
466 rv = cache_register_net(nn->nametoid_cache, net);
468 goto destroy_nametoid_cache;
471 destroy_nametoid_cache:
472 cache_destroy_net(nn->nametoid_cache, net);
473 unregister_idtoname_cache:
474 cache_unregister_net(nn->idtoname_cache, net);
475 destroy_idtoname_cache:
476 cache_destroy_net(nn->idtoname_cache, net);
481 nfsd_idmap_shutdown(struct net *net)
483 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
485 cache_unregister_net(nn->idtoname_cache, net);
486 cache_unregister_net(nn->nametoid_cache, net);
487 cache_destroy_net(nn->idtoname_cache, net);
488 cache_destroy_net(nn->nametoid_cache, net);
492 idmap_lookup(struct svc_rqst *rqstp,
493 struct ent *(*lookup_fn)(struct cache_detail *, struct ent *),
494 struct ent *key, struct cache_detail *detail, struct ent **item)
498 *item = lookup_fn(detail, key);
502 ret = cache_check(detail, &(*item)->h, &rqstp->rq_chandle);
504 if (ret == -ETIMEDOUT) {
505 struct ent *prev_item = *item;
506 *item = lookup_fn(detail, key);
507 if (*item != prev_item)
509 cache_put(&(*item)->h, detail);
515 rqst_authname(struct svc_rqst *rqstp)
517 struct auth_domain *clp;
519 clp = rqstp->rq_gssclient ? rqstp->rq_gssclient : rqstp->rq_client;
524 idmap_name_to_id(struct svc_rqst *rqstp, int type, const char *name, u32 namelen,
527 struct ent *item, key = {
531 struct nfsd_net *nn = net_generic(SVC_NET(rqstp), nfsd_net_id);
533 if (namelen + 1 > sizeof(key.name))
534 return nfserr_badowner;
535 memcpy(key.name, name, namelen);
536 key.name[namelen] = '\0';
537 strlcpy(key.authname, rqst_authname(rqstp), sizeof(key.authname));
538 ret = idmap_lookup(rqstp, nametoid_lookup, &key, nn->nametoid_cache, &item);
540 return nfserr_badowner;
542 return nfserrno(ret);
544 cache_put(&item->h, nn->nametoid_cache);
548 static __be32 encode_ascii_id(struct xdr_stream *xdr, u32 id)
554 len = sprintf(buf, "%u", id);
555 p = xdr_reserve_space(xdr, len + 4);
557 return nfserr_resource;
558 p = xdr_encode_opaque(p, buf, len);
562 static __be32 idmap_id_to_name(struct xdr_stream *xdr,
563 struct svc_rqst *rqstp, int type, u32 id)
565 struct ent *item, key = {
571 struct nfsd_net *nn = net_generic(SVC_NET(rqstp), nfsd_net_id);
573 strlcpy(key.authname, rqst_authname(rqstp), sizeof(key.authname));
574 ret = idmap_lookup(rqstp, idtoname_lookup, &key, nn->idtoname_cache, &item);
576 return encode_ascii_id(xdr, id);
578 return nfserrno(ret);
579 ret = strlen(item->name);
580 WARN_ON_ONCE(ret > IDMAP_NAMESZ);
581 p = xdr_reserve_space(xdr, ret + 4);
583 return nfserr_resource;
584 p = xdr_encode_opaque(p, item->name, ret);
585 cache_put(&item->h, nn->idtoname_cache);
590 numeric_name_to_id(struct svc_rqst *rqstp, int type, const char *name, u32 namelen, u32 *id)
595 if (namelen + 1 > sizeof(buf))
596 /* too long to represent a 32-bit id: */
598 /* Just to make sure it's null-terminated: */
599 memcpy(buf, name, namelen);
601 ret = kstrtouint(buf, 10, id);
606 do_name_to_id(struct svc_rqst *rqstp, int type, const char *name, u32 namelen, u32 *id)
608 if (nfs4_disable_idmapping && rqstp->rq_cred.cr_flavor < RPC_AUTH_GSS)
609 if (numeric_name_to_id(rqstp, type, name, namelen, id))
612 * otherwise, fall through and try idmapping, for
613 * backwards compatibility with clients sending names:
615 return idmap_name_to_id(rqstp, type, name, namelen, id);
618 static __be32 encode_name_from_id(struct xdr_stream *xdr,
619 struct svc_rqst *rqstp, int type, u32 id)
621 if (nfs4_disable_idmapping && rqstp->rq_cred.cr_flavor < RPC_AUTH_GSS)
622 return encode_ascii_id(xdr, id);
623 return idmap_id_to_name(xdr, rqstp, type, id);
627 nfsd_map_name_to_uid(struct svc_rqst *rqstp, const char *name, size_t namelen,
633 if (name == NULL || namelen == 0)
636 status = do_name_to_id(rqstp, IDMAP_TYPE_USER, name, namelen, &id);
637 *uid = make_kuid(&init_user_ns, id);
638 if (!uid_valid(*uid))
639 status = nfserr_badowner;
644 nfsd_map_name_to_gid(struct svc_rqst *rqstp, const char *name, size_t namelen,
650 if (name == NULL || namelen == 0)
653 status = do_name_to_id(rqstp, IDMAP_TYPE_GROUP, name, namelen, &id);
654 *gid = make_kgid(&init_user_ns, id);
655 if (!gid_valid(*gid))
656 status = nfserr_badowner;
660 __be32 nfsd4_encode_user(struct xdr_stream *xdr, struct svc_rqst *rqstp,
663 u32 id = from_kuid(&init_user_ns, uid);
664 return encode_name_from_id(xdr, rqstp, IDMAP_TYPE_USER, id);
667 __be32 nfsd4_encode_group(struct xdr_stream *xdr, struct svc_rqst *rqstp,
670 u32 id = from_kgid(&init_user_ns, gid);
671 return encode_name_from_id(xdr, rqstp, IDMAP_TYPE_GROUP, id);