Clase: Mongo::Crypt::KMS::AWS::MasterKeyDocument Privado

Hereda:
Objeto
  • Objeto
Mostrar todo
Incluye:
validación
Definido en:
lib/mongo/crypt/kms/aws/master_document.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 documento de clave maestra de AWS KMS contiene los parámetros de clave maestra de KMS.

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. 

'El documento clave de AWS debe estar en el formato: ' +
"{ region: 'REGION', key: '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

#inicializar(opts) ⇒ MasterKeyDocument

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 formulario de objeto de documento de clave maestra a partir de un hash de parámetros.

Parámetros:

  • opciones (encriptada) —

    Un hash que contiene opciones de clave maestra para el proveedor de KMS de AWS.

Opciones Hash (opts):

  • región (string) —

    Región AWS.

  • :clave (string) —

    Clave de AWS KMS.

  • punto final (String | nil) —

    Punto final de AWS KMS, opcional.

Aumenta:

  • (ArgumentError) —

    Si faltan opciones requeridas o están incorrectas.



48
49
50
51
52
53
54
55
56
57
 
# Archivo 'lib/mongo/crypt/kms/aws/master_document.rb', línea 48

def inicializar(opciones)
  a menos que opciones.is_a?(encriptada)
    propagar ArgumentError.Nuevo(
      'Las opciones del documento clave deben contener una clave denominada :master_key con un valor Hash'
    )
  end
  @region = validate_param(región, opciones, FORMAT_HINT)
  @key = validate_param(:clave, opciones, FORMAT_HINT)
  @endpoint = validate_param(punto final, opciones, FORMAT_HINT, obligatorio: false)
end

Detalles de atributo de instancias

#endpoint ⇒ String| nil (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 el punto final de AWS KMS.

Devuelve:

  • (String | nil) —

    Punto final de AWS KMS.



34
35
36
 
# Archivo 'lib/mongo/crypt/kms/aws/master_document.rb', línea 34

def endpoint
  @endpoint
end

#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 de AWS KMS.

Devuelve:

  • (string) —

    Clave de AWS KMS.



31
32
33
 
# Archivo 'lib/mongo/crypt/kms/aws/master_document.rb', línea 31

def llave
  @key
end

#region ⇒ 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 región de AWS.

Devuelve:

  • (string) —

    Región AWS.



28
29
30
 
# Archivo 'lib/mongo/crypt/kms/aws/master_document.rb', línea 28

def region
  @region
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.

Convertir el objeto de clave maestra del documento a un documento BSON en formato libmongocrypt.

Devuelve:

  • (BSON::Document) —

    Documento clave maestra AWS KMS en formato libmongocrypt.



62
63
64
65
66
67
68
69
70
 
# Archivo 'lib/mongo/crypt/kms/aws/master_document.rb', línea 62

def to_document
  BSON::Documento.Nuevo({
                       proveedor: 'aws',
                       región: region,
                       clave: llave,
                     }).tocar hacer |BSON|
    BSON.update({ punto final: endpoint }) a menos que endpoint.nil?
  end
end