클래스: Mongo::Crypt::KMS::Credentials Private

상속:
객체
  • 객체
모두 표시
다음에 정의됨:
build/ruby-driver-v2.19/lib/mongo/crypt/KMS/credentials.rb

개요

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

KMS 자격 증명 객체에는 KMS 제공자를 사용하기 위한 자격 증명이 포함되어 있습니다.

인스턴스 속성 요약 접기

인스턴스 메서드 요약 접기

생성자 세부 정보

#initialize(kms_providers) ⇒ 자격 증명

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

참고:

지정된 KMS 제공자가 두 개 이상 있을 수 있습니다.

매개변수 해시 형식으로 KMS 자격 증명 객체를 생성합니다.

매개변수:

  • kms_providers (해시) —

    KMS 제공자에 대한 자격 증명이 포함된 해시입니다. 해시에는 KMS 제공자 이름이 키로, 모든 제공자에 대한 필수 매개변수가 값으로 있어야 합니다. KMS 제공자에 대한 필수 매개변수는 Mongo::Crypt::KMS 모듈 내의 해당 클래스에 설명되어 있습니다.

다음을 발생시킵니다.

  • (ArgumentError) —

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# 파일 'build/ruby-driver-v2.19/lib/mongo/crypt/KMS/credentials.rb', 줄 54

def 초기화(kms_providers)
  만약 kms_providers.nil?
    올리다 ArgumentError.신규("KMS 제공자 옵션은 nil이 아니어야 합니다")
  end
  만약 kms_providers.키?(:aws)
    @aws = AWS::자격 증명.신규(kms_providers[:aws])
  end
  만약 kms_providers.키?(:azure)
    @azure = Azure::자격 증명.신규(kms_providers[:azure])
  end
  만약 kms_providers.키?(:gcp)
    @gcp = GCP::자격 증명.신규(kms_providers[:gcp])
  end
  만약 kms_providers.키?(:kmip)
    @kmip = KMIP::자격 증명.신규(kms_providers[:kmip])
  end
  만약 kms_providers.키?(:local)
    @local = 로컬::자격 증명.신규(kms_providers[:local])
  end
  만약 @aws.nil? && @azure.nil? && @gcp.nil? && @kmip.nil? && @local.nil?
    올리다 ArgumentError.신규(
      "KMS 제공자 옵션에는 다음 키 중 하나가 있어야 합니다. " +
      ":aws, :azure, :gcp, :kmip, :local"
    )
  end
end

인스턴스 속성 세부 정보

#Amazon Web Services ⇒ Credentials::AWS | nil (읽기 전용)

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

Amazon Web Services KMS 자격 증명을 반환합니다.

반환합니다:

  • (Credentials::AWS | nil) —

    Amazon Web Services KMS 자격 증명.



28
29
30
 
# 파일 'build/ruby-driver-v2.19/lib/mongo/crypt/KMS/credentials.rb', 줄 28

def AWS
  @aws
end

#azure ⇒ Credentials::Azure | nil (읽기 전용)

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

Azure KMS 자격 증명을 반환합니다.

반환합니다:

  • (Credentials::Azure | nil) —

    Azure KMS 자격 증명.



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

def Azure
  @azure
end

#gcp ⇒ Credentials::GCP | nil (읽기 전용)

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

GCP KMS 자격 증명을 반환합니다.

반환합니다:

  • (Credentials::GCP | nil) —

    GCP KMS 자격 증명.



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

def GCP
  @gcp
end

#kmip ⇒ Credentials::KMIP | nil (읽기 전용)

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

KMIP KMS 자격 증명을 반환합니다.

반환합니다:

  • (Credentials::KMIP | nil) —

    KMIP KMS 자격 증명.



37
38
39
 
# 파일 'build/ruby-driver-v2.19/lib/mongo/crypt/KMS/credentials.rb', 줄 37

def KMIP
  @kmip
end

#local ⇒ Credentials::Local | nil (읽기 전용)

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

로컬 KMS 자격 증명을 반환합니다.

반환합니다:

  • (Credentials::Local | nil) —

    로컬 KMS 자격 증명.



40
41
42
 
# 파일 'build/ruby-driver-v2.19/lib/mongo/crypt/KMS/credentials.rb', 줄 40

def 로컬
  @local
end

인스턴스 메서드 세부 정보

#to_document ⇒ BSON::Document

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

자격 증명 객체 를 libmongocrypt 형식의 BSON 문서 로 변환합니다.

반환합니다:

  • (BSON::Document) —

    BSON 문서로서의 자격 증명.



84
85
86
87
88
89
90
91
92
 
# 파일 'build/ruby-driver-v2.19/lib/mongo/crypt/KMS/credentials.rb', 줄 84

def to_document
  BSON::문서.신규.탭 do |BSON|
    BSON[:aws] = @aws.to_document 만약 @aws
    BSON[:azure] = @azure.to_document 만약 @azure
    BSON[:gcp] = @gcp.to_document 만약 @gcp
    BSON[:kmip] = @kmip.to_document 만약 @kmip
    BSON[:local] = @local.to_document 만약 @local
  end
end