Class: Chef::Knife::Core::WindowsBootstrapContext

Inherits:
BootstrapContext
  • Object
show all
Defined in:
lib/chef/knife/core/windows_bootstrap_context.rb

Overview

Instances of BootstrapContext are the context objects (i.e., self) for bootstrap templates. For backwards compatability, they must set the following instance variables:

  • @config - a hash of knife’s config values

  • @run_list - the run list for the node to boostrap

Constant Summary collapse

PathHelper = 
::Knife::Windows::PathHelper

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config, run_list, chef_config, secret = nil) ⇒ WindowsBootstrapContext

Returns a new instance of WindowsBootstrapContext.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/chef/knife/core/windows_bootstrap_context.rb', line 38

def initialize(config, run_list, chef_config, secret=nil)
  @config       = config
  @run_list     = run_list
  @chef_config  = chef_config
  @secret       = secret
  # Compatibility with Chef 12 and Chef 11 versions
  begin
    # Pass along the secret parameter for Chef 12
    super(config, run_list, chef_config, secret)
  rescue ArgumentError
    # The Chef 11 base class only has parameters for initialize
    super(config, run_list, chef_config)
  end
end

Instance Attribute Details

#client_pem ⇒ Object

Returns the value of attribute client_pem.



36
37
38
 
# File 'lib/chef/knife/core/windows_bootstrap_context.rb', line 36

def client_pem
  @client_pem
end

Instance Method Details

#bootstrap_directory ⇒ Object 



296
297
298
 
# File 'lib/chef/knife/core/windows_bootstrap_context.rb', line 296

def bootstrap_directory
  bootstrap_directory = "C:\\chef"
end

#config_content ⇒ Object 



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
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
 
# File 'lib/chef/knife/core/windows_bootstrap_context.rb', line 69

def config_content
  client_rb = <<-CONFIG
chef_server_url  "#{@chef_config[:chef_server_url]}"
validation_client_name "#{@chef_config[:validation_client_name]}"
file_cache_path   "c:/chef/cache"
file_backup_path  "c:/chef/backup"
cache_options     ({:path => "c:/chef/cache/checksums", :skip_expires => true})
  CONFIG
  if @config[:chef_node_name]
    client_rb << %Q{node_name "#{@config[:chef_node_name]}"\n}
  else
    client_rb << "# Using default node name (fqdn)\n"
  end

  if @chef_config[:config_log_level]
    client_rb << %Q{log_level :#{@chef_config[:config_log_level]}\n}
  else
    client_rb << "log_level        :info\n"
  end

  client_rb << "log_location       #{get_log_location}"

  # We configure :verify_api_cert only when it's overridden on the CLI
  # or when specified in the knife config.
  if !@config[:node_verify_api_cert].nil? || knife_config.has_key?(:verify_api_cert)
    value = @config[:node_verify_api_cert].nil? ? knife_config[:verify_api_cert] : @config[:node_verify_api_cert]
    client_rb << %Q{verify_api_cert #{value}\n}
  end

  # We configure :ssl_verify_mode only when it's overridden on the CLI
  # or when specified in the knife config.
  if @config[:node_ssl_verify_mode] || knife_config.has_key?(:ssl_verify_mode)
    value = case @config[:node_ssl_verify_mode]
    when "peer"
      :verify_peer
    when "none"
      :verify_none
    when nil
      knife_config[:ssl_verify_mode]
    else
      nil
    end

    if value
      client_rb << %Q{ssl_verify_mode :#{value}\n}
    end
  end

  if @config[:ssl_verify_mode]
    client_rb << %Q{ssl_verify_mode :#{knife_config[:ssl_verify_mode]}\n}
  end

  if knife_config[:bootstrap_proxy]
    client_rb << "\n"
    client_rb << %Q{http_proxy        "#{knife_config[:bootstrap_proxy]}"\n}
    client_rb << %Q{https_proxy       "#{knife_config[:bootstrap_proxy]}"\n}
    client_rb << %Q{no_proxy          "#{knife_config[:bootstrap_no_proxy]}"\n} if knife_config[:bootstrap_no_proxy]
  end

  if knife_config[:bootstrap_no_proxy]
    client_rb << %Q{no_proxy       "#{knife_config[:bootstrap_no_proxy]}"\n}
  end

  if @config[:secret]
    client_rb << %Q{encrypted_data_bag_secret "c:/chef/encrypted_data_bag_secret"\n}
  end

  unless trusted_certs_script.empty?
    client_rb << %Q{trusted_certs_dir "c:/chef/trusted_certs"\n}
  end

  if Chef::Config[:fips]
    client_rb << <<-CONFIG
fips true
chef_version = ::Chef::VERSION.split(".")
unless chef_version[0].to_i > 12 || (chef_version[0].to_i == 12 && chef_version[1].to_i >= 8)
  raise "FIPS Mode requested but not supported by this client"
end
CONFIG
  end

  escape_and_echo(client_rb)
end

#escape_and_echo(file_contents) ⇒ Object

escape WIN BATCH special chars and prefixes each line with an echo



326
327
328
 
# File 'lib/chef/knife/core/windows_bootstrap_context.rb', line 326

def escape_and_echo(file_contents)
  file_contents.gsub(/^(.*)$/, 'echo.\1').gsub(/([(<|>)^])/, '^\1')
end

#first_boot ⇒ Object 



319
320
321
 
# File 'lib/chef/knife/core/windows_bootstrap_context.rb', line 319

def first_boot
  escape_and_echo(super.to_json)
end

#get_log_location ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/chef/knife/core/windows_bootstrap_context.rb', line 153

def get_log_location
  if @chef_config[:config_log_location].equal?(:win_evt)
    %Q{:#{@chef_config[:config_log_location]}\n}
  elsif @chef_config[:config_log_location].equal?(:syslog)
    raise "syslog is not supported for log_location on Windows OS\n"
  elsif (@chef_config[:config_log_location].equal?(STDOUT))
    "STDOUT\n"
  elsif (@chef_config[:config_log_location].equal?(STDERR))
    "STDERR\n"
  elsif @chef_config[:config_log_location].nil? || @chef_config[:config_log_location].empty?
    "STDOUT\n"
  elsif @chef_config[:config_log_location]
    %Q{"#{@chef_config[:config_log_location]}"\n}
  else
    "STDOUT\n"
  end
end

#install_chef ⇒ Object 



290
291
292
293
294
 
# File 'lib/chef/knife/core/windows_bootstrap_context.rb', line 290

def install_chef
  # The normal install command uses regular double quotes in
  # the install command, so request such a string from install_command
  install_chef = install_command('"') + "\n" + fallback_install_task_command
end

#latest_current_windows_chef_version_query ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/chef/knife/core/windows_bootstrap_context.rb', line 177

def latest_current_windows_chef_version_query
  installer_version_string = nil
  if @config[:prerelease]
    installer_version_string = "&prerelease=true"
  else
    chef_version_string = if knife_config[:bootstrap_version]
      knife_config[:bootstrap_version]
    else
      Chef::VERSION.split(".").first
    end

    installer_version_string = "&v=#{chef_version_string}"

    # If bootstrapping a pre-release version add the prerelease query string
    if chef_version_string.split(".").length > 3
      installer_version_string << "&prerelease=true"
    end
  end

  installer_version_string
end

#local_download_path ⇒ Object 



300
301
302
 
# File 'lib/chef/knife/core/windows_bootstrap_context.rb', line 300

def local_download_path
  local_download_path = "%TEMP%\\chef-client-latest.msi"
end

#msi_url(machine_os = nil, machine_arch = nil, download_context = nil) ⇒ Object 



304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/chef/knife/core/windows_bootstrap_context.rb', line 304

def msi_url(machine_os=nil, machine_arch=nil, download_context=nil)
  # The default msi path has a number of url query parameters - we attempt to substitute
  # such parameters in as long as they are provided by the template.

  if @config[:msi_url].nil? || @config[:msi_url].empty?
    url = "https://www.chef.io/chef/download?p=windows"
    url += "&pv=#{machine_os}" unless machine_os.nil?
    url += "&m=#{machine_arch}" unless machine_arch.nil?
    url += "&DownloadContext=#{download_context}" unless download_context.nil?
    url += latest_current_windows_chef_version_query
  else
    @config[:msi_url]
  end
end

#secret ⇒ Object 



61
62
63
 
# File 'lib/chef/knife/core/windows_bootstrap_context.rb', line 61

def secret
  escape_and_echo(@config[:secret])
end

#start_chef ⇒ Object 



171
172
173
174
175
 
# File 'lib/chef/knife/core/windows_bootstrap_context.rb', line 171

def start_chef
  bootstrap_environment_option = bootstrap_environment.nil? ? '' : " -E #{bootstrap_environment}"
  start_chef = "SET \"PATH=%SystemRoot%\\system32;%SystemRoot%;%SystemRoot%\\System32\\Wbem;%SYSTEMROOT%\\System32\\WindowsPowerShell\\v1.0\\;C:\\ruby\\bin;C:\\opscode\\chef\\bin;C:\\opscode\\chef\\embedded\\bin\"\n"
  start_chef << "chef-client -c c:/chef/client.rb -j c:/chef/first-boot.json#{bootstrap_environment_option}\n"
end

#trusted_certs_script ⇒ Object 



65
66
67
 
# File 'lib/chef/knife/core/windows_bootstrap_context.rb', line 65

def trusted_certs_script
  @trusted_certs_script ||= trusted_certs_content
end

#validation_key ⇒ Object 



53
54
55
56
57
58
59
 
# File 'lib/chef/knife/core/windows_bootstrap_context.rb', line 53

def validation_key
  if File.exist?(File.expand_path(@chef_config[:validation_key]))
    IO.read(File.expand_path(@chef_config[:validation_key]))
  else
    false
  end
end

#win_wget ⇒ Object 



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/chef/knife/core/windows_bootstrap_context.rb', line 199

def win_wget
  # I tried my best to figure out how to properly url decode and switch / to \
  # but this is VBScript - so I don't really care that badly.
  win_wget = <<-WGET
url = WScript.Arguments.Named("url")
path = WScript.Arguments.Named("path")
proxy = null
'* Vaguely attempt to handle file:// scheme urls by url unescaping and switching all
'* / into \.  Also assume that file:/// is a local absolute path and that file://<foo>
'* is possibly a network file path.
If InStr(url, "file://") = 1 Then
url = Unescape(url)
If InStr(url, "file:///") = 1 Then
sourcePath = Mid(url, Len("file:///") + 1)
Else
sourcePath = Mid(url, Len("file:") + 1)
End If
sourcePath = Replace(sourcePath, "/", "\\")

Set objFSO = CreateObject("Scripting.FileSystemObject")
If objFSO.Fileexists(path) Then objFSO.DeleteFile path
objFSO.CopyFile sourcePath, path, true
Set objFSO = Nothing

Else
Set objXMLHTTP = CreateObject("MSXML2.ServerXMLHTTP")
Set wshShell = CreateObject( "WScript.Shell" )
Set objUserVariables = wshShell.Environment("USER")

rem http proxy is optional
rem attempt to read from HTTP_PROXY env var first
On Error Resume Next

If NOT (objUserVariables("HTTP_PROXY") = "") Then
proxy = objUserVariables("HTTP_PROXY")

rem fall back to named arg
ElseIf NOT (WScript.Arguments.Named("proxy") = "") Then
proxy = WScript.Arguments.Named("proxy")
End If

If NOT isNull(proxy) Then
rem setProxy method is only available on ServerXMLHTTP 6.0+
Set objXMLHTTP = CreateObject("MSXML2.ServerXMLHTTP.6.0")
objXMLHTTP.setProxy 2, proxy
End If

On Error Goto 0

objXMLHTTP.open "GET", url, false
objXMLHTTP.send()
If objXMLHTTP.Status = 200 Then
Set objADOStream = CreateObject("ADODB.Stream")
objADOStream.Open
objADOStream.Type = 1
objADOStream.Write objXMLHTTP.ResponseBody
objADOStream.Position = 0
Set objFSO = Createobject("Scripting.FileSystemObject")
If objFSO.Fileexists(path) Then objFSO.DeleteFile path
Set objFSO = Nothing
objADOStream.SaveToFile path
objADOStream.Close
Set objADOStream = Nothing
End If
Set objXMLHTTP = Nothing
End If
WGET
  escape_and_echo(win_wget)
end

#win_wget_ps ⇒ Object 



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/chef/knife/core/windows_bootstrap_context.rb', line 269

def win_wget_ps
  win_wget_ps = <<-WGET_PS
param(
   [String] $remoteUrl,
   [String] $localPath
)

$ProxyUrl = $env:http_proxy;
$webClient = new-object System.Net.WebClient;

if ($ProxyUrl -ne '') {
  $WebProxy = New-Object System.Net.WebProxy($ProxyUrl,$true)
  $WebClient.Proxy = $WebProxy
}

$webClient.DownloadFile($remoteUrl, $localPath);
WGET_PS

  escape_and_echo(win_wget_ps)
end