Class: ChefConfig::Config

Inherits:
Object
  • Object
show all
Extended by:
Mixin::FuzzyHostnameMatcher, Mixlib::Config
Defined in:
lib/chef-config/config.rb

Constant Summary collapse

USER =

Character classes for Addressable See www.ietf.org/rfc/rfc3986.txt 3.2.1 The user part may not have a : in it

Addressable::URI::CharacterClasses::UNRESERVED + Addressable::URI::CharacterClasses::SUB_DELIMS
PASSWORD =

The password part may have any valid USERINFO characters

USER + "\\:"

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Mixin::FuzzyHostnameMatcher

fuzzy_hostname_match?, fuzzy_hostname_match_any?

Class Method Details

._this_file ⇒ Object

Path to this file in the current install.



1241
1242
1243
 
# File 'lib/chef-config/config.rb', line 1241

def self._this_file
  File.expand_path(__FILE__)
end

.add_event_logger(logger) ⇒ Object

Parameters:

  • logger (String) 


128
129
130
 
# File 'lib/chef-config/config.rb', line 128

def self.add_event_logger(logger)
  event_handlers << logger
end

.add_formatter(name, file_path = nil) ⇒ Object

Parameters:

  • name (String)
  • file_path (String) (defaults to: nil) 


123
124
125
 
# File 'lib/chef-config/config.rb', line 123

def self.add_formatter(name, file_path = nil)
  formatters << [name, file_path]
end

.apply_extra_config_options(extra_config_options) ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/chef-config/config.rb', line 132

def self.apply_extra_config_options(extra_config_options)
  if extra_config_options
    extra_parsed_options = extra_config_options.inject({}) do |memo, option|
      # Sanity check value.
      if option.empty? || !option.include?("=")
        raise UnparsableConfigOption, "Unparsable config option #{option.inspect}"
      end

      # Split including whitespace if someone does truly odd like
      # --config-option "foo = bar"
      key, value = option.split(/\s*=\s*/, 2)

      # Call to_sym because Chef::Config expects only symbol keys. Also
      # runs a simple parse on the string for some common types.
      memo[key.to_sym] = YAML.safe_load(value)
      memo
    end
    set_extra_config_options(extra_parsed_options)
  end
end

.c_chef_dir ⇒ Object

On windows, C:/chef/



96
97
98
99
100
 
# File 'lib/chef-config/config.rb', line 96

def self.c_chef_dir
  drive = windows_installation_drive || "C:"
  path = PathHelper.join(drive, ChefConfig::Dist::DIR_SUFFIX)
  PathHelper.cleanpath(path)
end

.c_opscode_dir ⇒ Object 



102
103
104
105
106
 
# File 'lib/chef-config/config.rb', line 102

def self.c_opscode_dir
  drive = windows_installation_drive || "C:"
  path = PathHelper.join(drive, ChefConfig::Dist::LEGACY_CONF_DIR, ChefConfig::Dist::DIR_SUFFIX)
  PathHelper.cleanpath(path)
end

.derive_path_from_chef_repo_path(child_path) ⇒ Object

Parameters:

  • child_path (String) 


251
252
253
254
255
256
257
 
# File 'lib/chef-config/config.rb', line 251

def self.derive_path_from_chef_repo_path(child_path)
  if chef_repo_path.is_a?(String)
    PathHelper.join(chef_repo_path, child_path)
  else
    chef_repo_path.uniq.map { |path| PathHelper.join(path, child_path) }
  end
end

.embedded_dir ⇒ Object

If installed via an omnibus installer, this gives the path to the “embedded” directory which contains all of the software packaged with omnibus. This is used to locate the cacert.pem file on windows.



1230
1231
1232
1233
1234
1235
1236
1237
1238
 
# File 'lib/chef-config/config.rb', line 1230

def self.embedded_dir
  Pathname.new(_this_file).ascend do |path|
    if path.basename.to_s == "embedded"
      return path.to_s
    end
  end

  nil
end

.enable_fips_mode ⇒ Object

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.

Set fips mode in openssl. Do any patching necessary to make sure Chef runs do not crash.



1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
 
# File 'lib/chef-config/config.rb', line 1248

def self.enable_fips_mode
  OpenSSL.fips_mode = true
  require "digest"
  require "digest/sha1"
  require "digest/md5"
  # Remove pre-existing constants if they do exist to reduce the
  # amount of log spam and warnings.
  Digest.send(:remove_const, "SHA1") if Digest.const_defined?("SHA1")
  Digest.const_set("SHA1", OpenSSL::Digest::SHA1)
  OpenSSL::Digest.send(:remove_const, "MD5") if OpenSSL::Digest.const_defined?("MD5")
  OpenSSL::Digest.const_set("MD5", Digest::MD5)
  ChefConfig.logger.debug "FIPS mode is enabled."
end

.env ⇒ Object

This provides a hook which rspec can stub so that we can avoid twiddling global state in tests.



913
914
915
 
# File 'lib/chef-config/config.rb', line 913

def self.env
  ENV
end

.etc_chef_dir(is_windows = ChefUtils.windows?) ⇒ Object

On *nix, /etc/chef



78
79
80
81
 
# File 'lib/chef-config/config.rb', line 78

def self.etc_chef_dir(is_windows = ChefUtils.windows?)
  path = is_windows ? c_chef_dir : PathHelper.join("/etc", ChefConfig::Dist::DIR_SUFFIX)
  PathHelper.cleanpath(path)
end

.expand_relative_paths(path) ⇒ Object 



199
200
201
202
203
204
205
206
207
 
# File 'lib/chef-config/config.rb', line 199

def self.expand_relative_paths(path)
  unless path.nil?
    if path.is_a?(String)
      File.expand_path(path)
    else
      Array(path).map { |path| File.expand_path(path) }
    end
  end
end

.export_no_proxy(value) ⇒ Object

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. 



1133
1134
1135
1136
 
# File 'lib/chef-config/config.rb', line 1133

def self.export_no_proxy(value)
  ENV["no_proxy"] = value unless ENV["no_proxy"]
  ENV["NO_PROXY"] = value unless ENV["NO_PROXY"]
end

.export_proxies ⇒ Object

Public method that users should call to export proxies to the appropriate environment variables. This method should be called after the config file is parsed and loaded. TODO add some post-file-parsing logic that automatically calls this so users don’t have to



1089
1090
1091
1092
1093
1094
 
# File 'lib/chef-config/config.rb', line 1089

def self.export_proxies
  export_proxy("http", http_proxy, http_proxy_user, http_proxy_pass) if key?(:http_proxy) && http_proxy
  export_proxy("https", https_proxy, https_proxy_user, https_proxy_pass) if key?(:https_proxy) && https_proxy
  export_proxy("ftp", ftp_proxy, ftp_proxy_user, ftp_proxy_pass) if key?(:ftp_proxy) && ftp_proxy
  export_no_proxy(no_proxy) if key?(:no_proxy) && no_proxy
end

.export_proxy(scheme, path, user, pass) ⇒ Object

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.

Builds a proxy uri and exports it to the appropriate environment variables. Examples:

http://username:password@hostname:port
https://username@hostname:port
ftp://hostname:port

when

scheme = "http", "https", or "ftp"
hostport = hostname:port or scheme://hostname:port
user = username
pass = password



1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
 
# File 'lib/chef-config/config.rb', line 1113

def self.export_proxy(scheme, path, user, pass)
  path = "#{scheme}://#{path}" unless path.include?("://")
  # URI.split returns the following parts:
  # [scheme, userinfo, host, port, registry, path, opaque, query, fragment]
  uri = Addressable::URI.encode(path, Addressable::URI)

  if user && !user.empty?
    userinfo = Addressable::URI.encode_component(user, USER)
    if pass
      userinfo << ":#{Addressable::URI.encode_component(pass, PASSWORD)}"
    end
    uri.userinfo = userinfo
  end

  path = uri.to_s
  ENV["#{scheme}_proxy".downcase] = path unless ENV["#{scheme}_proxy".downcase]
  ENV["#{scheme}_proxy".upcase] = path unless ENV["#{scheme}_proxy".upcase]
end

.find_chef_repo_path(cwd) ⇒ Object 



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/chef-config/config.rb', line 234

def self.find_chef_repo_path(cwd)
  # In local mode, we auto-discover the repo root by looking for a path with "cookbooks" under it.
  # This allows us to run config-free.
  path = cwd
  until File.directory?(PathHelper.join(path, "cookbooks")) || File.directory?(PathHelper.join(path, "cookbook_artifacts"))
    new_path = File.expand_path("..", path)
    if new_path == path
      ChefConfig.logger.warn("No cookbooks directory found at or above current directory.  Assuming #{cwd}.")
      return cwd
    end
    path = new_path
  end
  ChefConfig.logger.info("Auto-discovered #{ChefConfig::Dist::SHORT} repository at #{path}")
  path
end

.from_string(string, filename) ⇒ Object

Evaluates the given string as config.

filename is used for context in stacktraces, but doesn’t need to be the name of an actual file.



49
50
51
 
# File 'lib/chef-config/config.rb', line 49

def self.from_string(string, filename)
  instance_eval(string, filename, 1)
end

.guess_internal_locale ⇒ Object

Chef requires an English-language UTF-8 locale to function properly. We attempt to use the ‘locale -a’ command and search through a list of preferences until we find one that we can use. On Ubuntu systems we should find ‘C.UTF-8’ and be able to use that even if there is no English locale on the server, but Mac, Solaris, AIX, etc do not have that locale. We then try to find an English locale and fall back to ‘C’ if we do not. The choice of fallback is pick-your-poison. If we try to do the work to return a non-US UTF-8 locale then we fail inside of providers when things like ‘svn info’ return Japanese and we can’t parse them. OTOH, if we pick ‘C’ then we will blow up on UTF-8 characters. Between the warn we throw and the Encoding exception that ruby will throw it is more obvious what is broken if we drop UTF-8 by default rather than drop English.

If there is no ‘locale -a’ then we return ‘en_US.UTF-8’ since that is the most commonly available English UTF-8 locale. However, all modern POSIXen should support ‘locale -a’.



1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
 
# File 'lib/chef-config/config.rb', line 1172

def self.guess_internal_locale
  # https://github.com/chef/chef/issues/2181
  # Some systems have the `locale -a` command, but the result has
  # invalid characters for the default encoding.
  #
  # For example, on CentOS 6 with ENV['LANG'] = "en_US.UTF-8",
  # `locale -a`.split fails with ArgumentError invalid UTF-8 encoding.
  cmd = Mixlib::ShellOut.new("locale -a").run_command
  cmd.error!
  locales = cmd.stdout.split
  case
  when locales.include?("C.UTF-8")
    "C.UTF-8"
  when locales.include?("en_US.UTF-8"), locales.include?("en_US.utf8")
    "en_US.UTF-8"
  when locales.include?("en.UTF-8")
    "en.UTF-8"
  else
    # Will match en_ZZ.UTF-8, en_ZZ.utf-8, en_ZZ.UTF8, en_ZZ.utf8
    guesses = locales.select { |l| l =~ /^en_.*UTF-?8$/i }
    unless guesses.empty?
      guessed_locale = guesses.first
      # Transform into the form en_ZZ.UTF-8
      guessed_locale.gsub(/UTF-?8$/i, "UTF-8")
    else
      ChefConfig.logger.warn "Please install an English UTF-8 locale for Chef to use, falling back to C locale and disabling UTF-8 support."
      "C"
    end
  end
rescue
  if ChefUtils.windows?
    ChefConfig.logger.trace "Defaulting to locale en_US.UTF-8 on Windows, until it matters that we do something else."
  else
    ChefConfig.logger.trace "No usable locale -a command found, assuming you have en_US.UTF-8 installed."
  end
  "en_US.UTF-8"
end

.init_openssl ⇒ Object

Initialize openssl



679
680
681
682
683
 
# File 'lib/chef-config/config.rb', line 679

def self.init_openssl
  if fips
    enable_fips_mode
  end
end

.inspect ⇒ Object 



53
54
55
 
# File 'lib/chef-config/config.rb', line 53

def self.inspect
  configuration.inspect
end

.is_valid_url?(uri) ⇒ Boolean

Returns is the URL valid.

Parameters:

  • uri (String) —

    the URI to validate

Returns:

  • (Boolean) —

    is the URL valid



176
177
178
179
 
# File 'lib/chef-config/config.rb', line 176

def self.is_valid_url?(uri)
  url = uri.to_s.strip
  %r{^http://} =~ url || %r{^https://} =~ url || /^chefzero:/ =~ url
end

.path_accessible?(path) ⇒ Boolean

Returns true only if the path exists and is readable and writeable for the user.

Parameters:

  • path (String)

Returns:

  • (Boolean) 


354
355
356
 
# File 'lib/chef-config/config.rb', line 354

def self.path_accessible?(path)
  File.exists?(path) && File.readable?(path) && File.writable?(path)
end

.platform_specific_path(path) ⇒ String

given a *nix style config path return the platform specific path to that same config file

Examples:

client.pem path on Windows

platform_specific_path("/etc/chef/client.pem") #=> "C:\\chef\\client.pem"

Parameters:

  • path (String) —

    The unix path to convert to a platform specific path

Returns:

  • (String) —

    a platform specific path



63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/chef-config/config.rb', line 63

def self.platform_specific_path(path)
  path = PathHelper.cleanpath(path)
  if ChefUtils.windows?
    # turns \etc\chef\client.rb and \var\chef\client.rb into C:/chef/client.rb
    # Some installations will be on different drives so use the drive that
    # the expanded path to __FILE__ is found.
    drive = windows_installation_drive
    if drive && path[0] == '\\' && path.split('\\')[2] == "chef"
      path = PathHelper.join(drive, path.split('\\', 3)[2])
    end
  end
  path
end

.proxy_uri(scheme, host, port) ⇒ Object

Given a scheme, host, and port, return the correct proxy URI based on the set environment variables, unless exluded by no_proxy, in which case nil is returned



1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
 
# File 'lib/chef-config/config.rb', line 1141

def self.proxy_uri(scheme, host, port)
  proxy_env_var = ENV["#{scheme}_proxy"].to_s.strip

  # Check if the proxy string contains a scheme. If not, add the url's scheme to the
  # proxy before parsing. The regex /^.*:\/\// matches, for example, http://. Reusing proxy
  # here since we are really just trying to get the string built correctly.
  proxy = unless proxy_env_var.empty?
            if proxy_env_var =~ %r{^.*://}
              URI.parse(proxy_env_var)
            else
              URI.parse("#{scheme}://#{proxy_env_var}")
            end
          end

  return proxy unless fuzzy_hostname_match_any?(host, ENV["no_proxy"])
end

.set_defaults_for_nix ⇒ Object 



891
892
893
894
895
896
897
898
899
900
901
 
# File 'lib/chef-config/config.rb', line 891

def self.set_defaults_for_nix
  # Those lists of regular expressions define what chef considers a
  # valid user and group name
  #
  # user/group cannot start with '-', '+' or '~'
  # user/group cannot contain ':', ',' or non-space-whitespace or null byte
  # everything else is allowed (UTF-8, spaces, etc) and we delegate to your O/S useradd program to barf or not
  # copies: http://anonscm.debian.org/viewvc/pkg-shadow/debian/trunk/debian/patches/506_relaxed_usernames?view=markup
  default :user_valid_regex, [ /^[^-+~:,\t\r\n\f\0]+[^:,\t\r\n\f\0]*$/ ]
  default :group_valid_regex, [ /^[^-+~:,\t\r\n\f\0]+[^:,\t\r\n\f\0]*$/ ]
end

.set_defaults_for_windows ⇒ Object 



880
881
882
883
884
885
886
887
888
889
 
# File 'lib/chef-config/config.rb', line 880

def self.set_defaults_for_windows
  # Those lists of regular expressions define what chef considers a
  # valid user and group name
  # From http://technet.microsoft.com/en-us/library/cc776019(WS.10).aspx
  principal_valid_regex_part = '[^"\/\\\\\[\]\:;|=,+*?<>]+'
  default :user_valid_regex, [ /^(#{principal_valid_regex_part}\\)?#{principal_valid_regex_part}$/ ]
  default :group_valid_regex, [ /^(#{principal_valid_regex_part}\\)?#{principal_valid_regex_part}$/ ]

  default :fatal_windows_admin_check, false
end

.set_extra_config_options(extra_parsed_options) ⇒ Object

We use :[]= assignment here to not bypass any coercions that happen via mixlib-config writes_value callbacks



154
155
156
157
158
 
# File 'lib/chef-config/config.rb', line 154

def self.set_extra_config_options(extra_parsed_options)
  extra_parsed_options.each do |key, value|
    self[key.to_sym] = value
  end
end

.target_mode? ⇒ Boolean

Returns:

  • (Boolean) 


500
501
502
 
# File 'lib/chef-config/config.rb', line 500

def self.target_mode?
  target_mode.enabled
end

.var_chef_dir(is_windows = ChefUtils.windows?) ⇒ Object

On *nix, /var/chef



84
85
86
87
 
# File 'lib/chef-config/config.rb', line 84

def self.var_chef_dir(is_windows = ChefUtils.windows?)
  path = is_windows ? c_chef_dir : PathHelper.join("/var", ChefConfig::Dist::DIR_SUFFIX)
  PathHelper.cleanpath(path)
end

.var_root_dir(is_windows = ChefUtils.windows?) ⇒ Object

On *nix, the root of /var/, used to test if we can create and write in /var/chef



90
91
92
93
 
# File 'lib/chef-config/config.rb', line 90

def self.var_root_dir(is_windows = ChefUtils.windows?)
  path = is_windows ? c_chef_dir : "/var"
  PathHelper.cleanpath(path)
end

.windows_home_path ⇒ Object 



917
918
919
920
 
# File 'lib/chef-config/config.rb', line 917

def self.windows_home_path
  ChefConfig.logger.deprecation("Chef::Config.windows_home_path is now deprecated.  Consider using Chef::Util::PathHelper.home instead.")
  PathHelper.home
end

.windows_installation_drive ⇒ String

the drive where Chef is installed on a windows host. This is determined either by the drive containing the current file or by the SYSTEMDRIVE ENV variable

Returns:

  • (String) —

    the drive letter



113
114
115
116
117
118
119
 
# File 'lib/chef-config/config.rb', line 113

def self.windows_installation_drive
  if ChefUtils.windows?
    drive = File.expand_path(__FILE__).split("/", 2)[0]
    drive = ENV["SYSTEMDRIVE"] if drive.to_s == ""
    drive
  end
end

Instance Method Details

#user ⇒ Object

Daemonization Settings ## What user should Chef run as?



376
 
# File 'lib/chef-config/config.rb', line 376

default :user, nil