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