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 November 9, 2021
  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 options that can be specified in this
 121 section are ones related to security:
 122 .Fl sec ,
 123 .Fl tls ,
 124 .Fl tlscert
 125 and
 126 .Fl tlscertuser .
 127 .Pp
 128 Export options are specified as follows:
 129 .Pp
 130 .Sm off
 131 .Fl maproot Li = Sy user
 132 .Sm on
 133 The credential of the specified user is used for remote access by root.
 134 The credential includes all the groups to which the user is a member
 135 on the local machine (see
 136 .Xr id 1 ) .
 137 The user may be specified by name or number.
 138 The user string may be quoted, or use backslash escaping.
 139 .Pp
 140 .Sm off
 141 .Fl maproot Li = Sy user:group1:group2:...
 142 .Sm on
 143 The colon separated list is used to specify the precise credential
 144 to be used for remote access by root.
 145 The elements of the list may be either names or numbers.
 146 Note that user: should be used to distinguish a credential containing
 147 no groups from a complete credential for that user.
 148 The group names may be quoted, or use backslash escaping.
 149 .Pp
 150 .Sm off
 151 .Fl mapall Li = Sy user
 152 .Sm on
 153 or
 154 .Sm off
 155 .Fl mapall Li = Sy user:group1:group2:...
 156 .Sm on
 157 specifies a mapping for all client UIDs (including root)
 158 using the same semantics as
 159 .Fl maproot .
 160 .Pp
 161 The option
 162 .Fl r
 163 is a synonym for
 164 .Fl maproot
 165 in an effort to be backward compatible with older export file formats.
 166 .Pp
 167 In the absence of
 168 .Fl maproot
 169 and
 170 .Fl mapall
 171 options, remote accesses by root will result in using a credential of 65534:65533.
 172 All other users will be mapped to their remote credential.
 173 If a
 174 .Fl maproot
 175 option is given,
 176 remote access by root will be mapped to that credential instead of 65534:65533.
 177 If a
 178 .Fl mapall
 179 option is given,
 180 all users (including root) will be mapped to that credential in
 181 place of their own.
 182 .Pp
 183 .Sm off
 184 .Fl sec Li = Sy flavor1:flavor2...
 185 .Sm on
 186 specifies a colon separated list of acceptable security flavors to be
 187 used for remote access.
 188 Supported security flavors are sys, krb5, krb5i and krb5p.
 189 If multiple flavors are listed, they should be ordered with the most
 190 preferred flavor first.
 191 If this option is not present,
 192 the default security flavor list of just sys is used.
 193 .Pp
 194 The
 195 .Fl ro
 196 option specifies that the file system should be exported read-only
 197 (default read/write).
 198 The option
 199 .Fl o
 200 is a synonym for
 201 .Fl ro
 202 in an effort to be backward compatible with older export file formats.
 203 .Pp
 204 .Tn WebNFS
 205 exports strictly according to the spec (RFC 2054 and RFC 2055) can
 206 be done with the
 207 .Fl public
 208 flag.
 209 However, this flag in itself allows r/w access to all files in
 210 the file system, not requiring reserved ports and not remapping UIDs.
 211 It
 212 is only provided to conform to the spec, and should normally not be used.
 213 For a
 214 .Tn WebNFS
 215 export,
 216 use the
 217 .Fl webnfs
 218 flag, which implies
 219 .Fl public ,
 220 .Sm off
 221 .Fl mapall No = Sy nobody
 222 .Sm on
 223 and
 224 .Fl ro .
 225 Note that only one file system can be
 226 .Tn WebNFS
 227 exported on a server.
 228 .Pp
 229 A
 230 .Sm off
 231 .Fl index No = Pa file
 232 .Sm on
 233 option can be used to specify a file whose handle will be returned if
 234 a directory is looked up using the public filehandle
 235 .Pq Tn WebNFS .
 236 This is to mimic the behavior of URLs.
 237 If no
 238 .Fl index
 239 option is specified, a directory filehandle will be returned as usual.
 240 The
 241 .Fl index
 242 option only makes sense in combination with the
 243 .Fl public
 244 or
 245 .Fl webnfs
 246 flags.
 247 .Pp
 248 The
 249 .Fl tls ,
 250 .Fl tlscert
 251 and
 252 .Fl tlscertuser
 253 export options are used to require the client to use TLS for the mount(s)
 254 per RFC NNNN.
 255 For NFS mounts using TLS to work,
 256 .Xr rpc.tlsservd 8
 257 must be running on the server.
 258 .Bd -filled -offset indent
 259 .Fl tls
 260 requires that the client use TLS.
 261 .br
 262 .Fl tlscert
 263 requires that the client use TLS and provide a verifiable X.509 certificate
 264 during TLS handshake.
 265 .br
 266 .Fl tlscertuser
 267 requires that the client use TLS and provide a verifiable X.509 certificate.
 268 The otherName component of the certificate's subjAltName must have a
 269 an OID of 1.3.6.1.4.1.2238.1.1.1 and a UTF8 string of the form
 270 .Dq user@domain .
 271 .Dq user@domain
 272 will be translated to the credentials of the specified user in the same
 273 manner as
 274 .Xr nfsuserd 8 ,
 275 where
 276 .Dq user
 277 is normally a username is the server's password database and
 278 .Dq domain
 279 is the DNS domain name for the server.
 280 All RPCs will be performed using these credentials instead of the
 281 ones in the RPC header in a manner similar to
 282 .Sm off
 283 .Fl mapall Li = Sy user .
 284 .Sm on
 285 .Ed
 286 .Pp
 287 If none of these three flags are specified, TLS mounts are permitted but
 288 not required.
 289 .Pp
 290 Specifying the
 291 .Fl quiet
 292 option will inhibit some of the syslog diagnostics for bad lines in
 293 .Pa /etc/exports .
 294 This can be useful to avoid annoying error messages for known possible
 295 problems (see
 296 .Sx EXAMPLES
 297 below).
 298 .Pp
 299 The third component of a line specifies the host set to which the line applies.
 300 The set may be specified in three ways.
 301 The first way is to list the host name(s) separated by white space.
 302 (Standard Internet
 303 .Dq dot
 304 addresses may be used in place of names.)
 305 The second way is to specify a
 306 .Dq netgroup
 307 as defined in the
 308 .Pa netgroup
 309 file (see
 310 .Xr netgroup 5 ) .
 311 The third way is to specify an Internet subnetwork using a network and
 312 network mask that is defined as the set of all hosts with addresses within
 313 the subnetwork.
 314 This latter approach requires less overhead within the
 315 kernel and is recommended for cases where the export line refers to a
 316 large number of clients within an administrative subnet.
 317 .Pp
 318 The first two cases are specified by simply listing the name(s) separated
 319 by whitespace.
 320 All names are checked to see if they are
 321 .Dq netgroup
 322 names
 323 first and are assumed to be hostnames otherwise.
 324 Using the full domain specification for a hostname can normally
 325 circumvent the problem of a host that has the same name as a netgroup.
 326 The third case is specified by the flag
 327 .Sm off
 328 .Fl network Li = Sy netname Op Li / Ar prefixlength
 329 .Sm on
 330 and optionally
 331 .Sm off
 332 .Fl mask No = Sy netmask .
 333 .Sm on
 334 The netmask may be specified either by attaching a
 335 .Ar prefixlength
 336 to the
 337 .Fl network
 338 option, or by using a separate
 339 .Fl mask
 340 option.
 341 If the mask is not specified, it will default to the historical mask
 342 for that network class (A, B, or C; see
 343 .Xr inet 4 ) .
 344 This usage is deprecated, and will elicit a warning log message.
 345 See the
 346 .Sx EXAMPLES
 347 section below.
 348 .Pp
 349 Scoped IPv6 address must carry scope identifier as documented in
 350 .Xr inet6 4 .
 351 For example,
 352 .Dq Li fe80::%re2/10
 353 is used to specify
 354 .Li fe80::/10
 355 on
 356 .Li re2
 357 interface.
 358 .Pp
 359 For the third form which specifies the NFSv4 tree root, the directory path
 360 specifies the location within the server's file system tree which is the
 361 root of the NFSv4 tree.
 362 There can only be one NFSv4 root directory per server.
 363 As such, all entries of this form must specify the same directory path.
 364 For file systems other than ZFS,
 365 this location can be any directory and does not
 366 need to be within an exported file system.
 367 If it is not in an exported file system, a very limited set of operations
 368 are permitted, so that an NFSv4 client can traverse the tree to an
 369 exported file system.
 370 Although parts of the NFSv4 tree can be non-exported, the entire NFSv4 tree
 371 must consist of local file systems capable of being exported via NFS.
 372 All ZFS file systems in the subtree below the NFSv4 tree root must be
 373 exported.
 374 NFSv4 does not use the mount protocol and does permit clients to cross server
 375 mount point boundaries, although not all clients are capable of crossing the
 376 mount points.
 377 .Pp
 378 The
 379 .Fl sec
 380 option on these line(s) specifies what security flavors may be used for
 381 NFSv4 operations that do not use file handles.
 382 Since these operations (SetClientID, SetClientIDConfirm, Renew, DelegPurge
 383 and ReleaseLockOnwer) allocate/modify state in the server, it is possible
 384 to restrict some clients to the use of the krb5[ip] security flavors,
 385 via this option.
 386 See the
 387 .Sx EXAMPLES
 388 section below.
 389 This third form is meaningless for NFSv2 and NFSv3 and is ignored for them.
 390 .Pp
 391 The
 392 .Xr mountd 8
 393 utility can be made to re-read the
 394 .Nm
 395 file by sending it a hangup signal as follows:
 396 .Bd -literal -offset indent
 397 /etc/rc.d/mountd reload
 398 .Ed
 399 .Pp
 400 After sending the
 401 .Dv SIGHUP ,
 402 check the
 403 .Xr syslogd 8
 404 output to see whether
 405 .Xr mountd 8
 406 logged any parsing errors in the
 407 .Nm
 408 file.
 409 .Sh FILES
 410 .Bl -tag -width /etc/exports -compact
 411 .It Pa /etc/exports
 412 the default remote mount-point file
 413 .El
 414 .Sh EXAMPLES
 415 .Bd -literal -offset indent
 416 /usr /usr/local -maproot=0:10 friends
 417 /usr -maproot=daemon grumpy.cis.uoguelph.ca 131.104.48.16
 418 /usr -ro -mapall=nobody
 419 /u -maproot=bin: -network 131.104.48 -mask 255.255.255.0
 420 /a -network 192.168.0/24
 421 /a -network 3ffe:1ce1:1:fe80::/64
 422 /u2 -maproot=root friends
 423 /u2 -alldirs -network cis-net -mask cis-mask
 424 /cdrom -alldirs,quiet,ro -network 192.168.33.0 -mask 255.255.255.0
 425 /private -sec=krb5i
 426 /secret -sec=krb5p
 427 V4: /   -sec=krb5:krb5i:krb5p -network 131.104.48 -mask 255.255.255.0
 428 V4: /   -sec=sys:krb5:krb5i:krb5p grumpy.cis.uoguelph.ca
 429 .Ed
 430 .Pp
 431 Given that
 432 .Pa /usr , /u , /a
 433 and
 434 .Pa /u2
 435 are
 436 local file system mount points, the above example specifies the following:
 437 .Pp
 438 The file system rooted at
 439 .Pa /usr
 440 is exported to hosts
 441 .Em friends
 442 where friends is specified in the netgroup file
 443 with users mapped to their remote credentials and
 444 root mapped to UID 0 and group 10.
 445 It is exported read-write and the hosts in
 446 .Dq friends
 447 can mount either
 448 .Pa /usr
 449 or
 450 .Pa /usr/local .
 451 It 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 specification in
 595 .Rs
 596 .%T "Network File System Protocol Specification, Appendix A, RFC 1094"
 597 .%T "NFS: Network File System Version 3, Appendix I, RFC 1813"
 598 .%T "Towards Remote Procedure Call Encryption By Default, RFC nnnn"
 599 .Re
 600 .Sh BUGS
 601 The export options are tied to the local mount points in the kernel and
 602 must be non-contradictory for any exported subdirectory of the local
 603 server mount point.
 604 It is recommended that all exported directories within the same server
 605 file system be specified on adjacent lines going down the tree.
 606 You cannot specify a hostname that is also the name of a netgroup.
 607 Specifying the full domain specification for a hostname can normally
 608 circumvent the problem.