1 // SPDX-License-Identifier: GPL-2.0
3 * NFS exporting and validation.
5 * We maintain a list of clients, each of which has a list of
6 * exports. To export an fs to a given client, you first have
7 * to create the client entry with NFSCTL_ADDCLIENT, which
8 * creates a client control block and adds it to the hash
9 * table. Then, you call NFSCTL_EXPORT for each fs.
12 * Copyright (C) 1995, 1996 Olaf Kirch, <okir@monad.swb.de>
15 #include <linux/slab.h>
16 #include <linux/namei.h>
17 #include <linux/module.h>
18 #include <linux/exportfs.h>
19 #include <linux/sunrpc/svc_xprt.h>
25 #include "filecache.h"
28 #define NFSDDBG_FACILITY NFSDDBG_EXPORT
32 * One maps client+vfsmnt+dentry to export options - the export map
33 * The other maps client+filehandle-fragment to export options. - the expkey map
35 * The export options are actually stored in the first map, and the
36 * second map contains a reference to the entry in the first map.
39 #define EXPKEY_HASHBITS 8
40 #define EXPKEY_HASHMAX (1 << EXPKEY_HASHBITS)
41 #define EXPKEY_HASHMASK (EXPKEY_HASHMAX -1)
43 static void expkey_put(struct kref *ref)
45 struct svc_expkey *key = container_of(ref, struct svc_expkey, h.ref);
47 if (test_bit(CACHE_VALID, &key->h.flags) &&
48 !test_bit(CACHE_NEGATIVE, &key->h.flags))
49 path_put(&key->ek_path);
50 auth_domain_put(key->ek_client);
51 kfree_rcu(key, ek_rcu);
54 static int expkey_upcall(struct cache_detail *cd, struct cache_head *h)
56 return sunrpc_cache_pipe_upcall(cd, h);
59 static void expkey_request(struct cache_detail *cd,
61 char **bpp, int *blen)
63 /* client fsidtype \xfsid */
64 struct svc_expkey *ek = container_of(h, struct svc_expkey, h);
67 qword_add(bpp, blen, ek->ek_client->name);
68 snprintf(type, 5, "%d", ek->ek_fsidtype);
69 qword_add(bpp, blen, type);
70 qword_addhex(bpp, blen, (char*)ek->ek_fsid, key_len(ek->ek_fsidtype));
74 static struct svc_expkey *svc_expkey_update(struct cache_detail *cd, struct svc_expkey *new,
75 struct svc_expkey *old);
76 static struct svc_expkey *svc_expkey_lookup(struct cache_detail *cd, struct svc_expkey *);
78 static int expkey_parse(struct cache_detail *cd, char *mesg, int mlen)
80 /* client fsidtype fsid expiry [path] */
83 struct auth_domain *dom = NULL;
87 struct svc_expkey key;
88 struct svc_expkey *ek = NULL;
90 if (mesg[mlen - 1] != '\n')
94 buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
100 if (qword_get(&mesg, buf, PAGE_SIZE) <= 0)
104 dom = auth_domain_find(buf);
107 dprintk("found domain %s\n", buf);
110 if (qword_get(&mesg, buf, PAGE_SIZE) <= 0)
112 fsidtype = simple_strtoul(buf, &ep, 10);
115 dprintk("found fsidtype %d\n", fsidtype);
116 if (key_len(fsidtype)==0) /* invalid type */
118 if ((len=qword_get(&mesg, buf, PAGE_SIZE)) <= 0)
120 dprintk("found fsid length %d\n", len);
121 if (len != key_len(fsidtype))
124 /* OK, we seem to have a valid key */
126 err = get_expiry(&mesg, &key.h.expiry_time);
131 key.ek_fsidtype = fsidtype;
132 memcpy(key.ek_fsid, buf, len);
134 ek = svc_expkey_lookup(cd, &key);
139 /* now we want a pathname, or empty meaning NEGATIVE */
141 len = qword_get(&mesg, buf, PAGE_SIZE);
144 dprintk("Path seems to be <%s>\n", buf);
147 set_bit(CACHE_NEGATIVE, &key.h.flags);
148 ek = svc_expkey_update(cd, &key, ek);
150 trace_nfsd_expkey_update(ek, NULL);
154 err = kern_path(buf, 0, &key.ek_path);
158 dprintk("Found the path %s\n", buf);
160 ek = svc_expkey_update(cd, &key, ek);
162 trace_nfsd_expkey_update(ek, buf);
165 path_put(&key.ek_path);
170 cache_put(&ek->h, cd);
172 auth_domain_put(dom);
177 static int expkey_show(struct seq_file *m,
178 struct cache_detail *cd,
179 struct cache_head *h)
181 struct svc_expkey *ek ;
185 seq_puts(m, "#domain fsidtype fsid [path]\n");
188 ek = container_of(h, struct svc_expkey, h);
189 seq_printf(m, "%s %d 0x", ek->ek_client->name,
191 for (i=0; i < key_len(ek->ek_fsidtype)/4; i++)
192 seq_printf(m, "%08x", ek->ek_fsid[i]);
193 if (test_bit(CACHE_VALID, &h->flags) &&
194 !test_bit(CACHE_NEGATIVE, &h->flags)) {
196 seq_path(m, &ek->ek_path, "\\ \t\n");
202 static inline int expkey_match (struct cache_head *a, struct cache_head *b)
204 struct svc_expkey *orig = container_of(a, struct svc_expkey, h);
205 struct svc_expkey *new = container_of(b, struct svc_expkey, h);
207 if (orig->ek_fsidtype != new->ek_fsidtype ||
208 orig->ek_client != new->ek_client ||
209 memcmp(orig->ek_fsid, new->ek_fsid, key_len(orig->ek_fsidtype)) != 0)
214 static inline void expkey_init(struct cache_head *cnew,
215 struct cache_head *citem)
217 struct svc_expkey *new = container_of(cnew, struct svc_expkey, h);
218 struct svc_expkey *item = container_of(citem, struct svc_expkey, h);
220 kref_get(&item->ek_client->ref);
221 new->ek_client = item->ek_client;
222 new->ek_fsidtype = item->ek_fsidtype;
224 memcpy(new->ek_fsid, item->ek_fsid, sizeof(new->ek_fsid));
227 static inline void expkey_update(struct cache_head *cnew,
228 struct cache_head *citem)
230 struct svc_expkey *new = container_of(cnew, struct svc_expkey, h);
231 struct svc_expkey *item = container_of(citem, struct svc_expkey, h);
233 new->ek_path = item->ek_path;
234 path_get(&item->ek_path);
237 static struct cache_head *expkey_alloc(void)
239 struct svc_expkey *i = kmalloc(sizeof(*i), GFP_KERNEL);
246 static void expkey_flush(void)
249 * Take the nfsd_mutex here to ensure that the file cache is not
250 * destroyed while we're in the middle of flushing.
252 mutex_lock(&nfsd_mutex);
253 nfsd_file_cache_purge(current->nsproxy->net_ns);
254 mutex_unlock(&nfsd_mutex);
257 static const struct cache_detail svc_expkey_cache_template = {
258 .owner = THIS_MODULE,
259 .hash_size = EXPKEY_HASHMAX,
261 .cache_put = expkey_put,
262 .cache_upcall = expkey_upcall,
263 .cache_request = expkey_request,
264 .cache_parse = expkey_parse,
265 .cache_show = expkey_show,
266 .match = expkey_match,
268 .update = expkey_update,
269 .alloc = expkey_alloc,
270 .flush = expkey_flush,
274 svc_expkey_hash(struct svc_expkey *item)
276 int hash = item->ek_fsidtype;
277 char * cp = (char*)item->ek_fsid;
278 int len = key_len(item->ek_fsidtype);
280 hash ^= hash_mem(cp, len, EXPKEY_HASHBITS);
281 hash ^= hash_ptr(item->ek_client, EXPKEY_HASHBITS);
282 hash &= EXPKEY_HASHMASK;
286 static struct svc_expkey *
287 svc_expkey_lookup(struct cache_detail *cd, struct svc_expkey *item)
289 struct cache_head *ch;
290 int hash = svc_expkey_hash(item);
292 ch = sunrpc_cache_lookup_rcu(cd, &item->h, hash);
294 return container_of(ch, struct svc_expkey, h);
299 static struct svc_expkey *
300 svc_expkey_update(struct cache_detail *cd, struct svc_expkey *new,
301 struct svc_expkey *old)
303 struct cache_head *ch;
304 int hash = svc_expkey_hash(new);
306 ch = sunrpc_cache_update(cd, &new->h, &old->h, hash);
308 return container_of(ch, struct svc_expkey, h);
314 #define EXPORT_HASHBITS 8
315 #define EXPORT_HASHMAX (1<< EXPORT_HASHBITS)
317 static void nfsd4_fslocs_free(struct nfsd4_fs_locations *fsloc)
319 struct nfsd4_fs_location *locations = fsloc->locations;
325 for (i = 0; i < fsloc->locations_count; i++) {
326 kfree(locations[i].path);
327 kfree(locations[i].hosts);
331 fsloc->locations = NULL;
334 static int export_stats_init(struct export_stats *stats)
336 stats->start_time = ktime_get_seconds();
337 return nfsd_percpu_counters_init(stats->counter, EXP_STATS_COUNTERS_NUM);
340 static void export_stats_reset(struct export_stats *stats)
342 nfsd_percpu_counters_reset(stats->counter, EXP_STATS_COUNTERS_NUM);
345 static void export_stats_destroy(struct export_stats *stats)
347 nfsd_percpu_counters_destroy(stats->counter, EXP_STATS_COUNTERS_NUM);
350 static void svc_export_put(struct kref *ref)
352 struct svc_export *exp = container_of(ref, struct svc_export, h.ref);
353 path_put(&exp->ex_path);
354 auth_domain_put(exp->ex_client);
355 nfsd4_fslocs_free(&exp->ex_fslocs);
356 export_stats_destroy(&exp->ex_stats);
358 kfree_rcu(exp, ex_rcu);
361 static int svc_export_upcall(struct cache_detail *cd, struct cache_head *h)
363 return sunrpc_cache_pipe_upcall(cd, h);
366 static void svc_export_request(struct cache_detail *cd,
367 struct cache_head *h,
368 char **bpp, int *blen)
371 struct svc_export *exp = container_of(h, struct svc_export, h);
374 qword_add(bpp, blen, exp->ex_client->name);
375 pth = d_path(&exp->ex_path, *bpp, *blen);
377 /* is this correct? */
381 qword_add(bpp, blen, pth);
385 static struct svc_export *svc_export_update(struct svc_export *new,
386 struct svc_export *old);
387 static struct svc_export *svc_export_lookup(struct svc_export *);
389 static int check_export(struct path *path, int *flags, unsigned char *uuid)
391 struct inode *inode = d_inode(path->dentry);
394 * We currently export only dirs, regular files, and (for v4
395 * pseudoroot) symlinks.
397 if (!S_ISDIR(inode->i_mode) &&
398 !S_ISLNK(inode->i_mode) &&
399 !S_ISREG(inode->i_mode))
403 * Mountd should never pass down a writeable V4ROOT export, but,
406 if (*flags & NFSEXP_V4ROOT)
407 *flags |= NFSEXP_READONLY;
409 /* There are two requirements on a filesystem to be exportable.
410 * 1: We must be able to identify the filesystem from a number.
411 * either a device number (so FS_REQUIRES_DEV needed)
412 * or an FSID number (so NFSEXP_FSID or ->uuid is needed).
413 * 2: We must be able to find an inode from a filehandle.
414 * This means that s_export_op must be set.
415 * 3: We must not currently be on an idmapped mount.
417 if (!(inode->i_sb->s_type->fs_flags & FS_REQUIRES_DEV) &&
418 !(*flags & NFSEXP_FSID) &&
420 dprintk("exp_export: export of non-dev fs without fsid\n");
424 if (!inode->i_sb->s_export_op ||
425 !inode->i_sb->s_export_op->fh_to_dentry) {
426 dprintk("exp_export: export of invalid fs type.\n");
430 if (is_idmapped_mnt(path->mnt)) {
431 dprintk("exp_export: export of idmapped mounts not yet supported.\n");
435 if (inode->i_sb->s_export_op->flags & EXPORT_OP_NOSUBTREECHK &&
436 !(*flags & NFSEXP_NOSUBTREECHECK)) {
437 dprintk("%s: %s does not support subtree checking!\n",
438 __func__, inode->i_sb->s_type->name);
444 #ifdef CONFIG_NFSD_V4
447 fsloc_parse(char **mesg, char *buf, struct nfsd4_fs_locations *fsloc)
450 int migrated, i, err;
452 /* more than one fsloc */
453 if (fsloc->locations)
457 err = get_uint(mesg, &fsloc->locations_count);
460 if (fsloc->locations_count > MAX_FS_LOCATIONS)
462 if (fsloc->locations_count == 0)
465 fsloc->locations = kcalloc(fsloc->locations_count,
466 sizeof(struct nfsd4_fs_location),
468 if (!fsloc->locations)
470 for (i=0; i < fsloc->locations_count; i++) {
471 /* colon separated host list */
473 len = qword_get(mesg, buf, PAGE_SIZE);
477 fsloc->locations[i].hosts = kstrdup(buf, GFP_KERNEL);
478 if (!fsloc->locations[i].hosts)
481 /* slash separated path component list */
482 len = qword_get(mesg, buf, PAGE_SIZE);
486 fsloc->locations[i].path = kstrdup(buf, GFP_KERNEL);
487 if (!fsloc->locations[i].path)
491 err = get_int(mesg, &migrated);
495 if (migrated < 0 || migrated > 1)
497 fsloc->migrated = migrated;
500 nfsd4_fslocs_free(fsloc);
504 static int secinfo_parse(char **mesg, char *buf, struct svc_export *exp)
506 struct exp_flavor_info *f;
510 /* more than one secinfo */
511 if (exp->ex_nflavors)
514 err = get_uint(mesg, &listsize);
517 if (listsize > MAX_SECINFO_LIST)
520 for (f = exp->ex_flavors; f < exp->ex_flavors + listsize; f++) {
521 err = get_uint(mesg, &f->pseudoflavor);
525 * XXX: It would be nice to also check whether this
526 * pseudoflavor is supported, so we can discover the
527 * problem at export time instead of when a client fails
530 err = get_uint(mesg, &f->flags);
533 /* Only some flags are allowed to differ between flavors: */
534 if (~NFSEXP_SECINFO_FLAGS & (f->flags ^ exp->ex_flags))
537 exp->ex_nflavors = listsize;
541 #else /* CONFIG_NFSD_V4 */
543 fsloc_parse(char **mesg, char *buf, struct nfsd4_fs_locations *fsloc){return 0;}
545 secinfo_parse(char **mesg, char *buf, struct svc_export *exp) { return 0; }
548 static int xprtsec_parse(char **mesg, char *buf, struct svc_export *exp)
550 unsigned int i, mode, listsize;
553 err = get_uint(mesg, &listsize);
556 if (listsize > NFSEXP_XPRTSEC_NUM)
559 exp->ex_xprtsec_modes = 0;
560 for (i = 0; i < listsize; i++) {
561 err = get_uint(mesg, &mode);
564 if (mode > NFSEXP_XPRTSEC_MTLS)
566 exp->ex_xprtsec_modes |= mode;
572 nfsd_uuid_parse(char **mesg, char *buf, unsigned char **puuid)
576 /* more than one uuid */
580 /* expect a 16 byte uuid encoded as \xXXXX... */
581 len = qword_get(mesg, buf, PAGE_SIZE);
582 if (len != EX_UUID_LEN)
585 *puuid = kmemdup(buf, EX_UUID_LEN, GFP_KERNEL);
592 static int svc_export_parse(struct cache_detail *cd, char *mesg, int mlen)
594 /* client path expiry [flags anonuid anongid fsid] */
597 struct auth_domain *dom = NULL;
598 struct svc_export exp = {}, *expp;
601 if (mesg[mlen-1] != '\n')
605 buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
611 if (qword_get(&mesg, buf, PAGE_SIZE) <= 0)
615 dom = auth_domain_find(buf);
621 if (qword_get(&mesg, buf, PAGE_SIZE) <= 0)
624 err = kern_path(buf, 0, &exp.ex_path);
630 exp.ex_devid_map = NULL;
631 exp.ex_xprtsec_modes = NFSEXP_XPRTSEC_ALL;
634 err = get_expiry(&mesg, &exp.h.expiry_time);
639 err = get_int(&mesg, &an_int);
640 if (err == -ENOENT) {
642 set_bit(CACHE_NEGATIVE, &exp.h.flags);
644 if (err || an_int < 0)
646 exp.ex_flags= an_int;
649 err = get_int(&mesg, &an_int);
652 exp.ex_anon_uid= make_kuid(current_user_ns(), an_int);
655 err = get_int(&mesg, &an_int);
658 exp.ex_anon_gid= make_kgid(current_user_ns(), an_int);
661 err = get_int(&mesg, &an_int);
664 exp.ex_fsid = an_int;
666 while (qword_get(&mesg, buf, PAGE_SIZE) > 0) {
667 if (strcmp(buf, "fsloc") == 0)
668 err = fsloc_parse(&mesg, buf, &exp.ex_fslocs);
669 else if (strcmp(buf, "uuid") == 0)
670 err = nfsd_uuid_parse(&mesg, buf, &exp.ex_uuid);
671 else if (strcmp(buf, "secinfo") == 0)
672 err = secinfo_parse(&mesg, buf, &exp);
673 else if (strcmp(buf, "xprtsec") == 0)
674 err = xprtsec_parse(&mesg, buf, &exp);
676 /* quietly ignore unknown words and anything
677 * following. Newer user-space can try to set
678 * new values, then see what the result was.
685 err = check_export(&exp.ex_path, &exp.ex_flags, exp.ex_uuid);
690 * No point caching this if it would immediately expire.
691 * Also, this protects exportfs's dummy export from the
692 * anon_uid/anon_gid checks:
694 if (exp.h.expiry_time < seconds_since_boot())
697 * For some reason exportfs has been passing down an
698 * invalid (-1) uid & gid on the "dummy" export which it
699 * uses to test export support. To make sure exportfs
700 * sees errors from check_export we therefore need to
701 * delay these checks till after check_export:
704 if (!uid_valid(exp.ex_anon_uid))
706 if (!gid_valid(exp.ex_anon_gid))
710 nfsd4_setup_layout_type(&exp);
713 expp = svc_export_lookup(&exp);
718 expp = svc_export_update(&exp, expp);
720 trace_nfsd_export_update(expp);
726 nfsd4_fslocs_free(&exp.ex_fslocs);
729 path_put(&exp.ex_path);
731 auth_domain_put(dom);
737 static void exp_flags(struct seq_file *m, int flag, int fsid,
738 kuid_t anonu, kgid_t anong, struct nfsd4_fs_locations *fslocs);
739 static void show_secinfo(struct seq_file *m, struct svc_export *exp);
741 static int is_export_stats_file(struct seq_file *m)
744 * The export_stats file uses the same ops as the exports file.
745 * We use the file's name to determine the reported info per export.
746 * There is no rename in nsfdfs, so d_name.name is stable.
748 return !strcmp(m->file->f_path.dentry->d_name.name, "export_stats");
751 static int svc_export_show(struct seq_file *m,
752 struct cache_detail *cd,
753 struct cache_head *h)
755 struct svc_export *exp;
756 bool export_stats = is_export_stats_file(m);
760 seq_puts(m, "#path domain start-time\n#\tstats\n");
762 seq_puts(m, "#path domain(flags)\n");
765 exp = container_of(h, struct svc_export, h);
766 seq_path(m, &exp->ex_path, " \t\n\\");
768 seq_escape(m, exp->ex_client->name, " \t\n\\");
770 seq_printf(m, "\t%lld\n", exp->ex_stats.start_time);
771 seq_printf(m, "\tfh_stale: %lld\n",
772 percpu_counter_sum_positive(&exp->ex_stats.counter[EXP_STATS_FH_STALE]));
773 seq_printf(m, "\tio_read: %lld\n",
774 percpu_counter_sum_positive(&exp->ex_stats.counter[EXP_STATS_IO_READ]));
775 seq_printf(m, "\tio_write: %lld\n",
776 percpu_counter_sum_positive(&exp->ex_stats.counter[EXP_STATS_IO_WRITE]));
781 if (test_bit(CACHE_VALID, &h->flags) &&
782 !test_bit(CACHE_NEGATIVE, &h->flags)) {
783 exp_flags(m, exp->ex_flags, exp->ex_fsid,
784 exp->ex_anon_uid, exp->ex_anon_gid, &exp->ex_fslocs);
787 seq_puts(m, ",uuid=");
788 for (i = 0; i < EX_UUID_LEN; i++) {
791 seq_printf(m, "%02x", exp->ex_uuid[i]);
794 show_secinfo(m, exp);
799 static int svc_export_match(struct cache_head *a, struct cache_head *b)
801 struct svc_export *orig = container_of(a, struct svc_export, h);
802 struct svc_export *new = container_of(b, struct svc_export, h);
803 return orig->ex_client == new->ex_client &&
804 path_equal(&orig->ex_path, &new->ex_path);
807 static void svc_export_init(struct cache_head *cnew, struct cache_head *citem)
809 struct svc_export *new = container_of(cnew, struct svc_export, h);
810 struct svc_export *item = container_of(citem, struct svc_export, h);
812 kref_get(&item->ex_client->ref);
813 new->ex_client = item->ex_client;
814 new->ex_path = item->ex_path;
815 path_get(&item->ex_path);
816 new->ex_fslocs.locations = NULL;
817 new->ex_fslocs.locations_count = 0;
818 new->ex_fslocs.migrated = 0;
819 new->ex_layout_types = 0;
822 export_stats_reset(&new->ex_stats);
825 static void export_update(struct cache_head *cnew, struct cache_head *citem)
827 struct svc_export *new = container_of(cnew, struct svc_export, h);
828 struct svc_export *item = container_of(citem, struct svc_export, h);
831 new->ex_flags = item->ex_flags;
832 new->ex_anon_uid = item->ex_anon_uid;
833 new->ex_anon_gid = item->ex_anon_gid;
834 new->ex_fsid = item->ex_fsid;
835 new->ex_devid_map = item->ex_devid_map;
836 item->ex_devid_map = NULL;
837 new->ex_uuid = item->ex_uuid;
838 item->ex_uuid = NULL;
839 new->ex_fslocs.locations = item->ex_fslocs.locations;
840 item->ex_fslocs.locations = NULL;
841 new->ex_fslocs.locations_count = item->ex_fslocs.locations_count;
842 item->ex_fslocs.locations_count = 0;
843 new->ex_fslocs.migrated = item->ex_fslocs.migrated;
844 item->ex_fslocs.migrated = 0;
845 new->ex_layout_types = item->ex_layout_types;
846 new->ex_nflavors = item->ex_nflavors;
847 for (i = 0; i < MAX_SECINFO_LIST; i++) {
848 new->ex_flavors[i] = item->ex_flavors[i];
850 new->ex_xprtsec_modes = item->ex_xprtsec_modes;
853 static struct cache_head *svc_export_alloc(void)
855 struct svc_export *i = kmalloc(sizeof(*i), GFP_KERNEL);
859 if (export_stats_init(&i->ex_stats)) {
867 static const struct cache_detail svc_export_cache_template = {
868 .owner = THIS_MODULE,
869 .hash_size = EXPORT_HASHMAX,
870 .name = "nfsd.export",
871 .cache_put = svc_export_put,
872 .cache_upcall = svc_export_upcall,
873 .cache_request = svc_export_request,
874 .cache_parse = svc_export_parse,
875 .cache_show = svc_export_show,
876 .match = svc_export_match,
877 .init = svc_export_init,
878 .update = export_update,
879 .alloc = svc_export_alloc,
883 svc_export_hash(struct svc_export *exp)
887 hash = hash_ptr(exp->ex_client, EXPORT_HASHBITS);
888 hash ^= hash_ptr(exp->ex_path.dentry, EXPORT_HASHBITS);
889 hash ^= hash_ptr(exp->ex_path.mnt, EXPORT_HASHBITS);
893 static struct svc_export *
894 svc_export_lookup(struct svc_export *exp)
896 struct cache_head *ch;
897 int hash = svc_export_hash(exp);
899 ch = sunrpc_cache_lookup_rcu(exp->cd, &exp->h, hash);
901 return container_of(ch, struct svc_export, h);
906 static struct svc_export *
907 svc_export_update(struct svc_export *new, struct svc_export *old)
909 struct cache_head *ch;
910 int hash = svc_export_hash(old);
912 ch = sunrpc_cache_update(old->cd, &new->h, &old->h, hash);
914 return container_of(ch, struct svc_export, h);
920 static struct svc_expkey *
921 exp_find_key(struct cache_detail *cd, struct auth_domain *clp, int fsid_type,
922 u32 *fsidv, struct cache_req *reqp)
924 struct svc_expkey key, *ek;
928 return ERR_PTR(-ENOENT);
931 key.ek_fsidtype = fsid_type;
932 memcpy(key.ek_fsid, fsidv, key_len(fsid_type));
934 ek = svc_expkey_lookup(cd, &key);
936 return ERR_PTR(-ENOMEM);
937 err = cache_check(cd, &ek->h, reqp);
939 trace_nfsd_exp_find_key(&key, err);
945 static struct svc_export *
946 exp_get_by_name(struct cache_detail *cd, struct auth_domain *clp,
947 const struct path *path, struct cache_req *reqp)
949 struct svc_export *exp, key;
953 return ERR_PTR(-ENOENT);
959 exp = svc_export_lookup(&key);
961 return ERR_PTR(-ENOMEM);
962 err = cache_check(cd, &exp->h, reqp);
964 trace_nfsd_exp_get_by_name(&key, err);
971 * Find the export entry for a given dentry.
973 static struct svc_export *
974 exp_parent(struct cache_detail *cd, struct auth_domain *clp, struct path *path)
976 struct dentry *saved = dget(path->dentry);
977 struct svc_export *exp = exp_get_by_name(cd, clp, path, NULL);
979 while (PTR_ERR(exp) == -ENOENT && !IS_ROOT(path->dentry)) {
980 struct dentry *parent = dget_parent(path->dentry);
982 path->dentry = parent;
983 exp = exp_get_by_name(cd, clp, path, NULL);
986 path->dentry = saved;
993 * Obtain the root fh on behalf of a client.
994 * This could be done in user space, but I feel that it adds some safety
995 * since its harder to fool a kernel module than a user space program.
998 exp_rootfh(struct net *net, struct auth_domain *clp, char *name,
999 struct knfsd_fh *f, int maxsize)
1001 struct svc_export *exp;
1003 struct inode *inode;
1006 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1007 struct cache_detail *cd = nn->svc_export_cache;
1010 /* NB: we probably ought to check that it's NUL-terminated */
1011 if (kern_path(name, 0, &path)) {
1012 printk("nfsd: exp_rootfh path not found %s", name);
1015 inode = d_inode(path.dentry);
1017 dprintk("nfsd: exp_rootfh(%s [%p] %s:%s/%ld)\n",
1018 name, path.dentry, clp->name,
1019 inode->i_sb->s_id, inode->i_ino);
1020 exp = exp_parent(cd, clp, &path);
1027 * fh must be initialized before calling fh_compose
1029 fh_init(&fh, maxsize);
1030 if (fh_compose(&fh, exp, path.dentry, NULL))
1034 memcpy(f, &fh.fh_handle, sizeof(struct knfsd_fh));
1042 static struct svc_export *exp_find(struct cache_detail *cd,
1043 struct auth_domain *clp, int fsid_type,
1044 u32 *fsidv, struct cache_req *reqp)
1046 struct svc_export *exp;
1047 struct nfsd_net *nn = net_generic(cd->net, nfsd_net_id);
1048 struct svc_expkey *ek = exp_find_key(nn->svc_expkey_cache, clp, fsid_type, fsidv, reqp);
1050 return ERR_CAST(ek);
1052 exp = exp_get_by_name(cd, clp, &ek->ek_path, reqp);
1053 cache_put(&ek->h, nn->svc_expkey_cache);
1056 return ERR_CAST(exp);
1060 __be32 check_nfsd_access(struct svc_export *exp, struct svc_rqst *rqstp)
1062 struct exp_flavor_info *f, *end = exp->ex_flavors + exp->ex_nflavors;
1063 struct svc_xprt *xprt = rqstp->rq_xprt;
1065 if (exp->ex_xprtsec_modes & NFSEXP_XPRTSEC_NONE) {
1066 if (!test_bit(XPT_TLS_SESSION, &xprt->xpt_flags))
1069 if (exp->ex_xprtsec_modes & NFSEXP_XPRTSEC_TLS) {
1070 if (test_bit(XPT_TLS_SESSION, &xprt->xpt_flags) &&
1071 !test_bit(XPT_PEER_AUTH, &xprt->xpt_flags))
1074 if (exp->ex_xprtsec_modes & NFSEXP_XPRTSEC_MTLS) {
1075 if (test_bit(XPT_TLS_SESSION, &xprt->xpt_flags) &&
1076 test_bit(XPT_PEER_AUTH, &xprt->xpt_flags))
1082 /* legacy gss-only clients are always OK: */
1083 if (exp->ex_client == rqstp->rq_gssclient)
1085 /* ip-address based client; check sec= export option: */
1086 for (f = exp->ex_flavors; f < end; f++) {
1087 if (f->pseudoflavor == rqstp->rq_cred.cr_flavor)
1090 /* defaults in absence of sec= options: */
1091 if (exp->ex_nflavors == 0) {
1092 if (rqstp->rq_cred.cr_flavor == RPC_AUTH_NULL ||
1093 rqstp->rq_cred.cr_flavor == RPC_AUTH_UNIX)
1097 /* If the compound op contains a spo_must_allowed op,
1098 * it will be sent with integrity/protection which
1099 * will have to be expressly allowed on mounts that
1103 if (nfsd4_spo_must_allow(rqstp))
1107 return rqstp->rq_vers < 4 ? nfserr_acces : nfserr_wrongsec;
1111 * Uses rq_client and rq_gssclient to find an export; uses rq_client (an
1112 * auth_unix client) if it's available and has secinfo information;
1113 * otherwise, will try to use rq_gssclient.
1115 * Called from functions that handle requests; functions that do work on
1116 * behalf of mountd are passed a single client name to use, and should
1117 * use exp_get_by_name() or exp_find().
1120 rqst_exp_get_by_name(struct svc_rqst *rqstp, struct path *path)
1122 struct svc_export *gssexp, *exp = ERR_PTR(-ENOENT);
1123 struct nfsd_net *nn = net_generic(SVC_NET(rqstp), nfsd_net_id);
1124 struct cache_detail *cd = nn->svc_export_cache;
1126 if (rqstp->rq_client == NULL)
1129 /* First try the auth_unix client: */
1130 exp = exp_get_by_name(cd, rqstp->rq_client, path, &rqstp->rq_chandle);
1131 if (PTR_ERR(exp) == -ENOENT)
1135 /* If it has secinfo, assume there are no gss/... clients */
1136 if (exp->ex_nflavors > 0)
1139 /* Otherwise, try falling back on gss client */
1140 if (rqstp->rq_gssclient == NULL)
1142 gssexp = exp_get_by_name(cd, rqstp->rq_gssclient, path, &rqstp->rq_chandle);
1143 if (PTR_ERR(gssexp) == -ENOENT)
1151 rqst_exp_find(struct svc_rqst *rqstp, int fsid_type, u32 *fsidv)
1153 struct svc_export *gssexp, *exp = ERR_PTR(-ENOENT);
1154 struct nfsd_net *nn = net_generic(SVC_NET(rqstp), nfsd_net_id);
1155 struct cache_detail *cd = nn->svc_export_cache;
1157 if (rqstp->rq_client == NULL)
1160 /* First try the auth_unix client: */
1161 exp = exp_find(cd, rqstp->rq_client, fsid_type,
1162 fsidv, &rqstp->rq_chandle);
1163 if (PTR_ERR(exp) == -ENOENT)
1167 /* If it has secinfo, assume there are no gss/... clients */
1168 if (exp->ex_nflavors > 0)
1171 /* Otherwise, try falling back on gss client */
1172 if (rqstp->rq_gssclient == NULL)
1174 gssexp = exp_find(cd, rqstp->rq_gssclient, fsid_type, fsidv,
1175 &rqstp->rq_chandle);
1176 if (PTR_ERR(gssexp) == -ENOENT)
1184 rqst_exp_parent(struct svc_rqst *rqstp, struct path *path)
1186 struct dentry *saved = dget(path->dentry);
1187 struct svc_export *exp = rqst_exp_get_by_name(rqstp, path);
1189 while (PTR_ERR(exp) == -ENOENT && !IS_ROOT(path->dentry)) {
1190 struct dentry *parent = dget_parent(path->dentry);
1192 path->dentry = parent;
1193 exp = rqst_exp_get_by_name(rqstp, path);
1196 path->dentry = saved;
1200 struct svc_export *rqst_find_fsidzero_export(struct svc_rqst *rqstp)
1204 mk_fsid(FSID_NUM, fsidv, 0, 0, 0, NULL);
1206 return rqst_exp_find(rqstp, FSID_NUM, fsidv);
1210 * Called when we need the filehandle for the root of the pseudofs,
1211 * for a given NFSv4 client. The root is defined to be the
1212 * export point with fsid==0
1215 exp_pseudoroot(struct svc_rqst *rqstp, struct svc_fh *fhp)
1217 struct svc_export *exp;
1220 exp = rqst_find_fsidzero_export(rqstp);
1222 return nfserrno(PTR_ERR(exp));
1223 rv = fh_compose(fhp, exp, exp->ex_path.dentry, NULL);
1228 static struct flags {
1232 { NFSEXP_READONLY, {"ro", "rw"}},
1233 { NFSEXP_INSECURE_PORT, {"insecure", ""}},
1234 { NFSEXP_ROOTSQUASH, {"root_squash", "no_root_squash"}},
1235 { NFSEXP_ALLSQUASH, {"all_squash", ""}},
1236 { NFSEXP_ASYNC, {"async", "sync"}},
1237 { NFSEXP_GATHERED_WRITES, {"wdelay", "no_wdelay"}},
1238 { NFSEXP_NOREADDIRPLUS, {"nordirplus", ""}},
1239 { NFSEXP_NOHIDE, {"nohide", ""}},
1240 { NFSEXP_CROSSMOUNT, {"crossmnt", ""}},
1241 { NFSEXP_NOSUBTREECHECK, {"no_subtree_check", ""}},
1242 { NFSEXP_NOAUTHNLM, {"insecure_locks", ""}},
1243 { NFSEXP_V4ROOT, {"v4root", ""}},
1244 { NFSEXP_PNFS, {"pnfs", ""}},
1245 { NFSEXP_SECURITY_LABEL, {"security_label", ""}},
1249 static void show_expflags(struct seq_file *m, int flags, int mask)
1252 int state, first = 0;
1254 for (flg = expflags; flg->flag; flg++) {
1255 if (flg->flag & ~mask)
1257 state = (flg->flag & flags) ? 0 : 1;
1258 if (*flg->name[state])
1259 seq_printf(m, "%s%s", first++?",":"", flg->name[state]);
1263 static void show_secinfo_flags(struct seq_file *m, int flags)
1266 show_expflags(m, flags, NFSEXP_SECINFO_FLAGS);
1269 static bool secinfo_flags_equal(int f, int g)
1271 f &= NFSEXP_SECINFO_FLAGS;
1272 g &= NFSEXP_SECINFO_FLAGS;
1276 static int show_secinfo_run(struct seq_file *m, struct exp_flavor_info **fp, struct exp_flavor_info *end)
1280 flags = (*fp)->flags;
1281 seq_printf(m, ",sec=%d", (*fp)->pseudoflavor);
1283 while (*fp != end && secinfo_flags_equal(flags, (*fp)->flags)) {
1284 seq_printf(m, ":%d", (*fp)->pseudoflavor);
1290 static void show_secinfo(struct seq_file *m, struct svc_export *exp)
1292 struct exp_flavor_info *f;
1293 struct exp_flavor_info *end = exp->ex_flavors + exp->ex_nflavors;
1296 if (exp->ex_nflavors == 0)
1298 f = exp->ex_flavors;
1299 flags = show_secinfo_run(m, &f, end);
1300 if (!secinfo_flags_equal(flags, exp->ex_flags))
1301 show_secinfo_flags(m, flags);
1303 flags = show_secinfo_run(m, &f, end);
1304 show_secinfo_flags(m, flags);
1308 static void exp_flags(struct seq_file *m, int flag, int fsid,
1309 kuid_t anonu, kgid_t anong, struct nfsd4_fs_locations *fsloc)
1311 struct user_namespace *userns = m->file->f_cred->user_ns;
1313 show_expflags(m, flag, NFSEXP_ALLFLAGS);
1314 if (flag & NFSEXP_FSID)
1315 seq_printf(m, ",fsid=%d", fsid);
1316 if (!uid_eq(anonu, make_kuid(userns, (uid_t)-2)) &&
1317 !uid_eq(anonu, make_kuid(userns, 0x10000-2)))
1318 seq_printf(m, ",anonuid=%u", from_kuid_munged(userns, anonu));
1319 if (!gid_eq(anong, make_kgid(userns, (gid_t)-2)) &&
1320 !gid_eq(anong, make_kgid(userns, 0x10000-2)))
1321 seq_printf(m, ",anongid=%u", from_kgid_munged(userns, anong));
1322 if (fsloc && fsloc->locations_count > 0) {
1323 char *loctype = (fsloc->migrated) ? "refer" : "replicas";
1326 seq_printf(m, ",%s=", loctype);
1327 seq_escape(m, fsloc->locations[0].path, ",;@ \t\n\\");
1329 seq_escape(m, fsloc->locations[0].hosts, ",;@ \t\n\\");
1330 for (i = 1; i < fsloc->locations_count; i++) {
1332 seq_escape(m, fsloc->locations[i].path, ",;@ \t\n\\");
1334 seq_escape(m, fsloc->locations[i].hosts, ",;@ \t\n\\");
1339 static int e_show(struct seq_file *m, void *p)
1341 struct cache_head *cp = p;
1342 struct svc_export *exp = container_of(cp, struct svc_export, h);
1343 struct cache_detail *cd = m->private;
1344 bool export_stats = is_export_stats_file(m);
1346 if (p == SEQ_START_TOKEN) {
1347 seq_puts(m, "# Version 1.1\n");
1349 seq_puts(m, "# Path Client Start-time\n#\tStats\n");
1351 seq_puts(m, "# Path Client(Flags) # IPs\n");
1356 if (cache_check(cd, &exp->h, NULL))
1359 return svc_export_show(m, cd, cp);
1362 const struct seq_operations nfs_exports_op = {
1363 .start = cache_seq_start_rcu,
1364 .next = cache_seq_next_rcu,
1365 .stop = cache_seq_stop_rcu,
1370 * Initialize the exports module.
1373 nfsd_export_init(struct net *net)
1376 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1378 dprintk("nfsd: initializing export module (net: %x).\n", net->ns.inum);
1380 nn->svc_export_cache = cache_create_net(&svc_export_cache_template, net);
1381 if (IS_ERR(nn->svc_export_cache))
1382 return PTR_ERR(nn->svc_export_cache);
1383 rv = cache_register_net(nn->svc_export_cache, net);
1385 goto destroy_export_cache;
1387 nn->svc_expkey_cache = cache_create_net(&svc_expkey_cache_template, net);
1388 if (IS_ERR(nn->svc_expkey_cache)) {
1389 rv = PTR_ERR(nn->svc_expkey_cache);
1390 goto unregister_export_cache;
1392 rv = cache_register_net(nn->svc_expkey_cache, net);
1394 goto destroy_expkey_cache;
1397 destroy_expkey_cache:
1398 cache_destroy_net(nn->svc_expkey_cache, net);
1399 unregister_export_cache:
1400 cache_unregister_net(nn->svc_export_cache, net);
1401 destroy_export_cache:
1402 cache_destroy_net(nn->svc_export_cache, net);
1407 * Flush exports table - called when last nfsd thread is killed
1410 nfsd_export_flush(struct net *net)
1412 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1414 cache_purge(nn->svc_expkey_cache);
1415 cache_purge(nn->svc_export_cache);
1419 * Shutdown the exports module.
1422 nfsd_export_shutdown(struct net *net)
1424 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1426 dprintk("nfsd: shutting down export module (net: %x).\n", net->ns.inum);
1428 cache_unregister_net(nn->svc_expkey_cache, net);
1429 cache_unregister_net(nn->svc_export_cache, net);
1430 cache_destroy_net(nn->svc_expkey_cache, net);
1431 cache_destroy_net(nn->svc_export_cache, net);
1432 svcauth_unix_purge(net);
1434 dprintk("nfsd: export shutdown complete (net: %x).\n", net->ns.inum);