MongoDB\Driver\ClientEncryption::createDataKey

(mongodb >=1.7.0)

MongoDB\Driver\ClientEncryption::createDataKey — 새 암호화 데이터 키 생성

설명

---

final public MongoDB\Driver\ClientEncryption::createDataKey(string $kmsProvider, array $options = ?): MongoDB\BSON\Binary

새 주요 문서를 만들어 주요 자격 증명 모음 컬렉션에 삽입합니다.

매개변수

---

kmsProvider

새 암호화 키를 암호화하는 데 사용할 KMS 공급자(예: "local","aws", "azure", "gcp")입니다.

options

Data key options

Option	Type	설명
masterKey	array	masterKey는 새 데이터 키를 암호화하는 데 사용되는 KMS별 키를 식별합니다. kmsProvider가 "local"이 아닌 경우 이 옵션이 필요합니다. kmsProvider가 "aws"인 경우 이 옵션은 필수이며 다음 필드가 있습니다. AWS masterKey options Option Type 설명 region string 필수 key string 필수. AWS 고객 마스터 키(CMK)에 대한 Amazon 리소스 이름(ARN). endpoint string 선택. KMS 요청을 보낼 대체 호스트 식별자입니다. 포트 번호를 포함할 수 있습니다. kmsProvider가 "azure"인 경우 이 옵션은 필수이며 다음 필드가 있습니다. Azure masterKey options Option Type 설명 keyVaultEndpoint string 필수. 선택적 포트가 있는 호스트(예: "example.vault.azure.net"). keyName string 필수. keyVersion string 선택. 명명된 키의 특정 버전입니다. 기본적으로 키의 기본 버전을 사용합니다. kmsProvider가 "gcp"인 경우 이 옵션은 필수이며 다음 필드가 있습니다. GCP masterKey options Option Type 설명 projectId string 필수. location string 필수. keyRing string 필수. keyName string 필수. keyVersion string 선택. 명명된 키의 특정 버전입니다. 기본적으로 키의 기본 버전을 사용합니다. endpoint string 선택. 선택적 포트가 있는 호스트. 기본값은 "cloudkms.googleapis.com"입니다.
keyAltNames	array<	키를 참조하는 데 사용되는 문자열 대체 이름의 선택적 목록입니다. 키가 대체 이름으로 생성된 경우 암호화는 _id 대신 고유한 대체 이름으로 키를 참조할 수 있습니다.

반환 값

---

새 키의 식별자를 하위 유형이 4(UUID)인 MongoDB\BSON\Binary 객체로 반환합니다.

오류/예외

---

• 인수 구문 분석 오류에 대해 MongoDB\Driver\Exception\InvalidArgumentException을 던집니다.
• 데이터 키를 생성하는 동안 오류가 발생하면 MongoDB\Driver\Exception\EncryptionException을 던집니다.

변경 로그

---