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 .\" 4. 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 June 30, 2008
  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 The second is to specify the pathname of the root of the file system
  76 followed by the
  77 .Fl alldirs
  78 flag;
  79 this form allows the host(s) to mount at any point within the file system,
  80 including regular files if the
  81 .Fl r
  82 option is used on
  83 .Xr mountd 8 .
  84 The third form has the string ``V4:'' followed by a single absolute path
  85 name, to sepcify the NFSv4 tree root.
  86 The pathnames must not have any symbolic links in them and should not have
  87 any
  88 .Dq Pa \&.
  89 or
  90 .Dq Pa ..
  91 components.
  92 Mount points for a file system may appear on multiple lines each with
  93 different sets of hosts and export options.
  94 .Pp
  95 The second component of a line specifies how the file system is to be
  96 exported to the host set.
  97 The option flags specify whether the file system
  98 is exported read-only or read-write and how the client UID is mapped to
  99 user credentials on the server.
 100 For the NFSv4 tree root, the only option that can be specified in this
 101 section is
 102 .Fl sec .
 103 .Pp
 104 Export options are specified as follows:
 105 .Pp
 106 .Sm off
 107 .Fl maproot Li = Sy user
 108 .Sm on
 109 The credential of the specified user is used for remote access by root.
 110 The credential includes all the groups to which the user is a member
 111 on the local machine (see
 112 .Xr id 1 ) .
 113 The user may be specified by name or number.
 114 .Pp
 115 .Sm off
 116 .Fl maproot Li = Sy user:group1:group2:...
 117 .Sm on
 118 The colon separated list is used to specify the precise credential
 119 to be used for remote access by root.
 120 The elements of the list may be either names or numbers.
 121 Note that user: should be used to distinguish a credential containing
 122 no groups from a complete credential for that user.
 123 .Pp
 124 .Sm off
 125 .Fl mapall Li = Sy user
 126 .Sm on
 127 or
 128 .Sm off
 129 .Fl mapall Li = Sy user:group1:group2:...
 130 .Sm on
 131 specifies a mapping for all client UIDs (including root)
 132 using the same semantics as
 133 .Fl maproot .
 134 .Pp
 135 The option
 136 .Fl r
 137 is a synonym for
 138 .Fl maproot
 139 in an effort to be backward compatible with older export file formats.
 140 .Pp
 141 In the absence of
 142 .Fl maproot
 143 and
 144 .Fl mapall
 145 options, remote accesses by root will result in using a credential of -2:-2.
 146 All other users will be mapped to their remote credential.
 147 If a
 148 .Fl maproot
 149 option is given,
 150 remote access by root will be mapped to that credential instead of -2:-2.
 151 If a
 152 .Fl mapall
 153 option is given,
 154 all users (including root) will be mapped to that credential in
 155 place of their own.
 156 .Pp
 157 .Sm off
 158 .Fl sec Li = Sy flavor1:flavor2...
 159 .Sm on
 160 specifies a colon separated list of acceptable security flavors to be
 161 used for remote access.
 162 Supported security flavors are sys, krb5, krb5i and krb5p.
 163 If multiple flavors are listed, they should be ordered with the most
 164 preferred flavor first.
 165 If this option is not present,
 166 the default security flavor list of just sys is used.
 167 .Pp
 168 The
 169 .Fl ro
 170 option specifies that the file system should be exported read-only
 171 (default read/write).
 172 The option
 173 .Fl o
 174 is a synonym for
 175 .Fl ro
 176 in an effort to be backward compatible with older export file formats.
 177 .Pp
 178 .Tn WebNFS
 179 exports strictly according to the spec (RFC 2054 and RFC 2055) can
 180 be done with the
 181 .Fl public
 182 flag.
 183 However, this flag in itself allows r/w access to all files in
 184 the file system, not requiring reserved ports and not remapping UIDs.
 185 It
 186 is only provided to conform to the spec, and should normally not be used.
 187 For a
 188 .Tn WebNFS
 189 export,
 190 use the
 191 .Fl webnfs
 192 flag, which implies
 193 .Fl public ,
 194 .Sm off
 195 .Fl mapall No = Sy nobody
 196 .Sm on
 197 and
 198 .Fl ro .
 199 Note that only one file system can be
 200 .Tn WebNFS
 201 exported on a server.
 202 .Pp
 203 A
 204 .Sm off
 205 .Fl index No = Pa file
 206 .Sm on
 207 option can be used to specify a file whose handle will be returned if
 208 a directory is looked up using the public filehandle
 209 .Pq Tn WebNFS .
 210 This is to mimic the behavior of URLs.
 211 If no
 212 .Fl index
 213 option is specified, a directory filehandle will be returned as usual.
 214 The
 215 .Fl index
 216 option only makes sense in combination with the
 217 .Fl public
 218 or
 219 .Fl webnfs
 220 flags.
 221 .Pp
 222 Specifying the
 223 .Fl quiet
 224 option will inhibit some of the syslog diagnostics for bad lines in
 225 .Pa /etc/exports .
 226 This can be useful to avoid annoying error messages for known possible
 227 problems (see
 228 .Sx EXAMPLES
 229 below).
 230 .Pp
 231 The third component of a line specifies the host set to which the line applies.
 232 The set may be specified in three ways.
 233 The first way is to list the host name(s) separated by white space.
 234 (Standard Internet
 235 .Dq dot
 236 addresses may be used in place of names.)
 237 The second way is to specify a
 238 .Dq netgroup
 239 as defined in the
 240 .Pa netgroup
 241 file (see
 242 .Xr netgroup 5 ) .
 243 The third way is to specify an Internet subnetwork using a network and
 244 network mask that is defined as the set of all hosts with addresses within
 245 the subnetwork.
 246 This latter approach requires less overhead within the
 247 kernel and is recommended for cases where the export line refers to a
 248 large number of clients within an administrative subnet.
 249 .Pp
 250 The first two cases are specified by simply listing the name(s) separated
 251 by whitespace.
 252 All names are checked to see if they are
 253 .Dq netgroup
 254 names
 255 first and are assumed to be hostnames otherwise.
 256 Using the full domain specification for a hostname can normally
 257 circumvent the problem of a host that has the same name as a netgroup.
 258 The third case is specified by the flag
 259 .Sm off
 260 .Fl network Li = Sy netname Op Li / Ar prefixlength
 261 .Sm on
 262 and optionally
 263 .Sm off
 264 .Fl mask No = Sy netmask .
 265 .Sm on
 266 The netmask may be specified either by attaching a
 267 .Ar prefixlength
 268 to the
 269 .Fl network
 270 option, or by using a separate
 271 .Fl mask
 272 option.
 273 If the mask is not specified, it will default to the mask for that network
 274 class (A, B or C; see
 275 .Xr inet 4 ) .
 276 See the
 277 .Sx EXAMPLES
 278 section below.
 279 .Pp
 280 Scoped IPv6 address must carry scope identifier as documented in
 281 .Xr inet6 4 .
 282 For example,
 283 .Dq Li fe80::%re2/10
 284 is used to specify
 285 .Li fe80::/10
 286 on
 287 .Li re2
 288 interface.
 289 .Pp
 290 For the third form which specifies the NFSv4 tree root, the directory path
 291 specifies the location within the server's file system tree which is the
 292 root of the NFSv4 tree.
 293 All entries of this form must specify the same directory path.
 294 This location can be any directory and does not
 295 need to be within an exported file system. If it is not in an exported
 296 file system, a very limited set of operations are permitted, so that an
 297 NFSv4 client can traverse the tree to an exported file system.
 298 Although parts of the NFSv4 tree can be non-exported, the entire NFSv4 tree
 299 must consist of local file systems capable of being exported via NFS.
 300 NFSv4 does not use the mount protocol and does permit clients to cross server
 301 mount point boundaries, although not all clients are capable of crossing the
 302 mount points.
 303 .Pp
 304 The
 305 .Fl sec
 306 option on these line(s) specifies what security flavors may be used for
 307 NFSv4 operations that do not use file handles. Since these operations
 308 (SetClientID, SetClientIDConfirm, Renew, DelegPurge and ReleaseLockOnwer)
 309 allocate/modify state in the server, it is possible to restrict some clients to
 310 the use of the krb5[ip] security flavors, via this option.
 311 See the
 312 .Sx EXAMPLES
 313 section below.
 314 This third form is meaningless for NFSv2 and NFSv3 and is ignored for them.
 315 .Pp
 316 The
 317 .Xr mountd 8
 318 utility can be made to re-read the
 319 .Nm
 320 file by sending it a hangup signal as follows:
 321 .Bd -literal -offset indent
 322 /etc/rc.d/mountd reload
 323 .Ed
 324 .Pp
 325 After sending the
 326 .Dv SIGHUP ,
 327 check the
 328 .Xr syslogd 8
 329 output to see whether
 330 .Xr mountd 8
 331 logged any parsing errors in the
 332 .Nm
 333 file.
 334 .Sh FILES
 335 .Bl -tag -width /etc/exports -compact
 336 .It Pa /etc/exports
 337 the default remote mount-point file
 338 .El
 339 .Sh EXAMPLES
 340 .Bd -literal -offset indent
 341 /usr /usr/local -maproot=0:10 friends
 342 /usr -maproot=daemon grumpy.cis.uoguelph.ca 131.104.48.16
 343 /usr -ro -mapall=nobody
 344 /u -maproot=bin: -network 131.104.48 -mask 255.255.255.0
 345 /a -network 192.168.0/24
 346 /a -network 3ffe:1ce1:1:fe80::/64
 347 /u2 -maproot=root friends
 348 /u2 -alldirs -network cis-net -mask cis-mask
 349 /cdrom -alldirs,quiet,ro -network 192.168.33.0 -mask 255.255.255.0
 350 /private -sec=krb5i
 351 /secret -sec=krb5p
 352 V4: /   -sec=krb5:krb5i:krb5p -network 131.104.48 -mask 255.255.255.0
 353 V4: /   -sec=sys:krb5:krb5i:krb5p grumpy.cis.uoguelph.ca
 354 .Ed
 355 .Pp
 356 Given that
 357 .Pa /usr , /u , /a
 358 and
 359 .Pa /u2
 360 are
 361 local file system mount points, the above example specifies the following:
 362 .Pp
 363 The file system rooted at
 364 .Pa /usr
 365 is exported to hosts
 366 .Em friends
 367 where friends is specified in the netgroup file
 368 with users mapped to their remote credentials and
 369 root mapped to UID 0 and group 10.
 370 It is exported read-write and the hosts in
 371 .Dq friends
 372 can mount either
 373 .Pa /usr
 374 or
 375 .Pa /usr/local .
 376 It is exported to
 377 .Em 131.104.48.16
 378 and
 379 .Em grumpy.cis.uoguelph.ca
 380 with users mapped to their remote credentials and
 381 root mapped to the user and groups associated with
 382 .Dq daemon ;
 383 it is exported to the rest of the world as read-only with
 384 all users mapped to the user and groups associated with
 385 .Dq nobody .
 386 .Pp
 387 The file system rooted at
 388 .Pa /u
 389 is exported to all hosts on the subnetwork
 390 .Em 131.104.48
 391 with root mapped to the UID for
 392 .Dq bin
 393 and with no group access.
 394 .Pp
 395 The file system rooted at
 396 .Pa /u2
 397 is exported to the hosts in
 398 .Dq friends
 399 with root mapped to UID and groups
 400 associated with
 401 .Dq root ;
 402 it is exported to all hosts on network
 403 .Dq cis-net
 404 allowing mounts at any
 405 directory within /u2.
 406 .Pp
 407 The file system rooted at
 408 .Pa /a
 409 is exported to the network 192.168.0.0, with a netmask of 255.255.255.0.
 410 However, the netmask length in the entry for
 411 .Pa /a
 412 is not specified through a
 413 .Fl mask
 414 option, but through the
 415 .Li / Ns Ar prefix
 416 notation.
 417 .Pp
 418 The file system rooted at
 419 .Pa /a
 420 is also exported to the IPv6 network
 421 .Li 3ffe:1ce1:1:fe80::
 422 address, using the upper 64 bits as the prefix.
 423 Note that, unlike with IPv4 network addresses, the specified network
 424 address must be complete, and not just contain the upper bits.
 425 With IPv6 addresses, the
 426 .Fl mask
 427 option must not be used.
 428 .Pp
 429 The file system rooted at
 430 .Pa /cdrom
 431 will be exported read-only to the entire network 192.168.33.0/24, including
 432 all its subdirectories.
 433 Since
 434 .Pa /cdrom
 435 is the conventional mountpoint for a CD-ROM device, this export will
 436 fail if no CD-ROM medium is currently mounted there since that line
 437 would then attempt to export a subdirectory of the root file system
 438 with the
 439 .Fl alldirs
 440 option which is not allowed.
 441 The
 442 .Fl quiet
 443 option will then suppress the error message for this condition that
 444 would normally be syslogged.
 445 As soon as an actual CD-ROM is going to be mounted,
 446 .Xr mount 8
 447 will notify
 448 .Xr mountd 8
 449 about this situation, and the
 450 .Pa /cdrom
 451 file system will be exported as intended.
 452 Note that without using the
 453 .Fl alldirs
 454 option, the export would always succeed.
 455 While there is no CD-ROM medium mounted under
 456 .Pa /cdrom ,
 457 it would export the (normally empty) directory
 458 .Pa /cdrom
 459 of the root file system instead.
 460 .Pp
 461 The file system rooted at
 462 .Pa /private
 463 will be exported using Kerberos 5 authentication and will require
 464 integrity protected messages for all accesses.
 465 The file system rooted at
 466 .Pa /secret
 467 will also be exported using Kerberos 5 authentication and all messages
 468 used to access it will be encrypted.
 469 .Pp
 470 For the experimental server, the NFSv4 tree is rooted at ``/'',
 471 and any client within the 131.104.48 subnet is permitted to perform NFSv4 state
 472 operations on the server, so long as valid Kerberos credentials are provided.
 473 The machine grumpy.cis.uoguelph.ca is permitted to perform NFSv4 state
 474 operations on the server using AUTH_SYS credentials, as well as Kerberos ones.
 475 .Sh SEE ALSO
 476 .Xr netgroup 5 ,
 477 .Xr mountd 8 ,
 478 .Xr nfsd 8 ,
 479 .Xr showmount 8
 480 .Sh BUGS
 481 The export options are tied to the local mount points in the kernel and
 482 must be non-contradictory for any exported subdirectory of the local
 483 server mount point.
 484 It is recommended that all exported directories within the same server
 485 file system be specified on adjacent lines going down the tree.
 486 You cannot specify a hostname that is also the name of a netgroup.
 487 Specifying the full domain specification for a hostname can normally
 488 circumvent the problem.