メソッド: cryptoKeys.encrypt

フルネーム: projects.locations.keyRings.cryptoKeys.encrypt

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

HTTP リクエスト

POST https://cloudkms.googleapis.com/v1/{name=projects/*/locations/*/keyRings/*/cryptoKeys/**}:encrypt

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

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

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

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

  • cloudkms.cryptoKeyVersions.useToEncrypt

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現

{
  "plaintext": string,
  "additionalAuthenticatedData": string
}
フィールド
plaintext

string (bytes format)

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

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

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

additionalAuthenticatedData

string (bytes format)

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

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

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

レスポンスの本文

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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

JSON 表現

{
  "name": string,
  "ciphertext": string
}
フィールド
name

string

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

ciphertext

string (bytes format)

暗号化されたデータ。

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

承認スコープ

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

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

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

試してみましょう

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

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

Cloud KMS ドキュメント