Classificação: Mongo::Crypt::KMS::AWS::Credentials Private

Herda:
Objeto
  • Objeto
mostrar tudo
Estendido por:
Encaminhável
Inclui:
Validações
Definido em:
lib/mongo/crypt/KMS/Amazon Web Services/credentials.rb

Visão geral

Esta classe faz parte de uma API privada. Evite usar essa classe, se possível, pois ela pode ser removida ou alterada no futuro.

O objeto Credenciais KMS do Amazon Web Services contém credenciais para usar o fornecedor KMS do Amazon Web Services.

Colapsode resumo constante

FORMAT_HINT =

Essa constante faz parte de uma API privada. Você deve evitar usar essa constante, se possível, pois ela pode ser removida ou alterada no futuro. 

'As opções do fornecedor AWS KMS devem estar no formato: ' +
"{ access_key_id: 'YOUR-ACCESS-KEY-ID', secret_access_key: 'SECRET-ACCESS-KEY' }"

Recolhimento do Resumo do atributo de instância

Recolhimento do Resumo do método de instância

Métodos incluídos nas Validações

#validate_param, validate_tls_options

Detalhes do construtor

#initialize(opts) ➤ Credenciais

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Cria um objeto de credenciais do Amazon Web Services KMS de um hash de parâmetros.

Parâmetros:

  • opciona (Hash) —

    Um hash que contém credenciais do fornecedor Amazon Web Services KMS

Hash de opções (opts):

  • :access_key_id (string) —

    ID da chave de acesso do Amazon Web Services .

  • :secret_access_key (string) —

    Chave de acesso secreto do Amazon Web Services.

  • :session_token (string | nil) —

    Token de sessão do Amazon Web Services, opcional.

Aumenta:

  • (ArgumentError) —

    Se as opções necessárias estiverem ausentes ou formatadas incorretamente.



53
54
55
56
57
58
59
60
 
# Arquivo 'lib/mongo/crypt/KMS/Amazon Web Services/credentials.rb', linha 53

def inicializar(opciona)
  @opts = opciona
  Método se vazio?

  @access_key_id = validate_param(:access_key_id, opciona, FORMAT_HINT)
  @secret_access_key = validate_param(:secret_access_key, opciona, FORMAT_HINT)
  @session_token = validate_param(:session_token, opciona, FORMAT_HINT, necessário: false)
end

Detalhes do atributo da instância

#access_key_id ➤ string (somente leitura)

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Retorna a chave de acesso do Amazon Web Services.

Retorna:

  • (string) —

    Chave de acesso Amazon Web Services.



29
30
31
 
# Arquivo 'lib/mongo/crypt/KMS/Amazon Web Services/credentials.rb', linha 29

def access_key_id
  @access_key_id
end

#secret_access_key ➤ string (readonly)

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Retorna a chave de acesso secreto do Amazon Web Services.

Retorna:

  • (string) —

    Chave de acesso secreto do Amazon Web Services.



32
33
34
 
# Arquivo 'lib/mongo/crypt/KMS/Amazon Web Services/credentials.rb', linha 32

def secret_access_key
  @secret_access_key
end

#session_token token string | nil (somente leitura)

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Retorna o token de sessão do Amazon Web Services.

Retorna:

  • (string | nil) —

    Token de sessão do Amazon Web Services.



35
36
37
 
# Arquivo 'lib/mongo/crypt/KMS/Amazon Web Services/credentials.rb', linha 35

def session_token
  @session_token
end

Detalhes do método de instância

#to_document ➤ BSON::Document

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Converta o objeto de credenciais em um documento BSON no formato libmongocrypt.

Retorna:

  • (BSON::Document) —

    Credenciais Amazon Web Services KMS no formato libmongocrypt.



65
66
67
68
69
70
71
72
73
74
 
# Arquivo 'lib/mongo/crypt/KMS/Amazon Web Services/credentials.rb', linha 65

def to_document
  Método BSON::Documento.Novo se vazio?

  BSON::Documento.Novo({
                       accessKeyId: access_key_id,
                       secretAccessKey: secret_access_key,
                     }).toque fazer |BSON|
    BSON.update({ sessionToken: session_token }) a menos que session_token.nada?
  end
end