클래스: Mongo::Crypt:: KMS::KMIP::MasterKeyDocument Private

상속:
객체
  • 객체
모두 표시
다음을 포함합니다.
유효성 검사
다음에 정의됨:
build/ruby-driver-v2.19/lib/mongo/crypt/KMS/kmip/master_document.rb

개요

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

KMIP KMS 마스터 키 문서 객체 에는 KMS 마스터 키 매개 변수가 포함되어 있습니다.

상수 요약 접기

FORMAT_HINT =

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

"KMIP KMS 키 문서 는 다음 형식이어야 합니다. " +
"{ key_id: 'KEY-ID', endpoint: 'ENDPOINT' }"

인스턴스 속성 요약 접기

인스턴스 메서드 요약 접기

유효성 검사에 포함된 메서드

#validate_param, validate_tls_options

생성자 세부 정보

#initialize(opts = {}) ⇒ MasterKeyDocument

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

매개변수 해시 형식으로 마스터 키 문서 객체를 생성합니다.

매개변수:

  • opts (해시) (기본값: {}) —

    KMIP KMS 제공자 에 대한 마스터 키 옵션이 포함된 해시

옵션 해시(opts):

  • :key_id (string | nil) —

    96 바이트 KMIP 시크릿 데이터 관리 객체에 대한 KMIP 고유 식별자(선택 사항). key_id를 생략하면 드라이버는 임의의 96 바이트 식별자를 생성합니다.

  • :endpoint (string | nil) —

    KMIP 엔드포인트, 선택 사항.

다음을 발생시킵니다.

  • (ArgumentError) —

    필수 옵션이 누락되었거나 형식이 잘못된 경우.



49
50
51
52
53
54
55
56
 
# 파일 'build/ruby-driver-v2.19/lib/mongo/crypt/KMS/kmip/master_document.rb', 줄 49

def 초기화(opts = {})
  @key_id = validate_param(
    :key_id, opts, FORMAT_HINT, 필수: 거짓
  )
  @endpoint = validate_param(
    :endpoint, opts, FORMAT_HINT, 필수: 거짓
  )
end

인스턴스 속성 세부 정보

#엔드포인트 ⇒ string | nil (읽기 전용)

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

선택적 포트가 있는 KMIP KMS 엔드포인트를 반환합니다.

반환합니다:

  • (string | nil) —

    선택적 포트가 있는 KMIP KMS 엔드포인트.



33
34
35
 
# 파일 'build/ruby-driver-v2.19/lib/mongo/crypt/KMS/kmip/master_document.rb', 줄 33

def 엔드포인트
  @endpoint
end

#key_id ⇒ string | nil (읽기 전용)

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

KMIP 고유 식별자를 96 바이트 KMIP 시크릿 데이터 관리 객체에 반환합니다.

반환합니다:

  • (string | nil) —

    96 바이트 KMIP 비밀 데이터 managed 객체 에 대한 KMIP 고유 식별자입니다.



30
31
32
 
# 파일 'build/ruby-driver-v2.19/lib/mongo/crypt/KMS/kmip/master_document.rb', 줄 30

def key_id
  @key_id
end

인스턴스 메서드 세부 정보

#to_document ⇒ BSON::Document

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

마스터 키 문서 객체를 libmongocrypt 형식의 BSON 문서로 변환합니다.

반환합니다:

  • (BSON::Document) —

    libmongocrypt 형식의 KMIP KMS 자격 증명입니다.



61
62
63
64
65
66
67
68
 
# 파일 'build/ruby-driver-v2.19/lib/mongo/crypt/KMS/kmip/master_document.rb', 줄 61

def to_document
  BSON::문서.신규({
    제공자: 'kmip',
  }).탭 do |BSON|
    BSON.update({ 엔드포인트: 엔드포인트 }) 하지 않는 한 엔드포인트.nil?
    BSON.update({ keyId: key_id }) 하지 않는 한 key_id.nil?
  end
end