Clase: Mongo::Crypt::KMS::Local::Credentials Private

Hereda:
Objeto
  • Objeto
Mostrar todo
Ampliado por:
Reenviable
Incluye:
Validaciones
Definido en:
lib/mongo/crypt/kms/local/credenciales.rb

Overview

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

El objeto Credenciales KMS locales contiene credenciales para utilizar el proveedor 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: 'LLAVE MAESTRA' }"

Colapso delresumen de atributos de instancia

Colapso del resumen del método de instancia

Métodos incluidos de Validaciones

#validate_param, validate_tls_options

Detalles del constructor

#inicializar(opciones) ⇒ 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 (Hash) —

    Un hash que contiene las credenciales del proveedor KMS local

Opciones Hash (opts):

  • :llave (Cadena) —

    Llave maestra.

Aumentos:

  • (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 no ser que ¿vacío?
    @llave = validate_param(:llave, opta, SUGERENCIA DE FORMATO)
  end
end

Detalles de los atributos de instancia

#tecla ⇒ Cadena (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:

  • (Cadena) -

    Llave maestra.



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

def clave
  @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 las credenciales de KMS locales en formato libmongocrypt.

Devuelve:

  • (BSON::Documento) —

    Credenciales KMS locales en formato libmongocrypt.



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

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