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

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

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. 

"Eldocumento clave de AWS debe tener elformato:" +
"{ region: 'REGION', key: 'KEY' }"

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) ⇒ MasterKeyDocument

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

Parámetros:

  • opta (Hash) —

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

Opciones Hash (opts):

  • :región (Cadena) —

    Región de AWS.

  • :llave (Cadena) —

    Clave KMS de AWS.

  • :punto final (String | nil) —

    Punto final de AWS KMS, opcional.

Aumentos:

  • (ArgumentError) —

    Si faltan las opciones requeridas o son incorrectas.



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

def inicializar(opta)
  a no ser que opta.is_a?(Picadillo)
    propagar ArgumentError.Nuevo(
      'Las opciones clave del documento deben contener una clave llamada:master_key con un valor Hash'
    )
  end
  @región = validate_param(:región, opta, SUGERENCIA DE FORMATO)
  @llave = validate_param(:llave, opta, SUGERENCIA DE FORMATO)
  @punto final = validate_param(:punto final, opta, SUGERENCIA DE FORMATO, requerido: false)
end

Detalles de los atributos de instancia

#punto final ⇒ Cadena | nulo (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 el punto final de AWS KMS.

Devuelve:

  • ( Cadena| nulo ) —

    Punto final de AWS KMS.



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

def punto final
  @punto final
end

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

Devuelve:

  • (Cadena) -

    Clave KMS de AWS.



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

def clave
  @llave
end

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

Devuelve:

  • (Cadena) -

    Región de AWS.



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

def región
  @región
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.

Convierte el objeto de documento de clave maestra en un documento BSON en formato libmongocrypt.

Devuelve:

  • (BSON::Documento) —

    Documento de clave maestra de AWS KMS en formato libmongocrypt.



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

def al_documento
  BSON::Documento.Nuevo({
    proveedor: 'aws',
    región: región,
    llave: clave,
  }).grifo hacer |BSON|
    a no ser que punto final.nil?
      BSON.update({ punto final: punto final })
    end
  end
end