[apple/libc.git] / net / rcmdsh.3

.\"	$OpenBSD: rcmdsh.3,v 1.6 1999/07/05 04:41:00 aaron Exp $
.\"
.\" Copyright (c) 1983, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD: src/lib/libc/net/rcmdsh.3,v 1.2 2001/11/09 15:19:25 ru Exp $
.\"
.Dd September 1, 1996
.Dt RCMDSH 3
.Os
.Sh NAME
.Nm rcmdsh
.Nd return a stream to a remote command without superuser
.Sh SYNOPSIS
.In unistd.h
.Ft int
.Fo rcmdsh
.Fa "char **ahost"
.Fa "int inport"
.Fa "const char *locuser"
.Fa "const char *remuser"
.Fa "const char *cmd"
.Fa "const char *rshprog"
.Fc
.Sh DESCRIPTION
The
.Fn rcmdsh
function
is used by normal users to execute a command on
a remote machine using an authentication scheme based
on reserved port numbers using
.Xr rshd 8
or the value of
.Fa rshprog
(if
.No non- Ns Dv NULL ) .
.Pp
The
.Fn rcmdsh
function
looks up the host
.Fa *ahost
using
.Xr gethostbyname 3 ,
returning \-1 if the host does not exist.
Otherwise
.Fa *ahost
is set to the standard name of the host
and a connection is established to a server
residing at the well-known Internet port
.Dq Li shell/tcp
(or whatever port is used by
.Fa rshprog ) .
The parameter
.Fa inport
is ignored; it is only included to provide an interface similar to
.Xr rcmd 3 .
.Pp
If the connection succeeds,
a socket in the
.Ux
domain of type
.Dv SOCK_STREAM
is returned to the caller, and given to the remote
command as stdin, stdout, and stderr.
.Sh RETURN VALUES
The
.Fn rcmdsh
function
returns a valid socket descriptor on success.
Otherwise, \-1 is returned
and a diagnostic message is printed on the standard error.
.Sh SEE ALSO
.Xr rsh 1 ,
.Xr socketpair 2 ,
.Xr rcmd 3 ,
.Xr rshd 8
.Sh BUGS
If
.Xr rsh 1
encounters an error, a file descriptor is still returned instead of \-1.
.Sh HISTORY
The
.Fn rcmdsh
function first appeared in
.Ox 2.0 ,
and made its way into
.Fx 5.0 .
Commit	Line	Data
5b2abdfb A	1	.\" $OpenBSD: rcmdsh.3,v 1.6 1999/07/05 04:41:00 aaron Exp $
	2	.\"
	3	.\" Copyright (c) 1983, 1991, 1993
e9ce8d39 A	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	.\"
5b2abdfb	34	.\" $FreeBSD: src/lib/libc/net/rcmdsh.3,v 1.2 2001/11/09 15:19:25 ru Exp $
e9ce8d39	35	.\"
5b2abdfb A	36	.Dd September 1, 1996
5b2abdfb A	37	.Dt RCMDSH 3
e9ce8d39 A	38	.Os
e9ce8d39 A	39	.Sh NAME
5b2abdfb A	40	.Nm rcmdsh
5b2abdfb A	41	.Nd return a stream to a remote command without superuser
e9ce8d39	42	.Sh SYNOPSIS
5b2abdfb	43	.In unistd.h
e9ce8d39	44	.Ft int
5b2abdfb A	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
e9ce8d39 A	53	.Sh DESCRIPTION
e9ce8d39 A	54	The
5b2abdfb A	55	.Fn rcmdsh
	56	function
	57	is used by normal users to execute a command on
	58	a remote machine using an authentication scheme based
	59	on reserved port numbers using
	60	.Xr rshd 8
	61	or the value of
	62	.Fa rshprog
	63	(if
	64	.No non- Ns Dv NULL ) .
	65	.Pp
e9ce8d39	66	The
5b2abdfb A	67	.Fn rcmdsh
	68	function
	69	looks up the host
	70	.Fa *ahost
	71	using
	72	.Xr gethostbyname 3 ,
	73	returning \-1 if the host does not exist.
	74	Otherwise
	75	.Fa *ahost
	76	is set to the standard name of the host
	77	and a connection is established to a server
	78	residing at the well-known Internet port
	79	.Dq Li shell/tcp
	80	(or whatever port is used by
	81	.Fa rshprog ) .
	82	The parameter
	83	.Fa inport
	84	is ignored; it is only included to provide an interface similar to
	85	.Xr rcmd 3 .
	86	.Pp
	87	If the connection succeeds,
	88	a socket in the
	89	.Ux
	90	domain of type
	91	.Dv SOCK_STREAM
	92	is returned to the caller, and given to the remote
	93	command as stdin, stdout, and stderr.
e9ce8d39	94	.Sh RETURN VALUES
5b2abdfb A	95	The
	96	.Fn rcmdsh
	97	function
	98	returns a valid socket descriptor on success.
	99	Otherwise, \-1 is returned
	100	and a diagnostic message is printed on the standard error.
e9ce8d39	101	.Sh SEE ALSO
5b2abdfb A	102	.Xr rsh 1 ,
	103	.Xr socketpair 2 ,
	104	.Xr rcmd 3 ,
	105	.Xr rshd 8
	106	.Sh BUGS
	107	If
	108	.Xr rsh 1
	109	encounters an error, a file descriptor is still returned instead of \-1.
e9ce8d39 A	110	.Sh HISTORY
e9ce8d39 A	111	The
5b2abdfb	112	.Fn rcmdsh
e9ce8d39	113	function first appeared in
5b2abdfb A	114	.Ox 2.0 ,
	115	and made its way into
	116	.Fx 5.0 .