KeyVault.addKeyAlternateName() (mongosh 메서드)

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"
)

행동

데이터베이스 연결 시 클라이언트 측 필드 레벨 암호화 구성 필요

mongosh ClientEncryption 메서드를 사용하려면 사용 중 암호화 활성화된 데이터베이스 연결이 필요합니다. 사용 중 암호화 활성화된 상태에서 현재 데이터베이스 연결이 시작되지 않은 경우 다음 중 하나를 수행합니다.

Mongo() 의 mongosh 생성자를 사용하여 필요한 사용 중 암호화 옵션과 연결을 설정합니다. Mongo() 메서드는 고객 마스터 키 (CMK) 관리 위해 다음과 같은 KMS (KMS ) 공급자를 지원합니다.
or
mongosh 명령줄 옵션을 사용하여 필요한 옵션과의 연결을 설정합니다. 명령줄 옵션은 CMK 관리를 위한 Amazon Web Services KMS 제공자만 지원합니다.

예시

다음 예제는 클라이언트 사이드 필드 수준 암호화를 빠르게 평가하기 위한 것입니다. KeyVault.addKeyAlternateName() 지원되는 각 KMS 제공자와 함께 를 사용하는 구체적인 예는 암호화 키 관리를 참조하세요.

mongosh 시작

mongosh 클라이언트를 시작합니다.

mongosh --nodb

키 생성

로컬로 managed 키에 대한 클라이언트 사이드 필드 수준 암호화를 구성하려면 줄바꿈 없이 base64로 인코딩된 96바이트 문자열을 생성합니다.

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

클라이언트 측 필드 레벨 암호화 옵션 생성

생성된 로컬 키 문자열을 사용하여 클라이언트 사이드 필드 수준 암호화 옵션을 생성합니다.

 var autoEncryptionOpts = {
   "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",
   autoEncryptionOpts
)

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" : Long(0),
    "masterKey" : {
        "provider" : "local"
    },
    "keyAltNames" : [
    ]
}

데이터 암호화 키 문서의 현재 버전을 보려면 반환된 KeyVault.getKey() _id 문서의 을 지정하는 을 사용 하거나 중 KeyVault.getKeyByAltName() 하나를 지정하는 를 keyAltNames 사용합니다.

팁

암호화 키 관리(Encryption Key Management)

돌아가기

KeyVault.addKeyName

KeyVault.createDataKey