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_work(struct work_struct
*work
)
45 struct svc_expkey
*key
=
46 container_of(to_rcu_work(work
), struct svc_expkey
, ek_rcu_work
);
48 if (test_bit(CACHE_VALID
, &key
->h
.flags
) &&
49 !test_bit(CACHE_NEGATIVE
, &key
->h
.flags
))
50 path_put(&key
->ek_path
);
51 auth_domain_put(key
->ek_client
);
55 static void expkey_put(struct kref
*ref
)
57 struct svc_expkey
*key
= container_of(ref
, struct svc_expkey
, h
.ref
);
59 INIT_RCU_WORK(&key
->ek_rcu_work
, expkey_put_work
);
60 queue_rcu_work(system_wq
, &key
->ek_rcu_work
);
63 static int expkey_upcall(struct cache_detail
*cd
, struct cache_head
*h
)
65 return sunrpc_cache_pipe_upcall(cd
, h
);
68 static void expkey_request(struct cache_detail
*cd
,
70 char **bpp
, int *blen
)
72 /* client fsidtype \xfsid */
73 struct svc_expkey
*ek
= container_of(h
, struct svc_expkey
, h
);
76 qword_add(bpp
, blen
, ek
->ek_client
->name
);
77 snprintf(type
, 5, "%d", ek
->ek_fsidtype
);
78 qword_add(bpp
, blen
, type
);
79 qword_addhex(bpp
, blen
, (char*)ek
->ek_fsid
, key_len(ek
->ek_fsidtype
));
83 static struct svc_expkey
*svc_expkey_update(struct cache_detail
*cd
, struct svc_expkey
*new,
84 struct svc_expkey
*old
);
85 static struct svc_expkey
*svc_expkey_lookup(struct cache_detail
*cd
, struct svc_expkey
*);
87 static int expkey_parse(struct cache_detail
*cd
, char *mesg
, int mlen
)
89 /* client fsidtype fsid expiry [path] */
92 struct auth_domain
*dom
= NULL
;
96 struct svc_expkey key
;
97 struct svc_expkey
*ek
= NULL
;
99 if (mesg
[mlen
- 1] != '\n')
103 buf
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
109 if (qword_get(&mesg
, buf
, PAGE_SIZE
) <= 0)
113 dom
= auth_domain_find(buf
);
116 dprintk("found domain %s\n", buf
);
119 if (qword_get(&mesg
, buf
, PAGE_SIZE
) <= 0)
121 fsidtype
= simple_strtoul(buf
, &ep
, 10);
124 dprintk("found fsidtype %d\n", fsidtype
);
125 if (key_len(fsidtype
)==0) /* invalid type */
127 if ((len
=qword_get(&mesg
, buf
, PAGE_SIZE
)) <= 0)
129 dprintk("found fsid length %d\n", len
);
130 if (len
!= key_len(fsidtype
))
133 /* OK, we seem to have a valid key */
135 err
= get_expiry(&mesg
, &key
.h
.expiry_time
);
140 key
.ek_fsidtype
= fsidtype
;
141 memcpy(key
.ek_fsid
, buf
, len
);
143 ek
= svc_expkey_lookup(cd
, &key
);
148 /* now we want a pathname, or empty meaning NEGATIVE */
150 len
= qword_get(&mesg
, buf
, PAGE_SIZE
);
153 dprintk("Path seems to be <%s>\n", buf
);
156 set_bit(CACHE_NEGATIVE
, &key
.h
.flags
);
157 ek
= svc_expkey_update(cd
, &key
, ek
);
159 trace_nfsd_expkey_update(ek
, NULL
);
163 err
= kern_path(buf
, 0, &key
.ek_path
);
167 dprintk("Found the path %s\n", buf
);
169 ek
= svc_expkey_update(cd
, &key
, ek
);
171 trace_nfsd_expkey_update(ek
, buf
);
174 path_put(&key
.ek_path
);
179 cache_put(&ek
->h
, cd
);
181 auth_domain_put(dom
);
186 static int expkey_show(struct seq_file
*m
,
187 struct cache_detail
*cd
,
188 struct cache_head
*h
)
190 struct svc_expkey
*ek
;
194 seq_puts(m
, "#domain fsidtype fsid [path]\n");
197 ek
= container_of(h
, struct svc_expkey
, h
);
198 seq_printf(m
, "%s %d 0x", ek
->ek_client
->name
,
200 for (i
=0; i
< key_len(ek
->ek_fsidtype
)/4; i
++)
201 seq_printf(m
, "%08x", ek
->ek_fsid
[i
]);
202 if (test_bit(CACHE_VALID
, &h
->flags
) &&
203 !test_bit(CACHE_NEGATIVE
, &h
->flags
)) {
205 seq_path(m
, &ek
->ek_path
, "\\ \t\n");
211 static inline int expkey_match (struct cache_head
*a
, struct cache_head
*b
)
213 struct svc_expkey
*orig
= container_of(a
, struct svc_expkey
, h
);
214 struct svc_expkey
*new = container_of(b
, struct svc_expkey
, h
);
216 if (orig
->ek_fsidtype
!= new->ek_fsidtype
||
217 orig
->ek_client
!= new->ek_client
||
218 memcmp(orig
->ek_fsid
, new->ek_fsid
, key_len(orig
->ek_fsidtype
)) != 0)
223 static inline void expkey_init(struct cache_head
*cnew
,
224 struct cache_head
*citem
)
226 struct svc_expkey
*new = container_of(cnew
, struct svc_expkey
, h
);
227 struct svc_expkey
*item
= container_of(citem
, struct svc_expkey
, h
);
229 kref_get(&item
->ek_client
->ref
);
230 new->ek_client
= item
->ek_client
;
231 new->ek_fsidtype
= item
->ek_fsidtype
;
233 memcpy(new->ek_fsid
, item
->ek_fsid
, sizeof(new->ek_fsid
));
236 static inline void expkey_update(struct cache_head
*cnew
,
237 struct cache_head
*citem
)
239 struct svc_expkey
*new = container_of(cnew
, struct svc_expkey
, h
);
240 struct svc_expkey
*item
= container_of(citem
, struct svc_expkey
, h
);
242 new->ek_path
= item
->ek_path
;
243 path_get(&item
->ek_path
);
246 static struct cache_head
*expkey_alloc(void)
248 struct svc_expkey
*i
= kmalloc(sizeof(*i
), GFP_KERNEL
);
255 static void expkey_flush(void)
258 * Take the nfsd_mutex here to ensure that the file cache is not
259 * destroyed while we're in the middle of flushing.
261 mutex_lock(&nfsd_mutex
);
262 nfsd_file_cache_purge(current
->nsproxy
->net_ns
);
263 mutex_unlock(&nfsd_mutex
);
266 static const struct cache_detail svc_expkey_cache_template
= {
267 .owner
= THIS_MODULE
,
268 .hash_size
= EXPKEY_HASHMAX
,
270 .cache_put
= expkey_put
,
271 .cache_upcall
= expkey_upcall
,
272 .cache_request
= expkey_request
,
273 .cache_parse
= expkey_parse
,
274 .cache_show
= expkey_show
,
275 .match
= expkey_match
,
277 .update
= expkey_update
,
278 .alloc
= expkey_alloc
,
279 .flush
= expkey_flush
,
283 svc_expkey_hash(struct svc_expkey
*item
)
285 int hash
= item
->ek_fsidtype
;
286 char * cp
= (char*)item
->ek_fsid
;
287 int len
= key_len(item
->ek_fsidtype
);
289 hash
^= hash_mem(cp
, len
, EXPKEY_HASHBITS
);
290 hash
^= hash_ptr(item
->ek_client
, EXPKEY_HASHBITS
);
291 hash
&= EXPKEY_HASHMASK
;
295 static struct svc_expkey
*
296 svc_expkey_lookup(struct cache_detail
*cd
, struct svc_expkey
*item
)
298 struct cache_head
*ch
;
299 int hash
= svc_expkey_hash(item
);
301 ch
= sunrpc_cache_lookup_rcu(cd
, &item
->h
, hash
);
303 return container_of(ch
, struct svc_expkey
, h
);
308 static struct svc_expkey
*
309 svc_expkey_update(struct cache_detail
*cd
, struct svc_expkey
*new,
310 struct svc_expkey
*old
)
312 struct cache_head
*ch
;
313 int hash
= svc_expkey_hash(new);
315 ch
= sunrpc_cache_update(cd
, &new->h
, &old
->h
, hash
);
317 return container_of(ch
, struct svc_expkey
, h
);
323 #define EXPORT_HASHBITS 8
324 #define EXPORT_HASHMAX (1<< EXPORT_HASHBITS)
326 static void nfsd4_fslocs_free(struct nfsd4_fs_locations
*fsloc
)
328 struct nfsd4_fs_location
*locations
= fsloc
->locations
;
334 for (i
= 0; i
< fsloc
->locations_count
; i
++) {
335 kfree(locations
[i
].path
);
336 kfree(locations
[i
].hosts
);
340 fsloc
->locations
= NULL
;
343 static int export_stats_init(struct export_stats
*stats
)
345 stats
->start_time
= ktime_get_seconds();
346 return percpu_counter_init_many(stats
->counter
, 0, GFP_KERNEL
,
347 EXP_STATS_COUNTERS_NUM
);
350 static void export_stats_reset(struct export_stats
*stats
)
355 for (i
= 0; i
< EXP_STATS_COUNTERS_NUM
; i
++)
356 percpu_counter_set(&stats
->counter
[i
], 0);
360 static void export_stats_destroy(struct export_stats
*stats
)
363 percpu_counter_destroy_many(stats
->counter
,
364 EXP_STATS_COUNTERS_NUM
);
367 static void svc_export_put_work(struct work_struct
*work
)
369 struct svc_export
*exp
=
370 container_of(to_rcu_work(work
), struct svc_export
, ex_rcu_work
);
372 path_put(&exp
->ex_path
);
373 auth_domain_put(exp
->ex_client
);
374 nfsd4_fslocs_free(&exp
->ex_fslocs
);
375 export_stats_destroy(exp
->ex_stats
);
376 kfree(exp
->ex_stats
);
381 static void svc_export_put(struct kref
*ref
)
383 struct svc_export
*exp
= container_of(ref
, struct svc_export
, h
.ref
);
385 INIT_RCU_WORK(&exp
->ex_rcu_work
, svc_export_put_work
);
386 queue_rcu_work(system_wq
, &exp
->ex_rcu_work
);
389 static int svc_export_upcall(struct cache_detail
*cd
, struct cache_head
*h
)
391 return sunrpc_cache_pipe_upcall(cd
, h
);
394 static void svc_export_request(struct cache_detail
*cd
,
395 struct cache_head
*h
,
396 char **bpp
, int *blen
)
399 struct svc_export
*exp
= container_of(h
, struct svc_export
, h
);
402 qword_add(bpp
, blen
, exp
->ex_client
->name
);
403 pth
= d_path(&exp
->ex_path
, *bpp
, *blen
);
405 /* is this correct? */
409 qword_add(bpp
, blen
, pth
);
413 static struct svc_export
*svc_export_update(struct svc_export
*new,
414 struct svc_export
*old
);
415 static struct svc_export
*svc_export_lookup(struct svc_export
*);
417 static int check_export(struct path
*path
, int *flags
, unsigned char *uuid
)
419 struct inode
*inode
= d_inode(path
->dentry
);
422 * We currently export only dirs, regular files, and (for v4
423 * pseudoroot) symlinks.
425 if (!S_ISDIR(inode
->i_mode
) &&
426 !S_ISLNK(inode
->i_mode
) &&
427 !S_ISREG(inode
->i_mode
))
431 * Mountd should never pass down a writeable V4ROOT export, but,
434 if (*flags
& NFSEXP_V4ROOT
)
435 *flags
|= NFSEXP_READONLY
;
437 /* There are two requirements on a filesystem to be exportable.
438 * 1: We must be able to identify the filesystem from a number.
439 * either a device number (so FS_REQUIRES_DEV needed)
440 * or an FSID number (so NFSEXP_FSID or ->uuid is needed).
441 * 2: We must be able to find an inode from a filehandle.
442 * This means that s_export_op must be set.
443 * 3: We must not currently be on an idmapped mount.
445 if (!(inode
->i_sb
->s_type
->fs_flags
& FS_REQUIRES_DEV
) &&
446 !(*flags
& NFSEXP_FSID
) &&
448 dprintk("exp_export: export of non-dev fs without fsid\n");
452 if (!exportfs_can_decode_fh(inode
->i_sb
->s_export_op
)) {
453 dprintk("exp_export: export of invalid fs type.\n");
457 if (is_idmapped_mnt(path
->mnt
)) {
458 dprintk("exp_export: export of idmapped mounts not yet supported.\n");
462 if (inode
->i_sb
->s_export_op
->flags
& EXPORT_OP_NOSUBTREECHK
&&
463 !(*flags
& NFSEXP_NOSUBTREECHECK
)) {
464 dprintk("%s: %s does not support subtree checking!\n",
465 __func__
, inode
->i_sb
->s_type
->name
);
471 #ifdef CONFIG_NFSD_V4
474 fsloc_parse(char **mesg
, char *buf
, struct nfsd4_fs_locations
*fsloc
)
477 int migrated
, i
, err
;
479 /* more than one fsloc */
480 if (fsloc
->locations
)
484 err
= get_uint(mesg
, &fsloc
->locations_count
);
487 if (fsloc
->locations_count
> MAX_FS_LOCATIONS
)
489 if (fsloc
->locations_count
== 0)
492 fsloc
->locations
= kcalloc(fsloc
->locations_count
,
493 sizeof(struct nfsd4_fs_location
),
495 if (!fsloc
->locations
)
497 for (i
=0; i
< fsloc
->locations_count
; i
++) {
498 /* colon separated host list */
500 len
= qword_get(mesg
, buf
, PAGE_SIZE
);
504 fsloc
->locations
[i
].hosts
= kstrdup(buf
, GFP_KERNEL
);
505 if (!fsloc
->locations
[i
].hosts
)
508 /* slash separated path component list */
509 len
= qword_get(mesg
, buf
, PAGE_SIZE
);
513 fsloc
->locations
[i
].path
= kstrdup(buf
, GFP_KERNEL
);
514 if (!fsloc
->locations
[i
].path
)
518 err
= get_int(mesg
, &migrated
);
522 if (migrated
< 0 || migrated
> 1)
524 fsloc
->migrated
= migrated
;
527 nfsd4_fslocs_free(fsloc
);
531 static int secinfo_parse(char **mesg
, char *buf
, struct svc_export
*exp
)
533 struct exp_flavor_info
*f
;
537 /* more than one secinfo */
538 if (exp
->ex_nflavors
)
541 err
= get_uint(mesg
, &listsize
);
544 if (listsize
> MAX_SECINFO_LIST
)
547 for (f
= exp
->ex_flavors
; f
< exp
->ex_flavors
+ listsize
; f
++) {
548 err
= get_uint(mesg
, &f
->pseudoflavor
);
552 * XXX: It would be nice to also check whether this
553 * pseudoflavor is supported, so we can discover the
554 * problem at export time instead of when a client fails
557 err
= get_uint(mesg
, &f
->flags
);
560 /* Only some flags are allowed to differ between flavors: */
561 if (~NFSEXP_SECINFO_FLAGS
& (f
->flags
^ exp
->ex_flags
))
564 exp
->ex_nflavors
= listsize
;
568 #else /* CONFIG_NFSD_V4 */
570 fsloc_parse(char **mesg
, char *buf
, struct nfsd4_fs_locations
*fsloc
){return 0;}
572 secinfo_parse(char **mesg
, char *buf
, struct svc_export
*exp
) { return 0; }
575 static int xprtsec_parse(char **mesg
, char *buf
, struct svc_export
*exp
)
577 unsigned int i
, mode
, listsize
;
580 err
= get_uint(mesg
, &listsize
);
583 if (listsize
> NFSEXP_XPRTSEC_NUM
)
586 exp
->ex_xprtsec_modes
= 0;
587 for (i
= 0; i
< listsize
; i
++) {
588 err
= get_uint(mesg
, &mode
);
591 if (mode
> NFSEXP_XPRTSEC_MTLS
)
593 exp
->ex_xprtsec_modes
|= mode
;
599 nfsd_uuid_parse(char **mesg
, char *buf
, unsigned char **puuid
)
603 /* more than one uuid */
607 /* expect a 16 byte uuid encoded as \xXXXX... */
608 len
= qword_get(mesg
, buf
, PAGE_SIZE
);
609 if (len
!= EX_UUID_LEN
)
612 *puuid
= kmemdup(buf
, EX_UUID_LEN
, GFP_KERNEL
);
619 static int svc_export_parse(struct cache_detail
*cd
, char *mesg
, int mlen
)
621 /* client path expiry [flags anonuid anongid fsid] */
624 struct auth_domain
*dom
= NULL
;
625 struct svc_export exp
= {}, *expp
;
628 if (mesg
[mlen
-1] != '\n')
632 buf
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
638 if (qword_get(&mesg
, buf
, PAGE_SIZE
) <= 0)
642 dom
= auth_domain_find(buf
);
648 if (qword_get(&mesg
, buf
, PAGE_SIZE
) <= 0)
651 err
= kern_path(buf
, 0, &exp
.ex_path
);
657 exp
.ex_devid_map
= NULL
;
658 exp
.ex_xprtsec_modes
= NFSEXP_XPRTSEC_ALL
;
661 err
= get_expiry(&mesg
, &exp
.h
.expiry_time
);
666 err
= get_int(&mesg
, &an_int
);
667 if (err
== -ENOENT
) {
669 set_bit(CACHE_NEGATIVE
, &exp
.h
.flags
);
671 if (err
|| an_int
< 0)
673 exp
.ex_flags
= an_int
;
676 err
= get_int(&mesg
, &an_int
);
679 exp
.ex_anon_uid
= make_kuid(current_user_ns(), an_int
);
682 err
= get_int(&mesg
, &an_int
);
685 exp
.ex_anon_gid
= make_kgid(current_user_ns(), an_int
);
688 err
= get_int(&mesg
, &an_int
);
691 exp
.ex_fsid
= an_int
;
693 while (qword_get(&mesg
, buf
, PAGE_SIZE
) > 0) {
694 if (strcmp(buf
, "fsloc") == 0)
695 err
= fsloc_parse(&mesg
, buf
, &exp
.ex_fslocs
);
696 else if (strcmp(buf
, "uuid") == 0)
697 err
= nfsd_uuid_parse(&mesg
, buf
, &exp
.ex_uuid
);
698 else if (strcmp(buf
, "secinfo") == 0)
699 err
= secinfo_parse(&mesg
, buf
, &exp
);
700 else if (strcmp(buf
, "xprtsec") == 0)
701 err
= xprtsec_parse(&mesg
, buf
, &exp
);
703 /* quietly ignore unknown words and anything
704 * following. Newer user-space can try to set
705 * new values, then see what the result was.
712 err
= check_export(&exp
.ex_path
, &exp
.ex_flags
, exp
.ex_uuid
);
717 * No point caching this if it would immediately expire.
718 * Also, this protects exportfs's dummy export from the
719 * anon_uid/anon_gid checks:
721 if (exp
.h
.expiry_time
< seconds_since_boot())
724 * For some reason exportfs has been passing down an
725 * invalid (-1) uid & gid on the "dummy" export which it
726 * uses to test export support. To make sure exportfs
727 * sees errors from check_export we therefore need to
728 * delay these checks till after check_export:
731 if (!uid_valid(exp
.ex_anon_uid
))
733 if (!gid_valid(exp
.ex_anon_gid
))
737 nfsd4_setup_layout_type(&exp
);
740 expp
= svc_export_lookup(&exp
);
745 expp
= svc_export_update(&exp
, expp
);
747 trace_nfsd_export_update(expp
);
753 nfsd4_fslocs_free(&exp
.ex_fslocs
);
756 path_put(&exp
.ex_path
);
758 auth_domain_put(dom
);
764 static void exp_flags(struct seq_file
*m
, int flag
, int fsid
,
765 kuid_t anonu
, kgid_t anong
, struct nfsd4_fs_locations
*fslocs
);
766 static void show_secinfo(struct seq_file
*m
, struct svc_export
*exp
);
768 static int is_export_stats_file(struct seq_file
*m
)
771 * The export_stats file uses the same ops as the exports file.
772 * We use the file's name to determine the reported info per export.
773 * There is no rename in nsfdfs, so d_name.name is stable.
775 return !strcmp(m
->file
->f_path
.dentry
->d_name
.name
, "export_stats");
778 static int svc_export_show(struct seq_file
*m
,
779 struct cache_detail
*cd
,
780 struct cache_head
*h
)
782 struct svc_export
*exp
;
783 bool export_stats
= is_export_stats_file(m
);
787 seq_puts(m
, "#path domain start-time\n#\tstats\n");
789 seq_puts(m
, "#path domain(flags)\n");
792 exp
= container_of(h
, struct svc_export
, h
);
793 seq_path(m
, &exp
->ex_path
, " \t\n\\");
795 seq_escape(m
, exp
->ex_client
->name
, " \t\n\\");
797 struct percpu_counter
*counter
= exp
->ex_stats
->counter
;
799 seq_printf(m
, "\t%lld\n", exp
->ex_stats
->start_time
);
800 seq_printf(m
, "\tfh_stale: %lld\n",
801 percpu_counter_sum_positive(&counter
[EXP_STATS_FH_STALE
]));
802 seq_printf(m
, "\tio_read: %lld\n",
803 percpu_counter_sum_positive(&counter
[EXP_STATS_IO_READ
]));
804 seq_printf(m
, "\tio_write: %lld\n",
805 percpu_counter_sum_positive(&counter
[EXP_STATS_IO_WRITE
]));
810 if (test_bit(CACHE_VALID
, &h
->flags
) &&
811 !test_bit(CACHE_NEGATIVE
, &h
->flags
)) {
812 exp_flags(m
, exp
->ex_flags
, exp
->ex_fsid
,
813 exp
->ex_anon_uid
, exp
->ex_anon_gid
, &exp
->ex_fslocs
);
816 seq_puts(m
, ",uuid=");
817 for (i
= 0; i
< EX_UUID_LEN
; i
++) {
820 seq_printf(m
, "%02x", exp
->ex_uuid
[i
]);
823 show_secinfo(m
, exp
);
828 static int svc_export_match(struct cache_head
*a
, struct cache_head
*b
)
830 struct svc_export
*orig
= container_of(a
, struct svc_export
, h
);
831 struct svc_export
*new = container_of(b
, struct svc_export
, h
);
832 return orig
->ex_client
== new->ex_client
&&
833 path_equal(&orig
->ex_path
, &new->ex_path
);
836 static void svc_export_init(struct cache_head
*cnew
, struct cache_head
*citem
)
838 struct svc_export
*new = container_of(cnew
, struct svc_export
, h
);
839 struct svc_export
*item
= container_of(citem
, struct svc_export
, h
);
841 kref_get(&item
->ex_client
->ref
);
842 new->ex_client
= item
->ex_client
;
843 new->ex_path
= item
->ex_path
;
844 path_get(&item
->ex_path
);
845 new->ex_fslocs
.locations
= NULL
;
846 new->ex_fslocs
.locations_count
= 0;
847 new->ex_fslocs
.migrated
= 0;
848 new->ex_layout_types
= 0;
851 export_stats_reset(new->ex_stats
);
854 static void export_update(struct cache_head
*cnew
, struct cache_head
*citem
)
856 struct svc_export
*new = container_of(cnew
, struct svc_export
, h
);
857 struct svc_export
*item
= container_of(citem
, struct svc_export
, h
);
860 new->ex_flags
= item
->ex_flags
;
861 new->ex_anon_uid
= item
->ex_anon_uid
;
862 new->ex_anon_gid
= item
->ex_anon_gid
;
863 new->ex_fsid
= item
->ex_fsid
;
864 new->ex_devid_map
= item
->ex_devid_map
;
865 item
->ex_devid_map
= NULL
;
866 new->ex_uuid
= item
->ex_uuid
;
867 item
->ex_uuid
= NULL
;
868 new->ex_fslocs
.locations
= item
->ex_fslocs
.locations
;
869 item
->ex_fslocs
.locations
= NULL
;
870 new->ex_fslocs
.locations_count
= item
->ex_fslocs
.locations_count
;
871 item
->ex_fslocs
.locations_count
= 0;
872 new->ex_fslocs
.migrated
= item
->ex_fslocs
.migrated
;
873 item
->ex_fslocs
.migrated
= 0;
874 new->ex_layout_types
= item
->ex_layout_types
;
875 new->ex_nflavors
= item
->ex_nflavors
;
876 for (i
= 0; i
< MAX_SECINFO_LIST
; i
++) {
877 new->ex_flavors
[i
] = item
->ex_flavors
[i
];
879 new->ex_xprtsec_modes
= item
->ex_xprtsec_modes
;
882 static struct cache_head
*svc_export_alloc(void)
884 struct svc_export
*i
= kmalloc(sizeof(*i
), GFP_KERNEL
);
888 i
->ex_stats
= kmalloc(sizeof(*(i
->ex_stats
)), GFP_KERNEL
);
894 if (export_stats_init(i
->ex_stats
)) {
903 static const struct cache_detail svc_export_cache_template
= {
904 .owner
= THIS_MODULE
,
905 .hash_size
= EXPORT_HASHMAX
,
906 .name
= "nfsd.export",
907 .cache_put
= svc_export_put
,
908 .cache_upcall
= svc_export_upcall
,
909 .cache_request
= svc_export_request
,
910 .cache_parse
= svc_export_parse
,
911 .cache_show
= svc_export_show
,
912 .match
= svc_export_match
,
913 .init
= svc_export_init
,
914 .update
= export_update
,
915 .alloc
= svc_export_alloc
,
919 svc_export_hash(struct svc_export
*exp
)
923 hash
= hash_ptr(exp
->ex_client
, EXPORT_HASHBITS
);
924 hash
^= hash_ptr(exp
->ex_path
.dentry
, EXPORT_HASHBITS
);
925 hash
^= hash_ptr(exp
->ex_path
.mnt
, EXPORT_HASHBITS
);
929 static struct svc_export
*
930 svc_export_lookup(struct svc_export
*exp
)
932 struct cache_head
*ch
;
933 int hash
= svc_export_hash(exp
);
935 ch
= sunrpc_cache_lookup_rcu(exp
->cd
, &exp
->h
, hash
);
937 return container_of(ch
, struct svc_export
, h
);
942 static struct svc_export
*
943 svc_export_update(struct svc_export
*new, struct svc_export
*old
)
945 struct cache_head
*ch
;
946 int hash
= svc_export_hash(old
);
948 ch
= sunrpc_cache_update(old
->cd
, &new->h
, &old
->h
, hash
);
950 return container_of(ch
, struct svc_export
, h
);
956 static struct svc_expkey
*
957 exp_find_key(struct cache_detail
*cd
, struct auth_domain
*clp
, int fsid_type
,
958 u32
*fsidv
, struct cache_req
*reqp
)
960 struct svc_expkey key
, *ek
;
964 return ERR_PTR(-ENOENT
);
967 key
.ek_fsidtype
= fsid_type
;
968 memcpy(key
.ek_fsid
, fsidv
, key_len(fsid_type
));
970 ek
= svc_expkey_lookup(cd
, &key
);
972 return ERR_PTR(-ENOMEM
);
973 err
= cache_check(cd
, &ek
->h
, reqp
);
975 trace_nfsd_exp_find_key(&key
, err
);
981 static struct svc_export
*
982 exp_get_by_name(struct cache_detail
*cd
, struct auth_domain
*clp
,
983 const struct path
*path
, struct cache_req
*reqp
)
985 struct svc_export
*exp
, key
;
989 return ERR_PTR(-ENOENT
);
995 exp
= svc_export_lookup(&key
);
997 return ERR_PTR(-ENOMEM
);
998 err
= cache_check(cd
, &exp
->h
, reqp
);
1000 trace_nfsd_exp_get_by_name(&key
, err
);
1001 return ERR_PTR(err
);
1007 * Find the export entry for a given dentry.
1009 static struct svc_export
*
1010 exp_parent(struct cache_detail
*cd
, struct auth_domain
*clp
, struct path
*path
)
1012 struct dentry
*saved
= dget(path
->dentry
);
1013 struct svc_export
*exp
= exp_get_by_name(cd
, clp
, path
, NULL
);
1015 while (PTR_ERR(exp
) == -ENOENT
&& !IS_ROOT(path
->dentry
)) {
1016 struct dentry
*parent
= dget_parent(path
->dentry
);
1018 path
->dentry
= parent
;
1019 exp
= exp_get_by_name(cd
, clp
, path
, NULL
);
1022 path
->dentry
= saved
;
1029 * Obtain the root fh on behalf of a client.
1030 * This could be done in user space, but I feel that it adds some safety
1031 * since its harder to fool a kernel module than a user space program.
1034 exp_rootfh(struct net
*net
, struct auth_domain
*clp
, char *name
,
1035 struct knfsd_fh
*f
, int maxsize
)
1037 struct svc_export
*exp
;
1039 struct inode
*inode
;
1042 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
1043 struct cache_detail
*cd
= nn
->svc_export_cache
;
1046 /* NB: we probably ought to check that it's NUL-terminated */
1047 if (kern_path(name
, 0, &path
)) {
1048 printk("nfsd: exp_rootfh path not found %s", name
);
1051 inode
= d_inode(path
.dentry
);
1053 dprintk("nfsd: exp_rootfh(%s [%p] %s:%s/%ld)\n",
1054 name
, path
.dentry
, clp
->name
,
1055 inode
->i_sb
->s_id
, inode
->i_ino
);
1056 exp
= exp_parent(cd
, clp
, &path
);
1063 * fh must be initialized before calling fh_compose
1065 fh_init(&fh
, maxsize
);
1066 if (fh_compose(&fh
, exp
, path
.dentry
, NULL
))
1070 memcpy(f
, &fh
.fh_handle
, sizeof(struct knfsd_fh
));
1078 static struct svc_export
*exp_find(struct cache_detail
*cd
,
1079 struct auth_domain
*clp
, int fsid_type
,
1080 u32
*fsidv
, struct cache_req
*reqp
)
1082 struct svc_export
*exp
;
1083 struct nfsd_net
*nn
= net_generic(cd
->net
, nfsd_net_id
);
1084 struct svc_expkey
*ek
= exp_find_key(nn
->svc_expkey_cache
, clp
, fsid_type
, fsidv
, reqp
);
1086 return ERR_CAST(ek
);
1088 exp
= exp_get_by_name(cd
, clp
, &ek
->ek_path
, reqp
);
1089 cache_put(&ek
->h
, nn
->svc_expkey_cache
);
1092 return ERR_CAST(exp
);
1097 * check_nfsd_access - check if access to export is allowed.
1098 * @exp: svc_export that is being accessed.
1099 * @rqstp: svc_rqst attempting to access @exp (will be NULL for LOCALIO).
1100 * @may_bypass_gss: reduce strictness of authorization check
1103 * %nfs_ok if access is granted, or
1104 * %nfserr_wrongsec if access is denied
1106 __be32
check_nfsd_access(struct svc_export
*exp
, struct svc_rqst
*rqstp
,
1107 bool may_bypass_gss
)
1109 struct exp_flavor_info
*f
, *end
= exp
->ex_flavors
+ exp
->ex_nflavors
;
1110 struct svc_xprt
*xprt
;
1113 * If rqstp is NULL, this is a LOCALIO request which will only
1114 * ever use a filehandle/credential pair for which access has
1115 * been affirmed (by ACCESS or OPEN NFS requests) over the
1116 * wire. So there is no need for further checks here.
1121 xprt
= rqstp
->rq_xprt
;
1123 if (exp
->ex_xprtsec_modes
& NFSEXP_XPRTSEC_NONE
) {
1124 if (!test_bit(XPT_TLS_SESSION
, &xprt
->xpt_flags
))
1127 if (exp
->ex_xprtsec_modes
& NFSEXP_XPRTSEC_TLS
) {
1128 if (test_bit(XPT_TLS_SESSION
, &xprt
->xpt_flags
) &&
1129 !test_bit(XPT_PEER_AUTH
, &xprt
->xpt_flags
))
1132 if (exp
->ex_xprtsec_modes
& NFSEXP_XPRTSEC_MTLS
) {
1133 if (test_bit(XPT_TLS_SESSION
, &xprt
->xpt_flags
) &&
1134 test_bit(XPT_PEER_AUTH
, &xprt
->xpt_flags
))
1140 /* legacy gss-only clients are always OK: */
1141 if (exp
->ex_client
== rqstp
->rq_gssclient
)
1143 /* ip-address based client; check sec= export option: */
1144 for (f
= exp
->ex_flavors
; f
< end
; f
++) {
1145 if (f
->pseudoflavor
== rqstp
->rq_cred
.cr_flavor
)
1148 /* defaults in absence of sec= options: */
1149 if (exp
->ex_nflavors
== 0) {
1150 if (rqstp
->rq_cred
.cr_flavor
== RPC_AUTH_NULL
||
1151 rqstp
->rq_cred
.cr_flavor
== RPC_AUTH_UNIX
)
1155 /* If the compound op contains a spo_must_allowed op,
1156 * it will be sent with integrity/protection which
1157 * will have to be expressly allowed on mounts that
1161 if (nfsd4_spo_must_allow(rqstp
))
1164 /* Some calls may be processed without authentication
1165 * on GSS exports. For example NFS2/3 calls on root
1166 * directory, see section 2.3.2 of rfc 2623.
1167 * For "may_bypass_gss" check that export has really
1168 * enabled some flavor with authentication (GSS or any
1169 * other) and also check that the used auth flavor is
1170 * without authentication (none or sys).
1172 if (may_bypass_gss
&& (
1173 rqstp
->rq_cred
.cr_flavor
== RPC_AUTH_NULL
||
1174 rqstp
->rq_cred
.cr_flavor
== RPC_AUTH_UNIX
)) {
1175 for (f
= exp
->ex_flavors
; f
< end
; f
++) {
1176 if (f
->pseudoflavor
>= RPC_AUTH_DES
)
1182 return nfserr_wrongsec
;
1186 * Uses rq_client and rq_gssclient to find an export; uses rq_client (an
1187 * auth_unix client) if it's available and has secinfo information;
1188 * otherwise, will try to use rq_gssclient.
1190 * Called from functions that handle requests; functions that do work on
1191 * behalf of mountd are passed a single client name to use, and should
1192 * use exp_get_by_name() or exp_find().
1195 rqst_exp_get_by_name(struct svc_rqst
*rqstp
, struct path
*path
)
1197 struct svc_export
*gssexp
, *exp
= ERR_PTR(-ENOENT
);
1198 struct nfsd_net
*nn
= net_generic(SVC_NET(rqstp
), nfsd_net_id
);
1199 struct cache_detail
*cd
= nn
->svc_export_cache
;
1201 if (rqstp
->rq_client
== NULL
)
1204 /* First try the auth_unix client: */
1205 exp
= exp_get_by_name(cd
, rqstp
->rq_client
, path
, &rqstp
->rq_chandle
);
1206 if (PTR_ERR(exp
) == -ENOENT
)
1210 /* If it has secinfo, assume there are no gss/... clients */
1211 if (exp
->ex_nflavors
> 0)
1214 /* Otherwise, try falling back on gss client */
1215 if (rqstp
->rq_gssclient
== NULL
)
1217 gssexp
= exp_get_by_name(cd
, rqstp
->rq_gssclient
, path
, &rqstp
->rq_chandle
);
1218 if (PTR_ERR(gssexp
) == -ENOENT
)
1226 * rqst_exp_find - Find an svc_export in the context of a rqst or similar
1227 * @reqp: The handle to be used to suspend the request if a cache-upcall is needed
1228 * If NULL, missing in-cache information will result in failure.
1229 * @net: The network namespace in which the request exists
1230 * @cl: default auth_domain to use for looking up the export
1231 * @gsscl: an alternate auth_domain defined using deprecated gss/krb5 format.
1232 * @fsid_type: The type of fsid to look for
1233 * @fsidv: The actual fsid to look up in the context of either client.
1235 * Perform a lookup for @cl/@fsidv in the given @net for an export. If
1236 * none found and @gsscl specified, repeat the lookup.
1238 * Returns an export, or an error pointer.
1241 rqst_exp_find(struct cache_req
*reqp
, struct net
*net
,
1242 struct auth_domain
*cl
, struct auth_domain
*gsscl
,
1243 int fsid_type
, u32
*fsidv
)
1245 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
1246 struct svc_export
*gssexp
, *exp
= ERR_PTR(-ENOENT
);
1247 struct cache_detail
*cd
= nn
->svc_export_cache
;
1252 /* First try the auth_unix client: */
1253 exp
= exp_find(cd
, cl
, fsid_type
, fsidv
, reqp
);
1254 if (PTR_ERR(exp
) == -ENOENT
)
1258 /* If it has secinfo, assume there are no gss/... clients */
1259 if (exp
->ex_nflavors
> 0)
1262 /* Otherwise, try falling back on gss client */
1265 gssexp
= exp_find(cd
, gsscl
, fsid_type
, fsidv
, reqp
);
1266 if (PTR_ERR(gssexp
) == -ENOENT
)
1274 rqst_exp_parent(struct svc_rqst
*rqstp
, struct path
*path
)
1276 struct dentry
*saved
= dget(path
->dentry
);
1277 struct svc_export
*exp
= rqst_exp_get_by_name(rqstp
, path
);
1279 while (PTR_ERR(exp
) == -ENOENT
&& !IS_ROOT(path
->dentry
)) {
1280 struct dentry
*parent
= dget_parent(path
->dentry
);
1282 path
->dentry
= parent
;
1283 exp
= rqst_exp_get_by_name(rqstp
, path
);
1286 path
->dentry
= saved
;
1290 struct svc_export
*rqst_find_fsidzero_export(struct svc_rqst
*rqstp
)
1294 mk_fsid(FSID_NUM
, fsidv
, 0, 0, 0, NULL
);
1296 return rqst_exp_find(&rqstp
->rq_chandle
, SVC_NET(rqstp
),
1297 rqstp
->rq_client
, rqstp
->rq_gssclient
,
1302 * Called when we need the filehandle for the root of the pseudofs,
1303 * for a given NFSv4 client. The root is defined to be the
1304 * export point with fsid==0
1307 exp_pseudoroot(struct svc_rqst
*rqstp
, struct svc_fh
*fhp
)
1309 struct svc_export
*exp
;
1312 exp
= rqst_find_fsidzero_export(rqstp
);
1314 return nfserrno(PTR_ERR(exp
));
1315 rv
= fh_compose(fhp
, exp
, exp
->ex_path
.dentry
, NULL
);
1320 static struct flags
{
1324 { NFSEXP_READONLY
, {"ro", "rw"}},
1325 { NFSEXP_INSECURE_PORT
, {"insecure", ""}},
1326 { NFSEXP_ROOTSQUASH
, {"root_squash", "no_root_squash"}},
1327 { NFSEXP_ALLSQUASH
, {"all_squash", ""}},
1328 { NFSEXP_ASYNC
, {"async", "sync"}},
1329 { NFSEXP_GATHERED_WRITES
, {"wdelay", "no_wdelay"}},
1330 { NFSEXP_NOREADDIRPLUS
, {"nordirplus", ""}},
1331 { NFSEXP_NOHIDE
, {"nohide", ""}},
1332 { NFSEXP_CROSSMOUNT
, {"crossmnt", ""}},
1333 { NFSEXP_NOSUBTREECHECK
, {"no_subtree_check", ""}},
1334 { NFSEXP_NOAUTHNLM
, {"insecure_locks", ""}},
1335 { NFSEXP_V4ROOT
, {"v4root", ""}},
1336 { NFSEXP_PNFS
, {"pnfs", ""}},
1337 { NFSEXP_SECURITY_LABEL
, {"security_label", ""}},
1341 static void show_expflags(struct seq_file
*m
, int flags
, int mask
)
1344 int state
, first
= 0;
1346 for (flg
= expflags
; flg
->flag
; flg
++) {
1347 if (flg
->flag
& ~mask
)
1349 state
= (flg
->flag
& flags
) ? 0 : 1;
1350 if (*flg
->name
[state
])
1351 seq_printf(m
, "%s%s", first
++?",":"", flg
->name
[state
]);
1355 static void show_secinfo_flags(struct seq_file
*m
, int flags
)
1358 show_expflags(m
, flags
, NFSEXP_SECINFO_FLAGS
);
1361 static bool secinfo_flags_equal(int f
, int g
)
1363 f
&= NFSEXP_SECINFO_FLAGS
;
1364 g
&= NFSEXP_SECINFO_FLAGS
;
1368 static int show_secinfo_run(struct seq_file
*m
, struct exp_flavor_info
**fp
, struct exp_flavor_info
*end
)
1372 flags
= (*fp
)->flags
;
1373 seq_printf(m
, ",sec=%d", (*fp
)->pseudoflavor
);
1375 while (*fp
!= end
&& secinfo_flags_equal(flags
, (*fp
)->flags
)) {
1376 seq_printf(m
, ":%d", (*fp
)->pseudoflavor
);
1382 static void show_secinfo(struct seq_file
*m
, struct svc_export
*exp
)
1384 struct exp_flavor_info
*f
;
1385 struct exp_flavor_info
*end
= exp
->ex_flavors
+ exp
->ex_nflavors
;
1388 if (exp
->ex_nflavors
== 0)
1390 f
= exp
->ex_flavors
;
1391 flags
= show_secinfo_run(m
, &f
, end
);
1392 if (!secinfo_flags_equal(flags
, exp
->ex_flags
))
1393 show_secinfo_flags(m
, flags
);
1395 flags
= show_secinfo_run(m
, &f
, end
);
1396 show_secinfo_flags(m
, flags
);
1400 static void exp_flags(struct seq_file
*m
, int flag
, int fsid
,
1401 kuid_t anonu
, kgid_t anong
, struct nfsd4_fs_locations
*fsloc
)
1403 struct user_namespace
*userns
= m
->file
->f_cred
->user_ns
;
1405 show_expflags(m
, flag
, NFSEXP_ALLFLAGS
);
1406 if (flag
& NFSEXP_FSID
)
1407 seq_printf(m
, ",fsid=%d", fsid
);
1408 if (!uid_eq(anonu
, make_kuid(userns
, (uid_t
)-2)) &&
1409 !uid_eq(anonu
, make_kuid(userns
, 0x10000-2)))
1410 seq_printf(m
, ",anonuid=%u", from_kuid_munged(userns
, anonu
));
1411 if (!gid_eq(anong
, make_kgid(userns
, (gid_t
)-2)) &&
1412 !gid_eq(anong
, make_kgid(userns
, 0x10000-2)))
1413 seq_printf(m
, ",anongid=%u", from_kgid_munged(userns
, anong
));
1414 if (fsloc
&& fsloc
->locations_count
> 0) {
1415 char *loctype
= (fsloc
->migrated
) ? "refer" : "replicas";
1418 seq_printf(m
, ",%s=", loctype
);
1419 seq_escape(m
, fsloc
->locations
[0].path
, ",;@ \t\n\\");
1421 seq_escape(m
, fsloc
->locations
[0].hosts
, ",;@ \t\n\\");
1422 for (i
= 1; i
< fsloc
->locations_count
; i
++) {
1424 seq_escape(m
, fsloc
->locations
[i
].path
, ",;@ \t\n\\");
1426 seq_escape(m
, fsloc
->locations
[i
].hosts
, ",;@ \t\n\\");
1431 static int e_show(struct seq_file
*m
, void *p
)
1433 struct cache_head
*cp
= p
;
1434 struct svc_export
*exp
= container_of(cp
, struct svc_export
, h
);
1435 struct cache_detail
*cd
= m
->private;
1436 bool export_stats
= is_export_stats_file(m
);
1438 if (p
== SEQ_START_TOKEN
) {
1439 seq_puts(m
, "# Version 1.1\n");
1441 seq_puts(m
, "# Path Client Start-time\n#\tStats\n");
1443 seq_puts(m
, "# Path Client(Flags) # IPs\n");
1447 if (!cache_get_rcu(&exp
->h
))
1450 if (cache_check(cd
, &exp
->h
, NULL
))
1454 return svc_export_show(m
, cd
, cp
);
1457 const struct seq_operations nfs_exports_op
= {
1458 .start
= cache_seq_start_rcu
,
1459 .next
= cache_seq_next_rcu
,
1460 .stop
= cache_seq_stop_rcu
,
1465 * Initialize the exports module.
1468 nfsd_export_init(struct net
*net
)
1471 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
1473 dprintk("nfsd: initializing export module (net: %x).\n", net
->ns
.inum
);
1475 nn
->svc_export_cache
= cache_create_net(&svc_export_cache_template
, net
);
1476 if (IS_ERR(nn
->svc_export_cache
))
1477 return PTR_ERR(nn
->svc_export_cache
);
1478 rv
= cache_register_net(nn
->svc_export_cache
, net
);
1480 goto destroy_export_cache
;
1482 nn
->svc_expkey_cache
= cache_create_net(&svc_expkey_cache_template
, net
);
1483 if (IS_ERR(nn
->svc_expkey_cache
)) {
1484 rv
= PTR_ERR(nn
->svc_expkey_cache
);
1485 goto unregister_export_cache
;
1487 rv
= cache_register_net(nn
->svc_expkey_cache
, net
);
1489 goto destroy_expkey_cache
;
1492 destroy_expkey_cache
:
1493 cache_destroy_net(nn
->svc_expkey_cache
, net
);
1494 unregister_export_cache
:
1495 cache_unregister_net(nn
->svc_export_cache
, net
);
1496 destroy_export_cache
:
1497 cache_destroy_net(nn
->svc_export_cache
, net
);
1502 * Flush exports table - called when last nfsd thread is killed
1505 nfsd_export_flush(struct net
*net
)
1507 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
1509 cache_purge(nn
->svc_expkey_cache
);
1510 cache_purge(nn
->svc_export_cache
);
1514 * Shutdown the exports module.
1517 nfsd_export_shutdown(struct net
*net
)
1519 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
1521 dprintk("nfsd: shutting down export module (net: %x).\n", net
->ns
.inum
);
1523 cache_unregister_net(nn
->svc_expkey_cache
, net
);
1524 cache_unregister_net(nn
->svc_export_cache
, net
);
1525 cache_destroy_net(nn
->svc_expkey_cache
, net
);
1526 cache_destroy_net(nn
->svc_export_cache
, net
);
1527 svcauth_unix_purge(net
);
1529 dprintk("nfsd: export shutdown complete (net: %x).\n", net
->ns
.inum
);