1 .\" Copyright (c) 1983, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .\" From: @(#)rcmd.3 8.1 (Berkeley) 6/4/93
46 .Nd routines for returning a stream to a remote command
52 .Fn rcmd "char **ahost" "int inport" "const char *locuser" "const char *remuser" "const char *cmd" "int *fd2p"
54 .Fn rresvport "int *port"
56 .Fn iruserok "u_long raddr" "int superuser" "const char *ruser" "const char *luser"
58 .Fn ruserok "const char *rhost" "int superuser" "const char *ruser" "const char *luser"
60 .Fn rcmd_af "char **ahost" "int inport" "const char *locuser" "const char *remuser" "const char *cmd" "int *fd2p" "int af"
62 .Fn rresvport_af "int *port" "int af"
64 .Fn iruserok_sa "const void *addr" "int addrlen" "int superuser" "const char *ruser" "const char *luser"
69 is used by the super-user to execute a command on
70 a remote machine using an authentication scheme based
71 on reserved port numbers.
75 returns a descriptor to a socket
76 with an address in the privileged port space.
81 to authenticate clients requesting service with
83 All three functions are present in the same file and are used
86 server (among others).
95 returning -1 if the host does not exist.
98 is set to the standard name of the host
99 and a connection is established to a server
100 residing at the well-known Internet port
103 If the connection succeeds,
104 a socket in the Internet domain of type
106 is returned to the caller, and given to the remote
113 is non-zero, then an auxiliary channel to a control
114 process will be set up, and a descriptor for it will be placed
117 The control process will return diagnostic
118 output from the command (unit 2) on this channel, and will also
119 accept bytes on this channel as being
121 signal numbers, to be
122 forwarded to the process group of the command.
127 (unit 2 of the remote
128 command) will be made the same as the
131 provision is made for sending arbitrary signals to the remote process,
132 although you may be able to get its attention by using out-of-band data.
134 The protocol is described in detail in
139 function is used to obtain a socket to which an address with a Privileged
140 Internet port is bound.
141 This socket is suitable for use by
143 and several other functions.
144 Privileged Internet ports are those in the range 0 to 1023.
145 Only the super-user is allowed to bind an address of this sort
152 functions take a remote host's IP address or name, as returned by the
154 routines, two user names and a flag indicating whether the local user's
155 name is that of the super-user.
158 the super-user, it checks the
161 If that lookup is not done, or is unsuccessful, the
163 in the local user's home directory is checked to see if the request for
166 If this file does not exist, is not a regular file, is owned by anyone
167 other than the user or the super-user, or is writable by anyone other
168 than the owner, the check automatically fails.
169 Zero is returned if the machine name is listed in the
171 file, or the host and remote user name are found in the
178 If the local domain (as obtained from
180 is the same as the remote domain, only the machine name need be specified.
184 function is strongly preferred for security reasons.
185 It requires trusting the local DNS at most, while the
187 function requires trusting the entire DNS, which can be spoofed.
189 The functions with an
198 work the same as the corresponding functions without a
199 suffix, except that they are capable of handling both IPv6 and IPv4 ports.
203 suffix means that the function has an additional
205 argument which is used to specify the address family,
209 argument extension is implemented for functions
210 that have no binary address argument.
213 argument specifies which address family is desired.
217 suffix means that the function has general socket address and
219 As the socket address is a protocol independent data structure,
220 IPv4 and IPv6 socket address can be passed as desired.
223 argument extension is implemented for functions
224 that pass a protocol dependent binary address argument.
225 The argument needs to be replaced with a more general address structure
226 to support multiple address families in a general way.
228 The functions with neither an
232 suffix work for IPv4 only, except for
234 which can handle both IPv6 and IPv4.
235 To switch the address family, the
237 argument must be filled with
249 returns a valid socket descriptor on success.
250 It returns -1 on error and prints a diagnostic message
251 on the standard error.
256 returns a valid, bound socket descriptor on success.
257 It returns -1 on error with the global value
259 set according to the reason for failure.
262 is overloaded to mean ``All network ports in use.''
275 .%T "Advanced Socket API for IPv6"
282 .%T "Advanced Socket API for IPv6"
283 .%O draft-ietf-ipngwg-rfc2292bis-01.txt
287 functions appeared in
290 appeared in RFC2292, and was implemented by the WIDE project
291 for the Hydrangea IPv6 protocol stack kit.
293 appeared in draft-ietf-ipngwg-rfc2292bis-01.txt,
294 and was implemented in the WIDE/KAME IPv6 protocol stack kit.
296 appeared in discussion on the IETF ipngwg mailing list,
297 and was implemented in