クラス: Mongo::Auth::SCRAM Private

継承:
Base
  • オブジェクト
すべて表示
定義:
lib/mongo/auth/SCRAM.rb
、lib/mongo/auth/SCRAM/conversion.rb

Overview

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

SCRAM 認証の動作を定義します。

以来

  • 2.0.0

既知のサブクラスを直接確認

SCRAM256

名前空間で定義済み

クラス: 変換

定数の概要の削減

Mechanism =

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

認証メカニズムstring 。

以来

  • 2.0.0

'SCRAM-SHA-1'

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

baseから継承される属性

# connection 、 #user

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

コンストラクターの詳細

#初期化（ユーザー、接続、**ops） SCRAM

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

SCRAM 認証を初期化します。

パラメーター:

  • user （認証::ユーザー） —

    認証するユーザー。

  • 接続 （ Mongo::Connection ） —

    認証する接続。

  • ops （ハッシュ） —

    カスタマイズ可能なオプションのセット

オプション ハッシュ（ * Ops ）:

  • 推測的_auth_client_nance （ string | nil ） —

    指定された接続で推測的認証に使用されたクライアントは、指定された推測的認証結果を生成しました。

  • 推測的_認証_結果 (BSON::Document | nil) —

    指定された接続でのハンドシェイクの hello レスポンスの推測的認証フィールドの値。

以来

  • 2.0.0



37
38
39
40
41
 
# ファイル 'lib/mongo/auth/SCRAM.rb', 行 37

デフォルト 初期化(user, 接続, **ops)
  スーパー
  @speculative_auth_client_nance = ops[:speculative_auth_client_nance]
  @speculative_auth_result = ops[:speculative_auth_result]
end

インスタンス属性の詳細

#推測的_auth_client_nance == string | nil （読み取り専用）

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

現在の接続で推測的認証で使用されたクライアントを返します。

次の値を返します。

  • ( string | nil ) —

    クライアントが現在の接続で推測的認証で使用されることはありません。

以来

  • 2.0.0



45
46
47
 
# ファイル 'lib/mongo/auth/SCRAM.rb', 行 45

デフォルト 推測的_auth_client_nance
  @speculative_auth_client_nance
end

#推測的_認証_結果 = BSON::ドキュメント | nil （読み取り専用）

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

現在の接続でのハンドシェイクの hello レスポンスの推測的認証フィールドの値を返します。

次の値を返します。

  • (BSON::Document | nil) —

    現在の接続でのハンドシェイクの hello レスポンスの推測的認証フィールドの値。

以来

  • 2.0.0



49
50
51
 
# ファイル 'lib/mongo/auth/SCRAM.rb', 行 49

デフォルト 推測的_認証_結果
  @speculative_auth_result
end

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

#通信=オブジェクト

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

以来

  • 2.0.0



51
52
53
54
55
 
# ファイル 'lib/mongo/auth/SCRAM.rb', 行 51

デフォルト 交信
  @convert ||= 自己.クラス.const_get(:変換).新着情報(
    user, 接続, client_nonce: 推測的_auth_client_nance
  )
end

#login ⇒ BSON::Document

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

現在の接続でユーザーをログインさせます。

次の値を返します。

  • （ BSON::Document ） —

    認証応答のドキュメント。

以来

  • 2.0.0



60
61
62
63
64
65
 
# ファイル 'lib/mongo/auth/SCRAM.rb', 行 60

デフォルト 
  convert_multi_step(接続, 交信,
                      推測的_認証_結果: 推測的_認証_結果).タップ 行う
    発生 エラー::MissingScrimServerSignature ただし、 交信.server_versioned?
  end
end