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

継承:
オブジェクト
  • オブジェクト
すべて表示
次による拡張機能。
転送可能
次のことが含まれます。
検証
定義:
build/ruby-Driver-v2.19/lib/ mongo /crypt/ KMS /local/credentials.rb

Overview

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

ローカル KMS 認証情報オブジェクトには、ローカル KMS プロバイダーを使用するための認証情報が含まれています。

定数の概要の削減

FORMAT_HINT =

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

"ローカル KMS プロバイダー オプションは次の形式である必要があります: " +
。{ key: "MASTER-KEY" }。

インスタンス属性の概要を折りたたむ

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

検証に含まれるメソッド

#validate_param, validate_tls_options

コンストラクターの詳細

#初期化（opts） =認証情報

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

パラメーター ハッシュの形式でローカル KMS 認証情報オブジェクトを作成します。

パラメーター:

  • ops （ハッシュ） —

    ローカル KMS プロバイダーの認証情報を含む ハッシュ

オプション ハッシュ（ opts ）:

  • :key （ string ） —

    マスターキー。

次の値が発生します。

  • (ArgumentError) —

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



46
47
48
49
50
51
 
# ファイル 'Build/ruby-Driver-v2.19/lib/ mongo /crypt/ KMS /local/credentials.rb', 行46

デフォルト 初期化(ops)
  @opts = ops
  ただし、 空の場合
    @key = validate_param(:key, ops, FORMAT_HINT)
  end
end

インスタンス属性の詳細

#キーとstring （読み取り専用）

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

マスターキーを返します。

次の値を返します。

  • ( string ) —

    マスターキー。



30
31
32
 
# ファイル 'Build/ruby-Driver-v2.19/lib/ mongo /crypt/ KMS /local/credentials.rb', 行30

デフォルト キー
  @key
end

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

#to_document ⇒ BSON::Document

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

ローカル KMS 認証情報を libmongocrypt 形式で返します。

次の値を返します。

  • （ BSON::Document ） —

    libmongocrypt 形式のローカル KMS 認証情報。



54
55
56
57
58
59
 
# ファイル 'Build/ruby-Driver-v2.19/lib/ mongo /crypt/ KMS /local/credentials.rb', 行54

デフォルト to_document
  return BSON::ドキュメント.新着情報({}) 場合 空の場合
  BSON::ドキュメント.新着情報({
    キー: BSON::バイナリ.新着情報(@key, :ジェネリック),
  })
end