usr.sbin/rpcbind/rpcbind.8

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