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.

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 KMS de KMIP debe tener elformato:" +
"{ key_id: 'KEY-ID', endpoint: 'ENDPOINT' }"

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 forma parte de una API privada. Debe evitarlo 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:

  • opta (Hash) (por defecto: {}) —

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

Opciones Hash (opts):

  • :identificación_de_clave (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.

Aumenta:

  • (ArgumentError) —

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



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

def inicializar(opta = {})
  @key_id = validate_param(
    :identificación_de_clave, opta, FORMAT_HINT, obligatorio: false
  )
  @endpoint = validate_param(
    punto final, opta, FORMAT_HINT, obligatorio: 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 endpoint KMIP KMS con puerto opcional.

Devuelve:

  • (String | nil) —

    Punto final de KMIP KMS con puerto opcional.



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

def endpoint
  @endpoint
end

#key_id ⇒ String | nil (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 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.



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

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

    Credenciales KMS de KMIP en formato libmongocrypt.



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

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?
  end
end