Classe: Mongo::Auth::Scram Private

Herda:
Base
  • Objeto
mostrar tudo
Definido em:
lib/mongo/auth/SCRAM.rb,
lib/mongo/auth/SCRAM/conversation.rb

Visão geral

Esta classe faz parte de uma API privada. Evite usar essa classe, se possível, pois ela pode ser removida ou alterada no futuro.

Define o comportamento da autenticação SCRAM.

Desde:

  • 2.0.0

Subclasses conhecidas diretas

Scram256

Definido sob namespace

Classes: Diálogo

Colapsode resumo constante

Mecanismo =

Essa constante faz parte de uma API privada. Você deve evitar usar essa constante, se possível, pois ela pode ser removida ou alterada no futuro.

A string do mecanismo de autenticação.

Desde:

  • 2.0.0

'SCRAM-SHA-1'

Recolhimento do Resumo do atributo de instância

Atributos herdados da Base

#connection, #user

Recolhimento do Resumo do método de instância

Detalhes do construtor

#inicializar(usuário, conexão, **opts) ➤ SCRAM

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Inicializa o autenticador SCRAM .

Parâmetros:

  • utilizador (Auth::User) —

    O usuário a ser autenticado.

  • Conexão (Mongo::Connection) —

    A conexão para autenticar.

  • opciona (Hash) —

    um conjunto personalizável de opções

Hash de opções (**opts):

  • speculative_auth_client_nonce (string | nil) —

    O cliente não usado em autenticação especulativa na conexão especificada que produzia o resultado de autenticação especulativa especificado.

  • speculative_auth_result (BSON::Document | nil) —

    O valor do campo speculativeAuthenticate da resposta hello da negociação na conexão especificada.

Desde:

  • 2.0.0



37
38
39
40
41
 
# Arquivo 'lib/mongo/auth/scram.rb', linha 37

def inicializar(utilizador, Conexão, **opciona)
  super
  @speculative_auth_client_nonce = opciona[:speculative_auth_client_nonce]
  @speculative_auth_result = opciona[:speculative_auth_result]
end

Detalhes do atributo da instância

#speculative_auth_client_nonce ➤ string | nil (somente leitura)

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Retorna O cliente não usado em autenticação especulativa na conexão atual.

Retorna:

  • (string | nil) —

    O cliente não usado em autenticação especulativa na conexão atual.

Desde:

  • 2.0.0



45
46
47
 
# Arquivo 'lib/mongo/auth/scram.rb', linha 45

def speculative_auth_client_nonce
  @speculative_auth_client_nonce
end

#speculative_auth_result ➤ BSON::Document | nil (somente leitura)

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Retorna o valor do campo speculativeAuthenticate da resposta hello da negociação na conexão atual.

Retorna:

  • (BSON::Document | nil) —

    O valor do campo speculativeAuthenticate da resposta hello da negociação na conexão atual.

Desde:

  • 2.0.0



49
50
51
 
# Arquivo 'lib/mongo/auth/scram.rb', linha 49

def speculative_auth_result
  @speculative_auth_result
end

Detalhes do método de instância

#conversa ➤ Objeto

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Desde:

  • 2.0.0



51
52
53
54
55
 
# Arquivo 'lib/mongo/auth/scram.rb', linha 51

def conversa
  @conversation ||= auto.classe.const_get(:Conversation).Novo(
    utilizador, Conexão, client_nonce: speculative_auth_client_nonce
  )
end

#login ➤ BSON::Document

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Faça login do usuário na conexão atual.

Retorna:

  • (BSON::Document) —

    O documento da resposta de autenticação.

Desde:

  • 2.0.0



60
61
62
63
64
65
 
# Arquivo 'lib/mongo/auth/scram.rb', linha 60

def 
  conversa_multi_step(Conexão, conversa,
                      speculative_auth_result: speculative_auth_result).toque fazer
    aumentar Erro::Faltando ScramServerSignature a menos que conversa.server_verified?
  end
end