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

상속:
객체
  • 객체
모두 표시
확장자:
전달 가능
다음을 포함합니다.
유효성 검사
다음에 정의됨:
build/ruby-driver-v2.19/lib/mongo/crypt/KMS/Azure/credentials.rb

개요

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

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

상수 요약 접기

FORMAT_HINT =

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

'Azure KMS 제공자 옵션은 다음 형식이어야 합니다: \ { tenant_id: "TENANT- ID", client_id: "TENANT_ID", client_secret: "CLIENT_SECRET" }'

인스턴스 속성 요약 접기

인스턴스 메서드 요약 접기

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

#validate_param, validate_tls_options

생성자 세부 정보

#initialize(opts) ⇒ 자격 증명

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

매개 변수 해시 형식으로 Azure KMS 자격 증명 객체 를 만듭니다.

매개변수:

  • opts (해시) —

    Azure KMS 제공자 에 대한 자격 증명 이 포함된 해시

옵션 해시(opts):

  • :tenant_id (string) —

    Azure tenant id.

  • :client_id (string) —

    Azure 클라이언트 ID입니다.

  • :client_secret (string) —

    Azure 클라이언트 비밀.

  • :identity_platform_endpoint (string | nil) —

    Azure ID 플랫폼 엔드포인트, 선택 사항.

다음을 발생시킵니다.

  • (ArgumentError) —

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# 파일 ' 빌드/ Ruby-driver-v2.19/lib/mongo/crypt/KMS/Azure/ 자격 증명.rb', 줄 61

def 초기화(opts)
  @opts = opts
  반환 만약 비어 있나요?

  만약 opts[:access_token]
    @access_token = opts[:access_token]
  other
    @tenant_id = validate_param(:tenant_id, opts, FORMAT_HINT)
    @client_id = validate_param(:client_id, opts, FORMAT_HINT)
    @client_secret = validate_param(:client_secret, opts, FORMAT_HINT)
    @identity_platform_endpoint = validate_param(
      :identity_platform_endpoint, opts, FORMAT_HINT, 필수: 거짓
    )
  end
end

인스턴스 속성 세부 정보

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

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

Azure 액세스 토큰을 반환합니다.

반환합니다:

  • (string | nil) —

    Azure 액세스 토큰.



41
42
43
 
# 파일 ' 빌드/ Ruby-driver-v2.19/lib/mongo/crypt/KMS/Azure/ 자격 증명.rb', 줄 41

def access_token
  @access_token
end

#client_id ⇒ string (읽기 전용)

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

Azure 클라이언트 ID를 반환합니다.

반환합니다:

  • (string) —

    Azure 클라이언트 ID입니다.



32
33
34
 
# 파일 ' 빌드/ Ruby-driver-v2.19/lib/mongo/crypt/KMS/Azure/ 자격 증명.rb', 줄 32

def client_id
  @client_id
end

#client_secret ⇒ string (읽기 전용)

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

Azure 클라이언트 비밀을 반환합니다.

반환합니다:

  • (string) —

    Azure 클라이언트 비밀.



35
36
37
 
# 파일 ' 빌드/ Ruby-driver-v2.19/lib/mongo/crypt/KMS/Azure/ 자격 증명.rb', 줄 35

def client_secret
  @client_secret
end

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

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

Azure ID 플랫폼 엔드포인트를 반환합니다.

반환합니다:

  • (string | nil) —

    Azure ID 플랫폼 엔드포인트.



38
39
40
 
# 파일 ' 빌드/ Ruby-driver-v2.19/lib/mongo/crypt/KMS/Azure/ 자격 증명.rb', 줄 38

def identity_platform_endpoint
  @identity_platform_endpoint
end

#tenant_id ⇒ string (읽기 전용)

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

Azure 테넌트 ID를 반환합니다.

반환합니다:

  • (string) —

    Azure tenant id.



29
30
31
 
# 파일 ' 빌드/ Ruby-driver-v2.19/lib/mongo/crypt/KMS/Azure/ 자격 증명.rb', 줄 29

def tenant_id
  @tenant_id
end

인스턴스 메서드 세부 정보

#to_document ⇒ BSON::Document

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

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

반환합니다:

  • (BSON::Document) —

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# 파일 ' 빌드/ Ruby-driver-v2.19/lib/mongo/crypt/KMS/Azure/ 자격 증명.rb', 줄 80

def to_document
  반환 BSON::문서.신규 만약 비어 있나요?

  만약 access_token
    BSON::문서.신규({ accessToken: access_token })
  other
    BSON::문서.신규(
      {
        tenantId: @tenant_id,
        clientId: @client_id,
        clientSecret: @client_secret
      }
    ).탭 do |BSON|
      하지 않는 한 identity_platform_endpoint.nil?
        BSON.update({ identityPlatformEndpoint: identity_platform_endpoint })
      end
    end
  end
end