モジュール: Mongo::Crypt::KMS::Validation Private

次のドキュメントに含まれます。
AWS::Credentials 、 AWS::マスターキードキュメント、 Azure::Credentials 、 Azure:マスターKeyDocument 、 GCP::Credentials 、 GCP:: MasterKeyDocument 、 KMIP::Credentials 、 KMIP:: MasterKeyDocument 、 Local::Credentials
定義:
lib/mongo/crypt/ kms.rb

Overview

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

このモジュールには、KMS パラメータを検証するためのヘルパー メソッドが含まれています。

クラスメソッドの概要を折りたたむ

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

クラスメソッドの詳細

.validate_tls_options(options) ⇒ Hash

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

KMS TLS オプションを検証します。

パラメーター:

  • options (ハッシュ | nil ) —

    KMS プロバイダーに接続するための TLS オプション。 ハッシュのキーは、K SM プロバイダー名である必要があります。値は、TLS 接続オプションのハッシュである必要があります。 オプションは、Mongo::Client の TLS 接続オプションと同じです。

次の値を返します。

  • （ハッシュ） —

    TLS オプションが有効な場合は指定しました。

次の値が発生します。

  • (ArgumentError) —

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# ファイル 'lib/mongo/crypt/ kms.rb' の場合 85 行

デフォルト validate_tls_options(options)
  ops = options || {}
  ops.各 行う |プロバイダー, provider_opts|
    場合 provider_opts[:ssl] == false || ops[:tls] == false
      発生 ArgumentError.新着情報(
        " #{ provider } の TLS オプションが正しく ありません: TLS が必要です "
      )
    end
    %i[
      ssl_verify_certify
      ssl_verify_hostname
    ].各 行う |opt|
      次へ ただし、 provider_opts[opt] == false

      発生 ArgumentError.新着情報(
        " #{ provider } の TLS オプションが正しくありません : " +
        '安全でない TLS オプションは禁止されています、 ' +
        " KMS では#{ opt }を false に設定できません。
      )
    end
  end
  ops
end

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

# validate_aram （key、opts、format_hint、必須: true）= string | nil

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

KMS パラメータが有効かどうかを検証します。

パラメーター:

  • キー （シンボル） —

    パラメータ名。

  • ops （ハッシュ） —

    ハッシュには、キーの下の パラメーターが含まれている必要があります。

  • 必須 （ブール値） （デフォルトはtrue ） —

    パラメーターが必須かどうか。 必須でないパラメーターは nil にすることができます。

次の値を返します。

  • ( string | nil ) —

    string パラメーター値、または必須以外のパラメーターが欠落している場合は nil 。

次の値が発生します。

  • (ArgumentError) —

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



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# ファイル 'lib/mongo/crypt/ kms.rb' の場合 42 行

デフォルト validate_param(キー, ops, format_hint, 必須: true)
  価値 = ops.fetch(キー)
  return nil 場合 価値.nil? & & !必須

  場合 価値.nil?
    発生 ArgumentError.新着情報(
      " #{key } オプションは、少なくとも 1 文字を含む String である必要があります。"\ は現在 nil ' ）の値が でない限り 、末尾に表示されます。 is_a? （ String ） は ArgmentError を発生させます。 new（" #{key } オプションは、少なくとも 1 文字を含む String である必要があります。"\ " は現在、#{ 値 } " ）の値が の場合に終了します。空の場合は、引数エラーを発生させます。 new（"#{key} オプションは少なくとも 1 文字のstring である必要があります。"\  、現在は空の文字列です（）。必要に応じてを使用して終了します。 KeyError new（" 指定された KMS プロバイダー オプションは無効です: #{ opts }。" +format_hint ）末尾