GC !__DragonFly__ section.
[dragonfly.git] / 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. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)netgroup.5  8.2 (Berkeley) 12/11/93
33 .\" $FreeBSD: src/sbin/mountd/netgroup.5,v 1.10.2.2 2001/07/22 11:32:30 dd Exp $
34 .\" $DragonFly: src/sbin/mountd/netgroup.5,v 1.3 2004/03/11 12:28:54 hmp Exp $
35 .\"
36 .Dd December 11, 1993
37 .Dt NETGROUP 5
38 .Os
39 .Sh NAME
40 .Nm netgroup
41 .Nd defines network groups
42 .Sh SYNOPSIS
43 .Nm
44 .Sh DESCRIPTION
45 The
46 .Nm
47 file
48 specifies ``netgroups'', which are sets of
49 .Sy (host, user, domain)
50 tuples that are to be given similar network access.
51 .Pp
52 Each line in the file
53 consists of a netgroup name followed by a list of the members of the
54 netgroup.
55 Each member can be either the name of another netgroup or a specification
56 of a tuple as follows:
57 .Bd -literal -offset indent
58 (host, user, domain)
59 .Ed
60 .Pp
61 where the
62 .Sy host ,
63 .Sy user ,
64 and
65 .Sy domain
66 are character string names for the corresponding component.
67 Any of the comma separated fields may be empty to specify a ``wildcard'' value
68 or may consist of the string ``-'' to specify ``no valid value''.
69 The members of the list may be separated by whitespace and/or commas;
70 the ``\e'' character may be used at the end of a line to specify
71 line continuation.
72 Lines are limited to 1024 characters.
73 The functions specified in
74 .Xr getnetgrent 3
75 should normally be used to access the
76 .Nm
77 database.
78 .Pp
79 Lines that begin with a # are treated as comments.
80 .Sh NIS/YP INTERACTION
81 On most other platforms,
82 .Nm Ns s
83 are only used in conjunction with
84 .Tn NIS
85 and local
86 .Pa /etc/netgroup
87 files are ignored.
88 With
89 .Dx ,
90 .Nm Ns s
91 can be used with either
92 .Tn NIS
93 or local files, but there are certain
94 caveats to consider.
95 The existing
96 .Nm
97 system is extremely inefficient where
98 .Fn innetgr 3
99 lookups are concerned since
100 .Nm
101 memberships are computed on the fly.
102 By contrast, the
103 .Tn NIS
104 .Nm
105 database consists of three separate maps (netgroup, netgroup.byuser
106 and netgroup.byhost) that are keyed to allow
107 .Fn innetgr 3
108 lookups to be done quickly.
109 The
110 .Dx
111 .Nm
112 system can interact with the
113 .Tn NIS
114 .Nm
115 maps in the following ways:
116 .Bl -bullet -offset indent
117 .It
118 If the
119 .Pa /etc/netgroup
120 file does not exist, or it exists and is empty, or
121 it exists and contains only a
122 .Sq + ,
123 and
124 .Tn NIS
125 is running,
126 .Nm
127 lookups will be done exclusively through
128 .Tn NIS ,
129 with
130 .Fn innetgr 3
131 taking advantage of the netgroup.byuser and
132 netgroup.byhost maps to speed up searches.
133 (This
134 is more or less compatible with the behavior of SunOS and
135 similar platforms.)
136 .It
137 If the
138 .Pa /etc/netgroup
139 exists and contains only local
140 .Nm
141 information (with no
142 .Tn NIS
143 .Sq +
144 token), then only the local
145 .Nm
146 information will be processed (and
147 .Tn NIS
148 will be ignored).
149 .It
150 If
151 .Pa /etc/netgroup
152 exists and contains both local netgroup data
153 .Pa and
154 the
155 .Tn NIS
156 .Sq +
157 token, the local data and the
158 .Tn NIS
159 netgroup
160 map will be processed as a single combined
161 .Nm
162 database.
163 While this configuration is the most flexible, it
164 is also the least efficient: in particular,
165 .Fn innetgr 3
166 lookups will be especially slow if the
167 database is large.
168 .El
169 .Sh FILES
170 .Bl -tag -width /etc/netgroup -compact
171 .It Pa /etc/netgroup
172 the netgroup database
173 .El
174 .Sh SEE ALSO
175 .Xr getnetgrent 3 ,
176 .Xr exports 5
177 .Sh COMPATIBILITY
178 The file format is compatible with that of various vendors, however it
179 appears that not all vendors use an identical format.
180 .Sh BUGS
181 The interpretation of access restrictions based on the member tuples of a
182 netgroup is left up to the various network applications.
183 Also, it is not obvious how the domain specification
184 applies to the
185 .Bx
186 environment.
187 .Pp
188 The
189 .Nm
190 database should be stored in the form of a
191 hashed
192 .Xr db 3
193 database just like the
194 .Xr passwd 5
195 database to speed up reverse lookups.