draft/man3/rcmd.3

   1 .\"     $NetBSD: rcmd.3,v 1.9 1996/05/28 02:07:39 mrg 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 .\"     @(#)rcmd.3      8.1 (Berkeley) 6/4/93
  35 .\"
  36 .\" Contributed as Linux man page by David A. Holland, 970908
  37 .\" I have not checked whether the Linux situation is exactly the same.
  38 .\"
  39 .\" 2007-12-08, mtk, Converted from mdoc to man macros
  40 .\"
  41 .\"
  42 .\" Japanese Version Copyright (c) 1999 NAKANO Takeo all rights reserved.
  43 .\" Translated Mon Mar 1 1999 by NAKANO Takeo <nakano@apm.seikei.ac.jp>
  44 .\"
  45 .\"WORD:        standard name           (ホストの) 標準名
  46 .\"WORD:        regular file            通常ファイル
  47 .\"
  48 .TH RCMD 3 2007-12-28 "Linux" "Linux Programmer's Manual"
  49 .\"O .SH NAME
  50 .\"O rcmd, rresvport, iruserok, ruserok \- routines for returning a
  51 .\"O stream to a remote command
  52 .SH 名前
  53 rcmd, rresvport, iruserok, ruserok \- リモートコマンドにストリームを返す関数群
  54 .\"O .SH SYNOPSIS
  55 .SH 書式
  56 .nf
  57 .B #include <netdb.h> \ \ \fP/* Or <unistd.h> on some systems */
  58 .sp
  59 .BI "int rcmd(char **" ahost ", int " inport ", const char *" locuser ", "
  60 .BI "         const char *" remuser ", const char *" cmd ", int *" fd2p );
  61 .sp
  62 .BI "int rresvport(int *" port );
  63 .sp
  64 .BI "int iruserok(uint32_t " raddr ", int " superuser ", "
  65 .BI "             const char *" ruser ", const char *" luser );
  66 .sp
  67 .BI "int ruserok(const char *" rhost ", int " superuser ", "
  68 .BI "            const char *" ruser ", const char *" luser );
  69 .fi
  70 .sp
  71 .in -4n
  72 .\"O Feature Test Macro Requirements for glibc (see
  73 .\"O .BR feature_test_macros (7)):
  74 glibc 向けの機能検査マクロの要件
  75 .RB ( feature_test_macros (7)
  76 参照):
  77 .in
  78 .sp
  79 .BR rcmd (),
  80 .BR rresvport (),
  81 .BR ruserok ():
  82 _BSD_SOURCE
  83 .\"O .SH DESCRIPTION
  84 .SH 説明
  85 .\"O The
  86 .\"O .BR rcmd ()
  87 .\"O function is used by the superuser to execute a command on
  88 .\"O a remote machine using an authentication scheme based
  89 .\"O on privileged port numbers.
  90 .BR rcmd ()
  91 関数は、スーパーユーザーがリモートマシンでコマンドを実行するために
  92 用いられる。このとき特権ポート番号をもとにした認証スキームが
  93 用いられる。
  94 .\"O The
  95 .\"O .BR rresvport ()
  96 .\"O function
  97 .\"O returns a descriptor to a socket
  98 .\"O with an address in the privileged port space.
  99 .BR rresvport ()
 100 関数は、特権ポート空間のアドレスを持つソケットの
 101 ディスクリプターを返す。
 102 .\"O The
 103 .\"O .BR iruserok ()
 104 .\"O and
 105 .\"O .BR ruserok ()
 106 .\"O functions are used by servers
 107 .\"O to authenticate clients requesting service with
 108 .\"O .BR rcmd ().
 109 .BR iruserok ()
 110 関数と
 111 .BR ruserok ()
 112 関数は、
 113 .BR rcmd ()
 114 でサービス要求を行ったクライアントの認証を行うために
 115 サーバーが用いる関数である。
 116 .\"O All four functions are present in the same file and are used
 117 .\"O by the
 118 .\"O .BR rshd (8)
 119 .\"O server (among others).
 120 以上の 4 つの関数は、すべて同じファイルに記述されており、
 121 .BR rshd (8)
 122 サーバーによって (他の関数とともに) 利用される。
 123 .PP
 124 .\"O The
 125 .\"O .BR rcmd ()
 126 .\"O function
 127 .\"O looks up the host
 128 .\"O .I *ahost
 129 .\"O using
 130 .\"O .BR gethostbyname (3),
 131 .\"O returning \-1 if the host does not exist.
 132 .\"O Otherwise
 133 .\"O .I *ahost
 134 .\"O is set to the standard name of the host
 135 .\"O and a connection is established to a server
 136 .\"O residing at the well-known Internet port
 137 .\"O .IR inport .
 138 .BR rcmd ()
 139 関数は
 140 .BR gethostbyname (3)
 141 を用いて
 142 .I *ahost
 143 の参照を行う。ホストが存在しない場合は \-1 を返す。
 144 見つかった場合は
 145 .I *ahost
 146 にホストの標準名 (standard name) をセットして、
 147 予約されているインターネットポート
 148 .I inport
 149 経由でサーバーへの接続を確立する。
 150 .PP
 151 .\"O If the connection succeeds,
 152 .\"O a socket in the Internet domain of type
 153 .\"O .BR SOCK_STREAM
 154 .\"O is returned to the caller, and given to the remote
 155 .\"O command as
 156 .\"O .IR stdin
 157 .\"O and
 158 .\"O .IR stdout .
 159 接続に成功したら、インターネットドメインに存在するタイプ
 160 .B SOCK_STREAM
 161 のソケットが呼び出しもとに返される。
 162 このソケットの相手側はリモートコマンドの
 163 .I stdin
 164 および
 165 .I stdout
 166 に接続される。
 167 .\"O If
 168 .\"O .I fd2p
 169 .\"O is nonzero, then an auxiliary channel to a control
 170 .\"O process will be set up, and a descriptor for it will be placed
 171 .\"O in
 172 .\"O .IR *fd2p .
 173 .I fd2p
 174 がゼロでない場合は、制御プロセスへの接続がもう一つ用意され、
 175 そのディスクリプターが
 176 .I *fd2p
 177 にセットされる。
 178 .\"O The control process will return diagnostic
 179 .\"O output from the command (unit 2) on this channel, and will also
 180 .\"O accept bytes on this channel as being UNIX signal numbers, to be
 181 .\"O forwarded to the process group of the command.
 182 制御プロセスはリモートコマンドからの標準エラー出力 (unit 2) を
 183 このチャンネルに返す。
 184 また制御プロセスはこの接続から受け取ったバイトデータを
 185 UNIX シグナルの番号として扱い、リモートコマンドのプロセス
 186 グループへとシグナルを送る。
 187 .\"O If
 188 .\"O .I fd2p
 189 .\"O is 0, then the
 190 .\"O .IR stderr
 191 .\"O (unit 2 of the remote
 192 .\"O command) will be made the same as the
 193 .\"O .IR stdout
 194 .\"O and no
 195 .\"O provision is made for sending arbitrary signals to the remote process,
 196 .\"O although you may be able to get its attention by using out-of-band data.
 197 .I fd2p
 198 がゼロの場合は、
 199 .I stderr
 200 (リモートコマンドの unit 2) は
 201 .I stdout
 202 と一緒にまとめられる。またこの場合はリモートプロセスへ
 203 任意のシグナルを送ることはできなくなる。
 204 ただし帯域外 (out-of-band) データを用いれば、
 205 リモートプロセスの注意を引くことはできるかもしれない。
 206 .PP
 207 .\"O The protocol is described in detail in
 208 .\"O .BR rshd (8).
 209 プロトコルの詳細は
 210 .BR rshd (8)
 211 に記述されている。
 212 .PP
 213 .\"O The
 214 .\"O .BR rresvport ()
 215 .\"O function is used to obtain a socket with a privileged
 216 .\"O address bound to it.
 217 .\"O This socket is suitable for use by
 218 .\"O .BR rcmd ()
 219 .\"O and several other functions.
 220 .\"O Privileged Internet ports are those in the range 0 to 1023.
 221 .\"O Only the superuser is allowed to bind an address of this sort to a socket.
 222 .BR rresvport ()
 223 関数は特権アドレスにバインドされたソケットを取得するために用いられる。
 224 このソケットは
 225 .BR rcmd ()
 226 などの関数での利用に適している。インターネットポートの特権ポートは、
 227 0 から 1023 の範囲である。スーパーユーザーだけがこれらのアドレスを
 228 ソケットにバインドすることができる。
 229 .PP
 230 .\"O The
 231 .\"O .BR iruserok ()
 232 .\"O and
 233 .\"O .BR ruserok ()
 234 .\"O functions take a remote host's IP address or name, respectively,
 235 .\"O two usernames and a flag indicating whether the local user's
 236 .\"O name is that of the superuser.
 237 .BR iruserok ()
 238 と
 239 .BR ruserok ()
 240 関数は、まず以下の引数を取る: リモートホスト
 241 .RB ( iruserok ()
 242 は IP アドレスで、
 243 .BR ruserok ()
 244 はホスト名で指定)、 2 つのユーザー名、ローカルユーザーの名前が
 245 スーパーユーザーのものであるかどうかを示すフラグ、である。
 246 .\"O Then, if the user is
 247 .\"O .I not
 248 .\"O the superuser, it checks the
 249 .\"O .IR /etc/hosts.equiv
 250 .\"O file.
 251 .\"O If that lookup is not done, or is unsuccessful, the
 252 .\"O .IR .rhosts
 253 .\"O in the local user's home directory is checked to see if the request for
 254 .\"O service is allowed.
 255 もしユーザーが\fBスーパーユーザーではない\fP場合は、これらの関数は
 256 .I /etc/hosts.equiv
 257 ファイルをチェックする。ファイルが見つからなかったり、
 258 内容のチェックに失敗した場合には、
 259 ローカルユーザーのホームディレクトリにある
 260 .I .rhosts
 261 ファイルをチェックして、サービス要求が許可されているかどうか調べる。
 262 .PP
 263 .\"O If this file does not exist, is not a regular file, is owned by anyone
 264 .\"O other than the user or the superuser, or is writable by anyone other
 265 .\"O than the owner, the check automatically fails.
 266 .\"O Zero is returned if the machine name is listed in the
 267 .\"O .IR hosts.equiv
 268 .\"O file, or the host and remote username are found in the
 269 .\"O .IR .rhosts
 270 .\"O file; otherwise
 271 .\"O .BR iruserok ()
 272 .\"O and
 273 .\"O .BR ruserok ()
 274 .\"O return \-1.
 275 .\"O If the local domain (as obtained from
 276 .\"O .BR gethostname (2))
 277 .\"O is the same as the remote domain, only the machine name need be specified.
 278 このファイルが存在しなかったり、
 279 通常ファイル (regular file) ではなかったり、
 280 指定ユーザーまたはスーパーユーザー以外の所有だったり、
 281 所有者以外から書き込み可能だったりした場合には、
 282 このチェックは自動的に失敗する。
 283 マシンの名前が
 284 .I hosts.equiv
 285 にリストされていたり、
 286 ホストとリモートユーザーの名前が
 287 .I .rhosts
 288 ファイルに書かれていた場合には 0 が返される。
 289 それ以外の場合には、
 290 .BR iruserok ()
 291 と
 292 .BR ruserok ()
 293 は \-1 を返す。
 294 .RB ( gethostname (2)
 295 によって取得される) ローカルドメインがリモートのドメインと同じ場合は、
 296 マシンの名前だけを指定すればよい。
 297 .PP
 298 .\"O If the IP address of the remote host is known,
 299 .\"O .BR iruserok ()
 300 .\"O should be used in preference to
 301 .\"O .BR ruserok (),
 302 .\"O as it does not require trusting the DNS server for the remote host's domain.
 303 リモートホストの IP アドレスがわかっている場合は、
 304 .BR ruserok ()
 305 よりも
 306 .BR iruserok () を用いる方が良いだろう。
 307 .BR ruserok ()
 308 はリモートホストの所属するドメインの DNS サーバーが信頼できなくても
 309 使用できるからである。
 310 .\"O .SH RETURN VALUE
 311 .SH 返り値
 312 .\"O The
 313 .\"O .BR rcmd ()
 314 .\"O function
 315 .\"O returns a valid socket descriptor on success.
 316 .\"O It returns \-1 on error and prints a diagnostic message on the standard error.
 317 .BR rcmd ()
 318 関数は成功すると有効なソケットディスクリプターを返す。
 319 失敗すると \-1 を返し、標準エラー出力に診断メッセージを
 320 表示する。
 321 .PP
 322 .\"O The
 323 .\"O .BR rresvport ()
 324 .\"O function
 325 .\"O returns a valid, bound socket descriptor on success.
 326 .\"O It returns \-1 on error with the global value
 327 .\"O .I errno
 328 .\"O set according to the reason for failure.
 329 .\"O The error code
 330 .\"O .BR EAGAIN
 331 .\"O is overloaded to mean "All network ports in use."
 332 .BR rresvport ()
 333 関数は、成功するとバインドされた有効なソケットディスクリプターを返す。
 334 失敗すると \-1 を返し、グローバル変数
 335 .I errno
 336 をエラーの原因に対応する値にセットする。
 337 エラーコード
 338 .B EAGAIN
 339 は、この関数においては「すべてのネットワークポートが使用中」
 340 という意味を表す。
 341 .\"O .SH "CONFORMING TO"
 342 .SH 準拠
 343 .\"O Not in POSIX.1-2001.
 344 .\"O Present on the BSDs, Solaris, and many other systems.
 345 .\"O These
 346 .\"O functions appeared in
 347 .\"O 4.2BSD.
 348 POSIX.1-2001 にはない。
 349 BSD 系、Solaris や他の多くのシステムに存在する。
 350 これらの関数は 4.2BSD で登場した。
 351 .\"O .SH BUGS
 352 .SH バグ
 353 .\"O .BR iruserok ()
 354 .\"O is not declared in glibc headers.
 355 .BR iruserok ()
 356 は glibc のヘッダでは宣言されていない。
 357 .\" Bug filed 25 Nov 2007:
 358 .\" http://sources.redhat.com/bugzilla/show_bug.cgi?id=5399
 359 .\"O .SH SEE ALSO
 360 .SH 関連項目
 361 .BR rlogin (1),
 362 .BR rsh (1),
 363 .BR intro (2),
 364 .BR rexec (3),
 365 .BR rexecd (8),
 366 .BR rlogind (8),
 367 .BR rshd (8)