名称

ssh-add — 認証エージェントに秘密鍵 (identity) を追加する

書式

ssh-add

[ -cDdkLlXx][ -t life][ file ...]

ssh-add

-s pkcs11

ssh-add

-e pkcs11

解説

ssh-add は、認証エージェント ssh-agent(1) に、秘密鍵 (identity) を追加します。引数なしで実行されるとき、ファイル ~/.ssh/id_rsa, ~/.ssh/id_dsa, ~/.ssh/id_ecdsa と ~/.ssh/identity を追加します。秘密鍵をロードした後に、 ssh-add は、 -cert.pub を追加することによって取得されるファイル名から、秘密鍵ファイルの名前まで対応する証明書情報をロードしようとします。コマンドラインで代わりのファイル名を与えることができます。

任意のファイルがパスフレーズを要求するなら、 ssh-add は、ユーザからパスフレーズを求めます。パスフレーズは、ユーザの tty から読み込まれます。 ssh-add は、複数の秘密鍵 (identity) ファイルが与えられるなら、最後のパスフレーズを再試行します。

認証エージェントは、実行されていなければならず、 SSH_AUTH_SOCK 環境変数は、動作する ssh-add のために、そのソケットの名前を含んでいなければなりません。

オプションは、次の通りです:

-c

追加の identity が認証のために使用される前に、確認しなければならないことを示します。確認は、以下に説明される SSH_ASKPASS プログラムによって行なわれます。確認が成功したかは、要求者に入力されたテキストではなく SSH_ASKPASS プログラムからの 0 の終了ステータスによって示されます。

-D

エージェントからすべての identity を削除します。

-d

identity を追加する代わりに、エージェントから identity を削除します。 ssh-add が引数なしで実行されたなら、デフォルトの識別のための鍵とそれらの対応する証明書は、削除されます。そうでなければ、引数リストは、エージェントから削除される鍵と証明書を指定するための公開鍵のファイルへのパスのリストとして解釈されます。公開鍵が与えられたパスで見つけられないなら、 ssh-add は、 .pub を追加して、再試行します。

-e pkcs11

PKCS#11 共有ライブラリ pkcs11 によって提供される鍵を削除します。

-k

エージェントにキーをロードするか、またはエージェントからキーを削除するとき、平易な秘密鍵だけを処理して、証明書をスキップします。

-L

現在、エージェントによって表わされるすべての identity の公開鍵パラメータをリストします。

-l

現在、エージェントによって表わされるすべての identity の指紋 (fingerprint) をリストします。

-s pkcs11

PKCS#11 共有ライブラリ pkcs11 によって提供される鍵を追加します。

-t life

エージェントに鍵を追加するさい、その鍵の最大生存時間を指定します。存続期間は、秒または sshd_config(5) で指定される時間の形式で指定されます。

-X

エージェントのロックを解除します。

-x

パスワードがあるエージェントをロックします。

環境変数

DISPLAY と SSH_ASKPASS

ssh-add がパスフレーズを必要とし、それが、端末から実行されたなら、現在の端末からパスフレーズを読み込みます。 ssh-add に関連している端末がないけれども、 DISPLAY と SSH_ASKPASS が設定されているなら、 SSH_ASKPASS によって指定されたプログラムを実行し、パスフレーズを読み込むために X11 window をオープンします。これは、 .xsession または関連するスクリプトから ssh-add を呼び出すとき、特に役に立ちます。 (いくつかのマシンでは、この作業を行うために /dev/null からの入力をリダイレクトする必要があることに注意してください。)

SSH_AUTH_SOCK

エージェントと通信するために使用される UNIX ドメインのソケットのパスを識別します。

関連ファイル

~/.ssh/identity

ユーザのプロトコルバージョン 1 の RSA 認証の秘密鍵 (identity) を含んでいます。

~/.ssh/id_dsa

ユーザのプロトコルバージョン 2 の DSA 認証の秘密鍵 (identity) を含んでいます。

~/.ssh/id_ecdsa

ユーザのプロトコルバージョン 2 の ECDSA 認証の秘密鍵 (identity) を含んでいます。

~/.ssh/id_rsa

ユーザのプロトコルバージョン 2 の RSA 認証の秘密鍵 (identity) を含んでいます。

秘密鍵 (identity) ファイルは、ユーザ以外の誰によっても読み込み可能であってはなりません。 ssh-add は、秘密鍵 (identity) ファイルが他の人によってアクセス可能であるなら、秘密鍵 (identity) ファイルを無視することに注意してください。

終了ステータス

終了ステータスは、成功すれば、0 で、指定されたコマンドが失敗するなら、1 で、 ssh-add が認証エージェントと通信することができないなら、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 を作成しました。 Markus Friedl は、SSH プロトコルバージョン 1.5 と 2.0 のためのサポートを寄贈しました。