xref: /openbsd-src/lib/libc/net/rcmdsh.3 (revision b2ea75c1b17e1a9a339660e7ed45cd24946b230e)
1.\"	$OpenBSD: rcmdsh.3,v 1.8 2000/12/24 00:30:56 aaron Exp $
2.\"
3.\" Copyright (c) 1983, 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.Dd September 1, 1996
35.Dt RCMDSH 3
36.Os
37.Sh NAME
38.Nm rcmdsh
39.Nd return a stream to a remote command without superuser
40.Sh SYNOPSIS
41.Fd #include <unistd.h>
42.Ft int
43.Fn rcmdsh "char **ahost" "int inport" "const char *locuser" "const char *remuser" "const char *cmd" "char *rshprog"
44.Sh DESCRIPTION
45The
46.Fn rcmdsh
47function is used by normal users to execute a command on a remote machine
48using an authentication scheme based on reserved port numbers using
49.Xr rshd 8
50or the value of
51.Fa rshprog
52(if non-null).
53.Pp
54The
55.Fn rcmdsh
56function looks up the host
57.Fa *ahost
58using
59.Xr gethostbyname 3 ,
60returning \-1 if the host does not exist.
61Otherwise
62.Fa *ahost
63is set to the standard name of the host and a connection is established to
64a server residing at the well-known Internet port
65.Li shell/tcp
66(or whatever port is used by
67.Fa rshprog ) .
68The parameter
69.Fa inport
70is ignored; it is only included to provide an interface similar to
71.Xr rcmd 3 .
72.Pp
73If the connection succeeds, a socket in the
74.Tn UNIX
75domain of type
76.Dv SOCK_STREAM
77is returned to the caller, and given to the remote
78command as stdin and stdout, and stderr.
79.Sh DIAGNOSTICS
80The
81.Fn rcmdsh
82function returns a valid socket descriptor on success.
83It returns \-1 on error and prints a diagnostic message on the standard error.
84.Sh SEE ALSO
85.Xr rsh 1 ,
86.Xr socketpair 2 ,
87.Xr rcmd 3 ,
88.Xr rshd 8
89.Sh BUGS
90If
91.Xr rsh 1
92encounters an error, a file descriptor is still returned instead of \-1.
93.Sh HISTORY
94The
95.Fn rcmdsh
96function first appeared in
97.Ox 2.0 .
98