Class: Puppetserver::Ca::Config::Puppet

Inherits:
Object
  • Object
show all
Defined in:
lib/puppetserver/ca/config/puppet.rb

Overview

Provides an interface for asking for Puppet settings w/o loading Puppet. Includes a simple ini parser that will ignore Puppet’s more complicated conventions.

Constant Summary collapse

TTL_UNITMAP =

How we convert from various units to seconds.

{
  # 365 days isn't technically a year, but is sufficient for most purposes
  "y" => 365 * 24 * 60 * 60,
  "d" => 24 * 60 * 60,
  "h" => 60 * 60,
  "m" => 60,
  "s" => 1
}
TTL_FORMAT =

A regex describing valid formats with groups for capturing the value and units

/^(\d+)(y|d|h|m|s)?$/

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(supplied_config_path = nil) ⇒ Puppet

Returns a new instance of Puppet.



35
36
37
38
39
40
41
 
# File 'lib/puppetserver/ca/config/puppet.rb', line 35

def initialize(supplied_config_path = nil)
  @using_default_location = !supplied_config_path
  @config_path = supplied_config_path || user_specific_puppet_config

  @settings = nil
  @errors = []
end

Instance Attribute Details

#errors ⇒ Object (readonly)

Returns the value of attribute errors.



33
34
35
 
# File 'lib/puppetserver/ca/config/puppet.rb', line 33

def errors
  @errors
end

#settings ⇒ Object (readonly)

Returns the value of attribute settings.



33
34
35
 
# File 'lib/puppetserver/ca/config/puppet.rb', line 33

def settings
  @settings
end

Class Method Details

.parse(config_path, logger) ⇒ Object 



26
27
28
29
30
31
 
# File 'lib/puppetserver/ca/config/puppet.rb', line 26

def self.parse(config_path, logger)
  instance = new(config_path)
  instance.load(logger: logger)

  return instance
end

Instance Method Details

#default_certname ⇒ Object 



79
80
81
82
83
84
85
86
87
88
 
# File 'lib/puppetserver/ca/config/puppet.rb', line 79

def default_certname
  hostname = Facter.value(:hostname)
  domain = Facter.value(:domain)
  if domain and domain != ''
    fqdn = [hostname, domain].join('.')
  else
    fqdn = hostname
  end
  fqdn.chomp('.')
end

#load(cli_overrides: {}, logger:, ca_dir_warn: true) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/puppetserver/ca/config/puppet.rb', line 57

def load(cli_overrides: {}, logger:, ca_dir_warn: true)
  if explicitly_given_config_file_or_default_config_exists?
    results = parse_text(File.read(@config_path))
  end

  results ||= {}
  results[:main] ||= {}
  # The [master] config section is deprecated
  # We now favor [server], but support both for backwards compatibility
  results[:master] ||= {}
  results[:server] ||= {}
  results[:agent] ||= {}

  overrides = results[:agent].merge(results[:main]).merge(results[:master]).merge(results[:server])
  overrides.merge!(cli_overrides)
  if overrides[:masterport]
    overrides[:serverport] ||= overrides.delete(:masterport)
  end

  @settings = resolve_settings(overrides, logger, ca_dir_warn: ca_dir_warn).freeze
end

#parse_text(text) ⇒ Object

Parse an inifile formatted String. Only captures word character class keys/section names but nearly any character values (excluding leading whitespace) up to one of whitespace, opening curly brace, or hash sign (Our concern being to capture filesystem path values).

ca_root and root_ca_name values may include whitespace

Put values without a section into :main.

Return Hash of Symbol section names with Symbol setting keys and String values.



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/puppetserver/ca/config/puppet.rb', line 204

def parse_text(text)
  res = {}
  current_section = :main
  text.each_line do |line|
    case line
    when /^\s*\[(\w+)\].*/
      current_section = $1.to_sym
    when /^\s*(\w+)\s*=\s*(.+?)\s*(?=[{#]|$)/
      # Using a Hash with a default key breaks RSpec expectations.
      res[current_section] ||= {}
      res[current_section][$1.to_sym] =
        if [:ca_name, :root_ca_name].include?($1.to_sym)
          $2
        else
          $2.split(' ')[0]
        end
    end
  end

  res
end

#resolve_settings(overrides = {}, logger, ca_dir_warn: true) ⇒ Object

Resolve settings from default values, with any overrides for the specific settings or their dependent settings (ssldir, cadir) taken into account.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/puppetserver/ca/config/puppet.rb', line 92

def resolve_settings(overrides = {}, logger, ca_dir_warn: true)
  unresolved_setting = /\$[a-z_]+/

  # Returning the key for unknown keys (rather than nil) is required to
  # keep unknown settings in the string for later verification.
  substitutions = Hash.new {|h, k| k }
  settings = {}

  # Order for base settings here matters!
  # These need to be evaluated before we can construct their dependent
  # defaults below
  base_defaults = [
    [:confdir, user_specific_puppet_confdir],
    [:ssldir,'$confdir/ssl'],
    [:certdir, '$ssldir/certs'],
    [:certname, default_certname],
    [:server, 'puppet'],
    [:serverport, '8140'],
    [:privatekeydir, '$ssldir/private_keys'],
    [:publickeydir, '$ssldir/public_keys'],
  ]

  dependent_defaults = {
    :ca_name => 'Puppet CA: $certname',
    :root_ca_name => "Puppet Root CA: #{SecureRandom.hex(7)}",
    :keylength => 4096,
    :cacert => '$cadir/ca_crt.pem',
    :cakey => '$cadir/ca_key.pem',
    :capub => '$cadir/ca_pub.pem',
    :csr_attributes => '$confdir/csr_attributes.yaml',
    :rootkey => '$cadir/root_key.pem',
    :cacrl => '$cadir/ca_crl.pem',
    :serial => '$cadir/serial',
    :cert_inventory => '$cadir/inventory.txt',
    :ca_server => '$server',
    :ca_port => '$serverport',
    :localcacert => '$certdir/ca.pem',
    :hostcrl => '$ssldir/crl.pem',
    :hostcert => '$certdir/$certname.pem',
    :hostprivkey => '$privatekeydir/$certname.pem',
    :hostpubkey => '$publickeydir/$certname.pem',
    :ca_ttl => '15y',
    :certificate_revocation => 'true',
    :signeddir => '$cadir/signed',
    :server_list => '',
  }

  # This loops through the base defaults and gives each setting a
  # default if the value isn't specified in the config file. Default
  # values given may depend upon the value of a previous base setting,
  # thus the creation of the substitution hash.
  base_defaults.each do |setting_name, default_value|
    substitution_name = '$' + setting_name.to_s
    setting_value = overrides.fetch(setting_name, default_value)
    subbed_value = setting_value.sub(unresolved_setting, substitutions)
    settings[setting_name] = substitutions[substitution_name] = subbed_value
  end

  cadir = find_cadir(overrides.fetch(:cadir, false),
                     settings[:confdir],
                     settings[:ssldir],
                     logger,
                     ca_dir_warn)
  settings[:cadir] = substitutions['$cadir'] = cadir


  dependent_defaults.each do |setting_name, default_value|
    setting_value = overrides.fetch(setting_name, default_value)
    settings[setting_name] = setting_value
  end

  # If subject-alt-names are provided, we need to add the certname in addition
  overrides[:dns_alt_names] << ',$certname' if overrides[:dns_alt_names]

  # rename dns_alt_names to subject_alt_names now that we support IP alt names
  settings[:subject_alt_names] = overrides.fetch(:dns_alt_names, "")

  # Some special cases where we need to manipulate config settings:
  settings[:ca_ttl] = munge_ttl_setting(settings[:ca_ttl])
  settings[:certificate_revocation] = parse_crl_usage(settings[:certificate_revocation])
  settings[:subject_alt_names] = Puppetserver::Ca::Utils::Config.munge_alt_names(settings[:subject_alt_names])
  settings[:keylength] = settings[:keylength].to_i
  settings[:server_list] = settings[:server_list].
                             split(/\s*,\s*/).
                             map {|entry| entry.split(":") }

  update_for_server_list!(settings)

  settings.each do |key, value|
    next unless value.is_a? String
    settings[key] = value.gsub(unresolved_setting, substitutions)
    if match = settings[key].match(unresolved_setting)
      @errors << "Could not parse #{match[0]} in #{value}, " +
                 'valid settings to be interpolated are ' +
                 '$ssldir, $certdir, $cadir, $certname, $server, or $masterport'
    end
  end

  return settings
end

#user_specific_puppet_confdir ⇒ Object

Return the correct confdir. We check for being root on *nix, else the user path. We do not include a check for running as Adminstrator since non-development scenarios for Puppet Server on Windows are unsupported. Note that Puppet Server runs as the [pe-]puppet user but to start/stop it you must be root.



49
50
51
 
# File 'lib/puppetserver/ca/config/puppet.rb', line 49

def user_specific_puppet_confdir
  @user_specific_puppet_confdir ||= Puppetserver::Ca::Utils::Config.puppet_confdir
end

#user_specific_puppet_config ⇒ Object 



53
54
55
 
# File 'lib/puppetserver/ca/config/puppet.rb', line 53

def user_specific_puppet_config
  user_specific_puppet_confdir + '/puppet.conf'
end