xref: /freebsd/lib/libc/net/rcmdsh.3 (revision 3642298923e528d795e3a30ec165d2b469e28b40)
1.\"	$OpenBSD: rcmdsh.3,v 1.6 1999/07/05 04:41:00 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.\" $FreeBSD$
35.\"
36.Dd September 1, 1996
37.Dt RCMDSH 3
38.Os
39.Sh NAME
40.Nm rcmdsh
41.Nd return a stream to a remote command without superuser
42.Sh SYNOPSIS
43.In unistd.h
44.Ft int
45.Fo rcmdsh
46.Fa "char **ahost"
47.Fa "int inport"
48.Fa "const char *locuser"
49.Fa "const char *remuser"
50.Fa "const char *cmd"
51.Fa "const char *rshprog"
52.Fc
53.Sh DESCRIPTION
54The
55.Fn rcmdsh
56function
57is used by normal users to execute a command on
58a remote machine using an authentication scheme based
59on reserved port numbers using
60.Xr rshd 8
61or the value of
62.Fa rshprog
63(if
64.No non- Ns Dv NULL ) .
65.Pp
66The
67.Fn rcmdsh
68function
69looks up the host
70.Fa *ahost
71using
72.Xr gethostbyname 3 ,
73returning \-1 if the host does not exist.
74Otherwise
75.Fa *ahost
76is set to the standard name of the host
77and a connection is established to a server
78residing at the well-known Internet port
79.Dq Li shell/tcp
80(or whatever port is used by
81.Fa rshprog ) .
82The
83.Fa inport
84argument
85is ignored; it is only included to provide an interface similar to
86.Xr rcmd 3 .
87.Pp
88If the connection succeeds,
89a socket in the
90.Ux
91domain of type
92.Dv SOCK_STREAM
93is returned to the caller, and given to the remote
94command as
95.Dv stdin , stdout ,
96and
97.Dv stderr .
98.Sh RETURN VALUES
99The
100.Fn rcmdsh
101function
102returns a valid socket descriptor on success.
103Otherwise, \-1 is returned
104and a diagnostic message is printed on the standard error.
105.Sh SEE ALSO
106.Xr rsh 1 ,
107.Xr socketpair 2 ,
108.Xr rcmd 3 ,
109.Xr rshd 8
110.Sh HISTORY
111The
112.Fn rcmdsh
113function first appeared in
114.Ox 2.0 ,
115and made its way into
116.Fx 4.6 .
117.Sh BUGS
118If
119.Xr rsh 1
120encounters an error, a file descriptor is still returned instead of \-1.
121