usr.sbin/mountd/exports.5

   1 .\" Copyright (c) 1989, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)exports.5   8.3 (Berkeley) 3/29/95
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd February 11, 2019
  32 .Dt EXPORTS 5
  33 .Os
  34 .Sh NAME
  35 .Nm exports
  36 .Nd define remote mount points for
  37 .Tn NFS
  38 mount requests
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 file specifies remote mount points for the
  45 .Tn NFS
  46 mount protocol per the
  47 .Tn NFS
  48 server specification; see
  49 .%T "Network File System Protocol Specification" ,
  50 RFC1094, Appendix A and
  51 .%T "NFS: Network File System Version 3 Specification" ,
  52 Appendix I.
  53 .Pp
  54 Each line in the file
  55 (other than comment lines that begin with a #)
  56 specifies the mount point(s) and export flags within one local server
  57 file system or the NFSv4 tree root for one or more hosts.
  58 A long line may be split over several lines by ending all but the
  59 last line with a backslash
  60 .Pq Ql \e .
  61 A host may be specified only once for each local file or the NFSv4 tree root on the
  62 server and there may be only one default entry for each server
  63 file system that applies to all other hosts.
  64 The latter exports the file system to the
  65 .Dq world
  66 and should
  67 be used only when the file system contains public information.
  68 .Pp
  69 In a mount entry,
  70 the first field(s) specify the directory path(s) within a server file system
  71 that can be mounted on by the corresponding client(s).
  72 There are three forms of this specification.
  73 The first is to list all mount points as absolute
  74 directory paths separated by whitespace.
  75 This list of directory paths should be considered an
  76 .Dq administrative control ,
  77 since it is only enforced by the
  78 .Xr mountd 8
  79 daemon and not the kernel.
  80 As such, it only applies to NFSv2 and NFSv3 mounts and only
  81 with respect to the client's use of the mount protocol.
  82 The second is to specify the pathname of the root of the file system
  83 followed by the
  84 .Fl alldirs
  85 flag;
  86 this form allows the host(s) to mount at any point within the file system,
  87 including regular files if the
  88 .Fl r
  89 option is used on
  90 .Xr mountd 8 .
  91 Because NFSv4 does not use the mount protocol,
  92 the
  93 .Dq administrative controls
  94 are not applied and all directories within this server
  95 file system are mountable via NFSv4 even if the
  96 .Fl alldirs
  97 flag has not been specified.
  98 The third form has the string ``V4:'' followed by a single absolute path
  99 name, to specify the NFSv4 tree root.
 100 This line does not export any file system, but simply marks where the root
 101 of the server's directory tree is for NFSv4 clients.
 102 The exported file systems for NFSv4 are specified via the other lines
 103 in the
 104 .Nm
 105 file in the same way as for NFSv2 and NFSv3.
 106 The pathnames must not have any symbolic links in them and should not have
 107 any
 108 .Dq Pa \&.
 109 or
 110 .Dq Pa ..
 111 components.
 112 Mount points for a file system may appear on multiple lines each with
 113 different sets of hosts and export options.
 114 .Pp
 115 The second component of a line specifies how the file system is to be
 116 exported to the host set.
 117 The option flags specify whether the file system
 118 is exported read-only or read-write and how the client UID is mapped to
 119 user credentials on the server.
 120 For the NFSv4 tree root, the only option that can be specified in this
 121 section is
 122 .Fl sec .
 123 .Pp
 124 Export options are specified as follows:
 125 .Pp
 126 .Sm off
 127 .Fl maproot Li = Sy user
 128 .Sm on
 129 The credential of the specified user is used for remote access by root.
 130 The credential includes all the groups to which the user is a member
 131 on the local machine (see
 132 .Xr id 1 ) .
 133 The user may be specified by name or number.
 134 The user string may be quoted, or use backslash escaping.
 135 .Pp
 136 .Sm off
 137 .Fl maproot Li = Sy user:group1:group2:...
 138 .Sm on
 139 The colon separated list is used to specify the precise credential
 140 to be used for remote access by root.
 141 The elements of the list may be either names or numbers.
 142 Note that user: should be used to distinguish a credential containing
 143 no groups from a complete credential for that user.
 144 The group names may be quoted, or use backslash escaping.
 145 .Pp
 146 .Sm off
 147 .Fl mapall Li = Sy user
 148 .Sm on
 149 or
 150 .Sm off
 151 .Fl mapall Li = Sy user:group1:group2:...
 152 .Sm on
 153 specifies a mapping for all client UIDs (including root)
 154 using the same semantics as
 155 .Fl maproot .
 156 .Pp
 157 The option
 158 .Fl r
 159 is a synonym for
 160 .Fl maproot
 161 in an effort to be backward compatible with older export file formats.
 162 .Pp
 163 In the absence of
 164 .Fl maproot
 165 and
 166 .Fl mapall
 167 options, remote accesses by root will result in using a credential of 65534:65533.
 168 All other users will be mapped to their remote credential.
 169 If a
 170 .Fl maproot
 171 option is given,
 172 remote access by root will be mapped to that credential instead of 65534:65533.
 173 If a
 174 .Fl mapall
 175 option is given,
 176 all users (including root) will be mapped to that credential in
 177 place of their own.
 178 .Pp
 179 .Sm off
 180 .Fl sec Li = Sy flavor1:flavor2...
 181 .Sm on
 182 specifies a colon separated list of acceptable security flavors to be
 183 used for remote access.
 184 Supported security flavors are sys, krb5, krb5i and krb5p.
 185 If multiple flavors are listed, they should be ordered with the most
 186 preferred flavor first.
 187 If this option is not present,
 188 the default security flavor list of just sys is used.
 189 .Pp
 190 The
 191 .Fl ro
 192 option specifies that the file system should be exported read-only
 193 (default read/write).
 194 The option
 195 .Fl o
 196 is a synonym for
 197 .Fl ro
 198 in an effort to be backward compatible with older export file formats.
 199 .Pp
 200 .Tn WebNFS
 201 exports strictly according to the spec (RFC 2054 and RFC 2055) can
 202 be done with the
 203 .Fl public
 204 flag.
 205 However, this flag in itself allows r/w access to all files in
 206 the file system, not requiring reserved ports and not remapping UIDs.
 207 It
 208 is only provided to conform to the spec, and should normally not be used.
 209 For a
 210 .Tn WebNFS
 211 export,
 212 use the
 213 .Fl webnfs
 214 flag, which implies
 215 .Fl public ,
 216 .Sm off
 217 .Fl mapall No = Sy nobody
 218 .Sm on
 219 and
 220 .Fl ro .
 221 Note that only one file system can be
 222 .Tn WebNFS
 223 exported on a server.
 224 .Pp
 225 A
 226 .Sm off
 227 .Fl index No = Pa file
 228 .Sm on
 229 option can be used to specify a file whose handle will be returned if
 230 a directory is looked up using the public filehandle
 231 .Pq Tn WebNFS .
 232 This is to mimic the behavior of URLs.
 233 If no
 234 .Fl index
 235 option is specified, a directory filehandle will be returned as usual.
 236 The
 237 .Fl index
 238 option only makes sense in combination with the
 239 .Fl public
 240 or
 241 .Fl webnfs
 242 flags.
 243 .Pp
 244 Specifying the
 245 .Fl quiet
 246 option will inhibit some of the syslog diagnostics for bad lines in
 247 .Pa /etc/exports .
 248 This can be useful to avoid annoying error messages for known possible
 249 problems (see
 250 .Sx EXAMPLES
 251 below).
 252 .Pp
 253 The third component of a line specifies the host set to which the line applies.
 254 The set may be specified in three ways.
 255 The first way is to list the host name(s) separated by white space.
 256 (Standard Internet
 257 .Dq dot
 258 addresses may be used in place of names.)
 259 The second way is to specify a
 260 .Dq netgroup
 261 as defined in the
 262 .Pa netgroup
 263 file (see
 264 .Xr netgroup 5 ) .
 265 The third way is to specify an Internet subnetwork using a network and
 266 network mask that is defined as the set of all hosts with addresses within
 267 the subnetwork.
 268 This latter approach requires less overhead within the
 269 kernel and is recommended for cases where the export line refers to a
 270 large number of clients within an administrative subnet.
 271 .Pp
 272 The first two cases are specified by simply listing the name(s) separated
 273 by whitespace.
 274 All names are checked to see if they are
 275 .Dq netgroup
 276 names
 277 first and are assumed to be hostnames otherwise.
 278 Using the full domain specification for a hostname can normally
 279 circumvent the problem of a host that has the same name as a netgroup.
 280 The third case is specified by the flag
 281 .Sm off
 282 .Fl network Li = Sy netname Op Li / Ar prefixlength
 283 .Sm on
 284 and optionally
 285 .Sm off
 286 .Fl mask No = Sy netmask .
 287 .Sm on
 288 The netmask may be specified either by attaching a
 289 .Ar prefixlength
 290 to the
 291 .Fl network
 292 option, or by using a separate
 293 .Fl mask
 294 option.
 295 If the mask is not specified, it will default to the mask for that network
 296 class (A, B or C; see
 297 .Xr inet 4 ) .
 298 See the
 299 .Sx EXAMPLES
 300 section below.
 301 .Pp
 302 Scoped IPv6 address must carry scope identifier as documented in
 303 .Xr inet6 4 .
 304 For example,
 305 .Dq Li fe80::%re2/10
 306 is used to specify
 307 .Li fe80::/10
 308 on
 309 .Li re2
 310 interface.
 311 .Pp
 312 For the third form which specifies the NFSv4 tree root, the directory path
 313 specifies the location within the server's file system tree which is the
 314 root of the NFSv4 tree.
 315 There can only be one NFSv4 root directory per server.
 316 As such, all entries of this form must specify the same directory path.
 317 For file systems other than ZFS,
 318 this location can be any directory and does not
 319 need to be within an exported file system.
 320 If it is not in an exported file system, a very limited set of operations
 321 are permitted, so that an NFSv4 client can traverse the tree to an
 322 exported file system.
 323 Although parts of the NFSv4 tree can be non-exported, the entire NFSv4 tree
 324 must consist of local file systems capable of being exported via NFS.
 325 All ZFS file systems in the subtree below the NFSv4 tree root must be
 326 exported.
 327 NFSv4 does not use the mount protocol and does permit clients to cross server
 328 mount point boundaries, although not all clients are capable of crossing the
 329 mount points.
 330 .Pp
 331 The
 332 .Fl sec
 333 option on these line(s) specifies what security flavors may be used for
 334 NFSv4 operations that do not use file handles.
 335 Since these operations (SetClientID, SetClientIDConfirm, Renew, DelegPurge
 336 and ReleaseLockOnwer) allocate/modify state in the server, it is possible
 337 to restrict some clients to the use of the krb5[ip] security flavors,
 338 via this option.
 339 See the
 340 .Sx EXAMPLES
 341 section below.
 342 This third form is meaningless for NFSv2 and NFSv3 and is ignored for them.
 343 .Pp
 344 The
 345 .Xr mountd 8
 346 utility can be made to re-read the
 347 .Nm
 348 file by sending it a hangup signal as follows:
 349 .Bd -literal -offset indent
 350 /etc/rc.d/mountd reload
 351 .Ed
 352 .Pp
 353 After sending the
 354 .Dv SIGHUP ,
 355 check the
 356 .Xr syslogd 8
 357 output to see whether
 358 .Xr mountd 8
 359 logged any parsing errors in the
 360 .Nm
 361 file.
 362 .Sh FILES
 363 .Bl -tag -width /etc/exports -compact
 364 .It Pa /etc/exports
 365 the default remote mount-point file
 366 .El
 367 .Sh EXAMPLES
 368 .Bd -literal -offset indent
 369 /usr /usr/local -maproot=0:10 friends
 370 /usr -maproot=daemon grumpy.cis.uoguelph.ca 131.104.48.16
 371 /usr -ro -mapall=nobody
 372 /u -maproot=bin: -network 131.104.48 -mask 255.255.255.0
 373 /a -network 192.168.0/24
 374 /a -network 3ffe:1ce1:1:fe80::/64
 375 /u2 -maproot=root friends
 376 /u2 -alldirs -network cis-net -mask cis-mask
 377 /cdrom -alldirs,quiet,ro -network 192.168.33.0 -mask 255.255.255.0
 378 /private -sec=krb5i
 379 /secret -sec=krb5p
 380 V4: /   -sec=krb5:krb5i:krb5p -network 131.104.48 -mask 255.255.255.0
 381 V4: /   -sec=sys:krb5:krb5i:krb5p grumpy.cis.uoguelph.ca
 382 .Ed
 383 .Pp
 384 Given that
 385 .Pa /usr , /u , /a
 386 and
 387 .Pa /u2
 388 are
 389 local file system mount points, the above example specifies the following:
 390 .Pp
 391 The file system rooted at
 392 .Pa /usr
 393 is exported to hosts
 394 .Em friends
 395 where friends is specified in the netgroup file
 396 with users mapped to their remote credentials and
 397 root mapped to UID 0 and group 10.
 398 It is exported read-write and the hosts in
 399 .Dq friends
 400 can mount either
 401 .Pa /usr
 402 or
 403 .Pa /usr/local .
 404 It is exported to
 405 .Em 131.104.48.16
 406 and
 407 .Em grumpy.cis.uoguelph.ca
 408 with users mapped to their remote credentials and
 409 root mapped to the user and groups associated with
 410 .Dq daemon ;
 411 it is exported to the rest of the world as read-only with
 412 all users mapped to the user and groups associated with
 413 .Dq nobody .
 414 .Pp
 415 The file system rooted at
 416 .Pa /u
 417 is exported to all hosts on the subnetwork
 418 .Em 131.104.48
 419 with root mapped to the UID for
 420 .Dq bin
 421 and with no group access.
 422 .Pp
 423 The file system rooted at
 424 .Pa /u2
 425 is exported to the hosts in
 426 .Dq friends
 427 with root mapped to UID and groups
 428 associated with
 429 .Dq root ;
 430 it is exported to all hosts on network
 431 .Dq cis-net
 432 allowing mounts at any
 433 directory within /u2.
 434 .Pp
 435 The file system rooted at
 436 .Pa /a
 437 is exported to the network 192.168.0.0, with a netmask of 255.255.255.0.
 438 However, the netmask length in the entry for
 439 .Pa /a
 440 is not specified through a
 441 .Fl mask
 442 option, but through the
 443 .Li / Ns Ar prefix
 444 notation.
 445 .Pp
 446 The file system rooted at
 447 .Pa /a
 448 is also exported to the IPv6 network
 449 .Li 3ffe:1ce1:1:fe80::
 450 address, using the upper 64 bits as the prefix.
 451 Note that, unlike with IPv4 network addresses, the specified network
 452 address must be complete, and not just contain the upper bits.
 453 With IPv6 addresses, the
 454 .Fl mask
 455 option must not be used.
 456 .Pp
 457 The file system rooted at
 458 .Pa /cdrom
 459 will be exported read-only to the entire network 192.168.33.0/24, including
 460 all its subdirectories.
 461 Since
 462 .Pa /cdrom
 463 is the conventional mountpoint for a CD-ROM device, this export will
 464 fail if no CD-ROM medium is currently mounted there since that line
 465 would then attempt to export a subdirectory of the root file system
 466 with the
 467 .Fl alldirs
 468 option which is not allowed.
 469 The
 470 .Fl quiet
 471 option will then suppress the error message for this condition that
 472 would normally be syslogged.
 473 As soon as an actual CD-ROM is going to be mounted,
 474 .Xr mount 8
 475 will notify
 476 .Xr mountd 8
 477 about this situation, and the
 478 .Pa /cdrom
 479 file system will be exported as intended.
 480 Note that without using the
 481 .Fl alldirs
 482 option, the export would always succeed.
 483 While there is no CD-ROM medium mounted under
 484 .Pa /cdrom ,
 485 it would export the (normally empty) directory
 486 .Pa /cdrom
 487 of the root file system instead.
 488 .Pp
 489 The file system rooted at
 490 .Pa /private
 491 will be exported using Kerberos 5 authentication and will require
 492 integrity protected messages for all accesses.
 493 The file system rooted at
 494 .Pa /secret
 495 will also be exported using Kerberos 5 authentication and all messages
 496 used to access it will be encrypted.
 497 .Pp
 498 For the experimental server, the NFSv4 tree is rooted at ``/'',
 499 and any client within the 131.104.48 subnet is permitted to perform NFSv4 state
 500 operations on the server, so long as valid Kerberos credentials are provided.
 501 The machine grumpy.cis.uoguelph.ca is permitted to perform NFSv4 state
 502 operations on the server using AUTH_SYS credentials, as well as Kerberos ones.
 503 .Pp
 504 In the following example some directories are exported as NFSv3 and NFSv4:
 505 .Bd -literal -offset indent
 506 V4: /wingsdl/nfsv4
 507 /wingsdl/nfsv4/usr-ports -maproot=root -network 172.16.0.0 -mask 255.255.0.0
 508 /wingsdl/nfsv4/clasper   -maproot=root clasper
 509 .Ed
 510 .Pp
 511 Only one V4: line is needed or allowed to declare where NFSv4 is
 512 rooted.
 513 The other lines declare specific exported directories with
 514 their absolute paths given in /etc/exports.
 515 .Pp
 516 The exported directories' paths are used for both v3 and v4.
 517 However, they are interpreted differently for v3 and v4.
 518 A client mount command for usr-ports would use the server-absolute name when
 519 using nfsv3:
 520 .Bd -literal -offset indent
 521 mount server:/wingsdl/nfsv4/usr-ports /mnt/tmp
 522 .Ed
 523 .Pp
 524 A mount command using NFSv4 would use the path relative to the NFSv4
 525 root:
 526 .Bd -literal -offset indent
 527 mount server:/usr-ports /mnt/tmp
 528 .Ed
 529 .Pp
 530 This also differentiates which version you want if the client can do
 531 both v3 and v4.
 532 The former will only ever do a v3 mount and the latter will only ever
 533 do a v4 mount.
 534 .Pp
 535 Note that due to different mount behavior between NFSv3 and NFSv4 a
 536 NFSv4 mount request for a directory that the client does not have
 537 permission for will succeed and read/write access will fail
 538 afterwards, whereas NFSv3 rejects the mount request.
 539 .Sh SEE ALSO
 540 .Xr nfsv4 4 ,
 541 .Xr netgroup 5 ,
 542 .Xr mountd 8 ,
 543 .Xr nfsd 8 ,
 544 .Xr showmount 8
 545 .Sh BUGS
 546 The export options are tied to the local mount points in the kernel and
 547 must be non-contradictory for any exported subdirectory of the local
 548 server mount point.
 549 It is recommended that all exported directories within the same server
 550 file system be specified on adjacent lines going down the tree.
 551 You cannot specify a hostname that is also the name of a netgroup.
 552 Specifying the full domain specification for a hostname can normally
 553 circumvent the problem.