Clase: Mongo::Crypt::KMS::KMIP::Credenciales Privadas

Hereda:
Objeto
  • Objeto
Mostrar todo
Ampliado por:
Reenviable
Incluye:
validación
Definido en:
lib/mongo/crypt/kms/kmip/credenciales.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 KMIP KMS El objeto credencial contiene credenciales para un proveedor remoto de KMIP 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.

'Las opciones de proveedor KMS de KMIP deben seguir el formato: ' +
"{ 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) ⇒ Credenciales

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 objeto de credenciales KMS KMIP a partir de un hash de parámetros.

Parámetros:

  • opciones (encriptada)

    Una clave que contiene credenciales para el proveedor KMIP KMS.

Opciones Hash (opts):

  • punto final (string)

    Punto final KMIP.

Aumenta:

  • (ArgumentError)

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



46
47
48
49
50
51
# Archivo 'lib/mongo/crypt/kms/kmip/credentials.rb', línea 46

def inicializar(opciones)
  @opts = opciones
  return si ¿vacío?

  @endpoint = validate_param(punto final, opciones, FORMAT_HINT)
end

Detalles de atributo de instancias

#endpointString (acceso de 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)

    Punto final de KMIP KMS con puerto opcional.



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

def endpoint
  @endpoint
end

Detalles del método de instancia

#to_documentBSON::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.

Convierte el objeto credencial a un documento BSON en formato libmongocrypt.

Devuelve:

  • (BSON::Document)

    Credenciales KMS locales en formato libmongocrypt.



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

def to_document
  return BSON::Documento.Nuevo({}) si ¿vacío?

  BSON::Documento.Nuevo({
                       punto final: endpoint,
                     })
end