usr.sbin/mountd/netgroup.5

   1 .\" Copyright (c) 1992, 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 December 11, 1993
  29 .Dt NETGROUP 5
  30 .Os
  31 .Sh NAME
  32 .Nm netgroup
  33 .Nd defines network groups
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Sh DESCRIPTION
  37 The
  38 .Nm
  39 file
  40 specifies ``netgroups'', which are sets of
  41 .Sy (host, user, domain)
  42 tuples that are to be given similar network access.
  43 .Pp
  44 Each line in the file
  45 consists of a netgroup name followed by a list of the members of the
  46 netgroup.
  47 Each member can be either the name of another netgroup or a specification
  48 of a tuple as follows:
  49 .Bd -literal -offset indent
  50 (host, user, domain)
  51 .Ed
  52 .Pp
  53 where the
  54 .Sy host ,
  55 .Sy user ,
  56 and
  57 .Sy domain
  58 are character string names for the corresponding component.
  59 Any of the comma separated fields may be empty to specify a ``wildcard'' value
  60 or may consist of the string ``-'' to specify ``no valid value''.
  61 The members of the list may be separated by whitespace and/or commas;
  62 the ``\e'' character may be used at the end of a line to specify
  63 line continuation.
  64 Lines are limited to 1024 characters.
  65 The functions specified in
  66 .Xr getnetgrent 3
  67 should normally be used to access the
  68 .Nm
  69 database.
  70 .Pp
  71 Lines that begin with a # are treated as comments.
  72 .Sh NIS/YP INTERACTION
  73 On most other platforms,
  74 .Nm Ns s
  75 are only used in conjunction with
  76 .Tn NIS
  77 and local
  78 .Pa /etc/netgroup
  79 files are ignored.
  80 With
  81 .Fx ,
  82 .Nm Ns s
  83 can be used with either
  84 .Tn NIS
  85 or local files, but there are certain
  86 caveats to consider.
  87 The existing
  88 .Nm
  89 system is extremely inefficient where
  90 .Fn innetgr 3
  91 lookups are concerned since
  92 .Nm
  93 memberships are computed on the fly.
  94 By contrast, the
  95 .Tn NIS
  96 .Nm
  97 database consists of three separate maps (netgroup, netgroup.byuser
  98 and netgroup.byhost) that are keyed to allow
  99 .Fn innetgr 3
 100 lookups to be done quickly.
 101 The
 102 .Fx
 103 .Nm
 104 system can interact with the
 105 .Tn NIS
 106 .Nm
 107 maps in the following ways:
 108 .Bl -bullet -offset indent
 109 .It
 110 If the
 111 .Pa /etc/netgroup
 112 file does not exist, or it exists and is empty, or
 113 it exists and contains only a
 114 .Sq + ,
 115 and
 116 .Tn NIS
 117 is running,
 118 .Nm
 119 lookups will be done exclusively through
 120 .Tn NIS ,
 121 with
 122 .Fn innetgr 3
 123 taking advantage of the netgroup.byuser and
 124 netgroup.byhost maps to speed up searches.
 125 (This
 126 is more or less compatible with the behavior of SunOS and
 127 similar platforms.)
 128 .It
 129 If the
 130 .Pa /etc/netgroup
 131 exists and contains only local
 132 .Nm
 133 information (with no
 134 .Tn NIS
 135 .Sq +
 136 token), then only the local
 137 .Nm
 138 information will be processed (and
 139 .Tn NIS
 140 will be ignored).
 141 .It
 142 If
 143 .Pa /etc/netgroup
 144 exists and contains both local netgroup data
 145 .Pa and
 146 the
 147 .Tn NIS
 148 .Sq +
 149 token, the local data and the
 150 .Tn NIS
 151 netgroup
 152 map will be processed as a single combined
 153 .Nm
 154 database.
 155 While this configuration is the most flexible, it
 156 is also the least efficient: in particular,
 157 .Fn innetgr 3
 158 lookups will be especially slow if the
 159 database is large.
 160 .El
 161 .Sh FILES
 162 .Bl -tag -width /etc/netgroup -compact
 163 .It Pa /etc/netgroup
 164 the netgroup database
 165 .El
 166 .Sh COMPATIBILITY
 167 The file format is compatible with that of various vendors, however it
 168 appears that not all vendors use an identical format.
 169 .Sh SEE ALSO
 170 .Xr getnetgrent 3 ,
 171 .Xr exports 5
 172 .Sh BUGS
 173 The interpretation of access restrictions based on the member tuples of a
 174 netgroup is left up to the various network applications.
 175 Also, it is not obvious how the domain specification
 176 applies to the
 177 .Bx
 178 environment.
 179 .Pp
 180 The
 181 .Nm
 182 database should be stored in the form of a
 183 hashed
 184 .Xr db 3
 185 database just like the
 186 .Xr passwd 5
 187 database to speed up reverse lookups.