lib/libcompat/4.3/rexec.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 .\" 4. 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 .\"     @(#)rexec.3     8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD: src/lib/libcompat/4.3/rexec.3,v 1.5.2.4 2001/08/17 15:42:56 ru Exp $
  30 .\" $DragonFly: src/lib/libcompat/4.3/rexec.3,v 1.3 2007/07/30 22:11:33 swildner Exp $
  31 .\"
  32 .Dd June 4, 1993
  33 .Dt REXEC 3
  34 .Os
  35 .Sh NAME
  36 .Nm rexec
  37 .Nd return stream to a remote command
  38 .Sh LIBRARY
  39 .Lb libcompat
  40 .Sh SYNOPSIS
  41 .Ft int
  42 .Fn rexec "char **ahost" "int inport" "char *user" "char *passwd" "char *cmd" "int *fd2p"
  43 .Sh DESCRIPTION
  44 .Bf -symbolic
  45 This interface is obsoleted by
  46 .Xr rcmd 3 .
  47 .Ef
  48 .Pp
  49 The
  50 .Fn rexec
  51 function
  52 looks up the host
  53 .Fa *ahost
  54 using
  55 .Xr gethostbyname 3 ,
  56 returning \-1 if the host does not exist.
  57 Otherwise
  58 .Fa *ahost
  59 is set to the standard name of the host.
  60 If a username and password are both specified, then these
  61 are used to authenticate to the foreign host; otherwise
  62 the environment and then the user's
  63 .Pa .netrc
  64 file in his
  65 home directory are searched for appropriate information.
  66 If all this fails, the user is prompted for the information.
  67 .Pp
  68 The port
  69 .Fa inport
  70 specifies which well-known
  71 .Tn DARPA
  72 Internet port to use for
  73 the connection; the call
  74 .Fn getservbyname \*qexec\*q \*qtcp\*q
  75 (see
  76 .Xr getservent 3 )
  77 will return a pointer to a structure, which contains the
  78 necessary port.
  79 The protocol for connection is described in detail in
  80 .Xr rexecd 8 .
  81 .Pp
  82 If the connection succeeds,
  83 a socket in the Internet domain of type
  84 .Dv SOCK_STREAM
  85 is returned to
  86 the caller, and given to the remote command as
  87 .Em stdin
  88 and
  89 .Em stdout .
  90 If
  91 .Fa fd2p
  92 is non-zero, then an auxiliary channel to a control
  93 process will be setup, and a descriptor for it will be placed
  94 in
  95 .Fa *fd2p .
  96 The control process will return diagnostic
  97 output from the command (unit 2) on this channel, and will also
  98 accept bytes on this channel as being
  99 .Ux
 100 signal numbers, to be
 101 forwarded to the process group of the command.  The diagnostic
 102 information returned does not include remote authorization failure,
 103 as the secondary connection is set up after authorization has been
 104 verified.
 105 If
 106 .Fa fd2p
 107 is 0, then the
 108 .Em stderr
 109 (unit 2 of the remote
 110 command) will be made the same as the
 111 .Em stdout
 112 and no
 113 provision is made for sending arbitrary signals to the remote process,
 114 although you may be able to get its attention by using out-of-band data.
 115 .Sh SEE ALSO
 116 .Xr rcmd 3 ,
 117 .Xr rexecd 8
 118 .Sh HISTORY
 119 The
 120 .Fn rexec
 121 function appeared in
 122 .Bx 4.2 .
 123 .Sh BUGS
 124 The
 125 .Fn rexec
 126 function sends the unencrypted password across the network.
 127 .Pp
 128 The underlying service is considered a big security hole and therefore
 129 not enabled on many sites, see
 130 .Xr rexecd 8
 131 for explanations.