パッケージ google.cloud.kms.v1

目次

KeyManagementService

Google Cloud Key Management Service

暗号鍵と鍵を使用した操作を管理します。次のオブジェクトを含む REST モデルを実装します。

手動 gRPC ライブラリを使用している場合は、Cloud KMS での gRPC の使用をご覧ください。

AsymmetricDecrypt

rpc AsymmetricDecrypt(AsymmetricDecryptRequest) returns (AsymmetricDecryptResponse)

CryptoKey.purpose が ASYMMETRIC_DECRYPT の CryptoKeyVersion に対応する GetPublicKey から取得された公開鍵で暗号化されたデータを復号します。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

AsymmetricSign

rpc AsymmetricSign(AsymmetricSignRequest) returns (AsymmetricSignResponse)

CryptoKey.purpose が ASYMMETRIC_SIGN の CryptoKeyVersion を使用し、GetPublicKey から取得された公開鍵で検証できる署名を作成してデータに署名します。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

CreateCryptoKey

rpc CreateCryptoKey(CreateCryptoKeyRequest) returns (CryptoKey)

KeyRing 内に新しい CryptoKey を作成します。

CryptoKey.purposeCryptoKey.version_template.algorithm が必要です。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

CreateCryptoKeyVersion

rpc CreateCryptoKeyVersion(CreateCryptoKeyVersionRequest) returns (CryptoKeyVersion)

CryptoKey 内に新しい CryptoKeyVersion を作成します。

サーバーによって次の順次 ID が割り当てられます。設定されていない場合、stateENABLED に設定されます。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

CreateKeyRing

rpc CreateKeyRing(CreateKeyRingRequest) returns (KeyRing)

指定したプロジェクトとロケーションで新しい KeyRing を作成します。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

Decrypt

rpc Decrypt(DecryptRequest) returns (DecryptResponse)

Encrypt によって保護されたデータを復号します。CryptoKey.purposeENCRYPT_DECRYPT である必要があります。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

DestroyCryptoKeyVersion

rpc DestroyCryptoKeyVersion(DestroyCryptoKeyVersionRequest) returns (CryptoKeyVersion)

CryptoKeyVersion の破棄をスケジュールします。

このメソッドを呼び出すと、CryptoKeyVersion.stateDESTROY_SCHEDULED に設定され、destroy_time が 24 時間後に設定されます。その時点で、stateDESTROYED に変更され、鍵のマテリアルが完全に破棄されます。

このプロセスを取り消すには、destroy_time に達する前に RestoreCryptoKeyVersion を呼び出します。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

Encrypt

rpc Encrypt(EncryptRequest) returns (EncryptResponse)

Decrypt の呼び出し以外の方法で解読できないようデータを暗号化します。CryptoKey.purposeENCRYPT_DECRYPT である必要があります。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

GetCryptoKey

rpc GetCryptoKey(GetCryptoKeyRequest) returns (CryptoKey)

指定した CryptoKey とその primary CryptoKeyVersion のメタデータを返します。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

GetCryptoKeyVersion

rpc GetCryptoKeyVersion(GetCryptoKeyVersionRequest) returns (CryptoKeyVersion)

指定した CryptoKeyVersion のメタデータを返します。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

GetKeyRing

rpc GetKeyRing(GetKeyRingRequest) returns (KeyRing)

指定した KeyRing のメタデータを返します。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

GetPublicKey

rpc GetPublicKey(GetPublicKeyRequest) returns (PublicKey)

指定した CryptoKeyVersion の公開鍵を返します。CryptoKey.purposeASYMMETRIC_SIGN または ASYMMETRIC_DECRYPT である必要があります。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

ListCryptoKeyVersions

rpc ListCryptoKeyVersions(ListCryptoKeyVersionsRequest) returns (ListCryptoKeyVersionsResponse)

CryptoKeyVersions をリストします。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

ListCryptoKeys

rpc ListCryptoKeys(ListCryptoKeysRequest) returns (ListCryptoKeysResponse)

CryptoKeys をリストします。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

ListKeyRings

rpc ListKeyRings(ListKeyRingsRequest) returns (ListKeyRingsResponse)

KeyRings をリストします。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

RestoreCryptoKeyVersion

rpc RestoreCryptoKeyVersion(RestoreCryptoKeyVersionRequest) returns (CryptoKeyVersion)

DESTROY_SCHEDULED 状態の CryptoKeyVersion を復元します。

CryptoKeyVersion を復元すると、stateDISABLED に設定されて、destroy_time がクリアされます。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

UpdateCryptoKey

rpc UpdateCryptoKey(UpdateCryptoKeyRequest) returns (CryptoKey)

CryptoKey を更新します。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

UpdateCryptoKeyPrimaryVersion

rpc UpdateCryptoKeyPrimaryVersion(UpdateCryptoKeyPrimaryVersionRequest) returns (CryptoKey)

Encrypt で使用される CryptoKey のバージョンを更新します。

非対称鍵で呼び出された場合、エラーを返します。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

UpdateCryptoKeyVersion

rpc UpdateCryptoKeyVersion(UpdateCryptoKeyVersionRequest) returns (CryptoKeyVersion)

CryptoKeyVersion のメタデータを更新します。

このメソッドを使用して、stateENABLEDDISABLED の間で変更できます。他の状態間で変更する場合は、DestroyCryptoKeyVersionRestoreCryptoKeyVersion をご覧ください。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

AsymmetricDecryptRequest

KeyManagementService.AsymmetricDecrypt のリクエスト メッセージ。

フィールド
name

string

必須。復号に使用する CryptoKeyVersion のリソース名。

承認には、指定したリソースの name に対する次の Google IAM 権限が必要です。

  • cloudkms.cryptoKeyVersions.useToDecrypt

ciphertext

bytes

必須。OAEP を使用して、指定された CryptoKeyVersion の公開鍵で暗号化されたデータ。

AsymmetricDecryptResponse

KeyManagementService.AsymmetricDecrypt のレスポンス メッセージ。

フィールド
plaintext

bytes

一致する公開鍵で暗号化されていたデータを復号化した文字列。

AsymmetricSignRequest

KeyManagementService.AsymmetricSign のリクエスト メッセージ。

フィールド
name

string

必須。署名に使用する CryptoKeyVersion のリソース名。

承認には、指定したリソースの name に対する次の Google IAM 権限が必要です。

  • cloudkms.cryptoKeyVersions.useToSign

digest

Digest

必須。署名するデータのダイジェスト。ダイジェストは、鍵バージョンの algorithm で指定されたダイジェスト アルゴリズムと同じアルゴリズムで生成する必要があります。

AsymmetricSignResponse

KeyManagementService.AsymmetricSign のレスポンス メッセージ。

フィールド
signature

bytes

作成された署名。

CreateCryptoKeyRequest

KeyManagementService.CreateCryptoKey のリクエスト メッセージ。

フィールド
parent

string

必須。CryptoKeys に関連付けられた KeyRing の name

承認には、指定したリソースの parent に対する次の Google IAM 権限が必要です。

  • cloudkms.cryptoKeys.create

crypto_key_id

string

必須。KeyRing 内で固有であり、[a-zA-Z0-9_-]{1,63} という正規表現に一致する必要があります。

crypto_key

CryptoKey

初期フィールド値を持つ CryptoKey

CreateCryptoKeyVersionRequest

KeyManagementService.CreateCryptoKeyVersion のリクエスト メッセージ。

フィールド
parent

string

必須。CryptoKeyVersions に関連付けられている CryptoKeyname

承認には、指定したリソースの parent に対する次の Google IAM 権限が必要です。

  • cloudkms.cryptoKeyVersions.create

crypto_key_version

CryptoKeyVersion

初期フィールド値を持つ CryptoKeyVersion

CreateKeyRingRequest

KeyManagementService.CreateKeyRing のリクエスト メッセージ。

フィールド
parent

string

必須。KeyRings に関連付けられているロケーションのリソース名。形式は projects/*/locations/* です。

承認には、指定したリソースの parent に対する次の Google IAM 権限が必要です。

  • cloudkms.keyRings.create

key_ring_id

string

必須。同一の場所に同じものがあってはならず、正規表現 [a-zA-Z0-9_-]{1,63} に一致しなければなりません。

key_ring

KeyRing

初期フィールド値を持つ KeyRing

CryptoKey

CryptoKey は、暗号オペレーションに使用できる論理鍵を表したものです。

CryptoKey は 1 つ以上の versions で構成され、それぞれが暗号オペレーションで使用される実際の鍵のマテリアルを表します。

フィールド
name

string

出力のみ。この CryptoKey のリソース名。形式は projects/*/locations/*/keyRings/*/cryptoKeys/* です。

primary

CryptoKeyVersion

出力のみ。この CryptoKeyEncryptRequest.name で指定されているときに Encrypt によって使用される「メイン」の CryptoKeyVersion のコピー。

CryptoKey のメイン バージョンは UpdateCryptoKeyPrimaryVersion で更新できます。

purposeENCRYPT_DECRYPT であるすべての鍵に primary があります。他の鍵の場合、このフィールドは省略されます。

purpose

CryptoKeyPurpose

この CryptoKey の不変の目的。

create_time

Timestamp

出力のみ。この CryptoKey が作成された時刻。

next_rotation_time

Timestamp

next_rotation_time に、Key Management Service は次の処理を自動的に行います。

  1. この CryptoKey の新しいバージョンを作成します。
  2. 新しいバージョンをメインとしてマークします。

CreateCryptoKeyVersionUpdateCryptoKeyPrimaryVersion を介して手動で行われる鍵のローテーションは next_rotation_time に影響しません。

purposeENCRYPT_DECRYPT である鍵では自動ローテーションがサポートされます。他の鍵については、このフィールドを省略する必要があります。

version_template

CryptoKeyVersionTemplate

新しい CryptoKeyVersion インスタンスの設定を記述するテンプレート。CryptoKeyVersion または自動ローテーションによって作成された新しい CreateCryptoKeyVersion インスタンスのプロパティは、このテンプレートによって制御されます。

labels

map<string, string>

ユーザー定義のメタデータを持つラベル。詳細については、鍵のラベル付けをご覧ください。

rotation_period

Duration

サービスが自動的に鍵のローテーションを行う場合、next_rotation_time はこの期間だけ進められます。1 日以上にする必要があります。

rotation_period が設定されている場合は、next_rotation_time も設定する必要があります。

purposeENCRYPT_DECRYPT である鍵では自動ローテーションがサポートされます。他の鍵については、このフィールドを省略する必要があります。

CryptoKeyPurpose

CryptoKeyPurpose は、CryptoKey の暗号機能を示します。指定した鍵は、その目的で許可されたオペレーションにのみ使用できます。

列挙型
CRYPTO_KEY_PURPOSE_UNSPECIFIED 指定なし。
ENCRYPT_DECRYPT この目的の CryptoKeys は、EncryptDecrypt で使用できます。
ASYMMETRIC_SIGN この目的の CryptoKeys は、AsymmetricSignGetPublicKey で使用できます。
ASYMMETRIC_DECRYPT この目的の CryptoKeys は、AsymmetricDecryptGetPublicKey で使用できます。

CryptoKeyVersion

CryptoKeyVersion は、個々の暗号鍵とそれに関連付けられた鍵のマテリアルを表しています。

ENABLED バージョンは、暗号オペレーションに使用できます。

セキュリティ上の理由から、CryptoKeyVersion で表される未加工の暗号鍵のマテリアルは、表示およびエクスポートできません。使用できるのは、承認されたユーザーまたはアプリケーションが Cloud KMS を呼び出すときにデータを暗号化または復号する場合に限られます。

フィールド
name

string

出力のみ。この CryptoKeyVersion のリソース名。形式は projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/* です。

state

CryptoKeyVersionState

CryptoKeyVersion の現在の状態。

protection_level

ProtectionLevel

出力のみ。ProtectionLevel は暗号オペレーションの実行方法を表し、CryptoKeyVersion と一緒に使用されます。

algorithm

CryptoKeyVersionAlgorithm

出力のみ。この CryptoKeyVersion がサポートする CryptoKeyVersionAlgorithm

attestation

KeyOperationAttestation

出力のみ。鍵の生成時に HSM によって生成され、署名されたステートメント。このステートメントを使用して、Google とは独立して HSM に格納されている鍵の属性を検証します。protection_levelHSM の鍵バージョンにのみ提供されます。

create_time

Timestamp

出力のみ。この CryptoKeyVersion が作成された時刻。

generate_time

Timestamp

出力のみ。この CryptoKeyVersion の鍵のマテリアルが生成された時刻。

destroy_time

Timestamp

出力のみ。この CryptoKeyVersion の鍵のマテリアルの破棄がスケジュールされている時刻。stateDESTROY_SCHEDULED の場合にのみ表示されます。

destroy_event_time

Timestamp

出力のみ。この暗号鍵バージョンの鍵のマテリアルが破棄された時刻。stateDESTROYED の場合にのみ表示されます。

CryptoKeyVersionAlgorithm

各暗号オペレーションで使用する必要があるパラメータを示す CryptoKeyVersion のアルゴリズムです。

GOOGLE_SYMMETRIC_ENCRYPTION アルゴリズムは CryptoKey.purpose ENCRYPT_DECRYPT で使用できます。

「RSA_SIGN_」で始まるアルゴリズムは CryptoKey.purpose ASYMMETRIC_SIGN で使用できます。

「RSA_SIGN_」の後に続く名前のフィールドは、パディング アルゴリズム、係数ビット長、ダイジェスト アルゴリズムの各パラメータに対応します。

PSS の場合、使用されるソルトの長さはダイジェスト アルゴリズムで使用される長さと同じです。たとえば、RSA_SIGN_PSS_2048_SHA256 では、ソルト長 256 ビット(32 バイト)の PSS が使用されます。

「RSA_DECRYPT_」で始まるアルゴリズムは CryptoKey.purpose ASYMMETRIC_DECRYPT で使用できます。

「RSA_DECRYPT_」の後に続く名前のフィールドは、パディング アルゴリズム、係数ビット長、ダイジェスト アルゴリズムの各パラメータに対応します。

「EC_SIGN_」で始まるアルゴリズムは CryptoKey.purpose ASYMMETRIC_SIGN で使用できます。

「EC_SIGN_」の後に続く名前のフィールドは、楕円曲線とダイジェスト アルゴリズムの各パラメータに対応します。

列挙型
CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED 指定なし。
GOOGLE_SYMMETRIC_ENCRYPTION 対称暗号鍵を作成します。
RSA_SIGN_PSS_2048_SHA256 RSASSA-PSS の 2,048 ビットの鍵(SHA256 ダイジェストを使用)。
RSA_SIGN_PSS_3072_SHA256 RSASSA-PSS の 3,072 ビットの鍵(SHA256 ダイジェストを使用)。
RSA_SIGN_PSS_4096_SHA256 RSASSA-PSS の 4,096 ビットの鍵(SHA256 ダイジェストを使用)。
RSA_SIGN_PSS_4096_SHA512 RSASSA-PSS の 4,096 ビットの鍵(SHA512 ダイジェストを使用)。
RSA_SIGN_PKCS1_2048_SHA256 RSASSA-PKCS1-v1_5 の 2,048 ビットの鍵(SHA256 ダイジェストを使用)。
RSA_SIGN_PKCS1_3072_SHA256 RSASSA-PKCS1-v1_5 の 3,072 ビットの鍵(SHA256 ダイジェストを使用)。
RSA_SIGN_PKCS1_4096_SHA256 RSASSA-PKCS1-v1_5 の 4,096 ビットの鍵(SHA256 ダイジェストを使用)。
RSA_SIGN_PKCS1_4096_SHA512 RSASSA-PKCS1-v1_5 の 4,096 ビットの鍵(SHA512 ダイジェストを使用)。
RSA_DECRYPT_OAEP_2048_SHA256 RSAES-OAEP の 2,048 ビットの鍵(SHA256 ダイジェストを使用)。
RSA_DECRYPT_OAEP_3072_SHA256 RSAES-OAEP の 3,072 ビットの鍵(SHA256 ダイジェストを使用)。
RSA_DECRYPT_OAEP_4096_SHA256 RSAES-OAEP の 4,096 ビットの鍵(SHA256 ダイジェストを使用)。
RSA_DECRYPT_OAEP_4096_SHA512 RSAES-OAEP の 4,096 ビットの鍵(SHA512 ダイジェストを使用)。
EC_SIGN_P256_SHA256 NIST P-256 曲線上の ECDSA(SHA256 ダイジェストを使用)。
EC_SIGN_P384_SHA384 NIST P-384 曲線上の ECDSA(SHA384 ダイジェストを使用)。

CryptoKeyVersionState

CryptoKeyVersion の状態で、使用できるかどうかを示します。

列挙型
CRYPTO_KEY_VERSION_STATE_UNSPECIFIED 指定なし。
PENDING_GENERATION このバージョンはまだ生成中です。使用、有効化、無効化、破棄はできません。バージョンが準備完了になると、Cloud KMS はこのバージョンを自動的に ENABLED とマークします。
ENABLED このバージョンは、暗号オペレーションに使用できます。
DISABLED このバージョンは使用できませんが、鍵のマテリアルは引き続き使用可能であり、バージョンを ENABLED の状態に戻すことができます。
DESTROYED このバージョンは破棄され、鍵のマテリアルは保存されなくなります。一度この状態になったバージョンは元に戻りません。
DESTROY_SCHEDULED このバージョンは破棄がスケジュールされており、まもなく破棄されます。RestoreCryptoKeyVersion を呼び出して DISABLED 状態に戻します。

CryptoKeyVersionView

CryptoKeyVersion のビュー。CryptoKeyVersionsKeyManagementService.ListCryptoKeyVersionsKeyManagementService.ListCryptoKeys)に返される詳細レベルを制御します。

列挙型
CRYPTO_KEY_VERSION_VIEW_UNSPECIFIED CryptoKeyVersion のデフォルト ビュー。attestation フィールドは含まれません。
FULL attestation を含む CryptoKeyVersion のすべてのフィールドを返します。

CryptoKeyVersionTemplate

CryptoKeyVersionTemplate では、CreateCryptoKeyVersion を使用して手動で新しい CryptoKeyVersion が作成されるか、自動ローテーションの結果として自動的に作成されたときに使用するプロパティを指定します。

フィールド
protection_level

ProtectionLevel

このテンプレートに基づいて CryptoKeyVersion を作成するときに使用する ProtectionLevel。不変。デフォルトは SOFTWARE です。

algorithm

CryptoKeyVersionAlgorithm

必須。このテンプレートに基づいて CryptoKeyVersion を作成するときに使用する Algorithm

このフィールドが省略され、CryptoKey.purposeENCRYPT_DECRYPT である場合、下位互換性を維持するため、GOOGLE_SYMMETRIC_ENCRYPTION が暗黙的に指定されます。

DecryptRequest

KeyManagementService.Decrypt に対するリクエスト メッセージ。

フィールド
name

string

必須。復号に使用する CryptoKey のリソース名。サーバーにより適切なバージョンが選択されます。

承認には、指定したリソースの name に対する次の Google IAM 権限が必要です。

  • cloudkms.cryptoKeyVersions.useToDecrypt

ciphertext

bytes

必須。EncryptResponse.ciphertext で返された暗号化データ。

additional_authenticated_data

bytes

EncryptRequest.additional_authenticated_data で提供されていたデータと一致している必要があるオプションのデータ。

DecryptResponse

KeyManagementService.Decrypt に対するレスポンス メッセージ。

フィールド
plaintext

bytes

EncryptRequest.plaintext で提供されたデータを復号した文字列。

DestroyCryptoKeyVersionRequest

KeyManagementService.DestroyCryptoKeyVersion に対するリクエスト メッセージ。

フィールド
name

string

破棄する CryptoKeyVersion のリソース名。

承認には、指定したリソースの name に対する次の Google IAM 権限が必要です。

  • cloudkms.cryptoKeyVersions.destroy

Digest

Digest は、暗号メッセージのダイジェストを保持します。

フィールド
Union フィールド digest。必須。メッセージ ダイジェスト。digest は、次のいずれかになります。
sha256

bytes

SHA-256 アルゴリズムで生成されたメッセージ ダイジェスト。

sha384

bytes

SHA-384 アルゴリズムで生成されたメッセージ ダイジェスト。

sha512

bytes

SHA-512 アルゴリズムで生成されたメッセージ ダイジェスト。

EncryptRequest

KeyManagementService.Encrypt に対するリクエスト メッセージ。

フィールド
name

string

必須。暗号化に使用する CryptoKey または CryptoKeyVersion のリソース名。

CryptoKey が指定されている場合、サーバーはその primary version を使用します。

承認には、指定したリソースの name に対する次の Google IAM 権限が必要です。

  • cloudkms.cryptoKeyVersions.useToEncrypt

plaintext

bytes

必須。暗号化するデータです。64 KiB 以下でなければなりません。

最大サイズは、鍵バージョンの protection_level によって異なります。SOFTWARE 鍵の場合、プレーン テキストは 64 KiB 以下でなければなりません。HSM 鍵の場合、プレーン テキストと additional_authenticated_data フィールドを合わせた長さが 8 KiB 以下でなければなりません。

additional_authenticated_data

bytes

オプションのデータ。指定されている場合は、DecryptRequest.additional_authenticated_data による復号化時にも提供される必要があります。

最大サイズは、鍵バージョンの protection_level によって異なります。SOFTWARE 鍵の場合、AAD は 64 KiB 以下でなければなりません。HSM 鍵の場合、プレーン テキストと additional_authenticated_data フィールドを合わせた長さが 8 KiB 以下でなければなりません。

EncryptResponse

KeyManagementService.Encrypt に対するレスポンス メッセージ。

フィールド
name

string

暗号化で使用する CryptoKeyVersion のリソース名。

ciphertext

bytes

暗号化されたデータ。

GetCryptoKeyRequest

KeyManagementService.GetCryptoKey に対するリクエスト メッセージ。

フィールド
name

string

取得する CryptoKeyname

承認には、指定したリソースの name に対する次の Google IAM 権限が必要です。

  • cloudkms.cryptoKeys.get

GetCryptoKeyVersionRequest

KeyManagementService.GetCryptoKeyVersion に対するリクエスト メッセージ。

フィールド
name

string

取得する CryptoKeyVersionname

承認には、指定したリソースの name に対する次の Google IAM 権限が必要です。

  • cloudkms.cryptoKeyVersions.get

GetKeyRingRequest

KeyManagementService.GetKeyRing に対するリクエスト メッセージ

フィールド
name

string

取得する KeyRingname

承認には、指定したリソースの name に対する次の Google IAM 権限が必要です。

  • cloudkms.keyRings.get

GetPublicKeyRequest

KeyManagementService.GetPublicKey に対するリクエスト メッセージ。

フィールド
name

string

取得する CryptoKeyVersion 公開鍵の name

承認には、指定したリソースの name に対する次の Google IAM 権限が必要です。

  • cloudkms.cryptoKeyVersions.viewPublicKey

KeyOperationAttestation

鍵オペレーションに関する HSM 生成証明書が含まれます。

フィールド
format

AttestationFormat

出力のみ。証明書データの形式。

content

bytes

出力のみ。鍵オペレーションの実行時に HSM から提供された証明書データ。

AttestationFormat

HSM によって提供される証明書の形式。

列挙型
ATTESTATION_FORMAT_UNSPECIFIED
CAVIUM_V1_COMPRESSED gzip で圧縮された Cavium HSM 証明書。この形式は Cavium によって定義されています。随時変更される可能性があります。

KeyRing

KeyRingCryptoKeys の最上位の論理グループです。

フィールド
name

string

出力のみ。KeyRing のリソース名。形式は projects/*/locations/*/keyRings/* です。

create_time

Timestamp

出力のみ。この KeyRing が作成された時刻。

ListCryptoKeyVersionsRequest

KeyManagementService.ListCryptoKeyVersions に対するリクエスト メッセージ。

フィールド
parent

string

必須。リストする CryptoKey のリソース名。形式は projects/*/locations/*/keyRings/*/cryptoKeys/* です。

承認には、指定したリソースの parent に対する次の Google IAM 権限が必要です。

  • cloudkms.cryptoKeyVersions.list

page_size

int32

レスポンスに含める CryptoKeyVersions の上限数。オプションです。それ以降の CryptoKeyVersions は、後続のリクエストに ListCryptoKeyVersionsResponse.next_page_token を含めることによって後で取得できます。指定していない場合は、適切なデフォルトが選択されます。

page_token

string

前の ListCryptoKeyVersionsResponse.next_page_token で返されたページ設定トークン。オプションです。

view

CryptoKeyVersionView

レスポンスに含めるフィールド。

ListCryptoKeyVersionsResponse

KeyManagementService.ListCryptoKeyVersions に対するレスポンス メッセージ。

フィールド
crypto_key_versions[]

CryptoKeyVersion

CryptoKeyVersions のリスト。

next_page_token

string

結果の次ページを取得するためのトークン。この値を ListCryptoKeyVersionsRequest.page_token で渡して、結果の次ページを取得します。

total_size

int32

クエリに一致した CryptoKeyVersions の総数。

ListCryptoKeysRequest

KeyManagementService.ListCryptoKeys に対するリクエスト メッセージ。

フィールド
parent

string

必須。リストする KeyRing のリソース名。形式は projects/*/locations/*/keyRings/* です。

承認には、指定したリソースの parent に対する次の Google IAM 権限が必要です。

  • cloudkms.cryptoKeys.list

page_size

int32

レスポンスに含める CryptoKeys の上限数。オプションです。それ以降の CryptoKeys は、後続のリクエストに ListCryptoKeysResponse.next_page_token を含めることによって後で取得できます。指定していない場合は、適切なデフォルトが選択されます。

page_token

string

前の ListCryptoKeysResponse.next_page_token で返されたページ設定トークン。オプションです。

version_view

CryptoKeyVersionView

レスポンスに含めるメイン バージョンのフィールド。

ListCryptoKeysResponse

KeyManagementService.ListCryptoKeys に対するレスポンス メッセージ。

フィールド
crypto_keys[]

CryptoKey

CryptoKeys のリスト。

next_page_token

string

結果の次ページを取得するためのトークン。この値を ListCryptoKeysRequest.page_token で渡して、結果の次ページを取得します。

total_size

int32

クエリに一致した CryptoKeys の総数。

ListKeyRingsRequest

KeyManagementService.ListKeyRings に対するリクエスト メッセージ。

フィールド
parent

string

必須。KeyRings に関連付けられているロケーションのリソース名。形式は projects/*/locations/* です。

承認には、指定したリソースの parent に対する次の Google IAM 権限が必要です。

  • cloudkms.keyRings.list

page_size

int32

レスポンスに含める KeyRings の上限数。オプションです。それ以降の KeyRings は、後続のリクエストに ListKeyRingsResponse.next_page_token を含めることによって後で取得できます。指定していない場合は、適切なデフォルトが選択されます。

page_token

string

前の ListKeyRingsResponse.next_page_token で返されたページ設定トークン。オプションです。

ListKeyRingsResponse

KeyManagementService.ListKeyRings に対するレスポンス メッセージ。

フィールド
key_rings[]

KeyRing

KeyRings のリスト。

next_page_token

string

結果の次ページを取得するためのトークン。この値を ListKeyRingsRequest.page_token で渡して、結果の次ページを取得します。

total_size

int32

クエリに一致した KeyRings の総数。

LocationMetadata

指定された google.cloud.location.Location の Cloud KMS メタデータ。

フィールド
hsm_available

bool

protection_levelHSMCryptoKeys をこのロケーションに作成できるかどうかを示します。

ProtectionLevel

ProtectionLevel では、暗号オペレーションの実行方法を指定します。

列挙型
PROTECTION_LEVEL_UNSPECIFIED 指定なし。
SOFTWARE 暗号オペレーションをソフトウェアで行います。
HSM 暗号オペレーションをハードウェア セキュリティ モジュールで行います。

PublicKey

指定した CryptoKeyVersion の公開鍵。GetPublicKey で取得します。

フィールド
pem

string

PEM 形式でエンコードされた公開鍵。詳しくは、一般的な考慮事項RFC 7468 セクションと主体者公開鍵情報のテキスト エンコーディングをご覧ください。

algorithm

CryptoKeyVersionAlgorithm

この鍵に関連付けられている Algorithm

RestoreCryptoKeyVersionRequest

KeyManagementService.RestoreCryptoKeyVersion に対するリクエスト メッセージ。

フィールド
name

string

復元する CryptoKeyVersion のリソース名。

承認には、指定したリソースの name に対する次の Google IAM 権限が必要です。

  • cloudkms.cryptoKeyVersions.restore

UpdateCryptoKeyPrimaryVersionRequest

KeyManagementService.UpdateCryptoKeyPrimaryVersion に対するリクエスト メッセージ.

フィールド
name

string

更新する CryptoKey のリソース名。

承認には、指定したリソースの name に対する次の Google IAM 権限が必要です。

  • cloudkms.cryptoKeys.update

crypto_key_version_id

string

メインとして使用する子の CryptoKeyVersion の ID。

UpdateCryptoKeyRequest

KeyManagementService.UpdateCryptoKey に対するリクエスト メッセージ。

フィールド
crypto_key

CryptoKey

更新された値を持つ CryptoKey

承認には、指定したリソースの cryptoKey に対する次の Google IAM 権限が必要です。

  • cloudkms.cryptoKeys.update

update_mask

FieldMask

このリクエストで更新が必要なフィールドのリスト。

UpdateCryptoKeyVersionRequest

KeyManagementService.UpdateCryptoKeyVersion に対するリクエスト メッセージ。

フィールド
crypto_key_version

CryptoKeyVersion

更新された値を持つ CryptoKeyVersion

承認には、指定したリソースの cryptoKeyVersion に対する次の Google IAM 権限が必要です。

  • cloudkms.cryptoKeyVersions.update

update_mask

FieldMask

このリクエストで更新が必要なフィールドのリスト。

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Cloud KMS ドキュメント