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コマンドを使用します。

必要な権限

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

構文

JSON構文のみを使用: okv managed-object attribute add --generate-json-input

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

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

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

パラメータ

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

--uuid / uuid

必須

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

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

attributes

必須

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

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

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

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

日付値には、次の書式を使用します。

YYYY-MM-DD HH:mm:ss (UTC)

dateコマンドを使用してUTCで時間を表示する方法を示す例: 

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

JSONの例

  1. okv managed-object attribute addコマンドのJSON入力を生成し、add-attrib.jsonとして保存します。 
    okv managed-object attribute add --generate-json-input > add-attrib.json; more add-attrib.json

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

    {
  "service" : {
    "category" : "managed-object",
    "resource" : "attribute",
    "action" : "add",
    "options" : {
      "uuid" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE",
        "activationDate" : "#YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#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" : "pfitch@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_attrib.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 listコマンドを実行します。

必要な権限

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

構文

JSON構文のみを使用: okv managed-object attribute delete --generate-json-input

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

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

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

パラメータ

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

--uuid / uuid

必須

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

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

attributes

必須

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

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

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

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": "",
        "activationDate": "",
        "deactivationDate": "",
        "protectStopDate": "",
        "processStartDate": ""
      }
    }
  }
}
  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 listコマンドを実行します。カスタム属性の値を取得するには、okv managed-object attribute get-allコマンドを実行します。

必要な権限

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

構文

JSON構文のみを使用: okv managed-object attribute get --generate-json-input

属性を指定する場合は、このコマンドにJSON構文を使用する必要があります。ただし、コマンドラインでは、このコマンドに--uuidパラメータを使用できます。これは、複数のオブジェクトに同じ属性値を適用する際に役立ちます。同じ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" ]
    }
  }
}

パラメータ

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

--uuid / uuid

必須

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

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

attributes

必須

属性名の配列。属性を指定する場合は、JSON構文を使用する必要があります。コマンドラインでは属性を指定できません。オプションのATTRIBUTE_NAME属性を追加することで、複数の属性の値を取得できます。例を参照してください。

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

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

customAttributes

オプション

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

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"
      ],
      "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": "pfitch@example.com",
      "cryptoUsageMask": [
        "ENCRYPT",
        "DECRYPT"
      ],
      "cryptographicAlgorithm": "AES",
      "cryptographicLength": "256",
      "name": [
        {
          "type": "text",
          "value": "PROD-HRDB-MKEY"
        }
      ],
      "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_attribute.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_attribute.json

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

    {
  "result" : "Success",
  "value" : {
    "attributes" : {
      "activationDate" : "2020-11-21 01:00:00",
      "contactInfo" : "pfitch@example.com",
      "cryptoUsageMask" : [ "ENCRYPT", "DECRYPT" ],
      "cryptographicAlgorithm" : "AES",
      "cryptographicLength" : "256",
      "deactivationDate" : "2024-12-31 01:00:00",
      "digest" : {
       "algorithm" : "SHA-256",
       "digestValue" : "EA31657433D91BF79660525131772D838A1128FCE6B49471726EEF5844EFA3F7",
       "keyFormatType" : "RAW"
      },
      "fresh" : "Yes",
      "initialDate" : "2020-11-21 00:57:00",
      "lastChangeDate" : "2020-11-21 20:17:19",
      "name" : [ {
        "type" : "text",
        "value" : "PROD-HRDB-MKEY"
      } ],
      "objectType" : "Symmetric Key",
      "processStartDate" : "2020-11-21 00:57:00",
      "protectStopDate" : "2024-09-30 09:00:00",
      "state" : "Active"
    },
    "customAttributes" : [ {
      "index" : "1",
      "name" : "x-ApplicationTag",
      "type" : "Text String",
      "value" : "HR-Production"
    } ]
  }
}

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

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_attribute.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_attribute.json

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

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

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

5.6 okv managed-object attribute modifyコマンド

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

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

必要な権限

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

構文

JSON構文のみを使用: okv managed-object attribute modify --generate-json-input

属性を指定する場合は、このコマンドにJSON構文を使用する必要があります。ただし、コマンドラインでは、このコマンドに--uuidパラメータを使用できます。これは、複数のオブジェクトに同じ属性値を適用する際に役立ちます。同じ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" : "#YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#YYYY-MM-DD HH:mm:ss"
      }
    }
  }
}

パラメータ

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

--uuid / uuid

必須

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

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

attributes

必須

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

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

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

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

日付値には、次の書式を使用します。

YYYY-MM-DD HH:mm:ss (UTC)

dateコマンドを使用してUTCで時間を表示する方法を示す例: 

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

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" : "#YYYY-MM-DD HH:mm:ss",
        "deactivationDate" : "#YYYY-MM-DD HH:mm:ss",
        "protectStopDate" : "#YYYY-MM-DD HH:mm:ss",
        "processStartDate" : "#YYYY-MM-DD HH:mm:ss"
      }
    }
  }
}
  2. 生成された入力をファイル(たとえば、modify_attribute.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"
      }
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object attribute modifyコマンドを実行します。 
    okv managed-object attribute modify --from-json modify_attribute.json

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

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

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

5.7 okv managed-object certificate getコマンド

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

必要な権限

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

構文

okv managed-object certificate get --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」列を確認します。

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-----"
  }
}

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

5.8 okv managed-object certificate registerコマンド

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

必要な権限

なし

構文

okv managed-object certificate register --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

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

{
  "service" : {
    "category" : "managed-object",
    "resource" : "certificate",
    "action" : "register",
    "options" : {
      "object" : "#VALUE",
      "algorithm" : "#RSA",
      "length" : "#1024,2048,4096(RSA)",
      "mask" : #[ "ENCRYPT", "DECRYPT", "WRAP_KEY", "UNWRAP_KEY", "EXPORT", "DERIVE_KEY", "GENERATE_CRYPTOGRAM", "VALIDATE_CRYPTOGRAM", "TRANSLATE_ENCRYPT", "TRANSLATE_DECRYPT", "TRANSLATE_WRAP", "TRANSLATE_UNWRAP" ],
      "type" : "X_509",
      "subType" : "#USER_CERT|TRUSTPOINT",
      "privateKeyUUID" : "#VALUE",
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE"
      }
    }
  }
}

パラメータ

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

--object / object

必須

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

--type / type

必須

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

--sub-type / sub-type

オプション

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

  • USER_CERT
  • TRUSTPOINT

--algorithm / algorithm

オプション

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

  • RSA

--length / length

オプション

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

  • 1024
  • 2048
  • 4096

--mask / mask

必須

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

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

--privateKeyUUID / privateKeyUUID

オプション

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

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

--wallet / wallet

オプション

ウォレット名。アクセス権のある既存のウォレットの名前を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブを選択して、左側のナビゲーション・ウィンドウで「Wallets」をクリックします。

attributes

オプション

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

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

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

  • nameには、次の情報が含まれます。
    • valueは、名前値です。
    • typeは、textまたはuriです。
  • contactInfo

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

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,4096(RSA)",
      "mask" : #[ "ENCRYPT", "DECRYPT", "WRAP_KEY", "UNWRAP_KEY", "EXPORT", "DERIVE_KEY", "GENERATE_CRYPTOGRAM", "VALIDATE_CRYPTOGRAM", "TRANSLATE_ENCRYPT", "TRANSLATE_DECRYPT", "TRANSLATE_WRAP", "TRANSLATE_UNWRAP" ],
      "type" : "X_509",
      "subType" : "#USER_CERT|TRUSTPOINT",
      "privateKeyUUID" : "#VALUE",
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE"
      }
    }
  }
}
  2. 生成された入力をファイル(たとえば、reg_cert.json)に保存して、証明書を登録できるように編集します。 
    {
  "service" : {
    "category" : "managed-object",
    "resource" : "certificate",
    "action" : "register",
    "options" : {
      "object" : "./cert.pem",
      "algorithm" : "RSA",
      "length" : "2048",
      "mask" : [ "ENCRYPT"],
      "type" : "X_509",
      "subType" : "USER_CERT",
      "privateKeyUUID" : "D497994E-74CD-4F60-BF7C-52F254142705",
      "wallet" : "hr_wallet",
      "attributes" : {
        "name" : {
          "value" : "FINDB-PROD-CERT",
          "type" : "text"
        },
        "contactInfo" : "pfitch@example.com"
      }
    }
  }
}
  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"
  }
}

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

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

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

必要な権限

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

構文

okv managed-object certificate-request get  --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」列を確認します。

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-----"
  }
}

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

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

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

必要な権限

なし

構文

okv managed-object certificate-request register --object certificate_requeset_file_path --type certificate_requeset_type --private-key-uuid private_key_uuid --wallet wallet_name

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"
      }
    }
  }
}

パラメータ

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

--object / object

必須

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

--type / type

必須

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

  • CRMF
  • PKCS10
  • PEM
  • PGP

--privateKeyUUID / privateKeyUUID

オプション

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

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

--wallet / wallet

オプション

ウォレット名。アクセス権のある既存のウォレットの名前を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブを選択して、左側のナビゲーション・ウィンドウで「Wallets」をクリックします。

attributes

オプション

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

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

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

  • nameには、次の情報が含まれます。
    • valueは、名前値です。
    • typeは、textまたはuriです。
  • contactInfo
これらの属性の詳細は、Key Management Interoperability Protocol仕様バージョン1.1を参照してください。

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"
      }
    }
  }
}
  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" : "pfitch@example.com"
      }
    }
  }
}
  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"
  }
}

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

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

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

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

必要な権限

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

構文

JSON構文のみを使用: okv managed-object custom-attribute add --generate-json-input

属性を指定する場合は、このコマンドにJSON構文を使用する必要があります。ただし、コマンドラインでは、このコマンドに--uuidパラメータを使用できます。これは、複数のオブジェクトに同じ属性値を適用する際に役立ちます。同じ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」列を確認します。

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を参照してください。

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コマンドでは、セキュリティ・オブジェクトのカスタム属性を削除します。

必要な権限

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

構文

JSON構文のみを使用: okv managed-object custom-attribute delete --generate-json-input

属性を指定する場合は、このコマンドにJSON構文を使用する必要があります。ただし、コマンドラインでは、このコマンドに--uuidパラメータを使用できます。これは、複数のオブジェクトに同じ属性値を適用する際に役立ちます。同じ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」列を確認します。

customAttribute

必須

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

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

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

これらの属性の詳細は、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コマンドでは、セキュリティ・オブジェクトのカスタム属性を変更します。

必要な権限

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

構文

JSON構文のみを使用: okv managed-object custom-attribute modify --generate-json-input

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

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

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

パラメータ

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

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は、変更する属性の索引です。

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 --algorithm  cryptographic_algorithm --length key_length --mask crypographic_usage_mask --wallet wallet_name

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"
    }
  }
}

パラメータ

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

--algorithm / algorithm

必須

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

  • AES
  • 3DES

--length / length

必須

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

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

--mask / mask

必須

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

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

--wallet / wallet

オプション

ウォレット名。アクセス権のある既存のウォレットの名前を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブを選択して、左側のナビゲーション・ウィンドウで「Wallets」をクリックします。

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"
    }
  }
}
  2. 生成された入力をファイル(たとえば、create_key.json)に保存して、キーを作成できるように編集します。 
    {
  "service": {
    "category": "managed-object",
    "resource": "key",
    "action": "create",
    "options": {
      "algorithm": "AES",
      "length": "256",
      "mask": [
        "ENCRYPT",
        "DECRYPT"
      ],
      "wallet": "hr_wallet"
    }
  }
}
  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"
  }
}

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

5.15 okv managed-object key getコマンド

okv managed-object key getコマンドでは、暗号化キーを取得します。

必要な権限

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

構文

okv managed-object key get --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」列を確認します。

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"
  }
}

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

5.16 okv managed-object key registerコマンド

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

必要な権限

なし

構文

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

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"
      }
    }
  }
}

パラメータ

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

--algorithm / algorithm

必須

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

  • AES
  • 3DES

--length / length

必須

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

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

--mask / mask

必須

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

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

--object / object

必須

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

--wallet / wallet

オプション

ウォレット名。アクセス権のある既存のウォレットの名前を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブを選択して、左側のナビゲーション・ウィンドウで「Wallets」をクリックします。

attributes

必須

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

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

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

  • nameには、次の情報が含まれます。
    • valueは、名前値です。
    • typeは、textまたはuriです。
  • contactInfo

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

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"
      }
    }
  }
}
  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"
      }
    }
  }
}
  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"
  }
}

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

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」列を確認します。

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"
}

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

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」列を確認します。

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 del_obj.json

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

    {
  "result": "Success"
}

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

5.19 okv managed-object object locateコマンド

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

必要な権限

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

構文

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

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

{
  "service" : {
    "category" : "managed-object",
    "resource" : "object",
    "action" : "locate",
    "options" : {
      "max" : "#VALUE",
      "objectGroupMember" : "#FRESH|DEFAULT",
      "attributes" : {
        "name" : {
          "value" : "#VALUE"
        },
        "state" :
"#PREACTIVE|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"
      },
      "customAttributes" : [ {
        "name" : "#VALUE",
        "value" : "#VALUE",
        "type" : "#TEXT|NUMBER"
      } ]
    }
  }
}

パラメータ

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

--max / max

必須

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

--object-group-member / object-group-member

オプション

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

  • DEFAULT
  • FRESH

--state / state

オプション

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

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

--name / name

オプション

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

--attributes / 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は、オブジェクトの非アクティブ化日です。
  • processStartDateは、オブジェクトのプロセス開始日です。
  • protectStopDateは、オブジェクトの保護停止日です。
  • initialDateは、オブジェクトの初期化日です。
  • lastChangeDateは、オブジェクトの最終変更日です。
  • compromiseDateは、オブジェクトの危殆化日です。
  • compromiseOccurrenceDateは、オブジェクトの侵害発生日です。
  • destroyDateは、オブジェクトの破棄日です。
  • archiveDateは、オブジェクトのアーカイブ日です。

customAttributes

オプション

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

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

  • nameは、カスタム属性の名前です。
  • valueは、カスタム属性の値です。
  • typeは、textまたはnumberです。

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

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" :
"#PREACTIVE|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"
      },
      "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"
           }
      },
     "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" ]
  }
}

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

5.20 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.21 okv managed-object object revokeコマンド

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

必要な権限

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

構文

okv managed-object object revoke --code code --reason reason --compromiseDate 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
  • KEY_COMPROMISE
  • PRIVILEGE_WITHDRAWN
  • SUPERSEDED
  • UNSPECIFIED

--reason / reason

必須

失効の理由の説明

--compromise-occurrence-date / compromiseOccurrenceDate

オプション

侵害の発生日

--uuid / uuid

必須

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

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

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"
}

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

5.22 okv managed-object opaque getコマンド

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

必要な権限

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

構文

okv managed-object opaque get --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」列を確認します。

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"
  }
}

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

5.23 okv managed-object opaque registerコマンド

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

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

必要な権限

なし

構文

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

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

{
  "service" : {
    "category" : "managed-object",
    "resource" : "opaque",
    "action" : "register",
    "options" : {
      "object" : "#VALUE",
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE"
      }
    }
  }
}

パラメータ

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

--object / object

必須

オブジェクトへのファイル・パス。アクセス権のある既存のオブジェクトの名前を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブを選択して、左側のナビゲーション・ウィンドウで「Keys, Secrets & Objects」をクリックします。

--wallet / wallet

オプション

ウォレット名。アクセス権のある既存のウォレットの名前を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブを選択して、左側のナビゲーション・ウィンドウで「Wallets」をクリックします。

attributes

オプション

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

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

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

  • nameには、次の情報が含まれます。
    • valueは、名前値です。
    • typeは、textまたはuriです。
  • contactInfo

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

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"
      }
    }
  }
}
  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": "pfitch@example.com"
      }
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv managed-object opaque registerコマンドを実行します。 
    okv managed-object opaque register --from-json reg_opaque.json

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

    {
  "result": "Success"
}

関連項目

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

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

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

必要な権限

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

構文

okv managed-object private-key get  --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」列を確認します。

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-----"
  }
}

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

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

okv managed-object private-key registerコマンドは、秘密キーを登録します。

必要な権限

なし

構文

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

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

{
  "service" : {
    "category" : "managed-object",
    "resource" : "private-key",
    "action" : "register",
    "options" : {
      "object" : "#VALUE",
      "algorithm" : "#RSA",
      "length" : "#1024,2048,4096(RSA)",
      "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"
      }
    }
  }
}

パラメータ

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

--object / object

必須

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

--algorithm / algorithm

必須

暗号化アルゴリズム。次の値が有効です: RSA

--length / length

必須

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

  • 1024
  • 2048
  • 4096

--mask / mask

必須

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

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

--wallet / wallet

オプション

ウォレット名。アクセス権のある既存のウォレットの名前を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブを選択して、左側のナビゲーション・ウィンドウで「Wallets」をクリックします。

attributes

オプション

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

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

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

  • nameには、次の情報が含まれます。
    • valueは、名前値です。
    • typeは、textまたはuriです。
  • contactInfo

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

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" : #[ "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"
      }
    }
  }
}
  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" : "pfitch@example.com"
      }
    }
  }
}
  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"
  }
}

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

5.26 okv managed-object public-key getコマンド

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

必要な権限

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

構文

okv managed-object public-key get  --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」列を確認します。

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-----"
  }
}

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

5.27 okv managed-object public-key registerコマンド

okv managed-object public-key registerコマンドは、公開キーを登録します。

必要な権限

なし

構文

okv managed-object public-key register --object public_key_file_path --algorithm cryptographic_algorithm --length key_length --mask cryptographic_usage_mask --private-key-uuid private_key_uuid --wallet wallet_name

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

{
  "service" : {
    "category" : "managed-object",
    "resource" : "public-key",
    "action" : "register",
    "options" : {
      "object" : "#VALUE",
      "algorithm" : "#RSA",
      "length" : "#1024,2048,4096(RSA)",
      "mask" : #[ "ENCRYPT", "DECRYPT", "WRAP_KEY", "UNWRAP_KEY", "EXPORT", "DERIVE_KEY", "GENERATE_CRYPTOGRAM", "VALIDATE_CRYPTOGRAM", "TRANSLATE_ENCRYPT", "TRANSLATE_DECRYPT", "TRANSLATE_WRAP", "TRANSLATE_UNWRAP" ],
      "privateKeyUUID" : "#VALUE",
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE"
      }
    }
  }
}

パラメータ

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

--object / object

必須

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

--algorithm / algorithm

必須

暗号化アルゴリズム。次の値が有効です。

  • RSA

--length / length

必須

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

  • 1024
  • 2048
  • 4096

--mask / mask

必須

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

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

--privateKeyUUID / privateKeyUUID

オプション

登録中の公開キーに関連付けられている秘密キーのUUID (Universally Unique ID)。

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

--wallet / wallet

オプション

ウォレット名。アクセス権のある既存のウォレットの名前を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブを選択して、左側のナビゲーション・ウィンドウで「Wallets」をクリックします。

attributes

オプション

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

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

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

  • nameには、次の情報が含まれます。
    • valueは、名前値です。
    • typeは、textまたはuriです。
  • contactInfo

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

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,4096(RSA)",
      "mask" : #[ "ENCRYPT", "DECRYPT", "WRAP_KEY", "UNWRAP_KEY", "EXPORT", "DERIVE_KEY", "GENERATE_CRYPTOGRAM", "VALIDATE_CRYPTOGRAM", "TRANSLATE_ENCRYPT", "TRANSLATE_DECRYPT", "TRANSLATE_WRAP", "TRANSLATE_UNWRAP" ],
      "privateKeyUUID" : "#VALUE",
      "wallet" : "#VALUE",
      "attributes" : {
        "name" : {
          "value" : "#VALUE",
          "type" : "#text|uri"
        },
        "contactInfo" : "#VALUE"
      }
    }
  }
}
  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" : " pfitch@example.com "
      }
    }
  }
}
  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 "
  }
}

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

5.28 okv managed-object secret getコマンド

okv managed-object secret getコマンドでは、secretタイプのセキュリティ・オブジェクトからシークレット・データを取得します。

必要な権限

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

構文

okv managed-object secret get --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」列を確認します。

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"
  }
}

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

5.29 okv managed-object secret registerコマンド

okv managed-object secret registerコマンドでは、パスワードやランダム・シードなどのシークレット・データを登録します。

必要な権限

なし

構文

okv managed-object secret register --object object_name type PASSWORD|SEED wallet wallet_name --mask cryptogrpahic_usage_mask

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

{
  "service" : {
    "category" : "managed-object",
    "resource" : "secret",
    "action" : "register",
    "options" : {
      "object" : "#VALUE",
      "type" : "#PASSWORD|SEED",
      "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"
      }
    }
  }
}

パラメータ

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

--object / object

必須

シークレット・データを格納しているオブジェクト・ファイルのパス。

--type / type

必須

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

  • PASSWORD
  • SEED

--wallet / wallet

オプション

ウォレット名。アクセス権のある既存のウォレットの名前を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブを選択して、左側のナビゲーション・ウィンドウで「Wallets」をクリックします。

--mask / mask

必須

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

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

attributes

必須

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

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

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

  • nameには、次の情報が含まれます。
    • valueは、名前値です。
    • typeは、textまたはuriです。
  • contactInfo

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

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" : #[ "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"
      }
    }
  }
}
  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" : "pfitch@example.com"
      }
    }
  }
}
  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"
  }
}

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

5.30 okv managed-object wallet add-memberコマンド

okv managed-object wallet add-memberコマンドでは、セキュリティ・オブジェクトをメンバーとしてウォレットに追加します。

このコマンドは、エンドポイントのクライアント証明書を使用して認証します。

必要な権限

エンドポイントには、オブジェクトに対する読取り変更権限と、ウォレットに対するウォレット管理アクセス権(MW)が必要です。

構文

okv managed-object wallet add-member --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

必須

ウォレット名。アクセス権のある既存のウォレットの名前を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブを選択して、左側のナビゲーション・ウィンドウで「Wallets」をクリックします。

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"
}

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

5.31 okv managed-object wallet delete-memberコマンド

okv managed-object wallet delete-memberコマンドでは、管理対象オブジェクトのメンバーシップをウォレットから削除します。

このコマンドは、エンドポイントのクライアント証明書を使用して認証します。

必要な権限

エンドポイントには、オブジェクトに対する読取り変更権限と、ウォレットに対するウォレット管理アクセス権(MW)が必要です。

構文

okv managed-object wallet delete-member --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

必須

ウォレット名。アクセス権のある既存のウォレットの名前を調べるには、Oracle Key Vault管理コンソールで、「Keys & Wallets」タブを選択して、左側のナビゲーション・パネルで「Wallets」をクリックします。

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"
}

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

5.32 okv managed-object wallet listコマンド

okv managed-object wallet listコマンドでは、Oracle Key Vaultへの接続に使用されるエンドポイントへのアクセス権が付与されているウォレットをリストします。

このコマンドは、エンドポイントのクライアント証明書を使用して認証します。

必要な権限

なし。ただし、このコマンドでは、現在のエンドポイントに対してアクセス権が付与されているウォレットのみが返されます。

構文

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

{
  "service": {
    "category": "managed-object",
    "resource": "wallet",
    "action": "list"
  }
}
okv managed-object wallet list

パラメータ

なし

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"
    ]
  }
}

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