KeyVault.addKeyAlternateName()
KeyVault.addKeyAlternateName(UUID, keyAltName)
UUID
를 사용하여 데이터 암호화 키의keyAltNames
배열에keyAltName
를 추가합니다.keyAltName
키 볼트의 모든 키 중에서 고유 해야 합니다 .getKeyVault()
메서드는 가 존재하는keyAltNames
문서에 대해서만 부분 인덱스keyAltNames
필터하다 를 사용하여 필드 에 고유 인덱스 를 자동으로 생성합니다.반환합니다: 데이터 암호화 키 문서의 이전 버전을 반환합니다. 지정된
UUID()
이 있는 데이터 암호화 키가 없는 경우null
을 반환합니다.
호환성
이 명령은 다음 환경에서 호스팅되는 배포에서 사용할 수 있습니다.
MongoDB Atlas: 클라우드에서의 MongoDB 배포를 위한 완전 관리형 서비스
MongoDB Enterprise: MongoDB의 구독 기반 자체 관리 버전
MongoDB Community: MongoDB의 소스 사용 가능 무료 자체 관리 버전
구문
addKeyAlternateName()
의 구문은 다음과 같습니다:
keyVault = db.getMongo().getKeyVault() keyVault.addKeyAlternateName( UUID("<UUID string>"), "keyAlternateName" )
행동
데이터베이스 연결 시 클라이언트 측 필드 레벨 암호화 구성 필요
mongo
클라이언트 사이드 필드 수준 암호화 방법을 사용하려면 클라이언트 사이드 필드 수준 암호화가 활성화된 데이터베이스 연결이 필요합니다. 클라이언트 사이드 필드 수준 암호화가 활성화된 상태에서 현재 데이터베이스 연결이 시작되지 않은 경우 다음 중 하나를 수행하세요.
예시
다음 예시 는 클라이언트 사이드 필드 수준 암호화 를 빠르게 평가하기 위한 것입니다. 지원되는 각 KMS제공자 와 함께 를 사용하는 구체적인 예 는 KeyVault.addKeyAlternateName()
데이터 암호화 키의 대체 이름 관리를 참조하세요.
로컬로 managed 키에 대해 클라이언트 사이드 필드 수준 암호화를 구성하려면 줄바꿈 없이 base64로 인코딩된 96바이트 문자열을 지정해야 합니다. 다음 작업은 명시된 요구 사항을 충족하는 키를 생성하고 이를 mongo
shell에 로드합니다.
TEST_LOCAL_KEY=$(echo "$(head -c 96 /dev/urandom | base64 | tr -d '\n')") mongosh --nodb --shell --eval "var TEST_LOCAL_KEY='$TEST_LOCAL_KEY'"
생성된 로컬 키 문자열을 사용하여 클라이언트 사이드 필드 수준 암호화 객체를 생성합니다.
var ClientSideFieldLevelEncryptionOptions = { "keyVaultNamespace" : "encryption.__dataKeys", "kmsProviders" : { "local" : { "key" : BinData(0, TEST_LOCAL_KEY) } } }
Mongo()
생성자를 사용하여 클라이언트 사이드 필드 수준 암호화 옵션으로 데이터베이스 연결을 생성합니다. mongodb://myMongo.example.net
URI를 대상 cluster의 연결 문자열 URI 로 바꿉니다.
encryptedClient = Mongo( "mongodb://myMongo.example.net:27017/?replSetName=myMongo", ClientSideFieldLevelEncryptionOptions )
KeyVault
객체를 검색하고 KeyVault.addKeyAlternateName()
메서드를 사용하여 UUID
과 일치하는 데이터 암호화 키에 새 키 대체 이름을 추가합니다. 지정된 키 대체 이름은 고유 해야 합니다.
keyVault = encryptedClient.getKeyVault() keyVault.addKeyAlternateName(UUID("b4b41b33-5c97-412e-a02b-743498346079"),"Other-Data-Encryption-Key")
성공하면 addKeyAlternateName()
는 이전 버전의 데이터 암호화 키 문서를 반환합니다.
{ "_id" : UUID("b4b41b33-5c97-412e-a02b-743498346079"), "keyMaterial" : BinData(0,"PXRsLOAYxhzTS/mFQAI8486da7BwZgqA91UI7NKz/T/AjB0uJZxTvhvmQQsKbCJYsWVS/cp5Rqy/FUX2zZwxJOJmI3rosPhzV0OI5y1cuXhAlLWlj03CnTcOSRzE/YIrsCjMB0/NyiZ7MRWUYzLAEQnE30d947XCiiHIb8a0kt2SD0so8vZvSuP2n0Vtz4NYqnzF0CkhZSWFa2e2yA=="), "creationDate" : ISODate("2019-08-12T21:21:30.569Z"), "updateDate" : ISODate("2019-08-12T21:21:30.569Z"), "status" : 0, "version" : NumberLong(0), "masterKey" : { "provider" : "local" }, "keyAltNames" : [ ] }
데이터 암호화 키 문서의 현재 버전을 보려면 반환된 KeyVault.getKey()
_id
문서의 을 지정하는 을 사용 하거나 중 KeyVault.getKeyByAltName()
하나를 지정하는 를 keyAltNames
사용합니다.