profileコマンド

Keeper Secrets Managerデバイスのプロファイルの設定と初期化

profileコマンド

**説明:**デバイスのプロファイルを初期化して切り替えます。同じデバイスで複数の環境をサポートするために、Secrets Managerデバイスのプロファイルを切り替えることもできます。

パラメータ:

実行するサブコマンドとオプション

形式: ksm profile <sub-command>

サブコマンド:

サブコマンド	説明
init	新しいクライアントデバイスのプロファイルを初期化します
setup	外部ストレージから新しいプロファイルを設定します
list	作成されたプロファイルを一覧表示して、有効なプロファイルを示します
export	設定プロファイルをエクスポートします
import	エクスポートされた暗号化プロファイルから新しい設定を作成します
active	有効な設定プロファイルを指定します

init

クライアントデバイスのプロファイルを初期化します。

ksm profile init

keeper.iniファイルが現在の作業ディレクトリに作成されます。WindowsまたはmacOSのバイナリアプリケーションの場合、keeper.iniは、ユーザーのホームディレクトリ（${HOME}環境変数または$env:USERPROFILE環境変数）に作成されます。keeper.iniは以下の場所に移動できます。

• 環境変数**KSM_INI_DIR**で定義されたパス

• カレントディレクトリ

• ユーザーのホームディレクトリ

  • ${HOME}

  • ${HOME}/.config/ksm

  • $env:USERPROFILE

• 様々なシステムディレクトリ

  • /etc

  • /etc/ksm

  • /etc/keeper

  • $env:APPDATA/Keeper

  • $env:ProgamData/Keeper

  • $env:ProgramFiles/Keeper

オプションパラメータ:

• -t、--token <token> ワンタイムアクセストークン

• -h、--hostname <XX> 接続先のリージョン

  デフォルトはUSリージョンです。他のリージョンでホストされているお客様は、以下の値を設定する必要があります。

  • US（米国）

  • EU（ヨーロッパ）

  • AU（オーストラリア）

  • JP（日本）

  • CA（カナダ）

  • US_GOV（GovCloud）

• --ini-file <FILENAME> 新しいプロファイルをこのファイルに保存します

• -p、--profile-name <NAME> プロファイル名を設定します 設定しない場合、プロファイルは「default」に設定されます

例:

$ ksm profile init --token XX:XXXXXXXX

Added profile _default to INI config file keeper.ini

クイックスタートガイドに記載されているように、まずCommander CLIでトークンXXXを取得します。

My Vault> secrets-manager client add --app MyApplicationName

setup

AWS Secrets Managerなどの外部ストレージから読み込む新しいプロファイルを設定します。

ksm profile setup --type=aws

選択したクレデンシャルは、シークレットへの読み取りアクセス権を備えている必要があります。たとえば、EC2インスタンスのクレデンシャルの場合、そのインスタンスは、SecretsManagerReadWriteポリシーが有効になっているロールに属している必要があります

リモートストレージのアクセスクレデンシャルだけがローカルプロファイルに保存され、このプロファイルはksm profile exportコマンドでエクスポートできません。

EC2インスタンスのクレデンシャルを使用するコマンド:

ksm profile setup --type=aws デフォルトでは、AWS設定は、ec2instanceのクレデンシャルを使用して、AWS Secrets Managerの秘密鍵ksm-configからデバイスの設定を読み込みます。

--secretオプションは、短い鍵名または完全なARNを指定できます クレデンシャルのオプション: ksm profile setup --type=aws --secret=ksm-config --credentials=ec2instance ec2isntanceは、追加のオプションを必要としません プロファイルのクレデンシャルを使用するコマンド: ksm profile setup --type=aws --secret=ksm-config --credentials=profile --credentials-profile=default プロファイルは、オプションパラメータを1つ（AWSプロファイル名）指定します。デフォルトでは、aws configureコマンドを使用して、マシンに作成されたdefaultプロファイルを使用します。 カスタムクレデンシャルを使用するコマンド: ksm profile setup --type=aws --secret=ksm-config --credentials=keys 最後のタイプには、--aws-access-key-id、--aws-secret-access-key、--regionの3つの必須パラメータがあります 追加フラグ--fallbackを使用すると、初回のクレデンシャルが失敗した場合、（awsのローカル設定から）デフォルトのプロファイルへのフォールバックを指定できます --ini-file <FILENAME> 新しいプロファイルをこのファイルに保存します -p、--profile-name <NAME> プロファイル名を設定します。設定しない場合、プロファイルは「default」として設定されます

list

現在のクライアントデバイスで利用可能なすべてのプロファイルを一覧で表示します。

ksm profile list

例:

$ ksm profile list

  Active   Profile
 ======== ===============
           Production
  *        Test Server 1
           Test Server 2
           Local Dev

export

現在のプロファイルをbase64でエンコードした文字列にエクスポートします。

ksm profile export [--plain] [--file-format] [PROFILE NAME]

オプションパラメータ:

• --plain 文字列をbase64でエンコードせずにプロファイルをエクスポートします。

• --file-format プロファイルを特定のファイル形式にエクスポートします。利用可能な形式は以下のとおりです。

  • ini - CLIの別のインスタンスで使用されます。

  • json - CLIおよびその他の開発者用SDKで使用できます。

例

$ ksm profile export my_profile

import

暗号化されたbase64エンコード文字列からクライアントデバイスのプロファイルをインポートします。

ksm profile import [--output-file "INI filename"] <BASE64 CONFIG>

オプションパラメータ:

• --output-file <INI filename> INI設定ファイルの作成場所。設定されていない場合は、カレントディレクトリに作成されます。

$ ksm profile import --output-file=my_profile BASE64_ENC_CONFIG

active

このクライアントデバイスの現在有効なプロファイルを設定します。

ksm profile active <PROFILE NAME>

例:

$ ksm profile active production

production is now the active profile.

コンテナ内のプロファイル

コンテナ化された環境内でCLIを実行している場合、プロファイルを初期化できないことがあります。INI設定ファイルが見つからず、環境変数KSM_TOKENが見つかった場合、デフォルトプロファイルが自動生成されます。INI設定ファイルが作成され、現在の作業ディレクトリに格納されます。これは、環境変数KSM_INI_DIRで上書きできます。

デフォルトのINIファイル名

iniファイルのデフォルトの名前はkeeper.iniですが_、_**KSM_INI_FILE環境変数を使用して上書きできます。KSM_INI_DIRおよびKSM_INI_FILE**環境変数を使用すると、INI設定ファイルの場所と名前を完全に変更できます。