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 2010-09-10 "Linux" "Linux Programmer's Manual"
  40 .SH NAME
  41 rexec \- return stream to a remote command
  42 .SH SYNOPSIS
  43 .nf
  44 .BR "#define _BSD_SOURCE" "             /* See feature_test_macros(7) */"
  45 .B #include <netdb.h>
  46 .sp
  47 .BI "int rexec(char **" ahost ", int " inport ", char *" user ", "
  48 .BI "          char *" passwd ", char *" cmd ", int *" fd2p );
  49 .fi
  50 .SH DESCRIPTION
  51 This interface is obsoleted by
  52 .BR rcmd (3).
  53
  54 The
  55 .BR rexec ()
  56 function
  57 looks up the host
  58 .IR *ahost
  59 using
  60 .BR gethostbyname (3),
  61 returning \-1 if the host does not exist.
  62 Otherwise
  63 .IR *ahost
  64 is set to the standard name of the host.
  65 If a username and password are both specified, then these
  66 are used to authenticate to the foreign host; otherwise
  67 the environment and then the user's
  68 .I .netrc
  69 file in his
  70 home directory are searched for appropriate information.
  71 If all this fails, the user is prompted for the information.
  72 .PP
  73 The port
  74 .I inport
  75 specifies which well-known DARPA Internet port to use for
  76 the connection; the call
  77 .I "getservbyname(""exec"", ""tcp"")"
  78 (see
  79 .BR getservent (3))
  80 will return a pointer to a structure that contains the necessary port.
  81 The protocol for connection is described in detail in
  82 .BR rexecd (8).
  83 .PP
  84 If the connection succeeds,
  85 a socket in the Internet domain of type
  86 .BR SOCK_STREAM
  87 is returned to
  88 the caller, and given to the remote command as
  89 .IR stdin
  90 and
  91 .IR stdout .
  92 If
  93 .I fd2p
  94 is nonzero, then an auxiliary channel to a control
  95 process will be setup, and a descriptor for it will be placed
  96 in
  97 .IR *fd2p .
  98 The control process will return diagnostic
  99 output from the command (unit 2) on this channel, and will also
 100 accept bytes on this channel as being UNIX signal numbers, to be
 101 forwarded to the process group of the command.
 102 The diagnostic
 103 information returned does not include remote authorization failure,
 104 as the secondary connection is set up after authorization has been
 105 verified.
 106 If
 107 .I fd2p
 108 is 0, then the
 109 .IR stderr
 110 (unit 2 of the remote
 111 command) will be made the same as the
 112 .IR stdout
 113 and no
 114 provision is made for sending arbitrary signals to the remote process,
 115 although you may be able to get its attention by using out-of-band data.
 116 .SH "CONFORMING TO"
 117 Not in POSIX.1-2001.
 118 Present on the BSDs, Solaris, and many other systems.
 119 The
 120 .BR rexec ()
 121 function appeared in
 122 4.2BSD.
 123 .SH BUGS
 124 The
 125 .BR 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 .BR rexecd (8)
 131 for explanations.
 132 .SH SEE ALSO
 133 .BR rcmd (3),
 134 .BR rexecd (8)