original/man3/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 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)rexec.3     8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libcompat/4.3/rexec.3,v 1.12 2004/07/02 23:52:14 ru Exp $
  34 .\"
  35 .\" Taken from FreeBSD 5.4; not checked against Linux reality (mtk)
  36 .\"
  37 .\" 2007-12-08, mtk, Converted from mdoc to man macros
  38 .\"
  39 .TH REXEC 3 2007-12-28 "Linux" "Linux Programmer's Manual"
  40 .SH NAME
  41 rexec \- return stream to a remote command
  42 .SH SYNOPSIS
  43 .nf
  44 .sp
  45 .BI "int rexec(char **" ahost ", int " inport ", char *" user ", "
  46 .BI "          char *" passwd ", char *" cmd ", int *" fd2p );
  47 .\" This function requires _BSD_SOURCE on Linux
  48 .fi
  49 .SH DESCRIPTION
  50 This interface is obsoleted by
  51 .BR rcmd (3).
  52
  53 The
  54 .BR rexec ()
  55 function
  56 looks up the host
  57 .IR *ahost
  58 using
  59 .BR gethostbyname (3),
  60 returning \-1 if the host does not exist.
  61 Otherwise
  62 .IR *ahost
  63 is set to the standard name of the host.
  64 If a username and password are both specified, then these
  65 are used to authenticate to the foreign host; otherwise
  66 the environment and then the user's
  67 .I .netrc
  68 file in his
  69 home directory are searched for appropriate information.
  70 If all this fails, the user is prompted for the information.
  71 .PP
  72 The port
  73 .I inport
  74 specifies which well-known DARPA Internet port to use for
  75 the connection; the call
  76 .I "getservbyname(""exec"", ""tcp"")"
  77 (see
  78 .BR getservent (3))
  79 will return a pointer to a structure that contains the necessary port.
  80 The protocol for connection is described in detail in
  81 .BR rexecd (8).
  82 .PP
  83 If the connection succeeds,
  84 a socket in the Internet domain of type
  85 .BR SOCK_STREAM
  86 is returned to
  87 the caller, and given to the remote command as
  88 .IR stdin
  89 and
  90 .IR stdout .
  91 If
  92 .I fd2p
  93 is nonzero, then an auxiliary channel to a control
  94 process will be setup, and a descriptor for it will be placed
  95 in
  96 .IR *fd2p .
  97 The control process will return diagnostic
  98 output from the command (unit 2) on this channel, and will also
  99 accept bytes on this channel as being
 100 Unix
 101 signal numbers, to be
 102 forwarded to the process group of the command.
 103 The diagnostic
 104 information returned does not include remote authorization failure,
 105 as the secondary connection is set up after authorization has been
 106 verified.
 107 If
 108 .I fd2p
 109 is 0, then the
 110 .IR stderr
 111 (unit 2 of the remote
 112 command) will be made the same as the
 113 .IR stdout
 114 and no
 115 provision is made for sending arbitrary signals to the remote process,
 116 although you may be able to get its attention by using out-of-band data.
 117 .SH "CONFORMING TO"
 118 Not in POSIX.1-2001.
 119 Present on the BSDs, Solaris, and many other systems.
 120 The
 121 .BR rexec ()
 122 function appeared in
 123 4.2BSD.
 124 .SH BUGS
 125 The
 126 .BR rexec ()
 127 function sends the unencrypted password across the network.
 128 .PP
 129 The underlying service is considered a big security hole and therefore
 130 not enabled on many sites, see
 131 .BR rexecd (8)
 132 for explanations.
 133 .SH SEE ALSO
 134 .BR rcmd (3),
 135 .BR rexecd (8)