클래스: Mongo::Crypt::ExplicitEncrypter Private

상속:
객체
  • 객체
모두 표시
확장자:
전달 가능
다음에 정의됨:
lib/ Mongo/crypt/explicit_encrypter.rb

개요

이 클래스는 비공개 API의 일부입니다. 이 클래스는 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

ExplicitEncrypter는 명시적 암호화 작업을 수행하고 모든 관련 옵션 및 인스턴스 변수를 처리하는 객체입니다.

인스턴스 메서드 요약 접기

생성자 세부 정보

#initialize(key_vault_client, key_vault_namespace, kms_providers, kms_tls_options, timeout_ms = nil, key_expiration_ms = nil) ⇒ ExplicitEncrypter

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

새 ExplicitEncrypter 객체를 만듭니다.

매개변수:

  • key_Vault_client (Mongo::Client) —

    키 볼트 컬렉션 에 연결할 Mongo::Client 인스턴스 입니다.

  • key_Vault_namespace (string) —

    'db_name.collection_name' 형식의 키 볼트 컬렉션 의 네임스페이스 .

  • kms_providers (Crypt:: KMS::Credentials) —

    KMS 구성 정보의 해시입니다.

  • kms_tls_options (해시) —

    KMS 제공자에 연결하기 위한 TLS 옵션. 해시의 키는 KSM 제공자 이름이어야 합니다. 값은 TLS 연결 옵션의 해시여야 합니다. 이 옵션은 Mongo::Client의 TLS 연결 옵션과 동일합니다.

  • timeout_ms (정수 | nil) (기본값: nil) —

    이 객체 에서 실행된 모든 작업의 시간 초과입니다.

  • key_expiration_ms (정수 | nil) (기본값: nil) —

    데이터 암호화 키 캐시 의 수명(밀리초)입니다. 0 값은 캐시 만료되지 않음을 의미합니다. nil인 경우, libmongocrypt의 기본값 인 60000이 사용됩니다.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# 파일 'lib/ Mongo/crypt/explicit_encrypter.rb', 줄 43

def 초기화(
  key_Vault_client, key_Vault_namespace, kms_providers, kms_tls_options,
  timeout_ms = nil, key_expiration_ms = nil
)
  암호화.validate_ffi!
  @crypt_handle = 핸들.신규(
    kms_providers,
    kms_tls_options,
    명시적_암호화_전용: true,
    key_expiration_ms: key_expiration_ms
  )
  @encryption_io = EncryptionIO.신규(
    key_vault_client: key_Vault_client,
    metadata_client: nil,
    key_vault_namespace: key_Vault_namespace
  )
  @timeout_ms = timeout_ms
end

인스턴스 메서드 세부 정보

#add_key_alt_name(ID, key_alt_name) ⇒ BSON::Document | nil

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

지정된 ID를 가진 키 볼트 컬렉션의 키에 대한 key_alt_name을 추가합니다.

매개변수:

  • id (BSON::Binary) —

    새 키 대체 이름을 추가할 키의 ID입니다.

  • key_alt_name (string) —

    추가할 새 키 대체 이름입니다.

반환합니다:

  • (BSON::Document | nil) —

    키를 추가하기 전에 식별된 키를 설명하는 문서로, 해당 키가 없는 경우 nil을 추가하세요.



218
219
220
 
# 파일 'lib/ Mongo/crypt/explicit_encrypter.rb', 줄 218

def add_key_alt_name(id, key_alt_name)
  @encryption_io.add_key_alt_name(id, key_alt_name, timeout_ms: @timeout_ms)
end

#create_and_insert_data_key(master_key_document, key_alt_names, key_material = nil) ⇒ BSON::Binary

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

암호화/복호화에 사용되는 데이터 키를 생성하고 해당 키를 KMS 컬렉션에 저장합니다. 생성된 키는 KMS 마스터 키로 암호화됩니다.

매개변수:

  • master_key_document (Mongo::Crypt::KMS::MasterKeyDocument) —

    마스터 암호화 키 매개변수가 포함된 마스터 키 문서입니다.

  • key_alt_names (Array<String> | nil) —

    새 데이터 키의 대체 이름을 지정하는 문자열의 선택적 배열입니다.

  • key_material (string | nil) (기본값: nil) —

    생성 중인 데이터 키의 사용자 지정 키 자료로 사용할 선택적 96 바이트입니다. key_material 옵션이 지정되면 사용자 지정 키 자료가 데이터 암호화 및 암호 해독에 사용됩니다.

반환합니다:

  • (BSON::Binary) —

    새 데이터 키의 16-바이트 UUID로, 유형이 :uuid인 BSON::Binary 객체 입니다.



77
78
79
80
81
82
83
84
85
86
87
88
89
 
# 파일 'lib/ Mongo/crypt/explicit_encrypter.rb', 줄 77

def create_and_insert_data_key(master_key_document, key_alt_names, key_material = nil)
  data_key_document = 암호화::DataKeyContext.신규(
    @crypt_handle,
    @encryption_io,
    master_key_document,
    key_alt_names,
    key_material
  ).run_state_ machine(timeout_holder)

  @encryption_io.insert_data_key(
    data_key_document, timeout_ms: timeout_holder.잔여 시간 초과_ms!
  ).insert_id
end

#Decrypt(value) ⇒ 객체

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

이미 암호화된 값을 해독합니다.

매개변수:

  • value (BSON::Binary) —

    해독될 하위 유형 6 (암호 텍스트)의 BSON 바이너리 객체입니다.

반환합니다:

  • (객체) —

    해독된 값



203
204
205
206
207
208
209
 
# 파일 'lib/ Mongo/crypt/explicit_encrypter.rb', 줄 203

def 암호 해독(value)
  암호화::명시적 암호 해독 컨텍스트.신규(
    @crypt_handle,
    @encryption_io,
    { v: value }
  ).run_state_ machine(timeout_holder)['v']
end

#delete_key(ID) ⇒ Operation::Result

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

키 볼트 컬렉션 에서 지정된 ID의 키를 제거합니다.

매개변수:

  • id (BSON::Binary) —

    삭제 키의 ID입니다.

반환합니다:

  • (Operation::Result) —

    키를 삭제하는 delete_one 작업에 대한 데이터베이스의 응답입니다.



228
229
230
 
# 파일 'lib/ Mongo/crypt/explicit_encrypter.rb', 줄 228

def delete_key(id)
  @encryption_io.delete_key(id, timeout_ms: @timeout_ms)
end

#암호화(값, 옵션) ⇒ BSON::Binary

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

참고:

:key_id 및 :key_alt_name 옵션은 상호 배타적입니다. 명시적 암호화를 수행하는 데는 하나만 필요합니다.

지정된 암호화 키 및 알고리즘을 사용하여 값을 암호화합니다.

매개변수:

  • value (객체) —

    암호화할 값

  • 옵션 (해시)

옵션 해시(options):

  • :key_id (BSON::Binary) —

    키 볼트 컬렉션 에 저장된 암호화 키 의 UUID를 나타내는 :uuid 유형의 BSON::Binary 객체 입니다.

  • :key_alt_name (string) —

    암호화 키의 대체 이름입니다.

  • :algorithm (string) —

    The algorithm used to encrypt the value. Valid algorithms are "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic", "AEAD_AES_256_CBC_HMAC_SHA_512-Random", "Indexed", "Unindexed", "Range", "String".

  • :contention_factor (정수 | nil) —

    암호화 알고리즘 'Indexed(인덱스)', 'Range(범위)' 또는 'String(문자열)'으로 설정하다 경우 적용되는 경합 요인입니다. 제공하지 않으면 기본값은 0입니다. 경합 요인은 암호화 알고리즘 'Indexed(인덱스)', 'Range(범위)' 또는 'String(문자열)'으로 설정하다 경우에만 설정하다 해야 합니다.

  • :query_type (string | nil) —

    암호화 알고리즘 '인덱스', '범위' 또는 '문자열'로 설정하다 경우 적용할 쿼리 유형입니다. 허용되는 값은 다음과 같습니다. ('인덱스됨'의 경우), '범위' ('Range'의 경우) 및 'prefix', 'suffix', 'substring' ('String'의 경우).

  • :range_opts (해시 | nil) —

    "range"를 지원하는 Queryable Encryption 필드 에 대한 인덱스 옵션을 지정합니다. 쿼리. 알고리즘 '범위'인 경우 필수 사항입니다.

  • :string_opts (해시 | nil) —

    "prefix", "suffix" 또는 "substring" 을 지원하는 Queryable Encryption 필드 에 대한 인덱스 옵션을 지정합니다. 쿼리. 알고리즘 '문자열'인 경우 필수 사항입니다.

반환합니다:

  • (BSON::Binary) —

    암호화된 값을 나타내는 하위 유형 6 (암호 텍스트)의 BSON 바이너리 객체

다음을 발생시킵니다.

  • (ArgumentError) —

    경쟁 요소 또는 쿼리 유형이 설정하다 알고리즘 '인덱스', '범위' 또는 '문자열'이 아닌 경우.



128
129
130
131
132
133
134
135
 
# 파일 'lib/ Mongo/crypt/explicit_encrypter.rb', 줄 128

def 암호화(value, 옵션)
  암호화::명시적 암호화 컨텍스트.신규(
    @crypt_handle,
    @encryption_io,
    { v: value },
    옵션
  ).run_state_ machine(timeout_holder)['v']
end

# 암호화 표현식 (표현식, 옵션) ⇒BSON :: Binary

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

참고:

범위 알고리즘 실험용으로만 제공됩니다. 그렇지 않습니다.

참고:

:key_id 및 :key_alt_name 옵션은 상호 배타적입니다. 명시적 암호화를 수행하는 데는 하나만 필요합니다.

범위 인덱스를 쿼리하기 위해 일치 표현식 또는 애그리게이션 표현식을 암호화합니다.

queryType이 ' 범위'이고 알고리즘 이 'Range'인 경우에만 지원됩니다. @note: 범위 알고리즘 은 실험적일 뿐입니다. 공개적으로 사용할 수 없습니다. 호환성이 손상되는 변경이 발생할 수 있습니다.

@param [ 해시 ] 옵션

공개적으로 사용하기 위한 것입니다.

예시:

암호화 일치 표현식.

encryption.encrypt_expression(
  {'$and' =>  [{'field' => {'$gt' => 10}}, {'field' =>  {'$lt' => 20 }}]}
)

애그리게이션 표현식을 암호화합니다.

encryption.encrypt_expression(
  {'$and' =>  [{'$gt' => ['$field', 10]}, {'$lt' => ['$field', 20]}}
)
{$and: [{$gt: [<fieldpath>, <value1>]}, {$lt: [<fieldpath>, <value2>]}]

매개변수:

  • 표현식 (해시) —

    암호화할 표현식입니다.

  • 옵션 (해시) —

    사용자 지정 가능한 옵션 세트

옵션 해시(options):

  • :key_id (BSON::Binary) —

    키 볼트 컬렉션 에 저장된 암호화 키 의 UUID를 나타내는 :uuid 유형의 BSON::Binary 객체 입니다.

  • :key_alt_name (string) —

    암호화 키의 대체 이름입니다.

  • :algorithm (string) —

    표현식 을 암호화하는 데 사용되는 알고리즘 . 허용되는 유일한 값은 'Range'입니다.

  • :contention_factor (정수 | nil) —

    적용할 경합 요인을 제공하지 않으면 기본값은 0 입니다.

  • query_type (string | nil) —

    적용할 쿼리 유형입니다. 허용되는 유일한 값은 "범위"입니다.

  • :range_opts (해시 | nil) —

    ' 범위 ' 쿼리를 지원하는 Queryable Encryption 필드 에 대한 인덱스 옵션을 지정합니다. 허용되는 옵션은 다음과 같습니다.

    • :min
    • :max
    • :trim_factor
    • :sparsity
    • :precision 최소, 최대, 트림_인자, 희소성 및 정밀도는 대상 컬렉션 의 암호화된 필드에 설정하다 값과 일치해야 합니다. double 및 십진수128의 경우 최소/최대/정밀도를 모두 설정하다 하거나 모두 설정 해제해야 합니다.

반환합니다:

  • (BSON::Binary) —

    암호화됨 표현식 나타내는 하위 유형 6 (암호 텍스트)의 BSON 바이너리 객체 입니다.

다음을 발생시킵니다.

  • (ArgumentError) —

    options 에 허용되지 않는 값이 설정하다 경우.



188
189
190
191
192
193
194
195
 
# 파일 'lib/ Mongo/crypt/explicit_encrypter.rb', 줄 188

def 암호화 표현식(표현식, 옵션)
  암호화::명시적 암호화 표현식 컨텍스트.신규(
    @crypt_handle,
    @encryption_io,
    { v: 표현식 },
    옵션
  ).run_state_ machine(timeout_holder)['v']
end

#get_key(id) ⇒ BSON::Document | nil

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

지정된 ID를 가진 단일 키를 찾습니다.

매개변수:

  • id (BSON::Binary) —

    가져올 키의 ID입니다.

반환합니다:

  • (BSON::Document | nil) —

    발견된 키 문서 를 반환하거나, 찾을 수 없는 경우 nil을 반환합니다.



238
239
240
 
# 파일 'lib/ Mongo/crypt/explicit_encrypter.rb', 줄 238

def get_key(id)
  @encryption_io.get_key(id, timeout_ms: @timeout_ms)
end

#get_key_by_alt_name(key_alt_name) ⇒ BSON::Document | nil

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

지정된 key_alt_name을 가진 키 볼트 컬렉션 의 키를 반환합니다.

매개변수:

  • key_alt_name (string) —

    키를 찾으려면 키 대체 이름을 입력합니다.

반환합니다:

  • (BSON::Document | nil) —

    발견된 키 문서 를 반환하거나, 찾을 수 없는 경우 nil을 반환합니다.



248
249
250
 
# 파일 'lib/ Mongo/crypt/explicit_encrypter.rb', 줄 248

def get_key_by_alt_name(key_alt_name)
  @encryption_io.get_key_by_alt_name(key_alt_name, timeout_ms: @timeout_ms)
end

#get_keys ⇒ Collection::View

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

키 볼트 컬렉션 의 모든 키를 반환합니다.

Rubocop:disable Naming/AccessorMethodName 이 메서드의 이름은 FLE 사양에 정의되어 있습니다.

반환합니다:



257
258
259
 
# 파일 'lib/ Mongo/crypt/explicit_encrypter.rb', 줄 257

def get_keys
  @encryption_io.get_keys(timeout_ms: @timeout_ms)
end

#remove_key_alt_name(ID, key_alt_name) ⇒ BSON::Document | nil

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

지정된 ID를 가진 키 볼트 컬렉션 의 키에서 key_alt_name을 제거합니다.

매개변수:

  • id (BSON::Binary) —

    키 대체 이름을 제거 키의 ID입니다.

  • key_alt_name (string) —

    제거할 키 대체 이름입니다.

반환합니다:

  • (BSON::Document | nil) —

    키를 제거하기 전에 식별된 키를 설명하는 문서로 대체 이름을 지정하고, 해당 키가 없는 경우 nil을 지정합니다.



269
270
271
 
# 파일 'lib/ Mongo/crypt/explicit_encrypter.rb', 줄 269

def remove_key_alt_name(id, key_alt_name)
  @encryption_io.remove_key_alt_name(id, key_alt_name, timeout_ms: @timeout_ms)
end

#rewrap_many_data_key(필터하다, opts = {}) ⇒ Crypt::RewrapManyDataKeyResult

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

여러 데이터 키를 해독하고 새 마스터 키로 데이터 키를 (재)암호화하거나, 새 키가 제공되지 않은 경우 현재 마스터 키로 암호화합니다.

매개변수:

  • 필터 (해시) —

    업데이트할 키를 찾는 데 사용되는 필터입니다.

  • 옵션 (해시)

반환합니다:



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# 파일 'lib/ Mongo/crypt/explicit_encrypter.rb', 줄 284

def rerap_many_data_key(필터, opts = {})
  validate_rerap_options!(opts)

  master_key_document = master_key_for_provider(opts)

  rerap_result = 암호화::RewrapManyDataKeyContext.신규(
    @crypt_handle,
    @encryption_io,
    필터,
    master_key_document
  ).run_state_ machine(timeout_holder)

  반환 RewrapManyDataKeyResult.신규(nil) 만약 rerap_result.nil?

  업데이트 = update_from_data_key_documents(rerap_result.가져오기('v'))
  RewrapManyDataKeyResult.신규(
    @encryption_io.update_data_keys(업데이트, timeout_ms: @timeout_ms)
  )
end