Class: Mongo::Crypt::KMS::GCP::MasterKeyDocument Private

Inherits:
Object
  • Object
show all
Includes:
Validations
Defined in:
lib/mongo/crypt/kms/gcp/master_document.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

GCP KMS master key document object contains KMS master key parameters.

Constant Summary collapse

FORMAT_HINT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

'GCP key document  must be in the format: ' +
"{ project_id: 'PROJECT_ID', location: 'LOCATION', " +
"key_ring: 'KEY-RING', key_name: 'KEY-NAME' }"

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Validations

#validate_param, validate_tls_options

Constructor Details

#initialize(opts) ⇒ MasterKeyDocument

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Creates a master key document object form a parameters hash.

Parameters:

  • opts (Hash) —

    A hash that contains master key options for the GCP KMS provider.

Options Hash (opts):

  • :project_id (String) —

    GCP project id.

  • :location (String) —

    GCP location.

  • :key_ring (String) —

    GCP KMS key ring.

  • :key_name (String) —

    GCP KMS key name.

  • :key_version (String | nil) —

    GCP KMS key version, optional.

  • :endpoint (String | nil) —

    GCP KMS key endpoint, optional.

Raises:

  • (ArgumentError) —

    If required options are missing or incorrectly.



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/mongo/crypt/kms/gcp/master_document.rb', line 61

def initialize(opts)
  if opts.empty?
    @empty = true
    return
  end
  @project_id = validate_param(:project_id, opts, FORMAT_HINT)
  @location = validate_param(:location, opts, FORMAT_HINT)
  @key_ring = validate_param(:key_ring, opts, FORMAT_HINT)
  @key_name = validate_param(:key_name, opts, FORMAT_HINT)
  @key_version = validate_param(:key_version, opts, FORMAT_HINT, required: false)
  @endpoint = validate_param(:endpoint, opts, FORMAT_HINT, required: false)
end

Instance Attribute Details

#endpoint ⇒ String | nil (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns GCP KMS endpoint.

Returns:

  • (String | nil) —

    GCP KMS endpoint.



43
44
45
 
# File 'lib/mongo/crypt/kms/gcp/master_document.rb', line 43

def endpoint
  @endpoint
end

#key_name ⇒ String (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns GCP KMS key name.

Returns:

  • (String) —

    GCP KMS key name.



37
38
39
 
# File 'lib/mongo/crypt/kms/gcp/master_document.rb', line 37

def key_name
  @key_name
end

#key_ring ⇒ String (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns GCP KMS key ring.

Returns:

  • (String) —

    GCP KMS key ring.



34
35
36
 
# File 'lib/mongo/crypt/kms/gcp/master_document.rb', line 34

def key_ring
  @key_ring
end

#key_version ⇒ String | nil (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns GCP KMS key version.

Returns:

  • (String | nil) —

    GCP KMS key version.



40
41
42
 
# File 'lib/mongo/crypt/kms/gcp/master_document.rb', line 40

def key_version
  @key_version
end

#location ⇒ String (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns GCP location.

Returns:

  • (String) —

    GCP location.



31
32
33
 
# File 'lib/mongo/crypt/kms/gcp/master_document.rb', line 31

def location
  @location
end

#project_id ⇒ String (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns GCP project id.

Returns:

  • (String) —

    GCP project id.



28
29
30
 
# File 'lib/mongo/crypt/kms/gcp/master_document.rb', line 28

def project_id
  @project_id
end

Instance Method Details

#to_document ⇒ BSON::Document

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Convert master key document object to a BSON document in libmongocrypt format.

Returns:

  • (BSON::Document) —

    GCP KMS credentials in libmongocrypt format.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/mongo/crypt/kms/gcp/master_document.rb', line 77

def to_document
  return BSON::Document.new({}) if @empty

  BSON::Document.new({
                       provider: 'gcp',
                       projectId: project_id,
                       location: location,
                       keyRing: key_ring,
                       keyName: key_name
                     }).tap do |bson|
    bson.update({ keyVersion: key_version }) unless key_version.nil?
    bson.update({ endpoint: endpoint }) unless endpoint.nil?
  end
end