Class: BoltServer::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/bolt_server/config.rb

Constant Summary collapse

CONFIG_KEYS = 
['host', 'port', 'ssl-cert', 'ssl-key', 'ssl-ca-cert',
'ssl-cipher-suites', 'loglevel', 'logfile', 'whitelist', 'concurrency',
'cache-dir', 'file-server-conn-timeout', 'file-server-uri'].freeze
DEFAULTS = 
{
  'host' => '127.0.0.1',
  'port' => 62658,
  'ssl-cipher-suites' => ['ECDHE-ECDSA-AES256-GCM-SHA384',
                          'ECDHE-RSA-AES256-GCM-SHA384',
                          'ECDHE-ECDSA-CHACHA20-POLY1305',
                          'ECDHE-RSA-CHACHA20-POLY1305',
                          'ECDHE-ECDSA-AES128-GCM-SHA256',
                          'ECDHE-RSA-AES128-GCM-SHA256',
                          'ECDHE-ECDSA-AES256-SHA384',
                          'ECDHE-RSA-AES256-SHA384',
                          'ECDHE-ECDSA-AES128-SHA256',
                          'ECDHE-RSA-AES128-SHA256'],
  'loglevel' => 'notice',
  'concurrency' => 100,
  'cache-dir' => "/opt/puppetlabs/server/data/bolt-server/cache",
  'file-server-conn-timeout' => 120
}.freeze

Instance Method Summary collapse

Constructor Details

#initialize(config = nil) ⇒ Config

Returns a new instance of Config.



37
38
39
40
41
 
# File 'lib/bolt_server/config.rb', line 37

def initialize(config = nil)
  @data = DEFAULTS.clone
  @data = @data.merge(config.select { |key, _| CONFIG_KEYS.include?(key) }) if config
  @config_path = nil
end

Instance Method Details

#[](key) ⇒ Object 



101
102
103
 
# File 'lib/bolt_server/config.rb', line 101

def [](key)
  @data[key]
end

#load_config(path) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/bolt_server/config.rb', line 43

def load_config(path)
  @config_path = path
  begin
    parsed_hocon = Hocon.load(path)['bolt-server']
  rescue Hocon::ConfigError => e
    raise "Hocon data in '#{path}' failed to load.\n Error: '#{e.message}'"
  rescue Errno::EACCES
    raise "Your user doesn't have permission to read #{path}"
  end

  raise "Could not find bolt-server config at #{path}" if parsed_hocon.nil?

  parsed_hocon = parsed_hocon.select { |key, _| CONFIG_KEYS.include?(key) }
  @data = @data.merge(parsed_hocon)

  validate
  self
end

#natural?(num) ⇒ Boolean

Returns:

  • (Boolean) 


62
63
64
 
# File 'lib/bolt_server/config.rb', line 62

def natural?(num)
  num.is_a?(Integer) && num.positive?
end

#validate ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/bolt_server/config.rb', line 66

def validate
  ssl_keys = ['ssl-cert', 'ssl-key', 'ssl-ca-cert']
  required_keys = ssl_keys + ['file-server-uri']

  required_keys.each do |k|
    next unless @data[k].nil?
    raise Bolt::ValidationError, "You must configure #{k} in #{@config_path}"
  end

  unless natural?(port)
    raise Bolt::ValidationError, "Configured 'port' must be a valid integer greater than 0"
  end
  ssl_keys.each do |sk|
    unless File.file?(@data[sk]) && File.readable?(@data[sk])
      raise Bolt::ValidationError, "Configured #{sk} must be a valid filepath"
    end
  end

  unless ssl_cipher_suites.is_a?(Array)
    raise Bolt::ValidationError, "Configured 'ssl-cipher-suites' must be an array of cipher suite names"
  end

  unless whitelist.nil? || whitelist.is_a?(Array)
    raise Bolt::ValidationError, "Configured 'whitelist' must be an array of names"
  end

  unless natural?(concurrency)
    raise Bolt::ValidationError, "Configured 'concurrency' must be a positive integer"
  end

  unless natural?(file_server_conn_timeout)
    raise Bolt::ValidationError, "Configured 'file-server-conn-timeout' must be a positive integer"
  end
end