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.

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

Parámetros:

  • opta (encriptada) —

    Un hash que contiene credenciales para el proveedor de AWS KMS

Opciones Hash (opts):

  • :access_key_id (Cadena) —

    Id. de la clave de acceso de AWS.

  • clave_de_acceso_secreta (Cadena) —

    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.



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

def inicializar(opta)
  @opts = opta
  a menos que ¿vacío?
    @access_key_id = validate_param(:access_key_id, opta, FORMAT_HINT)
    @secret_access_key = validate_param(clave_de_acceso_secreta, opta, FORMAT_HINT)
    @session_token = validate_param(:session_token, opta, FORMAT_HINT, obligatorio: false)
  end
end

Detalles de los atributos de instancia

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

Devuelve:

  • (string) —

    Clave de acceso de AWS.



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

def Access Key ID
  @access_key_id
end

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

Devuelve:

  • (string) —

    Clave de acceso secreta de AWS.



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

def clave de acceso secreta
  @secret_access_key
end

#session_token ⇒ 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 token de sesión de AWS.

Devuelve:

  • (String | nil) —

    AWS session token.



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

def session_token
  @session_token
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 credencial a un documento BSON en formato libmongocrypt.

Devuelve:

  • (BSON::Document) —

    Credenciales de AWS KMS en formato libmongocrypt.



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

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|
    a menos que session_token.nil?
      BSON.update({ sessionToken: session_token })
    end
  end
end