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 objeto Credenciales KMIP KMS contiene credenciales para un proveedor KMIP KMS remoto.

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.

"Las opciones del proveedor KMIP KMS deben estar en 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 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 credenciales KMS KMIP a partir de un hash de parámetros.

Parámetros:

  • opta (encriptada)

    Un hash que contiene las credenciales para el proveedor KMS de KMIP.

Opciones Hash (opts):

  • punto final (Cadena)

    Punto final KMIP.

Aumenta:

  • (ArgumentError)

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



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

def inicializar(opta)
  @opts = opta
  a menos que ¿vacío?
    @endpoint = validate_param(punto final, opta, FORMAT_HINT)
  end
end

Detalles de los atributos de instancia

#punto finalCadena (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)

    Punto final de KMIP KMS con puerto opcional.



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

def endpoint
  @endpoint
end

Detalles del método de instancia

#to_documentBSON::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 credencial a un documento BSON en formato libmongocrypt.

Devuelve:

  • (BSON::Document)

    Credenciales KMS locales en formato libmongocrypt.



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

def to_document
  return BSON::Documento.Nuevo({}) si ¿vacío?
  BSON::Documento.Nuevo({
    punto final: endpoint,
  })
end