Clase: Mongo::Crypt::KMS::KMIP::MasterKeyDocument Privado

Hereda:
Objeto
  • Objeto
Mostrar todo
Incluye:
validación
Definido en:
lib/mongo/crypt/kms/kmip/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 KMIP 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 de clave KMS de KMIP debe estar en el formato: ' +
"{ key_id: 'KEY-ID', endpoint: 'ENDPOINT', delegated: true|false }"

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 = {}) ⇒ 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) (por defecto: {}) —

    Un hash que contiene las opciones de clave maestra para el proveedor de gestión de claves KMIP KMS

Opciones Hash (opts):

  • :key_id (String | nil) —

    Identificador Único de KMIP a un objeto gestionado KMIP Secret Data de 96 bytes, opcional. Si se omite key_id, el controlador crea un identificador aleatorio de 96 bytes.

  • punto final (String | nil) —

    Punto final KMIP, opcional.

  • :delegado (true | false | nil) —

    Si es verdadero, el servidor KMIP realiza el cifrado y descifrado de la clave de datos, opcional. Se configura por defecto en false.

Aumenta:

  • (ArgumentError) —

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



55
56
57
58
59
60
61
62
63
 
# Archivo 'lib/mongo/crypt/kms/kmip/master_document.rb', línea 55

def inicializar(opciones = {})
  @key_id = validate_param(
    :key_id, opciones, FORMAT_HINT, obligatorio: false
  )
  @endpoint = validate_param(
    punto final, opciones, FORMAT_HINT, obligatorio: false
  )
  @delegado = validate_delegated(opciones)
end

Detalles de atributo de instancias

#delegated ⇒ true | false | 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 si el servidor KMIP realiza el cifrado y descifrado de la clave de datos.

Devuelve:

  • (true | false | nil) —

    Si el servidor KMIP realiza el cifrado y descifrado de la clave de datos.



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

def delegado
  @delegado
end

#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 endpoint KMIP KMS con puerto opcional.

Devuelve:

  • (String | nil) —

    Punto final de KMIP KMS con puerto opcional.



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

def endpoint
  @endpoint
end

#key_id ⇒ 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 identificador único de KMIP a un objeto administrado de datos secretos de KMIP de 96 bytes.

Devuelve:

  • (String | nil) —

    El identificador único de KMIP a un objeto gestionado de datos secretos de KMIP de 96 bytes.



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

def key_id
  @key_id
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) —

    Credenciales KMIP KMS en formato libmongocrypt.



68
69
70
71
72
73
74
75
76
 
# Archivo 'lib/mongo/crypt/kms/kmip/master_document.rb', línea 68

def to_document
  BSON::Documento.Nuevo({
                       proveedor: 'kmip',
                     }).tocar hacer |BSON|
    BSON.update({ punto final: endpoint }) a menos que endpoint.nil?
    BSON.update({ keyId: key_id }) a menos que key_id.nil?
    BSON.update({ delegado: delegado }) a menos que delegado.nil?
  end
end