4 * Mapping of UID/GIDs to name and vice versa.
6 * Copyright (c) 2002, 2003 The Regents of the University of
7 * Michigan. All rights reserved.
9 * Marius Aamodt Eriksen <marius@umich.edu>
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. Neither the name of the University nor the names of its
21 * contributors may be used to endorse or promote products derived
22 * from this software without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
25 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
26 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
31 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
32 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
33 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
34 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 #include <linux/module.h>
38 #include <linux/init.h>
41 #include <linux/utsname.h>
42 #include <linux/errno.h>
43 #include <linux/string.h>
44 #include <linux/sunrpc/clnt.h>
45 #include <linux/nfs.h>
46 #include <linux/nfs4.h>
47 #include <linux/nfs_fs.h>
48 #include <linux/nfs_page.h>
49 #include <linux/sunrpc/cache.h>
50 #include <linux/nfsd_idmap.h>
51 #include <linux/list.h>
52 #include <linux/time.h>
53 #include <linux/seq_file.h>
54 #include <linux/sunrpc/svcauth.h>
61 * XXX we know that IDMAP_NAMESZ < PAGE_SIZE, but it's ugly to rely on
65 #define IDMAP_TYPE_USER 0
66 #define IDMAP_TYPE_GROUP 1
70 int type; /* User / Group */
72 char name[IDMAP_NAMESZ];
73 char authname[IDMAP_NAMESZ];
76 /* Common entry handling */
78 #define ENT_HASHBITS 8
79 #define ENT_HASHMAX (1 << ENT_HASHBITS)
80 #define ENT_HASHMASK (ENT_HASHMAX - 1)
83 ent_init(struct cache_head *cnew, struct cache_head *citm)
85 struct ent *new = container_of(cnew, struct ent, h);
86 struct ent *itm = container_of(citm, struct ent, h);
89 new->type = itm->type;
91 strlcpy(new->name, itm->name, sizeof(new->name));
92 strlcpy(new->authname, itm->authname, sizeof(new->name));
96 ent_put(struct kref *ref)
98 struct ent *map = container_of(ref, struct ent, h.ref);
102 static struct cache_head *
105 struct ent *e = kmalloc(sizeof(*e), GFP_KERNEL);
116 static struct cache_head *idtoname_table[ENT_HASHMAX];
119 idtoname_hash(struct ent *ent)
123 hash = hash_str(ent->authname, ENT_HASHBITS);
124 hash = hash_long(hash ^ ent->id, ENT_HASHBITS);
126 /* Flip LSB for user/group */
127 if (ent->type == IDMAP_TYPE_GROUP)
134 idtoname_request(struct cache_detail *cd, struct cache_head *ch, char **bpp,
137 struct ent *ent = container_of(ch, struct ent, h);
140 qword_add(bpp, blen, ent->authname);
141 snprintf(idstr, sizeof(idstr), "%u", ent->id);
142 qword_add(bpp, blen, ent->type == IDMAP_TYPE_GROUP ? "group" : "user");
143 qword_add(bpp, blen, idstr);
149 idtoname_upcall(struct cache_detail *cd, struct cache_head *ch)
151 return sunrpc_cache_pipe_upcall(cd, ch, idtoname_request);
155 idtoname_match(struct cache_head *ca, struct cache_head *cb)
157 struct ent *a = container_of(ca, struct ent, h);
158 struct ent *b = container_of(cb, struct ent, h);
160 return (a->id == b->id && a->type == b->type &&
161 strcmp(a->authname, b->authname) == 0);
165 idtoname_show(struct seq_file *m, struct cache_detail *cd, struct cache_head *h)
170 seq_puts(m, "#domain type id [name]\n");
173 ent = container_of(h, struct ent, h);
174 seq_printf(m, "%s %s %u", ent->authname,
175 ent->type == IDMAP_TYPE_GROUP ? "group" : "user",
177 if (test_bit(CACHE_VALID, &h->flags))
178 seq_printf(m, " %s", ent->name);
184 warn_no_idmapd(struct cache_detail *detail, int has_died)
186 printk("nfsd: nfsv4 idmapping failing: has idmapd %s?\n",
187 has_died ? "died" : "not been started");
191 static int idtoname_parse(struct cache_detail *, char *, int);
192 static struct ent *idtoname_lookup(struct ent *);
193 static struct ent *idtoname_update(struct ent *, struct ent *);
195 static struct cache_detail idtoname_cache = {
196 .owner = THIS_MODULE,
197 .hash_size = ENT_HASHMAX,
198 .hash_table = idtoname_table,
199 .name = "nfs4.idtoname",
200 .cache_put = ent_put,
201 .cache_upcall = idtoname_upcall,
202 .cache_parse = idtoname_parse,
203 .cache_show = idtoname_show,
204 .warn_no_listener = warn_no_idmapd,
205 .match = idtoname_match,
212 idtoname_parse(struct cache_detail *cd, char *buf, int buflen)
214 struct ent ent, *res;
219 if (buf[buflen - 1] != '\n')
221 buf[buflen - 1]= '\0';
223 buf1 = kmalloc(PAGE_SIZE, GFP_KERNEL);
227 memset(&ent, 0, sizeof(ent));
229 /* Authentication name */
230 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
232 memcpy(ent.authname, buf1, sizeof(ent.authname));
235 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
237 ent.type = strcmp(buf1, "user") == 0 ?
238 IDMAP_TYPE_USER : IDMAP_TYPE_GROUP;
241 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
243 ent.id = simple_strtoul(buf1, &bp, 10);
248 ent.h.expiry_time = get_expiry(&buf);
249 if (ent.h.expiry_time == 0)
253 res = idtoname_lookup(&ent);
259 len = qword_get(&buf, buf1, PAGE_SIZE);
263 set_bit(CACHE_NEGATIVE, &ent.h.flags);
264 else if (len >= IDMAP_NAMESZ)
267 memcpy(ent.name, buf1, sizeof(ent.name));
269 res = idtoname_update(&ent, res);
273 cache_put(&res->h, &idtoname_cache);
284 idtoname_lookup(struct ent *item)
286 struct cache_head *ch = sunrpc_cache_lookup(&idtoname_cache,
288 idtoname_hash(item));
290 return container_of(ch, struct ent, h);
296 idtoname_update(struct ent *new, struct ent *old)
298 struct cache_head *ch = sunrpc_cache_update(&idtoname_cache,
302 return container_of(ch, struct ent, h);
312 static struct cache_head *nametoid_table[ENT_HASHMAX];
315 nametoid_hash(struct ent *ent)
317 return hash_str(ent->name, ENT_HASHBITS);
321 nametoid_request(struct cache_detail *cd, struct cache_head *ch, char **bpp,
324 struct ent *ent = container_of(ch, struct ent, h);
326 qword_add(bpp, blen, ent->authname);
327 qword_add(bpp, blen, ent->type == IDMAP_TYPE_GROUP ? "group" : "user");
328 qword_add(bpp, blen, ent->name);
334 nametoid_upcall(struct cache_detail *cd, struct cache_head *ch)
336 return sunrpc_cache_pipe_upcall(cd, ch, nametoid_request);
340 nametoid_match(struct cache_head *ca, struct cache_head *cb)
342 struct ent *a = container_of(ca, struct ent, h);
343 struct ent *b = container_of(cb, struct ent, h);
345 return (a->type == b->type && strcmp(a->name, b->name) == 0 &&
346 strcmp(a->authname, b->authname) == 0);
350 nametoid_show(struct seq_file *m, struct cache_detail *cd, struct cache_head *h)
355 seq_puts(m, "#domain type name [id]\n");
358 ent = container_of(h, struct ent, h);
359 seq_printf(m, "%s %s %s", ent->authname,
360 ent->type == IDMAP_TYPE_GROUP ? "group" : "user",
362 if (test_bit(CACHE_VALID, &h->flags))
363 seq_printf(m, " %u", ent->id);
368 static struct ent *nametoid_lookup(struct ent *);
369 static struct ent *nametoid_update(struct ent *, struct ent *);
370 static int nametoid_parse(struct cache_detail *, char *, int);
372 static struct cache_detail nametoid_cache = {
373 .owner = THIS_MODULE,
374 .hash_size = ENT_HASHMAX,
375 .hash_table = nametoid_table,
376 .name = "nfs4.nametoid",
377 .cache_put = ent_put,
378 .cache_upcall = nametoid_upcall,
379 .cache_parse = nametoid_parse,
380 .cache_show = nametoid_show,
381 .warn_no_listener = warn_no_idmapd,
382 .match = nametoid_match,
389 nametoid_parse(struct cache_detail *cd, char *buf, int buflen)
391 struct ent ent, *res;
395 if (buf[buflen - 1] != '\n')
397 buf[buflen - 1]= '\0';
399 buf1 = kmalloc(PAGE_SIZE, GFP_KERNEL);
403 memset(&ent, 0, sizeof(ent));
405 /* Authentication name */
406 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
408 memcpy(ent.authname, buf1, sizeof(ent.authname));
411 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
413 ent.type = strcmp(buf1, "user") == 0 ?
414 IDMAP_TYPE_USER : IDMAP_TYPE_GROUP;
417 error = qword_get(&buf, buf1, PAGE_SIZE);
418 if (error <= 0 || error >= IDMAP_NAMESZ)
420 memcpy(ent.name, buf1, sizeof(ent.name));
423 ent.h.expiry_time = get_expiry(&buf);
424 if (ent.h.expiry_time == 0)
428 error = get_int(&buf, &ent.id);
429 if (error == -EINVAL)
431 if (error == -ENOENT)
432 set_bit(CACHE_NEGATIVE, &ent.h.flags);
435 res = nametoid_lookup(&ent);
438 res = nametoid_update(&ent, res);
442 cache_put(&res->h, &nametoid_cache);
452 nametoid_lookup(struct ent *item)
454 struct cache_head *ch = sunrpc_cache_lookup(&nametoid_cache,
456 nametoid_hash(item));
458 return container_of(ch, struct ent, h);
464 nametoid_update(struct ent *new, struct ent *old)
466 struct cache_head *ch = sunrpc_cache_update(&nametoid_cache,
470 return container_of(ch, struct ent, h);
480 nfsd_idmap_init(void)
484 rv = cache_register(&idtoname_cache);
487 rv = cache_register(&nametoid_cache);
489 cache_unregister(&idtoname_cache);
494 nfsd_idmap_shutdown(void)
496 cache_unregister(&idtoname_cache);
497 cache_unregister(&nametoid_cache);
501 * Deferred request handling
504 struct idmap_defer_req {
505 struct cache_req req;
506 struct cache_deferred_req deferred_req;
507 wait_queue_head_t waitq;
512 put_mdr(struct idmap_defer_req *mdr)
514 if (atomic_dec_and_test(&mdr->count))
519 get_mdr(struct idmap_defer_req *mdr)
521 atomic_inc(&mdr->count);
525 idmap_revisit(struct cache_deferred_req *dreq, int toomany)
527 struct idmap_defer_req *mdr =
528 container_of(dreq, struct idmap_defer_req, deferred_req);
530 wake_up(&mdr->waitq);
534 static struct cache_deferred_req *
535 idmap_defer(struct cache_req *req)
537 struct idmap_defer_req *mdr =
538 container_of(req, struct idmap_defer_req, req);
540 mdr->deferred_req.revisit = idmap_revisit;
542 return (&mdr->deferred_req);
546 do_idmap_lookup(struct ent *(*lookup_fn)(struct ent *), struct ent *key,
547 struct cache_detail *detail, struct ent **item,
548 struct idmap_defer_req *mdr)
550 *item = lookup_fn(key);
553 return cache_check(detail, &(*item)->h, &mdr->req);
557 do_idmap_lookup_nowait(struct ent *(*lookup_fn)(struct ent *),
558 struct ent *key, struct cache_detail *detail,
563 *item = lookup_fn(key);
567 if (!test_bit(CACHE_VALID, &(*item)->h.flags)
568 || (*item)->h.expiry_time < get_seconds()
569 || detail->flush_time > (*item)->h.last_refresh)
572 if (test_bit(CACHE_NEGATIVE, &(*item)->h.flags))
576 cache_put(&(*item)->h, detail);
583 idmap_lookup(struct svc_rqst *rqstp,
584 struct ent *(*lookup_fn)(struct ent *), struct ent *key,
585 struct cache_detail *detail, struct ent **item)
587 struct idmap_defer_req *mdr;
590 mdr = kzalloc(sizeof(*mdr), GFP_KERNEL);
593 atomic_set(&mdr->count, 1);
594 init_waitqueue_head(&mdr->waitq);
595 mdr->req.defer = idmap_defer;
596 ret = do_idmap_lookup(lookup_fn, key, detail, item, mdr);
597 if (ret == -EAGAIN) {
598 wait_event_interruptible_timeout(mdr->waitq,
599 test_bit(CACHE_VALID, &(*item)->h.flags), 1 * HZ);
600 ret = do_idmap_lookup_nowait(lookup_fn, key, detail, item);
607 rqst_authname(struct svc_rqst *rqstp)
609 struct auth_domain *clp;
611 clp = rqstp->rq_gssclient ? rqstp->rq_gssclient : rqstp->rq_client;
616 idmap_name_to_id(struct svc_rqst *rqstp, int type, const char *name, u32 namelen,
619 struct ent *item, key = {
624 if (namelen + 1 > sizeof(key.name))
626 memcpy(key.name, name, namelen);
627 key.name[namelen] = '\0';
628 strlcpy(key.authname, rqst_authname(rqstp), sizeof(key.authname));
629 ret = idmap_lookup(rqstp, nametoid_lookup, &key, &nametoid_cache, &item);
631 ret = -ESRCH; /* nfserr_badname */
635 cache_put(&item->h, &nametoid_cache);
640 idmap_id_to_name(struct svc_rqst *rqstp, int type, uid_t id, char *name)
642 struct ent *item, key = {
648 strlcpy(key.authname, rqst_authname(rqstp), sizeof(key.authname));
649 ret = idmap_lookup(rqstp, idtoname_lookup, &key, &idtoname_cache, &item);
651 return sprintf(name, "%u", id);
654 ret = strlen(item->name);
655 BUG_ON(ret > IDMAP_NAMESZ);
656 memcpy(name, item->name, ret);
657 cache_put(&item->h, &idtoname_cache);
662 nfsd_map_name_to_uid(struct svc_rqst *rqstp, const char *name, size_t namelen,
665 return idmap_name_to_id(rqstp, IDMAP_TYPE_USER, name, namelen, id);
669 nfsd_map_name_to_gid(struct svc_rqst *rqstp, const char *name, size_t namelen,
672 return idmap_name_to_id(rqstp, IDMAP_TYPE_GROUP, name, namelen, id);
676 nfsd_map_uid_to_name(struct svc_rqst *rqstp, __u32 id, char *name)
678 return idmap_id_to_name(rqstp, IDMAP_TYPE_USER, id, name);
682 nfsd_map_gid_to_name(struct svc_rqst *rqstp, __u32 id, char *name)
684 return idmap_id_to_name(rqstp, IDMAP_TYPE_GROUP, id, name);