/usr/bin/xauth

xauth - X 認可ファイルユーティリティ

SYNOPSIS

xauth [ -f authfile ] [ -vqibn ] [ command arg ... ]

DESCRIPTION

xauthプログラムは、Xサーバーに接続する際に使用される認証情報を編集し、表示するために使用される。このプログラムは通常、あるマシンから認証記録を抽出し、別のマシンにマージするために使用される（リモートログインや他のユーザーへのアクセス許可を使用する場合と同様である）。コマンド（以下に説明）は、対話式、xauthコマンドライン、またはスクリプトで入力することができる。generateコマンドを使用する場合を除いて、このプログラムはXサーバーに接触しないことに注意。通常、xauth はそもそも権限ファイルのエントリを作成するために使用されない。X サーバーを起動するプログラム (多くの場合 xdm または startx) がそれを行う。

OPTIONS

xauthでは、以下のオプションを使用することができる。 これらは個別に（例：-q -i）、または組み合わせて（例：-qi）与えることができる。

-f authfile

このオプションは、使用する認証ファイルの名前を指定する。 デフォルトでは、xauth は XAUTHORITY 環境変数またはユーザーのホームディレクトリの .Xauthority によって指定されたファイルを使用する。

-q

このオプションは、xauth が静かに動作し、未承諾のステータスメッセージを表示しないようにすることを示す。これは、xauth コマンドがコマンドライン上で与えられた場合、または標準出力がターミナルに向けられない場合のデフォルトである。

-v

このオプションは、xauth が冗長に動作し、様々な操作の結果 (例えば、いくつのレコードが読み込まれたか、または書き出されたか) を示す状態メッセージを表示することを指示する。 これは、xauth が標準入力からコマンドを読み、その標準出力がターミナルに向けられる場合のデフォルトである。

-i

このオプションは、xauth が権威ファイルロックを無視すべきことを示す。 通常、xauth は他のプログラム (通常 xdm または別の xauth) によってロックされた権限ファイルの読み取りまたは編集を拒否する。

-b

このオプションは、xauth が処理を進める前に、権威ファイル・ロックの解除を試みるべきことを示す。このオプションは、古くなったロックを整理するためにのみ使用する。

-n

このオプションは、xauth がホスト名の解決を試みず、単に権威ファイルに格納されているホストアドレスを常に表示することを示す。

-V

バージョン番号を示す。

COMMANDS

認可ファイルの操作には、以下のコマンドを使用することができる。

add displayname protocolname hexkey

指定されたプロトコルと鍵データを用いて、指定されたディスプレイの認証エントリを 認証ファイルに追加する。 データは，16進数の偶数桁の文字列で指定され，各組は1オクテットに相当する。 各ペアの1桁目がオクテットの最上位4ビット、2桁目が最下位4ビットとなる。 例えば、32文字のHEXKEYは128ビットの値を表す。 ピリオド1つで構成されるプロトコル名は、MIT-MAGIC-COOKIE-1の略称として扱われる。

generate displayname protocolname [trusted|untrusted] [timeout seconds] [group group-id] [data hexdata]

このコマンドはaddと似ている。主な違いは、ユーザーに鍵データを提供させる代わりに、displayname で指定されたサーバーに接続し、SECURITY 拡張子を使用して、認証ファイルに格納する鍵データを取得する点である。 サーバーに接続できない場合、またはサーバーがSECURITY拡張をサポートしていない場合、コマンドは失敗する。それ以外の場合は、指定されたプロトコルを使用する表示用の認可エントリが認可ファイルに追加される。 ピリオド1つだけのプロトコル名は、MIT-MAGIC-COOKIE-1の省略形として扱われる。

trustedオプションを使用した場合、この認証を使って接続したクライアントは、通常通りディスプレイを完全に実行できる。untrustedが使用された場合、この認証を使用して接続するクライアントは信頼されていないとみなされ、信頼されたクライアントのデータを盗んだり、改ざんしたりすることができなくなる。信頼されていないクライアントに課される制限の詳細については、SECURITY拡張仕様を参照すること。デフォルトは untrusted である。

timeout オプションは、この認証が有効である時間を秒単位で指定する。認証がこの時間以上使われない (クライアントが接続されない) 場合、サーバはその認証を削除し、 その認証を使って今後接続しようとしても失敗する。サーバーによる削除は、認証ファイルから認証エントリを削除しないことに注意すること。 デフォルトのタイムアウトは 60 秒である。

group オプションは、この認証を使用して接続するクライアントが属するべきアプリケーション グループを指定する。詳細は、アプリケーショングループエクステンションの仕様を参照。 デフォルトは、アプリケーショングループに属さない。

dataオプションは、サーバーが認可を生成するために使用するデータを指定する。 これは、認証ファイルに書き込まれるデータと同じものではないことに注意。 このデータの解釈は、認証プロトコルに依存する。 hexdata は、add コマンドで説明されている hexkey と同じ形式である。 デフォルトでは、データは送信されない。

[n]extract filename displayname...

指定された各ディスプレイの認証エントリが、指定されたファイルに書き込まれる。 nextract コマンドを使用すると、エントリは、バイナリ以外の送信 (安全な電子メールなど) に適した数値形式で書き込まれる。抽出された項目は、merge および nmerge コマンドを使用して読み戻すことができる。ファイル名がダッシュ1つで構成されている場合、エントリーは標準出力に書き出される。

[n]merge [filename...]

認可エントリは指定されたファイルから読み込まれ、認可データベースにマージされ、一致する既存のエントリより優先される。nmerge コマンドが使用された場合、extract コマンドの説明で示された数値形式が使用される。 ファイル名がダッシュ1つで構成されている場合、以前に読み込まれたことがなければ、標準入力が読み込まれる。

remove displayname...

指定された表示に一致する認証項目が、権限ファイルから削除される。

source filename

指定されたファイルは、実行する xauth コマンドを含むスクリプトとして扱われる。空白行とシャープ記号(#)で始まる行は無視される。標準入力がまだ読み込まれていない場合は、ダッシュ1つで示すことができる。

info

認証ファイルの説明、変更の有無、xauthコマンドの読み込み元の情報が標準出力に出力される。

exit

何らかの変更が加えられた場合、権限ファイルが書き出され(許可されていれば)、プログラムが終了する。ファイルの終了は、暗黙の終了コマンドとして扱われる。

quit

プログラムは、変更された内容を無視して終了する。これは、割り込み文字を押すことによっても可能である。

version

このコマンドは、xauth実行ファイルのバージョン番号を表示する。

help [string]

与えられた文字列で始まるすべてのコマンド（文字列が与えられない場合はすべてのコマンド）の説明が標準出力に表示される。

?

有効なコマンドの短いリストが標準出力に表示される。

DISPLAY NAMES

add、[n]extract、[n]list、[n]merge、および remove コマンドの表示名は、DISPLAY 環境変数および共通の -display コマンドライン引数と同じ形式を使用します。ディスプレイ固有の情報 (画面番号など) は不要であり、無視される。同一マシン接続 (ローカルホストソケット、共有メモリ、インターネットプロトコルホスト名 localhost など) は hostname/unix:displaynumber と呼ばれ、異なるマシンのローカルエントリを 1 つの権限ファイルに格納できるようにする。

EXAMPLE

xauthの最も一般的な使用法は、現在のディスプレイのエントリーを抽出し、それを別のマシンにコピーして、リモートマシンのユーザーの権限ファイルにマージすることである。

% xauth extract - $DISPLAY | ssh otherhost xauth merge -

次のコマンドは、サーバー :0 に連絡して MIT-MAGIC-COOKIE-1 プロトコルを使用した認可を作成する。この認証で接続するクライアントは、信頼されないことになる。

% xauth generate :0 .

ENVIRONMENT

このxauthプログラムは、以下の環境変数を使用する。

XAUTHORITY

-f オプションが使われていない場合に使用する認可ファイルの名前を取得する。

HOME

XAUTHORITY が定義されていない場合、ユーザーのホームディレクトリを取得するために使用する。

FILES

$HOME/.Xauthority

XAUTHORITY が定義されていない場合、デフォルトの権限ファイルを指定する。

SEE ALSO

X(7), Xsecurity(7), xhost, Xserver, xdm, startx, Xau(3).

BUGS

安全でないネットワークを持つユーザーは、マシン間で認証エントリーをコピーするために、暗号化されたファイル転送メカニズムを使用するように注意する必要がある。同様に、MIT-MAGIC-COOKIE-1プロトコルは、安全でない環境ではあまり有用ではない。さらなるセキュリティを求めるサイトでは、Kerberosのような暗号化された認証メカニズムを使用する必要があるかもしれない。

現在、プロトコル名にはスペースは使用できない。本当に変態な人のために、引用を追加することができる。

AUTHOR

Jim Fulton, MIT X Consortium