1. RESTfulサービス管理者ガイド
  2. セキュリティ・オブジェクトのコマンド

5 セキュリティ・オブジェクトのコマンド

エンドポイントでは、管理対象オブジェクトの操作にセキュリティ・オブジェクト・コマンドを使用できます。

5.1 okv managed-object attribute addコマンド

okv managed-object attribute addコマンドでは、セキュリティ・オブジェクトに1つ以上の属性を追加します。

セキュリティ・オブジェクトの既存の属性を調べるには、okv managed-object attribute listコマンドを実行します。カスタム属性を作成するには、okv managed-object custom-attribute addコマンドを使用します。

必要な権限

エンドポイントには、オブジェクトに対する読取り変更権限が必要です。

構文

 okv managed-object attribute add [--activation-date activation date] [--contact-info contact information] [--deactivation-date deactivation date] [--name name] [--process-start-date process start date] [--protect-stop-date protect stop date] --uuid uuid

このコマンドで、コマンドラインで--uuidパラメータを指定して属性を指定するには、次のJSON構文を使用できます。これは、複数のオブジェクトに同じ属性値を適用する際に役立ちます。同じJSONファイルを再利用して、コマンドラインで異なるUUIDを指定できます。

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "managed-object",
    "resource" : "attribute",
    "action" : "add",
    "options" : {
      "uuid" : "#VALUE",
      "attributes" : {
        "name" : {
        "value" : "#VALUE",
        "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
      }
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--uuid / uuid

必須

セキュリティ・オブジェクトのUUID (Universally Unique ID)

オブジェクトの一意識別子を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブをクリックして、左側のナビゲーション・ウィンドウで「Keys & Secrets」をクリックします。「Keys & Secrets」表で、「Unique Identifier」列を確認します。

「okv managed-object object locateコマンド」を参照
--activation-date / activationDate

オプション
セキュリティ・オブジェクトをアクティブ化するタイミングを指定します。形式は次のとおりです。
"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time
このパラメータを省略した場合、アクティブ化日は、アップロードされている証明書ファイルから取得されます。 
If activationDate meets the date criteria,the date is overwritten with the provided date.
    notBefore < deactivationDate <= notAfter
    activationDate < deactivationDat
activation-dateが条件を満たさない場合は、エラー・メッセージが表示されます。
contact-info / contactInfo

オプション

この属性は説明目的でのみ使用されます。
--deactivation-date / deactivationDate

オプション
セキュリティ・オブジェクトを非アクティブ化するタイミングを指定します。activation-dateと同じ形式です。このパラメータを省略した場合、非アクティブ化日は、アップロードされている証明書ファイルから取得されます。 
If deactivationDate meets the date criteria,the date is overwritten with the provided date.
 notBefore <= activationDate < notAfter
 activationDate < deactivationDate
deactivation-dateが条件を満たさない場合は、エラー・メッセージが表示されます。
--name / name

オプション

セキュリティ・オブジェクトの名前を指定します。使用可能な値は次のとおりです。

  • value
  • type

デフォルト値は次のとおりです。

  • text
    -Support complex data format, name attribute in command line
        --name '{"value" : "KEY1", "type" : "uri"}'or
        --name '{"value" : "KEY1", "type" : "text}'
-Support simplified data format, name attribute in command line. when type is "text" as a default:
        --name KEY1
--process-start-date / process start date

オプション

日時を指定します。有効なセキュリティ・オブジェクトで、暗号で保護された情報の処理が開始される時間。
--protect-stop-date / protectStopDate

オプション

有効なセキュリティ・オブジェクトを暗号化保護の適用に使用できなくなる日時を指定します。

/ attributes

必須

属性のリストを含むJSONオブジェクト。属性を追加する場合は、JSON構文を使用する必要があります。コマンドラインでは属性を指定できません。管理対象オブジェクトの既存の属性を調べるには、okv managed-object attribute listコマンドを実行します。

入力できる属性は次のとおりです。

  • nameには、次の情報が含まれます。
    • valueは、値名です。
    • typeは、textまたはuriです。コマンドラインでname属性が使用されている場合、デフォルトのタイプはtextです。
  • contactInfo: オブジェクトの連絡先情報。たとえば、電子メール・アドレスです。
  • 次の日時属性:
    • activationDate: 管理対象オブジェクトを使用する日時が含まれます。
    • deactivationDate: 復号化を除き、管理対象オブジェクトをいかなる目的にも使用しない日時。
    • protectStopDate: 有効な管理対象オブジェクトを、暗号で保護された情報を処理するため(復号化やアンラップなど)に使用する日時。
    • processStartDate: 有効な管理対象オブジェクトを、暗号化保護の適用(暗号化やラップなど)に使用しない日時。

日付と時間を設定するには、様々な方法を使用できます。次に各例を示します。 

"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time

UTC書式で時間を表示するには、Linuxのdateコマンドを使用します。たとえば: 

$ date --utc "+%F %T"
2021-03-15 20:31:37

これらの属性の詳細は、Key Management Interoperability Protocol仕様バージョン1.1を参照してください。

JSONの例

  1. okv managed-object attribute addコマンド用にJSON入力を生成し、保存します。 
    okv managed-object attribute add --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "managed-object",
    "resource" : "attribute",
    "action" : "add",
    "options" : {
      "uuid" : "#VALUE",
      "attributes" : {
       "name" : {
         "value" : "#VALUE",
         "type" : "#text|uri"
         },
        "contactInfo" : "#VALUE",
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
      }
    }
  }
}
  2. 生成された入力をファイル(たとえば、add_attribute.json)に保存し、それを編集してセキュリティ・オブジェクトの属性を含めます。たとえば:
    {
  "service" : {
    "category" : "managed-object",
    "resource" : "attribute",
    "action" : "add",
    "options" : {
      "uuid" : "2359E04F-DA61-4F7C-BF9F-913D3369A93A",
      "attributes" : {
        "contactInfo" : "psmith@example.com",
        "deactivationDate" : "2024-12-31 09:00:00",
        "name" : {
         "value" : "PROD-HRDB-MKEY",
         "type" : "text"
         },
       "protectStopDate" : "2024-09-30 09:00:00"
      }
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object attribute addコマンドを実行します。 
    okv managed-object attribute add --from-json add_attribute.json

    出力は、次のようになります。 

    {
  "result" : "Success",
  "value" : {
    "attributes" : {
      "contactInfo" : "Added",
      "deactivationDate" : "Added",
      "name" : "Added",
      "protectStopDate" : "Added"
      }
   }    
 }

関連トピック

親トピック: セキュリティ・オブジェクトのコマンド

5.2 okv managed-object attribute deleteコマンド

okv managed-object attribute deleteコマンドでは、セキュリティ・オブジェクトに関連付けられている1つ以上の属性を削除します。

必要な権限

エンドポイントには、オブジェクトに対する読取り変更権限が必要です。

構文

okv managed-object attribute delete [--activation-date] [--contact-info] [--deactivation-date]
             [--name name] [--process-start-date] [--protect-stop-date] --uuid uuid

このコマンドで、コマンドラインで--uuidパラメータを指定して属性を指定するには、次のJSON構文を使用できます。これは、複数のオブジェクトに同じ属性値を適用する際に役立ちます。同じJSONファイルを再利用して、コマンドラインで異なるUUIDを指定できます。

JSON入力ファイル・テンプレート

{
  "service": {
    "category": "managed-object",
    "resource": "attribute",
    "action": "delete",
    "options": {
      "uuid": "#VALUE",
      "attributes": {
        "name": {
          "value": "#VALUE"
        },
        "contactInfo": "#VALUE",
        "activationDate": "#VALUE",
        "deactivationDate": "#VALUE",
        "protectStopDate": "#VALUE",
        "processStartDate": "#VALUE"
      }
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--uuid / uuid

必須

セキュリティ・オブジェクトのUUID (Universally Unique ID)

オブジェクトの一意識別子を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブをクリックして、左側のナビゲーション・ウィンドウで「Keys & Secrets」をクリックします。「Keys & Secrets」表で、「Unique Identifier」列を確認します。

--activation-date

オプション
セキュリティ・オブジェクトをアクティブ化するタイミングを指定します。形式は次のとおりです。
"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time
このパラメータを省略した場合、アクティブ化日は、アップロードされている証明書ファイルから取得されます。 
If activationDate meets the date criteria,the date is overwritten with the provided date.
    notBefore < deactivationDate <= notAfter
    activationDate < deactivationDate
activation-dateが条件を満たさない場合は、エラー・メッセージが表示されます。
--contact-info / contactInfo

オプション

この属性は説明目的でのみ使用されます。
--deactivation-date / deactivationDate

オプション
セキュリティ・オブジェクトを非アクティブ化するタイミングを指定します。activation-dateと同じ形式です。このパラメータを省略した場合、非アクティブ化日は、アップロードされている証明書ファイルから取得されます。 
If deactivationDate meets the date criteria,the date is overwritten with the provided date.
 notBefore <= activationDate < notAfter
 activationDate < deactivationDate
deactivation-dateが条件を満たさない場合は、エラー・メッセージが表示されます。
--name / name

オプション

セキュリティ・オブジェクトの名前を指定します。使用可能な値は次のとおりです。

  • value
  • type

デフォルト値は次のとおりです。

  • text
    -Support complex data format, name attribute in command line
        --name '{"value" : "KEY1", "type" : "uri"}'or
        --name '{"value" : "KEY1", "type" : "text}'
-Support simplified data format, name attribute in command line. when type is "text" as a default:
        --name KEY1
--process-start-date / processStartDate

オプション

日時を指定します。有効なセキュリティ・オブジェクトで、暗号で保護された情報の処理が開始される時間。
--protect-stop-date / protectStopDate

オプション

有効なセキュリティ・オブジェクトを暗号化保護の適用に使用できなくなる日時を指定します。

/ attributes

必須

属性のリストを含むJSONオブジェクト。属性を指定する場合は、JSON構文を使用する必要があります。コマンドラインでは属性を指定できません。管理対象オブジェクトの既存の属性を調べるには、okv managed-object attribute listコマンドを実行します。

削除できる属性は次のとおりです。

  • name (削除するname属性インスタンスの値も指定する必要があります)。
  • 次の日時属性:
    • activationDate
    • deactivationDate
    • protectStopDate
    • processStartDate

    日付と時間を設定するには、様々な方法を使用できます。次に各例を示します。 

    "activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time

    UTC書式で時間を表示するには、Linuxのdateコマンドを使用します。たとえば: 

    $ date --utc "+%F %T"
2021-03-15 20:31:37

JSONの例

  1. okv managed-object attribute deleteコマンド用にJSON入力を生成します。 
    okv managed-object attribute delete --generate-json-input

    次のような入力が生成されます。 

    {
  "service": {
    "category": "managed-object",
    "resource": "attribute",
    "action": "delete",
    "options": {
      "uuid": "#VALUE",
      "attributes": {
        "name": {
          "value": "#VALUE"
        },
        "contactInfo": "#VALUE",
        "activationDate": "#VALUE",
        "deactivationDate": "#VALUE",
        "protectStopDate": "#VALUE",
        "processStartDate": "#VALUE"
      }
    }
  }
}
  2. 生成された入力をファイル(たとえば、del_attribute.json)に保存し、セキュリティ・オブジェクトに関連付けられた属性を削除できるように編集します。
    {
  "service": {
    "category": "managed-object",
    "resource": "attribute",
    "action": "delete",
    "options": {
      "uuid": "2359E04F-DA61-4F7C-BF9F-913D3369A93A",
      "attributes": {
        "name": {
          "value": "PROD-HRDB-MKEY"
        }
      }
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object attribute deleteコマンドを実行します。 
    okv managed-object attribute delete --from-json del_attribute.json

    出力は、次のようになります。 

    {
  "result": "Success",
  "value": {
    "attributes": {
      "name": "Deleted"
    }
  }
}

関連トピック

親トピック: セキュリティ・オブジェクトのコマンド

5.3 okv managed-object attribute getコマンド

okv managed-object attribute getコマンドでは、セキュリティ・オブジェクトの属性または属性のリストを取得します。

必要な権限

エンドポイントには、オブジェクトに対する読取り権限が必要です。

構文

okv managed-object attribute get [--activation-date] [--archive-date] [--certificate-length] [--certificate-type]
 [--compromise-date] [--compromise-occurrence-date] [--contact-info] [--crypto-usage-mask] [--cryptographic-algorithm]
 [--cryptographic-length][--custom-attribute] [--custom-attributes custom attributes] [--deactivation-date] [--destroy-date]
 [--digest] [--digital-signing-algorithm ][--extractable] [--initial-date] [--last-change-date] [--link] [--name][--never-extractable]
 [--object-group-member] [--object-type][- -process-start-date] [--protect-stop-date] [--state] --uuid [uuid] [--x509-certificate-issuer]
 [--x509-certificate-subject]

このコマンドで、コマンドラインで--uuidパラメータを指定して属性を指定するには、次のJSON構文を使用できます。これは、複数のオブジェクトに同じ属性値を適用する際に役立ちます。同じJSONファイルを再利用して、コマンドラインで異なるUUIDを指定できます。

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "managed-object",
    "resource" : "attribute",
    "action" : "get",
    "options" : {
      "uuid" : "#VALUE",
      "attributes" : [ "#ATTRIBUTE_NAME", "#ATTRIBUTE_NAME", "#ATTRIBUTE_NAME"],
      "customAttributes" : [ "#ATTRIBUTE_NAME", "#ATTRIBUTE_NAME", "#ATTRIBUTE_NAME" ]
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明
--activation-date /

オプション
セキュリティ・オブジェクトをアクティブ化するタイミングを指定します。形式は次のとおりです。
"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time
このパラメータを省略した場合、アクティブ化日は、アップロードされている証明書ファイルから取得されます。 
If activationDate meets the date criteria,the date is overwritten with the provided date.
    notBefore < deactivationDate <= notAfter
    activationDate < deactivationDate
activation-dateが条件を満たさない場合は、エラー・メッセージが表示されます。
--archive-date /

オプション

セキュリティ・オブジェクトがアーカイブ・ストレージに保管された日時を指定します。
--certificate-length /

オプション

証明書オブジェクトの長さをバイト単位で指定します。

--certificate-type /

オプション

証明書のタイプを指定します。
--compromise-date /

オプション

管理対象暗号化オブジェクトが侵害状態になった日時を指定します。

--compromise-occurrence-date /

オプション

そのセキュリティ・オブジェクトが最初に侵害されたと考えられる日時を指定します。この設定は、--codeパラメータにKEY_COMPROMISEが指定されている場合のみ使用します。

--contact-info /

オプション

この属性は説明のためにのみ用意されています。
--crypto-usage-mask /

オプション

セキュリティ・オブジェクトの暗号化使用方法を指定します。
--cryptographic-algorithm/

オプション

セキュリティ・オブジェクトで使用されるアルゴリズムを指定します。
--cryptographic-length/

オプション

セキュリティ・オブジェクトの暗号化キー・マテリアルの長さをビット単位で指定します。
--custom-attributes / customAttributes

オプション

Oracle Key Vaultで解釈できない、エンドポイントで定義されている追加属性を指定します。
--deactivation-date /

オプション
セキュリティ・オブジェクトを非アクティブ化するタイミングを指定します。activation-dateと同じ形式です。このパラメータを省略した場合、非アクティブ化日は、アップロードされている証明書ファイルから取得されます。 
If deactivationDate meets the date criteria,the date is overwritten with the provided date.
 notBefore <= activationDate < notAfter
 activationDate < deactivationDate
deactivation-dateが条件を満たさない場合は、エラー・メッセージが表示されます。
--destroy-date /

オプション

セキュリティ・オブジェクトが破棄された日時を指定します。

--digest /

オプション

セキュリティ・オブジェクトのダイジェスト値を指定します。
--digital-signing-algorithm /

オプション

デジタル署名付きオブジェクトに関連付けられているデジタル署名アルゴリズムを指定します。
--extractable /

オプション
true値またはfalse値を指定します。
  • FALSE: オブジェクト値の取得がサーバーで防止されるように指定します。
  • TRUE: クライアントで値が指定されていない場合に、デフォルト値としてtrueを指定します。
.
--initial-date/

オプション

セキュリティ・オブジェクトがサーバーで最初に作成または登録された日時を指定します。
--last-change-date /

オプション

指定されたオブジェクトの最終変更の日時を指定します。
--link /

オプション

あるセキュリティ・オブジェクトから別の密接に関連するターゲット・セキュリティ・オブジェクトへのリンクを指定します。
--name /

オプション

検索するオブジェクトの名前を指定します。
--never-extractable /

オプション

抽出可能属性が常にFALSEの場合に、値としてTRUEを指定します。

--object-group-member /

オプション

オブジェクト・グループ・メンバー・タイプとしてDEFAULTまたはFRESHを指定します。

--object-type /

オプション

セキュリティ・オブジェクト・タイプを指定します。
--process-start-date /

オプション

有効なセキュリティ・オブジェクトでの、暗号で保護された情報の処理が開始される日時を指定します。
--protect-stop-date /

オプション

有効なセキュリティ・オブジェクトを暗号化保護の適用に使用できなくなる日時を指定します。
--state /

オプション

オブジェクトの様々な状態としてPREACTIVE、ACTIVE、DEACTIVATED、COMPROMISED、DESTROYEDおよびDESTROYED_COMPROMISEDを指定します。

--uuid / uuid

必須

セキュリティ・オブジェクトのUUID (Universally Unique ID)

オブジェクトの一意識別子を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブをクリックして、左側のナビゲーション・ウィンドウで「Keys & Secrets」をクリックします。「Keys & Secrets」表で、「Unique Identifier」列を確認します。

--attributes

オプション

次の1つ以上の属性を指定します:

activationDate、archiveDate、certificateLength、certificateType、compromiseDate、compromisOccurrenceDate、contactInfo、cryptoUsageMaskcustomAttributes、deactivationDate、destroyDate digitalSigningAlgorithm initialDate、lastChangeDate、name、neverExtractable、objectGroupMember、objectType、processStartDate、protectStopDate、state、uuid、x509CertificateIssuer、x509CertificateSubject。

JSONの例

  1. okv managed-object attribute getコマンド用にJSON入力を生成します。 
    okv managed-object attribute get --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "managed-object",
    "resource" : "attribute",
    "action" : "get",
    "options" : {
      "uuid" : "#VALUE",
      "attributes" : [ "#ATTRIBUTE_NAME", "#ATTRIBUTE_NAME", "#ATTRIBUTE_NAME" ],
      "customAttributes" : [ "#ATTRIBUTE_NAME", "#ATTRIBUTE_NAME", "#ATTRIBUTE_NAME" ]
    }
  }
}
  2. 生成された入力をファイル(たとえば、get_attribute.json)に保存し、それを編集して、セキュリティ・オブジェクトに関連付けられた属性を取得します。
    {
  "service" : {
    "category" : "managed-object",
    "resource" : "attribute",
    "action" : "get",
    "options" : {
       "uuid": "2359E04F-DA61-4F7C-BF9F-913D3369A93A",
       "attributes": [
         "activationDate",
         "contactInfo",
         "cryptoUsageMask",
         "cryptographicAlgorithm",
         "cryptographicLength",
         "name",
         "objectType",
         "state",
         "extractable",
         "neverExtractable"
      ],
      "customAttributes" : ["x-ApplicationTag"]
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object attribute getコマンドを実行します。 
    okv managed-object attribute get --from-json get_attribute.json

    出力は、次のようになります。 

    {
  "result": "Success",
  "value": {
    "attributes": {
      "activationDate": "2020-11-21 01:00:00",
      "contactInfo": "psmith@example.com",
      "cryptoUsageMask": [
        "ENCRYPT",
        "DECRYPT"
      ],
      "cryptographicAlgorithm": "AES",
      "cryptographicLength": "256",
      "extractable" : "false",
      "name": [
        {
          "type": "text",
          "value": "PROD-HRDB-MKEY"
        }
      ],
      "neverExtractable" : "TRUE",
      "objectType": "Symmetric Key",
      "state": "Active"
    },
    "customAttributes": [
      {
        "index": "1",
        "name": "x-ApplicationTag",
        "type": "Text String",
        "value": "HR-Production"
      }
    ]
  }
}

親トピック: セキュリティ・オブジェクトのコマンド

5.4 okv managed-object attribute get-allコマンド

okv managed-object attribute get-allコマンドでは、セキュリティ・オブジェクトのすべての属性を取得します。

必要な権限

エンドポイントには、オブジェクトに対する読取り権限が必要です。

構文

okv managed-object attribute get-all --uuid UUID

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "managed-object",
    "resource" : "attribute",
    "action" : "get-all",
    "options" : {
      "uuid" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--uuid / uuid

必須

セキュリティ・オブジェクトのUUID (Universally Unique ID)

オブジェクトの一意識別子を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブをクリックして、左側のナビゲーション・ウィンドウで「Keys & Secrets」をクリックします。「Keys & Secrets」表で、「Unique Identifier」列を確認します。

JSONの例

  1. okv managed-object attribute get-allコマンド用にJSON入力を生成します。 
    okv managed-object attribute get-all --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "managed-object",
    "resource" : "attribute",
    "action" : "get-all",
    "options" : {
      "uuid" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、get_all_attributes.json)に保存し、それを編集してセキュリティ・オブジェクトのすべての属性を取得します。
    {
  "service" : {
    "category" : "managed-object",
    "resource" : "attribute",
    "action" : "get-all",
    "options" : {
      "uuid" : "2359E04F-DA61-4F7C-BF9F-913D3369A93A"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object attribute get-allコマンドを実行します。 
    okv managed-object attribute get-all --from-json get_all_attributes.json

    出力は、次のようになります。 

    {  
  "result" : "Success",  "value" : {
    "attributes" : {
      "activationDate" : "2022-10-28 18:58:34",
      "cryptoUsageMask" : [ "SIGN" ],
      "cryptographicAlgorithm" : "RSA",
      "cryptographicLength" : "2048",
      "digest" : {
        "algorithm" : "SHA-256",
        "digestValue" : "9E6C6718C34FE44E3C91558CB83278CEC0706B8906BF0DED23A6117DC9EE6CD0",
        "keyFormatType" : "RAW"
      },
      "extractable" : "false",
      "fresh" : "Yes",
      "initialDate" : "2022-10-28 18:58:36",
      "lastChangeDate" : "2022-10-28 18:58:38",
      "neverExtractable" : "true",
      "objectType" : "Private Key",
      "processStartDate" : "2022-10-28 18:58:36",
      "state" : "Active",
      "uuid" : "06024832-066A-4F02-BF03-FA5B09E9A6AF"
    }
  }
}

親トピック: セキュリティ・オブジェクトのコマンド

5.5 okv managed-object attribute listコマンド

okv managed-object attribute listコマンドでは、セキュリティ・オブジェクトに関連付けられている属性の名前を取得します。

okv managed-object attribute listコマンドは、オブジェクトに1つ以上のカスタム属性がある場合にはキーcustomAttributesを表示します。オブジェクトに定義されているカスタム属性を調べるには、okv managed-object attribute get-allコマンドを実行します。

必要な権限

エンドポイントには、オブジェクトに対する読取り権限が必要です。

構文

okv managed-object attribute list --uuid UUID

JSON入力ファイル・テンプレート

{
  "service": {
    "category": "managed-object",
    "resource": "attribute",
    "action": "list",
    "options": {
      "uuid": "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--uuid / uuid

必須

セキュリティ・オブジェクトのUUID (Universally Unique ID)

オブジェクトの一意識別子を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブをクリックして、左側のナビゲーション・ウィンドウで「Keys & Secrets」をクリックします。「Keys & Secrets」表で、「Unique Identifier」列を確認します。

JSONの例

  1. okv managed-object attribute listコマンド用にJSON入力を生成します。 
    okv managed-object attribute list --generate-json-input

    次のような入力が生成されます。 

    {
  "service": {
    "category": "managed-object",
    "resource": "attribute",
    "action": "list",
    "options": {
      "uuid": "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、list_attributes.json)に保存し、それを編集してセキュリティ・オブジェクトの属性のリストを取得します。
    {
  "service": {
    "category": "managed-object",
    "resource": "attribute",
    "action": "list",
    "options": {
      "uuid": "2359E04F-DA61-4F7C-BF9F-913D3369A93A"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object attribute listコマンドを実行します。 
    okv managed-object attribute list --from-json list_attributes.json

    出力は、次のようになります。 

    {
  "result": "Success",
  "value": {
     "attributes" : [
         "activationDate",
         "contactInfo",
         "cryptoUsageMask",
         "cryptographicAlgorithm",
         "cryptographicLength",
         "deactivationDate",
         "digest",
         "extractable",
         "fresh",
         "initialDate",
         "lastChangeDate",
         "name",
         "neverExtractable", 
         "objectType",
         "processStartDate",
         "protectStopDate",
         "state"
         "uuid"
      ],
     "customAttributes" : [ "x-ApplicationTag" ]
  }
}

親トピック: セキュリティ・オブジェクトのコマンド

5.6 okv managed-object attribute modifyコマンド

okv managed-object attribute modifyコマンドでは、セキュリティ・オブジェクトに関連付けられている属性を変更します。

管理対象オブジェクトの既存の属性を調べるには、okv managed-object attribute listコマンドを実行します。

必要な権限

エンドポイントには、オブジェクトに対する読取り変更権限が必要です。

構文

okv managed-object attribute modify [--activation-date activation date] [--contact-info contact information]
    [--deactivation-date deactivation date] [--name name] [--process-start-date process start date] 
    [--protect-stop-date protect stop date] --uuid uuid

このコマンドで、コマンドラインで--uuidパラメータを指定して属性を指定するには、次のJSON構文を使用できます。これは、複数のオブジェクトに同じ属性値を適用する際に役立ちます。同じJSONファイルを再利用して、コマンドラインで異なるUUIDを指定できます。

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "managed-object",
    "resource" : "attribute",
    "action" : "modify",
      "options" : {
        "uuid" : "#VALUE",
        "attributes" : {
          "name" : {
            "value" : "#VALUE",
            "newValue" : "#VALUE",
            "newType" : "#text|uri"
                },
            "contactInfo" : "#VALUE",
            "activationDate" : "#VALUE",
            "deactivationDate" : "#VALUE",
            "protectStopDate" : "#VALUE",
            "processStartDate" : "#VALUE",
            "extractable" : "#TRUE|FALSE"
           }
        }
      }
   }

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--uuid / uuid

必須

セキュリティ・オブジェクトのUUID (Universally Unique ID)

オブジェクトの一意識別子を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブをクリックして、左側のナビゲーション・ウィンドウで「Keys & Secrets」をクリックします。「Keys & Secrets」表で、「Unique Identifier」列を確認します。

--activation-date / activationDate

オプション
セキュリティ・オブジェクトをアクティブ化するタイミングを指定します。形式は次のとおりです。
"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time
このパラメータを省略した場合、アクティブ化日は、アップロードされている証明書ファイルから取得されます。 
If activationDate meets the date criteria,the date is overwritten with the provided date.
    notBefore < deactivationDate <= notAfter
    activationDate < deactivationDate
activation-dateが条件を満たさない場合は、エラー・メッセージが表示されます。
contact-info / contactInfo

オプション

この属性は説明目的でのみ使用されます。
--deactivation-date / deactivationDate

オプション
セキュリティ・オブジェクトを非アクティブ化するタイミングを指定します。activation-dateと同じ形式です。このパラメータを省略した場合、非アクティブ化日は、アップロードされている証明書ファイルから取得されます。 
If deactivationDate meets the date criteria,the date is overwritten with the provided date.
 notBefore <= activationDate < notAfter
 activationDate < deactivationDate
deactivation-dateが条件を満たさない場合は、エラー・メッセージが表示されます。
--name / name

オプション

セキュリティ・オブジェクトの名前を指定します。使用可能な値は次のとおりです。

  • value
  • newValue
  • newType

デフォルト値は次のとおりです。

  • text
    -Support complex data format, name attribute in command line
        --name '{"value" : "KEY1", "newValue" : "KEY2", "newType" : "text"}'or
        --name '{"value" : "KEY1", "type" : "text}'
-Support simplified data format, name attribute in command line. when type is "text" as a default:
        --name KEY1
--process-start-date / processStartDate

オプション

日時を指定します。有効なセキュリティ・オブジェクトで、暗号で保護された情報の処理が開始される時間。
--protect-stop-date / protectStopDate

オプション

有効なセキュリティ・オブジェクトを暗号化保護の適用に使用できなくなる日時を指定します。

/attributes

必須

属性名とその値。属性を指定する場合は、JSON構文を使用する必要があります。コマンドラインでは属性を指定できません。管理対象オブジェクトの既存の属性を調べるには、okv managed-object attribute listコマンドを実行します。

入力できる属性は次のとおりです。

  • nameには、次の情報が含まれます。
    • valueは、既存の名前値です。
    • newValueは、新しい名前値です。
    • newTypeは、新しい名前値タイプです。タイプのみを変更する場合は、valueおよびnewValueを指定する必要があります。デフォルト値はtextです。
  • contactInfo
  • 次の日時属性:
    • activationDate
    • deactivationDate
    • protectStopDate
    • processStartDate

  • extractableは次のように設定できます。

    • TRUEにすると、オブジェクトをOracle Key Vaultから抽出できるようになります。

    • FALSEにすると、オブジェクト内のキー・マテリアルをOracle Key Vaultから抽出できなくなります。ただし、オブジェクトのメタデータ(オブジェクトの属性、状態など)は、引き続きOracle Key Vaultから取得できます。

    キー管理者ロールがあるユーザーは、既存の対称キーまたは秘密キーの抽出可能属性設定をTRUEまたはFALSEに変更できます。既存の対称キーに対する読取り変更アクセス権を持つユーザーは、その抽出可能属性設定を変更することもできますが、これは、より厳しい設定を適用すること、つまり値をFALSEに設定してオブジェクトを抽出不可にすることのみ許可されます。このようなユーザーは、対称キーが現在抽出不可である場合に、抽出可能になるように抽出可能属性設定を変更することはできません。抽出可能属性設定は対称キーにのみ適用でき、他のタイプのセキュリティ・オブジェクトには適用できません。

日付と時間を設定するには、様々な方法を使用できます。次に各例を示します。 

"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time

UTC書式で時間を表示するには、Linuxのdateコマンドを使用します。たとえば: 

$ date --utc "+%F %T"
2021-03-15 20:31:37

これらの属性の詳細は、Key Management Interoperability Protocol仕様バージョン1.1を参照してください。

JSONの例

  1. okv managed-object attribute modifyコマンド用にJSON入力を生成します。 
    okv managed-object attribute modify --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "managed-object",
    "resource" : "attribute",
    "action" : "modify",
    "options" : {
      "uuid" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "newValue" : "#VALUE",
          "newType" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "activationDate" : "#VALUE",
        "deactivationDate" : "#VALUE",
        "protectStopDate" : "#VALUE",
        "processStartDate" : "#VALUE",
        "extractable" : "#TRUE|FALSE"
      }
    }
  }
}
  2. 生成された入力をファイル(たとえば、modify_attributes.json)に保存し、それを編集して、セキュリティ・オブジェクトに関連付けられた属性を変更します。
    {
  "service" : {
    "category" : "managed-object",
    "resource" : "attribute",
    "action" : "modify",
    "options" : {
      "uuid" : "2359E04F-DA61-4F7C-BF9F-913D3369A93A",
      "attributes" : {
        "name" : {
          "value" : "PROD-HRDB-MKEY",
          "newValue" : "PROD-GLOBAL-HRDB-MKEY",
          "newType" : "text"
        },
        "contactInfo" : "jscott@example.com",
        "deactivationDate" : "2024-07-31 09:00:00",
        "protectStopDate" : "2024-04-30 09:00:00",
        "extractable" : "FALSE"
      }
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object attribute modifyコマンドを実行します。 
    okv managed-object attribute modify --from-json modify_attributes.json

    出力は、次のようになります。 

    {
     "result": "Success",
     "value": {
      "attributes": {
       "contactInfo": "Modified",
       "deactivationDate": "Modified",
       "name": "Modified",
       "protectStopDate": "Modified",
       "extractable" : "Modified"
    }
  }
}

関連トピック

親トピック: セキュリティ・オブジェクトのコマンド

5.7 okv managed-object certificate getコマンド

okv managed-object certificate getコマンドでは、デジタル証明書を取得します。

必要な権限

エンドポイントには、証明書オブジェクトに対する読取り権限が必要です。

構文 

okv managed-object certificate get --output_format <text|json> --uuid UUID

JSON入力ファイル・テンプレート

{
  "service": {
    "category": "managed-object",
    "resource": "certificate",
    "action": "get",
    "options": {
      "uuid": "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--uuid / uuid

必須

証明書のUUID (Universally Unique ID)

オブジェクトの一意識別子を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブをクリックして、左側のナビゲーション・ウィンドウで「Keys & Secrets」をクリックします。「Keys & Secrets」表で、「Unique Identifier」列を確認します。

--output_format

オプション

コマンドの出力形式を指定します。コマンドが正常に実行された場合、このコマンドは終了コード0で完了し、コマンドが失敗した場合は終了コード1で完了し、関連するエラーメッセージを生成します。

デフォルト値は次のとおりです。

  • text

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

JSONの例

  1. okv managed-object certificate getコマンド用にJSON入力を生成します。 
    okv managed-object certificate get --generate-json-input

    次のような入力が生成されます。 

    {
  "service": {
    "category": "managed-object",
    "resource": "certificate",
    "action": "get",
    "options": {
      "uuid": "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、get_cert.json)に保存し、それを編集して、指定された証明書を取得します。
    {
  "service": {
    "category": "managed-object",
    "resource": "certificate",
    "action": "get",
    "options": {
      "uuid": "EEED2C4F-33D7-4F9A-BF02-52DD2225A43A"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object certificate getコマンドを実行します。 
    okv managed-object certificate get --from-json get_cert.json

    出力は、次のようになります。 

    {
 "result": "Success",
  "value": {
   "object": "-----BEGIN CERTIFICATE-----\nMIIDdzCCAl+gAwIBAgICfVEwDQYJKoZIhvcNAQELBQAwazELMAkGA1UEBhMCdXMx\nEzARB << output truncated >> AYP\n4vwrDwBdNdGtj36GqjuCpz/xCVM9ieSRxJU8\n-----END CERTIFICATE-----"
  } 
}

出力形式としてのテキストの使用例

okv managed-object certificate get --output_format text --uuid EEED2C4F-33D7-4F9A-BF02-52DD2225A43A

出力

出力は、次のようになります。 

-----BEGIN CERTIFICATE-----
MIIDfDCCAmSgAwIBAgICVN0wDQYJKoZIhvcNAQELBQAwazELMAkGA1UEBhMCdXMx
EzARBgNVBAgTCkNhbGlmb3JuaWExFTATBgNVBAcMDFJlZHdvb2RfQ2l0eTEPMA0G
A1UEChMGT3JhY2xlMRIwEAYDVQQLDAlLZXlfVmF1bHQxCzAJBgNVBAMTAkNBMB4X
DTI0MDQwMjIxMzg0MloXDTI1MDQwMjIxMzg0MlowczELMAkGA1UEBhMCdXMxEzAR
BgNVBAgTCkNhbGlmb3JuaWExFTATBgNVBAcMDFJlZHdvb2RfQ2l0eTEPMA0GA1UE
ChMGT3JhY2xlMRIwEAYDVQQLDAlLZXlfVmF1bHQxEzARBgNVBAMTCllUS3hVQUNn
UFAwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDs/j10tz0hNX7tZQn3
S7I7lA7OkNO0eKiQWUThs/gvE+ARQlHC9xaRIONIFmLN41bQQdOQ4wWLDTv8CIK9
QgxldPdyVoTqV5D6x+kSfqI/BPuWvKyvIXuErr1XM/2LBh63Pu/2DXXDsmZK5BZn
wQrQ4iz/OjA8pG0gpboJJKnvVDzhul0z6lwvuVWLGwTqRwwXovlc/VF5/G5KReW0
stIZAfvpPtG/vlCbMd+LgGGyqUwWmdpTf7s0MMX1+kQ10vT4lV7jBNbLKl8u21bv
0d7Gt5Gqbh1+VLUEU/2tg+G2i8nMI3U0wc1IU2ndNV/YytzILg11AAYWvYikFiui
WwejAgMBAAGjIjAgMB4GA1UdEQQXMBWHBAr0QMaCDTEwLjI0NC42NC4xOTgwDQYJ
KoZIhvcNAQELBQADggEBADRzbI0uxExK2WlNNnFilLH/MmQVa2rMKybCFsiHiNjf
Rseq1Tm+qIYQlosaceIVw/lQLineVt73eXFhS66O01qPk2sG0WGRB08/BiQvDv2V
KwYJ5I9EVzILCmGeMCOLsdbNlodBiDcWBOubbbiyDShStgjEddoiVizfmfjeCUq2
sSN3hr4tgTZupgNA1RB9n+krBrSbR16aMbmrjqEubaBywnQNMiNLid7uRx243p96
WNup2dzGiuTJYyyRtbjpTPz1ZCQhqi5DsVFrclvH2V/EZj4rcLg/BS0cBcEc2gc/
9aYwIPbClN8Cj1bOGBQ66DvXVPBRNMfW5s8cWoX8JU4=
-----END CERTIFICATE-----

親トピック: セキュリティ・オブジェクトのコマンド

5.8 okv managed-object certificate registerコマンド

okv managed-object certificate registerコマンドでは、証明書を登録します。

必要な権限

なし

構文

okv managed-object certificate register [--activation-date activation date] [--algorithm algorithm] [--custom-attribute custom attribute]
       [--deactivation-date deactivation date] [--length length] [--mask mask] [--name name] --object object [--private-key-uuid
       private-key-uuid] [--sub-type sub-type] [--type type] [--wallet wallet]

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "managed-object",
    "resource" : "certificate",
    "action" : "register",
    "options" : {
      "object" : "#VALUE",
      "algorithm" : "#RSA",
      "length" : "#1024,2048,3072,4096(RSA)",
      "mask" : [ "#VERIFY", "#EXPORT" ],,
      "type" : "X_509",
      "subType" : "#USER_CERT|TRUSTPOINT",
      "privateKeyUUID" : "#VALUE",
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--object / object

必須

証明書オブジェクトへのファイル・パス。

--type / type

オプション

証明書のタイプ。X_509の値を入力します。

--sub-type / subType

オプション

証明書のサブタイプ。次の値から選択します。

  • USER_CERT
  • TRUSTPOINT

--algorithm / algorithm

オプション

証明書に含まれている公開キーの暗号化アルゴリズム。このパラメータを省略すると、アルゴリズムはアップロード中の証明書ファイルから取得されます。次の値を入力します。

  • RSA

--length / length

オプション

証明書に含まれている公開キーの長さ。このパラメータを省略すると、キーの長さはアップロード中の証明書ファイルから取得されます。次の値から選択します。

  • 1024
  • 2048
  • 4096

--mask / mask

オプション

二重引用符で囲まれた暗号化使用方法マスク次の値から選択します。

  • EXPORT
  • VERIFY

デフォルト値は次のとおりです。

  • VERIFY

--private-key-uuid / privateKeyUUID

オプション

証明書オブジェクトに関連付けられている秘密キーのUUID (Universally Unique ID)。

キーの一意識別子を調べるには、okv manage-access wallet list-objectsコマンドまたはokv admin endpoint list-objectsコマンドを実行します。

--wallet / wallet

オプション

ウォレット名。アクセスできる既存のウォレットの名前を調べるには、okv manage-access wallet listコマンドを実行します。

--name / name

オプション

セキュリティ・オブジェクトの名前を指定します。使用可能な値は次のとおりです。

  • value
  • type

デフォルト値は次のとおりです。

  • text
    -Support complex data format, name attribute in command line
        --name '{"value" : "KEY1", "type" : "uri"}'or
        --name '{"value" : "KEY1", "type" : "text}'
-Support simplified data format, name attribute in command line. when type is "text" as a default:
        --name KEY1

--custom-attribute / customAttribute

オプション

セキュリティ・オブジェクトのカスタム定義属性を指定します。

2017-04-29 18:14:51"}'
        --custom-attribute '[ { "name": "x-OKV Certificate Expiration Date",
           "value" : "2017-04-29 18:14:51"}, { "name": "x-local-name", "value" : "HR"} ] '
Support simplified data format, name
      attribute(single instance), in command line --name KEY1
Support simplified data format, custom attribute(multi instance),in commandline
      --custom-attribute "x-local-name:HR" 
      --custom-attribute ' [  “x-local-name:HR”,“x-local-id:100” ]'

--deactivation-date / deactivationDate

オプション
セキュリティ・オブジェクトを非アクティブ化するタイミングを指定します。activation-dateと同じ形式です。このパラメータを省略した場合、非アクティブ化日は、アップロードされている証明書ファイルから取得されます。 
If deactivationDate meets the date criteria,the date is overwritten with the provided date.
 notBefore <= activationDate < notAfter
 activationDate < deactivationDate
deactivation-dateが条件を満たさない場合は、エラー・メッセージが表示されます。

--activation-date / activationDate

オプション
セキュリティ・オブジェクトをアクティブ化するタイミングを指定します。形式は次のとおりです。
"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time
このパラメータを省略した場合、アクティブ化日は、アップロードされている証明書ファイルから取得されます。 
If activationDate meets the date criteria,the date is overwritten with the provided date.
    notBefore < deactivationDate <= notAfter
    activationDate < deactivationDat
activation-dateが条件を満たさない場合は、エラー・メッセージが表示されます。

--attributes/ attributes

オプション

属性名とその値。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。管理対象オブジェクトの既存の属性を調べるには、okv managed-object attribute listコマンドを実行します。

コマンドラインでは属性を指定できません。属性を使用する場合は、JSON構文を使用する必要があります。

入力できる属性は次のとおりです。

  • nameには、次の情報が含まれます。
    • valueは、名前値です。
    • typeは、textまたはuriです。デフォルト値はtextです。
  • contactInfo
  • 次の日時属性:
    • activationDate
    • deactivationDate
    • protectStopDate
    • processStartDate

日付と時間を設定するには、様々な方法を使用できます。次に各例を示します。 

"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time

UTC書式で時間を表示するには、Linuxのdateコマンドを使用します。たとえば: 

$ date --utc "+%F %T"
2021-03-15 20:31:37

これらの属性の詳細は、Key Management Interoperability Protocol仕様バージョン1.1を参照してください。

--output_format

オプション

コマンドの出力形式を指定します。コマンドが正常に実行された場合、このコマンドは終了コード0で完了し、コマンドが失敗した場合は終了コード1で完了し、関連するエラーメッセージを生成します。

デフォルト値は次のとおりです。

  • text

CLIの例

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。 
okv managed-object certificate register --type X_509 --private-key-uuid 
95092BD2-B546-4F9A-BF0B-D8ECDC548546 --algorithm RSA --mask "ENCRYPT" --object
/Users/dopark/test/my.crt --name cert_0701 --activation-date now
--deactivation-date "2030-10-10 10:10:10

JSONの例

  1. okv managed-object certificate registerコマンド用にJSON入力を生成します。 
    okv managed-object certificate register --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "managed-object",
    "resource" : "certificate",
    "action" : "register",
    "options" : {
      "object" : "#VALUE",
      "algorithm" : "#RSA",
      "length" : "#1024,2048,3072,4096(RSA)",
      "mask" : [ "#VERIFY", "#EXPORT" ],
      
      "type" : "X_509",
      "subType" : "#USER_CERT|TRUSTPOINT",
      "privateKeyUUID" : "#VALUE",
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}
  2. 生成された入力をファイル(たとえば、reg_cert.json)に保存し、それを編集して、指定された証明書を登録します。 
    {
  "service" : {
    "category" : "managed-object",
    "resource" : "certificate",
    "action" : "register",
    "options" : {
      "object" : "./cert.pem",
      "algorithm" : "RSA",
      "length" : "2048",
      "mask" : [ "VERIFY"],
      "type" : "X_509",
      "subType" : "USER_CERT",
      "privateKeyUUID" : "D497994E-74CD-4F60-BF7C-52F254142705",
      "wallet" : "hr_wallet",
      "attributes" : {
        "name" : {
          "value" : "FINDB-PROD-CERT",
          "type" : "text"
        },
        "contactInfo" : "psmith@example.com"
        "activationDate" : "2020-12-31 09:00:00",
        "deactivationDate" : "2024-12-31 09:00:00",
        "processStartDate" : "2020-12-31 09:00:00",
        "protectStopDate" : "2024-12-31 09:00:00"
      }
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object certificate registerコマンドを実行します。 
    okv managed-object certificate register --from-json reg_cert.json

    出力は、次のようになります。 

    {
 "result" : "Success",
  "value" : {
  "uuid" : "EEED2C4F-33D7-4F9A-BF02-52DD2225A43A"
  }
}

出力形式としてのテキストの使用例

okv managed-object certificate register --output_format text --object certificate_file_path --type certificate_type --sub-type certificate_sub_type --algorithm cryptographic_algorithm --length key_length --mask cryptographic_usage_mask --private-key-uuid private_key_uuid  --wallet wallet_name

出力

出力は、次のようになります。 

"EEED2C4F-33D7-4F9A-BF02-52DD2225A43A"

関連トピック

親トピック: セキュリティ・オブジェクトのコマンド

5.9 okv managed-object certificate-request getコマンド

okv managed-object certificate-request getコマンドは、証明書リクエストを取得します。

必要な権限

エンドポイントには、証明書リクエスト・オブジェクトに対する読取り権限が必要です。

構文

okv managed-object certificate-request get --output_format <text|json> --uuid UUID

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "managed-object",
    "resource" : "certificate-request",
    "action" : "get",
    "options" : {
      "uuid" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--uuid / uuid

必須

証明書リクエストのUUID (Universally Unique ID)。

証明書リクエストの一意識別子を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブをクリックして、左側のナビゲーション・ウィンドウで「Keys & Secrets」をクリックします。「Keys & Secrets」表で、「Unique Identifier」列を確認します。
--output_format

オプション

コマンドの出力形式を指定します。コマンドが正常に実行された場合、このコマンドは終了コード0で完了し、コマンドが失敗した場合は終了コード1で完了し、関連するエラーメッセージを生成します。

デフォルト値は次のとおりです。

  • text

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

JSONの例

  1. okv managed-object certificate-request getコマンド用にJSON入力を生成します。 
    okv managed-object certificate-request get  --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "managed-object",
    "resource" : "certificate-request",
    "action" : "get",
    "options" : {
      "uuid" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、get_cert_req.json)に保存し、それを編集して証明書リクエストのUUIDを指定します。
    {
  "service" : {
    "category" : "managed-object",
    "resource" : "certificate-request",
    "action" : "get",
    "options" : {
      "uuid" : "BC0E9004-82E0-4FFA-BFF2-29A67DDD5C64"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object certificate-request getコマンドを実行します。 
    okv managed-object certificate-request get  --from-json get_cert_req.json

    出力は、次のようになります。 

    {
     "result" : "Success",
     "value" : {
      "object" : "-----BEGIN NEW CERTIFICATE REQUEST-----\nMIIC5TCCAc0CAQAwdDELMAkGA1UEBhMCdXMxEzARBgNVBAgTCkNhbGlmb3JuaWEx << output truncated >> \nDtWoeZfNYHcWPFmHK8aiLCgzeFG62xRdyg==\n-----END NEW CERTIFICATE REQUEST-----"
      }
    }

出力形式としてのテキストの使用例

okv managed-object certificate-request get --output_format text --uuid BC0E9004-82E0-4FFA-BFF2-29A67DDD5C64

出力

出力は、次のようになります。 

-----BEGIN NEW CERTIFICATE REQUEST-----
MIIC6TCCAdECAQAwczELMAkGA1UEBhMCdXMxEzARBgNVBAgTCkNhbGlmb3JuaWEx
FTATBgNVBAcMDFJlZHdvb2RfQ2l0eTEPMA0GA1UEChMGT3JhY2xlMRIwEAYDVQQL
DAlLZXlfVmF1bHQxEzARBgNVBAMTCllUS3hVQUNnUFAwggEiMA0GCSqGSIb3DQEB
AQUAA4IBDwAwggEKAoIBAQDs/j10tz0hNX7tZQn3S7I7lA7OkNO0eKiQWUThs/gv
E+ARQlHC9xaRIONIFmLN41bQQdOQ4wWLDTv8CIK9QgxldPdyVoTqV5D6x+kSfqI/
BPuWvKyvIXuErr1XM/2LBh63Pu/2DXXDsmZK5BZnwQrQ4iz/OjA8pG0gpboJJKnv
VDzhul0z6lwvuVWLGwTqRwwXovlc/VF5/G5KReW0stIZAfvpPtG/vlCbMd+LgGGy
qUwWmdpTf7s0MMX1+kQ10vT4lV7jBNbLKl8u21bv0d7Gt5Gqbh1+VLUEU/2tg+G2
i8nMI3U0wc1IU2ndNV/YytzILg11AAYWvYikFiuiWwejAgMBAAGgMTAvBgkqhkiG
9w0BCQ4xIjAgMB4GA1UdEQQXMBWHBAr0QMaCDTEwLjI0NC42NC4xOTgwDQYJKoZI
hvcNAQELBQADggEBAEkyFWs4O5AL8wbG1fJbfcOiXla9htESxqvxc+13/cpvnh1X
akifbJHIM/KNWtGo7Y4m/9ZZo+gbOQmLQgqaDVBbzlM7e0J0h6q3PITMqS3NyNcd
DS8lHaBX82Gv5MldIZcQ972JGXG/bkMuCy+XxtCTH7n7teFEmMZW3RJ0tGtmE16I
VzrIMcv7R2thKWRKI4YeTEltKukt8nOTfF1xRtfk4i4qyVJDLvOsU7aq+NqnXW3r
i1/SdCTkkP/lej/PovpFlzHQf9dFklc39vqTuHPXpWJGqe1uydhEVODB8DQlS6hf
n94/8z3OB4cLiiZGC4jFoKYBFabGYzhCoDtdckM=
-----END NEW CERTIFICATE REQUEST-----

親トピック: セキュリティ・オブジェクトのコマンド

5.10 okv managed-object certificate-request registerコマンド

okv managed-object certificate-request registerコマンドは、証明書リクエスト・オブジェクトをOracle Key Vaultに登録します。

必要な権限

なし

構文

okv managed-object certificate-request register [--activation-date activation date] [--custom-attribute custom attribute]
       [--deactivation-date deactivation date] [--name name] --object object --private-key-uuid private-key-uuid [--type type] [--wallet
       wallet]

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "managed-object",
    "resource" : "certificate-request",
    "action" : "register",
    "options" : {
      "type" : "#CRMF,PKCS10,PEM,PGP",
      "object" : "#VALUE",
      "privateKeyUUID" : "#VALUE",
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--object / object

必須

証明書リクエスト・オブジェクトへのファイル・パス。

--type / type

オプション

証明書リクエストのタイプ。次の値から選択します。

  • CRMF
  • PKCS10
  • PGP

    デフォルト値は次のとおりです。

  • PEM

--private-key-uuid / privateKeyUUID

必須

登録する証明書オブジェクトに関連付けられている秘密キーのUUID (Universally Unique ID)。

キーの一意識別子を調べるには、okv manage-access wallet list-objectsコマンドまたはokv admin endpoint list-objectsコマンドを実行します。

--wallet / wallet

オプション

ウォレット名。アクセスできる既存のウォレットの名前を調べるには、okv manage-access wallet listコマンドを実行します。

/attributes

オプション

属性名とその値。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。管理対象オブジェクトの既存の属性を調べるには、okv managed-object attribute listコマンドを実行します。

コマンドラインでは属性を指定できません。属性を使用する場合は、JSON構文を使用する必要があります。

入力できる属性は次のとおりです。

  • nameには、次の情報が含まれます。
    • valueは、名前値です。
    • typeは、textまたはuriです。デフォルト値はtextです。
  • contactInfo
  • 次の日時属性:
    • activationDate
    • deactivationDate
    • protectStopDate
    • processStartDate

日付と時間を設定するには、様々な方法を使用できます。次に各例を示します。 

"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time

UTC書式で時間を表示するには、Linuxのdateコマンドを使用します。たとえば: 

$ date --utc "+%F %T"
2021-03-15 20:31:37
これらの属性の詳細は、Key Management Interoperability Protocol仕様バージョン1.1を参照してください。

--name / name

オプション

セキュリティ・オブジェクトの名前を指定します。使用可能な値は次のとおりです。

  • value
  • type

デフォルト値は次のとおりです。

  • text
    -Support complex data format, name attribute in command line
        --name '{"value" : "KEY1", "type" : "uri"}'or
        --name '{"value" : "KEY1", "type" : "text}'
-Support simplified data format, name attribute in command line. when type is "text" as a default:
        --name KEY1

--custom-attribute/ customAttribute

オプション

セキュリティ・オブジェクトのカスタム定義属性を指定します。

2017-04-29 18:14:51"}'
        --custom-attribute '[ { "name": "x-OKV Certificate Expiration Date",
           "value" : "2017-04-29 18:14:51"}, { "name": "x-local-name", "value" : "HR"} ] '
Support simplified data format, name
      attribute(single instance), in command line --name KEY1
Support simplified data format, custom attribute(multi instance),in commandline
      --custom-attribute "x-local-name:HR" 
      --custom-attribute ' [  “x-local-name:HR”,“x-local-id:100” ]'

--deactivation-date / deactivationDate

オプション

セキュリティ・オブジェクトを非アクティブ化するタイミングを指定します。activation-dateと同じ形式です。

--activation-date / activationDate

オプション
セキュリティ・オブジェクトをアクティブ化するタイミングを指定します。形式は次のとおりです。
"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time
--output_format

オプション

コマンドの出力形式を指定します。コマンドが正常に実行された場合、このコマンドは終了コード0で完了し、コマンドが失敗した場合は終了コード1で完了し、関連するエラーメッセージを生成します。

デフォルト値は次のとおりです。

  • text

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

CLIの例

okv managed-object certificate-request register --name "FINDB-PROD-CERTREQ" --custom-attribute "x-local-name:HR" --activation-date "2020-12-31 09:00:00" --deactivation-date "2024-12-31 09:00:00

JSONの例

  1. okv managed-object certificate-request registerコマンド用にJSON入力を生成します。 
    okv managed-object certificate-request register --generate-json-input

    次のような入力が生成されます。 

    "service" : {
    "category" : "managed-object",
    "resource" : "certificate-request",
    "action" : "register",
    "options" : {
      "type" : "#CRMF,PKCS10,PEM,PGP",
      "object" : "#VALUE",
      "privateKeyUUID" : "#VALUE",
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}
  2. 生成された入力をファイル(たとえば、reg_cert_req.json)に保存し、それを編集して適切な証明書リクエスト値を指定します。
    {
  "service" : {
    "category" : "managed-object",
    "resource" : "certificate-request",
    "action" : "register",
    "options" : {
      "type" : "PEM",
      "object" : "./cert_req.pem",
      "privateKeyUUID" : "D497994E-74CD-4F60-BF7C-52F254142705",
      "wallet" : "hr_wallet",
      "attributes" : {
        "name" : {
          "value" : "FINDB-PROD-CERTREQ",
          "type" : "text"
        },
        "contactInfo" : "psmith@example.com"
        "activationDate" : "2020-12-31 09:00:00",
        "deactivationDate" : "2024-12-31 09:00:00",
        "processStartDate" : "2020-12-31 09:00:00",
        "protectStopDate" : "2024-12-31 09:00:00"
      }
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object certificate-request registerコマンドを実行します。 
    okv managed-object certificate-request register --from-json reg_cert_req.json

    出力は、次のようになります。 

    {
  "result" : "Success",
   "value" : {
    "uuid" : "BC0E9004-82E0-4FFA-BFF2-29A67DDD5C64"
   }
    }

出力形式としてのテキストの使用例

okv managed-object  certificate-request register --output_format text --object "./cert_req.pem" --type "PEM" --private-key-uuid
      "D497994E-74CD-4F60-BF7C-52F254142705" --wallet hr_wallet  --activation-date now --name hr_csr --custom-attribute "x-local-name:HR"

出力

出力は、次のようになります。 

"BC0E9004-82E0-4FFA-BFF2-29A67DDD5C64"

関連トピック

親トピック: セキュリティ・オブジェクトのコマンド

5.11 okv managed-object custom-attribute addコマンド

okv managed-object custom-attribute addコマンドでは、セキュリティ・オブジェクトにカスタム属性を追加します。

必要な権限

エンドポイントには、オブジェクトに対する読取り変更権限が必要です。

構文

okv managed-object custom-attribute add --custom-attribute custom attribute --uuid uuid

このコマンドで、コマンドラインで--uuidパラメータを指定して属性を指定するには、次のJSON構文を使用できます。これは、複数のオブジェクトに同じ属性値を適用する際に役立ちます。同じJSONファイルを再利用して、コマンドラインで異なるUUIDを指定できます。

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "managed-object",
    "resource" : "custom-attribute",
    "action" : "add",
    "options" : {
      "uuid" : "#VALUE",
      "customAttribute" : {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      }
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--uuid / uuid

必須

セキュリティ・オブジェクトのUUID (Universally Unique ID)

オブジェクトの一意識別子を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブをクリックして、左側のナビゲーション・ウィンドウで「Keys & Secrets」をクリックします。「Keys & Secrets」表で、「Unique Identifier」列を確認します。

--custom-attribute/ customAttribute

必須

カスタム属性名。属性名には接頭辞x-を含めます。カスタム属性名にはx-OKVという接頭辞を使用しないでください。x-OKV接頭辞で始まるカスタム属性は、Oracle Key Vaultでのみ使用できるように予約されています。属性を指定する場合は、JSON構文を使用する必要があります。コマンドラインでは属性を指定できません。管理対象オブジェクトの既存の属性を調べるには、okv managed-object attribute listコマンドを実行します。

カスタム属性には、次の値を指定する必要があります。

  • nameは、追加する値の名前です。
  • valueは、属性の値です。
  • typeは、textまたはnumberです。

JSONの属性の詳細は、Key Management Interoperability Protocol仕様バージョン1.1を参照してください。

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値としてtextが指定されたoutput_formatオプションでは、テキスト形式で出力が表示されます。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

JSONの例

  1. okv managed-object custom-attribute addコマンド用にJSON入力を生成します。 
    okv managed-object custom-attribute add --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "managed-object",
    "resource" : "custom-attribute",
    "action" : "add",
    "options" : {
      "uuid" : "#VALUE",
      "customAttribute" : {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      }
    }
  }
}
  2. 生成された入力をファイル(たとえば、add_cust_attr.json)に保存し、それを編集してセキュリティ・オブジェクトにカスタム属性を含めます。 
    {
  "service": {
    "category": "managed-object",
    "resource": "custom-attribute",
    "action": "add",
    "options": {
      "uuid": "3C695846-BB8D-4FD2-BFC4-E646ACB60404",
      "customAttribute": {
        "name": "x-ApplicationTag",
        "value": "HR-Production",
        "type": "TEXT"
      }
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object custom-attribute addコマンドを実行します。 
    okv managed-object custom-attribute add --from-json add_cust_attr.json

    出力は、次のようになります。 

    {
 "result" : "Success"
}

親トピック: セキュリティ・オブジェクトのコマンド

5.12 okv managed-object custom-attribute deleteコマンド

okv managed-object custom-attribute deleteコマンドでは、セキュリティ・オブジェクトのカスタム属性を削除します。

必要な権限

エンドポイントには、オブジェクトに対する読取り変更権限が必要です。

構文

 okv managed-object custom-attribute delete --custom-attribute custom attribute --uuid uuid

このコマンドで、コマンドラインで--uuidパラメータを指定して属性を指定するには、次のJSON構文を使用できます。これは、複数のオブジェクトに同じ属性値を適用する際に役立ちます。同じJSONファイルを再利用して、コマンドラインで異なるUUIDを指定できます。

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "managed-object",
    "resource" : "custom-attribute",
    "action" : "delete",
    "options" : {
      "uuid" : "#VALUE",
      "customAttribute" : {
        "name" : "#VALUE",
        "index" : "#VALUE"
      }
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--uuid / uuid

必須

セキュリティ・オブジェクトのUUID (Universally Unique ID)

オブジェクトの一意識別子を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブをクリックして、左側のナビゲーション・ウィンドウで「Keys & Secrets」をクリックします。「Keys & Secrets」表で、「Unique Identifier」列を確認します。

--custom-attribute/ customAttribute

必須

カスタム属性名とその索引。カスタム属性名にはx-OKVという接頭辞を使用しないでください。x-OKV接頭辞で始まるカスタム属性は、Oracle Key Vaultのみが使用できるように予約されています。属性を指定する場合は、JSON構文を使用する必要があります。コマンドラインでは属性を指定できません。管理対象オブジェクトの既存の属性を調べるには、okv managed-object attribute get-allコマンドを実行します。

属性には、次の値を指定する必要があります。

  • nameは、値の名前です。
  • indexは、値の索引です。

ノート:

カスタム属性名にはx-OKVという接頭辞を使用しないでください。x-OKV接頭辞で始まるカスタム属性は、Oracle Key Vaultでのみ使用できるように予約されています。

これらの属性の詳細は、Key Management Interoperability Protocol仕様バージョン1.1を参照してください。

JSONの例

  1. okv managed-object custom-attribute deleteコマンド用にJSON入力を生成します。 
    okv managed-object custom-attribute delete --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "managed-object",
    "resource" : "custom-attribute",
    "action" : "delete",
    "options" : {
      "uuid" : "#VALUE",
      "customAttribute" : {
        "name" : "#VALUE",
        "index" : "#VALUE"
      }
    }
  }
}
  2. 生成された入力をファイル(たとえば、del_cust_attr.json)に保存して、カスタム属性を削除できるように編集します。 
    {
  "service" : {
    "category" : "managed-object",
    "resource" : "custom-attribute",
    "action" : "delete",
    "options" : {
      "uuid" : "2359E04F-DA61-4F7C-BF9F-913D3369A93A",
      "customAttribute" : {
        "name" : "x-ApplicationTag",
        "index" : "1"
      }
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object custom-attribute deleteコマンドを実行します。 
    okv managed-object custom-attribute delete --from-json del_cust_attr.json

    出力は、次のようになります。 

    {
  "result" : "Success"
}

親トピック: セキュリティ・オブジェクトのコマンド

5.13 okv managed-object custom-attribute modifyコマンド

okv managed-object custom-attribute modifyコマンドでは、セキュリティ・オブジェクトのカスタム属性を変更します。

必要な権限

エンドポイントには、オブジェクトに対する読取り変更権限が必要です。

構文

 okv managed-object custom-attribute modify --custom-attribute <custom attribute> --uuid <uuid>

このコマンドで、コマンドラインで--uuidパラメータを指定して属性を指定するには、次のJSON構文を使用できます。これは、複数のオブジェクトに同じ属性値を適用する際に役立ちます。同じJSONファイルを再利用して、コマンドラインで異なるUUIDを指定できます。

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "managed-object",
    "resource" : "custom-attribute",
    "action" : "modify",
    "options" : {
      "uuid" : "#VALUE",
      "customAttribute" : {
        "name" : "#VALUE",
        "newValue" : "#VALUE",
        "index" : "#VALUE"
      }
    }
  }
}

パラメータ

テンプレート・パラメータ 必須かどうか 説明

--uuid/ uuid

必須

セキュリティ・オブジェクトのUUID (Universally Unique ID)

オブジェクトの一意識別子を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブをクリックして、左側のナビゲーション・ウィンドウで「Keys & Secrets」をクリックします。「Keys & Secrets」表で、「Unique Identifier」列を確認します。

/ customAttribute

必須

カスタム属性名、値および索引。属性を指定する場合は、JSON構文を使用する必要があります。コマンドラインでは属性を指定できません。管理対象オブジェクトの既存の属性を調べるには、okv managed-object attribute get-allコマンドを実行します。

コマンドラインでは属性を指定できません。カスタム属性を変更する場合は、JSON構文を使用する必要があります。

属性には、次の値を指定する必要があります。

  • nameは、変更する属性の名前です。
  • newValueは、属性の新しい値です。
  • indexは、変更する属性の索引です。

ノート:

カスタム属性名にはx-OKVという接頭辞を使用しないでください。x-OKV接頭辞で始まるカスタム属性は、Oracle Key Vaultでのみ使用できるように予約されています。

JSONの属性の詳細は、Key Management Interoperability Protocol仕様バージョン1.1を参照してください。

JSONの例

  1. okv managed-object custom-attribute modifyコマンド用にJSON入力を生成します。 
    okv managed-object custom-attribute modify --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "managed-object",
    "resource" : "custom-attribute",
    "action" : "modify",
    "options" : {
      "uuid" : "#VALUE",
      "customAttribute" : {
        "name" : "#VALUE",
        "newValue" : "#VALUE",
        "index" : "#VALUE"
      }
    }
  }
}
  2. 生成された入力をファイル(たとえば、modify_cust_attr.json)に保存し、それを編集してカスタム属性を変更します。 
    {
  "service" : {
    "category" : "managed-object",
    "resource" : "custom-attribute",
    "action" : "modify",
    "options" : {
      "uuid" : "2359E04F-DA61-4F7C-BF9F-913D3369A93A",
      "customAttribute" : {
        "name" : "x-ApplicationTag",
        "newValue" : "Global-HR-Production",
        "index" : "1"
      }
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object custom-attribute modifyコマンドを実行します。 
    okv managed-object custom-attribute modify --from-json modify_cust_attr.json

    出力は、次のようになります。 

    {
  "result" : "Success"
}

親トピック: セキュリティ・オブジェクトのコマンド

5.14 okv managed-object key createコマンド

okv managed-object key createコマンドは、対称キーを作成します。

必要な権限

なし

構文

okv managed-object key create [--activation-date activation date] [--algorithm algorithm]
 [--custom-attribute custom attribute][--deactivation-date deactivation date] [--extractable extractable]
 [--length length] [--mask mask] [--name name] [--wallet wallet]

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "managed-object",
    "resource" : "key",
    "action" : "create",
    "options" : {
      "algorithm" : "#3DES|AES",
      "length" : "#112,168(3DES)|128,192,256(AES)",
      "mask" : [ "#ENCRYPT", "#DECRYPT", "#WRAP_KEY", 
                 "#UNWRAP_KEY", "#EXPORT", "#DERIVE_KEY", "#GENERATE_CRYPTOGRAM",
                 "#VALIDATE_CRYPTOGRAM", "#TRANSLATE_ENCRYPT", "#TRANSLATE_DECRYPT", 
                 "#TRANSLATE_WRAP", "#TRANSLATE_UNWRAP" ],
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "extractable" : "#TRUE|FALSE"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--algorithm / algorithm

オプション

暗号化アルゴリズム。次の値から選択します。

  • AES
  • 3DES

    デフォルト値は次のとおりです。

  • AES

--length / length

オプション

アルゴリズムのキーの長さ。次の値から選択します。

  • AESの場合: 128、192、256
  • 3DESの場合: 112、168

    デフォルト値は次のとおりです。

  • 256

--mask / mask

オプション

二重引用符で囲まれた暗号化使用方法マスク次の値から選択します。

  • ENCRYPT
  • DECRYPT
  • DERIVE_KEY
  • EXPORT
  • GENERATE_CRYPTOGRAM
  • TRANSLATE_DECRYPT
  • TRANSLATE_ENCRYPT
  • TRANSLATE_UNWRAP
  • TRANSLATE_WRAP
  • UNWRAP_KEY
  • VALIDATE_CRYPTOGRAM
  • WRAP_KEY

デフォルト値は次のとおりです。

  • ENCRYPT
  • DECRYPT
  • UNWRAP_KEY
  • WRAP_KEY

--wallet / wallet

オプション

ウォレット名。アクセスできる既存のウォレットの名前を調べるには、okv manage-access wallet listコマンドを実行します。

attributes

オプション

extractable属性を設定します。

  • TRUEにすると、オブジェクトをOracle Key Vaultから抽出できるようになります。

  • FALSEにすると、オブジェクト内のキー・マテリアルをOracle Key Vaultから抽出できなくなります。ただし、オブジェクトのメタデータ(オブジェクトの属性、状態など)は、引き続きOracle Key Vaultから取得できます。

extractable属性を設定しない場合、この値はエンドポイントの構成から継承されます。コマンドラインでは、エンドポイントで有効な設定よりも厳しいextractable属性設定のみ指定できます。たとえば、エンドポイントでFALSEに設定されている場合は、extractable属性をTRUEに設定できません。ただし、コマンドラインでは、抽出可能属性の値を常にFALSEに設定できます。

--name/ name

オプション

セキュリティ・オブジェクトの名前を指定します。使用可能な値は次のとおりです。

  • value
  • type

デフォルト値は次のとおりです。

  • text
    -Support complex data format, name attribute in command line
        --name '{"value" : "KEY1", "type" : "uri"}'or
        --name '{"value" : "KEY1", "type" : "text}'
-Support simplified data format, name attribute in command line. when type is "text" as a default:
        --name KEY1

--custom-attribute / customAttribute

オプション

セキュリティ・オブジェクトのカスタム定義属性を指定します。

2017-04-29 18:14:51"}'
        --custom-attribute '[ { "name": "x-OKV Certificate Expiration Date",
           "value" : "2017-04-29 18:14:51", "type" : "text" }, { "name": "x-local-name", "value" : "HR", "type" : "text"} ] '
Support simplified data format, name
      attribute(single instance), in command line --name KEY1
Support simplified data format, custom attribute(multi instance),in commandline
      --custom-attribute "x-local-name:HR" 
      --custom-attribute ' [  “x-local-name:HR”,“x-local-id:100” ]'

--deactivation-date / deactivationDate

オプション

セキュリティ・オブジェクトを非アクティブ化するタイミングを指定します。activation-dateと同じ形式です。

--activation-date / activationDate

オプション
セキュリティ・オブジェクトをアクティブ化するタイミングを指定します。形式は次のとおりです。
"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time
--output_format

オプション

コマンドの出力形式を指定します。コマンドが正常に実行された場合、このコマンドは終了コード0で完了し、コマンドが失敗した場合は終了コード1で完了し、関連するエラーメッセージを生成します。

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

JSONを使用しない例

okv managed-object key create --length 128 --algorithm AES --mask"ENCRYPT" --name  dw_0706

JSONの例

  1. okv managed-object key createコマンド用にJSON入力を生成します。 
    okv managed-object key create --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "managed-object",
    "resource" : "key",
    "action" : "create",
    "options" : {
      "algorithm" : "#3DES|AES",
      "length" : "#112,168(3DES)|128,192,256(AES)",
      "mask" : [ "#ENCRYPT", "#DECRYPT", "#WRAP_KEY", "#UNWRAP_KEY",
                 "#EXPORT", "#DERIVE_KEY", "#GENERATE_CRYPTOGRAM", 
                 "#VALIDATE_CRYPTOGRAM", "#TRANSLATE_ENCRYPT", "#TRANSLATE_DECRYPT",
                 "#TRANSLATE_WRAP", "#TRANSLATE_UNWRAP" ],
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "extractable" : "#TRUE|FALSE"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}
  2. 生成された入力をファイル(たとえば、create_key.json)に保存し、それを編集してキーを作成します。 
    {
  "service": {
    "category": "managed-object",
    "resource": "key",
    "action": "create",
    "options": {
      "algorithm": "AES",
      "length": "256",
      "mask": [
        "ENCRYPT",
        "DECRYPT"
      ],
      "wallet": "hr_wallet",
      "attributes": {
         "extractable" : "FALSE"
      }
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object key createコマンドを実行します。 
    okv managed-object key create --from-json create_key.json

    出力は、次のようになります。 

    {
  "result": "Success",
   "value": {
    "uuid": "2359E04F-DA61-4F7C-BF9F-913D3369A93A"
  }
}

出力形式としてのテキストの使用例

okv managed-object key create --extractablefalse --output_format text --algorithm  cryptographic_algorithm --length key_length --mask crypographic_usage_mask --wallet wallet_name

出力

出力は、次のようになります。 

"2359E04F-DA61-4F7C-BF9F-913D3369A93A"

親トピック: セキュリティ・オブジェクトのコマンド

5.15 okv managed-object key getコマンド

okv managed-object key getコマンドは、対称キーを取得します。

必要な権限

エンドポイントには、キー・オブジェクトに対する読取り権限が必要です。

構文

okv managed-object key get --output_format text|json --uuid UUID

JSON入力ファイル・テンプレート

{
  "service": {
    "category": "managed-object",
    "resource": "key",
    "action": "get",
    "options": {
      "uuid": "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--uuid / uuid

必須

キーのUUID (Universally Unique ID)

オブジェクトの一意識別子を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブをクリックして、左側のナビゲーション・ウィンドウで「Keys & Secrets」をクリックします。「Keys & Secrets」表で、「Unique Identifier」列を確認します。

--output_format

オプション

コマンドの出力形式を指定します。コマンドが正常に実行された場合、このコマンドは終了コード0で完了し、コマンドが失敗した場合は終了コード1で完了し、関連するエラーメッセージを生成します。

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

JSONの例

  1. okv managed-object key getコマンド用にJSON入力を生成します。 
    okv managed-object key get --generate-json-input

    次のような入力が生成されます。 

    {
  "service": {
    "category": "managed-object",
    "resource": "key",
    "action": "get",
    "options": {
      "uuid": "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、get_key.json)に保存し、それを編集して、指定されたキーを取得します。 
    {
  "service": {
    "category": "managed-object",
    "resource": "key",
    "action": "get",
    "options": {
      "uuid": "2359E04F-DA61-4F7C-BF9F-913D3369A93A"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object key getコマンドを実行します。 
    okv managed-object key get --from-json get_key.json

    出力は、次のようになります。 

    {
  "result": "Success",
   "value": {
    "object": "E7A641D77DDAF074C62E7A2C2355F2B8D9CD49486E6AF7F38A22CBDEC91630D0"
    }
 }

    対称キーが抽出可能でない場合は、次のメッセージが表示されます。 

    {
 "result" : "Failure",
 "message" : "Operation Result Status: Operation Failed, Result Reason: Unavailable"
}

出力形式としてのテキストの使用例

okv managed-object certificate-request get --output_format text --uuid 2359E04F-DA61-4F7C-BF9F-913D3369A93A

出力

出力は、次のようになります。 

"E7A641D77DDAF074C62E7A2C2355F2B8D9CD49486E6AF7F38A22CBDEC91630D0"

親トピック: セキュリティ・オブジェクトのコマンド

5.16 okv managed-object key registerコマンド

okv managed-object key registerコマンドでは、対称キーを登録します。

必要な権限

なし

構文

 okv managed-object key register [--activation-date activation date] [--algorithm algorithm] [--custom-attribute custom attribute]
       [--deactivation-date deactivation date] [--extractable extractable] [--length length] [--mask mask] [--name name] --object object
       [--wallet wallet]

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "managed-object",
    "resource" : "key",
    "action" : "register",
    "options" : {
      "length" : "#112,168(3DES)|128,192,256(AES)",
      "object" : "#VALUE",
      "algorithm" : "#3DES|AES",
      "mask" : [ "#ENCRYPT", "#DECRYPT", "#WRAP_KEY", "#UNWRAP_KEY", 
                 "#EXPORT", "#DERIVE_KEY", "#GENERATE_CRYPTOGRAM", "#VALIDATE_CRYPTOGRAM", 
                 "#TRANSLATE_ENCRYPT", "#TRANSLATE_DECRYPT", "#TRANSLATE_WRAP", "#TRANSLATE_UNWRAP" ],
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "extractable" : "#TRUE|FALSE"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--algorithm / algorithm

オプション

暗号化アルゴリズム。次の値から選択します。

  • AES
  • 3DES

    デフォルト値は次のとおりです。

  • AES

--length / length

オプション

アルゴリズムのキーの長さ。次の値から選択します。

  • AESの場合: 128、192、256
  • 3DESの場合: 112、168

    デフォルト値は次のとおりです。

  • 256

--mask / mask

オプション

二重引用符で囲まれた暗号化使用方法マスク次の値から選択します。

  • ENCRYPT
  • DECRYPT
  • DERIVE_KEY
  • EXPORT
  • GENERATE_CRYPTOGRAM
  • TRANSLATE_DECRYPT
  • TRANSLATE_ENCRYPT
  • TRANSLATE_UNWRAP
  • TRANSLATE_WRAP
  • UNWRAP_KEY
  • VALIDATE_CRYPTOGRAM
  • WRAP_KEY

デフォルト値は次のとおりです。

  • ENCRYPT
  • DECRYPT
  • WRAP_KEY
  • UNWRAP_KEY

--object / object

必須

対称キー・オブジェクトへのファイル・パス。

--wallet / wallet

オプション

ウォレット名。アクセスできる既存のウォレットの名前を調べるには、okv manage-access wallet listコマンドを実行します。

/attributes

オプション

属性名とその値。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。管理対象オブジェクトの既存の属性を調べるには、okv managed-object attribute listコマンドを実行します。

コマンドラインでは属性を指定できません。属性を使用する場合は、JSON構文を使用する必要があります。

入力できる属性は次のとおりです。

  • nameには、次の情報が含まれます。
    • valueは、名前値です。
    • typeは、textまたはuriです。
  • contactInfo
  • 次の日時属性:
    • activationDate
    • deactivationDate
    • protectStopDate
    • processStartDate

  • extractableは次のように設定できます。

    • TRUEにすると、オブジェクトをOracle Key Vaultから抽出できるようになります。

    • FALSEにすると、オブジェクト内のキー・マテリアルをOracle Key Vaultから抽出できなくなります。ただし、オブジェクトのメタデータ(オブジェクトの属性、状態など)は、引き続きOracle Key Vaultから取得できます。

    extractable属性を設定しない場合、この値はエンドポイントの構成から継承されます。コマンドラインでは、エンドポイントで有効な設定よりも厳しいextractable属性設定のみ指定できます。たとえば、エンドポイントでFALSEに設定されている場合は、extractable属性をTRUEに設定できません。ただし、コマンドラインでは、抽出可能属性の値を常にFALSEに設定できます。

日付と時間を設定するには、様々な方法を使用できます。次に各例を示します。 

"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time

UTC書式で時間を表示するには、Linuxのdateコマンドを使用します。たとえば: 

$ date --utc "+%F %T"
2021-03-15 20:31:37

これらの属性の詳細は、Key Management Interoperability Protocol仕様バージョン1.1を参照してください。

--name/ name

オプション

セキュリティ・オブジェクトの名前を指定します。使用可能な値は次のとおりです。

  • value
  • type

デフォルト値は次のとおりです。

  • text
    -Support complex data format, name attribute in command line
        --name '{"value" : "KEY1", "type" : "uri"}'or
        --name '{"value" : "KEY1", "type" : "text}'
-Support simplified data format, name attribute in command line. when type is "text" as a default:
        --name KEY1

--custom-attribute / customAttribute

オプション

セキュリティ・オブジェクトのカスタム定義属性を指定します。

2017-04-29 18:14:51"}'
        --custom-attribute '[ { "name": "x-OKV Certificate Expiration Date",
           "value" : "2017-04-29 18:14:51"}, { "name": "x-local-name", "value" : "HR"} ] '
Support simplified data format, name
      attribute(single instance), in command line --name KEY1
Support simplified data format, custom attribute(multi instance),in commandline
      --custom-attribute "x-local-name:HR" 
      --custom-attribute ' [  “x-local-name:HR”,“x-local-id:100” ]'

--deactivation-date/ deactivationDate

オプション

セキュリティ・オブジェクトを非アクティブ化するタイミングを指定します。activation-dateと同じ形式です。

--activation-date / activationDate

オプション
セキュリティ・オブジェクトをアクティブ化するタイミングを指定します。形式は次のとおりです。
"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time
--output_format

オプション

コマンドの出力形式を指定します。コマンドが正常に実行された場合、このコマンドは終了コード0で完了し、コマンドが失敗した場合は終了コード1で完了し、関連するエラーメッセージを生成します。

デフォルト値は次のとおりです。

  • text

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

JSONを使用しない例

       okv managed-object key register
        --length 128 --object/Users/dopark/test/my.key --algorithm AES 
        --mask "ENCRYPT" --name dw_0701--activation-date now --deactivation-date "2030-10-10 10:10:10"
        okv managed-object key register --name
        '{"value" : "dw_key_2"}'--activation-date --deactivation-date
        okv managed-object key register --name
        '{"value" : "dw_key_2", "type" :"uri"}' --activation-date --deactivation-date
        okv managed-object key register --name
        '{"value" : "dw_key_2", "type" :"text"}' --activation-date --deactivation-date
        okv managed-object key register --name
        '{"value" : "dw_key_2", "type" :"uri"}' --custom-attribute '[ { "name": "x-OKV
        Private Key UID", "value" :"CA8075A4-C13F-4FD0-BF58-FDB984CC879A"}, { "name":
        "x-NAME2", "value" :"11111"} ] ' --activation-date
        --deactivation-date

JSONの例

  1. okv managed-object key registerコマンド用にJSON入力を生成します。 
    okv managed-object key register --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "managed-object",
    "resource" : "key",
    "action" : "register",
    "options" : {
      "length" : "#112,168(3DES)|128,192,256(AES)",
      "object" : "#VALUE",
      "algorithm" : "#3DES|AES",
      "mask" : [ "#ENCRYPT", "#DECRYPT", "#WRAP_KEY", "#UNWRAP_KEY", 
                 "#EXPORT", "#DERIVE_KEY", "#GENERATE_CRYPTOGRAM", "#VALIDATE_CRYPTOGRAM", 
                 "#TRANSLATE_ENCRYPT", "#TRANSLATE_DECRYPT", "#TRANSLATE_WRAP", "#TRANSLATE_UNWRAP" ],
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "activationDate" : "#YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#VALUE",
        "processStartDate" : "#VALUE",
        "protectStopDate" : "#VALUE",
        "extractable" : "#TRUE|FALSE"
      }
    }
  }
}
  2. 生成された入力をファイル(たとえば、reg_key.json)に保存し、それを編集してキーを登録します。 
    {
  "service": {
    "category": "managed-object",
    "resource": "key",
    "action": "register",
    "options": {
      "length": "256",
      "object": "./object.txt",
      "algorithm": "AES",
      "mask": [
        "ENCRYPT",
        "DECRYPT"
      ],
      "wallet": "hr_wallet",
      "attributes": {
        "name": {
          "value": "FINDB-PROD-MKEY",
          "type": "text"
        },
        "contactInfo" : "pfitch@example.com"
        "activationDate" : "2020-12-31 09:00:00",
        "deactivationDate" : "2024-12-31 09:00:00",
        "processStartDate" : "2020-12-31 09:00:00",
        "protectStopDate" : "2024-12-31 09:00:00",
        "extractable" : "FALSE"
      }
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object key registerコマンドを実行します。 
    okv managed-object key register --from-json reg_key.json

    出力は、次のようになります。 

    {
 "result": "Success",
  "value": {
   "uuid": "39BE0215-5D7B-4F38-BF5F-FC87C82AA004"
  }
}

出力形式としてのテキストの使用例

okv managed-object key register --output_format text --algorithm cryptographic_algorithm --length key_length --mask cryptographic_usage_mask --object key_file_path --wallet wallet_name

出力

出力は、次のようになります。 

"39BE0215-5D7B-4F38-BF5F-FC87C82AA004"

関連トピック

親トピック: セキュリティ・オブジェクトのコマンド

5.17 okv managed-object object activateコマンド

okv managed-object object activateコマンドでは、セキュリティ・オブジェクトをアクティブ化します。

セキュリティ・オブジェクトの各種状態の詳細は、Oasis Key Management Interoperability Protocol仕様バージョン1.1 Oasis標準を参照してください。

必要な権限

エンドポイントには、オブジェクトに対する読取り変更権限が必要です。

構文

okv managed-object object activate --uuid UUID

JSON入力ファイル・テンプレート

{
  "service": {
    "category": "managed-object",
    "resource": "object",
    "action": "activate",
    "options": {
      "uuid": "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--uuid / uuid

必須

セキュリティ・オブジェクトのUUID (Universally Unique ID)

オブジェクトの一意識別子を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブをクリックして、左側のナビゲーション・ウィンドウで「Keys & Secrets」をクリックします。「Keys & Secrets」表で、「Unique Identifier」列を確認します。

--output_format

オプション

コマンドの出力形式を指定します。コマンドが正常に実行された場合、このコマンドは終了コード0で完了し、コマンドが失敗した場合は終了コード1で完了し、関連するエラーメッセージを生成します。

デフォルト値は次のとおりです。

  • text

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

JSONの例

  1. okv managed-object managed-object activateコマンド用にJSON入力を生成します。 
    okv managed-object object activate --generate-json-input

    次のような入力が生成されます。 

    {
  "service": {
    "category": "managed-object",
    "resource": "object",
    "action": "activate",
    "options": {
      "uuid": "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、activate_object.json)に保存し、それを編集してセキュリティ・オブジェクトをアクティブ化します。 
    {
  "service": {
    "category": "managed-object",
    "resource": "object",
    "action": "activate",
    "options": {
      "uuid": "2359E04F-DA61-4F7C-BF9F-913D3369A93A"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object managed-object activateコマンドを実行します。 
    okv managed-object object activate --from-json activate_object.json

    出力は、次のようになります。 

    {
 "result": "Success"
}

出力書式テキストの使用例

okv managed-object object activate --output_format text --uuid UUID

出力

出力は、次のようになります。
  • 終了コード0 - 成功を示します
  • 終了コード1 - 失敗を示します

親トピック: セキュリティ・オブジェクトのコマンド

5.18 okv managed-object object destroyコマンド

okv managed-object object destroyコマンドでは、セキュリティ・オブジェクトのキー・データを破棄するようにサーバーにリクエストします。

必要な権限

エンドポイントには、オブジェクトに対する読取り変更権限が必要です。

構文

okv managed-object object destroy --uuid UUID

JSON入力ファイル・テンプレート

{
  "service": {
    "category": "managed-object",
    "resource": "object",
    "action": "destroy",
    "options": {
      "uuid": "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--uuid / uuid

必須

セキュリティ・オブジェクトのUUID (Universally Unique ID)

オブジェクトの一意識別子を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブをクリックして、左側のナビゲーション・ウィンドウで「Keys & Secrets」をクリックします。「Keys & Secrets」表で、「Unique Identifier」列を確認します。

--output_format

オプション

コマンドの出力形式を指定します。コマンドが正常に実行された場合、このコマンドは終了コード0で完了し、コマンドが失敗した場合は終了コード1で完了し、関連するエラーメッセージを生成します。

デフォルト値は次のとおりです。

  • text

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

JSONの例

  1. okv managed-object object destroyコマンド用にJSON入力を生成します。 
    okv managed-object object destroy --generate-json-input

    次のような入力が生成されます。 

    {
  "service": {
    "category": "managed-object",
    "resource": "object",
    "action": "destroy",
    "options": {
      "uuid": "#VALUE"
     }
   }
 }
  2. 生成された入力をファイル(たとえば、destroy_obj.json)に保存して、セキュリティ・オブジェクト・データを破棄できるように編集します。
    {
  "service": {
    "category": "managed-object",
    "resource": "object",
    "action": "destroy",
    "options": {
      "uuid": "B36F3AD1-0AC7-4FEB-BF32-79E6F727ECB2"
      }
    }
 }
  3. 生成されたJSONファイルを使用して、okv managed-object object destroyコマンドを実行します。 
    okv managed-object object destroy --from-json destroy_obj.json

    出力は、次のようになります。 

    {
 "result": "Success"
}

出力書式テキストの使用例

okv managed-object object destroy --output_format text --uuid UUID

出力

出力は、次のようになります。
  • 終了コード0 - 成功を示します
  • 終了コード1 - 失敗を示します

親トピック: セキュリティ・オブジェクトのコマンド

5.19 okv managed-object object fetchコマンド

okv managed-object fetchコマンドは、セキュリティ・オブジェクトとその属性をまとめてフェッチします。

必要な権限

エンドポイントには、オブジェクトに対する読取り権限が必要です

構文

 okv managed-object object fetch [--activation-date activation date] [--archive-date archive date] [--certificate-length certificate
       length] [--certificate-type certificate type] [--compromise-date compromise date] [--compromise-occurrence-date compromise occurrence
       date] [--contact-info contact information] [--crypto-usage-mask cryptoUsageMask] [--cryptographic-algorithm cryptographic
       algorithm] [--cryptographic-length cryptographic length] [--custom-attribute custom attribute] [--deactivation-date deactivation date]
       [--destroy-date destroy date] [--digest digest] [--digital-signing-algorithm digital signing algorithm] [--extractable true|false]
       [--initial-date initial date] [--last-change-date last change date] [--link link] [--max max] [--name name] [--never-extractable
       true|false] [--object-group-member object group member] [--object-type object type] [--process-start-date process start date]
       [--protect-stop-date protect stop date] [--single-object true|false] [--state state] [--x509-certificate-issuer X.509 certificate
       issuer] [--x509-certificate-subject X.509 certificate subject]

JSON入力ファイル・テンプレート 

{
  "service" : {
    "category" : "managed-object",
    "resource" : "object",
    "action" : "fetch",
    "options" : {
      "max" : "#VALUE",
      "objectGroupMember" : "#FRESH|DEFAULT",
      "attributes" : {
        "name" : {
          "value" : "#VALUE"
        },
        "state" : "#PRE-ACTIVE|ACTIVE|DEACTIVATED|COMPROMISED|DESTROYED|DESTROYED_COMPROMISED",
        "objectType" : "#VALUE",
        "fresh" : "#YES|NO",
        "objectGroup" : "#VALUE",
        "contactInfo" : "#VALUE",
        "cryptographicAlgorithm" : "#VALUE",
        "cryptographicLength" : "#VALUE",
        "cryptoUsageMask" : "#VALUE",
        "certificateLength" : "#VALUE",
        "certificateType" : "#VALUE",
        "x509CertificateSubject" : "#VALUE",
        "x509CertificateIssuer" : "#VALUE",
        "digitalSigningAlgorithm" : "#VALUE",
        "digest" : {
          "digestValue" : "#VALUE",
          "algorithm" : "#VALUE",
          "keyFormatType" : "#VALUE"
        },
        "link" : {
          "linkType" : "#VALUE",
          "linkValue" : "#VALUE"
        },
        "activationDate" : "#YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#YYYY-MM-DD HH:mm:ss",
        "initialDate" : "#YYYY-MM-DD HH:mm:ss",
        "lastChangeDate" : "#YYYY-MM-DD HH:mm:ss",
        "compromiseDate" : "#YYYY-MM-DD HH:mm:ss",
        "compromiseOccurrenceDate" : "#YYYY-MM-DD HH:mm:ss",
        "destroyDate" : "#YYYY-MM-DD HH:mm:ss",
        "archiveDate" : "#YYYY-MM-DD HH:mm:ss",
        "extractable" : "#TRUE|FALSE",
        "neverExtractable" : "#TRUE|FALSE"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--max / max

オプション

このコマンドが戻すオブジェクトの最大数

--object-group-member / objectGroupMember

オプション

次のいずれかのグループ値を入力します。

  • DEFAULT
  • FRESH

--state / state

オプション

次のいずれかの状態を入力します。

  • PREACTIVE
  • ACTIVE
  • DEACTIVATED
  • COMPROMISED
  • DESTROYED
  • DESTROYED_COMPROMISED
--activation-date / activationDate

オプション
セキュリティ・オブジェクトをアクティブ化するタイミングを指定します。形式は次のとおりです。
"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time
このパラメータを省略した場合、アクティブ化日は、アップロードされている証明書ファイルから取得されます。 
If activationDate meets the date criteria,the date is overwritten with the provided date.
    notBefore < deactivationDate <= notAfter
    activationDate < deactivationDate
activation-dateが条件を満たさない場合は、エラー・メッセージが表示されます。
--archive-date / archiveDate

オプション

セキュリティ・オブジェクトがアーカイブ・ストレージに保管された日時を指定します。
--certificate-length / certificateLength

オプション

証明書オブジェクトの長さをバイト単位で指定します。

--certificate-type / certificateType

オプション

証明書のタイプを指定します。
--compromise-date / compromiseDate

オプション

管理対象暗号化オブジェクトが侵害状態になった日時を指定します。

--compromise-occurrence-date / compromiseOccurrenceDate

オプション

そのセキュリティ・オブジェクトが最初に侵害されたと考えられる日時を指定します。この設定は、--codeパラメータにKEY_COMPROMISEが指定されている場合のみ使用します。

--contact-info / contactInfo

オプション

この属性は説明のためにのみ用意されています。
--crypto-usage-mask / cryptoUsageMask

オプション

セキュリティ・オブジェクトの暗号化使用方法を指定します。
--cryptographic-algorithm/ cryptographicAlgorithm

オプション

セキュリティ・オブジェクトで使用されるアルゴリズムを指定します。
--cryptographic-length / cryptographicLength

オプション

セキュリティ・オブジェクトの暗号化キー・マテリアルの長さをビット単位で指定します。
--deactivation-date / deactivationDate

オプション
セキュリティ・オブジェクトを非アクティブ化するタイミングを指定します。activation-dateと同じ形式です。このパラメータを省略した場合、非アクティブ化日は、アップロードされている証明書ファイルから取得されます。 
If deactivationDate meets the date criteria,the date is overwritten with the provided date.
 notBefore <= activationDate < notAfter
 activationDate < deactivationDate
deactivation-dateが条件を満たさない場合は、エラー・メッセージが表示されます。
--destroy-date / destroyDate

オプション

セキュリティ・オブジェクトが破棄された日時を指定します。

--digest / digest

オプション

セキュリティ・オブジェクトのダイジェスト値を指定します。
--digital-signing-algorithm / digitalSigningAlgorithm

オプション

デジタル署名付きオブジェクトに関連付けられているデジタル署名アルゴリズムを指定します。
--extractable / extractable

オプション
true値またはfalse値を指定します。
  • FALSE: オブジェクト値の取得がサーバーで防止されるように指定します。
  • TRUE: クライアントで値が指定されていない場合に、デフォルト値としてtrueを指定します。
.
--initial-date / initialDate

オプション

セキュリティ・オブジェクトがサーバーで最初に作成または登録された日時を指定します。
--last-change-date / lastChangeDate

オプション

指定されたオブジェクトの最終変更の日時を指定します。
--link / link

オプション

あるセキュリティ・オブジェクトから別の密接に関連するターゲット・セキュリティ・オブジェクトへのリンクを指定します。
--max / max

オプション

Specifies the maximum number of objects that this command should return.
--object-group-member/ objectGroupMember

オプション

オブジェクト・グループ・メンバー・タイプとしてDEFAULTまたはFRESHを指定します。

--object-type / objectType

オプション

セキュリティ・オブジェクト・タイプを指定します。
--process-start-date / processStartDate  

有効なセキュリティ・オブジェクトでの、暗号で保護された情報の処理が開始される日時を指定します。
--protect-stop-date / protect-stop-date

オプション

有効なセキュリティ・オブジェクトを暗号化保護の適用に使用できなくなる日時を指定します。
--state / state

オプション

オブジェクトの様々な状態としてPREACTIVE、ACTIVE、DEACTIVATED、COMPROMISED、DESTROYEDおよびDESTROYED_COMPROMISEDを指定します。

--x509-certificate-issuer / x509CertificateIssuer

オプション

X.509証明書での発行者識別名を指定します。
--x509-certificate-subject / x509CertificateSubject

オプション

X.509証明書サブジェクトでのサブジェクト識別名を指定します。

/ attributes

必須

検索するオブジェクトの属性名とその値。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。コマンドラインでは属性を指定できません。属性を使用する場合は、JSON構文を使用する必要があります。

入力できる属性は次のとおりです。

  • name includes value。
  • stateは、オブジェクトの状態です。
  • objectType、オブジェクトのタイプ。
  • freshは、オブジェクトが新規かどうかを示します。YESまたはNOを入力します。
  • objectGroupは、オブジェクト・グループまたはウォレット名です。
  • contactInfoは、オブジェクトの連絡先情報です。
  • cryptographicAlgorithmは、オブジェクトの暗号化アルゴリズムです。
  • cryptographicLengthは、オブジェクトの暗号の長さです。
  • cryptoUsageMaskは、オブジェクトの使用マスクです。
  • certificateTypeは、証明書オブジェクトのタイプです。
  • x509CertificateSubjectは、X.509証明書のサブジェクトです。
  • x509CertificateIssuerは、X.509証明書の発行者です。
  • digitalSigningAlgorithmは、オブジェクトのデジタル署名アルゴリズムです。
  • digestは、次のようなオブジェクトのダイジェストです。
    • digestValueは、ダイジェストの値です。
    • algorithmは、ハッシュ・アルゴリズムです。
    • keyFormatTypeは、オブジェクトの形式です。
  • linkは、オブジェクトのリンク属性で、次のものが含まれます。
    • linkTypeは、リンクのタイプです。
    • linkValueは、リンクされたオブジェクトUUIDです。
  • 次の日時属性:
    • activationDate
    • deactivationDate
    • protectStopDate
    • processStartDate
    • activationDate
    • deactivationDate
    • processStartDate
    • protectStopDate
    • initialDate
    • lastChangeDate
    • compromiseDate
    • compromiseOccurrenceDate
    • destroyDate
    • archiveDate

  • extractableは次のように設定できます。

    • TRUEにすると、オブジェクトをOracle Key Vaultから抽出できるようになります。

    • FALSEにすると、オブジェクト内のキー・マテリアルをOracle Key Vaultから抽出できなくなります。ただし、オブジェクトのメタデータ(オブジェクトの属性、状態など)は、引き続きOracle Key Vaultから取得できます。

  • neverExtractableは、セキュリティ・オブジェクトがOracle Key Vaultサーバーに存在していた間、その抽出が常に制限されていたかどうかを追跡します。設定は次のとおりです。
    • TRUEは、セキュリティ・オブジェクトが存在していた間、そのオブジェクトはOracle Key Vaultから抽出可能ではなかったことを意味します。
    • FALSEは、セキュリティ・オブジェクトが存在していた間、そのオブジェクトが1回以上Oracle Key Vaultから抽出可能だったことを意味します。

日付と時間を設定するには、様々な方法を使用できます。次に各例を示します。 

"activationDate" : "2021-12-20 10:30:00" --starts at this date and time

UTC書式で時間を表示するには、Linuxのdateコマンドを使用します。たとえば: 

$ date --utc "+%F %T"
2021-03-15 20:31:37

--custom attributes /customAttribute

オプション

検索するオブジェクトのカスタム属性のリスト。

入力できるカスタム属性は次のとおりです。

  • nameは、カスタム属性の名前です。
  • valueは、カスタム属性の値です。
  • typeは、textまたはnumberです。 
    
-Specifies custom defined attribute on security object. 2017-04-29 18:14:51"}'
        --custom-attribute '[ { "name": "x-OKV Certificate Expiration Date",
           "value" : "2017-04-29 18:14:51"}, { "name": "x-local-name", "value" : "HR"} ] '
-Support simplified data format, name
      attribute(single instance), in command line --name KEY1
-Support simplified data format, custom attribute(multi instance),in commandline
      --custom-attribute "x-local-name:HR"
      --custom-attribute ' [ “x-local-name:HR”,“x-local-id:100” ]'

これらの属性の詳細は、Key Management Interoperability Protocol仕様バージョン1.1を参照してください。

--name

オプション

セキュリティ・オブジェクトの名前を指定します。使用可能な値は次のとおりです。

  • value
  • type

デフォルトの型:

  • text
-Support complex data format, name attribute in command line
        --name '{"value" : "KEY1", "type" : "uri"}'or
        --name '{"value" : "KEY1", "type" : "text}'
-Support simplified data format, name attribute in command line. when type is "text" as a default:
        --name KEY1

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

JSONの例

  1. コマンドのJSON入力を生成します。 
    okv managed-object object fetch --generate-json-input

    次のような入力が生成されます。 

    okv managed-object object fetch --generate-json-input
{
  "service" : {
    "category" : "managed-object",
    "resource" : "object",
    "action" : "fetch",
    "options" : {
      "max" : "#VALUE",
      "objectGroupMember" : "#FRESH|DEFAULT",
      "attributes" : {
        "name" : {
          "value" : "#VALUE"
        },
        "state" : "#PRE-ACTIVE|ACTIVE|DEACTIVATED|COMPROMISED|DESTROYED|DESTROYED_COMPROMISED",
        "objectType" : "#VALUE",
        "fresh" : "#YES|NO",
        "objectGroup" : "#VALUE",
        "contactInfo" : "#VALUE",
        "cryptographicAlgorithm" : "#VALUE",
        "cryptographicLength" : "#VALUE",
        "cryptoUsageMask" : "#VALUE",
        "certificateLength" : "#VALUE",
        "certificateType" : "#VALUE",
        "x509CertificateSubject" : "#VALUE",
        "x509CertificateIssuer" : "#VALUE",
        "digitalSigningAlgorithm" : "#VALUE",
        "digest" : {
          "digestValue" : "#VALUE",
          "algorithm" : "#VALUE",
          "keyFormatType" : "#VALUE"
        },
        "link" : {
          "linkType" : "#VALUE",
          "linkValue" : "#VALUE"
        },
        "activationDate" : "#YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#YYYY-MM-DD HH:mm:ss",
        "initialDate" : "#YYYY-MM-DD HH:mm:ss",
        "lastChangeDate" : "#YYYY-MM-DD HH:mm:ss",
        "compromiseDate" : "#YYYY-MM-DD HH:mm:ss",
        "compromiseOccurrenceDate" : "#YYYY-MM-DD HH:mm:ss",
        "destroyDate" : "#YYYY-MM-DD HH:mm:ss",
        "archiveDate" : "#YYYY-MM-DD HH:mm:ss",
        "extractable" : "#TRUE|FALSE",
        "neverExtractable" : "#TRUE|FALSE"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}
  2. 生成された入力をファイル(fetch_obj.jsonなど)に保存します。
  3. 生成されたJSONファイルを使用して、コマンドを実行します。たとえば:
    okv managed-object object fetch --from-json fetch_obj.json 
--object-group-member --single-object --state

    出力は、次のようになります。 

    {
  "result" : "Success",
  "value" : [ {
    "attributes" : {
      "activationDate" : "2022-07-01 15:54:38",
      "cryptographicAlgorithm" : "RSA",
      "cryptographicLength" : "2048",
      "cryptoUsageMask" : [ "ENCRYPT" ],
      "deactivationDate" : "2030-10-10 10:10:10",
      "digest" : {
        "digestValue" : "B8ACE70487179C70DF3A6D320CA0D52FF7F4FB2D9E41E9542E7D8C0166B3D93",
        "keyFormatType" : "RAW",
        "algorithm" : "SHA-256"
      },
      "fresh" : "No",
      "initialDate" : "2022-07-01 15:54:38",
      "lastChangeDate" : "2022-07-01 17:57:24",
       "name" : [ {
        "type" : "text",
        "value" : "private_0701"
      } ],
      "objectType" : "Private Key",
      "processStartDate" : "2022-07-01 15:54:38",
      "state" : "Active",
      "uuid" : "95092BD2-B546-4F9A-BF0B-D8ECDC548546"
    }, "customAttribute" : [ {
      "name" : "x-NAME",
      "index" : "0",
      "type" : "Text String",
      "value" : "test4"
    }, {
      "name" : "x-ID",
      "index" : "0",
      "type" : "Integer",
      "value" : "1"
    } ],
       "object" : "-----BEGIN OPENSSH PRIVATE KEY-----\nb3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn\nNhAAAAAwEAAQAAAYEAyYrcnHs6I51lHheg90qTripWIuVKszoluqnBG0+QRLdLKOMIJjajygXKlT\n04DJSrQliR45oki2s/dgyfsTqpvanjTj7W10O5X2poohlGojumNOmb2p52em55yABUcYOb\nK4Qf5sX4vDpc/iUQAAABFkb3BhcmtAZG9wYXJrLW1hYw==\n-----END OPENSSH PRIVATE KEY-----\n"
  } ]
}

出力書式テキストの使用例

okv managed-object object fetch --max max_value --object-group-member object_group_member_type --state state_value --name name_value

親トピック: セキュリティ・オブジェクトのコマンド

5.20 okv managed-object object locateコマンド

okv managed-object object locateコマンドでは、セキュリティ・オブジェクトを検索します。

必要な権限

エンドポイントには、オブジェクトに対する読取り権限が必要です。

構文

 okv managed-object object locate [--activation-date activation date] [--archive-date archive date] [--certificate-length certificate
       length] [--certificate-type certificate type] [--compromise-date compromise date] [--compromise-occurrence-date compromise occurrence
       date] [--contact-info contact information] [--crypto-usage-mask cryptoUsageMask] [--cryptographic-algorithm cryptographic
       algorithm] [--cryptographic-length cryptographic length] [--custom-attribute custom attribute] [--deactivation-date deactivation date]
       [--destroy-date destroy date] [--digest digest] [--digital-signing-algorithm digital signing algorithm] [--extractable true|false]
       [--initial-date initial date] [--last-change-date last change date] [--link link] [--max max] [--name name] [--never-extractable
       true|false] [--object-group-member object group member] [--object-type object type] [--process-start-date process start date]
       [--protect-stop-date protect stop date] [--single-object true|false] [--state state] [--x509-certificate-issuer X.509 certificate
       issuer] [--x509-certificate-subject X.509 certificate subject]

JSON入力ファイル・テンプレート

okv managed-object object locate --generate-json-input

{
  "service" : {
    "category" : "managed-object",
    "resource" : "object",
    "action" : "locate",
    "options" : {
      "max" : "#VALUE",
      "objectGroupMember" : "#FRESH|DEFAULT",
      "attributes" : {
        "name" : {
          "value" : "#VALUE"
        },
        "state" : "#PRE-ACTIVE|ACTIVE|DEACTIVATED|COMPROMISED|DESTROYED|DESTROYED_COMPROMISED",
        "objectType" : "#VALUE",
        "fresh" : "#YES|NO",
        "objectGroup" : "#VALUE",
        "contactInfo" : "#VALUE",
        "cryptographicAlgorithm" : "#VALUE",
        "cryptographicLength" : "#VALUE",
        "cryptoUsageMask" : "#VALUE",
        "certificateLength" : "#VALUE",
        "certificateType" : "#VALUE",
        "x509CertificateSubject" : "#VALUE",
        "x509CertificateIssuer" : "#VALUE",
        "digitalSigningAlgorithm" : "#VALUE",
        "digest" : {
          "digestValue" : "#VALUE",
          "algorithm" : "#VALUE",
          "keyFormatType" : "#VALUE"
        },
        "link" : {
          "linkType" : "#VALUE",
          "linkValue" : "#VALUE"
        },
        "activationDate" : "#YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#YYYY-MM-DD HH:mm:ss",
        "initialDate" : "#YYYY-MM-DD HH:mm:ss",
        "lastChangeDate" : "#YYYY-MM-DD HH:mm:ss",
        "compromiseDate" : "#YYYY-MM-DD HH:mm:ss",
        "compromiseOccurrenceDate" : "#YYYY-MM-DD HH:mm:ss",
        "destroyDate" : "#YYYY-MM-DD HH:mm:ss",
        "archiveDate" : "#YYYY-MM-DD HH:mm:ss",
        "extractable" : "#TRUE|FALSE",
        "neverExtractable" : "#TRUE|FALSE"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--max / max

オプション

このコマンドが戻すオブジェクトの最大数

--object-group-member / objectGroupMember

オプション

次のいずれかのグループ値を入力します。

  • DEFAULT
  • FRESH

--state / state

オプション

次のいずれかの状態を入力します。

  • PREACTIVE
  • ACTIVE
  • DEACTIVATED
  • COMPROMISED
  • DESTROYED
  • DESTROYED_COMPROMISED

--name / name

オプション

検索するオブジェクトの名前。

attributes

必須

検索するオブジェクトの属性名とその値。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。コマンドラインでは属性を指定できません。属性を使用する場合は、JSON構文を使用する必要があります。

入力できる属性は次のとおりです。

  • name includes value。
  • stateは、オブジェクトの状態です。
  • objectType、オブジェクトのタイプ。
  • freshは、オブジェクトが新規かどうかを示します。YESまたはNOを入力します。
  • objectGroupは、オブジェクト・グループまたはウォレット名です。
  • contactInfoは、オブジェクトの連絡先情報です。
  • cryptographicAlgorithmは、オブジェクトの暗号化アルゴリズムです。
  • cryptographicLengthは、オブジェクトの暗号の長さです。
  • cryptoUsageMaskは、オブジェクトの使用マスクです。
  • certificateTypeは、証明書オブジェクトのタイプです。
  • x509CertificateSubjectは、X.509証明書のサブジェクトです。
  • x509CertificateIssuerは、X.509証明書の発行者です。
  • digitalSigningAlgorithmは、オブジェクトのデジタル署名アルゴリズムです。
  • digestは、次のようなオブジェクトのダイジェストです。
    • digestValueは、ダイジェストの値です。
    • algorithmは、ハッシュ・アルゴリズムです。
    • keyFormatTypeは、オブジェクトの形式です。
  • linkは、オブジェクトのリンク属性で、次のものが含まれます。
    • linkTypeは、リンクのタイプです。
    • linkValueは、リンクされたオブジェクトUUIDです。
  • 次の日時属性:
    • activationDate
    • deactivationDate
    • protectStopDate
    • processStartDate
    • activationDate
    • deactivationDate
    • processStartDate
    • protectStopDate
    • initialDate
    • lastChangeDate
    • compromiseDate
    • compromiseOccurrenceDate
    • destroyDate
    • archiveDate

  • extractableは次のように設定できます。

    • TRUEにすると、オブジェクトをOracle Key Vaultから抽出できるようになります。

    • FALSEにすると、オブジェクト内のキー・マテリアルをOracle Key Vaultから抽出できなくなります。ただし、オブジェクトのメタデータ(オブジェクトの属性、状態など)は、引き続きOracle Key Vaultから取得できます。

  • neverExtractableは、セキュリティ・オブジェクトがOracle Key Vaultサーバーに存在していた間、その抽出が常に制限されていたかどうかを追跡します。設定は次のとおりです。
    • TRUEは、セキュリティ・オブジェクトが存在していた間、そのオブジェクトはOracle Key Vaultから抽出可能ではなかったことを意味します。
    • FALSEは、セキュリティ・オブジェクトが存在していた間、そのオブジェクトが1回以上Oracle Key Vaultから抽出可能だったことを意味します。

日付と時間を設定するには、様々な方法を使用できます。次に各例を示します。 

"activationDate" : "2021-12-20 10:30:00" --starts at this date and time

UTC書式で時間を表示するには、Linuxのdateコマンドを使用します。たとえば: 

$ date --utc "+%F %T"
2021-03-15 20:31:37
--activation-date / activationDate

オプション
セキュリティ・オブジェクトをアクティブ化するタイミングを指定します。形式は次のとおりです。
"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time
このパラメータを省略した場合、アクティブ化日は、アップロードされている証明書ファイルから取得されます。 
If activationDate meets the date criteria,the date is overwritten with the provided date.
    notBefore < deactivationDate <= notAfter
    activationDate < deactivationDat
activation-dateが条件を満たさない場合は、エラー・メッセージが表示されます。
--archive-date / archiveDate

オプション

セキュリティ・オブジェクトがアーカイブ・ストレージに保管された日時を指定します。
--certificate-length / certificateLength

オプション

証明書オブジェクトの長さをバイト単位で指定します。

--certificate-type / certificateType

オプション

証明書のタイプを指定します。
--compromise-date / compromiseDate

オプション

管理対象暗号化オブジェクトが侵害状態になった日時を指定します。

--compromise-occurrence-date / compromiseOccurrence-date

オプション

そのセキュリティ・オブジェクトが最初に侵害されたと考えられる日時を指定します。この設定は、--codeパラメータにKEY_COMPROMISEが指定されている場合のみ使用します。

--contact-info / contactInformation

オプション

この属性は説明のためにのみ用意されています。
--crypto-usage-mask / cryptoUsageMask

オプション

セキュリティ・オブジェクトの暗号化使用方法を指定します。
--cryptographic-algorithm/ cryptographicAlgorithm

オプション

セキュリティ・オブジェクトで使用されるアルゴリズムを指定します。
--cryptographic-length / cryptographicLength

オプション

セキュリティ・オブジェクトの暗号化キー・マテリアルの長さをビット単位で指定します。
--custom-attribute / customAttribute

オプション

Oracle Key Vaultで解釈できない、エンドポイントで定義されている追加属性を指定します。
--deactivation-date / deactivationDate

オプション
セキュリティ・オブジェクトを非アクティブ化するタイミングを指定します。activation-dateと同じ形式です。このパラメータを省略した場合、非アクティブ化日は、アップロードされている証明書ファイルから取得されます。 
If deactivationDate meets the date criteria,the date is overwritten with the provided date.
 notBefore <= activationDate < notAfter
 activationDate < deactivationDate
deactivation-dateが条件を満たさない場合は、エラー・メッセージが表示されます。
--destroy-date/ destroyDate

オプション

セキュリティ・オブジェクトが破棄された日時を指定します。

--digest / digest

オプション

セキュリティ・オブジェクトのダイジェスト値を指定します。
--digital-signing-algorithm / digital signing algorithm

オプション

デジタル署名付きオブジェクトに関連付けられているデジタル署名アルゴリズムを指定します。
--extractable / extractable

オプション
true値またはfalse値を指定します。
  • FALSE: オブジェクト値の取得がサーバーで防止されるように指定します。
  • TRUE: クライアントで値が指定されていない場合に、デフォルト値としてtrueを指定します。
.
--initial-date / initialDate

オプション

セキュリティ・オブジェクトがサーバーで最初に作成または登録された日時を指定します。
--last-change-date/ lastChangeDate

オプション

指定されたオブジェクトの最終変更の日時を指定します。
--link/ link

オプション

あるセキュリティ・オブジェクトから別の密接に関連するターゲット・セキュリティ・オブジェクトへのリンクを指定します。
--max/ max

オプション

Specifies the maximum number of objects that this command should return.
--name/ name

オプション

検索するオブジェクトの名前を指定します。
--never-extractable/ neverExtractable

オプション

抽出可能属性が常にFALSEの場合に、値としてTRUEを指定します。

--object-group-member/ objectGroupMember

オプション

オブジェクト・グループ・メンバー・タイプとしてDEFAULTまたはFRESHを指定します。

--object-type / objectType

オプション

セキュリティ・オブジェクト・タイプを指定します。
--process-start-date/ processStartDate  

有効なセキュリティ・オブジェクトでの、暗号で保護された情報の処理が開始される日時を指定します。
--protect-stop-date/ protectStopDate

オプション

有効なセキュリティ・オブジェクトを暗号化保護の適用に使用できなくなる日時を指定します。
--state/ state

オプション

オブジェクトの様々な状態としてPREACTIVE、ACTIVE、DEACTIVATED、COMPROMISED、DESTROYEDおよびDESTROYED_COMPROMISEDを指定します。

--x509-certificate-issuer/ x509CertificateIssuer

オプション

X.509証明書での発行者識別名を指定します。
--x509-certificate-subject / x509CertificateSubject

オプション

X.509証明書サブジェクトでのサブジェクト識別名を指定します。

--cutstom-attribute / customAttribute

オプション

検索するオブジェクトのカスタム属性のリスト。

入力できるカスタム属性は次のとおりです。

  • nameは、カスタム属性の名前です。
  • valueは、カスタム属性の値です。
  • typeは、textまたはnumberです。
    
-Support simplified data format, name
      attribute(single instance), in command line --name KEY1
-Support simplified data format, custom attribute(multi instance),in commandline
      --custom-attribute "x-local-name:HR"
      --custom-attribute ' [ “x-local-name:HR”,“x-local-id:100” ]'

これらの属性の詳細は、Key Management Interoperability Protocol仕様バージョン1.1を参照してください。

--name/ name

オプション

セキュリティ・オブジェクトの名前を指定します。使用可能な値は次のとおりです。

  • value
  • type

デフォルト値は次のとおりです。

  • text
    -Support complex data format, name attribute in command line
        --name '{"value" : "KEY1", "type" : "uri"}'or
        --name '{"value" : "KEY1", "type" : "text}'
-Support simplified data format, name attribute in command line. when type is "text" as a default:
        --name KEY1
--output_format

オプション

コマンドの出力形式を指定します。コマンドが正常に実行された場合、このコマンドは終了コード0で完了し、コマンドが失敗した場合は終了コード1で完了し、関連するエラーメッセージを生成します。

デフォルト値は次のとおりです。

  • text

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

JSONの例

  1. okv managed-object object locateコマンド用にJSON入力を生成します。 
    okv managed-object object locate --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "managed-object",
    "resource" : "object",
    "action" : "locate",
    "options" : {
      "max" : "#VALUE",
      "objectGroupMember" : "#FRESH|DEFAULT",
      "attributes" : {
        "name" : {
          "value" : "#VALUE"
        },
        "state" : "#PRE-ACTIVE|ACTIVE|DEACTIVATED|COMPROMISED|DESTROYED|DESTROYED_COMPROMISED",
        "objectType" : "#VALUE",
        "fresh" : "#YES|NO",
        "objectGroup" : "#VALUE",
        "contactInfo" : "#VALUE",
        "cryptographicAlgorithm" : "#VALUE",
        "cryptographicLength" : "#VALUE",
        "cryptoUsageMask" : "#VALUE",
        "certificateLength" : "#VALUE",
        "certificateType" : "#VALUE",
        "x509CertificateSubject" : "#VALUE",
        "x509CertificateIssuer" : "#VALUE",
        "digitalSigningAlgorithm" : "#VALUE",
        "digest" : {
          "digestValue" : "#VALUE",
          "algorithm" : "#VALUE",
          "keyFormatType" : "#VALUE"
        },
        "link" : {
          "linkType" : "#VALUE",
          "linkValue" : "#VALUE"
        },
        "activationDate" : "#YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#YYYY-MM-DD HH:mm:ss",
        "initialDate" : "#YYYY-MM-DD HH:mm:ss",
        "lastChangeDate" : "#YYYY-MM-DD HH:mm:ss",
        "compromiseDate" : "#YYYY-MM-DD HH:mm:ss",
        "compromiseOccurrenceDate" : "#YYYY-MM-DD HH:mm:ss",
        "destroyDate" : "#YYYY-MM-DD HH:mm:ss",
        "archiveDate" : "#YYYY-MM-DD HH:mm:ss",
        "extractable" : "#TRUE|FALSE",
        "neverExtractable" : "#TRUE|FALSE"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}
  2. 生成された入力をファイル(たとえば、locate_obj.json)に保存し、それを編集してセキュリティ・オブジェクトを検索します。 
    {
  "service" : {
    "category" : "managed-object",
    "resource" : "object",
    "action" : "locate",
    "options" : {
      "max" : "10",
      "objectGroupMember" : "FRESH",
      "attributes" : {
         "state": "ACTIVE",
          "name": {
            "value": "key8"
         },
         "fresh" : "Yes",
         "activationDate": "2021-04-10 07:16:00",
          "link" : {
            "linkType" : "Replaced Object Link",
            "linkValue" : "6B13B7B3-BE61-4FF6-BFB0-4108231392F8"
           },
          "extractable" : "FALSE",
          "neverExtractable" : "TRUE"
      },
     "customAttributes" : [{
        "name": "x-test_1",
        "value": "test_1",
        "type": "TEXT"
       },
       {
        "name": "x-number",
        "value": "1",
        "type": "NUMBER"
       }]
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object object locateコマンドを実行します。 
    okv managed-object object locate --from-json locate_obj.json

    出力は、次のようになります。 

    {
     "result" : "Success",
     "value" : {
       "uuids" : [ "6C51CC04-BFA5-4FBD-BFB4-12DCCECAA355" ]
  }
 }

出力書式テキストの使用例

okv managed-object object locate --output_format text|json --output_format text --max max_value --object-group-member object_group_member_type --state state_value --name name_value --custom-attribute custom_attributes_value

出力

出力は、次のようになります。 

"6C51CC04-BFA5-4FBD-BFB4-12DCCECAA355"

関連トピック

親トピック: セキュリティ・オブジェクトのコマンド

5.21 okv managed-object object queryコマンド

okv managed-object object queryコマンドでは、サポートされている操作とオブジェクトを特定します。

必要な権限

なし

構文

okv managed-object object query

JSON入力ファイル・テンプレート

{
  "service": {
    "category": "managed-object",
    "resource": "object",
    "action": "query"
  }
}

パラメータ

なし

JSONの例

  1. okv managed-object object queryコマンド用にJSON入力を生成します。 
    okv managed-object object query --generate-json-input

    次のような入力が生成されます。 

    {
  "service": {
    "category": "managed-object",
    "resource": "object",
    "action": "query"
  }
}
  2. 生成された入力をファイル(たとえば、query_obj.json)に保存します。
  3. 生成されたJSONファイルを使用して、okv managed-object object queryコマンドを実行します。 
    okv managed-object object query --from-json query_obj.json

    出力は、次のようになります。 

    {
  "result": "Success",
  "value": {
    "objects": [
      "Symmetric Key",
      "Template",
      "Secret Data",
      "Opaque Object",
      "Certificate"
    ],
    "operations": [
      "Create",
      "Register",
      "Re-key",
      "Locate",
      "Check",
      "Get",
      "Get Attributes",
      "Get Attribute List",
      "Add Attribute",
      "Modify Attribute",
      "Delete Attribute",
      "Activate",
      "Revoke",
      "Destroy",
      "Query",
      "Discover Versions"
    ]
  }
}

親トピック: セキュリティ・オブジェクトのコマンド

5.22 okv managed-object object revokeコマンド

okv managed-object object revokeコマンドでは、セキュリティ・オブジェクトを取り消します。

必要な権限

エンドポイントには、オブジェクトに対する読取り変更権限が必要です。

構文

okv managed-object object revoke --code code --reason reason --compromise-occurrence-date date --uuid UUID

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "managed-object",
    "resource" : "object",
    "action" : "revoke",
    "options" : {
      "code" : "#UNSPECIFIED|KEY_COMPROMISE|CA_COMPROMISE|AFFILIATION_CHANGED|SUPERSEDED|CESSATION_OF_OPERATION|PRIVILEGE_WITHDRAWN",
      "reason" : "#VALUE",
      "compromiseOccurrenceDate" : "#YYYY-MM-DD HH:mm:ss",
      "uuid" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--code / code

オプション

次のいずれかの値を入力します。

  • AFFILIATION_CHANGED
  • CA_COMPROMISE
  • CESSATION_OF_OPERATION
  • PRIVILEGE_WITHDRAWN
  • SUPERSEDED
  • UNSPECIFIED
  • KEY_COMPROMISE

    デフォルト値は次のとおりです。

  • KEY_COMPROMISE

--reason / reason

必須

失効の理由の説明

--compromise-occurrence-date / compromiseOccurrenceDate

オプション

侵害の発生日この設定は、--code / codeパラメータにKEY_COMPROMISEが選択されている場合にのみ使用されます。

--uuid / uuid

必須

セキュリティ・オブジェクトのUUID (Universally Unique ID)

オブジェクトの一意識別子を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブをクリックして、左側のナビゲーション・ウィンドウで「Keys & Secrets」をクリックします。「Keys & Secrets」表で、「Unique Identifier」列を確認します。

--output_format

オプション

コマンドの出力形式を指定します。コマンドが正常に実行された場合、このコマンドは終了コード0で完了し、コマンドが失敗した場合は終了コード1で完了し、関連するエラーメッセージを生成します。

デフォルト値は次のとおりです。

  • text

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

JSONの例

  1. okv managed-object object revokeコマンド用にJSON入力を生成します。 
    okv managed-object object revoke --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "managed-object",
    "resource" : "object",
    "action" : "revoke",
    "options" : {
      "code" : "#UNSPECIFIED|KEY_COMPROMISE|CA_COMPROMISE|AFFILIATION_CHANGED|SUPERSEDED|CESSATION_OF_OPERATION|PRIVILEGE_WITHDRAWN",
      "reason" : "#VALUE",
      "compromiseOccurrenceDate" : "#YYYY-MM-DD HH:mm:ss",
      "uuid" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、revoke_obj.json)に保存して、セキュリティ・オブジェクトの権限を取消しできるように編集します。 
    {
  "service": {
    "category": "managed-object",
    "resource": "object",
    "action": "revoke",
    "options": {
      "code": "KEY_COMPROMISE",
      "reason": "security incidence",
      "compromiseOccurrenceDate": "2020-11-20 10:34:29",
      "uuid": "E4CA6A16-B3CD-4F98-BF25-4A0EF482B8B8"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object object revokeコマンドを実行します。 
    okv managed-object object revoke --from-json revoke_obj.json

    出力は、次のようになります。 

    {
 "result": "Success"
}

出力書式テキストの使用例

okv managed-object object revoke --output_format text --code code --reason reason --compromise-occurrence-date date --uuid UUID

出力

出力は、次のようになります。
  • 終了コード0 - 成功を示します
  • 終了コード1 - 失敗を示します

親トピック: セキュリティ・オブジェクトのコマンド

5.23 okv managed-object opaque getコマンド

okv managed-object opaque getコマンドでは、不透明なデータが格納されるオブジェクトを取得します。

必要な権限

エンドポイントには、オブジェクトに対する読取り権限が必要です。

構文

okv managed-object opaque get ----output_format <text|json> --uuid UUID

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "managed-object",
    "resource" : "opaque",
    "action" : "get",
    "options" : {
      "uuid" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--uuid / uuid

必須

セキュリティ・オブジェクトのUUID (Universally Unique ID)

オブジェクトの一意識別子を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブをクリックして、左側のナビゲーション・ウィンドウで「Keys & Secrets」をクリックします。「Keys & Secrets」表で、「Unique Identifier」列を確認します。

--output_format

オプション

コマンドの出力形式を指定します。コマンドが正常に実行された場合、このコマンドは終了コード0で完了し、コマンドが失敗した場合は終了コード1で完了し、関連するエラーメッセージを生成します。

デフォルト値は次のとおりです。

  • text

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

JSONの例

  1. okv managed-object opaque getコマンド用にJSON入力を生成します。 
    okv managed-object opaque get --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "managed-object",
    "resource" : "opaque",
    "action" : "get",
    "options" : {
      "uuid" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、get_opaque_object.json)に保存し、それを編集して不透明なオブジェクトからデータを取得します。 
    {
  "service" : {
    "category" : "managed-object",
    "resource" : "opaque",
    "action" : "get",
    "options" : {
      "uuid" : "2359E04F-DA61-4F7C-BF9F-913D3369A93A"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object opaque getコマンドを実行します。 
    okv managed-object opaque get --from-json get_opaque_object.json

    出力は、次のようになります。 

    {
  "result" : "Success",
  "value" : {
   "object" : "2D2D2D2D2D424547494E2050524956415445204B45592D2D2D2D2D0A4D494945765149424144414E42676B71686B6947397730424151454641415343424B637767675363
    <<<< Output Truncated>>>>
    7067533170633634656D3630686C72336B786C593858665734317A594A450A724546334C652F4A4F4B4968674A754C367352734C67553D0A2D2D2D2D2D454E442050524956415445204B45592D2D2D2D2D0A"
   }
 }

出力書式テキストの使用例

okv managed-object opaque get --output_format text --uuid 2359E04F-DA61-4F7C-BF9F-913D3369A93A

出力

出力は、次のようになります。 

2D2D2D2D2D424547494E2050524956415445204B45592D2D2D2D2D0A4D494945765149424144414E42676B71686B6947397730424151454641415343424B637767675363
<<<< Output Truncated>>>>
7067533170633634656D3630686C72336B786C593858665734317A594A450A724546334C652F4A4F4B4968674A754C367352734C67553D0A2D2D2D2D2D454E442050524956415445204B45592D2D2D2D2D0A

親トピック: セキュリティ・オブジェクトのコマンド

5.24 okv managed-object opaque registerコマンド

okv managed-object opaque registerコマンドでは、不透明なセキュリティ・オブジェクトを登録します。

不透明なデータを含むオブジェクトは、サーバーによって解釈されるとはかぎりません。

必要な権限

なし

構文

okv managed-object opaque register [--custom-attribute custom attribute] [--name name] --object object
 [--wallet wallet]

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "managed-object",
    "resource" : "opaque",
    "action" : "register",
    "options" : {
      "object" : "#VALUE",
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--object / object

必須

オブジェクトへのファイル・パス。

--wallet / wallet

オプション

ウォレット名。アクセスできる既存のウォレットの名前を調べるには、okv manage-access wallet listコマンドを実行します。

/attributes

オプション

属性名とその値。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。管理対象オブジェクトの既存の属性を調べるには、okv managed-object attribute listコマンドを実行します。

コマンドラインでは属性を指定できません。属性を使用する場合は、JSON構文を使用する必要があります。

入力できる属性は次のとおりです。

  • nameには、次の情報が含まれます。
    • valueは、名前値です。
    • typeは、textまたはuriです。デフォルト値はtextです。
  • contactInfo
  • 次の日時属性:
    • activationDate
    • deactivationDate
    • protectStopDate
    • processStartDate

日付と時間を設定するには、様々な方法を使用できます。次に各例を示します。 

"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time

UTC書式で時間を表示するには、Linuxのdateコマンドを使用します。たとえば: 

$ date --utc "+%F %T"
2021-03-15 20:31:37

これらの属性の詳細は、Key Management Interoperability Protocol仕様バージョン1.1を参照してください。

--name / name

オプション

セキュリティ・オブジェクトの名前を指定します。使用可能な値は次のとおりです。

  • value
  • KEY1
  • type
  • uri

デフォルト値は次のとおりです。

  • text
    -Support complex data format, name attribute in command line
        --name '{"value" : "KEY1", "type" : "uri"}'or
        --name '{"value" : "KEY1", "type" : "text}'
-Support simplified data format, name attribute in command line. when type is "text" as a default:
        --name KEY1

--custom-attribute / customAttribute

オプション

セキュリティ・オブジェクトのカスタム定義属性を指定します。

Support simplified data format, custom attribute(multi instance),in commandline
      --custom-attribute "x-local-name:HR" 
      --custom-attribute ' [  “x-local-name:HR”,“x-local-id:100” ]'
Support simplified data format, name
      attribute(single instance), in command line --name KEY1

セキュリティ・オブジェクトのカスタム定義属性を指定します。

2017-04-29 18:14:51"}'
        --custom-attribute '[ { "name": "x-OKV Certificate Expiration Date",
           "value" : "2017-04-29 18:14:51"}, { "name": "x-local-name", "value" : "HR"} ] '

--deactivation-date / deactivationDate

オプション

セキュリティ・オブジェクトを非アクティブ化するタイミングを指定します。

--activation-date / activationDate

オプション
セキュリティ・オブジェクトをアクティブ化するタイミングを指定します。形式は次のとおりです。
"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time
--output_format

オプション

コマンドの出力形式を指定します。コマンドが正常に実行された場合、このコマンドは終了コード0で完了し、コマンドが失敗した場合は終了コード1で完了し、関連するエラーメッセージを生成します。

デフォルト値は次のとおりです。

  • text

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextの output_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

JSONの例

  1. okv managed-object opaque registerコマンド用にJSON入力を生成します。 
    okv managed-object opaque register --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "managed-object",
    "resource" : "opaque",
    "action" : "register",
    "options" : {
      "object" : "#VALUE",
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}
  2. 生成された入力をファイル(たとえば、reg_opaque.json)に保存し、それを編集して不透明なキーを登録します。 
    {
  "service": {
    "category": "managed-object",
    "resource": "opaque",
    "action": "register",
    "options": {
      "object": "./key.pem",
      "wallet": "hr_wallet",
      "attributes": {
        "name": {
          "value": "Opaque-Key-102",
          "type": "text"
        },
        "contactInfo" : "psmith@example.com"
        "activationDate" : "2020-12-31 09:00:00",
        "deactivationDate" : "2024-12-31 09:00:00",
        "processStartDate" : "2020-12-31 09:00:00",
        "protectStopDate" : "2024-12-31 09:00:00"
      }
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object opaque registerコマンドを実行します。 
    okv managed-object opaque register --from-json reg_opaque.json

    出力は、次のようになります。 

    {
 "result" : "Success",
  "value" : {
   "uuid" : "B44A99FD-F892-4F3E-BF7D-487B68159CC3"
  }
}

出力書式テキストの使用例

okv managed-object opaque register --output_format text --object object_name --wallet wallet_name

出力

出力は、次のようになります。 

"B44A99FD-F892-4F3E-BF7D-487B68159CC3"

関連トピック

親トピック: セキュリティ・オブジェクトのコマンド

5.25 okv managed-object private-key getコマンド

okv managed-object private-key getコマンドは、秘密キーを取得します。

必要な権限

エンドポイントには、秘密キーに対する読取り権限が必要です。

構文

okv managed-object private-key get  --output_format text|json --uuid UUID

JSON入力ファイル・テンプレート 

{
  "service" : {
    "category" : "managed-object",
    "resource" : "private-key",
    "action" : "get",
    "options" : {
      "uuid" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--uuid / uuid

必須

秘密キーのUUID (Universally Unique ID)。

オブジェクトの一意識別子を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブをクリックして、左側のナビゲーション・ウィンドウで「Keys & Secrets」をクリックします。「Keys & Secrets」表で、「Unique Identifier」列を確認します。

--output_format

オプション

コマンドの出力形式を指定します。コマンドが正常に実行された場合、このコマンドは終了コード0で完了し、コマンドが失敗した場合は終了コード1で完了し、関連するエラーメッセージを生成します。

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

デフォルト値は次のとおりです。

  • text

JSONの例

  1. okv managed-object private-key getコマンド用にJSON入力を生成します。 
    okv managed-object private-key get  --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "managed-object",
    "resource" : "private-key",
    "action" : "get",
    "options" : {
      "uuid" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、get_private_key.json)に保存し、それを編集して秘密キーのUUIDを指定します。
    {
  "service" : {
    "category" : "managed-object",
    "resource" : "private-key",
    "action" : "get",
    "options" : {
      "uuid" : "2F9E2A31-D15A-4F5B-BFA0-761892021DBE"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object private-key getコマンドを実行します。 
    okv managed-object private-key get  --from-json get_private_key.json

    出力は、次のようになります。 

    {
     "result" : "Success",
     "value" : {
       "object" : "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAg << output truncated >> /onTXJKf8A1kZwPW/Qa6IpPOGCfOJDtyM9F5X9REaJQr+1\nXw1sBm1Tjh4z/m6rsKK6A4YP\n-----END PRIVATE KEY-----"
               }
}

出力書式テキストの使用例

okv managed-object private-key get --output_format text --uuid 2F9E2A31-D15A-4F5B-BFA0-761892021DBE

出力

出力は、次のようになります。 

"-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAg << output truncated >> /onTXJKf8A1kZwPW/Qa6IpPOGCfOJDtyM9F5X9REaJQr+1\nXw1sBm1Tjh4z/m6rsKK6A4YP\n-----END PRIVATE KEY-----"

親トピック: セキュリティ・オブジェクトのコマンド

5.26 okv managed-object private-key registerコマンド

okv managed-object private-key registerコマンドは、秘密キーを登録します。このコマンドを使用して、SSH秘密キーも登録できます。

必要な権限

なし

構文

okv managed-object private-key register [--activation-date activation date] [--algorithm algorithm] 
[--custom-attribute custom attribute] [--deactivation-date deactivation date] [--extractable extractable]
 --length length [--mask mask] [--name name] --object object [--ssh-user ssh-user] [--wallet wallet]

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "managed-object",
    "resource" : "private-key",
    "action" : "register",
    "options" : {
      "object" : "#VALUE",
      "algorithm" : "#RSA",
      "length" : "#1024,2048,4096(RSA)",
      "sshUser" : "#VALUE"
      "mask" : [ "#SIGN", "#ENCRYPT", "#DECRYPT", "#WRAP_KEY", "#UNWRAP_KEY", 
                 "#EXPORT", "#DERIVE_KEY", "#TRANSLATE_ENCRYPT", "#TRANSLATE_DECRYPT",
                 "#TRANSLATE_WRAP", "#TRANSLATE_UNWRAP" ],
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "extractable" : "#TRUE|FALSE"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--object / object

必須

秘密キー・オブジェクトへのファイル・パス。

--algorithm / algorithm

オプション

暗号化アルゴリズム。デフォルト値はRSAです。

--length / length

必須

アルゴリズムのキーの長さ。次の値から選択します。

  • 1024
  • 2048
  • 4096

--mask / mask

オプション

二重引用符で囲まれた暗号化使用方法マスク次の値から選択します。

  • ENCRYPT
  • DECRYPT
  • DERIVE_KEY
  • EXPORT
  • SIGN
  • TRANSLATE_DECRYPT
  • TRANSLATE_ENCRYPT
  • TRANSLATE_UNWRAP
  • TRANSLATE_WRAP
  • WRAP_KEY
  • UNWRAP_KEY

デフォルト値は次のとおりです。

  • DECRYPT
  • UNWRAP_KEY
  • WRAP_KEY
  • SIGN

--wallet / wallet

オプション

ウォレット名。アクセスできる既存のウォレットの名前を調べるには、okv manage-access wallet listコマンドを実行します。

/attributes

オプション

属性名とその値。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。管理対象オブジェクトの既存の属性を調べるには、okv managed-object attribute listコマンドを実行します。

コマンドラインでは属性を指定できません。属性を使用する場合は、JSON構文を使用する必要があります。

入力できる属性は次のとおりです。

  • nameには、次の情報が含まれます。
    • valueは、名前値です。
    • typeは、textまたはuriです。デフォルト値はtextです。
  • contactInfo
  • 次の日時属性:
    • activationDate
    • deactivationDate
    • protectStopDate
    • processStartDate

  • extractableは次のように設定できます。

    • TRUEにすると、オブジェクトをOracle Key Vaultから抽出できるようになります。

    • FALSEにすると、オブジェクト内のキー・マテリアルをOracle Key Vaultから抽出できなくなります。ただし、オブジェクトのメタデータ(オブジェクトの属性、状態など)は、引き続きOracle Key Vaultから取得できます。

    extractable属性を設定しない場合、この値はエンドポイントの構成から継承されます。コマンドラインでは、エンドポイントで有効な設定よりも厳しいextractable属性設定のみ指定できます。たとえば、エンドポイントでFALSEに設定されている場合は、extractable属性をTRUEに設定できません。ただし、コマンドラインでは、抽出可能属性の値を常にFALSEに設定できます。

日付と時間を設定するには、様々な方法を使用できます。次に各例を示します。 

"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time

UTC書式で時間を表示するには、Linuxのdateコマンドを使用します。たとえば: 

$ date --utc "+%F %T"
2021-03-15 20:31:37

これらの属性の詳細は、Key Management Interoperability Protocol仕様バージョン1.1を参照してください。

--name / name

オプション

セキュリティ・オブジェクトの名前を指定します。使用可能な値は次のとおりです。

  • value
  • type

デフォルト値は次のとおりです。

  • text
    -Support complex data format, name attribute in command line
        --name '{"value" : "KEY1", "type" : "uri"}'or
        --name '{"value" : "KEY1", "type" : "text}'
-Support simplified data format, name attribute in command line. when type is "text" as a default:
        --name KEY1

--custom-attribute / customAttribute

オプション

セキュリティ・オブジェクトのカスタム定義属性を指定します。

2017-04-29 18:14:51"}'
        --custom-attribute '[ { "name": "x-OKV Certificate Expiration Date",
           "value" : "2017-04-29 18:14:51"}, { "name": "x-local-name", "value" : "HR"} ] '
Support simplified data format, name
      attribute(single instance), in command line --name KEY1
Support simplified data format, custom attribute(multi instance),in commandline
      --custom-attribute "x-local-name:HR" 
      --custom-attribute ' [  “x-local-name:HR”,“x-local-id:100” ]'

--deactivation-date / deactivationDate

オプション

セキュリティ・オブジェクトを非アクティブ化するタイミングを指定します。activation-dateと同じ形式です。

--activation-date / activationDate

オプション
セキュリティ・オブジェクトをアクティブ化するタイミングを指定します。形式は次のとおりです。
"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time
--output_format

オプション

コマンドの出力形式を指定します。コマンドが正常に実行された場合、このコマンドは終了コード0で完了し、コマンドが失敗した場合は終了コード1で完了し、関連するエラーメッセージを生成します。

デフォルト値は次のとおりです。

  • text

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

JSONを使用しない例

         okv managed-object private-key register --algorithm RSA --length 2048
         --mask"ENCRYPT" --object /Users/dopark/test/id_rsa 
         --name private_0701--activation-date now --deactivation-date "2030-10-10 10:10:10"

JSONの例

  1. okv managed-object private-key registerコマンド用にJSON入力を生成します。 
    okv managed-object private-key register --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "managed-object",
    "resource" : "private-key",
    "action" : "register",
    "options" : {
      "object" : "#VALUE",
      "algorithm" : "#RSA",
      "length" : "#1024,2048,4096(RSA)",
      
      "mask" : [ "#SIGN", "#ENCRYPT", "#DECRYPT", "#WRAP_KEY", "#UNWRAP_KEY",
                 "#EXPORT", "#DERIVE_KEY", "#TRANSLATE_ENCRYPT", "#TRANSLATE_DECRYPT", 
                 "#TRANSLATE_WRAP", "#TRANSLATE_UNWRAP" ],
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "extractable" : "#TRUE|FALSE"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}
      }
    }
  }
}
  2. 生成された入力をファイル(たとえば、reg_private_key.json)に保存し、それを編集して適切な秘密キー設定を指定します。
    {
  "service" : {
    "category" : "managed-object",
    "resource" : "private-key",
    "action" : "register",
    "options" : {
      "object" : "./priv_key.pem",
      "algorithm" : "RSA",
      "length" : "2048",
      "mask" : [ "ENCRYPT", "DECRYPT" ],
      "wallet" : "hr_wallet",
      "attributes" : {
        "name" : {
          "value" : "CERT-APPID-103",
          "type" : "text"
        },
        "contactInfo" : "psmith@example.com"
        "activationDate" : "2020-12-31 09:00:00",
        "deactivationDate" : "2024-12-31 09:00:00",
        "processStartDate" : "2020-12-31 09:00:00",
        "protectStopDate" : "2024-12-31 09:00:00"
      }
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object private-key registerコマンドを実行します。 
    okv managed-object private-key register --from-json reg_private_key.json

    出力は、次のようになります。 

    {
  "result" : "Success",
   "value" : {
    "uuid" : "2F9E2A31-D15A-4F5B-BFA0-761892021DBE"
  }
}

出力書式テキストの使用例

okv managed-object private-key register --output_format text --object private_key_file_path --algorithm cryptographic_algorithm --length key_length --mask cryptographic_usage_mask --wallet wallet_name

出力

出力は、次のようになります。 

"2F9E2A31-D15A-4F5B-BFA0-761892021DBE"

関連トピック

親トピック: セキュリティ・オブジェクトのコマンド

5.27 okv managed-object public-key getコマンド

okv managed-object public-key getコマンドは、公開キーを取得します。

必要な権限

エンドポイントには、公開キーに対する読取り権限が必要です。

構文

okv managed-object public-key get  --output_format text|json --uuid UUID

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "managed-object",
    "resource" : "public-key",
    "action" : "get",
    "options" : {
      "uuid" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--uuid / uuid

必須

公開キーのUUID (Universally Unique ID)。

オブジェクトの一意識別子を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブをクリックして、左側のナビゲーション・ウィンドウで「Keys & Secrets」をクリックします。「Keys & Secrets」表で、「Unique Identifier」列を確認します。

--output_format

オプション

コマンドの出力形式を指定します。コマンドが正常に実行された場合、このコマンドは終了コード0で完了し、コマンドが失敗した場合は終了コード1で完了し、関連するエラーメッセージを生成します。

デフォルト値は次のとおりです。

  • text

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

JSONの例

  1. okv managed-object public-key getコマンド用にJSON入力を生成します。 
    okv managed-object public-key get --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "managed-object",
    "resource" : "public-key",
    "action" : "get",
    "options" : {
      "uuid" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、get_public_key.json)に保存し、それを編集して公開キーのUUIDを指定します。
    {
  "service" : {
    "category" : "managed-object",
    "resource" : "public-key",
    "action" : "get",
    "options" : {
      "uuid" : "11652909-D019-4F3B-BFB9-791723095005"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object public-key getコマンドを実行します。 
    okv managed-object public-key get  --from-json get_public_key.json

    出力は、次のようになります。 

    {
  "result" : "Success",
  "value" : {
    "object" : "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtK4YrT6A/4tVnadRg0ZT\nprsdUwXrIdoqf1+ye/yVkN6RmtR7mthn6WIIrbTVX5MuAkLc6yyuMEc+nLDPZzrU\nFXkCAQeVR7sT/hQo74dQHebIfJxgx+uZrlzOgT4Il1qfmjR6y81RjTvAU8ZPdzPb\nuXKHZErZVQdoXUw5uFrTNzOegLbYJFI2dZnf3erB7Ho64DckFRoFP05cc3A0iLrL\ntzE8CcjAlBlXTGJD4kAtTEet/0TkvuHzBHr23zkfj0kWV3PHGYYC3O+/UzXg/nal\n3iTK5yRDkln45AyI/PkfzAFiZ/kX9C66H0WRMxgfaOn/uRNbikFOFK6IPOGcT+0S\n/QIDAQAB\n-----END PUBLIC KEY-----"
   }
 }

出力書式テキストの使用例

okv managed-object public-key get --output_format text --uuid 11652909-D019-4F3B-BFB9-791723095005

出力

出力は、次のようになります。 

"-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtK4YrT6A/4tVnadRg0ZT\nprsdUwXrIdoqf1+ye/yVkN6RmtR7mthn6WIIrbTVX5MuAkLc6yyuMEc+nLDPZzrU\nFXkCAQeVR7sT/hQo74dQHebIfJxgx+uZrlzOgT4Il1qfmjR6y81RjTvAU8ZPdzPb\nuXKHZErZVQdoXUw5uFrTNzOegLbYJFI2dZnf3erB7Ho64DckFRoFP05cc3A0iLrL\ntzE8CcjAlBlXTGJD4kAtTEet/0TkvuHzBHr23zkfj0kWV3PHGYYC3O+/UzXg/nal\n3iTK5yRDkln45AyI/PkfzAFiZ/kX9C66H0WRMxgfaOn/uRNbikFOFK6IPOGcT+0S\n/QIDAQAB\n-----END PUBLIC KEY-----"

親トピック: セキュリティ・オブジェクトのコマンド

5.28 okv managed-object public-key registerコマンド

okv managed-object public-key registerコマンドは、公開キーを登録します。このコマンドを使用して、SSH公開キーも登録できます。

必要な権限

なし

構文

okv managed-object public-key register [--activation-date activation date] [--algorithm algorithm] [--custom-attribute custom attribute]
       [--deactivation-date deactivation date] --length length [--mask mask] [--name name] --object object [--private-key-uuid
       private-key-uuid] [--ssh-user ssh-user] [--wallet wallet]

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "managed-object",
    "resource" : "public-key",
    "action" : "register",
    "options" : {
      "object" : "#VALUE",
      "algorithm" : "#RSA",
      "length" : "#1024,2048,3072,4096(RSA)",
      "sshUser" : "#VALUE",
      "mask" : [ "#VERIFY", "#ENCRYPT", "#DECRYPT", "#UNWRAP_KEY",
                 "#EXPORT", "#DERIVE_KEY", "#TRANSLATE_ENCRYPT", 
                 "#TRANSLATE_DECRYPT", "#TRANSLATE_UNWRAP" ],
      "privateKeyUUID" : "#VALUE",
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--object / object

必須

公開キー・オブジェクトへのファイル・パス。

--algorithm / algorithm

オプション
暗号化アルゴリズム。デフォルト値は次のとおりです。
  • RSA

--length / length

必須

アルゴリズムのキーの長さ。次の値から選択します。

  • 1024
  • 2048
  • 4096

--mask / mask

オプション

二重引用符で囲まれた暗号化使用方法マスク次の値から選択します。

  • ENCRYPT
  • DECRYPT
  • DERIVE_KEY
  • EXPORT
  • TRANSLATE_DECRYPT
  • TRANSLATE_ENCRYPT
  • TRANSLATE_UNWRAP
  • UNWRAP_KEY
  • VERIFY

デフォルト値は次のとおりです。

  • UNWRAP_KEY
  • ENCRYPT
  • VERIFY

----private-key-uuid / privateKeyUUID

オプション

登録中の公開キーに関連付けられている秘密キーのUUID (Universally Unique ID)。

キーの一意識別子を調べるには、okv manage-access wallet list-objectsコマンドまたはokv admin endpoint list-objectsコマンドを実行します。

--wallet / wallet

オプション

ウォレット名。アクセスできる既存のウォレットの名前を調べるには、okv manage-access wallet listコマンドを実行します。

/attributes

オプション

属性名とその値。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。管理対象オブジェクトの既存の属性を調べるには、okv managed-object attribute listコマンドを実行します。

コマンドラインでは属性を指定できません。属性を使用する場合は、JSON構文を使用する必要があります。

入力できる属性は次のとおりです。

  • nameには、次の情報が含まれます。
    • valueは、名前値です。
    • typeは、textまたはuriです。
  • contactInfo
  • 次の日時属性:
    • activationDate
    • deactivationDate
    • protectStopDate
    • processStartDate

日付と時間を設定するには、様々な方法を使用できます。次に各例を示します。 

"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time

UTC書式で時間を表示するには、Linuxのdateコマンドを使用します。たとえば: 

$ date --utc "+%F %T"
2021-03-15 20:31:37

これらの属性の詳細は、Key Management Interoperability Protocol仕様バージョン1.1を参照してください。

--name / name

オプション

セキュリティ・オブジェクトの名前を指定します。使用可能な値は次のとおりです。

  • value
  • type

デフォルト値は次のとおりです。

  • text
    -Support complex data format, name attribute in command line
        --name '{"value" : "KEY1", "type" : "uri"}'or
        --name '{"value" : "KEY1", "type" : "text}'
-Support simplified data format, name attribute in command line. when type is "text" as a default:
        --name KEY1

--custom-attribute / customAttribute

オプション

セキュリティ・オブジェクトのカスタム定義属性を指定します。

2017-04-29 18:14:51"}'
        --custom-attribute '[ { "name": "x-OKV Certificate Expiration Date",
           "value" : "2017-04-29 18:14:51"}, { "name": "x-local-name", "value" : "HR"} ] '
Support simplified data format, name
      attribute(single instance), in command line --name KEY1
Support simplified data format, custom attribute(multi instance),in commandline
      --custom-attribute "x-local-name:HR" 
      --custom-attribute ' [  “x-local-name:HR”,“x-local-id:100” ]'

--deactivation-date / deactivationDate

オプション

セキュリティ・オブジェクトを非アクティブ化するタイミングを指定します。activation-dateと同じ形式です。

--activation-date / activationDate

オプション
セキュリティ・オブジェクトをアクティブ化するタイミングを指定します。形式は次のとおりです。
"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time
--output_format

オプション

コマンドの出力形式を指定します。コマンドが正常に実行された場合、このコマンドは終了コード0で完了し、コマンドが失敗した場合は終了コード1で完了し、関連するエラーメッセージを生成します。

デフォルト値は次のとおりです。

  • text
--ssh-user /sshUser

オプション

SSHユーザー名。SSHユーザーは、SSHキー、人間、アプリケーションまたはマシンといった実際のコンシューマを追跡することを目的としています。

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

JSONの例

  1. okv managed-object public-key registerコマンド用にJSON入力を生成します。 
    okv managed-object public-key register --generate-json-input

    次のような入力が生成されます。 

     {
  "service" : {
    "category" : "managed-object",
    "resource" : "public-key",
    "action" : "register",
    "options" : {
      "object" : "#VALUE",
      "algorithm" : "#RSA",
      "length" : "#1024,2048,3072,4096(RSA)",
      "sshUser" : "#VALUE",
      
      "mask" : [ "#VERIFY", "#ENCRYPT", "#DECRYPT", "#UNWRAP_KEY",
                 "#EXPORT", "#DERIVE_KEY", "#TRANSLATE_ENCRYPT", 
                 "#TRANSLATE_DECRYPT", "#TRANSLATE_UNWRAP" ],
      "privateKeyUUID" : "#VALUE",
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}
  2. 生成された入力をファイル(たとえば、reg_public_key.json)に保存し、それを編集して適切な公開キー設定を指定します。
    {
  "service" : {
    "category" : "managed-object",
    "resource" : "public-key",
    "action" : "register",
    "options" : {
      "object" : "./key.pub",
      "algorithm" : "RSA",
      "length" : "2048",
      "mask" : [ "ENCRYPT", "DECRYPT" ],
      "privateKeyUUID" : "2F9E2A31-D15A-4F5B-BFA0-761892021DBE ",
      "wallet" : "hr_wallet",
      "attributes" : {
        "name" : {
          "value" : " FINDB-PROD-PUBKEY ",
          "type" : "text"
        },
        "contactInfo" : "psmith@example.com"
        "activationDate" : "2020-12-31 09:00:00",
        "deactivationDate" : "2024-12-31 09:00:00",
        "processStartDate" : "2020-12-31 09:00:00",
        "protectStopDate" : "2024-12-31 09:00:00"
      }
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object public-key registerコマンドを実行します。 
    okv managed-object public-key register --from-json reg_public_key.json

    出力は、次のようになります。 

    {
  "result" : "Success",
   "value" : {
    "uuid" : "11652909-D019-4F3B-BFB9-791723095005"
   }
 }

JSONを使用しない例

okv managed-object public-key register   --object
id_rsa.pub  --algorithm RSA ---length 2048 -mask "ENCRYPT"
--private-key-uuid  95092BD2-B546-4F9A-BF0B-D8ECDC548546 --name hr_public_key
--activation-date now --deactivation-date "2030-10-10 10:10:10

出力書式テキストの使用例

okv managed-object public-key register --output_format text --object public_key_file_path --algorithm cryptographic_algorithm --length key_length --mask cryptographic_usage_mask --private-key-uuid private_key_uuid --wallet wallet_nameokv managed-object public-key get --output_format text --uuid UUID

出力

出力は、次のようになります。 

"11652909-D019-4F3B-BFB9-791723095005 "

関連トピック

親トピック: セキュリティ・オブジェクトのコマンド

5.29 okv managed-object secret getコマンド

okv managed-object secret getコマンドでは、secretタイプのセキュリティ・オブジェクトからシークレット・データを取得します。

必要な権限

エンドポイントには、シークレット・オブジェクトに対する読取り権限が必要です。

構文

okv managed-object secret get --output_format text|json --uuid UUID

JSON入力ファイル・テンプレート

{
  "service": {
    "category": "managed-object",
    "resource": "secret",
    "action": "get",
    "options": {
      "uuid": "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--uuid / uuid

必須

セキュリティ・オブジェクトのUUID (Universally Unique ID)

オブジェクトの一意識別子を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブをクリックして、左側のナビゲーション・ウィンドウで「Keys & Secrets」をクリックします。「Keys & Secrets」表で、「Unique Identifier」列を確認します。

--output_format

オプション

コマンドの出力形式を指定します。コマンドが正常に実行された場合、このコマンドは終了コード0で完了し、コマンドが失敗した場合は終了コード1で完了し、関連するエラーメッセージを生成します。

デフォルト値は次のとおりです。

  • text

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

JSONの例

  1. okv managed-object secret getコマンド用にJSON入力を生成します。 
    okv managed-object secret get --generate-json-input

    次のような入力が生成されます。 

    {
  "service": {
    "category": "managed-object",
    "resource": "secret",
    "action": "get",
    "options": {
      "uuid": "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、secret_get.json)に保存し、それを編集してシークレット・オブジェクトを検索します。 
    {
  "service": {
    "category": "managed-object",
    "resource": "secret",
    "action": "get",
    "options": {
      "uuid": "D69D2F32-2DBB-4FF3-BF52-95487526E6EC"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object secret getコマンドを実行します。 
    okv managed-object secret get --from-json secret_get.json

    出力は、次のようになります。 

    {
     "result": "Success",
     "value": {
       "object": "ki3j&8slo73y2ls"
      }
   }

出力書式テキストの使用例

okv managed-object secret get --output_format text --uuid D69D2F32-2DBB-4FF3-BF52-95487526E6EC

出力

出力は、次のようになります。 

"ki3j&8slo73y2ls"

親トピック: セキュリティ・オブジェクトのコマンド

5.30 okv managed-object secret registerコマンド

okv managed-object secret registerコマンドでは、パスワードやランダム・シードなどのシークレット・データを登録します。

必要な権限

なし

構文

okv managed-object secret register [--activation-date activation date] [--custom-attribute custom attribute] 
[--deactivation-date deactivation date] [--mask mask] [--name name] --object object [--type type] [--wallet wallet]

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "managed-object",
    "resource" : "secret",
    "action" : "register",
    "options" : {
      "object" : "#VALUE",
      "type" : "#PASSWORD|SEED",
      
      "mask" : [ "#DERIVE_KEY", "#EXPORT" ],
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}

パラメータ

パラメータ/テンプレート 必須かどうか 説明

--object / object

必須

シークレット・データを格納しているオブジェクト・ファイルのパス。

--type / type

オプション

次のいずれかの値を入力します。

  • SEED
  • PASSWORD

    デフォルト値は次のとおりです。

  • PASSWORD

--wallet / wallet

オプション

ウォレット名。アクセスできる既存のウォレットの名前を調べるには、okv manage-access wallet listコマンドを実行します。

--mask / mask

オプション

二重引用符で囲まれた暗号化使用方法マスク

次の値から選択します。

  • EXPORT
  • DERIVE_KEY
デフォルト値は次のとおりです。
  • DERIVE_KEY

/attributes

オプション

属性名とその値。値に空白、スラッシュまたはコロンが含まれている場合は、この値を二重引用符で囲みます。管理対象オブジェクトの既存の属性を調べるには、okv managed-object attribute listコマンドを実行します。

コマンドラインでは属性を指定できません。属性を使用する場合は、JSON構文を使用する必要があります。

入力できる属性は次のとおりです。

  • nameには、次の情報が含まれます。
    • valueは、名前値です。
    • typeは、textまたはuriです。デフォルト値はtextです。
  • contactInfo
  • 次の日時属性:
    • activationDate
    • deactivationDate
    • protectStopDate
    • processStartDate

日付と時間を設定するには、様々な方法を使用できます。次に各例を示します。 

"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time

UTC書式で時間を表示するには、Linuxのdateコマンドを使用します。たとえば: 

$ date --utc "+%F %T"
2021-03-15 20:31:37

これらの属性の詳細は、Key Management Interoperability Protocol仕様バージョン1.1を参照してください。

--name/ name

オプション

セキュリティ・オブジェクトの名前を指定します。使用可能な値は次のとおりです。

  • value
  • type

デフォルト値は次のとおりです。

  • text
    -Support complex data format, name attribute in command line
        --name '{"value" : "KEY1", "type" : "uri"}'or
        --name '{"value" : "KEY1", "type" : "text}'
-Support simplified data format, name attribute in command line. when type is "text" as a default:
        --name KEY1

--custom-attribute / customAttribute

オプション

セキュリティ・オブジェクトのカスタム定義属性を指定します。

2017-04-29 18:14:51"}'
        --custom-attribute '[ { "name": "x-OKV Certificate Expiration Date",
           "value" : "2017-04-29 18:14:51"}, { "name": "x-local-name", "value" : "HR"} ] '
Support simplified data format, name
      attribute(single instance), in command line --name KEY1
Support simplified data format, custom attribute(multi instance),in commandline
      --custom-attribute "x-local-name:HR" 
      --custom-attribute ' [  “x-local-name:HR”,“x-local-id:100” ]'

--deactivation-date/ deactivationDate

オプション

セキュリティ・オブジェクトを非アクティブ化するタイミングを指定します。activation-dateと同じ形式です。

--activation-date / activationDate

オプション
セキュリティ・オブジェクトをアクティブ化するタイミングを指定します。形式は次のようになります。 
"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M"  --starts 10 minutes after this date and time
--output_format

オプション

コマンドの出力形式を指定します。コマンドが正常に実行された場合、このコマンドは終了コード0で完了し、コマンドが失敗した場合は終了コード1で完了し、関連するエラーメッセージを生成します。

デフォルト値は次のとおりです。

  • text

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

JSONを使用しない例

okv managed-object secret register --type PASSWORD --mask "DERIVE_KEY"
--name secret_0701 --object /Users/dopark/test/my.secret --activation-date now
--deactivation-date "2030-10-10 10:10:10

JSONの例

  1. okv managed-object secret registerコマンド用にJSON入力を生成します。 
    okv managed-object secret register --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "managed-object",
    "resource" : "secret",
    "action" : "register",
    "options" : {
      "object" : "#VALUE",
      "type" : "#PASSWORD|SEED",
      "mask" : [ "#DERIVE_KEY", "#EXPORT" ],
     
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}
  2. 生成された入力をファイル(たとえば、reg_secret.json)に保存し、それを編集してシークレット・オブジェクトを登録します。 
    {
  "service" : {
    "category" : "managed-object",
    "resource" : "secret",
    "action" : "register",
    "options" : {
      "object" : "./hr_db_connect_password.txt",
      "type" : "PASSWORD",
      "mask" : [ "DERIVE_KEY" ],
      "wallet" : "hr_wallet",
      "attributes" : {
        "name" : {
          "value" : "HR-DB-CONNECT-PASSWORD",
          "type" : "text"
        },
        "contactInfo" : "psmith@example.com"
        "activationDate" : "2020-12-31 09:00:00",
        "deactivationDate" : "2024-12-31 09:00:00",
        "processStartDate" : "2020-12-31 09:00:00",
        "protectStopDate" : "2024-12-31 09:00:00"
      }
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object secret registerコマンドを実行します。 
    okv managed-object secret register --from-json reg_secret.json

    出力は、次のようになります。 

    {
     "result": "Success",
     "value": {
      "uuid": "0F54D31A-ABA0-4F15-BF67-1B7513DD8634"
      }
}

出力書式テキストの使用例

okv managed-object secret register --output_format text --object object_name type PASSWORD|SEED 
wallet wallet_name --mask cryptogrpahic_usage_mask

出力

出力は、次のようになります。 

"0F54D31A-ABA0-4F15-BF67-1B7513DD8634"

関連トピック

親トピック: セキュリティ・オブジェクトのコマンド

5.31 okv managed-object wallet add-memberコマンド

okv managed-object wallet add-memberコマンドでは、セキュリティ・オブジェクトをメンバーとしてウォレットに追加します。

このコマンドは、エンドポイントのクライアント証明書を使用して認証します。

必要な権限

エンドポイントには、オブジェクトに対する読取り変更権限と、ウォレットに対するウォレット管理アクセス権(MW)が必要です。

構文

okv managed-object wallet add-member -output_format text|json --uuid UUID --wallet wallet_name

JSON入力ファイル・テンプレート

{
  "service": {
    "category": "managed-object",
    "resource": "wallet",
    "action": "add-member",
    "options": {
      "uuid": "#VALUE",
      "wallet": "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--uuid / uuid

必須

ウォレットに追加する管理対象オブジェクトのUUID (Universally unique ID)。

オブジェクトの一意識別子を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブをクリックして、左側のナビゲーション・ウィンドウで「Keys & Secrets」をクリックします。「Keys & Secrets」表で、「Unique Identifier」列を確認します。

--wallet / wallet

必須

ウォレット名。アクセスできる既存のウォレットの名前を調べるには、okv manage-access wallet listコマンドを実行します。

--output_format

オプション

コマンドの出力形式を指定します。コマンドが正常に実行された場合、このコマンドは終了コード0で完了し、コマンドが失敗した場合は終了コード1で完了し、関連するエラーメッセージを生成します。

デフォルト値は次のとおりです。

  • text

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

JSONの例

  1. okv managed-object wallet add-memberコマンド用にJSON入力を生成します。 
    okv managed-object wallet add-member --generate-json-input

    次のような入力が生成されます。 

    {
  "service": {
    "category": "managed-object",
    "resource": "wallet",
    "action": "add-member",
    "options": {
      "uuid": "#VALUE",
      "wallet": "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、add_wallet_member.json)に保存し、それを編集してセキュリティ・オブジェクトをウォレットに追加します。
    {
  "service": {
    "category": "managed-object",
    "resource": "wallet",
    "action": "add-member",
    "options": {
      "uuid": "D69D2F32-2DBB-4FF3-BF52-95487526E6EC",
      "wallet": "hr_wallet"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object wallet add-memberコマンドを実行します。 
    okv managed-object wallet add-member --from-json add_wallet_member.json

    出力は、次のようになります。 

    {
 "result": "Success"
}

出力書式テキストの使用例

okv managed-object wallet add-member --output_format text --uuid UUID --wallet wallet_name

出力

出力は、次のようになります。
  • 終了コード0 - 成功を示します
  • 終了コード1 - 失敗を示します

親トピック: セキュリティ・オブジェクトのコマンド

5.32 okv managed-object wallet delete-memberコマンド

okv managed-object wallet delete-memberコマンドでは、管理対象オブジェクトのメンバーシップをウォレットから削除します。

このコマンドは、エンドポイントのクライアント証明書を使用して認証します。

必要な権限

エンドポイントには、オブジェクトに対する読取り変更権限と、ウォレットに対するウォレット管理アクセス権(MW)が必要です。

構文

okv managed-object wallet delete-member -output_format text|json--uuid UUID --wallet wallet_name

JSON入力ファイル・テンプレート

{
  "service": {
    "category": "managed-object",
    "resource": "wallet",
    "action": "delete-member",
    "options": {
      "uuid": "#VALUE",
      "wallet": "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--uuid / uuid

必須

ウォレット内の管理対象オブジェクトのUUID (Universally Unique ID)

オブジェクトの一意識別子を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブをクリックして、左側のナビゲーション・ウィンドウで「Keys & Secrets」をクリックします。「Keys & Secrets」表で、「Unique Identifier」列を確認します。

--wallet / wallet

必須

ウォレット名。アクセスできる既存のウォレットの名前を調べるには、okv manage-access wallet listコマンドを実行します。

--output_format

オプション

コマンドの出力形式を指定します。コマンドが正常に実行された場合、このコマンドは終了コード0で完了し、コマンドが失敗した場合は終了コード1で完了し、関連するエラーメッセージを生成します。

デフォルト値は次のとおりです。

  • text

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

JSONの例

  1. okv managed-object wallet delete-memberコマンド用にJSON入力を生成します。 
    okv managed-object wallet delete-member --generate-json-input

    次のような入力が生成されます。 

    {
  "service": {
    "category": "managed-object",
    "resource": "wallet",
    "action": "delete-member",
    "options": {
      "uuid": "#VALUE",
      "wallet": "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、delete_wallet_member.json)に保存し、それを編集してセキュリティ・オブジェクトをウォレットから削除します。
    {
  "service": {
    "category": "managed-object",
    "resource": "wallet",
    "action": "delete-member",
    "options": {
      "uuid": "D69D2F32-2DBB-4FF3-BF52-95487526E6EC",
      "wallet": "hr_wallet"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object wallet delete-memberコマンドを実行します。 
    okv managed-object wallet delete-member --from-json delete_wallet_member.json

    出力は、次のようになります。 

    {
 "result": "Success"
}

出力書式テキストの使用例

okv managed-object wallet delete-member --output_format text --uuid UUID --wallet wallet_name

出力

出力は、次のようになります。
  • 終了コード0 - 成功を示します
  • 終了コード1 - 失敗を示します

親トピック: セキュリティ・オブジェクトのコマンド

5.33 okv managed-object wallet listコマンド

okv managed-object wallet listコマンドでは、Oracle Key Vaultへの接続に使用されるエンドポイントへのアクセス権が付与されているウォレットをリストします。

このコマンドは、エンドポイントのクライアント証明書を使用して認証します。

必要な権限

なし。ただし、このコマンドでは、現在のエンドポイントに対してアクセス権が付与されているウォレットのみが返されます。

構文

okv managed-object wallet list

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "managed-object",
    "resource" : "wallet",
    "action" : "list"
     }
}

パラメータ

なし
パラメータ/テンプレート・パラメータ 必須かどうか 説明
--output_format

オプション

コマンドの出力形式を指定します。コマンドが正常に実行された場合、このコマンドは終了コード0で完了し、コマンドが失敗した場合は終了コード1で完了し、関連するエラーメッセージを生成します。

デフォルト値はtextです。

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

JSONの例

  1. okv managed-object wallet listコマンド用にJSON入力を生成します。 
    okv managed-object wallet list --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "managed-object",
    "resource" : "wallet",
    "action" : "list"
     }
}
  2. 生成された入力をファイル(たとえば、wallet_list.json)に保存します。
  3. 生成されたJSONファイルを使用して、okv managed-object wallet listコマンドを実行します。 
    okv managed-object wallet list --from-json wallet_list.json

    出力は、次のようになります。 

    {
  "result": "Success",
  "value": {
    "wallets": {
      "HR_WALLET",
      "SALES_WALLET"
      }
   }
 )

出力書式テキストの使用例

okv managed-object wallet list -output_format text

出力

出力は、次のようになります。 

"HR_WALLET","SALES_WALLET

親トピック: セキュリティ・オブジェクトのコマンド

5.34 okv managed-object key-pair createコマンド

okv managed-object key-pair createコマンドは、公開キーと秘密キーのペアを作成します。このコマンドを使用して、SSHキー・ペアも作成できます。

必要な権限

エンドポイントである必要があります

構文

okv managed-object key-pair create
        --activation-date activation date] [--algorithm algorithm] [--deactivation-date deactivation date]
       [--length length] [--private-key-custom-attribute private key custom attribute] [--private-key-extractable private-key-extractable]
       [--private-key-mask private key mask] [--private-key-name private-key-name] [--public-key-custom-attribute public key custom attribute]
       [--public-key-mask public key mask] [--public-key-name public-key-name] [--ssh-user ssh-user] [--wallet wallet]

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "managed-object",
    "resource" : "key-pair",
    "action" : "create",
    "options" : {
      "algorithm" : "#RSA",
      "length" : "#2048,3072,4096(RSA)",
      "sshUser" : "#VALUE",
      "wallet" : "#VALUE",
      "attributes" : {
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
      },
      "privateKey" : {
                "mask" : [ "#SIGN", "#ENCRYPT", "#DECRYPT", "#WRAP_KEY", "#UNWRAP_KEY",
                   "#EXPORT", "#DERIVE_KEY", "#TRANSLATE_ENCRYPT", "#TRANSLATE_DECRYPT", 
                   "#TRANSLATE_WRAP", "#TRANSLATE_UNWRAP" ],
        "attributes" : {
          "name" : {
            "value" : "#VALUE",
            "type" : "#text|uri"
          },
          "extractable" : "#TRUE|FALSE"
        },
        "customAttributes" : [ {
          "name" : "#VALUE",
          "value" : "#VALUE",
          "type" : "#TEXT|NUMBER"
        } ]
      },
      "publicKey" : {
               "mask" : [ "#VERIFY", "#ENCRYPT", "#DECRYPT", "#UNWRAP_KEY",
                  "#EXPORT", "#DERIVE_KEY", "#TRANSLATE_ENCRYPT", 
                  "#TRANSLATE_DECRYPT", "#TRANSLATE_UNWRAP" ],
        "attributes" : {
          "name" : {
            "value" : "#VALUE",
            "type" : "#text|uri"
          }
        },
        "customAttributes" : [ {
          "name" : "#VALUE",
          "value" : "#VALUE",
          "type" : "#TEXT|NUMBER"
        } ]
      }
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--algorithm / algorithm

オプション

暗号化アルゴリズム。次の値から選択します。

  • RSA

    デフォルト値は次のとおりです。

  • RSA

--length / length

オプション

アルゴリズムのキーの長さ。次の値から選択します。

  • RSAの場合: 2048、3072、4096

    デフォルト値は次のとおりです。

  • 2048

--private-key-mask / privateKeyMask

オプション

二重引用符で囲まれた暗号化使用方法マスク次の値から選択します。

  • ENCRYPT
  • DECRYPT
  • DERIVE_KEY
  • EXPORT
  • SIGN
  • TRANSLATE_DECRYPT
  • TRANSLATE_ENCRYPT
  • TRANSLATE_UNWRAP
  • TRANSLATE_WRAP
  • UNWRAP_KEY
  • WRAP_KEY

デフォルト値は次のとおりです。

  • WRAP_KEY
  • DECRYPT
  • UNWRAP_KEY
  • SIGN

--public-key-mask / publicKeyMask

 オプション

二重引用符で囲まれた暗号化使用方法マスク次の値から選択します。

  • ENCRYPT
  • DERIVE_KEY
  • EXPORT
  • TRANSLATE_DECRYPT
  • TRANSLATE_ENCRYPT
  • TRANSLATE_UNWRAP
  • UNWRAP_KEY
  • DECRYPT
  • VERIFY

デフォルト値は次のとおりです。

  • ENCRYPT
  • UNWRAP_KEY
  • VERIFY

--wallet / wallet

オプション

ウォレット名。アクセスできる既存のウォレットの名前を調べるには、okv manage-access wallet listコマンドを実行します。

--deactivation-date/ deactivationDate

オプション

セキュリティ・オブジェクトを非アクティブ化するタイミングを指定します。これはactivation-dateと同じ形式です。

--activation-date/activationDate

 オプション

セキュリティ・オブジェクトをアクティブ化するタイミングを指定します。形式は次のとおりです。

"activationDate" : "now" --starts immediately
"activationDate" : "now+PT10M" --starts 10 minutes from now
"activationDate" : "2021-12-20 10:30:00" --starts at this date and time
"activationDate" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time

--private-key-name/ privateKeyName

オプション

セキュリティ・オブジェクトの名前を指定します。使用可能な値は次のとおりです。

  • value
  • type

デフォルト値は次のとおりです。

  • text
    -Support complex data format, name attribute in command line
        --name '{"value" : "PRIVATE_KEY1", "type" : "uri"}'or
        --name '{"value" : " PRIVATE_KEY1", "type" : "text}'
-Support simplified data format, name attribute in command line, when type is "text" as a default:
--name PRIVATE_KEY1

--private-key-custom-attribute/ privateKeyCustomAttributes

オプション

セキュリティ・オブジェクトのカスタム定義属性を指定します。

 --custom-attribute '[ { "name": "x-OKV Certificate Expiration Date",
           "value" : "2017-04-29 18:14:51"}, { "name": "x-local-name", "value" : "HR"} ] '
Support simplified data format, name
      attribute(single instance), in command line --name KEY1
Support simplified data format, custom attribute(multi instance),in command line
      --custom-attribute "x-local-name:HR"
      --custom-attribute ' [  “x-local-name:HR”,“x-local-id:100” ]'

--public-key-name/ publicKeyName

オプション
セキュリティ・オブジェクトの名前を指定します。使用可能な値は次のとおりです。
  • value
  • type

typeのデフォルト値は次のとおりです:

  • text
    -Support complex data format, name attribute in command line
        --name '{"value" : "PUBLIC_KEY1", "type" : "uri"}'or
        --name '{"value" : " PUBLIC_KEY1", "type" : "text}'
-Support simplified data format, name attribute in command line, when type is "text" as a default:
--name PUBLIC_KEY1

--public-key-custom-attribute/ publicKey → customAttributes

オプション
セキュリティ・オブジェクトをアクティブ化するタイミングを指定します。形式は次のとおりです。
Specifies custom defined attribute on security object.
2017-04-29 18:14:51"}'
        --custom-attribute '[ { "name": "x-OKV Certificate Expiration Date",
           "value" : "2017-04-29 18:14:51"}, { "name": "x-local-name", "value" : "HR"} ] '
Support simplified data format, name
      attribute(single instance), in command line --name KEY1
Support simplified data format, custom attribute(multi instance),in command line
      --custom-attribute "x-local-name:HR"
      --custom-attribute ' [  “x-local-name:HR”,“x-local-id:100” ]'
--output_format

オプション

コマンドの出力形式を指定します。指定できる値は"text"または"json"です。

指定された出力形式が"text"の場合、このコマンドは、正常に実行されると終了コード0で完了し、秘密キーと公開キーのUniversally Unique ID (UUID)を返します。出力の1行目は秘密キーのUUIDで、2行目は公開キーのUUIDです。これは、失敗すると終了コード1で完了し、関連するエラー・メッセージを生成します。

指定された出力形式が"JSON"の場合、このコマンドは、操作の結果を示すJSON構造を返します。操作が正常に実行された場合、そのJSON構造には秘密キーと公開キーのUniversally Unique ID (UUID)が含まれ、終了コード0で完了します。操作に失敗した場合、そのJSON構造には関連するエラー・メッセージが含まれ、終了コード1で完了します。
--ssh-user /sshUser

オプション

SSHユーザー名。SSHユーザーは、SSHキー、人間、アプリケーションまたはマシンといった実際のコンシューマを追跡することを目的としています。

ノート:

CLIコマンド構文を使用して、output_formatオプションを指定します。デフォルトでは、出力形式はJSONです。ただし、値がtextのoutput_formatオプションは、テキスト形式で出力を表示します。テキスト出力形式を使用すると、JSON出力を解析する必要がなくなります。このオプションは、コマンドの出力が別のコマンドの入力として機能する場合に便利です。

JSONを使用しない例

okv managed-object key-pair create --length 4096 --algorithm RSA --private-key-mask "SIGN" --public-key-mask "VERIFY" --private-key-name 2023_ PRIVATE_KEY_FOR_SIGNING --public-key-name 2023_PUBLIC_KEY_FOR_VERIFY

JSONの例

  1. okv managed-object key-pair createコマンド用にJSON入力を生成します。 
    okv managed-object key-pair create --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "managed-object",
    "resource" : "key-pair",
    "action" : "create",
    "options" : {
      "algorithm" : "#RSA",
      "length" : "#2048,3072,4096(RSA)",
      "sshUser" : "#VALUE",
      "wallet" : "#VALUE",
      "attributes" : {
        "activationDate" : "#NOW|YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#NOW|YYYY-MM-DD HH:mm:ss"
      },
      "privateKey" : {
                "mask" : [ "#SIGN", "#ENCRYPT", "#DECRYPT", "#WRAP_KEY", "#UNWRAP_KEY",
                   "#EXPORT", "#DERIVE_KEY", "#TRANSLATE_ENCRYPT", 
                   "#TRANSLATE_DECRYPT", "#TRANSLATE_WRAP", "#TRANSLATE_UNWRAP" ],
        "attributes" : {
          "name" : {
            "value" : "#VALUE",
            "type" : "#text|uri"
          },
          "extractable" : "#TRUE|FALSE"
        },
        "customAttributes" : [ {
          "name" : "#VALUE",
          "value" : "#VALUE",
          "type" : "#TEXT|NUMBER"
        } ]
      },
      "publicKey" : {
                "mask" : [ "#VERIFY", "#ENCRYPT", "#DECRYPT", "#UNWRAP_KEY",
                   "#EXPORT", "#DERIVE_KEY", "#TRANSLATE_ENCRYPT", 
                   "#TRANSLATE_DECRYPT", "#TRANSLATE_UNWRAP" ],
        "attributes" : {
          "name" : {
            "value" : "#VALUE",
            "type" : "#text|uri"
          }
        },
        "customAttributes" : [ {
          "name" : "#VALUE",
          "value" : "#VALUE",
          "type" : "#TEXT|NUMBER"
        } ]
      }
    }
  }
}
  2. 生成された入力内容をファイル(たとえば、create_key_pair.json)に保存してから、それを編集してキー・ペアを作成します。 
     {
  "service": {
    "category": "managed-object",
    "resource": "key-pair",
    "action": "create",
    "options": {
      "algorithm": "RSA",
      "length": "3072",
      "privateKey": {
        "mask": ["SIGN", "DECRYPT"],
        "attributes": {
         "extractable" : "FALSE"
        },
      },
      "publicKey": {
        "mask": ["VERIFY", "ENCRYPT"]
      },
      "wallet": "hr_wallet"
    }
  }
}
  3. 生成されたJSONファイルを使用してokv managed-object key-pair createコマンドを実行します。 
    okv managed-object key-pair create --from-json create_key_pair.json

    出力は、次のようになります。 

    {
  "result": "Success",
   "value": {
    "privateKeyUUID": "2BFDEBD7-5AE5-4F31-BFF7-6E8B2D20A170",
    "publicKeyUUID": "6B87CF6A-A10E-4F10-BF06-D92CB0241E8A",
  }
}

出力形式としてのテキストの使用例

okv managed-object key-pair create --output_format text --length 4096 --algorithm RSA --private-key-mask "SIGN" --public-key-mask "VERIFY" –private-key-name 2023_PRIVATE_KEY_FOR_SIGNING –public-key-name 2023_PUBLIC_KEY_FOR_VERIFY

出力

出力は、次のようになります。 

2BFDEBD7-5AE5-4F31-BFF7-6E8B2D20A170
6B87CF6A-A10E-4F10-BF06-D92CB0241E8A

親トピック: セキュリティ・オブジェクトのコマンド