ssh-keygen コマンドラインユーティリティ

ssh-keygen - クライアントおよびサーバ認証に使用される鍵の作成、管理、変換。

書式

ssh-keygen [-b bits] -t type [-N [passphrase]] [-C comment] [-f output_keyfile]
ssh-keygen -B [-f input_keyfile]
ssh-keygen -c [-P passphrase] [-C comment] [-f keyfile]
ssh-keygen -e [-f input_keyfile]
ssh-keygen -p [-P old_passphrase] [-N new_passphrase] [-f keyfile]
ssh-keygen -i [-f input_keyfile]
ssh-keygen -y [-f input_keyfile]
ssh-keygen -l [-f input_keyfile]

［説明］

ssh-keygen コマンドラインユーティリティを使用すると、公開鍵認証用の RSA 鍵と DSA 鍵の作成、既存の鍵のプロパティの編集、ファイル形式の変換が可能です。オプションを指定しないと、ssh-keygen では 2048 ビットの RSA 鍵のペアを生成し、秘密鍵を保護するために鍵の名前とパスフレーズの入力を求められます。公開鍵は秘密鍵と同じ名前を使用して作成され、拡張子 .pub が追加されます。鍵の生成が完了すると、鍵の位置が表示されます。

オプション

-b bits

鍵のサイズを指定します。鍵のサイズを大きくすると、ある程度までセキュリティは向上します。鍵のサイズを大きくすると最初の接続が遅くなりますが、正常に接続した後は、鍵のサイズはデータストリームの暗号化や解読の速度に影響しません。使用する鍵の長さは、多くの要素に依存します。その要素には、鍵の種類、鍵の有効期間、保護するデータの値、潜在的な攻撃者にとって利用可能なリソース、この非対称鍵とともに使用する対称鍵のサイズなどがあります。ニーズに合った最適な選択をするには、セキュリティ管理者にお問い合わせください。ECDSA鍵のデフォルトは、256ビットです。DSA鍵では1024ビットで、RSAの場合は、2048ビットです。

-B

指定された鍵の指紋を、SHA-1 Bubble Babble 形式で表示します。-f を使用して、鍵ファイルを指定できます。ファイルを指定していない場合、ファイル名の入力を求められます。秘密鍵または公開鍵の名前を指定できますが、どちらの場合でも、公開鍵は使用可能でなくてはなりません。

-C comment

鍵ファイル内のコメントフィールドに情報を指定します。文字列に空白が含まれている場合、引用符を使用します。鍵の作成時にコメントを指定していない場合、鍵の種類、作成者、日付、時刻を含む既定のコメントが作成されます。

-e

指定した OpenSSH 公開鍵または秘密鍵を使用して、Reflection 形式の公開鍵を生成します。-f を使用して、鍵ファイルを指定できます。ファイルを指定していない場合、ファイル名の入力を求められます。

-f filename

生成される秘密鍵のファイル名を指定します(公開鍵も作成され、常に秘密鍵と同じ名前となり、.pub というファイル拡張子が付きます)。このオプションは、入力ファイル名を指定するため -e、-i、-l、-p、-y、および -B と組み合わせて使用することもできます。

-i

指定されたクライアント公開鍵をOpenSSH形式に変換します。-f を使用して、鍵ファイルを指定できます。ファイルを指定していない場合、ファイル名の入力を求められます。

-h

コマンドラインオプションに関する簡単な説明を表示します。

-l

MD5 ハッシュを使用し、指定された公開鍵ファイルの指紋を表示します。-f を使用して、鍵ファイルを指定できます。ファイルを指定していない場合、ファイル名の入力を求められます。秘密鍵を指定した場合、ssh-keygen では一致する公開鍵ファイルの検索を試行し、その指紋を印刷します。

-N passphrase

パスフレーズを設定します。例えば、新しい鍵のパスフレーズを指定するには、次のようにします。

ssh-keygen -N mypassphrase -f keyfile

パスフレーズ保護されていない新しい鍵を作成するには、次のようにします：

ssh-keygen -N -f keyfile

-N を、-p および -P と組み合わせて使用すると、既存の鍵のパスフレーズを変更できます。

-p

このオプションを使用して、既存の秘密鍵のパスフレーズを変更します。このオプションのみを使用する場合、秘密鍵を含むファイル、古いパスフレーズ、新しいパスフレーズ (2 回) の入力をプログラムにより求められます。-f、-P、および -N と組み合わせて使用し、パスフレーズを非対話形式で変更できます。次に例を示します。

ssh-keygen -p -f keyfile -P oldpassphrase -N newpassphrase

-P passphrase

(古い) パスフレーズを指定します。

-q

ssh-keygen を終了します。

-t type

鍵の生成に使用する鍵のアルゴリズムを指定します。プロトコルバージョン 2 に指定可能な値は「rsa」または「dsa」です。

指定できる値は、「ecdsa」、「rsa」または「dsa」です

-y

指定した秘密鍵を使用して、公開鍵の新しいコピーを取得します。-f を使用して、鍵ファイルを指定できます。ファイルを指定していない場合、ファイル名の入力を求められます。

返される値

コマンドが正常に完了した場合、ssh-keygen は 0 (ゼロ) を返します。ゼロ以外の値は失敗を示します。