KMSを使用したデータの暗号化

重要

サーバーレスインスタンスで使用できない機能

サーバーレスインスタンスは現時点ではこの機能をサポートしていません。詳しくは、「サーバーレスインスタンスの制限」を参照してください。

Atlas は、デフォルトで保管中のすべてのクラスターストレージとスナップショットボリュームを暗号化します。クラウドプロバイダーの KMSと MongoDB暗号化ストレージエンジンを併用することで、セキュリティをさらに強化できます。

Atlas での保管時の暗号化には、次のカスタマーKMSプロバイダーの 1 つ以上を使用できます。

注意

キー管理プロバイダーは、クラスタークラウドサービスプロバイダーと同じである必要はありません。

Atlas でKMSを使用する方法の詳細については、以下を参照してください。

Atlas Kubernetes Operator を使用して KMS 暗号化を管理するには、カスタムspec.encryptionAtRest リソースAtlasProject のパラメータを指定して更新します。サポートされているカスタムリソースのいずれかでspecフィールドを変更するたびに、Atlas Kubernetes Operator は対応する Atlas 構成を作成または更新します。

前提条件

Amazon Web ServicesKMSでAtlas Kubernetes Operator を使用して保管時の暗号化を設定するには、次のものが必要です。

Atlas Kubernetes Operatorが配置された実行中の Kubernetes クラスター。
Atlas のProject OwnerまたはOrganization Ownerロール。
Amazon Web Services KMS の有効なキー管理認証情報と暗号化のキー。詳細については、「 Amazon Web Servicesでカスタマーマネージドキーを有効にするための前提条件」を参照してください。
Atlas アカウントの想定されたIAMロール。 Atlas Kubernetes Operator を使用して想定されたIAMロールを設定するには、「統合クラウドプロバイダー統合の設定」を参照してください。 Amazon Web Services暗号化のキーのロールベースのアクセスの詳細については、「 Amazon Web Services KMSによるカスタマーキーの管理」を参照してください。

重要

暗号化キーをロールベースのアクセスに切り替えた場合、そのプロジェクトでは、ロールベースのアクセス構成を取り消して、暗号化のキーの認証情報ベースのアクセスに戻すことはできません。

Atlas Kubernetes Operator でAzure Key Vault を使用して保管時の暗号化を構成するには、次のものが必要です。

Atlas Kubernetes Operatorが配置された実行中の Kubernetes クラスター。
Atlas のProject OwnerまたはOrganization Ownerロール。
Azure Key Vault の有効なキー管理認証情報と暗号化のキー。詳しくは、「 Azureでカスタマーマネージドキーを有効にするための前提条件」を参照してください。

Google Cloud PlatformKMSでAtlas Kubernetes Operator を使用して保管時の暗号化を構成するには、次の手順を実行する必要があります。

Atlas Kubernetes Operatorが配置された実行中の Kubernetes クラスター。
Atlas のProject OwnerまたはOrganization Ownerロール。
Google Cloud Platform KMS の有効なキー管理認証情報と暗号化のキー。詳しくは、「 Google Cloud Platformでカスタマーマネージドキーを有効にするための前提条件」を参照してください。

手順

次の手順で、カスタマーマネージドキーを使用して Atlas データを暗号化します。

Amazon Web Services の認証情報を使用してシークレットを作成します。

次のパラメーターの値でシークレットを作成します。

Parameter	説明
`customerMasterKeyID`	マスターキーを暗号化および復号化するために使用する Amazon Web ServicesカスタマーstringMongoDB マスターキーを識別する一意の英数字。
`region`	CMK が存在するAmazon Web Servicesリージョンを示すラベル。
`roleId`	カスタマーマスターAmazon Web Services Amazon Web Servicesキーを管理する権限を持つAmazon Web Services IAM ロールを識別する一意の ARN 。この値を見つけるには、次の手順に従います。 GoRolesAmazon Web Servicesマネジメントコンソールの {0 セクションにします。 Atlas アクセス用に編集または作成したIAMロールをクリックします。 Amazon Web Servicesでは、Summary セクションにARNが表示されます。

シークレットを作成してラベルを付けるには、 Amazon Web Servicesの認証情報を使用して次のコマンドを実行します。

kubectl create secret generic aws-ear-creds \
  --from-literal="customerMasterKeyID=<customer-master-key>" \
  --from-literal="region=<aws-region>" \
  --from-literal="roleId=<aws-arn>" \
  -n mongodb-atlas-system

kubectl label secret aws-ear-creds atlas.mongodb.com/type=credentials -n mongodb-atlas-system

`spec.encryptionAtRest.awsKms`パラメータを指定します。

次のパラメータを含む AtlasProjectカスタム spec.encryptionAtRest.awsKms spec.encryptionAtRestリソースの配列にオブジェクトを追加します。

Parameter	説明
`spec.encryptionAtRest.awsKms.enabled`	このプロジェクトがAmazon Web Services KMSを使用して保管中のデータを暗号化するかどうかを示すフラグ。 Amazon Web Services KMSを使用して保管時の暗号化を有効にするには、このパラメータを `true` に設定します。 Amazon Web Services KMSを使用して保管時の暗号化を無効にするには、このパラメータを `false` に設定します。 Amazon Web Services KMSを使用して保管時の暗号化を無効にすると、 Atlas Kubernetes Operatorは構成の詳細を削除します。
`spec.encryptionAtRest.awsKms.secretRef.name`	Amazon Web Servicesの認証情報を含むシークレットの名前。
`spec.encryptionAtRest.awsKms.secretRef.namespace`	Amazon Web Servicesの認証情報を含む名前空間。指定されていない場合、このパラメータはデフォルトで`AtlasProject`カスタムリソースの名前空間になります。

次のパラメータの代わりに、customerMasterKeyID、region、roleId の値を含むシークレットを使用することを推奨します。

spec.encryptionAtRest.awsKms.customerMasterKeyID
spec.encryptionAtRest.awsKms.region
spec.encryptionAtRest.awsKms.roleId

次のコマンドを実行します:

cat <<EOF | kubectl apply -f -
apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
  name: my-project
  labels:
    app.kubernetes.io/version: 1.6.0
spec:
  name: Test Atlas Operator Project
  encryptionAtRest:
    awsKms:
      enabled: true
      secretRef:
        name: aws-ear-creds
        namespace: mongodb-atlas-system
EOF

プロジェクトで保管時の暗号化が正常に有効になっているかどうかを確認します。

次のコマンドを実行して、 Atlas Kubernetes OperatorがプロジェクトのAmazon Web Services KMS構成を検出しているかどうかを確認します。

kubectl get atlasprojects my-project -o=jsonpath='{.status.conditions[?(@.type=="EncryptionAtRestReadyType")].status}

true

クラスターのカスタマーマネージドキーを使用して保管時の暗号化を有効にします。

プロジェクトでカスタマーマネージドキーを使用して保管時の暗号化を有効にした後、データを暗号化するには、クラスターレベルで有効にする必要があります。

次のコマンドを実行して、 spec.deploymentSpec.encryptionAtRestProviderをAtlasDeployment カスタムリソースに追加します。これにより、このクラスターのAmazon Web Servicesキーを使用した保管時の暗号化が有効になります。

cat <<EOF | kubectl apply -f -
      apiVersion: atlas.mongodb.com/v1
      kind: AtlasDeployment
      metadata:
        name: my-cluster
      spec:
        name: Test Atlas Operator Cluster
        DeploymentSpec:
          encryptionAtRestProvider: "AWS"
      EOF

Azure認証情報を使用してシークレットを作成します。

次のパラメーターの値でシークレットを作成します。

Parameter	説明
`azureEnvironment`	Azure アカウント認証情報が存在する Azure 配置のロケーション。有効な値は`AZURE` 、 `AZURE_CHINA` 、 `AZURE_GERMANY`です。
`clientID`	アプリケーションを識別する一意の Azure36 桁の 16 進数文字。string
`keyIdentifier`	Azure Key Vault を識別する一意のキーを持つウェブアドレス。
`keyVaultName`	stringキーを含むAzure Key Vault を識別する一意の。
`resourceGroupName`	Azure Key Vault を含む Azure リソースグループを識別するラベル。Azureでは、リソースグループの詳細ページにリソースグループ名が表示されます。
`subscriptionID`	サブスクリプションを識別する一意の Azure36桁の 16 進数文字。stringAzureでは、サブスクリプションの詳細ページにサブスクリプション ID が表示されます。

シークレットを作成してラベルを付けるには、 Azure認証情報を使用して次のコマンドを実行します。

kubectl create secret generic azure-ear-creds \
  --from-literal="azureEnvironment=<deployment-locationy>" \
  --from-literal="clientID=<azure-app>" \
  --from-literal="keyIdentifier=<web-address>" \
  --from-literal="keyVaultName=<key-vault>" \
  --from-literal="resourceGroupName=<resource-group>" \
  --from-literal="subscriptionID=<subscription>" \
  -n mongodb-atlas-system

kubectl label secret azure-ear-creds atlas.mongodb.com/type=credentials -n mongodb-atlas-system

`spec.encryptionAtRest.azureKeyVault`パラメータを指定します。

次のパラメータを含む AtlasProjectカスタム spec.encryptionAtRest.azureKeyVault spec.encryptionAtRestリソースの配列にオブジェクトを追加します。

Parameter	説明
`spec.encryptionAtRest.azureKeyVault.` `enabled`	このプロジェクトがAzure Key Vault を使用して保管中のデータを暗号化するかどうかを示すフラグ。 Azure Key Vault を使用して保管時の暗号化を有効にするには、このパラメータを`true`に設定します。 Azure Key Vault を使用して保管時の暗号化を無効にするには、このパラメータを`false`に設定します。 Azure key vault を使用して保管時の暗号化を無効にすると、Atlas Kubernetes Operator によって構成の詳細が削除されます。
`spec.encryptionAtRest.azureKeyVault.` `secret`	`spec.encryptionAtRest.azureKeyVault.tenantID`で指定したAzure Key Vault テナントに関連付けられたプライベートデータ。
`spec.encryptionAtRest.azureKeyVault.` `tenantID`	Unique 36-hexadecimal character string that identifies the Azure Active Directory tenant within your Azure subscription. Azureは、テナントプロパティページにテナント ID を表示します。
`spec.encryptionAtRest.azureKeyVault.secretRef.name`	Azure認証情報を含むシークレットの名前。
`spec.encryptionAtRest.azureKeyVault.secretRef.namespace`	Azure認証情報を含む名前空間。指定されていない場合、このパラメータはデフォルトで`AtlasProject`カスタムリソースの名前空間になります。

次のパラメータの代わりに、azureEnvironment、clientID、keyIdentifier、keyVaultName、resourceGroupName、subscriptionID の値を含むシークレットを使用することをお勧めします。

spec.encryptionAtRest.azureKeyVault.azureEnvironment
spec.encryptionAtRest.azureKeyVault.clientID
spec.encryptionAtRest.azureKeyVault.keyIdentifier
spec.encryptionAtRest.azureKeyVault.keyVaultName
spec.encryptionAtRest.azureKeyVault.resourceGroupName
spec.encryptionAtRest.azureKeyVault.subscriptionID

次のコマンドを実行します:

cat <<EOF | kubectl apply -f -
apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
  name: my-project
spec:
  name: Test Atlas Operator Project
  encryptionAtRest:
    azureKeyVault:
      enabled: true
      secret: "EXAMPLESECRET"
      tenantID: "e8e4b6ba-ff32-4c88-a9af-EXAMPLEID"
      secretRef:
        name: azure-ear-creds
        namespace: mongodb-atlas-system
EOF

プロジェクトで保管時の暗号化が正常に有効になっているかどうかを確認します。

次のコマンドを実行して、Atlas Kubernetes Operator がプロジェクトのAzure Key Vault 構成を検出しているかどうかを確認します。

kubectl get atlasprojects my-project -o=jsonpath='{.status.conditions[?(@.type=="EncryptionAtRestReadyType")].status}

true

クラスターのカスタマーマネージドキーを使用して保管時の暗号化を有効にします。

次のコマンドを実行して、 spec.deploymentSpec.encryptionAtRestProviderをAtlasDeploymentカスタムリソースに追加します。これにより、このクラスターのAzureキーを使用した保管時の暗号化が有効になります。

cat <<EOF | kubectl apply -f -
      apiVersion: atlas.mongodb.com/v1
      kind: AtlasDeployment
      metadata:
        name: my-cluster
      spec:
        name: Test Atlas Operator Cluster
        DeploymentSpec:
          encryptionAtRestProvider: "AZURE"
      EOF

Google Cloud Platform の認証情報を使用してシークレットを作成します。

次のパラメーターの値でシークレットを作成します。

Parameter	説明
`keyVersionResourceID`	のキーバージョンリソースを表示する一意のリソースID Google Cloud PlatformKMSパス。
`serviceAccountKey`	JSONGoogle Cloud PlatformKMSアカウントの認証情報を含むGoogle Cloud Platform ファイル。重要: JSONオブジェクトは適切に形式する必要があります。ファイル内の認証情報フィールドを適切にインデントしていることを確認してください。

次の例は、 serviceAccountKey JSONファイルの内容を示しています。

{
  "type": "service_account",
  "project_id": "my-project-common-0",
  "private_key_id": "e120598ea4f88249469fcdd75a9a785c1bb3\",
  "private_key": "-----BEGIN PRIVATE KEY-----\\nMIIEuwIBA(truncated)SfecnS0mT94D9\\n-----END PRIVATE KEY-----\\n\",
  "client_email": "my-email-kms-0@my-project-common-0.iam.gserviceaccount.com\",
  "client_id": "10180967717292066",
  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
  "token_uri": "https://accounts.google.com/o/oauth2/token",
  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/my-email-kms-0%40my-project-common-0.iam.gserviceaccount.com"
  "universe_domain": "googleapis.com"
}

シークレットを作成してラベルを付けるには、 Google Cloud Platformの認証情報を使用して次のコマンドを実行します。

kubectl create secret generic azure-ear-creds \
  --from-literal="keyVersionResourceID=<resource-id>" \
  --from-file="serviceAccountKey=<your-service-account-key-files.json>" \
  -n mongodb-atlas-system

kubectl label secret gcp-ear-creds atlas.mongodb.com/type=credentials -n mongodb-atlas-system

`spec.encryptionAtRest.googleCloudKms`パラメータを指定します。

次のパラメータを含む AtlasProjectカスタム spec.encryptionAtRest.googleCloudKms spec.encryptionAtRestリソースの配列にオブジェクトを追加します。

Parameter	説明
`spec.encryptionAtRest.googleCloudKms.enabled`	このプロジェクトがGoogle Cloud Platform KMSを使用して保管中のデータを暗号化するかどうかを示すフラグ。 Google Cloud Platform KMSを使用して保管時の暗号化を有効にするには、このパラメータを `true` に設定します。 Google Cloud Platform KMSを使用して保管時の暗号化を無効にするには、このパラメータを `false` に設定します。 Google Cloud Platform KMSを使用して保管時の暗号化を無効にすると、 Atlas Kubernetes Operatorによって構成の詳細が削除されます。
`spec.encryptionAtRest.googleCloudKms.secretRef.name`	Google Cloud Platformの認証情報を含むシークレットの名前。
`spec.encryptionAtRest.googleCloudKms.secretRef.namespace`	Google Cloud Platformの認証情報を含む名前空間。指定されていない場合、このパラメータはデフォルトで`AtlasProject`カスタムリソースの名前空間になります。

次のパラメータの代わりに、keyVersionResourceID との値を含むシークレットを使用することをお勧めします。serviceAccountKey

spec.encryptionAtRest.googleCloudKms.keyVersionResourceID
spec.encryptionAtRest.googleCloudKms.serviceAccountKey

次のコマンドを実行します:

cat <<EOF | kubectl apply -f -
apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
  name: my-project
spec:
  name: Test Atlas Operator Project
  encryptionAtRest:
    googleCloudKms:
      enabled: true
      secretRef:
        name: gcp-ear-creds
        namespace: mongodb-atlas-system
EOF

プロジェクトで保管時の暗号化が正常に有効になっているかどうかを確認します。

次のコマンドを実行して、 Atlas Kubernetes OperatorがプロジェクトのGoogle Cloud Platform KMS構成を検出しているかどうかを確認します。

kubectl get atlasprojects my-project -o=jsonpath='{.status.conditions[?(@.type=="EncryptionAtRestReadyType")].status}

true

クラスターのカスタマーマネージドキーを使用して保管時の暗号化を有効にします。

次のコマンドを実行して、 spec.deploymentSpec.encryptionAtRestProviderをAtlasDeployment カスタムリソースに追加します。これにより、このクラスターのGoogle Cloud Platformキーを使用した保管時の暗号化が有効になります。

cat <<EOF | kubectl apply -f -
      apiVersion: atlas.mongodb.com/v1
      kind: AtlasDeployment
      metadata:
        name: my-cluster
        labels:
          app.kubernetes.io/version: 1.6.0
      spec:
        name: Test Atlas Operator Cluster
        DeploymentSpec:
          encryptionAtRestProvider: "GCP"
      EOF

戻る

x.509

フェデレーティッド認証

重要

サーバーレスインスタンスで使用できない機能

注意

前提条件

重要

手順

Amazon Web Services の認証情報を使用してシークレットを作成します。

spec.encryptionAtRest.awsKmsパラメータを指定します。

プロジェクトで保管時の暗号化が正常に有効になっているかどうかを確認します。

クラスターのカスタマー マネージド キーを使用して保管時の暗号化を有効にします。

Azure認証情報を使用してシークレットを作成します。

spec.encryptionAtRest.azureKeyVaultパラメータを指定します。

プロジェクトで保管時の暗号化が正常に有効になっているかどうかを確認します。

クラスターのカスタマー マネージド キーを使用して保管時の暗号化を有効にします。

Google Cloud Platform の認証情報を使用してシークレットを作成します。

spec.encryptionAtRest.googleCloudKmsパラメータを指定します。

プロジェクトで保管時の暗号化が正常に有効になっているかどうかを確認します。

クラスターのカスタマー マネージド キーを使用して保管時の暗号化を有効にします。

`spec.encryptionAtRest.awsKms`パラメータを指定します。

クラスターのカスタマーマネージドキーを使用して保管時の暗号化を有効にします。

`spec.encryptionAtRest.azureKeyVault`パラメータを指定します。

クラスターのカスタマーマネージドキーを使用して保管時の暗号化を有効にします。

`spec.encryptionAtRest.googleCloudKms`パラメータを指定します。

クラスターのカスタマーマネージドキーを使用して保管時の暗号化を有効にします。