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/config.h>
38 #include <linux/module.h>
39 #include <linux/init.h>
42 #include <linux/utsname.h>
43 #include <linux/errno.h>
44 #include <linux/string.h>
45 #include <linux/sunrpc/clnt.h>
46 #include <linux/nfs.h>
47 #include <linux/nfs4.h>
48 #include <linux/nfs_fs.h>
49 #include <linux/nfs_page.h>
50 #include <linux/smp_lock.h>
51 #include <linux/sunrpc/cache.h>
52 #include <linux/nfsd_idmap.h>
53 #include <linux/list.h>
54 #include <linux/sched.h>
55 #include <linux/time.h>
56 #include <linux/seq_file.h>
57 #include <linux/sunrpc/svcauth.h>
64 * XXX we know that IDMAP_NAMESZ < PAGE_SIZE, but it's ugly to rely on
68 #define IDMAP_TYPE_USER 0
69 #define IDMAP_TYPE_GROUP 1
73 int type; /* User / Group */
75 char name[IDMAP_NAMESZ];
76 char authname[IDMAP_NAMESZ];
79 #define DefineSimpleCacheLookupMap(STRUCT, FUNC) \
80 DefineCacheLookup(struct STRUCT, h, FUNC##_lookup, \
81 (struct STRUCT *item, int set), /*no setup */, \
82 & FUNC##_cache, FUNC##_hash(item), FUNC##_match(item, tmp), \
83 STRUCT##_init(new, item), STRUCT##_update(tmp, item), 0)
85 /* Common entry handling */
87 #define ENT_HASHBITS 8
88 #define ENT_HASHMAX (1 << ENT_HASHBITS)
89 #define ENT_HASHMASK (ENT_HASHMAX - 1)
92 ent_init(struct ent *new, struct ent *itm)
95 new->type = itm->type;
97 strlcpy(new->name, itm->name, sizeof(new->name));
98 strlcpy(new->authname, itm->authname, sizeof(new->name));
102 ent_update(struct ent *new, struct ent *itm)
108 ent_put(struct cache_head *ch, struct cache_detail *cd)
110 if (cache_put(ch, cd)) {
111 struct ent *map = container_of(ch, struct ent, h);
120 static struct cache_head *idtoname_table[ENT_HASHMAX];
123 idtoname_hash(struct ent *ent)
127 hash = hash_str(ent->authname, ENT_HASHBITS);
128 hash = hash_long(hash ^ ent->id, ENT_HASHBITS);
130 /* Flip LSB for user/group */
131 if (ent->type == IDMAP_TYPE_GROUP)
138 idtoname_request(struct cache_detail *cd, struct cache_head *ch, char **bpp,
141 struct ent *ent = container_of(ch, struct ent, h);
144 qword_add(bpp, blen, ent->authname);
145 snprintf(idstr, sizeof(idstr), "%d", ent->id);
146 qword_add(bpp, blen, ent->type == IDMAP_TYPE_GROUP ? "group" : "user");
147 qword_add(bpp, blen, idstr);
153 idtoname_match(struct ent *a, struct ent *b)
155 return (a->id == b->id && a->type == b->type &&
156 strcmp(a->authname, b->authname) == 0);
160 idtoname_show(struct seq_file *m, struct cache_detail *cd, struct cache_head *h)
165 seq_puts(m, "#domain type id [name]\n");
168 ent = container_of(h, struct ent, h);
169 seq_printf(m, "%s %s %d", ent->authname,
170 ent->type == IDMAP_TYPE_GROUP ? "group" : "user",
172 if (test_bit(CACHE_VALID, &h->flags))
173 seq_printf(m, " %s", ent->name);
178 static int idtoname_parse(struct cache_detail *, char *, int);
179 static struct ent *idtoname_lookup(struct ent *, int);
181 struct cache_detail idtoname_cache = {
182 .hash_size = ENT_HASHMAX,
183 .hash_table = idtoname_table,
184 .name = "nfs4.idtoname",
185 .cache_put = ent_put,
186 .cache_request = idtoname_request,
187 .cache_parse = idtoname_parse,
188 .cache_show = idtoname_show,
192 idtoname_parse(struct cache_detail *cd, char *buf, int buflen)
194 struct ent ent, *res;
198 if (buf[buflen - 1] != '\n')
200 buf[buflen - 1]= '\0';
202 buf1 = kmalloc(PAGE_SIZE, GFP_KERNEL);
206 memset(&ent, 0, sizeof(ent));
208 /* Authentication name */
209 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
211 memcpy(ent.authname, buf1, sizeof(ent.authname));
214 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
216 ent.type = strcmp(buf1, "user") == 0 ?
217 IDMAP_TYPE_USER : IDMAP_TYPE_GROUP;
220 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
222 ent.id = simple_strtoul(buf1, &bp, 10);
227 ent.h.expiry_time = get_expiry(&buf);
228 if (ent.h.expiry_time == 0)
232 error = qword_get(&buf, buf1, PAGE_SIZE);
233 if (error == -EINVAL)
235 if (error == -ENOENT)
236 set_bit(CACHE_NEGATIVE, &ent.h.flags);
238 if (error >= IDMAP_NAMESZ) {
242 memcpy(ent.name, buf1, sizeof(ent.name));
245 if ((res = idtoname_lookup(&ent, 1)) == NULL)
248 ent_put(&res->h, &idtoname_cache);
257 static DefineSimpleCacheLookupMap(ent, idtoname);
263 static struct cache_head *nametoid_table[ENT_HASHMAX];
266 nametoid_hash(struct ent *ent)
268 return hash_str(ent->name, ENT_HASHBITS);
272 nametoid_request(struct cache_detail *cd, struct cache_head *ch, char **bpp,
275 struct ent *ent = container_of(ch, struct ent, h);
277 qword_add(bpp, blen, ent->authname);
278 qword_add(bpp, blen, ent->type == IDMAP_TYPE_GROUP ? "group" : "user");
279 qword_add(bpp, blen, ent->name);
285 nametoid_match(struct ent *a, struct ent *b)
287 return (a->type == b->type && strcmp(a->name, b->name) == 0 &&
288 strcmp(a->authname, b->authname) == 0);
292 nametoid_show(struct seq_file *m, struct cache_detail *cd, struct cache_head *h)
297 seq_puts(m, "#domain type name [id]\n");
300 ent = container_of(h, struct ent, h);
301 seq_printf(m, "%s %s %s", ent->authname,
302 ent->type == IDMAP_TYPE_GROUP ? "group" : "user",
304 if (test_bit(CACHE_VALID, &h->flags))
305 seq_printf(m, " %d", ent->id);
310 static struct ent *nametoid_lookup(struct ent *, int);
311 int nametoid_parse(struct cache_detail *, char *, int);
313 struct cache_detail nametoid_cache = {
314 .hash_size = ENT_HASHMAX,
315 .hash_table = nametoid_table,
316 .name = "nfs4.nametoid",
317 .cache_put = ent_put,
318 .cache_request = nametoid_request,
319 .cache_parse = nametoid_parse,
320 .cache_show = nametoid_show,
324 nametoid_parse(struct cache_detail *cd, char *buf, int buflen)
326 struct ent ent, *res;
330 if (buf[buflen - 1] != '\n')
332 buf[buflen - 1]= '\0';
334 buf1 = kmalloc(PAGE_SIZE, GFP_KERNEL);
338 memset(&ent, 0, sizeof(ent));
340 /* Authentication name */
341 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
343 memcpy(ent.authname, buf1, sizeof(ent.authname));
346 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
348 ent.type = strcmp(buf1, "user") == 0 ?
349 IDMAP_TYPE_USER : IDMAP_TYPE_GROUP;
352 error = qword_get(&buf, buf1, PAGE_SIZE);
353 if (error <= 0 || error >= IDMAP_NAMESZ)
355 memcpy(ent.name, buf1, sizeof(ent.name));
358 ent.h.expiry_time = get_expiry(&buf);
359 if (ent.h.expiry_time == 0)
363 error = get_int(&buf, &ent.id);
364 if (error == -EINVAL)
366 if (error == -ENOENT)
367 set_bit(CACHE_NEGATIVE, &ent.h.flags);
370 if ((res = nametoid_lookup(&ent, 1)) == NULL)
373 ent_put(&res->h, &nametoid_cache);
381 static DefineSimpleCacheLookupMap(ent, nametoid);
388 nfsd_idmap_init(void)
390 cache_register(&idtoname_cache);
391 cache_register(&nametoid_cache);
395 nfsd_idmap_shutdown(void)
397 cache_unregister(&idtoname_cache);
398 cache_unregister(&nametoid_cache);
402 * Deferred request handling
405 struct idmap_defer_req {
406 struct cache_req req;
407 struct cache_deferred_req deferred_req;
408 wait_queue_head_t waitq;
413 put_mdr(struct idmap_defer_req *mdr)
415 if (atomic_dec_and_test(&mdr->count))
420 idmap_revisit(struct cache_deferred_req *dreq, int toomany)
422 struct idmap_defer_req *mdr =
423 container_of(dreq, struct idmap_defer_req, deferred_req);
425 wake_up(&mdr->waitq);
429 static struct cache_deferred_req *
430 idmap_defer(struct cache_req *req)
432 struct idmap_defer_req *mdr =
433 container_of(req, struct idmap_defer_req, req);
435 mdr->deferred_req.revisit = idmap_revisit;
436 return (&mdr->deferred_req);
439 static int threads_waiting = 0;
442 idmap_lookup_wait(struct idmap_defer_req *mdr, wait_queue_t waitq, struct
444 int ret = -ETIMEDOUT;
446 set_task_state(current, TASK_INTERRUPTIBLE);
448 /* XXX: Does it matter that threads_waiting isn't per-server? */
449 /* Note: BKL prevents races with nfsd_svc and other lookups */
450 if (2 * threads_waiting > rqstp->rq_server->sv_nrthreads)
453 schedule_timeout(10 * HZ);
458 remove_wait_queue(&mdr->waitq, &waitq);
459 set_task_state(current, TASK_RUNNING);
465 idmap_lookup(struct svc_rqst *rqstp,
466 struct ent *(*lookup_fn)(struct ent *, int), struct ent *key,
467 struct cache_detail *detail, struct ent **item)
469 struct idmap_defer_req *mdr;
470 DECLARE_WAITQUEUE(waitq, current);
473 *item = lookup_fn(key, 0);
476 mdr = kmalloc(sizeof(*mdr), GFP_KERNEL);
477 memset(mdr, 0, sizeof(*mdr));
478 init_waitqueue_head(&mdr->waitq);
479 add_wait_queue(&mdr->waitq, &waitq);
480 atomic_set(&mdr->count, 2);
481 mdr->req.defer = idmap_defer;
482 ret = cache_check(detail, &(*item)->h, &mdr->req);
483 if (ret == -EAGAIN) {
484 ret = idmap_lookup_wait(mdr, waitq, rqstp);
487 /* Try again, but don't wait. */
488 *item = lookup_fn(key, 0);
493 if (!test_bit(CACHE_VALID, &(*item)->h.flags)) {
494 ent_put(&(*item)->h, detail);
497 ret = cache_check(detail, &(*item)->h, NULL);
504 idmap_name_to_id(struct svc_rqst *rqstp, int type, const char *name, u32 namelen,
507 struct ent *item, key = {
512 if (namelen + 1 > sizeof(key.name))
514 memcpy(key.name, name, namelen);
515 key.name[namelen] = '\0';
516 strlcpy(key.authname, rqstp->rq_client->name, sizeof(key.authname));
517 ret = idmap_lookup(rqstp, nametoid_lookup, &key, &nametoid_cache, &item);
521 ent_put(&item->h, &nametoid_cache);
526 idmap_id_to_name(struct svc_rqst *rqstp, int type, uid_t id, char *name)
528 struct ent *item, key = {
534 strlcpy(key.authname, rqstp->rq_client->name, sizeof(key.authname));
535 ret = idmap_lookup(rqstp, idtoname_lookup, &key, &idtoname_cache, &item);
538 ret = strlen(item->name);
539 BUG_ON(ret > IDMAP_NAMESZ);
540 memcpy(name, item->name, ret);
541 ent_put(&item->h, &idtoname_cache);
546 nfsd_map_name_to_uid(struct svc_rqst *rqstp, const char *name, size_t namelen,
549 return idmap_name_to_id(rqstp, IDMAP_TYPE_USER, name, namelen, id);
553 nfsd_map_name_to_gid(struct svc_rqst *rqstp, const char *name, size_t namelen,
556 return idmap_name_to_id(rqstp, IDMAP_TYPE_GROUP, name, namelen, id);
560 nfsd_map_uid_to_name(struct svc_rqst *rqstp, __u32 id, char *name)
562 return idmap_id_to_name(rqstp, IDMAP_TYPE_USER, id, name);
566 nfsd_map_gid_to_name(struct svc_rqst *rqstp, __u32 id, char *name)
568 return idmap_id_to_name(rqstp, IDMAP_TYPE_GROUP, id, name);