lib/libc/net/rcmd.3

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     From: @(#)rcmd.3        8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD: src/lib/libc/net/rcmd.3,v 1.27 2008/12/14 22:48:48 murray Exp $
  30 .\"
  31 .Dd May 5, 2019
  32 .Dt RCMD 3
  33 .Os
  34 .Sh NAME
  35 .Nm rcmd ,
  36 .Nm rresvport ,
  37 .Nm iruserok ,
  38 .Nm ruserok ,
  39 .Nm rcmd_af ,
  40 .Nm rresvport_af ,
  41 .Nm iruserok_sa
  42 .Nd routines for returning a stream to a remote command
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In unistd.h
  47 .Ft int
  48 .Fn rcmd "char **ahost" "int inport" "const char *locuser" "const char *remuser" "const char *cmd" "int *fd2p"
  49 .Ft int
  50 .Fn rresvport "int *port"
  51 .Ft int
  52 .Fn iruserok "u_long raddr" "int superuser" "const char *ruser" "const char *luser"
  53 .Ft int
  54 .Fn ruserok "const char *rhost" "int superuser" "const char *ruser" "const char *luser"
  55 .Ft int
  56 .Fn rcmd_af "char **ahost" "int inport" "const char *locuser" "const char *remuser" "const char *cmd" "int *fd2p" "int af"
  57 .Ft int
  58 .Fn rresvport_af "int *port" "int af"
  59 .Ft int
  60 .Fn iruserok_sa "const void *addr" "int addrlen" "int superuser" "const char *ruser" "const char *luser"
  61 .Sh DESCRIPTION
  62 The
  63 .Fn rcmd
  64 function
  65 is used by the super-user to execute a command on
  66 a remote machine using an authentication scheme based
  67 on reserved port numbers.
  68 The
  69 .Fn rresvport
  70 function
  71 returns a descriptor to a socket
  72 with an address in the privileged port space.
  73 The
  74 .Fn ruserok
  75 function
  76 is used by servers
  77 to authenticate clients requesting service with
  78 .Fn rcmd .
  79 All three functions are present in the same file and are used
  80 by the
  81 .Xr rshd 8 Pq Pa net/bsdrcmds
  82 server (among others).
  83 .Pp
  84 The
  85 .Fn rcmd
  86 function
  87 looks up the host
  88 .Fa *ahost
  89 using
  90 .Xr gethostbyname 3 ,
  91 returning -1 if the host does not exist.
  92 Otherwise
  93 .Fa *ahost
  94 is set to the standard name of the host
  95 and a connection is established to a server
  96 residing at the well-known Internet port
  97 .Fa inport .
  98 .Pp
  99 If the connection succeeds,
 100 a socket in the Internet domain of type
 101 .Dv SOCK_STREAM
 102 is returned to the caller, and given to the remote
 103 command as
 104 .Dv stdin
 105 and
 106 .Dv stdout .
 107 If
 108 .Fa fd2p
 109 is non-zero, then an auxiliary channel to a control
 110 process will be set up, and a descriptor for it will be placed
 111 in
 112 .Fa *fd2p .
 113 The control process will return diagnostic
 114 output from the command (unit 2) on this channel, and will also
 115 accept bytes on this channel as being
 116 .Ux
 117 signal numbers, to be
 118 forwarded to the process group of the command.
 119 If
 120 .Fa fd2p
 121 is 0, then the
 122 .Dv stderr
 123 (unit 2 of the remote
 124 command) will be made the same as the
 125 .Dv stdout
 126 and no
 127 provision is made for sending arbitrary signals to the remote process,
 128 although you may be able to get its attention by using out-of-band data.
 129 .Pp
 130 The protocol is described in detail in
 131 .Xr rshd 8 .
 132 .Pp
 133 The
 134 .Fn rresvport
 135 function is used to obtain a socket to which an address with a Privileged
 136 Internet port is bound.
 137 This socket is suitable for use by
 138 .Fn rcmd
 139 and several other functions.
 140 Privileged Internet ports are those in the range 0 to 1023.
 141 Only the super-user is allowed to bind an address of this sort
 142 to a socket.
 143 .Pp
 144 The
 145 .Fn iruserok
 146 and
 147 .Fn ruserok
 148 functions take a remote host's IP address or name, as returned by the
 149 .Xr gethostbyname 3
 150 routines, two user names and a flag indicating whether the local user's
 151 name is that of the super-user.
 152 Then, if the user is
 153 .Em NOT
 154 the super-user, it checks the
 155 .Pa /etc/hosts.equiv
 156 file.
 157 If that lookup is not done, or is unsuccessful, the
 158 .Pa .rhosts
 159 in the local user's home directory is checked to see if the request for
 160 service is allowed.
 161 .Pp
 162 If this file does not exist, is not a regular file, is owned by anyone
 163 other than the user or the super-user, or is writable by anyone other
 164 than the owner, the check automatically fails.
 165 Zero is returned if the machine name is listed in the
 166 .Dq Pa hosts.equiv
 167 file, or the host and remote user name are found in the
 168 .Dq Pa .rhosts
 169 file; otherwise
 170 .Fn iruserok
 171 and
 172 .Fn ruserok
 173 return -1.
 174 If the local domain (as obtained from
 175 .Xr gethostname 3 )
 176 is the same as the remote domain, only the machine name need be specified.
 177 .Pp
 178 The
 179 .Fn iruserok
 180 function is strongly preferred for security reasons.
 181 It requires trusting the local DNS at most, while the
 182 .Fn ruserok
 183 function requires trusting the entire DNS, which can be spoofed.
 184 .Pp
 185 The functions with an
 186 .Dq Li _af
 187 or
 188 .Dq Li _sa
 189 suffix, i.e.,
 190 .Fn rcmd_af ,
 191 .Fn rresvport_af
 192 and
 193 .Fn iruserok_sa ,
 194 work the same as the corresponding functions without a
 195 suffix, except that they are capable of handling both IPv6 and IPv4 ports.
 196 .Pp
 197 The
 198 .Dq Li _af
 199 suffix means that the function has an additional
 200 .Fa af
 201 argument which is used to specify the address family,
 202 (see below).
 203 The
 204 .Fa af
 205 argument extension is implemented for functions
 206 that have no binary address argument.
 207 Instead, the
 208 .Fa af
 209 argument specifies which address family is desired.
 210 .Pp
 211 The
 212 .Dq Li _sa
 213 suffix means that the function has general socket address and
 214 length arguments.
 215 As the socket address is a protocol independent data structure,
 216 IPv4 and IPv6 socket address can be passed as desired.
 217 The
 218 .Fa sa
 219 argument extension is implemented for functions
 220 that pass a protocol dependent binary address argument.
 221 The argument needs to be replaced with a more general address structure
 222 to support multiple address families in a general way.
 223 .Pp
 224 The functions with neither an
 225 .Dq Li _af
 226 suffix nor an
 227 .Dq Li _sa
 228 suffix work for IPv4 only, except for
 229 .Fn ruserok
 230 which can handle both IPv6 and IPv4.
 231 To switch the address family, the
 232 .Fa af
 233 argument must be filled with
 234 .Dv AF_INET ,
 235 or
 236 .Dv AF_INET6 .
 237 For
 238 .Fn rcmd_af ,
 239 .Dv PF_UNSPEC
 240 is also allowed.
 241 .Sh RETURN VALUES
 242 The
 243 .Fn rcmd
 244 function
 245 returns a valid socket descriptor on success.
 246 It returns -1 on error and prints a diagnostic message
 247 on the standard error.
 248 .Pp
 249 The
 250 .Fn rresvport
 251 function
 252 returns a valid, bound socket descriptor on success.
 253 It returns -1 on error with the global value
 254 .Va errno
 255 set according to the reason for failure.
 256 The error code
 257 .Er EAGAIN
 258 is overloaded to mean ``All network ports in use.''
 259 .Sh ENVIRONMENT
 260 .Bl -tag -width RSH
 261 .It Ev RSH
 262 When using the
 263 .Fn rcmd
 264 function, this variable is used as the program to run instead of
 265 .Xr rsh 1 Pq Pa net/bsdrcmds .
 266 .El
 267 .Sh SEE ALSO
 268 .Xr rlogin 1 Pq Pa net/bsdrcmds ,
 269 .Xr rsh 1 ,
 270 .Xr intro 2 ,
 271 .Xr rlogind 8 Pq Pa net/bsdrcmds ,
 272 .Xr rshd 8
 273 .Rs
 274 .%A W. Stevens
 275 .%A M. Thomas
 276 .%T "Advanced Socket API for IPv6"
 277 .%O RFC 2292
 278 .Re
 279 .Rs
 280 .%A W. Stevens
 281 .%A M. Thomas
 282 .%A E. Nordmark
 283 .%T "Advanced Socket API for IPv6"
 284 .%O RFC 3542
 285 .Re
 286 .Sh HISTORY
 287 Most of these
 288 functions appeared in
 289 .Bx 4.2 .
 290 The
 291 .Fn rresvport_af
 292 function
 293 appeared in RFC 2292, and was implemented by the WIDE project
 294 for the Hydrangea IPv6 protocol stack kit.
 295 The
 296 .Fn rcmd_af
 297 function
 298 appeared in draft-ietf-ipngwg-rfc2292bis-01.txt,
 299 and was implemented in the WIDE/KAME IPv6 protocol stack kit.
 300 The
 301 .Fn iruserok_sa
 302 function
 303 appeared in discussion on the IETF ipngwg mailing list,
 304 and was implemented in
 305 .Fx 4.0 .