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