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 2012-04-23 "Linux" "Linux Programmer's Manual"
  40 .SH NAME
  41 rexec, rfexec_af \- 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 .sp
  50 .BI "int rexec_af(char **" ahost ", int " inport ", char *" user ", "
  51 .BI "             char *" passwd ", char *" cmd ", int *" fd2p ,
  52 .BI "             sa_family_t " af  );
  53 .fi
  54 .SH DESCRIPTION
  55 This interface is obsoleted by
  56 .BR rcmd (3).
  57
  58 The
  59 .BR rexec ()
  60 function
  61 looks up the host
  62 .IR *ahost
  63 using
  64 .BR gethostbyname (3),
  65 returning \-1 if the host does not exist.
  66 Otherwise
  67 .IR *ahost
  68 is set to the standard name of the host.
  69 If a username and password are both specified, then these
  70 are used to authenticate to the foreign host; otherwise
  71 the environment and then the user's
  72 .I .netrc
  73 file in his
  74 home directory are searched for appropriate information.
  75 If all this fails, the user is prompted for the information.
  76 .PP
  77 The port
  78 .I inport
  79 specifies which well-known DARPA Internet port to use for
  80 the connection; the call
  81 .I "getservbyname(""exec"", ""tcp"")"
  82 (see
  83 .BR getservent (3))
  84 will return a pointer to a structure that contains the necessary port.
  85 The protocol for connection is described in detail in
  86 .BR rexecd (8).
  87 .PP
  88 If the connection succeeds,
  89 a socket in the Internet domain of type
  90 .BR SOCK_STREAM
  91 is returned to
  92 the caller, and given to the remote command as
  93 .IR stdin
  94 and
  95 .IR stdout .
  96 If
  97 .I fd2p
  98 is nonzero, then an auxiliary channel to a control
  99 process will be setup, and a descriptor for it will be placed
 100 in
 101 .IR *fd2p .
 102 The control process will return diagnostic
 103 output from the command (unit 2) on this channel, and will also
 104 accept bytes on this channel as being UNIX signal numbers, to be
 105 forwarded to the process group of the command.
 106 The diagnostic
 107 information returned does not include remote authorization failure,
 108 as the secondary connection is set up after authorization has been
 109 verified.
 110 If
 111 .I fd2p
 112 is 0, then the
 113 .IR stderr
 114 (unit 2 of the remote
 115 command) will be made the same as the
 116 .IR stdout
 117 and no
 118 provision is made for sending arbitrary signals to the remote process,
 119 although you may be able to get its attention by using out-of-band data.
 120 .SS rexec_af()
 121 The
 122 .BR rexec ()
 123 function works over IPv4
 124 .RB ( AF_INET ).
 125 By contrast, the
 126 .BR rexec_af ()
 127 function provides an extra argument,
 128 .IR af ,
 129 that allows the caller to select the protocol.
 130 This argument can be specified as
 131 .BR AF_INET ,
 132 .BR AF_INET6 ,
 133 or
 134 .BR AF_UNSPEC
 135 (to allow the implementation to select the protocol).
 136 .SH VERSIONS
 137 The
 138 .BR rexec_af ()
 139 function was added to glibc in version 2.2.
 140 .SH "CONFORMING TO"
 141 These functions are not in POSIX.1-2001.
 142 The
 143 .BR rexec ()
 144 function first appeared in
 145 4.2BSD, and is present on the BSDs, Solaris, and many other systems.
 146 The
 147 .BR rexec_af ()
 148 function is more recent, nad less widespread.
 149 .SH BUGS
 150 The
 151 .BR rexec ()
 152 function sends the unencrypted password across the network.
 153 .PP
 154 The underlying service is considered a big security hole and therefore
 155 not enabled on many sites; see
 156 .BR rexecd (8)
 157 for explanations.
 158 .SH SEE ALSO
 159 .BR rcmd (3),
 160 .BR rexecd (8)