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