SSH-ADD(1)

名前
ssh-add - 認証エージェントに RSA あるいは DSA 秘密鍵を追加する

書式
ssh-add [-lLdDxXc] [-t 鍵の生存時間] [file ...]

ssh-add -s リーダ

ssh-add -e リーダ

説明
ssh-add は認証エージェントである ssh-agent(1). に、 RSA あるいは DSA の認証鍵を追加します。 引数なしで実行された場合、これは $HOME/.ssh/id_rsa, $HOME/.ssh/id_dsa および $HOME/.ssh/identity の各ファイルを追加します。コマンドラインから別の ファイル名を与えることもできます。パスフレーズが必要な場合、 ssh-add はユーザにそれを尋ねます。 このパスフレーズはユーザの端末から読み込まれます。 複数の identity ファイルが指定された場合、 ssh-add は最後に入力されたパスフレーズをくり返し使います。

ssh-add がうまく動くためには、認証エージェントが動いていて、環境変数 SSH_AUTH_SOCK が認証エージェント用のソケット名を指していなければなりません。

オプションは以下のとおりです:

-l  現在、エージェントによって保持されているすべての鍵の指紋 (fingerprint) を表示します。

-L  現在、エージェントによって保持されているすべての公開鍵の 情報を表示します。

-d  鍵を追加するのではなく、エージェントから鍵を取り除きます。

-D  エージェントからすべての鍵を取り除きます。

-x  エージェントをパスワードでロックします。

-X  エージェントのロックをはずします。

-t 鍵の生存時間
    エージェントに鍵を追加するさい、その鍵の最大生存時間を指定します。 生存時間は秒数、あるいは sshd_config(5) で使われている形式で指定できます。

-c  追加された鍵を、認証に使う前に確認するよう指定します。 この確認は、以下で説明する SSH_ASKPASS プログラムによっておこなわれます。確認の成功は、 SSH_ASKPASS プログラムに入力された文字列ではなく、 これが終了状態として 0 を返したかどうかによって決定されます。

-s リーダ
    スマートカード reader に鍵を追加します。

-e リーダ
    スマートカード reader から鍵を削除します。

環境変数

DISPLAY and SSH_ASKPASS
    ssh-add は端末で走っている場合、パスフレーズが必要になると その端末からパスフレーズを読み込みます。 ssh-add の使える端末がないときでも、環境変数 DISPLAY と SSH_ASKPASS が設定されていれば、 ssh-add は SSH_ASKPASS で指定されたプログラムを立ち上げ、パスフレーズを読むための X11 ウインドウを開きます。これは特に ssh-add を .Xsession などのスクリプトから走らせるときに有効です (機種によっては、これがうまく動作するためには入力を /dev/null にリダイレクトしておく必要があるかもしれません)。

SSH_AUTH_SOCK
    エージェントと通信するための unix ドメインソケットへのパス名が入っています。

関連ファイル

$HOME/.ssh/identity
    そのユーザがプロトコル バージョン 1 で使用する RSA 認証用の秘密鍵が入っています。

$HOME/.ssh/id_dsa
    そのユーザがプロトコル バージョン 2 で使用する DSA 認証用の秘密鍵が入っています。

$HOME/.ssh/id_rsa
    そのユーザがプロトコル バージョン 2 で使用する RSA 認証用の秘密鍵が入っています。

秘密鍵の入ったファイルは本人以外の誰にも読まれてはいけません。 他人から読めるようになっていると、 ssh-add はこのファイルを無視します。

診断
ssh-add は、成功すると終了状態として 0 を、指定されたコマンドが失敗すると 1 を、 認証エージェントと通信できない場合は 2 を返します。

関連項目
ssh(1), ssh-agent(1), ssh-keygen(1), sshd(8)

作者
OpenSSH は Tatu Ylonen による、フリーな オリジナル版 ssh 1.2.12 リリースから派生したものです。 Aaron Campbell、 Bob Beck、 Markus Friedl、 Niels Provos、 Theo de Raadt および Dug Song が多くのバグをとり除き、 新しい機能をふたたび追加して OpenSSH をつくりました。 SSH プロトコル バージョン 1.5 および 2.0 のサポートは Markus Friedl の貢献によるものです。

日本語訳
新山 祐介 (yusuke at cs . nyu . edu) 2004/2/26 (for 3.8p1)