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

継承:
オブジェクト
  • オブジェクト
すべて表示
次のことが含まれます。
検証
定義:
build/ruby-Driver-v2.19/lib/ mongo /crypt/ KMS /kip/ Master_document.rb

Overview

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

KMIP KMS マスター キー ドキュメント オブジェクトには、KMS マスター キー パラメーターが含まれます。

定数の概要の削減

FORMAT_HINT =

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

" KMIP KMS キー ドキュメントは次の形式である必要があります: " +
。{ key_id: 'KEY-ID', endpoint: 'ENDPOINT' }。

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

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

検証に含まれるメソッド

#validate_param, validate_tls_options

コンストラクターの詳細

#初期化（opts = {}） =マスターキードキュメント

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

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

パラメーター:

  • ops （ハッシュ） （デフォルトは{}です） —

    KMIP KMS プロバイダーのマスター キー オプションを含むハッシュ

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

  • :key_id （ string | nil ） —

    96バイトの KMIP シークレット データ管理対象オブジェクトへの KMIP ユニーク識別子（任意）。 key_id が省略されている場合、ドライバーはランダムな96バイト識別子を作成します。

  • : エンドポイント （ string | nil ） —

    KMIP エンドポイント（任意）。

次の値が発生します。

  • (ArgumentError) —

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



49
50
51
52
53
54
55
56
 
# ファイル 'Build/ruby-Driver-v2.19/lib/ mongo /crypt/ KMS /kip/ Master_document.rb '、 行49

デフォルト 初期化(ops = {})
  @key_id = validate_param(
    :key_id, ops, FORMAT_HINT, 必須: false
  )
  @endpoint = validate_param(
    : エンドポイント, ops, FORMAT_HINT, 必須: false
  )
end

インスタンス属性の詳細

#エンドポイント= string | nil （読み取り専用）

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

任意のポートを持つ KMIP KMS エンドポイントを返します。

次の値を返します。

  • ( string | nil ) —

    任意のポートを持つ KMIP KMS エンドポイント。



33
34
35
 
# ファイル 'Build/ruby-Driver-v2.19/lib/ mongo /crypt/ KMS /kip/ Master_document.rb '、 行33

デフォルト エンドポイント
  @endpoint
end

#key_id = string | nil （読み取り専用）

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

KMIP ユニーク識別子を96バイトの KMIP 秘密データ マネージド オブジェクトに返します。

次の値を返します。

  • ( string | nil ) —

    96バイトの KMIP 秘密データ管理オブジェクトへの KMIP ユニーク識別子。



30
31
32
 
# ファイル 'Build/ruby-Driver-v2.19/lib/ mongo /crypt/ KMS /kip/ Master_document.rb '、 行30

デフォルト key_id
  @key_id
end

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

#to_document ⇒ BSON::Document

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

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

次の値を返します。

  • （ BSON::Document ） —

    libmongocrypt 形式の KMIP KMS 認証情報。



61
62
63
64
65
66
67
68
 
# ファイル 'Build/ruby-Driver-v2.19/lib/ mongo /crypt/ KMS /kip/ Master_document.rb '、 行61

デフォルト to_document
  BSON::ドキュメント.新着情報({
    プロバイダー: 'kmip',
  }).タップ 行う |bson|
    bson.update({ エンドポイント: エンドポイント }) ただし、 エンドポイント.nil?
    bson.update({ keyId: key_id }) ただし、 key_id.nil?
  end
end