クラス: Mongo::Crypt::KMS::Credentials Private

継承:
オブジェクト
  • オブジェクト
すべて表示
定義:
lib/mongo/crypt/KMS/credentials.rb

Overview

このクラスは、プライベート 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
 
# ファイル 'lib/mongo/crypt/KMS/credentials.rb' の行 54

デフォルト 初期化(kms_providers)
  場合 kms_providers.nil?
    発生 ArgumentError.新着情報(「 KMS プロバイダーのオプションは nil ではない 必要があります」)
  end
  場合 kms_providers.key?(:aws)
    @aws = Amazon Web Services::Credentials.新着情報(kms_providers[:aws])
  end
  場合 kms_providers.key?(: azure)
    @azure = Azure::Credentials.新着情報(kms_providers[: azure])
  end
  場合 kms_providers.key?(:gcp)
    @gcp = GCP::Credentials.新着情報(kms_providers[:gcp])
  end
  場合 kms_providers.key?(:kmp)
    @kmp = KMIP::Credentials.新着情報(kms_providers[:kmp])
  end
  場合 kms_providers.key?(:local)
    @local = ローカル::Credentials.新着情報(kms_providers[:local])
  end
  場合 @aws.nil? & & @azure.nil? & & @gcp.nil? & & @kmp.nil? & & @local.nil?
    発生 ArgumentError.新着情報(
      " KMS プロバイダー オプションには次のいずれかのキーが必要です。 " +
      " :aws, : azure, :gcp, :kmp, :local "
    )
  end
end

インスタンス属性の詳細

Amazon Web Services =認証情報::AWS | nil （読み取り専用）

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

Amazon Web Services KMS認証情報を返します。

次の値を返します。

  • (認証情報::AWS | nil ) —

    Amazon Web Services KMS認証情報。



28
29
30
 
# ファイル 'lib/mongo/crypt/KMS/credentials.rb' の行 28

デフォルト Amazon Web Services
  @aws
end

# azure =認証情報::Azure | nil （読み取り専用）

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

Azure KMS 認証情報を返します。

次の値を返します。

  • (認証情報::Azure | nil ) —

    Azure KMS 認証情報。



31
32
33
 
# ファイル 'lib/mongo/crypt/KMS/credentials.rb' の行 31

デフォルト Azure
  @azure
end

# gcp ～認証情報::GCP | nil （読み取り専用）

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

GCP KMS 認証情報を返します。

次の値を返します。

  • （認証情報::GCP | nil ） —

    GCP KMS 認証情報。



34
35
36
 
# ファイル 'lib/mongo/crypt/KMS/credentials.rb' の行 34

デフォルト gcp
  @gcp
end

KMIP ～認証情報 # ::KMIP | nil （読み取り専用）

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

KMIP KMS 認証情報を返します。

次の値を返します。

  • (認証情報::KMIP | nil ) —

    KMIP KMS 認証情報。



37
38
39
 
# ファイル 'lib/mongo/crypt/KMS/credentials.rb' の行 37

デフォルト kmip
  @kmp
end

local ～認証情報 #::local | nil （読み取り専用）

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

ローカル KMS 認証情報を返します。

次の値を返します。

  • （認証情報 ::Local | nil ） —

    ローカル KMS 認証情報。



40
41
42
 
# ファイル 'lib/mongo/crypt/KMS/credentials.rb' の行 40

デフォルト ローカル
  @local
end

インスタンス メソッドの詳細

#to_document ⇒ BSON::Document

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

認証情報オブジェクトを libmongocrypt 形式の BSON ドキュメントに変換します。

次の値を返します。

  • （ BSON::Document ） —

    BSON ドキュメントとしての認証情報。



84
85
86
87
88
89
90
91
92
 
# ファイル 'lib/mongo/crypt/KMS/credentials.rb' の行 84

デフォルト to_document
  BSON::ドキュメント.新着情報.タップ 行う |bson|
    bson[:aws] = @aws.to_document 場合 @aws
    bson[: azure] = @azure.to_document 場合 @azure
    bson[:gcp] = @gcp.to_document 場合 @gcp
    bson[:kmp] = @kmp.to_document 場合 @kmp
    bson[:local] = @local.to_document 場合 @local
  end
end