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

Hereda:
Objeto
  • Objeto
Mostrar todo
Incluye:
Validaciones
Definido en:
lib/mongo/crypt/kms/kmip/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 KMS de KMIP contiene parámetros de clave maestra 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' }"

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

Parámetros:

  • opta (Hash) (predeterminado: {}) —

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

Opciones Hash (opts):

  • :identificación_de_clave (String | nil) —

    Identificador único de KMIP para un objeto gestionado de datos secretos de KMIP 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.

Aumentos:

  • (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, SUGERENCIA DE FORMATO, requerido: false
  )
  @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 KMIP KMS con puerto opcional.

Devuelve:

  • ( Cadena| nulo ) —

    Punto final KMS de KMIP con puerto opcional.



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

def punto final
  @punto final
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:

  • ( Cadena| nulo ) —

    El identificador único de KMIP para un objeto administrado de datos secretos de KMIP de 96 bytes.



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

def id_clave
  @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::Documento) —

    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 al_documento
  BSON::Documento.Nuevo({
    proveedor: 'kmip',
  }).grifo hacer |BSON|
    BSON.update({ punto final: punto final }) a no ser que punto final.nil?
    BSON.update({ keyId: id_clave }) a no ser que id_clave.nil?
  end
end