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.

Resumen de constantes colapsar

SUGERENCIA DE FORMATO =

Esta constante es parte de una API privada. Deberías evitar usar esta constante si es posible, ya que podría ser retirada o cambiada en el futuro. 

'Las opciones de proveedor de KMS local deben estar en el siguiente formato: ' +
"{ 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 es parte de una API privada. Se debe evitar el uso de este método si es posible, ya que podría eliminarse o modificarse en el futuro.

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

Parámetros:

  • opciones (encriptada) —

    Un hash que contiene credenciales para el proveedor local de KMS

Opciones Hash (opts):

  • :clave (string) —

    Llave maestra.

Aumenta:

  • (ArgumentError) —

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



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

def inicializar(opciones)
  @opts = opciones
  return si ¿vacío?

  @key = validate_param(:clave, opciones, FORMAT_HINT)
end

Detalles de atributo de instancias

#clave ⇒ string (solo lectura)

Este método es parte de una API privada. Se debe evitar el uso de este método si es posible, ya que podría eliminarse o modificarse en el futuro.

Devuelve la clave maestra.

Devuelve:

  • (string) —

    Llave maestra.



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

def llave
  @key
end

Detalles del método de instancia

#to_document ⇒ BSON::Document

Este método es parte de una API privada. Se debe evitar el uso de este método 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.



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

def to_document
  return BSON::Documento.Nuevo({}) si ¿vacío?

  BSON::Documento.Nuevo({
                       clave: BSON::Binario.Nuevo(@key, :generic),
                     })
end