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

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

Overview

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

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

定数の概要の削減

FORMAT_HINT =

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

「 Azure キー ドキュメントは次の形式である必要があります。 」 +
。{ key_vault_endpoint: 'KEY_VAULT_ENDPOINT', key_name: 'KEY_NAME' }。

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

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

検証に含まれるメソッド

#validate_param, validate_tls_options

コンストラクターの詳細

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

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

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

パラメーター:

  • ops （ハッシュ） —

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

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

  • :key_vault_endpoint （ string ） —

    Azure Key Vault エンドポイント。

  • :key_name （ string ） —

    Azure KMS キー名。

  • :key_version （ string | nil ） —

    Azure KMS キーのバージョン（任意）。

次の値が発生します。

  • (ArgumentError) —

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



49
50
51
52
53
54
55
56
57
58
 
2.19の をmongo KMSAzureします。行49

デフォルト 初期化(ops)
  ただし、 ops.is_a?(ハッシュ)
    発生 ArgumentError.新着情報(
      'キー ドキュメント オプションには、 ハッシュ値 を持つ という名前のキーが含まれている必要があります。
    )
  end
  @key_vault_endpoint = validate_param(:key_vault_endpoint, ops, FORMAT_HINT)
  @key_name = validate_param(:key_name, ops, FORMAT_HINT)
  @key_version = validate_param(:key_version, ops, FORMAT_HINT, 必須: false)
end

インスタンス属性の詳細

#key_name = string （読み取り専用）

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

Azure KMS キー名を返します。

次の値を返します。

  • ( string ) —

    Azure KMS キー名。



32
33
34
 
2.19の をmongo KMSAzureします。行32

デフォルト key_name
  @key_name
end

# key_vault_endpoint = string （読み取り専用）

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

Azure Key Vault エンドポイントを返します。

次の値を返します。

  • ( string ) —

    Azure Key Vault エンドポイント。



29
30
31
 
2.19の をmongo KMSAzureします。行29

デフォルト key_vault_endpoint
  @key_vault_endpoint
end

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

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

Azure KMS キーのバージョンを返します。

次の値を返します。

  • ( string | nil ) —

    Azure KMS キー バージョン。



35
36
37
 
2.19の をmongo KMSAzureします。行35

デフォルト key_version
  @key_version
end

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

#to_document ⇒ BSON::Document

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

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

次の値を返します。

  • （ BSON::Document ） —

    libmongocrypt 形式の Azure KMS 認証情報。



63
64
65
66
67
68
69
70
71
72
73
 
2.19の をmongo KMSAzureします。行63

デフォルト to_document
  BSON::ドキュメント.新着情報({
    プロバイダー: 'azure',
    keyVaultEndpoint: key_vault_endpoint,
    keyName: key_name,
  }).タップ 行う |bson|
    ただし、 key_version.nil?
      bson.update({ keyVersion: key_version })
    end
  end
end