xref: /netbsd-src/usr.sbin/rpcbind/rpcbind.8 (revision 39c7ca3b3ad30eef2dc3b0c3c82b8d386366d040)
1.\" $NetBSD: rpcbind.8,v 1.15 2017/08/17 07:45:24 christos Exp $
2.\" @(#)rpcbind.1m 1.19 92/09/14 SMI; from SVr4
3.\" Copyright 1989 AT&T
4.\" Copyright 1991 Sun Microsystems, Inc.
5.\" $FreeBSD: head/usr.sbin/rpcbind/rpcbind.8 317163 2017-04-19 20:23:27Z ngie $
6.Dd August 17, 2017
7.Dt RPCBIND 8
8.Os
9.Sh NAME
10.Nm rpcbind
11.Nd universal addresses to RPC program number mapper
12.Sh SYNOPSIS
13.Nm
14.Op Fl 6adiLlsWw
15.Op Fl h Ar bindip
16.Sh DESCRIPTION
17The
18.Nm
19utility is a server that converts RPC program numbers into
20universal addresses.
21It must be running on the host to be able to make RPC calls
22on a server on that machine.
23.Pp
24When an RPC service is started,
25it tells
26.Nm
27the address at which it is listening,
28and the RPC program numbers it is prepared to serve.
29When a client wishes to make an RPC call to a given program number,
30it first contacts
31.Nm
32on the server machine to determine
33the address where RPC requests should be sent.
34.Pp
35The
36.Nm
37utility should be started before any other RPC service.
38Normally, standard RPC servers are started by port monitors, so
39.Nm
40must be started before port monitors are invoked.
41.Pp
42When
43.Nm
44is started, it checks that certain name-to-address
45translation-calls function correctly.
46If they fail, the network configuration databases may be corrupt.
47Since RPC services cannot function correctly in this situation,
48.Nm
49reports the condition and terminates.
50.Pp
51The
52.Nm
53utility can only be started by the super-user.
54.Pp
55Access control is provided by
56.Pa /etc/hosts.allow
57and
58.Pa /etc/hosts.deny ,
59as described in
60.Xr hosts_access 5
61with daemon name
62.Nm .
63.Sh OPTIONS
64.Bl -tag -width indent
65.It Fl 6
66Bind to AF_INET6 (IPv6) addresses only.
67.It Fl a
68When debugging
69.Pq Fl d ,
70abort on errors.
71.It Fl d
72Run in debug mode.
73In this mode,
74.Nm
75will not fork when it starts, will print additional information
76during operation, and will abort on certain errors if
77.Fl a
78is also specified.
79With this option, the name-to-address translation consistency
80checks are shown in detail.
81.It Fl h Ar bindip
82IP addresses to bind to when servicing TCP and UDP requests.
83This option
84may be specified multiple times and is typically necessary when running
85on a multi-homed host.
86If no
87.Fl h
88option is specified,
89.Nm
90will bind to
91.Dv INADDR_ANY ,
92which could lead to problems on a multi-homed host due to
93.Nm
94returning a UDP packet from a different IP address than it was
95sent to.
96Note that when specifying IP addresses with
97.Fl h ,
98.Nm
99will automatically add
100.Li 127.0.0.1
101and if IPv6 is enabled,
102.Li ::1
103to the list.
104.It Fl i
105.Dq Insecure
106mode.
107Allows calls to SET and UNSET from any host.
108Normally
109.Nm
110accepts these requests only from the loopback interface for security reasons.
111This change is necessary for programs that were compiled with earlier
112versions of the rpc library and do not make those requests using the
113loopback interface.
114.It Fl L
115Allows old-style local connections over the loopback interface.
116Without this flag, local connections are only allowed over a local socket,
117.Pa /var/run/rpcbind.sock .
118.It Fl l
119Turns on libwrap connection logging.
120.It Fl s
121Causes
122.Nm
123to change to the user daemon as soon as possible.
124This causes
125.Nm
126to use non-privileged ports for outgoing connections, preventing non-privileged
127clients from using
128.Nm
129to connect to services from a privileged port.
130.It Fl W
131Enable libwrap (TCP wrappers) support.
132.It Fl w
133Enable the warmstart feature.
134.Pp
135The warmstart feature saves RPC registrations on termination.
136Any saved RPC registrations are restored on restart if
137.Fl w
138is specified.
139This feature helps avoid RPC service interruption when restarting
140.Nm .
141warmstart support must be compiled in to
142.Nm .
143Portmap registrations are stored in
144.Pa /tmp/portmap.file .
145.Nm
146registrations are stored in
147.Pa /tmp/rpcbind.file .
148.El
149.Sh NOTES
150All RPC servers must be restarted if
151.Nm
152is restarted.
153.Sh FILES
154.Bl -tag -width "/var/run/rpcbind.sock" -compact
155.It Pa /var/run/portmap.file
156saved portmap registrations file.
157.It Pa /var/run/rpcbind.file
158saved
159.Nm
160registrations file.
161.It Pa /var/run/rpcbind.sock
162.It Pa /etc/hosts.allow
163explicit remote host access list.
164.It Pa /etc/hosts.deny
165explicit remote host denial of service list.
166.El
167.Sh SEE ALSO
168.Xr rpcbind 3 ,
169.Xr hosts_access 5 ,
170.Xr hosts_options 5 ,
171.Xr netconfig 5 ,
172.Xr rpcinfo 8
173