Clase: Mongo::Crypt::KMS::Local::credenciales Privado

Hereda:
Objeto
  • Objeto
Mostrar todo
Ampliado por:
Reenviable
Incluye:
validación
Definido en:
lib/mongo/crypt/kms/local/credentials.rb

Overview

Esta clase forma parte de una API privada. Evita usar esta clase si es posible, ya que puede ser eliminada o modificada en el futuro.

El objeto de credenciales locales de KMS contiene las credenciales para usar el proveedor de KMS local.

Colapso delresumen constante

SUGERENCIA_DE_FORMATO =

Esta constante forma parte de una API privada. Debe evitar usarla siempre que sea posible, ya que podría eliminarse o modificarse en el futuro. 

"Lasopciones del proveedor KMS local deben tener elformato:" +
"{ key: 'MASTER-KEY' }"

Resumen de atributos de la instancia colapsar

Resumen del método de instancia colapsar

Métodos incluidos en Validaciones

#validate_param, validate_tls_options

Detalles del constructor

#initialize(opts) ⇒ Credenciales

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

Crea un objeto de credenciales KMS local a partir de un hash de parámetros.

Parámetros:

  • opta (encriptada) —

    Un hash que contiene credenciales para el proveedor local de KMS

Opciones Hash (opts):

  • :clave (Cadena) —

    Llave maestra.

Aumenta:

  • (ArgumentError) —

    Si faltan las opciones requeridas o están formateadas incorrectamente.



46
47
48
49
50
51
 
# Archivo 'lib/mongo/crypt/kms/local/credentials.rb', línea 46

def inicializar(opta)
  @opts = opta
  a menos que ¿vacío?
    @llave = validate_param(:clave, opta, FORMAT_HINT)
  end
end

Detalles de los atributos de instancia

#clave ⇒ string (solo lectura)

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

Devuelve la clave maestra.

Devuelve:

  • (string) —

    Llave maestra.



30
31
32
 
# Archivo 'lib/mongo/crypt/kms/local/credentials.rb', línea 30

def llave
  @llave
end

Detalles del método de instancia

#to_document ⇒ BSON::Document

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

Devuelve credenciales locales de KMS en formato libmongocrypt.

Devuelve:

  • (BSON::Document) —

    Credenciales KMS locales en formato libmongocrypt.



54
55
56
57
58
59
 
# Archivo 'lib/mongo/crypt/kms/local/credentials.rb', línea 54

def to_document
  return BSON::Documento.Nuevo({}) si ¿vacío?
  BSON::Documento.Nuevo({
    clave: BSON::Binario.Nuevo(@llave, :generic),
  })
end