usr.sbin/ypserv/ypserv.8

   1 .\" Copyright (c) 1995
   2 .\"     Bill Paul <wpaul@ctr.columbia.edu>.  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 Bill Paul.
  15 .\" 4. Neither the name of the author nor the names of any co-contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd February 3, 2008
  34 .Dt YPSERV 8
  35 .Os
  36 .Sh NAME
  37 .Nm ypserv
  38 .Nd NIS database server
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Op Fl n
  42 .Op Fl d
  43 .Op Fl P Ar port
  44 .Op Fl p Ar path
  45 .Sh DESCRIPTION
  46 .Tn NIS
  47 is an RPC-based service designed to allow a number of UNIX-based
  48 machines to share a common set of configuration files.
  49 Rather than
  50 requiring a system administrator to update several copies of files
  51 such as
  52 .Pa /etc/hosts ,
  53 .Pa /etc/passwd
  54 and
  55 .Pa /etc/group ,
  56 which tend to require frequent changes in most environments,
  57 .Tn NIS
  58 allows groups of computers to share one set of data which can be
  59 updated from a single location.
  60 .Pp
  61 The
  62 .Nm
  63 utility is the server that distributes
  64 .Tn NIS
  65 databases to client systems within an
  66 .Tn NIS
  67 .Em domain .
  68 Each client in an
  69 .Tn NIS
  70 domain must have its domainname set to
  71 one of the domains served by
  72 .Nm
  73 using the
  74 .Xr domainname 1
  75 command.
  76 The clients must also run
  77 .Xr ypbind 8
  78 in order to attach to a particular server, since it is possible to
  79 have several servers within a single
  80 .Tn NIS
  81 domain.
  82 .Pp
  83 The databases distributed by
  84 .Nm
  85 are stored in
  86 .Pa /var/yp/[domainname]
  87 where
  88 .Pa domainname
  89 is the name of the domain being served.
  90 There can be several
  91 such directories with different domainnames, and you need only one
  92 .Nm
  93 daemon to handle them all.
  94 .Pp
  95 The databases, or
  96 .Pa maps
  97 as they are often called,
  98 are created by
  99 .Pa /var/yp/Makefile
 100 using several system files as source.
 101 The database files are in
 102 .Xr db 3
 103 format to help speed retrieval when there are many records involved.
 104 In
 105 .Fx ,
 106 the maps are always readable and writable only by root for security
 107 reasons.
 108 Technically this is only necessary for the password
 109 maps, but since the data in the other maps can be found in
 110 other world-readable files anyway, it does not hurt and it is considered
 111 good general practice.
 112 .Pp
 113 The
 114 .Nm
 115 utility is started by
 116 .Pa /etc/rc.d/ypserv
 117 if it has been enabled in
 118 .Pa /etc/rc.conf .
 119 .Sh SPECIAL FEATURES
 120 There are some problems associated with distributing a
 121 .Fx
 122 password
 123 database via
 124 .Tn NIS :
 125 .Fx
 126 normally only stores encrypted passwords
 127 in
 128 .Pa /etc/master.passwd ,
 129 which is readable and writable only by root.
 130 By turning this file
 131 into an
 132 .Tn NIS
 133 map, this security feature would be completely defeated.
 134 .Pp
 135 To make up for this, the
 136 .Fx
 137 version of
 138 .Nm
 139 handles the
 140 .Pa master.passwd.byname
 141 and
 142 .Pa master.passwd.byuid
 143 maps in a special way.
 144 When the server receives a request to access
 145 either of these two maps, it will check the TCP port from which the
 146 request originated and return an error if the port number is greater
 147 than 1023.
 148 Since only the superuser is allowed to bind to TCP ports
 149 with values less than 1024, the server can use this test to determine
 150 whether or not the access request came from a privileged user.
 151 Any requests made by non-privileged users are therefore rejected.
 152 .Pp
 153 Furthermore, the
 154 .Xr getpwent 3
 155 routines in the
 156 .Fx
 157 standard C library will only attempt to retrieve
 158 data from the
 159 .Pa master.passwd.byname
 160 and
 161 .Pa master.passwd.byuid
 162 maps for the superuser: if a normal user calls any of these functions,
 163 the standard
 164 .Pa passwd.byname
 165 and
 166 .Pa passwd.byuid
 167 maps will be accessed instead.
 168 The latter two maps are constructed by
 169 .Pa /var/yp/Makefile
 170 by parsing the
 171 .Pa master.passwd
 172 file and stripping out the password fields, and are therefore
 173 safe to pass on to unprivileged users.
 174 In this way, the shadow password
 175 aspect of the protected
 176 .Pa master.passwd
 177 database is maintained through
 178 .Tn NIS .
 179 .Sh NOTES
 180 .Ss Setting Up Master and Slave Servers
 181 .Xr ypinit 8
 182 is a convenient script that will help setup master and slave
 183 .Tn NIS
 184 servers.
 185 .Ss Limitations
 186 There are two problems inherent with password shadowing in
 187 .Tn NIS
 188 that users should
 189 be aware of:
 190 .Bl -enum -offset indent
 191 .It
 192 The
 193 .Sq TCP port less than 1024
 194 test is trivial to defeat for users with
 195 unrestricted access to machines on your network (even those machines
 196 which do not run UNIX-based operating systems).
 197 .It
 198 If you plan to use a
 199 .Fx
 200 system to serve
 201 .No non- Ns Fx
 202 clients that
 203 have no support for password shadowing (which is most of them), you
 204 will have to disable the password shadowing entirely by uncommenting the
 205 .Em UNSECURE=True
 206 entry in
 207 .Pa /var/yp/Makefile .
 208 This will cause the standard
 209 .Pa passwd.byname
 210 and
 211 .Pa passwd.byuid
 212 maps to be generated with valid encrypted password fields, which is
 213 necessary in order for
 214 .No non- Ns Fx
 215 clients to perform user
 216 authentication through
 217 .Tn NIS .
 218 .El
 219 .Pp
 220 .Ss Security
 221 In general, any remote user can issue an RPC to
 222 .Nm
 223 and retrieve the contents of your
 224 .Tn NIS
 225 maps, provided the remote user
 226 knows your domain name.
 227 To prevent such unauthorized transactions,
 228 .Nm
 229 supports a feature called
 230 .Pa securenets
 231 which can be used to restrict access to a given set of hosts.
 232 At startup,
 233 .Nm
 234 will attempt to load the securenets information from a file
 235 called
 236 .Pa /var/yp/securenets .
 237 (Note that this path varies depending on the path specified with
 238 the
 239 .Fl p
 240 option, which is explained below.)
 241 This file contains entries
 242 that consist of a network specification and a network mask separated
 243 by white space.
 244 Lines starting with
 245 .Dq \&#
 246 are considered to be comments.
 247 A
 248 sample securenets file might look like this:
 249 .Bd -unfilled -offset indent
 250 # allow connections from local host -- mandatory
 251 127.0.0.1     255.255.255.255
 252 # allow connections from any host
 253 # on the 192.168.128.0 network
 254 192.168.128.0 255.255.255.0
 255 # allow connections from any host
 256 # between 10.0.0.0 to 10.0.15.255
 257 10.0.0.0      255.255.240.0
 258 .Ed
 259 .Pp
 260 If
 261 .Nm
 262 receives a request from an address that matches one of these rules,
 263 it will process the request normally.
 264 If the address fails to match
 265 a rule, the request will be ignored and a warning message will be
 266 logged.
 267 If the
 268 .Pa /var/yp/securenets
 269 file does not exist,
 270 .Nm
 271 will allow connections from any host.
 272 .Pp
 273 The
 274 .Nm
 275 utility also has support for Wietse Venema's
 276 .Em tcpwrapper
 277 package.
 278 This allows the administrator to use the tcpwrapper
 279 configuration files
 280 .Pa ( /etc/hosts.allow
 281 and
 282 .Pa /etc/hosts.deny )
 283 for access control instead of
 284 .Pa /var/yp/securenets .
 285 .Pp
 286 Note: while both of these access control mechanisms provide some
 287 security, they, like the privileged port test, are both vulnerable
 288 to
 289 .Dq IP spoofing
 290 attacks.
 291 .Pp
 292 .Ss NIS v1 compatibility
 293 This version of
 294 .Nm
 295 has some support for serving
 296 .Tn NIS
 297 v1 clients.
 298 The
 299 .Fx
 300 .Tn NIS
 301 implementation only uses the
 302 .Tn NIS
 303 v2 protocol, however other implementations
 304 include support for the v1 protocol for backwards compatibility
 305 with older systems.
 306 The
 307 .Xr ypbind 8
 308 daemons supplied with these systems will try to establish a binding
 309 to an
 310 .Tn NIS
 311 v1 server even though they may never actually need it (and they may
 312 persist in broadcasting in search of one even after they receive a
 313 response from a v2 server).
 314 Note that while
 315 support for normal client calls is provided, this version of
 316 .Nm
 317 does not handle v1 map transfer requests; consequently, it cannot
 318 be used as a master or slave in conjunction with older
 319 .Tn NIS
 320 servers that
 321 only support the v1 protocol.
 322 Fortunately, there probably are not any
 323 such servers still in use today.
 324 .Ss NIS servers that are also NIS clients
 325 Care must be taken when running
 326 .Nm
 327 in a multi-server domain where the server machines are also
 328 .Tn NIS
 329 clients.
 330 It is generally a good idea to force the servers to
 331 bind to themselves rather than allowing them to broadcast bind
 332 requests and possibly become bound to each other: strange failure
 333 modes can result if one server goes down and
 334 others are dependent upon on it.
 335 (Eventually all the clients will
 336 time out and attempt to bind to other servers, but the delay
 337 involved can be considerable and the failure mode is still present
 338 since the servers might bind to each other all over again).
 339 .Pp
 340 Refer to the
 341 .Xr ypbind 8
 342 man page for details on how to force it to bind to a particular
 343 server.
 344 .Sh OPTIONS
 345 The following options are supported by
 346 .Nm :
 347 .Bl -tag -width flag
 348 .It Fl n
 349 This option affects the way
 350 .Nm
 351 handles yp_match requests for the
 352 .Pa hosts.byname
 353 and
 354 .Pa hosts.byaddress
 355 maps.
 356 By default, if
 357 .Nm
 358 cannot find an entry for a given host in its hosts maps, it will
 359 return an error and perform no further processing.
 360 With the
 361 .Fl n
 362 flag,
 363 .Nm
 364 will go one step further: rather than giving up immediately, it
 365 will try to resolve the hostname or address using a DNS nameserver
 366 query.
 367 If the query is successful,
 368 .Nm
 369 will construct a fake database record and return it to the client,
 370 thereby making it seem as though the client's yp_match request
 371 succeeded.
 372 .Pp
 373 This feature is provided for compatibility with SunOS 4.1.x,
 374 which has brain-damaged resolver functions in its standard C
 375 library that depend on
 376 .Tn NIS
 377 for hostname and address resolution.
 378 The
 379 .Fx
 380 resolver can be configured to do DNS
 381 queries directly, therefore it is not necessary to enable this
 382 option when serving only
 383 .Fx
 384 .Tn NIS
 385 clients.
 386 .It Fl d
 387 Cause the server to run in debugging mode.
 388 Normally,
 389 .Nm
 390 reports only unusual errors (access violations, file access failures)
 391 using the
 392 .Xr syslog 3
 393 facility.
 394 In debug mode, the server does not background
 395 itself and prints extra status messages to stderr for each
 396 request that it receives.
 397 Also, while running in debug mode,
 398 .Nm
 399 will not spawn any additional subprocesses as it normally does
 400 when handling yp_all requests or doing DNS lookups.
 401 (These actions
 402 often take a fair amount of time to complete and are therefore handled
 403 in subprocesses, allowing the parent server process to go on handling
 404 other requests.)
 405 This makes it easier to trace the server with
 406 a debugging tool.
 407 .It Fl P Ar port
 408 Force ypserv to bind to a specific TCP/UDP port, rather than selecting
 409 its own.
 410 .It Fl p Ar path
 411 Normally,
 412 .Nm
 413 assumes that all
 414 .Tn NIS
 415 maps are stored under
 416 .Pa /var/yp .
 417 The
 418 .Fl p
 419 flag may be used to specify an alternate
 420 .Tn NIS
 421 root path, allowing
 422 the system administrator to move the map files to a different place
 423 within the file system.
 424 .El
 425 .Sh FILES
 426 .Bl -tag -width Pa -compact
 427 .It Pa /var/yp/[domainname]/[maps]
 428 the
 429 .Tn NIS
 430 maps
 431 .It Pa /etc/nsswitch.conf
 432 name switch configuration file
 433 .It Pa /var/yp/securenets
 434 host access control file
 435 .El
 436 .Sh SEE ALSO
 437 .Xr ypcat 1 ,
 438 .Xr db 3 ,
 439 .Xr hosts_access 5 ,
 440 .Xr rpc.yppasswdd 8 ,
 441 .Xr yp 8 ,
 442 .Xr ypbind 8 ,
 443 .Xr ypinit 8 ,
 444 .Xr yppush 8 ,
 445 .Xr ypxfr 8
 446 .Sh HISTORY
 447 This version of
 448 .Nm
 449 first appeared in
 450 .Fx 2.2 .
 451 .Sh AUTHORS
 452 .An Bill Paul Aq wpaul@ctr.columbia.edu