Clase: Mongo::Crypt::KMS::AWS::credenciales Privado

Hereda:
Objeto
  • Objeto
Mostrar todo
Ampliado por:
Reenviable
Incluye:
validación
Definido en:
lib/mongo/crypt/kms/aws/credentials.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 credenciales de AWS KMS contiene credenciales para utilizar el proveedor AWS 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 del proveedor de AWS KMS deben estar en el formato: ' +
"{ access_key_id: 'TU-ID-DE-CLAVE-DE-ACCESO', secret_access_key: 'CLAVE-DE-ACCESO-SECRETA' }"

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 de AWS KMS a partir de una tabla hash de parámetros.

Parámetros:

  • opciones (encriptada) —

    Un hash que contiene credenciales para el proveedor de AWS KMS

Opciones Hash (opts):

  • :access_key_id (string) —

    Id. de la clave de acceso de AWS.

  • clave_de_acceso_secreta (string) —

    Clave de acceso secreta de AWS.

  • :session_token (String | nil) —

    Token de sesión de AWS, opcional.

Aumenta:

  • (ArgumentError) —

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



53
54
55
56
57
58
59
60
 
# Archivo 'lib/mongo/crypt/kms/aws/credenciales.rb', línea 53

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

  @access_key_id = validate_param(:access_key_id, opciones, FORMAT_HINT)
  @secret_access_key = validate_param(clave_de_acceso_secreta, opciones, FORMAT_HINT)
  @session_token = validate_param(:session_token, opciones, FORMAT_HINT, obligatorio: false)
end

Detalles de atributo de instancias

#access_key_id ⇒ String (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 la clave de acceso de AWS.

Devuelve:

  • (string) —

    Clave de acceso de AWS.



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

def Access Key ID
  @access_key_id
end

#secret_access_key ⇒ string (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 la clave secreta de acceso de AWS.

Devuelve:

  • (string) —

    Clave de acceso secreta de AWS.



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

def clave_de_acceso_secreta
  @secret_access_key
end

#session_token ⇒ 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 AWS session token.

Devuelve:

  • (String | nil) —

    AWS session token.



35
36
37
 
# Archivo 'lib/mongo/crypt/kms/aws/credenciales.rb', línea 35

def session_token
  @session_token
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.

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

Devuelve:

  • (BSON::Document) —

    Credenciales de AWS KMS en formato libmongocrypt.



65
66
67
68
69
70
71
72
73
74
 
# Archivo 'lib/mongo/crypt/kms/aws/credenciales.rb', línea 65

def to_document
  return BSON::Documento.Nuevo si ¿vacío?

  BSON::Documento.Nuevo({
                       accessKeyId: Access Key ID,
                       secretAccessKey: clave_de_acceso_secreta,
                     }).tocar hacer |BSON|
    BSON.update({ sessionToken: session_token }) a menos que session_token.nil?
  end
end