Classe: Mongo::Crypt::KMS::KMIP::MasterKeyDocument Private

Herda:
Objeto
  • Objeto
mostrar tudo
Inclui:
Validações
Definido em:
build/ruby-driver-v2.19/lib/mongo/crypt/KMS/kmip/master_document.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 de documento de chave mestra KMIP KMS contém parâmetros de chave mestra KMS.

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. 

"O documento de chave KMIP KMS deve estar no formato: " +
"{ key_id: 'KEY-ID', endpoint: 'ENDPOINT' }"

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 = {}) ➤ MasterKeyDocument

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 documento de chave mestra a partir de um hash de parâmetros.

Parâmetros:

  • opciona (Hash) (padrão para: {}) —

    Um hash que contém opções de chave mestre para o provedor KMIP KMS

Hash de opções (opts):

  • :key_id (string | nil) —

    Identificador exclusivo KMIP para um objeto gerenciado de dados secretos KMIP de 96 bytes, opcional. Se key_id for omitido, o driver criará um identificador de bytes 96 aleatório.

  • :endpoint (string | nil) —

    Ponto de extremidade KMIP, opcional.

Aumenta:

  • (ArgumentError) —

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



49
50
51
52
53
54
55
56
 
# File 'build/ruby-driver-v2.19/lib/mongo/crypt/KMS/kmip/master_document.rb', linha 49

def inicializar(opciona = {})
  @key_id = validate_param(
    :key_id, opciona, FORMAT_HINT, necessário: false
  )
  @endpoint = validate_param(
    :endpoint, opciona, FORMAT_HINT, necessário: false
  )
end

Detalhes do atributo da instância

#endpoint ➤ 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 endpoint KMIP KMS com porta opcional.

Retorna:

  • (string | nil) —

    Endpoint KMIP KMS com porta opcional.



33
34
35
 
# File 'build/ruby-driver-v2.19/lib/mongo/crypt/KMS/kmip/master_document.rb', linha 33

def endpoint
  @endpoint
end

#key_id ➤ 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 identificador exclusivo KMIP para um objeto gerenciado de dados secretos KMIP de 96 bytes.

Retorna:

  • (string | nil) —

    O Identificador exclusivo KMIP para um objeto gerenciado de dados secretos KMIP de 96 bytes .



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

def key_id
  @key_id
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 documento de chave mestra em um documento BSON no formato libmongocrypt.

Retorna:

  • (BSON::Document) —

    Credenciais KMIP KMS no formato libmongocrypt.



61
62
63
64
65
66
67
68
 
# File 'build/ruby-driver-v2.19/lib/mongo/crypt/KMS/kmip/master_document.rb', linha 61

def to_document
  BSON::Documento.Novo({
    fornecedor: 'kmip',
  }).toque fazer |BSON|
    BSON.update({ ponto de conexão: endpoint }) a menos que endpoint.nada?
    BSON.update({ keyId: key_id }) a menos que key_id.nada?
  end
end