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

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

Overview

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

KMS マスター キー ドキュメント オブジェクトには、データ キーの作成に使用される KMS マスター キー パラメーターが含まれています。

定数の概要の削減

KMS_PROVIGERS =

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

既知の KMS プロバイダー名。

%w[Amazon Web Services Azure gcp kmip ローカル].freeze

インスタンス メソッドの概要を折りたたむ

コンストラクターの詳細

#初期化（ kms_provider 、オプション） = マスターキードキュメント

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

パラメーター ハッシュからマスター キー ドキュメント オブジェクトを作成します。

パラメーター:

  • kms_provider ( string ) —

    KMS プロバイダー名。

  • options （ハッシュ） —

    KMS プロバイダーのマスター キー オプションを含むハッシュです。 KMS プロバイダーに必要なパラメーターは、Mongo::Crypt::KMS モジュール内の対応するクラスで説明されています。

次の値が発生します。

  • (ArgumentError) —

    必須 オプションが欠落しているか正しくない場合。



37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# ファイル 'lib/mongo/crypt/KMS/server_key_document.rb' の場合、37 行

デフォルト 初期化(kms_provider, options)
  発生 ArgumentError.新着情報('キー ドキュメント オプションは nil 以外である必要があります。) 場合 options.nil?

  マスター_キー = options.fetch(: マスター_キー, {})
  @key_document = ケース kms_provider.to_s
                  次の場合: 'aws' 次に KMS::Amazon Web Services::MasterKeyDocument.新着情報(マスター_キー)
                  次の場合: 'azure' 次に KMS::Azure::MasterKeyDocument.新着情報(マスター_キー)
                  次の場合: 'gcp' 次に KMS::GCP::MasterKeyDocument.新着情報(マスター_キー)
                  次の場合: 'kmip' 次に KMS::KMIP::MasterKeyDocument.新着情報(マスター_キー)
                  次の場合: ' local ' 次に KMS::ローカル::MasterKeyDocument.新着情報(マスター_キー)
                  else
                    発生 ArgumentError.新着情報(" KMS プロバイダーは #{ KMS_PROVIGERS } の 1 つである必要があります ")
                  end
end

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

#to_document ⇒ BSON::Document

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

マスターキー ドキュメント オブジェクトを libmongocrypt 形式の BSON ドキュメントに変換します。

次の値を返します。

  • （ BSON::Document ） —

    BSON ドキュメントとしてのマスターキー ドキュメント。



55
56
57
 
# ファイル 'lib/mongo/crypt/KMS/server_key_document.rb' の場合、55 行

デフォルト to_document
  @key_document.to_document
end