getClientEncryption() (mongosh 메서드)

getClientEncryption()

현재 데이터베이스 컬렉션 에 대한 ClientEncryption 객체 를 반환합니다. ClientEncryption 객체 는 클라이언트 사이드 필드 수준 암호화를 위한 필드 값의 명시적(수동) 암호화 및 암호 해독을 지원합니다.

반환합니다:	현재 데이터베이스 연결에 대한 `ClientEncryption` 객체입니다.

호환성

이 명령은 다음 환경에서 호스팅되는 배포에서 사용할 수 있습니다.

MongoDB Atlas: 클라우드에서의 MongoDB 배포를 위한 완전 관리형 서비스

MongoDB Enterprise: MongoDB의 구독 기반 자체 관리 버전
MongoDB Community: MongoDB의 소스 사용 가능 무료 자체 관리 버전

구문

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

db.getMongo().getClientEncryption();

다음과 같은 명시적 암호화 메서드에 액세스하려면 ClientEncryption 객체를 사용합니다.

행동

데이터베이스 연결에서 클라이언트 측 필드 레벨 암호화 활성화

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

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

예시

메서드는 가 존재하는 문서에 대해서만 부분 인덱스 필터를 사용하여 필드에 고유 getKeyVault() 인덱스 를 자동으로 생성합니다.keyAltNames keyAltNames getKeyVault() 는 키 볼트 컬렉션에 이 인덱스를 생성합니다. 이렇게 하면 동일한 Key Vault에 있는 두 개의 데이터 암호화 키가 동일한 키 대체 이름을 갖는 것을 방지할 수 있으므로 암호화/복호화에 어떤 데이터 암호화 키가 적합한지 모호해지는 것을 방지할 수 있습니다.

경고

getKeyVault() 에 의해 생성된 고유 인덱스를 삭제하지 않도록 합니다. 클라이언트 측 필드 레벨 암호화 작업은 keyAltNames 의 서버 적용 고유성에 따라 달라집니다. 인덱스를 제거하면 예기치 않거나 예측할 수 없는 동작이 발생할 수 있습니다.

다음 예에서는 클라이언트 사이드 필드 수준 암호화 구성을 위해 로컬로 managed 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
)

getClientEncryption() 메서드를 사용하여 클라이언트 암호화 객체를 검색합니다.

clientEncryption = encryptedClient.getClientEncryption()

자세히 알아보기

클라이언트 사이드 필드 레벨 암호화가 활성화된 상태에서 MongoDB 연결을 시작하는 방법에 대한 전체 설명서는 Mongo() 를 참조하세요.

돌아가기

ClientEncryption.decrypt

getKeyVault