KeyVault.createKey()

KeyVault.createKey(keyManagementService, customerMasterKey, ["keyAltName"])

데이터베이스 연결과 연결된 Key Vault에 데이터 암호화 키 를 추가합니다. 클라이언트 측 필드 레벨 암호화 는 데이터 암호화 키를 사용하여 필드 값의 암호화 및 암호 해독을 지원합니다.

createKey() 의 구문은 다음과 같습니다:

keyVault = db.getMongo().getKeyVault()
keyVault.createKey(
  keyManagementService,
  customerMasterKey,
  [ "keyAltName" ]
)

Parameter	유형	설명
keyManagementService	문자열	필수 사항 고객 마스터 키(CMK)를 검색하는 데 사용할 키 관리 서비스(KMS) 입니다. 다음 매개변수를 허용합니다: aws Amazon Web Services KMS 용 . customerMasterKey 에 대한 고객 마스터 키(CMK) 문자열을 지정해야 합니다. azure Azure Key Vault 의 경우 . customerMasterKey 에 대한 고객 마스터 키(CMK) 문서를 지정해야 합니다. 버전 5.0에 추가. gcp Google Cloud Platform KMS 용 . customerMasterKey 에 대한 고객 마스터 키(CMK) 문서를 지정해야 합니다. 버전 5.0에 추가. local 로컬 managed 키의 경우. 지정된 KMS로 database connection 이(가) 구성되지 않은 경우 데이터 암호화 키 생성이 실패합니다.
customerMasterKey	문자열 또는 문서	데이터 암호화 키를 암호화하는 데 사용할 고객 마스터 키(CMK)입니다. keyManagementService 이 aws, azure 또는 gcp 인 경우 필수 사항입니다. KMS 제공자에 따라 다음과 같이 고객 마스터 키를 제공합니다. 의 경우 전체 Amazon Web Services KMS 리소스 Amazon 이름(ARN) 을(를) string 지정합니다. 를 단일 로 변환합니다. Azure Key Vault KMS의 경우 다음 키 값 쌍이 포함된 문서를 지정합니다. keyName - Azure Key Vault 이름 keyVaultEndpoint - 사용할 Azure Key Vault의 DNS 이름 keyVersion - 선택 사항입니다. 해당하는 경우 keyName 에 지정된 키의 버전입니다. 버전 5.0에 추가. Google Cloud Platform KMS 의 경우 다음 키 값 쌍이 포함된 문서를 지정합니다. projectId - GCP 프로젝트 이름 location - KMS 키링의 위치 keyRing - KMS 키링의 이름(대개 '글로벌') keyName - 사용할 키의 이름 keyVersion - 선택 사항입니다. 해당하는 경우 keyName 에 지정된 키의 버전입니다. 버전 5.0에 추가. createKey() 은(는) KMS 에 지정된 CMK 를 사용하여 데이터 암호화 키 자료를 암호화하도록 요청합니다. CMK 가 존재하지 않거나 AutoEncryptionOpts 구성에 CMK 를 사용할 충분한 권한이 없는 경우 createKey() 에서 오류를 반환합니다. 이 매개변수는 keyManagementService 이 local 인 경우에는 효과가 없으며 생략해도 됩니다.
keyAltName	문자열 배열	옵션 데이터 암호화 키의 대체 이름입니다. keyAltName 을(를) 사용하여 특정 데이터 암호화 키의 찾기를 개선하거나 댓글과 유사한 기능을 수행합니다. 메서드는 가 존재하는 문서에 대해서만 부분 인덱스 필터를 사용하여 필드에 고유 getKeyVault() 인덱스 를 자동으로 생성합니다.keyAltNames keyAltNames
options	문서	옵션 새 키에 대한 옵션을 지정하는 문서입니다. options 에는 다음과 같은 필드가 있습니다. masterKey: 데이터를 암호화하기 위한 새 마스터 키입니다. keyAltNames: 마스터 키당 하나씩 대체 이름의 배열입니다. keyMaterial: 키를 생성하는 데 사용되는 빈데이터입니다.

반환합니다:	생성된 데이터 암호화 키의 UUID 고유 식별자입니다.

mongosh --nodb

const TEST_LOCAL_KEY = require("crypto").randomBytes(96).toString("base64")

 var autoEncryptionOpts = {
   "keyVaultNamespace" : "encryption.__dataKeys",
   "kmsProviders" : {
     "local" : {
       "key" : BinData(0, TEST_LOCAL_KEY)
     }
   }
 }

encryptedClient = Mongo(
  "mongodb://myMongo.example.net:27017/?replSetName=myMongo",
   autoEncryptionOpts
)

keyVault = encryptedClient.getKeyVault()
keyVault.createKey("local", ["data-encryption-key"])