MFC r1.3 r1.13 r1.8 (HEAD):
[dragonfly.git] / usr.sbin / ypbind / ypbind.8
1 .\" Copyright (c) 1991, 1993, 1995
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 .\" $FreeBSD: src/usr.sbin/ypbind/ypbind.8,v 1.15.2.4 2003/03/11 22:31:35 trhodes Exp $
33 .\" $DragonFly: src/usr.sbin/ypbind/ypbind.8,v 1.2 2003/06/17 04:30:04 dillon Exp $
34 .\"
35 .Dd April 9, 1995
36 .Dt YPBIND 8
37 .Os
38 .Sh NAME
39 .Nm ypbind
40 .Nd "NIS domain binding daemon"
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl ypset
44 .Op Fl ypsetme
45 .Op Fl s
46 .Op Fl m
47 .Oo
48 .Fl S
49 .Sm off
50 .Ar domainname , server1 , server2 , ...
51 .Sm on
52 .Oc
53 .Sh DESCRIPTION
54 The
55 .Nm
56 utility is the process that maintains NIS binding information.
57 At startup,
58 it searches for an NIS server responsible for serving the system's
59 default domain (as set by the
60 .Xr domainname 1
61 command) using network broadcasts.
62 Once it receives a reply,
63 it will store the address of the server and other
64 information in a special file located in
65 .Pa /var/yp/binding .
66 The NIS routines in the standard C library can then use this file
67 when processing NIS requests.
68 There may be several such files
69 since it is possible for an NIS client to be bound to more than
70 one domain.
71 .Pp
72 After a binding has been established,
73 .Nm
74 will send DOMAIN_NONACK requests to the NIS server at one minute
75 intervals.
76 If it fails to receive a reply to one of these requests,
77 .Nm
78 assumes that the server is no longer running and resumes its network
79 broadcasts until another binding is established.
80 The
81 .Nm
82 utility will also log warning messages using the
83 .Xr syslog 3
84 facility each time it detects that a server has stopped responding,
85 as well as when it has bound to a new server.
86 .Pp
87 The following options are available:
88 .Bl -tag -width indent
89 .It Fl ypset
90 It is possible to force
91 .Nm
92 to bind to a particular NIS server host for a given domain by using the
93 .Xr ypset 8
94 command.
95 However,
96 .Nm
97 refuses YPBINDPROC_SETDOM requests by default since it has no way of
98 knowing exactly who is sending them.
99 Using the
100 .Fl ypset
101 flag causes
102 .Nm
103 to accept YPBINDPROC_SETDOM requests from any host.
104 This option should only
105 be used for diagnostic purposes and only for limited periods since allowing
106 arbitrary users to reset the binding of an NIS client poses a severe
107 security risk.
108 .It Fl ypsetme
109 This is similar to the
110 .Fl ypset
111 flag, except that it only permits YPBINDPROC_SETDOM requests to be processed
112 if they originated from the local host.
113 .It Fl s
114 Cause
115 .Nm
116 to run in secure mode: it will refuse to bind to any NIS server
117 that is not running as root (i.e. that is not using privileged
118 TCP ports).
119 .It Fl S Xo
120 .Sm off
121 .Ar domainname , server1 , server2 , server3 , ...
122 .Sm on
123 .Xc
124 Allow the system administrator to lock
125 .Nm
126 to a particular
127 domain and group of NIS servers.
128 Up to ten servers can be specified.
129 There must not be any spaces between the commas in the domain/server
130 specification.
131 This option is used to insure that the system binds
132 only to one domain and only to one of the specified servers, which
133 is useful for systems that are both NIS servers and NIS
134 clients: it provides a way to restrict what machines the system can
135 bind to without the need for specifying the
136 .Fl ypset
137 or
138 .Fl ypsetme
139 options, which are often considered to be security holes.
140 The specified
141 servers must have valid entries in the local
142 .Pa /etc/hosts
143 file. IP addresses may be specified in place of hostnames.
144 If
145 .Nm
146 can't make sense ouf of the arguments, it will ignore
147 the
148 .Fl S
149 flag and continue running normally.
150 .Pp
151 Note that
152 .Nm
153 will consider the domainname specified with the
154 .Fl S
155 flag to be the system default domain.
156 .It Fl m
157 Cause
158 .Nm
159 to use a 'many-cast' rather than a broadcast for choosing a server
160 from the restricted mode server list.
161 In many-cast mode,
162 .Nm
163 will transmit directly to the YPPROC_DOMAIN_NONACK procedure of the
164 servers specified in the restricted list and bind to the server that
165 responds the fastest.
166 This mode of operation is useful for NIS clients on remote subnets
167 where no local NIS servers are available.
168 The
169 .Fl m
170 flag can only be used in conjunction with the
171 .Fl S
172 flag above (if used without the
173 .Fl S
174 flag, it has no effect).
175 .El
176 .Sh NOTES
177 The
178 .Nm
179 utility will not make continuous attempts to keep secondary domains bound.
180 If a server for a secondary domain fails to respond to a ping,
181 .Nm
182 will broadcast for a new server only once before giving up.
183 If a
184 client program attempts to reference the unbound domain,
185 .Nm
186 will try broadcasting again.
187 By contrast,
188 .Nm
189 will automatically maintain a binding for the default domain whether
190 client programs reference it ot not.
191 .Sh FILES
192 .Bl -tag -width /etc/rc.conf -compact
193 .It Pa /var/yp/binding/[domainname].[version]
194 the files used to hold binding information for each NIS domain
195 .It Pa /etc/rc.conf
196 system configuration file where the system default domain and
197 ypbind startup options are specified
198 .El
199 .Sh SEE ALSO
200 .Xr domainname 1 ,
201 .Xr syslog 3 ,
202 .Xr yp 8 ,
203 .Xr ypserv 8 ,
204 .Xr ypset 8
205 .Sh AUTHORS
206 .An Theo de Raadt Aq deraadt@fsa.ca