csakeyadd(公開鍵認証の秘密鍵情報の登録・更新)
形式
csakeyadd [-h] { -userinfofile <ユーザ情報指定ファイルのパス> | -keyfile <秘密鍵のファイルパス> [-pass <秘密鍵のパスフレーズ>] -keyid <鍵ID> } [-r] -f <公開鍵認証情報定義ファイルのパス>
機能
ユーザ認証のうち,公開鍵認証に必要な秘密鍵の情報を登録または更新します。登録できる公開鍵認証情報の数に上限はありません。
登録または更新した公開鍵認証情報は,それを使用するサービスアダプタの初回リクエスト時に有効となります。また,初回リクエスト後にこのコマンドを実行すると,登録または更新した公開鍵認証情報は,次のサービスアダプタの開始後から有効となります。
コマンドを実行する前の注意事項を次に示します。
-
このコマンドの-passオプションにパスワードを指定した場合,プロセスの引数を確認できるOS機能などによって,パスワードが検知されるおそれがあります。このため,-userinfofileオプションを使用した,ユーザ情報指定ファイルでのパスワードの設定を推奨します。
-
コマンドを実行する管理者に限定して,公開鍵認証情報定義ファイルと秘密鍵ファイルに対する更新・参照権限を設定してください。
-
コマンドにユーザ情報指定ファイルを指定する場合,コマンドを実行する管理者に限定して,ユーザ情報指定ファイルに対する更新・参照権限を設定してください。
-
公開鍵認証情報定義ファイルを更新する場合は,バックアップファイルの作成をお勧めします。
引数
-h
コマンドの使用方法が表示されます。このオプションを指定している場合は,ほかのオプションを指定しても無視されます。
-userinfofile <ユーザ情報指定ファイルのパス>
秘密鍵のファイルパス,秘密鍵のパスフレーズ,鍵IDが記載されているユーザ情報指定ファイルのパスを指定します。絶対パス,またはコマンド実行時のカレントディレクトリからの相対パスで指定してください。パスが空白を含む場合は,パス全体をダブルクォーテーション(")で囲んでください。
指定されたユーザ情報指定ファイルのユーザ情報がすべて正常であれば,その内容が公開鍵認証情報定義ファイルに一括で登録または更新されます。ただし,次の場合はエラーとなり,登録・更新は実施されません。
-
指定されたファイルが存在しない場合
-
ファイル内のユーザ情報に1つでも不正があった場合
-
ファイル内に鍵IDが重複している場合
なお,実行対象のユーザ情報指定ファイルには,ユーザ情報の登録または更新のどちらかだけを指定できます。
ユーザ情報指定ファイルの記載方法については,「6.21.1 ユーザ情報指定ファイル」を参照してください。
-keyfile <秘密鍵のファイルパス>
秘密鍵ファイルのパスを相対パスまたは絶対パスで指定します。パスに空白を含む場合は,オプション引数全体をダブルクォーテーション(")で囲みます。
指定したファイルが存在しない場合はエラーになります。
-pass <秘密鍵のパスフレーズ>
対象となる秘密鍵にパスフレーズが設定されている場合,秘密鍵のパスフレーズを指定します。
-keyid <鍵ID> 〜<半角英数字およびアンダーバー(_)> ((1〜8文字))
秘密鍵を一意に区別するためのIDを指定します。
-
公開鍵認証情報の登録時
公開鍵認証情報定義ファイル内で一意となるIDを指定してください。
-
公開鍵認証情報の更新時(引数-rを指定した場合)
公開鍵認証情報定義ファイルに登録されているIDを指定してください。
-r
登録済みの公開鍵認証情報を更新する場合に指定します。
-f <公開鍵認証情報定義ファイルのパス>
このコマンドで定義した公開鍵認証情報を保存するための,公開鍵認証情報定義ファイルのパスを相対パスまたは絶対パスで指定します。パスに空白を含む場合は,オプション引数全体をダブルクォーテーション(")で囲みます。
指定したファイルが存在しない場合は次のように動作します。
-
公開鍵認証情報の登録時
指定したファイル名で,公開鍵認証情報定義ファイルが新規作成されます。ただし,指定したディレクトリが存在しない場合はエラーになります。
-
公開鍵認証情報の更新時(引数-rを指定した場合)
エラーになります。
戻り値
戻り値 |
意味 |
---|---|
0 |
正常終了しました。 |
1 |
コマンドが異常終了しました。 |
9 |
実行権限のチェックエラーが発生しました。 |
注意事項
-
公開鍵認証情報定義ファイルは直接編集しないでください。
-
コマンドの実行後は,秘密鍵ファイルの編集・移動はしないでください。