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

Herda:
Objeto
  • Objeto
mostrar tudo
Estendido por:
Encaminhável
Inclui:
Validações
Definido em:
build/ruby-driver-v2.19/lib/mongo/crypt/KMS/local/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 locais contém credenciais para usar o provedor KMS local.

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 provedor local de KMS devem estar no formato: " +
"{ key: 'MASTER-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 KMS local de um hash de parâmetros.

Parâmetros:

  • opciona (Hash) —

    Um hash que contém credenciais do provedor local de KMS

Hash de opções (opts):

  • :key (string) —

    Chave mestre.

Aumenta:

  • (ArgumentError) —

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



46
47
48
49
50
51
 
# File 'build/ruby-driver-v2.19/lib/mongo/crypt/KMS/local/credentials.rb', linha 46

def inicializar(opciona)
  @opts = opciona
  a menos que vazio?
    @key = validate_param(:key, opciona, FORMAT_HINT)
  end
end

Detalhes do atributo da instância

#chave ➤ 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 mestre.

Retorna:

  • (string) —

    Chave mestre.



30
31
32
 
# File 'build/ruby-driver-v2.19/lib/mongo/crypt/KMS/local/credentials.rb', linha 30

def chave
  @key
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.

Retorna credenciais KMS locais no formato libmongocrypt.

Retorna:

  • (BSON::Document) —

    Credenciais KMS locais no formato libmongocrypt.



54
55
56
57
58
59
 
# File 'build/ruby-driver-v2.19/lib/mongo/crypt/KMS/local/credentials.rb', linha 54

def to_document
  Método BSON::Documento.Novo({}) se vazio?
  BSON::Documento.Novo({
    chave: BSON::Binário.Novo(@key, :general),
  })
end