日本語 man コマンド類 (ja-man-1.1j_5) と日本語 man ドキュメント (ja-man-doc-5.4 (5.4-RELEASE 用) など) をインストールすると、以下のような man コマンド閲覧、キーワード検索が コンソールからできるようになります。
4.11-RELEASE-K, 5.4-RELEASE-K, 5.5-RELEASE-K, 6.0-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K, 12.1-RELEASE-K は、 プライベート版 (小金丸が編集してまとめたもの) ですが、 より多くの翻訳したファイルが含まれています。 (5.4-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K から 12.4-RELEASE-K, 13.0-RELEASE-K から 13.3-RELEASE-K, 14.0-RELEASE-K から 14.1-RELEASE-K は、全翻訳済み)
13.3-STABLE-K, 15.0-CURRENT-K は現在、作成中で日々更新されています。
Table of Contents
SSH-AGENT(1) FreeBSD 一般コマンドマニュアル SSH-AGENT(1)
名称
ssh-agent -- OpenSSH 認証エージェント
書式
ssh-agent [-c | -s] [-Ddx] [-a bind_address] [-E fingerprint_hash]
[-O option] [-P allowed_providers] [-t life]
ssh-agent [-a bind_address] [-E fingerprint_hash] [-O option]
[-P allowed_providers] [-t life] command [arg ...]
ssh-agent [-c | -s] -k
解説
ssh-agent は、公開鍵認証のために使用される秘密鍵を保持するプログラムで
す。ssh(1) を使用して他のマシンにログインするとき、環境変数の使用を通し
て、エージェントを検索し、認証のために自動的に使用することができます。最
初、エージェントには、何の秘密鍵がありません。
オプションは、次の通りです:
-a bind_address
エージェントを UNIX N0 ドメインソケット bind_address にバインドし
ます。デフォルトは、$TMPDIR/ssh-XXXXXXXXXX/agent.<ppid> です。
-c stdout (標準出力) に C シェルコマンドを生成します。これは、SHELL
が、それがシェルの csh スタイルのように見えるなら、デフォルトで
す。
-D フォアグラウンドモード。このオプションが指定されるとき、ssh-agent
は、フォーク (fork) しません。
-d デバッグモード。このオプションが指定されるとき、ssh-agent は、
フォーク (fork) されず、デバッグ情報を標準エラーに書き込みます。
-E fingerprint_hash
鍵の指紋を表示するとき、使用されたハッシュアルゴリズムを指定しま
す。有効なオプションは、次の通りです: ``md5'' と ``sha256''。デ
フォルトは、``sha256'' です。
-k (SSH_AGENT_PID 環境変数によって与えられる) 現在のエージェントを
kill します。
-O option
ssh-agent を開始するときのオプションを指定します。現在、次の 1 つ
のオプションのみがサポートされています: no-restrict-websafe。これ
は、web 認証要求であるかもしれない FIDO キーを使用した署名を許可
するように ssh-agent に指示します。デフォルトで、ssh-agent は、鍵
アプリケーション文字列が ``ssh:'' で始まらない FIDO 鍵のため署名
要求を拒否し、署名されるデータが ssh(1) ユーザ認証要求または ssh-
keygen(1) 署名のように見えないとき、拒否します。デフォルトの振る
舞いは、FIDO 鍵への転送されたアクセスが、認証への機能を Web サイ
トに暗黙的に転送することも防止します。
-P allowed_providers
ssh-add(1) に -S または -s オプションを付けて使用される、PKCS#11
プロバイダと FIDO 認証ミドルウェア共有ライブラリのために受け付け
可能なパスをパターンリストで指定します。パターンリストに一致しな
いライブラリは、拒否されます。パターンリストの構文の説明について
は、ssh_config(5) の「パターン」を参照してください。デフォルトの
リストは、``/usr/lib/*,/usr/local/lib/*'' です。
-s stdout (標準出力) に Bourne シェルコマンドを生成しします。これ
は、SHELL が、それがシェルの csh スタイルのように見えないなら、デ
フォルトです。
-t life
エージェントに追加された秘密鍵 (identity) の最大の存続期間のため
のデフォルト値を設定します。存続期間は、秒単位または
sshd_config(5) で指定される時間の形式で指定されます。ssh-add(1)
で秘密鍵 (identity) のために指定された存続期間は、この値を上書き
(この値より優先) します。このオプションなしで、デフォルトの最大の
存続期間は、永久となります。
-x 最後のクライアントが切断した後に終了します。
command [arg ...]
コマンド (とオプションの引数) が与えられるなら、これは、エージェ
ントのサブプロセスとして実行されます。エージェントは、コマンド行
で与えられたコマンドが終了するとき、自動的に終了します。
エージェントをセットアップする、主に 2 つの方法があります。最初は、他のす
べてのウィンドウまたはプログラムが ssh-agent プログラムの子プロセスとして
開始される、X セッションの開始時です。エージェントは、例えば、ssh-agent
xterm & のように、環境変数がエクスポートされるコマンドの下で開始します。
このコマンドが終了するとき、エージェントも終了します。
2 番目の方法は、ログインセッションのために使用されます。ssh-agent が開始
されるとき、環境変数を設定するために必要なシェルコマンドを印刷 (表示)
し、例えば、eval `ssh-agent -s` のように、呼び出しているシェルで順に評価
することができます。
いすれにしても、ssh(1) は、これらの環境変数を見て、エージェントへの接続を
確立するために使用します。
エージェントは、最初に、秘密鍵がありません。鍵は、ssh-add(1) を使用して追
加されるか、または AddKeysToAgent が ssh_config(5) で設定されるとき、
ssh(1) によって追加されます。複数の識別は、同時に ssh-agent に保存され、
ssh(1) は、存在するなら、それらを自動的に使用します。また ssh-add(1) は、
ssh-agent から鍵を削除するために、そして、それに保持されている鍵を問い合
わせるために使用されます。
ssh-agent への接続は、他のマシンで格納される認証データのために必要性を回
避して、ssh(1) への -A オプションを使用して、さらにリモートホストから転送
されます (ただし、そこに文書化されている警告を参照してください)。認証のパ
スフレーズと秘密鍵は、決してネットワークを通過しません。エージェントへの
接続は、SSH のリモート接続で転送され、ユーザは、安全なやり方でネットワー
クのどこでもそれらの識別にアクセスを許可して、結果が、要求者に返されま
す。
環境変数
SSH_AGENT_PID ssh-agent が開始するとき、エージェントのプロセス ID (PID)
の名前をこの変数に格納されます。
SSH_AUTH_SOCK ssh-agent が開始されるとき、UNIX ドメインのソケットを作成
し、そのパス名をこの変数に格納します。現在のユーザのみへの
アクセス可能ですが、root または同じユーザの別のインスタン
スによって簡単に悪用されます。
関連ファイル
$TMPDIR/ssh-XXXXXXXXXX/agent.<ppid>
認証エージェントへの接続のために使用される UNIX ドメインソケッ
ト。これらのソケットは、所有者によってのみ読み込み可能にするべき
です。ソケットは、エージェントが終了するとき、自動的に削除される
べきです。
関連項目
ssh(1), ssh-add(1), ssh-keygen(1), ssh_config(5), sshd(8)
作者
OpenSSH は、Tatu Ylonen によってリリースされたオリジナルのフリーな ssh
1.2.12 の派生物です。Aaron Campbell, Bob Beck, Markus Friedl, Niels
Provos, Theo de Raadt と Dug Song は、多くのバグを取り除き、新しい機能を
再び追加し、OpenSSH を作成しました。Markus Friedl は、SSH プロトコルバー
ジョン 1.5 と 2.0 のためのサポートを寄贈しました。
FreeBSD 13.2 October 7, 2022 FreeBSD 13.2