顧客管理の暗号鍵（CMEK）の使用

MySQL | PostgreSQL | SQL Server

このページでは、顧客管理の暗号鍵のサービスアカウントと鍵の設定方法と、顧客管理の暗号鍵を使用するインスタンスの作成方法について説明します。Cloud SQL で顧客管理の暗号鍵を使用する方法の詳細は、顧客管理の暗号鍵の概要を参照してください。

始める前に

Google Cloud アカウントにログインします。Google Cloud を初めて使用する場合は、アカウントを作成して、実際のシナリオでの Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。

Google Cloud Console の [プロジェクトセレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

注: この手順で作成するリソースをそのまま保持する予定でない場合、既存のプロジェクトを選択するのではなく、新しいプロジェクトを作成してください。チュートリアルの終了後にそのプロジェクトを削除すれば、プロジェクトに関連するすべてのリソースを削除できます。

プロジェクトセレクタに移動

Cloud プロジェクトに対して課金が有効になっていることを確認します。プロジェクトに対して課金が有効になっていることを確認する方法を学習する。

Cloud SDK をインストールして初期化します。

ユーザーアカウントに Cloud SQL 管理者のロールがあることを確認します。
IAM ページに移動

Cloud Key Management Service API を有効にします。
API を有効にする

Cloud SQL Admin API を有効にします。
API を有効にする

CMEK を使用して Cloud SQL インスタンスを作成するためのワークフロー

gcloud と API ユーザーのみ: 顧客管理の暗号鍵が必要なプロジェクトごとにサービスアカウントを作成します。
キーリングと鍵を作成し、鍵ごとに場所を設定します。
gcloud と API ユーザーのみ: サービスアカウントに鍵へのアクセス権を付与します。
鍵の鍵 ID（KMS_RESOURCE_ID）と場所、キーリングの ID（KMS_RESOURCE_ID）をコピーするか書き留めます。この情報は、サービスアカウントに鍵へのアクセスを付与するときに必要になります。
プロジェクトに移動して、次のオプションを使用して Cloud SQL インスタンスを作成します。
1. 顧客管理の暗号鍵と同じ場所
2. 顧客管理の暗号鍵の構成
3. 顧客管理の暗号鍵 ID

CMEK で Cloud SQL インスタンスが有効になります。

サービスアカウントの作成

顧客管理の暗号鍵が必要なプロジェクトごとにサービスアカウントを作成する必要があります。

ユーザーがサービスアカウントを管理できるようにするには、次のいずれかのロールを付与します。

サービスアカウントユーザー（roles/iam.serviceAccountUser）: サービスアカウントを一覧表示する権限、サービスアカウントの詳細を取得する権限、サービスアカウントの権限借用の権限が含まれます。
サービスアカウント管理者（roles/iam.serviceAccountAdmin）: サービスアカウントを一覧表示する権限、サービスアカウントの詳細を取得する権限が含まれます。サービスアカウントの作成、更新、削除に加え、サービスアカウントの Cloud SQL for PostgreSQL ポリシーを表示または変更する権限も含まれます。

現在使用できるのは、gcloud コマンドラインツールコマンドを使用して、顧客管理の暗号鍵に必要なサービスアカウントの種類を作成する方法だけです。Console を使用している場合は、Cloud SQL がこのサービスアカウントを自動的に作成します。

サービスアカウントを作成するには gcloud コマンドラインツールで次のコマンドを実行します。

gcloud beta services identity create --service=sqladmin.googleapis.com \
             --project=[USER_PROJECT]

このコマンドは、次の形式でサービスアカウント名を返します。

service-[PROJECT_NUMBER]@gcp-sa-cloud-sql.iam.gserviceaccount.com

例:

service-534582264470@gcp-sa-cloud-sql.iam.gserviceaccount.com

このサービスアカウント名は、サービスアカウントへの鍵へのアクセス権の付与の手順で使用します。

鍵の作成

注: Cloud EKM サービスを使用して CMEK で外部管理の鍵を使用すると、Cloud KMS から鍵を使用できます。詳細については、外部鍵を作成するをご覧ください。

鍵は、Cloud SQL インスタンスと同じ Google Cloud プロジェクトで作成するか、別のユーザープロジェクトで作成します。Cloud KMS キーリングの場所は、Cloud SQL インスタンスを作成するリージョンと一致する必要があります。マルチリージョンまたはグローバルリージョン鍵は使用できません。リージョンが一致しない場合、Cloud SQL インスタンスの作成リクエストは失敗します。

Cloud KMS 鍵を作成するには:

Console

[暗号鍵] ページに移動します。
[暗号鍵] ページに移動
[キーリングを作成] をクリックします。
[キーリング名] を追加します。この名前はサービスアカウントに鍵へのアクセスを付与するときに必要になるため、書き留めておきます。
[キーリングの場所] を追加します。
[作成] をクリックします。[鍵の作成] ページが開きます。
[鍵の名前] を追加します。
[目的] を選択します（対称または非対称）。
[ローテーション期間] と [開始日] を選択します。
[作成] をクリックします。
[鍵] のテーブルで、最後の列の 3 つのドットをクリックし、[リソース ID をコピー] を選択するか、書き留めます。これが KMS_RESOURCE_ID です。KMS_RESOURCE_ID は、サービスアカウントに鍵へのアクセスを付与するときに必要になります。

gcloud

新しいキーリングを作成します。
```
     gcloud kms keyrings create [KEYRING_NAME] --location [LOCATION]
  
```
この名前はサービスアカウントに鍵へのアクセスを付与するときに必要になるため、書き留めておきます。
キーリングで鍵を作成します。
```
     gcloud kms keys create [KEY_NAME] --location [LOCATION] \
           --keyring [KEYRING_NAME] --purpose encryption
     
```
この名前はサービスアカウントに鍵へのアクセスを付与するときに必要になるため、書き留めておきます。

サービスアカウントへの鍵のアクセス権の付与

この手順は、gcloud または API を使用する場合にのみ必要です。

サービスアカウントへのアクセス権を付与するには:

  gcloud kms keys add-iam-policy-binding 

         [KEY_NAME] --location [LOCATION] --keyring [KEY_RING_NAME] 

         --member serviceAccount:service-[PROJECT_NUMBER]@gcp-sa-cloud-sql.iam.gserviceaccount.com 

         --role roles/cloudkms.cryptoKeyEncrypterDecrypter

CMEK を使用した Cloud SQL インスタンスの作成

顧客管理の暗号鍵を使用してインスタンスを作成するには:

Console

Google Cloud Console の [Cloud SQL インスタンス] ページに移動します。
[Cloud SQL インスタンス] ページに移動
[インスタンスを作成] をクリックします。
データベースエンジンを選択します。
インスタンスの名前を入力します。インスタンス名には機密情報や個人を特定できる情報を含めないでください。インスタンス名は外部から閲覧可能です。インスタンス名にプロジェクト ID を含める必要はありません。これは、必要に応じて自動的に（ログファイルなどに）作成されます。
'root'@'%' ユーザーのパスワードを入力します。
インスタンスのリージョンを設定します。インスタンスにアクセスするリソースと同じリージョンにインスタンスを配置します。ほとんどの場合、ゾーンを指定する必要はありません。
[構成オプション] で、[マシンタイプとストレージ] が表示されるまですべての構成オプションを選択します。
[マシンタイプとストレージ] を展開します。
[暗号化] で、[顧客管理の暗号鍵] を選択します。
プルダウンメニューから KMS 鍵を選択するか、KMS_RESOURCE_ID を手動で入力します。インスタンスと同じプロジェクトとリージョン内の KMS 鍵のみが表示されます。同じリージョンにあるものの異なるプロジェクトに属している KMS 鍵を選択するには、[鍵が表示されない場合は、鍵のリソース ID を入力してください。] を選択し、先ほど取得した KMS_RESOURCE_ID を入力します。
選択した鍵で暗号化 / 復号を行う権限がサービスアカウントにない場合、メッセージが表示されます。この場合は、[付与] をクリックして、サービスアカウントに選択した KMS 鍵に対する Cloud IAM ロールを付与します。 IAM role on the selected KMS key.
構成オプションを選択したら、[作成] をクリックします。
顧客管理の暗号鍵を使用する場合の影響を説明するメッセージが表示されます。メッセージを確認して理解したうえで、インスタンスの作成に進みます。

gcloud

  gcloud sql instances create [INSTANCE_NAME] \
  --project [PROJECT_ID] \
  --disk-encryption-key [KMS_RESOURCE_ID] \
  --database-version=[VERSION] \
  --cpu=[NUMBER_CPUS] \
  --memory=[MEMORY_SIZE]
  --region=[REGION] \
  --root-password=[INSERT-PASSWORD-HERE]

REST API v1beta4

顧客管理の暗号鍵を使用してインスタンスを作成するには、diskEncryptionConfiguration をコマンドに渡します。

後述のリクエストのデータを使用する前に、次のように置き換えます。

project-id: プロジェクト ID
instance-id: インスタンス ID
region: リージョン
database-version: バージョンの列挙型文字列（POSTGRES_12 など）
kms-resource-id: 鍵の作成から受け取った ID。

HTTP メソッドと URL:

POST https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances

JSON 本文のリクエスト:

{
  "name":"instance-id",
  "region":"region",
  "databaseVersion": "database-version",
  "diskEncryptionConfiguration" :
  {
      "kmsKeyName" : "kms-resource-id"
  },
  "settings":
  {
     "backupConfiguration":
      {
         "pointInTimeRecoveryEnabled": true,
         "enabled":true
      }
   }
}

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 以下のコマンドでは、ご利用のユーザーアカウントで gcloud を認証する際に gcloud init または gcloud auth login を使用していることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

curl -X POST \
-H "Authorization: Bearer "$(gcloud auth print-access-token) \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances

PowerShell（Windows）

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
  -Method POST `
  -Headers $headers `
  -ContentType: "application/json; charset=utf-8" `
  -InFile request.json `
  -Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2020-01-16T02:32:12.281Z",
  "operationType": "UPDATE",
  "name": "operation-id",
  "targetId": "instance-id",
  "selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/operations/operation-id",
  "targetProject": "project-id"
}

この REST API は、Instances:Insert を使用します。

CMEK 対応インスタンスのバックアップの作成

Cloud SQL インスタンスのバックアップを作成すると、バックアップは、プライマリインスタンスの顧客管理の暗号鍵と同じ主キーのバージョンで暗号化されます。

オンデマンドバックアップと自動バックアップの作成と管理をご覧ください。

[バックアップの作成] フォームに次のメッセージが表示されます。「バックアップは、このインスタンスの顧客管理の暗号鍵のメインバージョンを使用して暗号化されます。誰かがこの鍵のバージョンを破棄するか無効にすると、この鍵のバージョンを使用して暗号化されているすべてのデータが完全に失われます。鍵のメインのバージョンは、Cloud KMS で確認できます。」

バックアップページで、顧客管理の暗号鍵が有効になっているバックアップのリストには列が 2 つ追加されています。CMEK 対応インスタンスのバックアップであることを示す列と、バックアップの暗号化に使用された鍵バージョンを示す列です。

CMEK 対応インスタンスのレプリカの作成

Cloud SQL インスタンスのリードレプリカを同じリージョン内に作成すると、親インスタンスと同じ顧客管理の暗号鍵を継承します。別のリージョンにリードレプリカを作成すると、顧客管理の暗号鍵の新しいリストから選択できます。リージョンごとに独自の鍵セットが使用されます。

リードレプリカの作成をご覧ください。

[リードレプリカの作成] ページには、次の情報が表示されます。

[暗号化] には、[顧客管理] と表示されます。
レプリカの暗号鍵が表示されます。
次のメッセージが表示されます。「レプリカは、プライマリインスタンスの顧客管理の暗号鍵を使用して暗号化されます。誰かがこの鍵を破棄すると、この鍵を使用して暗号化されているすべてのデータが完全に失われます。」

クロスリージョンレプリカの場合、次のメッセージが表示されます。

「クロスリージョンレプリカは、選択した顧客管理の暗号鍵を使用して暗号化されます。誰かがこの鍵を破棄すると、この鍵を使用して暗号化されているすべてのデータが完全に失われます。」

CMEK 対応インスタンスのクローンの作成

Cloud SQL インスタンスのクローンを作成すると、ソースインスタンスの暗号化に使用したのと同じ顧客管理の暗号鍵を継承します。

インスタンスのクローンを作成するをご覧ください。

[クローンの作成] ページに、次の情報が表示されます。

[暗号化] には、[顧客管理] と表示されます。
クローンの暗号鍵が表示されます。
次のメッセージが表示されます。「クローンは、ソースインスタンスの顧客管理の暗号鍵を使用して暗号化されます。誰かがこの鍵を破棄すると、この鍵を使用して暗号化されているすべてのデータが完全に失われます。」

CMEK 対応インスタンスの鍵情報の表示

Cloud SQL インスタンスが正常に作成されたら、インスタンスリストまたはインスタンスの概要ページで、顧客管理の暗号鍵を使用してインスタンスが作成されたことを確認できます。詳細には、インスタンスの作成に使用された鍵も表示されます。

[Cloud SQL インスタンス] ページに移動します。

[Cloud SQL インスタンス] ページに移動
[インスタンス] リストで、[暗号化] 列が表示されるまで右にスクロールします。この列には、[Google が管理] および [顧客管理] と表示されます。
インスタンスの名前をクリックして [概要] ページを開きます。顧客管理の暗号鍵が [構成] ペインに表示されます。

鍵バージョンの無効化と再有効化

次のトピックをご覧ください。

トラブルシューティング

ここでは、CMEK 対応インスタンスの設定中または使用中にエラーメッセージが表示された場合の対処方法について説明します。

Cloud KMS エラーやロールまたは権限がないために、作成、クローン作成、更新などの Cloud SQL 管理者のオペレーションが失敗する場合があります。失敗の一般的な理由には、Cloud KMS 鍵バージョンがない、Cloud KMS 鍵バージョンが無効かまたは破棄されている、Cloud KMS 鍵バージョンにアクセスするための IAM 権限が不足している、Cloud KMS 鍵バージョンが Cloud SQL インスタンスと別のリージョンにあるなどがあります。一般的な問題を診断して解決するには、次のトラブルシューティングの表を使用しください。

顧客管理の暗号鍵のトラブルシューティングの表

エラー:	次のような問題が考えられます...	次のことを試します...
プロダクトごと、プロジェクトごとのサービスアカウントが見つかりません	サービスアカウント名が正しくありません。	正しいユーザープロジェクトのサービスアカウントが作成されていることを確認します。 [サービスアカウント] ページに移動
サービスアカウントへのアクセスを許可できません	ユーザーアカウントに、この鍵バージョンへのアクセスを許可する権限がありません。	ユーザーアカウントまたはサービスアカウントで組織管理者のロールを追加してください。 IAM アカウントのページに移動
Cloud KMS 鍵バージョンが破棄されています	鍵バージョンが破棄されています。	鍵バージョンが破棄されている場合、データの暗号化や復号に使用できません。
Cloud KMS 鍵バージョンが無効です	鍵バージョンが無効です。	Cloud KMS 鍵バージョンを再度有効にします。暗号鍵のページに移動
Cloud KMS 鍵を使用するための十分な権限がありません	Cloud SQL インスタンスへのオペレーションの実行に使用しているユーザーアカウントまたはサービスアカウントに `cloudkms.cryptoKeyEncrypterDecrypter` のロールがないか、Cloud KMS 鍵バージョンが存在しません。	ユーザーアカウントまたはサービスアカウントに `cloudkms.cryptoKeyEncrypterDecrypter` のロールを追加します。 IAM アカウントのページに移動アカウントにすでにロールがある場合は、鍵の作成を参照して、新しい鍵バージョンの作成方法を確認してください。注を参照。
Cloud KMS 鍵が見つかりません	鍵バージョンが存在しません。	新しい鍵バージョンを作成します。鍵の作成をご覧ください。注を参照。
Cloud SQL インスタンスと Cloud KMS 鍵バージョンが異なるリージョンにあります	Cloud KMS 鍵バージョンと Cloud SQL インスタンスは同じリージョン内にある必要があります。Cloud KMS 鍵バージョンがグローバルリージョンまたはマルチリージョンにある場合は機能しません。	インスタンスを作成するリージョンと同じリージョンに鍵バージョンを作成します。鍵の作成をご覧ください。注を参照。

注: create オペレーション中にインスタンスがエラー状態になった場合、インスタンスを削除し、使用しているアカウントにロールを追加して、アクティブな Cloud KMS 鍵バージョンを持つ新しいインスタンスを作成する必要があります。

顧客管理の暗号鍵（CMEK）の使用

始める前に

CMEK を使用して Cloud SQL インスタンスを作成するためのワークフロー

サービス アカウントの作成

鍵の作成

Console

gcloud

サービス アカウントへの鍵のアクセス権の付与

CMEK を使用した Cloud SQL インスタンスの作成

Console

gcloud

REST API v1beta4

curl（Linux、macOS、Cloud Shell）

PowerShell（Windows）

CMEK 対応インスタンスのバックアップの作成

CMEK 対応インスタンスのレプリカの作成

CMEK 対応インスタンスのクローンの作成

CMEK 対応インスタンスの鍵情報の表示

鍵バージョンの無効化と再有効化

トラブルシューティング

顧客管理の暗号鍵のトラブルシューティングの表

次のステップ

サービスアカウントの作成

サービスアカウントへの鍵のアクセス権の付与