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

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

Overview

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

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

定数の概要の削減

FORMAT_HINT =

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

の KMIP KMS キードキュメントは: の形式である必要があります。 +
。{ key_id: 'KEY-ID', エンドポイントとなる接続されたデバイス: 'ENDPOINT', delegated: true|false }。

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

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

検証に含まれるメソッド

#validate_param, validate_tls_options

コンストラクターの詳細

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

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

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

パラメーター:

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

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

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

  • :key_id （ string | nil ） —

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

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

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

  • :delegated （ true | false | nil ） —

    true の場合、KMIP サーバーはデータ キーの暗号化と復号化を実行します（任意）。デフォルトは false です。

次の値が発生します。

  • (ArgumentError) —

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



55
56
57
58
59
60
61
62
63
 
# ファイル 'lib/mongo/crypt/KMS/kip/ Master_document.rb' は、55 行を

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

インスタンス属性の詳細

#delegated ⇒ true | false | nil (読み取り専用)

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

データ キーの暗号化と復号化を KMIP サーバーが実行するかどうかを返します。

次の値を返します。

  • （ true | false | nil ） —

    KMIP サーバーがデータ キーの暗号化と復号化を実行するかどうか。



36
37
38
 
# ファイル 'lib/mongo/crypt/KMS/kip/ Master_document.rb' は、36 行を

デフォルト 委任された
  @delegated
end

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

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

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

次の値を返します。

  • ( string | nil ) —

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



32
33
34
 
# ファイル 'lib/mongo/crypt/KMS/kip/ Master_document.rb' は、32 行を

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

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

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

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

次の値を返します。

  • ( string | nil ) —

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



29
30
31
 
# ファイル 'lib/mongo/crypt/KMS/kip/ Master_document.rb' は、29 行を

デフォルト key_id
  @key_id
end

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

#to_document ⇒ BSON::Document

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

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

次の値を返します。

  • （ BSON::Document ） —

    libmongocrypt 形式の KMIP KMS 認証情報。



68
69
70
71
72
73
74
75
76
 
# ファイル 'lib/mongo/crypt/KMS/kip/ Master_document.rb' は、68 行を

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