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