자동 암호화 규칙

encrypt Schema Keyword

"bsonType" : "object",
"properties" : {
  "<fieldName>" : {
    "encrypt" : {
      "algorithm" : "<string>",
      "bsonType" : "<string>" | [ "<string>" ],
      "keyId" : [ <UUID> ]
    }
  }
}

encrypt

객체

<fieldName> 을(를) 암호화해야 함을 나타냅니다. encrypt 객체에는 다음과 같은 요구 사항이 있습니다.

• encrypt <fieldName> 객체에 형제 필드를 가질 수 없습니다. encrypt 은(는) <fieldName> 객체의 유일한 하위 객체여야 합니다.

• encrypt items 또는 additionalItems 키워드의 하위 스키마 내에서 지정할 수 없습니다. 특히 자동 클라이언트 사이드 필드 수준 암호화 는 배열 의 개별 요소 암호화를 지원 하지 않습니다.

encrypt 객체에는 다음 필드 만 포함될 수 있습니다.

• algorithm

• bsonType

• keyId

encrypt 객체에 다른 필드를 포함하면 자동으로 암호화된 읽기 또는 쓰기 작업을 실행할 때 오류가 발생합니다.

keyId 또는 algorithm 이 생략되면 자동 암호화 공유 라이브러리는 상위 필드의 전체 트리를 확인하고 옵션을 지정하는 가장 가까운 encryptMetadata 객체 에서 해당 옵션을 구성하려고 시도합니다. algorithm는 bsonType 상속될 수 없으며 의 값에 따라 필요할 수 있습니다.

자동 암호화 공유 라이브러리가 객체에 지정된 필드와 필수 encryptMetadata상속 키를 사용하여 전체 encrypt 객체를 구성할 수 없는 경우 자동 암호화가 실패하고 오류를 반환합니다.

encrypt.algorithm

문자열

<fieldName> 의 값을 암호화할 때 사용할 암호화 알고리즘을 나타냅니다. 다음 알고리즘 만 지원합니다.

• AEAD_AES_256_CBC_HMAC_SHA_512-Random

• AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic

암호화 알고리즘에 대한 전체 문서는 암호화 알고리즘을 참조하세요 .

생략하면 자동 암호화 공유 라이브러리는 상위 필드의 전체 트리에서 가장 가까운 encryptMetadata.algorithm 키를 확인하고 해당 값을 상속합니다. 상위 algorithm 이(가) 존재하지 않으면 자동 필드 수준 암호화가 실패하고 오류를 반환합니다.

• encrypt.algorithm 또는 상속된 값이 AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic 인 경우 encrypt 객체에는 encrypt.bsonType 필드가 필요합니다.

• 또는 encrypt.algorithm 상속된 값이 AEAD_AES_256_CBC_HMAC_SHA_512-Random 인 encrypt 경우 encrypt.bsonType 객체 에는 필드 가 포함될 수 있습니다.

encrypt.bsonType

문자열 | 문자열 배열

암호화됨 되는 필드 의 BSON 입니다. encrypt.algorithm 가 AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic 인 경우 필수 사항입니다.

encrypt.algorithm 또는 상속된 값이 AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic 인 경우 bsonType(은)는 단일 유형을 지정 해야 합니다 . bsonType(은)는 결정론적 암호화 알고리즘을 사용하여 다음 BSON types을 지원하지 않습니다 .

• double

• decimal128

• bool

• object

• array

encrypt.algorithm 또는 상속된 값이 AED_AES_256_CBC_HMAC_SHA_512-Random인 경우, bsonType은 선택 사항이며, 지원되는 BSON 유형의 배열을 지정할 수 있습니다. bsonType 또는 array 또는 object 필드의 경우 클라이언트는 개별 요소가 아닌 전체 배열 또는 객체를 암호화합니다.

encrypt.bsonType 또는 상속된 값에 encrypt.algorithm 관계없이 다음 유형을 지원하지 않습니다 .

• minKey

• maxKey

• null

• undefined

encrypt.keyId

단일 UUID 배열

필드 값을 암호화하는 데 사용할 데이터 암호화 키의 UUID입니다. UUID는 BSON 바이너리 데이터 4입니다. 하위 유형 의 요소입니다.

배열 내부에 하나 의 문자열을 지정합니다.

생략하면 자동 암호화 공유 라이브러리 는 상위 필드의 전체 트리에서 가장 가까운 encryptMetadata.keyId 키를 확인하고 해당 값을 상속합니다. 상위 keyId 이(가) 없으면 자동 필드 수준 암호화가 실패하고 오류를 반환합니다.

또는 keyId 상속된 값이 자동 암호화 구성 옵션 의 일부로 지정된 키 볼트에 있어야 합니다. 지정된 데이터 암호화 키가 존재하지 않으면 자동 암호화가 실패합니다.

공식 MongoDB 드라이버에는 언어별로 UUID 지정 요구 사항이 있습니다. 클라이언트 사이드 필드 레벨 암호화 구현에 대한 전체 설명서는 드라이버 설명서를 따르세요.

encryptMetadata Schema Keyword

{
  "bsonType" : "object",
  "encryptMetadata" : {
    "algorithm" : "<string>",
    "keyId" : [ <UUID> ]
  },
  "properties" : {
    "encrypt" : {}
  }
}

encryptMetadata

객체

형제 properties 에 중첩된 encrypt 객체가 상속할 수 있는 암호화 옵션을 정의합니다. encrypt 에 암호화를 지원하는 데 필요한 옵션이 누락된 경우, 자동 암호화 공유 라이브러리는 상위 객체의 전체 트리를 검색하여 누락된 옵션을 지정하는 encryptMetadata 객체를 찾습니다.

encryptMetadata bsonType: "object" 을(를) 사용하여 하위 스키마에 지정해야 합니다. encryptMetadata 은(는) items 또는 additionalItems 키워드의 하위 스키마에 지정할 수 없습니다. 특히 자동 클라이언트 사이드 필드 수준 암호화는 배열의 개별 요소 암호화를 지원하지 않습니다.

encryptMetadata 객체에는 다음 필드 만 포함될 수 있습니다. encrypt 객체에 다른 필드를 포함하면 자동으로 암호화된 읽기 또는 쓰기 작업을 실행할 때 오류가 발생합니다.

• algorithm

• keyId

encryptMetadata.algorithm

문자열

지정된 필드를 암호화하는 데 사용할 암호화 알고리즘입니다. encrypt 객체에 algorithm 필드가 누락된 경우 자동 암호화 공유 라이브러리는 상위 객체의 전체 트리를 검색하여encryptMetadata.algorithm를 지정하는 encryptMetadata 객체를 찾습니다

다음 알고리즘 만 지원합니다.

• AEAD_AES_256_CBC_HMAC_SHA_512-Random

• AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic

암호화 알고리즘에 대한 전체 문서는 암호화 알고리즘을 참조하세요 .

을 지정하는 경우 해당 AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic encrypt 값을 상속하는 모든 객체 는 를 지정 해야 encrypt.bsonType 합니다 .

encryptMetadata.keyId

단일 UUID 배열

데이터 암호화 키의 UUID입니다. UUID는 BSON 바이너리 데이터 4입니다. 하위 유형 의 요소입니다.

배열 내부에 하나 의 문자열을 지정합니다.

encrypt 객체 에 keyId 필드 가 누락된 경우 자동 암호화 공유 라이브러리는 상위 객체의 전체 트리를 검색하여encryptMetadata.keyId를 지정하는 encryptMetadata 객체 를 찾습니다

데이터 암호화 키 는 자동 암호화 구성 옵션 의 일부로 지정된 키 볼트에 있어야 합니다. 지정된 구성 옵션에는 데이터 키를 생성하는 데 사용된 KMS (KMS) 및 고객 마스터 키 (CMK )에 대한 적절한 액세스 도 포함되어야 합니다. 데이터 암호화 키 가 없거나 클라이언트 가 지정된 KMS 및 CMK 로 키를 해독할 수 없는 경우 자동 암호화 가 실패합니다.

공식 MongoDB 드라이버에는 언어별로 UUID 지정 요구 사항이 있습니다. 클라이언트 사이드 필드 레벨 암호화 구현에 대한 전체 설명서는 드라이버 설명서를 따르세요.

예시

• 여러 필드를 자동으로 암호화

• 상속을 통해 여러 필드를 자동으로 암호화

{
  "fname" : "<String>",
  "lname" : "<String>",
  "passportId" : "<String>",
  "bloodType" : "<String>",
  "medicalRecords" : [
    {<object>}
  ],
  "insurance" : {
    "policyNumber" : "<string>",
    "provider" : "<string>"
  }
}

{
  "MedCo.patients" : {
    "bsonType" : "object",
    "properties" : {
      "passportId" : {
        "encrypt" : {
          "keyId" : [UUID("bffb361b-30d3-42c0-b7a4-d24a272b72e3")],
          "algorithm" : "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic",
          "bsonType" : "string"
        }
      },
      "bloodType" : {
        "encrypt" : {
          "keyId" : [UUID("bffb361b-30d3-42c0-b7a4-d24a272b72e3")],
          "algorithm" : "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic",
          "bsonType" : "string"
        }
      },
      "medicalRecords" : {
        "encrypt" : {
          "keyId" : [UUID("f3821212-e697-4d65-b740-4a6791697c6d")],
          "algorithm" : "AEAD_AES_256_CBC_HMAC_SHA_512-Random",
          "bsonType" : "array"
        }
      },
      "insurance" : {
        "bsonType" : "object",
        "properties" : {
          "policyNumber" : {
            "encrypt" : {
              "keyId" : [UUID("bffb361b-30d3-42c0-b7a4-d24a272b72e3")],
              "algorithm" : "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic",
              "bsonType" : "string"
            }
          },
          "provider" : {
            "encrypt" : {
              "keyId" : [UUID("bffb361b-30d3-42c0-b7a4-d24a272b72e3")],
              "algorithm" : "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic",
              "bsonType" : "string"
            }
          }
        }
      }
    }
  }
}

{
  "fname" : "<String>",
  "lname" : "<String>",
  "passportId" : "<String>",
  "bloodType" : "<String>",
  "medicalRecords" : [
    {<object>}
  ],
  "insurance" : {
    "policyNumber" : "<string>",
    "provider" : "<string>"
  }
}

{
  "MedCo.patients" : {
    "bsonType" : "object",
    "encryptMetadata" : {
      "keyId" : [UUID("6c512f5e-09bc-434f-b6db-c42eee30c6b1")],
      "algorithm" : "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic"
    },
    "properties" : {
      "passportId" : {
        "encrypt" : {
          "bsonType" : "string"
        }
      },
      "bloodType" : {
        "encrypt" : {
          "bsonType" : "string"
        }
      },
      "medicalRecords" : {
        "encrypt" : {
          "keyId" : [UUID("6c512f5e-09bc-434f-b6db-c42eee30c6b1")],
          "algorithm" : "AEAD_AES_256_CBC_HMAC_SHA_512-Random",
          "bsonType" : "array"
        }
      },
      "insurance" : {
        "bsonType" : "object",
        "properties" : {
          "policyNumber" : {
            "encrypt" : {
              "bsonType" : "string"
            }
          },
          "provider" : {
            "encrypt" : {
              "bsonType" : "string"
            }
          }
        }
      }
    }
  }
}