REST リソース: projects.locations.keyRings.cryptoKeys.cryptoKeyVersions

リソース: CryptoKeyVersion

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

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

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

JSON 表現

{
  "name": string,
  "state": enum(CryptoKeyVersionState),
  "protectionLevel": enum(ProtectionLevel),
  "algorithm": enum(CryptoKeyVersionAlgorithm),
  "attestation": {
    object(KeyOperationAttestation)
  },
  "createTime": string,
  "generateTime": string,
  "destroyTime": string,
  "destroyEventTime": string
}
フィールド
name

string

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

state

enum(CryptoKeyVersionState)

CryptoKeyVersion の現在の状態。

protectionLevel

enum(ProtectionLevel)

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

algorithm

enum(CryptoKeyVersionAlgorithm)

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

attestation

object(KeyOperationAttestation)

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

createTime

string(Timestamp 形式)

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

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒。例: "2014-10-02T15:01:23.045123456Z"

generateTime

string(Timestamp 形式)

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

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒。例: "2014-10-02T15:01:23.045123456Z"

destroyTime

string(Timestamp 形式)

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

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒。例: "2014-10-02T15:01:23.045123456Z"

destroyEventTime

string(Timestamp 形式)

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

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒。例: "2014-10-02T15:01:23.045123456Z"

CryptoKeyVersionState

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

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

KeyOperationAttestation

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

JSON 表現

{
  "format": enum(AttestationFormat),
  "content": string
}
フィールド
format

enum(AttestationFormat)

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

content

string (bytes format)

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

base64 でエンコードされた文字列。

AttestationFormat

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

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

メソッド

asymmetricDecrypt

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

asymmetricSign

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

create

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

destroy

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

get

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

getPublicKey

指定した CryptoKeyVersion の公開鍵を返します。

list

CryptoKeyVersions をリストします。

patch

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

restore

DESTROY_SCHEDULED 状態の CryptoKeyVersion を復元します。
このページは役立ちましたか?評価をお願いいたします。

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

Cloud KMS ドキュメント