Loading...
1/*
2 * Mapping of UID/GIDs to name and vice versa.
3 *
4 * Copyright (c) 2002, 2003 The Regents of the University of
5 * Michigan. All rights reserved.
6 *
7 * Marius Aamodt Eriksen <marius@umich.edu>
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
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.
21 *
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.
33 */
34
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>
41#include "idmap.h"
42#include "nfsd.h"
43#include "netns.h"
44
45/*
46 * Turn off idmapping when using AUTH_SYS.
47 */
48static bool nfs4_disable_idmapping = true;
49module_param(nfs4_disable_idmapping, bool, 0644);
50MODULE_PARM_DESC(nfs4_disable_idmapping,
51 "Turn off server's NFSv4 idmapping when using 'sec=sys'");
52
53/*
54 * Cache entry
55 */
56
57/*
58 * XXX we know that IDMAP_NAMESZ < PAGE_SIZE, but it's ugly to rely on
59 * that.
60 */
61
62#define IDMAP_TYPE_USER 0
63#define IDMAP_TYPE_GROUP 1
64
65struct ent {
66 struct cache_head h;
67 int type; /* User / Group */
68 u32 id;
69 char name[IDMAP_NAMESZ];
70 char authname[IDMAP_NAMESZ];
71};
72
73/* Common entry handling */
74
75#define ENT_HASHBITS 8
76#define ENT_HASHMAX (1 << ENT_HASHBITS)
77
78static void
79ent_init(struct cache_head *cnew, struct cache_head *citm)
80{
81 struct ent *new = container_of(cnew, struct ent, h);
82 struct ent *itm = container_of(citm, struct ent, h);
83
84 new->id = itm->id;
85 new->type = itm->type;
86
87 strlcpy(new->name, itm->name, sizeof(new->name));
88 strlcpy(new->authname, itm->authname, sizeof(new->name));
89}
90
91static void
92ent_put(struct kref *ref)
93{
94 struct ent *map = container_of(ref, struct ent, h.ref);
95 kfree(map);
96}
97
98static struct cache_head *
99ent_alloc(void)
100{
101 struct ent *e = kmalloc(sizeof(*e), GFP_KERNEL);
102 if (e)
103 return &e->h;
104 else
105 return NULL;
106}
107
108/*
109 * ID -> Name cache
110 */
111
112static uint32_t
113idtoname_hash(struct ent *ent)
114{
115 uint32_t hash;
116
117 hash = hash_str(ent->authname, ENT_HASHBITS);
118 hash = hash_long(hash ^ ent->id, ENT_HASHBITS);
119
120 /* Flip LSB for user/group */
121 if (ent->type == IDMAP_TYPE_GROUP)
122 hash ^= 1;
123
124 return hash;
125}
126
127static void
128idtoname_request(struct cache_detail *cd, struct cache_head *ch, char **bpp,
129 int *blen)
130{
131 struct ent *ent = container_of(ch, struct ent, h);
132 char idstr[11];
133
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);
138
139 (*bpp)[-1] = '\n';
140}
141
142static int
143idtoname_match(struct cache_head *ca, struct cache_head *cb)
144{
145 struct ent *a = container_of(ca, struct ent, h);
146 struct ent *b = container_of(cb, struct ent, h);
147
148 return (a->id == b->id && a->type == b->type &&
149 strcmp(a->authname, b->authname) == 0);
150}
151
152static int
153idtoname_show(struct seq_file *m, struct cache_detail *cd, struct cache_head *h)
154{
155 struct ent *ent;
156
157 if (h == NULL) {
158 seq_puts(m, "#domain type id [name]\n");
159 return 0;
160 }
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",
164 ent->id);
165 if (test_bit(CACHE_VALID, &h->flags))
166 seq_printf(m, " %s", ent->name);
167 seq_printf(m, "\n");
168 return 0;
169}
170
171static void
172warn_no_idmapd(struct cache_detail *detail, int has_died)
173{
174 printk("nfsd: nfsv4 idmapping failing: has idmapd %s?\n",
175 has_died ? "died" : "not been started");
176}
177
178
179static int idtoname_parse(struct cache_detail *, char *, int);
180static struct ent *idtoname_lookup(struct cache_detail *, struct ent *);
181static struct ent *idtoname_update(struct cache_detail *, struct ent *,
182 struct ent *);
183
184static 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,
194 .init = ent_init,
195 .update = ent_init,
196 .alloc = ent_alloc,
197};
198
199static int
200idtoname_parse(struct cache_detail *cd, char *buf, int buflen)
201{
202 struct ent ent, *res;
203 char *buf1, *bp;
204 int len;
205 int error = -EINVAL;
206
207 if (buf[buflen - 1] != '\n')
208 return (-EINVAL);
209 buf[buflen - 1]= '\0';
210
211 buf1 = kmalloc(PAGE_SIZE, GFP_KERNEL);
212 if (buf1 == NULL)
213 return (-ENOMEM);
214
215 memset(&ent, 0, sizeof(ent));
216
217 /* Authentication name */
218 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
219 goto out;
220 memcpy(ent.authname, buf1, sizeof(ent.authname));
221
222 /* Type */
223 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
224 goto out;
225 ent.type = strcmp(buf1, "user") == 0 ?
226 IDMAP_TYPE_USER : IDMAP_TYPE_GROUP;
227
228 /* ID */
229 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
230 goto out;
231 ent.id = simple_strtoul(buf1, &bp, 10);
232 if (bp == buf1)
233 goto out;
234
235 /* expiry */
236 ent.h.expiry_time = get_expiry(&buf);
237 if (ent.h.expiry_time == 0)
238 goto out;
239
240 error = -ENOMEM;
241 res = idtoname_lookup(cd, &ent);
242 if (!res)
243 goto out;
244
245 /* Name */
246 error = -EINVAL;
247 len = qword_get(&buf, buf1, PAGE_SIZE);
248 if (len < 0)
249 goto out;
250 if (len == 0)
251 set_bit(CACHE_NEGATIVE, &ent.h.flags);
252 else if (len >= IDMAP_NAMESZ)
253 goto out;
254 else
255 memcpy(ent.name, buf1, sizeof(ent.name));
256 error = -ENOMEM;
257 res = idtoname_update(cd, &ent, res);
258 if (res == NULL)
259 goto out;
260
261 cache_put(&res->h, cd);
262
263 error = 0;
264out:
265 kfree(buf1);
266
267 return error;
268}
269
270
271static struct ent *
272idtoname_lookup(struct cache_detail *cd, struct ent *item)
273{
274 struct cache_head *ch = sunrpc_cache_lookup(cd, &item->h,
275 idtoname_hash(item));
276 if (ch)
277 return container_of(ch, struct ent, h);
278 else
279 return NULL;
280}
281
282static struct ent *
283idtoname_update(struct cache_detail *cd, struct ent *new, struct ent *old)
284{
285 struct cache_head *ch = sunrpc_cache_update(cd, &new->h, &old->h,
286 idtoname_hash(new));
287 if (ch)
288 return container_of(ch, struct ent, h);
289 else
290 return NULL;
291}
292
293
294/*
295 * Name -> ID cache
296 */
297
298static inline int
299nametoid_hash(struct ent *ent)
300{
301 return hash_str(ent->name, ENT_HASHBITS);
302}
303
304static void
305nametoid_request(struct cache_detail *cd, struct cache_head *ch, char **bpp,
306 int *blen)
307{
308 struct ent *ent = container_of(ch, struct ent, h);
309
310 qword_add(bpp, blen, ent->authname);
311 qword_add(bpp, blen, ent->type == IDMAP_TYPE_GROUP ? "group" : "user");
312 qword_add(bpp, blen, ent->name);
313
314 (*bpp)[-1] = '\n';
315}
316
317static int
318nametoid_match(struct cache_head *ca, struct cache_head *cb)
319{
320 struct ent *a = container_of(ca, struct ent, h);
321 struct ent *b = container_of(cb, struct ent, h);
322
323 return (a->type == b->type && strcmp(a->name, b->name) == 0 &&
324 strcmp(a->authname, b->authname) == 0);
325}
326
327static int
328nametoid_show(struct seq_file *m, struct cache_detail *cd, struct cache_head *h)
329{
330 struct ent *ent;
331
332 if (h == NULL) {
333 seq_puts(m, "#domain type name [id]\n");
334 return 0;
335 }
336 ent = container_of(h, struct ent, h);
337 seq_printf(m, "%s %s %s", ent->authname,
338 ent->type == IDMAP_TYPE_GROUP ? "group" : "user",
339 ent->name);
340 if (test_bit(CACHE_VALID, &h->flags))
341 seq_printf(m, " %u", ent->id);
342 seq_printf(m, "\n");
343 return 0;
344}
345
346static struct ent *nametoid_lookup(struct cache_detail *, struct ent *);
347static struct ent *nametoid_update(struct cache_detail *, struct ent *,
348 struct ent *);
349static int nametoid_parse(struct cache_detail *, char *, int);
350
351static struct cache_detail nametoid_cache_template = {
352 .owner = THIS_MODULE,
353 .hash_size = ENT_HASHMAX,
354 .name = "nfs4.nametoid",
355 .cache_put = ent_put,
356 .cache_request = nametoid_request,
357 .cache_parse = nametoid_parse,
358 .cache_show = nametoid_show,
359 .warn_no_listener = warn_no_idmapd,
360 .match = nametoid_match,
361 .init = ent_init,
362 .update = ent_init,
363 .alloc = ent_alloc,
364};
365
366static int
367nametoid_parse(struct cache_detail *cd, char *buf, int buflen)
368{
369 struct ent ent, *res;
370 char *buf1;
371 int error = -EINVAL;
372
373 if (buf[buflen - 1] != '\n')
374 return (-EINVAL);
375 buf[buflen - 1]= '\0';
376
377 buf1 = kmalloc(PAGE_SIZE, GFP_KERNEL);
378 if (buf1 == NULL)
379 return (-ENOMEM);
380
381 memset(&ent, 0, sizeof(ent));
382
383 /* Authentication name */
384 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
385 goto out;
386 memcpy(ent.authname, buf1, sizeof(ent.authname));
387
388 /* Type */
389 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
390 goto out;
391 ent.type = strcmp(buf1, "user") == 0 ?
392 IDMAP_TYPE_USER : IDMAP_TYPE_GROUP;
393
394 /* Name */
395 error = qword_get(&buf, buf1, PAGE_SIZE);
396 if (error <= 0 || error >= IDMAP_NAMESZ)
397 goto out;
398 memcpy(ent.name, buf1, sizeof(ent.name));
399
400 /* expiry */
401 ent.h.expiry_time = get_expiry(&buf);
402 if (ent.h.expiry_time == 0)
403 goto out;
404
405 /* ID */
406 error = get_int(&buf, &ent.id);
407 if (error == -EINVAL)
408 goto out;
409 if (error == -ENOENT)
410 set_bit(CACHE_NEGATIVE, &ent.h.flags);
411
412 error = -ENOMEM;
413 res = nametoid_lookup(cd, &ent);
414 if (res == NULL)
415 goto out;
416 res = nametoid_update(cd, &ent, res);
417 if (res == NULL)
418 goto out;
419
420 cache_put(&res->h, cd);
421 error = 0;
422out:
423 kfree(buf1);
424
425 return (error);
426}
427
428
429static struct ent *
430nametoid_lookup(struct cache_detail *cd, struct ent *item)
431{
432 struct cache_head *ch = sunrpc_cache_lookup(cd, &item->h,
433 nametoid_hash(item));
434 if (ch)
435 return container_of(ch, struct ent, h);
436 else
437 return NULL;
438}
439
440static struct ent *
441nametoid_update(struct cache_detail *cd, struct ent *new, struct ent *old)
442{
443 struct cache_head *ch = sunrpc_cache_update(cd, &new->h, &old->h,
444 nametoid_hash(new));
445 if (ch)
446 return container_of(ch, struct ent, h);
447 else
448 return NULL;
449}
450
451/*
452 * Exported API
453 */
454
455int
456nfsd_idmap_init(struct net *net)
457{
458 int rv;
459 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
460
461 nn->idtoname_cache = cache_create_net(&idtoname_cache_template, net);
462 if (IS_ERR(nn->idtoname_cache))
463 return PTR_ERR(nn->idtoname_cache);
464 rv = cache_register_net(nn->idtoname_cache, net);
465 if (rv)
466 goto destroy_idtoname_cache;
467 nn->nametoid_cache = cache_create_net(&nametoid_cache_template, net);
468 if (IS_ERR(nn->nametoid_cache)) {
469 rv = PTR_ERR(nn->nametoid_cache);
470 goto unregister_idtoname_cache;
471 }
472 rv = cache_register_net(nn->nametoid_cache, net);
473 if (rv)
474 goto destroy_nametoid_cache;
475 return 0;
476
477destroy_nametoid_cache:
478 cache_destroy_net(nn->nametoid_cache, net);
479unregister_idtoname_cache:
480 cache_unregister_net(nn->idtoname_cache, net);
481destroy_idtoname_cache:
482 cache_destroy_net(nn->idtoname_cache, net);
483 return rv;
484}
485
486void
487nfsd_idmap_shutdown(struct net *net)
488{
489 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
490
491 cache_unregister_net(nn->idtoname_cache, net);
492 cache_unregister_net(nn->nametoid_cache, net);
493 cache_destroy_net(nn->idtoname_cache, net);
494 cache_destroy_net(nn->nametoid_cache, net);
495}
496
497static int
498idmap_lookup(struct svc_rqst *rqstp,
499 struct ent *(*lookup_fn)(struct cache_detail *, struct ent *),
500 struct ent *key, struct cache_detail *detail, struct ent **item)
501{
502 int ret;
503
504 *item = lookup_fn(detail, key);
505 if (!*item)
506 return -ENOMEM;
507 retry:
508 ret = cache_check(detail, &(*item)->h, &rqstp->rq_chandle);
509
510 if (ret == -ETIMEDOUT) {
511 struct ent *prev_item = *item;
512 *item = lookup_fn(detail, key);
513 if (*item != prev_item)
514 goto retry;
515 cache_put(&(*item)->h, detail);
516 }
517 return ret;
518}
519
520static char *
521rqst_authname(struct svc_rqst *rqstp)
522{
523 struct auth_domain *clp;
524
525 clp = rqstp->rq_gssclient ? rqstp->rq_gssclient : rqstp->rq_client;
526 return clp->name;
527}
528
529static __be32
530idmap_name_to_id(struct svc_rqst *rqstp, int type, const char *name, u32 namelen,
531 u32 *id)
532{
533 struct ent *item, key = {
534 .type = type,
535 };
536 int ret;
537 struct nfsd_net *nn = net_generic(SVC_NET(rqstp), nfsd_net_id);
538
539 if (namelen + 1 > sizeof(key.name))
540 return nfserr_badowner;
541 memcpy(key.name, name, namelen);
542 key.name[namelen] = '\0';
543 strlcpy(key.authname, rqst_authname(rqstp), sizeof(key.authname));
544 ret = idmap_lookup(rqstp, nametoid_lookup, &key, nn->nametoid_cache, &item);
545 if (ret == -ENOENT)
546 return nfserr_badowner;
547 if (ret)
548 return nfserrno(ret);
549 *id = item->id;
550 cache_put(&item->h, nn->nametoid_cache);
551 return 0;
552}
553
554static __be32 encode_ascii_id(u32 id, __be32 **p, int *buflen)
555{
556 char buf[11];
557 int len;
558 int bytes;
559
560 len = sprintf(buf, "%u", id);
561 bytes = 4 + (XDR_QUADLEN(len) << 2);
562 if (bytes > *buflen)
563 return nfserr_resource;
564 *p = xdr_encode_opaque(*p, buf, len);
565 *buflen -= bytes;
566 return 0;
567}
568
569static __be32 idmap_id_to_name(struct svc_rqst *rqstp, int type, u32 id, __be32 **p, int *buflen)
570{
571 struct ent *item, key = {
572 .id = id,
573 .type = type,
574 };
575 int ret;
576 int bytes;
577 struct nfsd_net *nn = net_generic(SVC_NET(rqstp), nfsd_net_id);
578
579 strlcpy(key.authname, rqst_authname(rqstp), sizeof(key.authname));
580 ret = idmap_lookup(rqstp, idtoname_lookup, &key, nn->idtoname_cache, &item);
581 if (ret == -ENOENT)
582 return encode_ascii_id(id, p, buflen);
583 if (ret)
584 return nfserrno(ret);
585 ret = strlen(item->name);
586 WARN_ON_ONCE(ret > IDMAP_NAMESZ);
587 bytes = 4 + (XDR_QUADLEN(ret) << 2);
588 if (bytes > *buflen)
589 return nfserr_resource;
590 *p = xdr_encode_opaque(*p, item->name, ret);
591 *buflen -= bytes;
592 cache_put(&item->h, nn->idtoname_cache);
593 return 0;
594}
595
596static bool
597numeric_name_to_id(struct svc_rqst *rqstp, int type, const char *name, u32 namelen, u32 *id)
598{
599 int ret;
600 char buf[11];
601
602 if (namelen + 1 > sizeof(buf))
603 /* too long to represent a 32-bit id: */
604 return false;
605 /* Just to make sure it's null-terminated: */
606 memcpy(buf, name, namelen);
607 buf[namelen] = '\0';
608 ret = kstrtouint(buf, 10, id);
609 return ret == 0;
610}
611
612static __be32
613do_name_to_id(struct svc_rqst *rqstp, int type, const char *name, u32 namelen, u32 *id)
614{
615 if (nfs4_disable_idmapping && rqstp->rq_cred.cr_flavor < RPC_AUTH_GSS)
616 if (numeric_name_to_id(rqstp, type, name, namelen, id))
617 return 0;
618 /*
619 * otherwise, fall through and try idmapping, for
620 * backwards compatibility with clients sending names:
621 */
622 return idmap_name_to_id(rqstp, type, name, namelen, id);
623}
624
625static __be32 encode_name_from_id(struct svc_rqst *rqstp, int type, u32 id, __be32 **p, int *buflen)
626{
627 if (nfs4_disable_idmapping && rqstp->rq_cred.cr_flavor < RPC_AUTH_GSS)
628 return encode_ascii_id(id, p, buflen);
629 return idmap_id_to_name(rqstp, type, id, p, buflen);
630}
631
632__be32
633nfsd_map_name_to_uid(struct svc_rqst *rqstp, const char *name, size_t namelen,
634 kuid_t *uid)
635{
636 __be32 status;
637 u32 id = -1;
638 status = do_name_to_id(rqstp, IDMAP_TYPE_USER, name, namelen, &id);
639 *uid = make_kuid(&init_user_ns, id);
640 if (!uid_valid(*uid))
641 status = nfserr_badowner;
642 return status;
643}
644
645__be32
646nfsd_map_name_to_gid(struct svc_rqst *rqstp, const char *name, size_t namelen,
647 kgid_t *gid)
648{
649 __be32 status;
650 u32 id = -1;
651 status = do_name_to_id(rqstp, IDMAP_TYPE_GROUP, name, namelen, &id);
652 *gid = make_kgid(&init_user_ns, id);
653 if (!gid_valid(*gid))
654 status = nfserr_badowner;
655 return status;
656}
657
658__be32 nfsd4_encode_user(struct svc_rqst *rqstp, kuid_t uid, __be32 **p, int *buflen)
659{
660 u32 id = from_kuid(&init_user_ns, uid);
661 return encode_name_from_id(rqstp, IDMAP_TYPE_USER, id, p, buflen);
662}
663
664__be32 nfsd4_encode_group(struct svc_rqst *rqstp, kgid_t gid, __be32 **p, int *buflen)
665{
666 u32 id = from_kgid(&init_user_ns, gid);
667 return encode_name_from_id(rqstp, IDMAP_TYPE_GROUP, id, p, buflen);
668}
1/*
2 * Mapping of UID/GIDs to name and vice versa.
3 *
4 * Copyright (c) 2002, 2003 The Regents of the University of
5 * Michigan. All rights reserved.
6 *
7 * Marius Aamodt Eriksen <marius@umich.edu>
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
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.
21 *
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.
33 */
34
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>
41#include "idmap.h"
42#include "nfsd.h"
43#include "netns.h"
44
45/*
46 * Turn off idmapping when using AUTH_SYS.
47 */
48static bool nfs4_disable_idmapping = true;
49module_param(nfs4_disable_idmapping, bool, 0644);
50MODULE_PARM_DESC(nfs4_disable_idmapping,
51 "Turn off server's NFSv4 idmapping when using 'sec=sys'");
52
53/*
54 * Cache entry
55 */
56
57/*
58 * XXX we know that IDMAP_NAMESZ < PAGE_SIZE, but it's ugly to rely on
59 * that.
60 */
61
62struct ent {
63 struct cache_head h;
64 int type; /* User / Group */
65 u32 id;
66 char name[IDMAP_NAMESZ];
67 char authname[IDMAP_NAMESZ];
68 struct rcu_head rcu_head;
69};
70
71/* Common entry handling */
72
73#define ENT_HASHBITS 8
74#define ENT_HASHMAX (1 << ENT_HASHBITS)
75
76static void
77ent_init(struct cache_head *cnew, struct cache_head *citm)
78{
79 struct ent *new = container_of(cnew, struct ent, h);
80 struct ent *itm = container_of(citm, struct ent, h);
81
82 new->id = itm->id;
83 new->type = itm->type;
84
85 strlcpy(new->name, itm->name, sizeof(new->name));
86 strlcpy(new->authname, itm->authname, sizeof(new->authname));
87}
88
89static void
90ent_put(struct kref *ref)
91{
92 struct ent *map = container_of(ref, struct ent, h.ref);
93 kfree_rcu(map, rcu_head);
94}
95
96static struct cache_head *
97ent_alloc(void)
98{
99 struct ent *e = kmalloc(sizeof(*e), GFP_KERNEL);
100 if (e)
101 return &e->h;
102 else
103 return NULL;
104}
105
106/*
107 * ID -> Name cache
108 */
109
110static uint32_t
111idtoname_hash(struct ent *ent)
112{
113 uint32_t hash;
114
115 hash = hash_str(ent->authname, ENT_HASHBITS);
116 hash = hash_long(hash ^ ent->id, ENT_HASHBITS);
117
118 /* Flip LSB for user/group */
119 if (ent->type == IDMAP_TYPE_GROUP)
120 hash ^= 1;
121
122 return hash;
123}
124
125static void
126idtoname_request(struct cache_detail *cd, struct cache_head *ch, char **bpp,
127 int *blen)
128{
129 struct ent *ent = container_of(ch, struct ent, h);
130 char idstr[11];
131
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);
136
137 (*bpp)[-1] = '\n';
138}
139
140static int
141idtoname_match(struct cache_head *ca, struct cache_head *cb)
142{
143 struct ent *a = container_of(ca, struct ent, h);
144 struct ent *b = container_of(cb, struct ent, h);
145
146 return (a->id == b->id && a->type == b->type &&
147 strcmp(a->authname, b->authname) == 0);
148}
149
150static int
151idtoname_show(struct seq_file *m, struct cache_detail *cd, struct cache_head *h)
152{
153 struct ent *ent;
154
155 if (h == NULL) {
156 seq_puts(m, "#domain type id [name]\n");
157 return 0;
158 }
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",
162 ent->id);
163 if (test_bit(CACHE_VALID, &h->flags))
164 seq_printf(m, " %s", ent->name);
165 seq_printf(m, "\n");
166 return 0;
167}
168
169static void
170warn_no_idmapd(struct cache_detail *detail, int has_died)
171{
172 printk("nfsd: nfsv4 idmapping failing: has idmapd %s?\n",
173 has_died ? "died" : "not been started");
174}
175
176
177static int idtoname_parse(struct cache_detail *, char *, int);
178static struct ent *idtoname_lookup(struct cache_detail *, struct ent *);
179static struct ent *idtoname_update(struct cache_detail *, struct ent *,
180 struct ent *);
181
182static 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,
192 .init = ent_init,
193 .update = ent_init,
194 .alloc = ent_alloc,
195};
196
197static int
198idtoname_parse(struct cache_detail *cd, char *buf, int buflen)
199{
200 struct ent ent, *res;
201 char *buf1, *bp;
202 int len;
203 int error = -EINVAL;
204
205 if (buf[buflen - 1] != '\n')
206 return (-EINVAL);
207 buf[buflen - 1]= '\0';
208
209 buf1 = kmalloc(PAGE_SIZE, GFP_KERNEL);
210 if (buf1 == NULL)
211 return (-ENOMEM);
212
213 memset(&ent, 0, sizeof(ent));
214
215 /* Authentication name */
216 len = qword_get(&buf, buf1, PAGE_SIZE);
217 if (len <= 0 || len >= IDMAP_NAMESZ)
218 goto out;
219 memcpy(ent.authname, buf1, sizeof(ent.authname));
220
221 /* Type */
222 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
223 goto out;
224 ent.type = strcmp(buf1, "user") == 0 ?
225 IDMAP_TYPE_USER : IDMAP_TYPE_GROUP;
226
227 /* ID */
228 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
229 goto out;
230 ent.id = simple_strtoul(buf1, &bp, 10);
231 if (bp == buf1)
232 goto out;
233
234 /* expiry */
235 ent.h.expiry_time = get_expiry(&buf);
236 if (ent.h.expiry_time == 0)
237 goto out;
238
239 error = -ENOMEM;
240 res = idtoname_lookup(cd, &ent);
241 if (!res)
242 goto out;
243
244 /* Name */
245 error = -EINVAL;
246 len = qword_get(&buf, buf1, PAGE_SIZE);
247 if (len < 0 || len >= IDMAP_NAMESZ)
248 goto out;
249 if (len == 0)
250 set_bit(CACHE_NEGATIVE, &ent.h.flags);
251 else
252 memcpy(ent.name, buf1, sizeof(ent.name));
253 error = -ENOMEM;
254 res = idtoname_update(cd, &ent, res);
255 if (res == NULL)
256 goto out;
257
258 cache_put(&res->h, cd);
259 error = 0;
260out:
261 kfree(buf1);
262 return error;
263}
264
265static struct ent *
266idtoname_lookup(struct cache_detail *cd, struct ent *item)
267{
268 struct cache_head *ch = sunrpc_cache_lookup_rcu(cd, &item->h,
269 idtoname_hash(item));
270 if (ch)
271 return container_of(ch, struct ent, h);
272 else
273 return NULL;
274}
275
276static struct ent *
277idtoname_update(struct cache_detail *cd, struct ent *new, struct ent *old)
278{
279 struct cache_head *ch = sunrpc_cache_update(cd, &new->h, &old->h,
280 idtoname_hash(new));
281 if (ch)
282 return container_of(ch, struct ent, h);
283 else
284 return NULL;
285}
286
287
288/*
289 * Name -> ID cache
290 */
291
292static inline int
293nametoid_hash(struct ent *ent)
294{
295 return hash_str(ent->name, ENT_HASHBITS);
296}
297
298static void
299nametoid_request(struct cache_detail *cd, struct cache_head *ch, char **bpp,
300 int *blen)
301{
302 struct ent *ent = container_of(ch, struct ent, h);
303
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);
307
308 (*bpp)[-1] = '\n';
309}
310
311static int
312nametoid_match(struct cache_head *ca, struct cache_head *cb)
313{
314 struct ent *a = container_of(ca, struct ent, h);
315 struct ent *b = container_of(cb, struct ent, h);
316
317 return (a->type == b->type && strcmp(a->name, b->name) == 0 &&
318 strcmp(a->authname, b->authname) == 0);
319}
320
321static int
322nametoid_show(struct seq_file *m, struct cache_detail *cd, struct cache_head *h)
323{
324 struct ent *ent;
325
326 if (h == NULL) {
327 seq_puts(m, "#domain type name [id]\n");
328 return 0;
329 }
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",
333 ent->name);
334 if (test_bit(CACHE_VALID, &h->flags))
335 seq_printf(m, " %u", ent->id);
336 seq_printf(m, "\n");
337 return 0;
338}
339
340static struct ent *nametoid_lookup(struct cache_detail *, struct ent *);
341static struct ent *nametoid_update(struct cache_detail *, struct ent *,
342 struct ent *);
343static int nametoid_parse(struct cache_detail *, char *, int);
344
345static 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,
355 .init = ent_init,
356 .update = ent_init,
357 .alloc = ent_alloc,
358};
359
360static int
361nametoid_parse(struct cache_detail *cd, char *buf, int buflen)
362{
363 struct ent ent, *res;
364 char *buf1;
365 int len, error = -EINVAL;
366
367 if (buf[buflen - 1] != '\n')
368 return (-EINVAL);
369 buf[buflen - 1]= '\0';
370
371 buf1 = kmalloc(PAGE_SIZE, GFP_KERNEL);
372 if (buf1 == NULL)
373 return (-ENOMEM);
374
375 memset(&ent, 0, sizeof(ent));
376
377 /* Authentication name */
378 len = qword_get(&buf, buf1, PAGE_SIZE);
379 if (len <= 0 || len >= IDMAP_NAMESZ)
380 goto out;
381 memcpy(ent.authname, buf1, sizeof(ent.authname));
382
383 /* Type */
384 if (qword_get(&buf, buf1, PAGE_SIZE) <= 0)
385 goto out;
386 ent.type = strcmp(buf1, "user") == 0 ?
387 IDMAP_TYPE_USER : IDMAP_TYPE_GROUP;
388
389 /* Name */
390 len = qword_get(&buf, buf1, PAGE_SIZE);
391 if (len <= 0 || len >= IDMAP_NAMESZ)
392 goto out;
393 memcpy(ent.name, buf1, sizeof(ent.name));
394
395 /* expiry */
396 ent.h.expiry_time = get_expiry(&buf);
397 if (ent.h.expiry_time == 0)
398 goto out;
399
400 /* ID */
401 error = get_int(&buf, &ent.id);
402 if (error == -EINVAL)
403 goto out;
404 if (error == -ENOENT)
405 set_bit(CACHE_NEGATIVE, &ent.h.flags);
406
407 error = -ENOMEM;
408 res = nametoid_lookup(cd, &ent);
409 if (res == NULL)
410 goto out;
411 res = nametoid_update(cd, &ent, res);
412 if (res == NULL)
413 goto out;
414
415 cache_put(&res->h, cd);
416 error = 0;
417out:
418 kfree(buf1);
419 return (error);
420}
421
422
423static struct ent *
424nametoid_lookup(struct cache_detail *cd, struct ent *item)
425{
426 struct cache_head *ch = sunrpc_cache_lookup_rcu(cd, &item->h,
427 nametoid_hash(item));
428 if (ch)
429 return container_of(ch, struct ent, h);
430 else
431 return NULL;
432}
433
434static struct ent *
435nametoid_update(struct cache_detail *cd, struct ent *new, struct ent *old)
436{
437 struct cache_head *ch = sunrpc_cache_update(cd, &new->h, &old->h,
438 nametoid_hash(new));
439 if (ch)
440 return container_of(ch, struct ent, h);
441 else
442 return NULL;
443}
444
445/*
446 * Exported API
447 */
448
449int
450nfsd_idmap_init(struct net *net)
451{
452 int rv;
453 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
454
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);
459 if (rv)
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;
465 }
466 rv = cache_register_net(nn->nametoid_cache, net);
467 if (rv)
468 goto destroy_nametoid_cache;
469 return 0;
470
471destroy_nametoid_cache:
472 cache_destroy_net(nn->nametoid_cache, net);
473unregister_idtoname_cache:
474 cache_unregister_net(nn->idtoname_cache, net);
475destroy_idtoname_cache:
476 cache_destroy_net(nn->idtoname_cache, net);
477 return rv;
478}
479
480void
481nfsd_idmap_shutdown(struct net *net)
482{
483 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
484
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);
489}
490
491static int
492idmap_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)
495{
496 int ret;
497
498 *item = lookup_fn(detail, key);
499 if (!*item)
500 return -ENOMEM;
501 retry:
502 ret = cache_check(detail, &(*item)->h, &rqstp->rq_chandle);
503
504 if (ret == -ETIMEDOUT) {
505 struct ent *prev_item = *item;
506 *item = lookup_fn(detail, key);
507 if (*item != prev_item)
508 goto retry;
509 cache_put(&(*item)->h, detail);
510 }
511 return ret;
512}
513
514static char *
515rqst_authname(struct svc_rqst *rqstp)
516{
517 struct auth_domain *clp;
518
519 clp = rqstp->rq_gssclient ? rqstp->rq_gssclient : rqstp->rq_client;
520 return clp->name;
521}
522
523static __be32
524idmap_name_to_id(struct svc_rqst *rqstp, int type, const char *name, u32 namelen,
525 u32 *id)
526{
527 struct ent *item, key = {
528 .type = type,
529 };
530 int ret;
531 struct nfsd_net *nn = net_generic(SVC_NET(rqstp), nfsd_net_id);
532
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);
539 if (ret == -ENOENT)
540 return nfserr_badowner;
541 if (ret)
542 return nfserrno(ret);
543 *id = item->id;
544 cache_put(&item->h, nn->nametoid_cache);
545 return 0;
546}
547
548static __be32 encode_ascii_id(struct xdr_stream *xdr, u32 id)
549{
550 char buf[11];
551 int len;
552 __be32 *p;
553
554 len = sprintf(buf, "%u", id);
555 p = xdr_reserve_space(xdr, len + 4);
556 if (!p)
557 return nfserr_resource;
558 p = xdr_encode_opaque(p, buf, len);
559 return 0;
560}
561
562static __be32 idmap_id_to_name(struct xdr_stream *xdr,
563 struct svc_rqst *rqstp, int type, u32 id)
564{
565 struct ent *item, key = {
566 .id = id,
567 .type = type,
568 };
569 __be32 *p;
570 int ret;
571 struct nfsd_net *nn = net_generic(SVC_NET(rqstp), nfsd_net_id);
572
573 strlcpy(key.authname, rqst_authname(rqstp), sizeof(key.authname));
574 ret = idmap_lookup(rqstp, idtoname_lookup, &key, nn->idtoname_cache, &item);
575 if (ret == -ENOENT)
576 return encode_ascii_id(xdr, id);
577 if (ret)
578 return nfserrno(ret);
579 ret = strlen(item->name);
580 WARN_ON_ONCE(ret > IDMAP_NAMESZ);
581 p = xdr_reserve_space(xdr, ret + 4);
582 if (!p)
583 return nfserr_resource;
584 p = xdr_encode_opaque(p, item->name, ret);
585 cache_put(&item->h, nn->idtoname_cache);
586 return 0;
587}
588
589static bool
590numeric_name_to_id(struct svc_rqst *rqstp, int type, const char *name, u32 namelen, u32 *id)
591{
592 int ret;
593 char buf[11];
594
595 if (namelen + 1 > sizeof(buf))
596 /* too long to represent a 32-bit id: */
597 return false;
598 /* Just to make sure it's null-terminated: */
599 memcpy(buf, name, namelen);
600 buf[namelen] = '\0';
601 ret = kstrtouint(buf, 10, id);
602 return ret == 0;
603}
604
605static __be32
606do_name_to_id(struct svc_rqst *rqstp, int type, const char *name, u32 namelen, u32 *id)
607{
608 if (nfs4_disable_idmapping && rqstp->rq_cred.cr_flavor < RPC_AUTH_GSS)
609 if (numeric_name_to_id(rqstp, type, name, namelen, id))
610 return 0;
611 /*
612 * otherwise, fall through and try idmapping, for
613 * backwards compatibility with clients sending names:
614 */
615 return idmap_name_to_id(rqstp, type, name, namelen, id);
616}
617
618static __be32 encode_name_from_id(struct xdr_stream *xdr,
619 struct svc_rqst *rqstp, int type, u32 id)
620{
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);
624}
625
626__be32
627nfsd_map_name_to_uid(struct svc_rqst *rqstp, const char *name, size_t namelen,
628 kuid_t *uid)
629{
630 __be32 status;
631 u32 id = -1;
632
633 if (name == NULL || namelen == 0)
634 return nfserr_inval;
635
636 status = do_name_to_id(rqstp, IDMAP_TYPE_USER, name, namelen, &id);
637 *uid = make_kuid(nfsd_user_namespace(rqstp), id);
638 if (!uid_valid(*uid))
639 status = nfserr_badowner;
640 return status;
641}
642
643__be32
644nfsd_map_name_to_gid(struct svc_rqst *rqstp, const char *name, size_t namelen,
645 kgid_t *gid)
646{
647 __be32 status;
648 u32 id = -1;
649
650 if (name == NULL || namelen == 0)
651 return nfserr_inval;
652
653 status = do_name_to_id(rqstp, IDMAP_TYPE_GROUP, name, namelen, &id);
654 *gid = make_kgid(nfsd_user_namespace(rqstp), id);
655 if (!gid_valid(*gid))
656 status = nfserr_badowner;
657 return status;
658}
659
660__be32 nfsd4_encode_user(struct xdr_stream *xdr, struct svc_rqst *rqstp,
661 kuid_t uid)
662{
663 u32 id = from_kuid_munged(nfsd_user_namespace(rqstp), uid);
664 return encode_name_from_id(xdr, rqstp, IDMAP_TYPE_USER, id);
665}
666
667__be32 nfsd4_encode_group(struct xdr_stream *xdr, struct svc_rqst *rqstp,
668 kgid_t gid)
669{
670 u32 id = from_kgid_munged(nfsd_user_namespace(rqstp), gid);
671 return encode_name_from_id(xdr, rqstp, IDMAP_TYPE_GROUP, id);
672}