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
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 strscpy(new->name, itm->name, sizeof(new->name));
86 strscpy(new->authname, itm->authname, sizeof(new->authname));
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_upcall(struct cache_detail *cd, struct cache_head *h)
128 return sunrpc_cache_pipe_upcall_timeout(cd, h);
132 idtoname_request(struct cache_detail *cd, struct cache_head *ch, char **bpp,
135 struct ent *ent = container_of(ch, struct ent, h);
138 qword_add(bpp, blen, ent->authname);
139 snprintf(idstr, sizeof(idstr), "%u", ent->id);
140 qword_add(bpp, blen, ent->type == IDMAP_TYPE_GROUP ? "group" : "user");
141 qword_add(bpp, blen, idstr);
147 idtoname_match(struct cache_head *ca, struct cache_head *cb)
149 struct ent *a = container_of(ca, struct ent, h);
150 struct ent *b = container_of(cb, struct ent, h);
152 return (a->id == b->id && a->type == b->type &&
153 strcmp(a->authname, b->authname) == 0);
157 idtoname_show(struct seq_file *m, struct cache_detail *cd, struct cache_head *h)
162 seq_puts(m, "#domain type id [name]\n");
165 ent = container_of(h, struct ent, h);
166 seq_printf(m, "%s %s %u", ent->authname,
167 ent->type == IDMAP_TYPE_GROUP ? "group" : "user",
169 if (test_bit(CACHE_VALID, &h->flags))
170 seq_printf(m, " %s", ent->name);
176 warn_no_idmapd(struct cache_detail *detail, int has_died)
178 printk("nfsd: nfsv4 idmapping failing: has idmapd %s?\n",
179 has_died ? "died" : "not been started");
183 static int idtoname_parse(struct cache_detail *, char *, int);
184 static struct ent *idtoname_lookup(struct cache_detail *, struct ent *);
185 static struct ent *idtoname_update(struct cache_detail *, struct ent *,
188 static const struct cache_detail idtoname_cache_template = {
189 .owner = THIS_MODULE,
190 .hash_size = ENT_HASHMAX,
191 .name = "nfs4.idtoname",
192 .cache_put = ent_put,
193 .cache_upcall = idtoname_upcall,
194 .cache_request = idtoname_request,
195 .cache_parse = idtoname_parse,
196 .cache_show = idtoname_show,
197 .warn_no_listener = warn_no_idmapd,
198 .match = idtoname_match,
205 idtoname_parse(struct cache_detail *cd, char *buf, int buflen)
207 struct ent ent, *res;
212 if (buf[buflen - 1] != '\n')
214 buf[buflen - 1]= '\0';
216 buf1 = kmalloc(PAGE_SIZE, GFP_KERNEL);
220 memset(&ent, 0, sizeof(ent));
222 /* Authentication name */
223 len = qword_get(&buf, buf1, PAGE_SIZE);
224 if (len <= 0 || len >= IDMAP_NAMESZ)
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(cd, &ent);
253 len = qword_get(&buf, buf1, PAGE_SIZE);
254 if (len < 0 || len >= IDMAP_NAMESZ)
257 set_bit(CACHE_NEGATIVE, &ent.h.flags);
259 memcpy(ent.name, buf1, sizeof(ent.name));
261 res = idtoname_update(cd, &ent, res);
265 cache_put(&res->h, cd);
273 idtoname_lookup(struct cache_detail *cd, struct ent *item)
275 struct cache_head *ch = sunrpc_cache_lookup_rcu(cd, &item->h,
276 idtoname_hash(item));
278 return container_of(ch, struct ent, h);
284 idtoname_update(struct cache_detail *cd, struct ent *new, struct ent *old)
286 struct cache_head *ch = sunrpc_cache_update(cd, &new->h, &old->h,
289 return container_of(ch, struct ent, h);
300 nametoid_hash(struct ent *ent)
302 return hash_str(ent->name, ENT_HASHBITS);
306 nametoid_upcall(struct cache_detail *cd, struct cache_head *h)
308 return sunrpc_cache_pipe_upcall_timeout(cd, h);
312 nametoid_request(struct cache_detail *cd, struct cache_head *ch, char **bpp,
315 struct ent *ent = container_of(ch, struct ent, h);
317 qword_add(bpp, blen, ent->authname);
318 qword_add(bpp, blen, ent->type == IDMAP_TYPE_GROUP ? "group" : "user");
319 qword_add(bpp, blen, ent->name);
325 nametoid_match(struct cache_head *ca, struct cache_head *cb)
327 struct ent *a = container_of(ca, struct ent, h);
328 struct ent *b = container_of(cb, struct ent, h);
330 return (a->type == b->type && strcmp(a->name, b->name) == 0 &&
331 strcmp(a->authname, b->authname) == 0);
335 nametoid_show(struct seq_file *m, struct cache_detail *cd, struct cache_head *h)
340 seq_puts(m, "#domain type name [id]\n");
343 ent = container_of(h, struct ent, h);
344 seq_printf(m, "%s %s %s", ent->authname,
345 ent->type == IDMAP_TYPE_GROUP ? "group" : "user",
347 if (test_bit(CACHE_VALID, &h->flags))
348 seq_printf(m, " %u", ent->id);
353 static struct ent *nametoid_lookup(struct cache_detail *, struct ent *);
354 static struct ent *nametoid_update(struct cache_detail *, struct ent *,
356 static int nametoid_parse(struct cache_detail *, char *, int);
358 static const struct cache_detail nametoid_cache_template = {
359 .owner = THIS_MODULE,
360 .hash_size = ENT_HASHMAX,
361 .name = "nfs4.nametoid",
362 .cache_put = ent_put,
363 .cache_upcall = nametoid_upcall,
364 .cache_request = nametoid_request,
365 .cache_parse = nametoid_parse,
366 .cache_show = nametoid_show,
367 .warn_no_listener = warn_no_idmapd,
368 .match = nametoid_match,
375 nametoid_parse(struct cache_detail *cd, char *buf, int buflen)
377 struct ent ent, *res;
379 int len, error = -EINVAL;
381 if (buf[buflen - 1] != '\n')
383 buf[buflen - 1]= '\0';
385 buf1 = kmalloc(PAGE_SIZE, GFP_KERNEL);
389 memset(&ent, 0, sizeof(ent));
391 /* Authentication name */
392 len = qword_get(&buf, buf1, PAGE_SIZE);
393 if (len <= 0 || len >= IDMAP_NAMESZ)
395 memcpy(ent.authname, buf1, sizeof(ent.authname));
398 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
400 ent.type = strcmp(buf1, "user") == 0 ?
401 IDMAP_TYPE_USER : IDMAP_TYPE_GROUP;
404 len = qword_get(&buf, buf1, PAGE_SIZE);
405 if (len <= 0 || len >= IDMAP_NAMESZ)
407 memcpy(ent.name, buf1, sizeof(ent.name));
410 ent.h.expiry_time = get_expiry(&buf);
411 if (ent.h.expiry_time == 0)
415 error = get_int(&buf, &ent.id);
416 if (error == -EINVAL)
418 if (error == -ENOENT)
419 set_bit(CACHE_NEGATIVE, &ent.h.flags);
422 res = nametoid_lookup(cd, &ent);
425 res = nametoid_update(cd, &ent, res);
429 cache_put(&res->h, cd);
438 nametoid_lookup(struct cache_detail *cd, struct ent *item)
440 struct cache_head *ch = sunrpc_cache_lookup_rcu(cd, &item->h,
441 nametoid_hash(item));
443 return container_of(ch, struct ent, h);
449 nametoid_update(struct cache_detail *cd, struct ent *new, struct ent *old)
451 struct cache_head *ch = sunrpc_cache_update(cd, &new->h, &old->h,
454 return container_of(ch, struct ent, h);
464 nfsd_idmap_init(struct net *net)
467 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
469 nn->idtoname_cache = cache_create_net(&idtoname_cache_template, net);
470 if (IS_ERR(nn->idtoname_cache))
471 return PTR_ERR(nn->idtoname_cache);
472 rv = cache_register_net(nn->idtoname_cache, net);
474 goto destroy_idtoname_cache;
475 nn->nametoid_cache = cache_create_net(&nametoid_cache_template, net);
476 if (IS_ERR(nn->nametoid_cache)) {
477 rv = PTR_ERR(nn->nametoid_cache);
478 goto unregister_idtoname_cache;
480 rv = cache_register_net(nn->nametoid_cache, net);
482 goto destroy_nametoid_cache;
485 destroy_nametoid_cache:
486 cache_destroy_net(nn->nametoid_cache, net);
487 unregister_idtoname_cache:
488 cache_unregister_net(nn->idtoname_cache, net);
489 destroy_idtoname_cache:
490 cache_destroy_net(nn->idtoname_cache, net);
495 nfsd_idmap_shutdown(struct net *net)
497 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
499 cache_unregister_net(nn->idtoname_cache, net);
500 cache_unregister_net(nn->nametoid_cache, net);
501 cache_destroy_net(nn->idtoname_cache, net);
502 cache_destroy_net(nn->nametoid_cache, net);
506 idmap_lookup(struct svc_rqst *rqstp,
507 struct ent *(*lookup_fn)(struct cache_detail *, struct ent *),
508 struct ent *key, struct cache_detail *detail, struct ent **item)
512 *item = lookup_fn(detail, key);
516 ret = cache_check(detail, &(*item)->h, &rqstp->rq_chandle);
518 if (ret == -ETIMEDOUT) {
519 struct ent *prev_item = *item;
520 *item = lookup_fn(detail, key);
521 if (*item != prev_item)
523 cache_put(&(*item)->h, detail);
529 rqst_authname(struct svc_rqst *rqstp)
531 struct auth_domain *clp;
533 clp = rqstp->rq_gssclient ? rqstp->rq_gssclient : rqstp->rq_client;
538 idmap_name_to_id(struct svc_rqst *rqstp, int type, const char *name, u32 namelen,
541 struct ent *item, key = {
545 struct nfsd_net *nn = net_generic(SVC_NET(rqstp), nfsd_net_id);
547 if (namelen + 1 > sizeof(key.name))
548 return nfserr_badowner;
549 memcpy(key.name, name, namelen);
550 key.name[namelen] = '\0';
551 strscpy(key.authname, rqst_authname(rqstp), sizeof(key.authname));
552 ret = idmap_lookup(rqstp, nametoid_lookup, &key, nn->nametoid_cache, &item);
554 return nfserr_badowner;
556 return nfserrno(ret);
558 cache_put(&item->h, nn->nametoid_cache);
562 static __be32 encode_ascii_id(struct xdr_stream *xdr, u32 id)
568 len = sprintf(buf, "%u", id);
569 p = xdr_reserve_space(xdr, len + 4);
571 return nfserr_resource;
572 p = xdr_encode_opaque(p, buf, len);
576 static __be32 idmap_id_to_name(struct xdr_stream *xdr,
577 struct svc_rqst *rqstp, int type, u32 id)
579 struct ent *item, key = {
585 struct nfsd_net *nn = net_generic(SVC_NET(rqstp), nfsd_net_id);
587 strscpy(key.authname, rqst_authname(rqstp), sizeof(key.authname));
588 ret = idmap_lookup(rqstp, idtoname_lookup, &key, nn->idtoname_cache, &item);
590 return encode_ascii_id(xdr, id);
592 return nfserrno(ret);
593 ret = strlen(item->name);
594 WARN_ON_ONCE(ret > IDMAP_NAMESZ);
595 p = xdr_reserve_space(xdr, ret + 4);
597 return nfserr_resource;
598 p = xdr_encode_opaque(p, item->name, ret);
599 cache_put(&item->h, nn->idtoname_cache);
604 numeric_name_to_id(struct svc_rqst *rqstp, int type, const char *name, u32 namelen, u32 *id)
609 if (namelen + 1 > sizeof(buf))
610 /* too long to represent a 32-bit id: */
612 /* Just to make sure it's null-terminated: */
613 memcpy(buf, name, namelen);
615 ret = kstrtouint(buf, 10, id);
620 do_name_to_id(struct svc_rqst *rqstp, int type, const char *name, u32 namelen, u32 *id)
622 if (nfs4_disable_idmapping && rqstp->rq_cred.cr_flavor < RPC_AUTH_GSS)
623 if (numeric_name_to_id(rqstp, type, name, namelen, id))
626 * otherwise, fall through and try idmapping, for
627 * backwards compatibility with clients sending names:
629 return idmap_name_to_id(rqstp, type, name, namelen, id);
632 static __be32 encode_name_from_id(struct xdr_stream *xdr,
633 struct svc_rqst *rqstp, int type, u32 id)
635 if (nfs4_disable_idmapping && rqstp->rq_cred.cr_flavor < RPC_AUTH_GSS)
636 return encode_ascii_id(xdr, id);
637 return idmap_id_to_name(xdr, rqstp, type, id);
641 nfsd_map_name_to_uid(struct svc_rqst *rqstp, const char *name, size_t namelen,
647 if (name == NULL || namelen == 0)
650 status = do_name_to_id(rqstp, IDMAP_TYPE_USER, name, namelen, &id);
651 *uid = make_kuid(nfsd_user_namespace(rqstp), id);
652 if (!uid_valid(*uid))
653 status = nfserr_badowner;
658 nfsd_map_name_to_gid(struct svc_rqst *rqstp, const char *name, size_t namelen,
664 if (name == NULL || namelen == 0)
667 status = do_name_to_id(rqstp, IDMAP_TYPE_GROUP, name, namelen, &id);
668 *gid = make_kgid(nfsd_user_namespace(rqstp), id);
669 if (!gid_valid(*gid))
670 status = nfserr_badowner;
674 __be32 nfsd4_encode_user(struct xdr_stream *xdr, struct svc_rqst *rqstp,
677 u32 id = from_kuid_munged(nfsd_user_namespace(rqstp), uid);
678 return encode_name_from_id(xdr, rqstp, IDMAP_TYPE_USER, id);
681 __be32 nfsd4_encode_group(struct xdr_stream *xdr, struct svc_rqst *rqstp,
684 u32 id = from_kgid_munged(nfsd_user_namespace(rqstp), gid);
685 return encode_name_from_id(xdr, rqstp, IDMAP_TYPE_GROUP, id);