GCP에서 자동 Queryable Encryption 사용
이 페이지의 내용
개요
이 가이드에서는 문서 필드를 자동으로 암호화 및 복호화하고 GCP 키 관리 서비스(KMS)를 사용하여 키를 관리하는 MongoDB Queryable Encryption 기능을 구현하는 애플리케이션을 빌드하는 방법을 설명합니다.
이 가이드의 단계를 완료하면 다음과 같은 내용이 표시됩니다:
Google Cloud 키 관리 서비스에서 관리하는 CMK
CMK를 사용하여 암호화된 필드가 있는 문서를 삽입하는 작동하는 클라이언트 애플리케이션
시작하기 전에
이 가이드의 코드를 완료하고 실행하려면 설치 요구 사항 페이지에 표시된 대로 개발 환경을 설정해야 합니다.
팁
참조: 전체 적용
이 샘플 애플리케이션의 전체 코드를 보려면 프로그래밍 언어에 해당하는 탭을 선택하고 제공된 링크를 따라가세요. 각 샘플 애플리케이션 리포지토리에는 환경을 설정하고 애플리케이션을 실행하는 방법을 배우는 데 사용할 수 있는 README.md
파일이 포함되어 있습니다.
KMS 설정
GCP 서비스 계정 등록
Google Cloud Platform 에 기존 계정을 등록하거나 로그인 Google Cloud Platform 합니다.
프로젝트에 대한 서비스 계정 만들기
GCP에서 서비스 계정을 만들려면 서비스 계정 만들기 를 따르세요. 가이드를 참조하세요.
서비스 계정 키 추가
GCP에 서비스 계정 키를 추가하려면 서비스 계정 키 관리 하기를 따르세요. 가이드를 참조하세요.
중요
서비스 계정 키를 생성할 때 비공개 키 정보를 일회성 다운로드로 받게 됩니다. 이 튜토리얼의 뒷부분에서 사용할 수 있도록 이 파일을 PKCS12 또는 JSON 형식으로 다운로드해야 합니다.
중요
서비스 계정 키를 생성할 때 비공개 키 정보를 일회성 다운로드로 받게 됩니다. 이 튜토리얼의 뒷부분에서 사용할 수 있도록 이 파일을 PKCS12 또는 JSON 형식으로 다운로드해야 합니다.
중요
서비스 계정 키를 생성할 때 비공개 키 정보를 일회성 다운로드로 받게 됩니다. 이 튜토리얼의 뒷부분에서 사용할 수 있도록 이 파일을 PKCS12 또는 JSON 형식으로 다운로드해야 합니다.
중요
서비스 계정 키를 생성하면 비공개 키 정보가 일회성으로 다운로드 됩니다. 연결된 서비스 계정을 사용하지 않는 한 이 튜토리얼의 뒷부분에서 사용할 수 있도록 이 파일 을 PKCS12 또는 JSON 형식으로 다운로드 해야 합니다.
중요
서비스 계정 키를 생성할 때 비공개 키 정보를 일회성 다운로드로 받게 됩니다. 이 튜토리얼의 뒷부분에서 사용할 수 있도록 이 파일을 PKCS12 또는 JSON 형식으로 다운로드해야 합니다.
중요
서비스 계정 키를 생성할 때 비공개 키 정보를 일회성 다운로드로 받게 됩니다. 이 튜토리얼의 뒷부분에서 사용할 수 있도록 이 파일을 PKCS12 또는 JSON 형식으로 다운로드해야 합니다.
GCP 고객 마스터 키 만들기
새 고객 마스터 키 생성
키 생성 단계에 따라 키링과 대칭 키를 생성합니다. 가이드를 참조하세요.
이 키는 고객 마스터 키(CMK)입니다.
이 튜토리얼의 이후 단계에서 사용할 수 있도록 고객 마스터 키 에 대한 다음 세부 정보를 기록합니다.
필드 | 필수 사항 | 설명 |
---|---|---|
key_name | 예 | 고객 마스터 키 의 식별자입니다. |
key_ring | 예 | 키가 속한 키 그룹의 식별자입니다. |
key_version | No | 명명된 키의 버전입니다. |
위치 | 예 | 키에 대해 지정된 리전입니다. |
엔드포인트 | No | Google Cloud KMS의 호스트 및 선택적 포트입니다. 기본값은 |
애플리케이션 생성
애플리케이션 변수 할당
이 튜토리얼의 코드 샘플에서는 다음 변수를 사용하여 Queryable Encryption 워크플로를 수행합니다.
kmsProviderName - 고객 마스터 키 를 저장 하는 데 사용하는 KMS 입니다. 이 튜토리얼에서는 이 변수를
"gcp"
로 설정합니다.uri - MongoDB deployment 연결 URI입니다.
MONGODB_URI
환경 변수에 연결 URI를 설정하거나 값을 직접 바꿉니다.keyVaultDatabaseName - 데이터 암호화 키(DEK)가 저장될 MongoDB 의 데이터베이스 입니다. 이 변수를
"encryption"
으로 설정합니다.keyVaultCollectionName - DEK가 저장될 MongoDB의 collection입니다. 이 변수를
"__keyVault"
로 설정합니다.keyVaultNamespace - DEK가 저장될 MongoDB 의 네임스페이스 입니다. 이 변수를 마침표로 구분된
keyVaultDatabaseName
및keyVaultCollectionName
변수의 값으로 설정합니다.encryptedDatabaseName - 암호화된 데이터가 저장될 MongoDB의 데이터베이스입니다. 이 변수를
"medicalRecords"
(으)로 설정합니다.encryptionCollectionName - 암호화됨 데이터가 저장될 MongoDB 의 컬렉션 입니다. 이 변수를
"patients"
으로 설정합니다.
다음 코드를 사용하여 이러한 변수를 선언할 수 있습니다.
// KMS provider name should be one of the following: "aws", "gcp", "azure", "kmip" or "local" const kmsProviderName = "<Your KMS Provider Name>"; const uri = process.env.MONGODB_URI; // Your connection URI const keyVaultDatabaseName = "encryption"; const keyVaultCollectionName = "__keyVault"; const keyVaultNamespace = `${keyVaultDatabaseName}.${keyVaultCollectionName}`; const encryptedDatabaseName = "medicalRecords"; const encryptedCollectionName = "patients";
kmsProviderName - 고객 마스터 키를 저장하는 데 사용하는 KMS입니다. 이 튜토리얼에서는 이 값을
"gcp"
로 설정합니다.keyVaultDatabaseName - 데이터 암호화 키(DEK)가 저장될 MongoDB의 데이터베이스입니다.
keyVaultDatabaseName
의 값을"encryption"
로 설정합니다.keyVaultCollectionName - DEK가 저장될 MongoDB의 collection입니다.
keyVaultCollectionName
의 값을"__keyVault"
로 설정합니다.keyVaultNamespace - DEK가 저장될 MongoDB의 네임스페이스입니다.
keyVaultDatabaseName
및keyVaultCollectionName
변수의 값이 마침표로 구분된 이름을 가진 새CollectionNamespace
객체로keyVaultNamespace
를 설정합니다.encryptionDatabaseName - 암호화된 데이터가 저장될 MongoDB의 데이터베이스입니다.
encryptedDatabaseName
의 값을"medicalRecords"
로 설정합니다.encryptedCollectionName - 암호화된 데이터가 저장될 MongoDB의 collection입니다.
encryptedCollectionName
의 값을"patients"
로 설정합니다.uri - MongoDB 배포 연결 URI입니다.
appsettings.json
파일에서 연결 URI를 설정하거나 값을 직접 바꿉니다.
다음 코드를 사용하여 이러한 변수를 선언할 수 있습니다.
// KMS provider name should be one of the following: "aws", "gcp", "azure", "kmip" or "local" const string kmsProviderName = "<your KMS provider name>"; const string keyVaultDatabaseName = "encryption"; const string keyVaultCollectionName = "__keyVault"; var keyVaultNamespace = CollectionNamespace.FromFullName($"{keyVaultDatabaseName}.{keyVaultCollectionName}"); const string encryptedDatabaseName = "medicalRecords"; const string encryptedCollectionName = "patients"; var appSettings = new ConfigurationBuilder().AddJsonFile("appsettings.json").Build(); var uri = appSettings["MongoDbUri"];
kmsProviderName - 고객 마스터 키 를 저장 하는 데 사용하는 KMS 입니다. 이 튜토리얼에서는 이 변수를
"gcp"
로 설정합니다.uri - MongoDB deployment 연결 URI입니다.
MONGODB_URI
환경 변수에 연결 URI를 설정하거나 값을 직접 바꿉니다.keyVaultDatabaseName - 데이터 암호화 키(DEK)가 저장될 MongoDB 의 데이터베이스 입니다. 이 변수를
"encryption"
으로 설정합니다.keyVaultCollectionName - DEK가 저장될 MongoDB의 collection입니다. 이 변수를
"__keyVault"
로 설정합니다.keyVaultNamespace - DEK가 저장될 MongoDB 의 네임스페이스 입니다. 이 변수를 마침표로 구분된
keyVaultDatabaseName
및keyVaultCollectionName
변수의 값으로 설정합니다.encryptedDatabaseName - 암호화된 데이터가 저장될 MongoDB의 데이터베이스입니다. 이 변수를
"medicalRecords"
(으)로 설정합니다.encryptionCollectionName - 암호화됨 데이터가 저장될 MongoDB 의 컬렉션 입니다. 이 변수를
"patients"
으로 설정합니다.
다음 코드를 사용하여 이러한 변수를 선언할 수 있습니다.
// KMS provider name should be one of the following: "aws", "gcp", "azure", "kmip" or "local" kmsProviderName := "<KMS provider name>" uri := os.Getenv("MONGODB_URI") // Your connection URI keyVaultDatabaseName := "encryption" keyVaultCollectionName := "__keyVault" keyVaultNamespace := keyVaultDatabaseName + "." + keyVaultCollectionName encryptedDatabaseName := "medicalRecords" encryptedCollectionName := "patients"
kmsProviderName - 고객 마스터 키 를 저장 하는 데 사용하는 KMS 입니다. 이 튜토리얼에서는 이 변수를
"gcp"
로 설정합니다.uri - MongoDB deployment 연결 URI입니다.
MONGODB_URI
환경 변수에 연결 URI를 설정하거나 값을 직접 바꿉니다.keyVaultDatabaseName - 데이터 암호화 키(DEK)가 저장될 MongoDB 의 데이터베이스 입니다. 이 변수를
"encryption"
으로 설정합니다.keyVaultCollectionName - DEK가 저장될 MongoDB의 collection입니다. 이 변수를
"__keyVault"
로 설정합니다.keyVaultNamespace - DEK가 저장될 MongoDB 의 네임스페이스 입니다. 이 변수를 마침표로 구분된
keyVaultDatabaseName
및keyVaultCollectionName
변수의 값으로 설정합니다.encryptedDatabaseName - 암호화된 데이터가 저장될 MongoDB의 데이터베이스입니다. 이 변수를
"medicalRecords"
(으)로 설정합니다.encryptionCollectionName - 암호화됨 데이터가 저장될 MongoDB 의 컬렉션 입니다. 이 변수를
"patients"
으로 설정합니다.
다음 코드를 사용하여 이러한 변수를 선언할 수 있습니다.
// KMS provider name should be one of the following: "aws", "gcp", "azure", "kmip" or "local" String kmsProviderName = "<KMS provider name>"; String uri = QueryableEncryptionHelpers.getEnv("MONGODB_URI"); // Your connection URI String keyVaultDatabaseName = "encryption"; String keyVaultCollectionName = "__keyVault"; String keyVaultNamespace = keyVaultDatabaseName + "." + keyVaultCollectionName; String encryptedDatabaseName = "medicalRecords"; String encryptedCollectionName = "patients";
kmsProviderName - 고객 마스터 키 를 저장 하는 데 사용하는 KMS 입니다. 이 튜토리얼에서는 이 변수를
"gcp"
로 설정합니다.uri - MongoDB deployment 연결 URI입니다.
MONGODB_URI
환경 변수에 연결 URI를 설정하거나 값을 직접 바꿉니다.keyVaultDatabaseName - 데이터 암호화 키(DEK)가 저장될 MongoDB 의 데이터베이스 입니다. 이 변수를
"encryption"
으로 설정합니다.keyVaultCollectionName - DEK가 저장될 MongoDB의 collection입니다. 이 변수를
"__keyVault"
로 설정합니다.keyVaultNamespace - DEK가 저장될 MongoDB 의 네임스페이스 입니다. 이 변수를 마침표로 구분된
keyVaultDatabaseName
및keyVaultCollectionName
변수의 값으로 설정합니다.encryptedDatabaseName - 암호화된 데이터가 저장될 MongoDB의 데이터베이스입니다. 이 변수를
"medicalRecords"
(으)로 설정합니다.encryptionCollectionName - 암호화됨 데이터가 저장될 MongoDB 의 컬렉션 입니다. 이 변수를
"patients"
으로 설정합니다.
다음 코드를 사용하여 이러한 변수를 선언할 수 있습니다.
// KMS provider name should be one of the following: "aws", "gcp", "azure", "kmip" or "local" const kmsProviderName = "<Your KMS Provider Name>"; const uri = process.env.MONGODB_URI; // Your connection URI const keyVaultDatabaseName = "encryption"; const keyVaultCollectionName = "__keyVault"; const keyVaultNamespace = `${keyVaultDatabaseName}.${keyVaultCollectionName}`; const encryptedDatabaseName = "medicalRecords"; const encryptedCollectionName = "patients";
kms_provider_name - 고객 마스터 키 를 저장 하는 데 사용하는 KMS 입니다. 이 튜토리얼에서는 이 변수를
"gcp"
로 설정합니다.uri - MongoDB deployment 연결 URI입니다.
MONGODB_URI
환경 변수에 연결 URI를 설정하거나 값을 직접 바꿉니다.key_vault_database_name - 데이터 암호화 키(DEK)가 저장될 MongoDB 의 데이터베이스 입니다. 이 변수를
"encryption"
으로 설정합니다.key_vault_collection_name - DEK가 저장될 MongoDB 의 컬렉션 입니다. 이 변수를
"__keyVault"
으로 설정합니다.key_vault_namespace - DEK가 저장될 MongoDB 의 네임스페이스 입니다. 이 변수를 마침표로 구분된
key_vault_database_name
및key_vault_collection_name
변수의 값으로 설정합니다.encryption_database_name - 암호화됨 데이터가 저장될 MongoDB 의 데이터베이스 입니다. 이 변수를
"medicalRecords"
으로 설정합니다.encryption_collection_name - 암호화됨 데이터가 저장될 MongoDB 의 컬렉션 입니다. Set this variable to
"patients"
.
다음 코드를 사용하여 이러한 변수를 선언할 수 있습니다.
# KMS provider name should be one of the following: "aws", "gcp", "azure", "kmip" or "local" kms_provider_name = "<KMS provider name>" uri = os.environ['MONGODB_URI'] # Your connection URI key_vault_database_name = "encryption" key_vault_collection_name = "__keyVault" key_vault_namespace = f"{key_vault_database_name}.{key_vault_collection_name}" encrypted_database_name = "medicalRecords" encrypted_collection_name = "patients"
중요
키 볼트 컬렉션 네임스페이스 권한
키 볼트 컬렉션은 encryption.__keyVault
네임스페이스에 있습니다. 애플리케이션이 MongoDB에 연결하는 데 사용하는 데이터베이스 사용자에게 이 네임스페이스에 대한 읽기/쓰기 권한이 있는지 확인합니다.
팁
환경 변수
이 튜토리얼의 샘플 코드는 설정해야 하는 환경 변수를 참조합니다. 또는 코드에서 직접 값을 바꿀 수도 있습니다.
이러한 환경 변수를 설정하는 방법을 알아보려면 README.md 를 참조하세요. 파일은 GitHub의 샘플 애플리케이션에 포함되어 있습니다.
팁
환경 변수
이 튜토리얼의 샘플 코드는 설정해야 하는 환경 변수를 참조합니다. 또는 코드에서 직접 값을 바꿀 수도 있습니다.
이러한 환경 변수를 설정하는 방법을 알아보려면 README.md 를 참조하세요. 파일은 GitHub의 샘플 애플리케이션에 포함되어 있습니다.
팁
환경 변수
이 튜토리얼의 샘플 코드는 설정해야 하는 환경 변수를 참조합니다. 또는 코드에서 직접 값을 바꿀 수도 있습니다.
이러한 환경 변수를 설정하는 방법을 알아보려면 README.md 를 참조하세요. 파일은 GitHub의 샘플 애플리케이션에 포함되어 있습니다.
팁
환경 변수
이 튜토리얼의 샘플 코드는 설정해야 하는 환경 변수를 참조합니다. 또는 코드에서 직접 값을 바꿀 수도 있습니다.
이러한 환경 변수를 설정하는 방법을 알아보려면 README.md 를 참조하세요. 파일은 GitHub의 샘플 애플리케이션에 포함되어 있습니다.
팁
환경 변수
이 튜토리얼의 샘플 코드는 설정해야 하는 환경 변수를 참조합니다. 또는 코드에서 직접 값을 바꿀 수도 있습니다.
이러한 환경 변수를 설정하는 방법을 알아보려면 README.md 를 참조하세요. 파일은 GitHub의 샘플 애플리케이션에 포함되어 있습니다.
팁
환경 변수
이 튜토리얼의 샘플 코드는 설정해야 하는 환경 변수를 참조합니다. 또는 코드에서 직접 값을 바꿀 수도 있습니다.
이러한 환경 변수를 설정하는 방법을 알아보려면 README.md 를 참조하세요. 파일은 GitHub의 샘플 애플리케이션에 포함되어 있습니다.
암호화된 컬렉션 만들기
Google Cloud 키 관리 서비스 자격 증명 추가
다음 구조로 Google Cloud 키 관리 서비스 자격 증명이 포함된 변수를 만듭니다.
kmsProviderCredentials = { gcp: { email: process.env["GCP_EMAIL"], // Your GCP email privateKey: process.env["GCP_PRIVATE_KEY"], // Your GCP private key }, };
var kmsProviderCredentials = new Dictionary<string, IReadOnlyDictionary<string, object>>(); var kmsOptions = new Dictionary<string, object> { { "email", _appSettings["Gcp:Email"] }, // Your GCP email { "privateKey", _appSettings["Gcp:PrivateKey"] } // Your GCP private key }; kmsProviderCredentials.Add(kmsProvider, kmsOptions);
kmsProviderCredentials := map[string]map[string]interface{}{ "gcp": { "email": os.Getenv("GCP_EMAIL"), // GCP email "privateKey": os.Getenv("GCP_PRIVATE_KEY"), // GCP private key }, }
Map<String, Object> kmsProviderDetails = new HashMap<>(); kmsProviderDetails.put("email", getEnv("GCP_EMAIL")); // Your GCP email kmsProviderDetails.put("privateKey", getEnv("GCP_PRIVATE_KEY")); // Your GCP private key Map<String, Map<String, Object>> kmsProviderCredentials = new HashMap<String, Map<String, Object>>(); kmsProviderCredentials.put("gcp", kmsProviderDetails);
kmsProviders = { gcp: { email: process.env.GCP_EMAIL, // Your GCP email privateKey: process.env.GCP_PRIVATE_KEY, // Your GCP private key }, };
kms_provider_credentials = { "gcp": { "email": os.environ['GCP_EMAIL'], # Your GCP email "privateKey": os.environ['GCP_PRIVATE_KEY'] # Your GCP private key } }
고객 마스터 키 자격 증명 추가
다음 구조로 고객 마스터 키 자격 증명이 포함된 변수를 생성합니다. 이 튜토리얼 의 새 고객 마스터 키 생성 단계에서 기록한 자격 증명을 사용합니다.
customerMasterKeyCredentials = { projectId: process.env["GCP_PROJECT_ID"], // Your GCP Project ID location: process.env["GCP_LOCATION"], // Your GCP Key Location keyRing: process.env["GCP_KEY_RING"], // Your GCP Key Ring keyName: process.env["GCP_KEY_NAME"], // Your GCP Key Name };
var customerMasterKeyCredentials = new BsonDocument { { "projectId", _appSettings["Gcp:ProjectId"] }, // Your GCP Project ID { "location", _appSettings["Gcp:Location"] }, // Your GCP Key Location { "keyRing", _appSettings["Gcp:KeyRing"] }, // Your GCP Key Ring { "keyName", _appSettings["Gcp:KeyName"] } // Your GCP Key Name };
customerMasterKeyCredentials := map[string]string{ "projectId": os.Getenv("GCP_PROJECT_ID"), // Your GCP Project ID "location": os.Getenv("GCP_LOCATION"), // Your GCP Key Location "keyRing": os.Getenv("GCP_KEY_RING"), // Your GCP Key Ring "keyName": os.Getenv("GCP_KEY_NAME"), // Your GCP Key Name }
BsonDocument customerMasterKeyCredentials = new BsonDocument(); customerMasterKeyCredentials.put("provider", new BsonString(kmsProviderName)); customerMasterKeyCredentials.put("projectId", new BsonString(getEnv("GCP_PROJECT_ID"))); // Your GCP Project ID customerMasterKeyCredentials.put("location", new BsonString(getEnv("GCP_LOCATION"))); // Your GCP Key Location customerMasterKeyCredentials.put("keyRing", new BsonString(getEnv("GCP_KEY_RING"))); // Your GCP Key Ring customerMasterKeyCredentials.put("keyName", new BsonString(getEnv("GCP_KEY_NAME"))); // Your GCP Key Name
customerMasterKeyCredentials = { projectId: process.env.GCP_PROJECT_ID, // Your GCP Project ID location: process.env.GCP_LOCATION, // Your GCP Key Location keyRing: process.env.GCP_KEY_RING, // Your GCP Key Ring keyName: process.env.GCP_KEY_NAME, // Your GCP Key Name };
customer_master_key_credentials = { "projectId": os.environ['GCP_PROJECT_ID'], # Your GCP email "location": os.environ['GCP_LOCATION'], # Your GCP private key "keyRing": os.environ['GCP_KEY_RING'], # Your GCP private key "keyName": os.environ['GCP_KEY_NAME'] # Your GCP private key }
자동 암호화 옵션 설정
다음 옵션을 포함하는 autoEncryptionOptions
객체 를 만듭니다.
키 볼트 컬렉션의 네임스페이스
Google Cloud 키 관리 서비스 자격 증명이 포함된
kmsProviderCredentials
객체
const autoEncryptionOptions = { keyVaultNamespace: keyVaultNamespace, kmsProviders: kmsProviderCredentials, };
다음 옵션을 포함하는 AutoEncryptionOptions
객체 를 만듭니다.
키 볼트 컬렉션의 네임스페이스
Google Cloud 키 관리 서비스 자격 증명이 포함된
kmsProviderCredentials
객체자동 암호화 공유 라이브러리의 경로가 포함된
extraOptions
객체
var extraOptions = new Dictionary<string, object> { { "cryptSharedLibPath", _appSettings["CryptSharedLibPath"] } // Path to your Automatic Encryption Shared Library }; var autoEncryptionOptions = new AutoEncryptionOptions( keyVaultNamespace, kmsProviderCredentials, extraOptions: extraOptions);
다음 옵션을 포함하는 AutoEncryption
객체 를 만듭니다.
키 볼트 컬렉션의 네임스페이스
Google Cloud 키 관리 서비스 자격 증명이 포함된
kmsProviderCredentials
객체자동 암호화 공유 라이브러리의 경로가 포함된
cryptSharedLibraryPath
객체
cryptSharedLibraryPath := map[string]interface{}{ "cryptSharedLibPath": os.Getenv("SHARED_LIB_PATH"), // Path to your Automatic Encryption Shared Library } autoEncryptionOptions := options.AutoEncryption(). SetKeyVaultNamespace(keyVaultNamespace). SetKmsProviders(kmsProviderCredentials). SetExtraOptions(cryptSharedLibraryPath)
다음 옵션을 포함하는 AutoEncryptionSettings
객체 를 만듭니다.
키 볼트 컬렉션의 네임스페이스
Google Cloud 키 관리 서비스 자격 증명이 포함된
kmsProviderCredentials
객체자동 암호화 공유 라이브러리의 경로가 포함된
extraOptions
객체
Map<String, Object> extraOptions = new HashMap<String, Object>(); extraOptions.put("cryptSharedLibPath", getEnv("SHARED_LIB_PATH")); // Path to your Automatic Encryption Shared Library AutoEncryptionSettings autoEncryptionSettings = AutoEncryptionSettings.builder() .keyVaultNamespace(keyVaultNamespace) .kmsProviders(kmsProviderCredentials) .extraOptions(extraOptions) .build();
다음 옵션을 포함하는 autoEncryptionOptions
객체 를 만듭니다.
키 볼트 컬렉션의 네임스페이스
Google Cloud 키 관리 서비스 자격 증명이 포함된
kmsProviders
객체자동 암호화 공유 라이브러리의 경로가 포함된
sharedLibraryPathOptions
객체
const extraOptions = { cryptSharedLibPath: process.env.SHARED_LIB_PATH, // Path to your Automatic Encryption Shared Library }; const autoEncryptionOptions = { keyVaultNamespace, kmsProviders, extraOptions, };
다음 옵션을 포함하는 AutoEncryptionOpts
객체 를 만듭니다.
Google Cloud 키 관리 서비스 자격 증명이 포함된
kms_provider_credentials
객체키 볼트 컬렉션의 네임스페이스
자동 암호화 공유 라이브러리의 경로
auto_encryption_options = AutoEncryptionOpts( kms_provider_credentials, key_vault_namespace, crypt_shared_lib_path=os.environ['SHARED_LIB_PATH'] # Path to your Automatic Encryption Shared Library> )
참고
자동 암호화 옵션
자동 암호화 옵션은 자동 암호화 공유 라이브러리에 구성 정보를 제공하여 암호화된 필드에 액세스할 때 애플리케이션의 동작을 수정합니다.
자동 암호화 공유 라이브러리에 대한 자세한 내용은 Queryable Encryption을 위한 자동 암호화 공유 라이브러리 페이지에서 확인하세요.
클라이언트를 만들어 암호화된 컬렉션 설정하기
컬렉션의 데이터를 암호화 및 암호 해독하는 데 사용되는 클라이언트를 만들려면 연결 URI 및 자동 암호화 옵션을 사용하여 새 MongoClient
를 인스턴스화합니다.
const encryptedClient = Mongo(uri, autoEncryptionOptions);
var clientSettings = MongoClientSettings.FromConnectionString(uri); clientSettings.AutoEncryptionOptions = qeHelpers.GetAutoEncryptionOptions( keyVaultNamespace, kmsProviderCredentials); var encryptedClient = new MongoClient(clientSettings);
encryptedClient, err := mongo.Connect( context.TODO(), options.Client().ApplyURI(uri).SetAutoEncryptionOptions(autoEncryptionOptions), ) if err != nil { panic(fmt.Sprintf("Unable to connect to MongoDB: %v\n", err)) } defer func() { _ = encryptedClient.Disconnect(context.TODO()) }()
MongoClientSettings clientSettings = MongoClientSettings.builder() .applyConnectionString(new ConnectionString(uri)) .autoEncryptionSettings(autoEncryptionSettings) .build(); try (MongoClient encryptedClient = MongoClients.create(clientSettings)) {
const encryptedClient = new MongoClient(uri, { autoEncryption: autoEncryptionOptions, });
encrypted_client = MongoClient( uri, auto_encryption_opts=auto_encryption_options)
암호화할 필드 지정
필드를 암호화하려면 암호화 스키마에 추가합니다. 필드에서 쿼리를 활성화하려면 'queries' 속성을 추가합니다. 다음과 같이 암호화 스키마를 생성합니다.
const encryptedFieldsMap = { encryptedFields: { fields: [ { path: "patientRecord.ssn", bsonType: "string", queries: { queryType: "equality" }, }, { path: "patientRecord.billing", bsonType: "object", }, ], }, };
var encryptedFields = new BsonDocument { { "fields", new BsonArray { new BsonDocument { { "keyId", BsonNull.Value }, { "path", "record.ssn" }, { "bsonType", "string" }, { "queries", new BsonDocument("queryType", "equality") } }, new BsonDocument { { "keyId", BsonNull.Value }, { "path", "record.billing" }, { "bsonType", "object" } } } } };
encryptedFieldsMap := bson.M{ "fields": []bson.M{ bson.M{ "keyId": nil, "path": "patientRecord.ssn", "bsonType": "string", "queries": []bson.M{ { "queryType": "equality", }, }, }, bson.M{ "keyId": nil, "path": "patientRecord.billing", "bsonType": "object", }, }, }
BsonDocument encryptedFieldsMap = new BsonDocument().append("fields", new BsonArray(Arrays.asList( new BsonDocument() .append("keyId", new BsonNull()) .append("path", new BsonString("patientRecord.ssn")) .append("bsonType", new BsonString("string")) .append("queries", new BsonDocument() .append("queryType", new BsonString("equality"))), new BsonDocument() .append("keyId", new BsonNull()) .append("path", new BsonString("patientRecord.billing")) .append("bsonType", new BsonString("object")))));
const encryptedFieldsMap = { encryptedFields: { fields: [ { path: "patientRecord.ssn", bsonType: "string", queries: { queryType: "equality" }, }, { path: "patientRecord.billing", bsonType: "object", }, ], }, };
encrypted_fields_map = { "fields": [ { "path": "patientRecord.ssn", "bsonType": "string", "queries": [{"queryType": "equality"}] }, { "path": "patientRecord.billing", "bsonType": "object", } ] }
참고
이전 코드 샘플에서는 "ssn" 및 "billing" 필드가 모두 암호화되어 있지만 "ssn" 필드만 쿼리할 수 있습니다.
컬렉션 생성
ClientEncryption
을 인스턴스화하여 암호화 헬퍼 메서드용 API에 액세스합니다.
const clientEncryption = encryptedClient.getClientEncryption()
var clientEncryptionOptions = new ClientEncryptionOptions( keyVaultClient: keyVaultClient, keyVaultNamespace: keyVaultNamespace, kmsProviders: kmsProviderCredentials ); var clientEncryption = new ClientEncryption(clientEncryptionOptions);
opts := options.ClientEncryption(). SetKeyVaultNamespace(keyVaultNamespace). SetKmsProviders(kmsProviderCredentials) clientEncryption, err := mongo.NewClientEncryption(encryptedClient, opts) if err != nil { panic(fmt.Sprintf("Unable to create a ClientEncryption instance due to the following error: %s\n", err)) }
ClientEncryptionSettings clientEncryptionSettings = ClientEncryptionSettings.builder() .keyVaultMongoClientSettings(MongoClientSettings.builder() .applyConnectionString(new ConnectionString(uri)) .build()) .keyVaultNamespace(keyVaultNamespace) .kmsProviders(kmsProviderCredentials) .build(); ClientEncryption clientEncryption = ClientEncryptions.create(clientEncryptionSettings);
const clientEncryption = new ClientEncryption(encryptedClient, autoEncryptionOptions);
client_encryption = ClientEncryption( kms_providers=kms_provider_credentials, key_vault_namespace=key_vault_namespace, key_vault_client=encrypted_client, codec_options=CodecOptions(uuid_representation=STANDARD) )
ClientEncryption
클래스를 통해 액세스하는 암호화 헬퍼 메서드를 사용하여 암호화됨 컬렉션 을 만듭니다. 이 메서드는 암호화됨 필드에 대한 데이터 암호화 키를 자동으로 생성하고 암호화됨 컬렉션 을 생성합니다.
await clientEncryption.createEncryptedCollection( encryptedDatabaseName, encryptedCollectionName, { provider: kmsProviderName, createCollectionOptions: encryptedFieldsMap, masterKey: customerMasterKeyCredentials, } );
이 튜토리얼의 C# 버전에서는 별도의 클래스를 데이터 모델로 사용하여 문서 구조를 나타냅니다. 프로젝트에 다음 Patient
, PatientRecord
및 PatientBilling
클래스를 추가합니다.
using MongoDB.Bson; using MongoDB.Bson.Serialization.Attributes; [ ]public class Patient { public ObjectId Id { get; set; } public string Name { get; set; } public PatientRecord Record { get; set; } }
public class PatientRecord { public string Ssn { get; set; } public PatientBilling Billing { get; set; } }
public class PatientBilling { public string CardType { get; set; } public long CardNumber { get; set; } }
이러한 클래스를 추가한 후 ClientEncryption
클래스를 통해 액세스하는 암호화 헬퍼 메서드를 사용하여 암호화된 collection을 만듭니다. 이 메서드는 암호화된 필드에 대한 데이터 암호화 키를 자동으로 생성하고 암호화된 collection을 생성합니다.
var createCollectionOptions = new CreateCollectionOptions<Patient> { EncryptedFields = encryptedFields }; clientEncryption.CreateEncryptedCollection(patientDatabase, encryptedCollectionName, createCollectionOptions, kmsProviderName, customerMasterKeyCredentials);
팁
데이터베이스 대 데이터베이스 이름
암호화된 컬렉션을 생성하는 방법에는 데이터베이스 이름이 아닌 데이터베이스 객체에 대한 참조가 필요합니다. 클라이언트 객체의 메서드를 사용하여 이 참조를 얻을 수 있습니다.
이 튜토리얼의 Go 버전에서는 데이터 모델을 사용하여 문서 구조를 나타냅니다. 프로젝트에 다음 구조체를 추가하여 컬렉션의 데이터를 나타냅니다.
type PatientDocument struct { PatientName string `bson:"patientName"` PatientID int32 `bson:"patientId"` PatientRecord PatientRecord `bson:"patientRecord"` }
type PatientRecord struct { SSN string `bson:"ssn"` Billing PaymentInfo `bson:"billing"` }
type PaymentInfo struct { Type string `bson:"type"` Number string `bson:"number"` }
이러한 클래스를 추가한 후 ClientEncryption
클래스를 통해 액세스하는 암호화 헬퍼 메서드를 사용하여 암호화된 collection을 만듭니다. 이 메서드는 암호화된 필드에 대한 데이터 암호화 키를 자동으로 생성하고 암호화된 collection을 생성합니다.
createCollectionOptions := options.CreateCollection().SetEncryptedFields(encryptedFieldsMap) _, _, err = clientEncryption.CreateEncryptedCollection( context.TODO(), encryptedClient.Database(encryptedDatabaseName), encryptedCollectionName, createCollectionOptions, kmsProviderName, customerMasterKey, )
팁
데이터베이스 대 데이터베이스 이름
암호화된 컬렉션을 생성하는 방법에는 데이터베이스 이름이 아닌 데이터베이스 객체에 대한 참조가 필요합니다. 클라이언트 객체의 메서드를 사용하여 이 참조를 얻을 수 있습니다.
ClientEncryption
클래스를 통해 액세스하는 암호화 헬퍼 메서드를 사용하여 암호화됨 컬렉션 을 만듭니다. 이 메서드는 암호화됨 필드에 대한 데이터 암호화 키를 자동으로 생성하고 암호화됨 컬렉션 을 생성합니다.
CreateCollectionOptions createCollectionOptions = new CreateCollectionOptions().encryptedFields(encryptedFieldsMap); CreateEncryptedCollectionParams encryptedCollectionParams = new CreateEncryptedCollectionParams(kmsProviderName); encryptedCollectionParams.masterKey(customerMasterKeyCredentials); try { clientEncryption.createEncryptedCollection( encryptedClient.getDatabase(encryptedDatabaseName), encryptedCollectionName, createCollectionOptions, encryptedCollectionParams); }
팁
데이터베이스 대 데이터베이스 이름
암호화된 컬렉션을 생성하는 방법에는 데이터베이스 이름이 아닌 데이터베이스 객체에 대한 참조가 필요합니다. 클라이언트 객체의 메서드를 사용하여 이 참조를 얻을 수 있습니다.
참고
클라이언트 암호화 가져오기
Node.js 드라이버 v6.0 이상을 사용하는 경우 mongodb
에서 ClientEncryption
을(를) 가져와야 합니다.
이전 드라이버 버전의 경우 mongodb-client-encryption
에서 ClientEncryption
을(를) 가져옵니다.
ClientEncryption
클래스를 통해 액세스하는 암호화 헬퍼 메서드를 사용하여 암호화됨 컬렉션 을 만듭니다. 이 메서드는 암호화됨 필드에 대한 데이터 암호화 키를 자동으로 생성하고 암호화됨 컬렉션 을 생성합니다.
await clientEncryption.createEncryptedCollection( encryptedDatabase, encryptedCollectionName, { provider: kmsProviderName, createCollectionOptions: encryptedFieldsMap, masterKey: customerMasterKeyCredentials, } );
팁
데이터베이스 대 데이터베이스 이름
암호화된 컬렉션을 생성하는 방법에는 데이터베이스 이름이 아닌 데이터베이스 객체에 대한 참조가 필요합니다. 클라이언트 객체의 메서드를 사용하여 이 참조를 얻을 수 있습니다.
ClientEncryption
클래스를 통해 액세스하는 암호화 헬퍼 메서드를 사용하여 암호화됨 컬렉션 을 만듭니다. 이 메서드는 암호화됨 필드에 대한 데이터 암호화 키를 자동으로 생성하고 암호화됨 컬렉션 을 생성합니다.
client_encryption.create_encrypted_collection( encrypted_client[encrypted_database_name], encrypted_collection_name, encrypted_fields_map, kms_provider_name, customer_master_key_credentials, )
팁
데이터베이스 대 데이터베이스 이름
암호화된 컬렉션을 생성하는 방법에는 데이터베이스 이름이 아닌 데이터베이스 객체에 대한 참조가 필요합니다. 클라이언트 객체의 메서드를 사용하여 이 참조를 얻을 수 있습니다.
암호화된 필드가 있는 문서 삽입하기
환자의 개인 정보를 설명하는 샘플 문서를 만듭니다. 다음 예시와 같이 암호화된 클라이언트를 사용하여 patients
컬렉션에 삽입합니다.
const patientDocument = { patientName: "Jon Doe", patientId: 12345678, patientRecord: { ssn: "987-65-4320", billing: { type: "Visa", number: "4111111111111111", }, }, }; const encryptedCollection = encryptedClient.getDB(encryptedDatabaseName).getCollection(encryptedCollectionName); const insertResult = await encryptedCollection.insertOne(patientDocument);
환자의 개인 정보를 설명하는 샘플 문서를 만듭니다. 다음 예시와 같이 암호화된 클라이언트를 사용하여 patients
컬렉션에 삽입합니다.
var patient = new Patient { Name = "Jon Doe", Id = new ObjectId(), Record = new PatientRecord { Ssn = "987-65-4320", Billing = new PatientBilling { CardType = "Visa", CardNumber = 4111111111111111 } } }; var encryptedCollection = encryptedClient.GetDatabase(encryptedDatabaseName). GetCollection<Patient>(encryptedCollectionName); encryptedCollection.InsertOne(patient);
환자의 개인 정보를 설명하는 샘플 문서를 만듭니다. 다음 예시와 같이 암호화된 클라이언트를 사용하여 patients
컬렉션에 삽입합니다.
patientDocument := &PatientDocument{ PatientName: "John Doe", PatientID: 12345678, PatientRecord: PatientRecord{ SSN: "987-65-4320", Billing: PaymentInfo{ Type: "Visa", Number: "4111111111111111", }, }, } coll := encryptedClient.Database(encryptedDatabaseName).Collection(encryptedCollectionName) _, err = coll.InsertOne(context.TODO(), patientDocument) if err != nil { panic(fmt.Sprintf("Unable to insert the patientDocument: %s", err)) }
이 튜토리얼에서는 POJO를 데이터 모델로 사용하여 문서 구조를 나타냅니다. POJO를 사용하도록 애플리케이션 을 설정하다 하려면 다음 코드를 추가하세요.
CodecProvider pojoCodecProvider = PojoCodecProvider.builder().automatic(true).build(); CodecRegistry pojoCodecRegistry = fromRegistries(getDefaultCodecRegistry(), fromProviders(pojoCodecProvider));
Java POJO에 학습 보려면 Plain Old Java Object 위키백과 문서를 참조하세요.
이 튜토리얼에서는 다음 POJO를 사용합니다.
Patient
PatientRecord
PatientBilling
이러한 클래스 는 전체 Java 애플리케이션 의 모델 패키지 에서 확인할 수 있습니다.
이러한 POJO 클래스를 애플리케이션 에 추가합니다. Then, create an instance of a Patient
that describes a patient's personal information. 다음 예시 와 같이 암호화됨 클라이언트 를 사용하여 patients
컬렉션 에 삽입합니다.
MongoDatabase encryptedDb = encryptedClient.getDatabase(encryptedDatabaseName).withCodecRegistry(pojoCodecRegistry); MongoCollection<Patient> collection = encryptedDb.getCollection(encryptedCollectionName, Patient.class); PatientBilling patientBilling = new PatientBilling("Visa", "4111111111111111"); PatientRecord patientRecord = new PatientRecord("987-65-4320", patientBilling); Patient patientDocument = new Patient("Jon Doe", patientRecord); InsertOneResult result = collection.insertOne(patientDocument);
환자의 개인 정보를 설명하는 샘플 문서를 만듭니다. 다음 예시와 같이 암호화된 클라이언트를 사용하여 patients
컬렉션에 삽입합니다.
const patientDocument = { patientName: "Jon Doe", patientId: 12345678, patientRecord: { ssn: "987-65-4320", billing: { type: "Visa", number: "4111111111111111", }, }, }; const encryptedCollection = encryptedClient .db(encryptedDatabaseName) .collection(encryptedCollectionName); const result = await encryptedCollection.insertOne(patientDocument);
환자의 개인 정보를 설명하는 샘플 문서를 만듭니다. 다음 예시와 같이 암호화된 클라이언트를 사용하여 patients
컬렉션에 삽입합니다.
patient_document = { "patientName": "Jon Doe", "patientId": 12345678, "patientRecord": { "ssn": "987-65-4320", "billing": { "type": "Visa", "number": "4111111111111111", }, }, } encrypted_collection = encrypted_client[encrypted_database_name][encrypted_collection_name] result = encrypted_collection.insert_one(patient_document)
암호화된 필드에 대한 쿼리
다음 코드 샘플은 암호화된 필드에서 찾기 쿼리를 실행하고 암호가 해독된 데이터를 출력합니다.
const findResult = await encryptedCollection.findOne({ "patientRecord.ssn": "987-65-4320", }); console.log(findResult);
var ssnFilter = Builders<Patient>.Filter.Eq("record.ssn", patient.Record.Ssn); var findResult = await encryptedCollection.Find(ssnFilter).ToCursorAsync(); Console.WriteLine(findResult.FirstOrDefault().ToJson());
var findResult PatientDocument err = coll.FindOne( context.TODO(), bson.M{"patientRecord.ssn": "987-65-4320"}, ).Decode(&findResult)
Patient findResult = collection.find( new BsonDocument() .append("patientRecord.ssn", new BsonString("987-65-4320"))) .first(); System.out.println(findResult);
const findResult = await encryptedCollection.findOne({ "patientRecord.ssn": "987-65-4320", }); console.log(findResult);
find_result = encrypted_collection.find_one({ "patientRecord.ssn": "987-65-4320" }) print(find_result)
이전 코드 샘플의 출력은 다음과 유사해야 합니다.
{ "_id": { "$oid": "648b384a722cb9b8392df76a" }, "name": "Jon Doe", "record": { "ssn": "987-65-4320", "billing": { "type": "Visa", "number": "4111111111111111" } }, "__safeContent__": [ { "$binary": { "base64": "L1NsYItk0Sg+oL66DBj6IYHbX7tveANQyrU2cvMzD9Y=", "subType": "00" } } ] }
경고
__safeContent__ 필드를 수정하지 마세요.
__safeContent__
필드는 Queryable Encryption에 반드시 필요합니다. 이 필드의 내용은 수정하지 마세요.
자세히 알아보기
Queryable Encryption의 작동 방식을 알아보려면 기본 사항을 참조하세요.
이 가이드에 언급된 주제에 대해 자세히 알아보려면 다음 링크를 참조하세요: