secretコマンド

Keeperボルトのシークレットとファイル添付の管理

secret コマンド

説明: ボルトからシークレットを取得し、レスポンスを解析します。

パラメータ

実行するサブコマンド

形式: ksm secret <サブコマンド>

サブコマンド

サブコマンド	説明
list	関連アプリケーションのシークレット一覧表示
get	ボルト内シークレットまたは特定フィールドの取得
add	ボルトへの新規シークレット追加
update	既存シークレット内フィールドの更新
delete	ボルトからのシークレット削除
upload	既存シークレットへのファイル添付のアップロード
download	名前指定によるファイル添付のダウンロード
delete-attachment	ファイル名またはUIDによる添付の削除
template	レコードタイプテンプレートの表示
notation	exec 向け環境変数テンプレートのテスト
totp	TOTPフィールドからのパスコード生成
password	パスワード生成

list

アプリケーションに関連付けられているすべてのシークレットを一覧で表示します。

ksm secret list

オプションパラメータ

• --json JSON形式での返却

• --uid <レコードUID> レコードUIDによる特定レコードの取得

• -t, --title <REGEX> タイトルが正規表現に一致するレコードの取得

• -f, --folder <フォルダUID> 指定フォルダ内レコードのみの一覧表示

• -r, --recursive サブフォルダを含む再帰的な一覧表示

• -q, --query <JSONPathクエリ> JSONPathクエリに一致するレコードのみの一覧表示

• -v, --show-value JSONPath使用時の一致値の出力 (タイトルに代えて)

--query スイッチでは、XPathに基づくクエリ構文であるJSONPathを使用します (仕様)。

例1: 表形式

ksm secret list

 UID                     Record Type          Title                    
 ----------------------- -------------------- -------------------------
 SNzjw8tM1HsXEzXERCJrNQ  login                Stripe API Key           
 8f8I-OqPV58o2r91wVgZ_A  databaseCredentials  Production MySQL Database
 hDFhwSUe6pTWdkJDSRmtBg  login                Amazon AWS              

例2: JSON形式

ksm secret list --json
[
    {
        "uid":"SNzjw8tM1HsXEzXERCJrNQ",
        "title":"Stripe API Key",
        "record_type": "login"
    },
    {
        "uid":"8f8I-OqPV58o2r91wVgZ_A",
        "title":"Production MySQL Database",
        "record_type": "databaseCredentials"
    },
    {
        "uid": "hDFhwSUe6pTWdkJDSRmtBg",
        "title":"Amazon AWS",
        "record_type": "login"
    }
]

例3: フォルダで絞り込み、タイトルで検索

ksm secret list --recursive --folder=KOx3pRkAnODGVWyDuK7ttw -t Stripe

 UID                     Record Type          Title         
 ----------------------- -------------------- --------------
 SNzjw8tM1HsXEzXERCJrNQ  login                Stripe API Key

例4: JSONPathによるユーザー名フィールドの検索

ksm secret list --query="$.fields[?(@.type=='login' & @.value[0]=='administrator')]"

 UID                     Record Type Title
 ----------------------- ----------- -------------
 exzoweGGpvYK0Z9_skWSPg  login       Login Record

ksm secret list --query="$.fields[?(@.type=='login' & @.value[0]=='administrator')].value" -v

 UID                     Record Type Value
 ----------------------- ----------- -------------
 exzoweGGpvYK0Z9_skWSPg  login       administrator

例5: JSONPathによるカスタムフィールドタイプの検索

ksm secret list --query=$.custom_fields[?(@.type==text)].value

 UID                     Record Type          Title
 ----------------------- -------------------- --------------
 SNzjw8tM1HsXEzXERCJrNQ  login                Stripe API Key

ksm secret list --query=$.custom_fields[?(@.type==text)].value -v

 UID                     Record Type          Value
 ----------------------- -------------------- ---------------
 SNzjw8tM1HsXEzXERCJrNQ  login                <API_Key_Value>

例6: JSONPathによるカスタムフィールドラベルと値の検索

$ ksm secret list -v -q '$.custom_fields[?(@.label=="app" & @.value[0]=="staging")].value'

 UID                Record Type Value
 ------------------ ----------- --------------
 i0U9lwTwl-7pChw8Q  login       staging
 8r9hxdlL7MINO6cJ9  login       staging

get

ボルトのシークレットまたはシークレットの特定のフィールドを取得します。

ksm secret get <レコードUID>

以下のパラメータの少なくとも1つが必要です。

• <レコードUID> レコードを1つ取得する場合は、レコードUIDをコマンドライン引数に含めることができます。

• -u、--uid <レコードUID> IDで特定のレコードを取得します。-uを複数使用して、複数のレコードを取得できます。

• -t、--title <RECORD TITLE> タイトルで特定のレコードを取得します。

オプションパラメータ

• -f、--field <Field Type or Custom Field Label> ラベルまたはタイプによる特定フィールド値の返却

• -q、--query <JSONPath Query> JSONPathクエリに一致する値のみの返却

• --json JSON形式での返却 (--query 使用時は必須)

• --raw 結果からの引用符削除

• --force-array 結果が1件でも配列としての返却

• --unmask 表形式でのパスワード値の表示

• --inflate/--deflate 他レコード参照の展開/非展開 (既定は展開)

レコードUIDが「-」で始まる場合は、以下のように先頭に「--」を付けます。 ksm secret get -- <レコードUID>

--query スイッチでは、XPathに基づくクエリ構文であるJSONPathを使用します (仕様)。

例1: 表形式での出力

$ ksm secret get 8f8I-OqPV58o2r91wVgZ_A

 Record:8f8I-OqPV58o2r91wVgZ_A
 Title:Production MySQL Database
 Record Type: databaseCredentials

 Field     Value                                         
 --------- ----------------------------------------------
 text      MySQL                                         
 host      [{"hostName":"192.168.1.24", "port":"3306"}]
 login     user                                          
 password  ****                                

例2: 表形式での出力 (パスワードをマスクしない)

 $ ksm secret get --unmask --uid 8f8I-OqPV58o2r91wVgZ_A
 
 Record:8f8I-OqPV58o2r91wVgZ_A
 Title:Production MySQL Database
 Record Type: databaseCredentials

 Field     Value                                         
 --------- ----------------------------------------------
 text      MySQL                                         
 host      [{"hostName":"192.168.1.24", "port":"3306"}]
 login     user                                          
 password  ksv#$0sbnb7W@b3VGCHb           

例3: パスワードフィールドの取得 (以下の2通り)

# フィールド検索の使用
$ ksm secret get -u SNzjw8tM1HsXEzXERCJrNQ -f password

# クエリ構文の使用
$ ksm secret get -u 8f8I-OqPV58o2r91wVgZ_A \
  --json --query '$.fields[?(@.type=="password")].value'

# 複雑な値にクエリ構文を使用
$ ksm secret get -u SNzjw8tM1HsXEzXERCJrNQ \
  --json --query '$.fields[?(@.type=="keyPair")].value[0].publicKey'

例4: カスタムフィールド値の取得 (以下の2通り)

# フィールド検索の使用
$ ksm secret get -u SNzjw8tM1HsXEzXERCJrNQ -f "API Key"

# クエリ表記法の使用
$ ksm secret get --uid SNzjw8tM1HsXEzXERCJrNQ \
  --json --query '$.custom[?(@.label=="API Key")].value'

クエリ構文は柔軟で、JSONオブジェクト内の任意の値を取得できます。カスタムフィールド値を指定する際は、\ と = を \ でエスケープしてください。

例5: 個別シークレットの生JSON取得

$ ksm secret get --unmask --uid 8f8I-OqPV58o2r91wVgZ_A --json
{
    "uid":"8f8I-OqPV58o2r91wVgZ_A",
    "title":"Production MySQL Database",
    "type": "databaseCredentials",
    "notes": "",
    "fields": [
        {
            "type": "text",
            "value": [
                "MySQL"
            ]
        },
        {
            "type": "host",
            "value": [
                {
                    "hostName":"192.168.1.24",
                    "port":"3306"
                }
            ]
        },
        {
            "type": "login",
            "value": [
                "user"
            ]
        },
        {
            "type": "password",
            "value": [
                "ksv#$0sbnb7W@b3VGCHb"
            ]
        },
        {
            "type": "fileRef",
            "value": []
        }
    ],
    "custom": [],
    "files": []
}

add

ボルトにレコードを追加します。既存レコードのクローン、ビジュアルエディタ、ファイル、フィールド引数の4通りから選べます。

レコードが正常に追加されると、標準出力にレコードUIDが出力されます。その他のテキストがある場合は標準エラーに表示されます。

editor

editor コマンドで、プレースホルダ値を含むレコードでエディタアプリケーションを起動します。プレースホルダの値を置き換えるか、値をすべて削除します。エディタアプリケーションは ksm config editor で設定するか、または EDITOR 環境変数で指定されたエディタを使用します。エディタが未設定の場合、インストール済みのエディタが自動的に検索されます。

UIを搭載したエディタを設定できます。WindowsおよびMac OSの場合、エディタから、レコードのテンプレートにプレースホルダが残っていると警告がある場合は、ブロッキングを有効にする必要があります。ブロッキングしない場合、編集が完了する前にCLIがレコードを処理しようとするためです。

macOSでは、ブロッキングが有効な場合、アプリケーションが完全に終了するまで待機してからレコードデータを処理します。完全に終了するとは、アプリケーションが閉じられてDockに表示されなくなることであり、エディタウィンドウが閉じられただけではありません。

Windowsでは、ブロッキングが有効な場合、エディタのプロセスがタスクリストから消えるまで待機します。アプリケーションが.batファイルまたは.cmdファイルを使用して起動された場合、プロセス名は起動されたアプリケーションとは異なります。これを適切に処理するには、ksm config editor を使用してエディタを設定します。

エディタがブロックせず、テンプレートマーカーに関するメッセージが表示された場合は、rと入力してファイルを再検査できます。これは、レコードの編集が完了して保存されたときに実行できます。

ksm secret add editor --sf <ストレージフォルダUID> --rt <レコードタイプ> [--title "TITLE"] [--notes "NOTES"] [-p] [-o yaml | json]

必須パラメータ

--storage-folder-uid, --sf 新しいシークレットレコードが作成されるストレージフォルダのUID。

--record-type, --rt シークレットレコードのレコードタイプ。

オプションパラメータ

--title, -t シークレットレコードのタイトル。

--notes, -n シークレットレコードに関連付けられたメモ。

--password-generate, -p 値が設定されていないパスワードフィールドのパスワードを生成します。

--output-format, -o エディタのテンプレートの出力形式。JSONまたはYAMLのいずれかを指定できます。デフォルトはJSONです。

--editor, -e エディタを上書きします。このパラメータを使用する場合、エディタがブロックします。

例

プレースホルダ値を持つログインレコードでエディタを起動します。値を設定するか、値をすべて置換してファイルを保存し、ブラウザを終了させます。

ksm secret add editor --sf XXXXXX --rt login -o yaml
<in the editor>
version: v3
kind: KeeperRecord
data:
- recordType: login
  title: '<#ADD: The title of record here. This is required.>'
  notes: '<#ADD: Add some notes or remove.>'
...
<save and exit from editor>
The following is the new record UID ...
["Ai9iFYWf6EOE0T9fV-ynBg"]

値がない場合は、「値」のキー/値の行全体を削除できます。フィールドを削除する必要はありません。

file

file コマンドは editor コマンドに似ていますが、2段階で実行するところが異なります。最初に ksm secret template コマンドでプレースホルダ付きレコードファイルを取得し、その後プレースホルダ値を置き換えてこのコマンドでファイルを読み込み、レコードを作成します。

このコマンドを使用すると、一度に複数のレコードを作成できます。

ksm secret add file --sf <ストレージフォルダUID> -f <テンプレートファイル> [-p]

必須パラメータ

--storage-folder-uid, --sf 新しいシークレットレコードが作成されるストレージフォルダのUID。

--file, -f レコードテンプレートファイルのパスと名前。

オプションパラメータ

--password-generate, -p 値が設定されていないパスワードフィールドのパスワードを生成します。

例

プレースホルダ値を含む銀行口座レコードタイプを保存します。お気に入りのエディタで編集して保存します。次に、ksm secret add file コマンドを使用して追加します。また、空白のパスワードフィールドがあれば、パスワードも生成されます。

ksm secret template bankAccount -f new_bank_account_record.json
<edit new_bank_account_record.json in favortite editor>
ksm secret add file --sf XXXX -f new_bank_account_record.json -p

field

field コマンドは、キー/値の引数をコマンドに渡してレコードの値を設定します。

ksm secret add field <--sf ストレージフォルダUID> <--rt レコードタイプ> <--title "タイトル"> [--notes "<メモ>"] [-p] <"フィールド" ...>

必須パラメータ

--storage-folder-uid, --sf 新しいシークレットレコードが作成されるストレージフォルダのUID。

--record-type, --rt シークレットレコードのレコードタイプ。

--title, -t シークレットレコードのタイトル。

FIELDS フィールドとその値からなるキー/値のペア。複数のフィールドを指定できます。

オプションパラメータ

--notes, -n シークレットレコードに関連付けられたメモ。

--password-generate, -p 値が設定されていないパスワードフィールドのパスワードを生成します。

例

ksm secret add field --sf XXXX --rt bankAccount \
    -t "My Bank Account" -n "My Checking Account" -p \
    "f.bankAccount.accountType=Checking" \
    "f.bankAccount.routingNumber=ROUT123" \
    "f.bankAccount.accountNumber=ACC456" \
    'f.name={"first":"John", "last":"Smith"}' \
    "login=jsmith" \
    "url=http://mybank.com" \
    "c.text[Bank Hours]=7:00AM to 5:00PM" \
    'c.phone=[{"number":"5551234567", "type":"Home"}, {"number":"5550987654"}]'
    
The following is the new record UID ...
Ai9iFYWf6EOE0T9fV-ynBg

field の構造は、[field section .]<field type>[[field label]][. value key]<=value> となります。

field section は、フィールドを設定する場所です。「f」は標準フィールド、「c」はカスタムフィールドです。設定しない場合、デフォルトで標準フィールドになります。

field type は必須となります。標準フィールドセクションの場合、フィールドタイプはレコードタイプスキーマの一部である必要があります。存在しないフィールドを追加しようとすると、エラーが表示されます。ユーザー設定フィールドセクションの場合、どのフィールドタイプでも追加できます。追加順に配列されます。

field label はオプションです。フィールドラベルは、field type の直後に [] で囲みます。カスタムフィールドセクションでは、ラベルが設定されていない場合、レコードフィールドタイプがUIで使用されます。

value key は、phone、bankAccount、name などの複合値を持つフィールドタイプのオプションです。value key を使用すると、値をJSON値として設定する代わりに、別々に作成できます。

value は、「=」文字の後から始まります。値が複雑な場合は、JSONが値として設定されます。JSONを使用する場合は、フィールドを適切に引用符で囲んでください。JSONで二重引用符を使用する場合は、フィールドを一重引用符で囲みます。両方が必要な場合は、引用符をバックスラッシュ (\) でエスケープする必要があります。

ルール

標準フィールドの場合、フィールドの設定順序は重要ではありません。フィールドは、レコードタイプスキーマによって並べ替えられます。レコードタイプスキーマ標準フィールドに存在しないフィールドは、標準フィールドに追加できません。

カスタムフィールドの場合、フィールドはフィールド引数の順序と同じ並びになります。

同じタイプのフィールドが複数ある場合は、field label を指定して一意にする必要があります。

値キー

値キーを使用した値の設定は、1つのフィールドを設定する場合に便利ですが、同じタイプの別のフィールドを設定する場合や、フィールドに複数の値 (電話番号) を指定する場合にはルールがあります。

同じタイプのフィールドを複数設定する場合、field label を使用して、フィールドを一意にします。

ksm secret add field --sf XXXX --rt "Custom Record" \
    "name[My Doctor].first=Jane" \
    "name[My Doctor].last=Smith" \
    "name[My Lawyer].first=John" \
    "name[My Lawyer].last=Doe"

field label を使用しない場合、前の値が既存の値を上書きします。

JSON値

値はJSON値に設定できます。複数の値を指定できるフィールドの場合、JSON値を設定すると、完全な値と見なされます。つまり、value key がJSON値の後に来ると、そのフィールドに新たな値が追加されます。以下の例では、2つの値を持つ電話番号フィールドを作成します。

ksm secret add field --sf XXXX --rt "Custom Record" \
    'c.phone={"number":"5551234567"}' \
    "c.phone.number=5551111111"

JSON値がJSONオブジェクトの配列である場合、このフィールドはすべて揃ったフィールドと見なされます。つまり、フィールドに新たな値を追加することはできません。以下では、最後のフィールドが一意でないというエラーが発生します。フィールドを一意にするには、field label を追加します。

ksm secret add field --sf XXXX --rt "Custom Record" \
    'c.phone=[{"number":"5551234567"}, {"number":"55599999999"}]',
    "c.phone.number=5551111111"
ksm had a problem:Cannot add this field due to it not being unique.To make unique add a label to the field or make sure the label is not being duplicated.

delete

アプリケーションに関連付けられたシークレットを削除します。

ksm secret delete

• --uid <レコードUID> レコードUIDでレコードを削除します。

オプションパラメータ

• --json JSON形式で返します。

例1: 表形式

$ ksm secret delete -u AAAAAAAAAAAAAAAAAAAAAA -u SNzjw8tM1HsXEzXERCJrNQ

 UID                     Response Code        Error                    
 ----------------------- -------------------- ---------
 AAAAAAAAAAAAAAAAAAAAAA  n/a                  Not Found
 SNzjw8tM1HsXEzXERCJrNQ  ok                  

例2: JSON形式

$ ksm secret delete --json -u AAAAAAAAAAAAAAAAAAAAAA -u riEeV5KUeiGqXXSidg47Zw
[
    {
        "uid": "AAAAAAAAAAAAAAAAAAAAAA",
        "responseCode": "n/a",
        "error": "Not found"
    },
    {
        "uid": "riEeV5KUeiGqXXSidg47Zw",
        "responseCode": "ok",
        "error": null
    }
]

clone

clone コマンドで、新しいタイトルを設定するオプションを使用して、既存のレコードのデータを使用して新しいレコードを作成します。

ksm secret add clone --uid <レコードUID> --title "タイトル"

必須パラメータ

--uid, -u 既存のレコードのレコード UID。

オプションパラメータ

--title, -t 新しいレコードのタイトル。

例

ksm secret add clone --uid XXXX --title NewTitle
    
The following is the new record UID ...
Ai9iFYWf6EOE0T9fV-ynBg

update

既存のシークレット内の既存のフィールドを更新します。

一部のフィールドタイプは複合的です。これは、値に配列や値の連想配列が含まれることを意味します。複合的なフィールドタイプを使用している場合は、--field-json と --custom-field-json を使用して、値を設定する必要があります。JSON構造については、こちらのページをご参照ください。

ksm secret update --uid <レコードUID>

オプションパラメータ

• --field 特定の標準フィールド値の更新

• --custom-field 特定のカスタムフィールド値の更新

• --field-json JSONによる特定の標準フィールド値の更新 (複合フィールド値向け)

• --custom-field-json JSONによる特定のカスタムフィールド値の更新 (複合フィールド値向け)

• --title, -t シークレットタイトルの更新

• --notes, -n シークレットメモの更新

更新は、既存のフィールドラベルとカスタムフィールドラベルのキーと照合します。「=」文字の後に表示されるものはすべて値と見なされます。パラメータ値を引用符で囲む場合を除き、値をエスケープする必要はありません。

例1: 基本的な使用例

# シークレットのパスワードを更新
$ ksm secret update --uid XXXXX --field password=xxxxxxxxxxx

# カスタムフィールドの値を更新
$ ksm secret update --uid XXXXX --custom-field "My Custom Label=XXXXX"

例2: 値にスペースや引用符が含まれる場合

キーまたはフィールドの値にスペースが含まれる場合は、パラメータ値全体を引用符で囲みます。値に引用符が含まれる場合 (JSONなど) は、一重引用符で囲みます。

$ ksm secret update --uid XXXXX --custom-field "My Base64=SElUSEVSRQo="

$ ksm secret update --uid XXXXX --field-json 'name={"first":"John", "middle":"X", "last":"Doe"}'

upload

ボルト内の既存のシークレットに添付ファイルをアップロードします。

ksm secret upload -u <レコードUID> --file "<ファイル名>" --title "<ファイルのタイトル>"

パラメータ

• -u, --uid <レコードUID> アップロード先のシークレットの UID (必須)

• -f, --file <ファイル名> アップロードするファイルへのファイルパス (必須)

• -t, --title <ファイルのタイトル> (指定されていない場合はファイル名 (パスなし) がデフォルトになります (オプション)

例

$ ksm secret upload -u oxhtLx9qrQIzeSXBtvQj2Q \
   --file "/path/to/SSHKey.pem" --title "SSHKey.pem"

download

ボルトのシークレットからSSH鍵などの添付ファイルをダウンロードします。

ksm secret download -u <レコードUID> --name "<ファイル名>" --file-output "<ファイル出力先>"

オプションパラメータ

• -u、--uid <レコードUID> ダウンロードするシークレットのUID (必須)

• --name <ファイル名> ダウンロードするファイルの名前 (必須)

• --file-output <ファイル名 | STDOUT | STDERR> ファイルの内容を書き込む場所 (必須)

• --create-folders ファイル名のパスのフォルダを作成します。

例

$ ksm secret download -u oxhtLx9qrQIzeSXBtvQj2Q \
   --name "SSHKey.pem" --file-output SSHKey.pem

delete-attachment

ボルト内のシークレットから添付ファイルを削除します。

ksm secret delete-attachment -u <RECORD UID> -f "<FILE_UID>" -file "<FILENAME>"

必須パラメータ

• -u, --uid <RECORD UID> 添付ファイルを含むシークレットのUID (必須)

• -f, --file <FILENAME|UID> 削除するファイルの名前またはUID (必須)

例

$ ksm secret delete-attachment -u oxhtLx9qrQIzeSXBtvQj2Q \
   --file "SSHKey.pem" --file 8f8IBOqPV58o2r91wVgZ_A

template

レコードまたはフィールドタイプのテンプレート情報を表示します。

record

レコードタイプスキーマテンプレートとレコードタイプリストを取得します。

ksm secret template record [-l] [-o json | yaml] [-f 出力ファイル] [レコードタイプ]

以下のいずれかのパラメータが必要です。

--show-list, -l 利用可能なすべてのレコードタイプを一覧表示します。

RECORD TYPE このレコードタイプのスキーマテンプレートを取得します。

オプションパラメータ

--output-format, -o スキーマをJSONまたはYAMLとして出力します。デフォルトはJSONです。

--output-file, -f スキーマをファイルに出力します。

例1: レコードタイプの一覧取得

$ ksm secret template record -l

 Record Type
 ------------------------
 login
 bankAccount
 address
...

例2: bankAccount レコードタイプのスキーマ取得 (YAML)

ksm secret template record -o yaml bankAccount

version: v3
kind:KeeperRecord
data:
- recordType: bankAccount
  title: '<#ADD:The title of record here.This is required.>'
  notes: '<#ADD:Add some notes or remove.>'
  fields:
  - type: bankAccount
    value:
      accountType: '<#ADD:Checking | Other | Savings>'
      otherType: '<#ADD:Other Type Description>'
      routingNumber: '<#ADD:Routing Number>'
      accountNumber: '<#ADD:Account Number>'
    privacyScreen: false
  - type: name
    value:
      first: '<#ADD:First Name>'
      middle: '<#ADD:Middle name>'
      last: '<#ADD:Last Name>'
    privacyScreen: false
  - type: login
    value: '<#ADD:Insert a str>'
    privacyScreen: false
  - type: password
    value: '<#ADD:Password or Remove If Generating>'
    privacyScreen: false
    enforceGeneration: false
    complexity:
      length:64
      caps:0
      lowercase:0
      digits:0
      special:0
  - type: url
    value: '<#ADD:Insert a str>'
    privacyScreen: false
  - type: cardRef
    value: '<#ADD:Record UID of PaymentCard record.>'
    privacyScreen: false
  - type: fileRef
    value: '<#ADD:Record UID of File record.>'
    privacyScreen: false
  - type: oneTimeCode
    value: '<#ADD:URL starting with otpauth://>'
    privacyScreen: false

field

フィールドタイプスキーマとフィールドタイプリストを取得します。

以下のいずれかのパラメータが必要です。

--show-list, -l 利用可能なすべてのフィールドタイプを一覧表示します。

FIELD TYPE このフィールドタイプのスキーマを取得します。

オプションパラメータ

--output-format, -o スキーマをJSONまたはYAMLとして出力します。デフォルトはJSONです。

例1: フィールドタイプの一覧取得

$ ksm secret template field -l

Field Type
 ----------------
 accountNumber
 address
 addressRef
...

例2: フィールドタイプのスキーマ取得 (既定のJSON)

$ ksm secret template field securityQuestion

{
    "type": "securityQuestion",
    "value": {
        "question": "<#ADD:Security Question>",
        "answer": "<#ADD:Answer To The Question>"
    },
    "privacyScreen": false
}

notation

ksm exec コマンドの環境変数置換をテストします。

ksm secret notation <NOTATION FIELD PATH>

このサブコマンドでは、keeper:// テンプレートURLでフィールド値を返し、環境変数置換の動作を確認できます。

例

$ ksm secret notation keeper://8f8I-OqPV58o2r91wVgZ_A/field/password
ksv#$0sbnb7W@b3VGCHb

$ ksm secret notation keeper://oxhtLx9qrQIzeSXBtvQj2Q/field/password
H=cBcl(u6%Ouv]mXpkPU>u]C;P0>E%yrcML

環境変数置換の詳細については、Execコマンドをご参照ください。

レコードUIDが「-」で始まる場合は、UIDの前に「--」を付けてフィールドを取得します。 ksm secret notation -- <レコードUID>/field/password

totp

ボルトのシークレットのTOTPフィールドから有効なパスコードを生成します。

ksm secret totp <レコードUID>

必須パラメータ

• <レコードUID> TOTPフィールドを含むシークレットのUID

例

$ ksm secret totp oxhtLx9qrQIzeSXBtvQj2Q
123456

password

ランダムなパスワードを生成します。

ksm secret password --length <パスワードの長さ> --lc <小文字の数> --uc <大文字の数> -d <数字の数> --sc <記号の数>

オプションパラメータ

--length または文字グループカウント (--lc, --uc, --digits, --sc) を使用します。文字グループカウントパラメータを使用すると、長さはそれらの値の合計になります。

合計長。文字グループの値は、その長さから自動的に均等に分割されます。

• --length, -l パスワードの長さ。これにより、小文字、大文字、数字、記号の間でこの長さが分割されます。

文字グループ

• -lc = 小文字の数。

• -uc = 大文字の数。

• -d = 数字の数。

• -sc = 記号の数。

例

$ ksm secret password
j.th,D,X92[B;d<F{2IkxuWS={#G4g7=b39kA16v6p44lqBU=v.Y6?MH5}$H3pG4

$ ksm secret password --length 32
5N=%B6ytb9No3w[F7WYgN0V@"+2j!u1#%

$ ksm secret password -lc 10
qaytxkwdwb

$ ksm secret password -lc 2 -uc 2 -d 2 -sc 0
4keD0V

「-」で始まるレコードUID

レコードUIDが「-」 (ダッシュ/ハイフン) で始まる場合、KSM CLIで使用するには先頭に「--」を付けます。

例

ksm secret get -- -id8QpE2ZAkdd4KlCfoWQ

*この例のUIDは実際のレコードUIDではありません。

詳細については、トラブルシューティングをご参照ください。