Módulo: Mongo::Auth::StringPrep Privado

Ampliado por:

StringPrep

Incluido en:

StringPrep

Definido en:

lib/mongo/auth/stringprep.rb,
lib/mongo/auth/stringprep/tables.rb

Overview

Este módulo forma parte de una API privada. Debe evitar su uso siempre que sea posible, ya que podría eliminarse o modificarse en el futuro.

Este espacio de nombres contiene todo el comportamiento relacionado con la preparación de cadenas (RFC 3454). Se utiliza para implementar la autenticación SCRAM-SHA-256, que está disponible en las versiones del servidor MongoDB 4.0 y posteriores.

Desde:

• 2.6.0

Definido bajo Namespace

Modules: Tables

Resumen del método de instancia

• #preparar(datos, mapeos, prohibido, opciones = {}) ⇒ Objeto privado

  Prepara una string dada un conjunto de mapeos y tablas de caracteres prohibidos.

Detalles del método de instancia

#prepare(data, mappings, prohibited, options = {}) ⇒ Object

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Prepara una string dada un conjunto de mapeos y tablas de caracteres prohibidos.

Ejemplos:

Preparar una cadena.

StringPrep.prepare("some string",
                   StringPrep::Profiles::SASL::MAPPINGS,
                   StringPrep::Profiles::SASL::PROHIBITED,
                   normalize: true, bidi: true)

Parámetros:

• Datos (string) —

  La cuerda a preparar.

• asignaciones (arreglo) —

  Una lista de asignaciones para aplicar a los datos.

• prohibido (arreglo) —

  Una lista de listas de caracteres prohibidos para garantizar que los datos no las contengan después de mapear y normalizar los datos.

• opciones (Hash) (por defecto: {}) —

  Operaciones opcionales a realizar durante la preparación de la string.

Opciones Hash (options):

• :normalizar (booleano) —

  Si se aplicará o no la normalización Unicode a los datos.

• :bidi (booleano) —

  Si se debe garantizar o no que los datos contengan una entrada bidireccional válida.

Aumenta:

• (Error::FailedStringPrepValidation) –

  Si fallan las validaciones de stringprep.

Desde:

• 2.6.0

# Archivo 'lib/mongo/auth/stringprep.rb', línea 54

def prepare(Datos, asignaciones, prohibido, opciones = {})
  aplicar_mapas(Datos, asignaciones).tocar hacer |mapeado|
    ¡normalizar!(mapeado) si opciones[:normalizar]
    chequear_prohibido!(mapeado, prohibido)
    check_bidi!(mapeado) si opciones[:bidi]
  end
end