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