Class: Chef::Knife::Ssh

Inherits:
Chef::Knife show all
Includes:
Mixin::ShellOut
Defined in:
lib/chef/knife/ssh.rb

Constant Summary

Constants included from Mixin::ShellOut

Mixin::ShellOut::DEPRECATED_OPTIONS

Instance Attribute Summary collapse

Attributes inherited from Chef::Knife

#name_args, #ui

Instance Method Summary collapse

Methods included from Mixin::ShellOut

#run_command_compatible_options, #shell_out, #shell_out!

Methods inherited from Chef::Knife

#api_key, #apply_computed_config, category, common_name, #config_file_settings, #configure_chef, #create_object, #delete_object, deps, #format_rest_error, guess_category, #highlight_config_error, #humanize_exception, #humanize_http_exception, inherited, #initialize, list_commands, load_commands, load_deps, #locate_config_file, #merge_configs, msg, #noauth_rest, #parse_options, #read_config_file, reset_subcommands!, #rest, run, #run_with_pretty_exceptions, #server_url, #show_usage, snake_case_name, subcommand_category, subcommand_class_from, subcommand_loader, subcommands, subcommands_by_category, ui, unnamed?, use_separate_defaults?, #username

Methods included from Mixin::ConvertToClassName

#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename

Methods included from Mixin::PathSanity

#enforce_path_sanity

Constructor Details

This class inherits a constructor from Chef::Knife

Instance Attribute Details

#password=(value) ⇒ Object (writeonly)

Sets the attribute password

Parameters:

  • value —

    the value to set the attribute password to.



37
38
39
 
# File 'lib/chef/knife/ssh.rb', line 37

def password=(value)
  @password = value
end

Instance Method Details

#configure_attribute ⇒ Object 



372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/chef/knife/ssh.rb', line 372

def configure_attribute
  # Setting 'knife[:ssh_attribute] = "foo"' in knife.rb => Chef::Config[:knife][:ssh_attribute] == 'foo'
  # Running 'knife ssh -a foo' => both Chef::Config[:knife][:ssh_attribute] && config[:attribute] == foo
  # Thus we can differentiate between a config file value and a command line override at this point by checking config[:attribute]
  # We can tell here if fqdn was passed from the command line, rather than being the default, by checking config[:attribute]
  # However, after here, we cannot tell these things, so we must preserve config[:attribute]
  config[:override_attribute] = config[:attribute] || Chef::Config[:knife][:ssh_attribute] 
  config[:attribute] = (Chef::Config[:knife][:ssh_attribute] ||
                        config[:attribute] ||
                        "fqdn").strip
end

#configure_gateway ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/chef/knife/ssh.rb', line 117

def configure_gateway
  config[:ssh_gateway] ||= Chef::Config[:knife][:ssh_gateway]
  if config[:ssh_gateway]
    gw_host, gw_user = config[:ssh_gateway].split('@').reverse
    gw_host, gw_port = gw_host.split(':')
    gw_opts = gw_port ? { :port => gw_port } : {}

    session.via(gw_host, gw_user || config[:ssh_user], gw_opts)
  end
rescue Net::SSH::AuthenticationFailed
  user = gw_user || config[:ssh_user]
  prompt = "Enter the password for #{user}@#{gw_host}: "
  gw_opts.merge!(:password => prompt_for_password(prompt))
  session.via(gw_host, user, gw_opts)
end

#configure_identity_file ⇒ Object 



413
414
415
416
 
# File 'lib/chef/knife/ssh.rb', line 413

def configure_identity_file
  config[:identity_file] = get_stripped_unfrozen_value(config[:identity_file] ||
                       Chef::Config[:knife][:ssh_identity_file])
end

#configure_session ⇒ Object 



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
 
# File 'lib/chef/knife/ssh.rb', line 133

def configure_session
  list = case config[:manual]
         when true
           @name_args[0].split(" ")
         when false
           r = Array.new
           q = Chef::Search::Query.new
           @action_nodes = q.search(:node, @name_args[0])[0]
           @action_nodes.each do |item|
             # we should skip the loop to next iteration if the item returned by the search is nil
             next if item.nil? 
             # if a command line attribute was not passed, and we have a cloud public_hostname, use that.
             # see #configure_attribute for the source of config[:attribute] and config[:override_attribute]
             if !config[:override_attribute] && item[:cloud] and item[:cloud][:public_hostname]
               i = item[:cloud][:public_hostname]
             elsif config[:override_attribute]
               i = extract_nested_value(item, config[:override_attribute])
             else
               i = extract_nested_value(item, config[:attribute])
             end
             # next if we couldn't find the specified attribute in the returned node object
             next if i.nil?
             r.push(i)
           end
           r
         end
  if list.length == 0
    if @action_nodes.length == 0
      ui.fatal("No nodes returned from search!")
    else
      ui.fatal("#{@action_nodes.length} #{@action_nodes.length > 1 ? "nodes":"node"} found, " +
               "but does not have the required attribute to establish the connection. " +
               "Try setting another attribute to open the connection using --attribute.")
    end
    exit 10
  end
  session_from_list(list)
end

#configure_user ⇒ Object 



408
409
410
411
 
# File 'lib/chef/knife/ssh.rb', line 408

def configure_user
  config[:ssh_user] = get_stripped_unfrozen_value(config[:ssh_user] ||
                       Chef::Config[:knife][:ssh_user])
end

#cssh ⇒ Object

Raises:



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/chef/knife/ssh.rb', line 384

def cssh
  cssh_cmd = nil
  %w[csshX cssh].each do |cmd|
    begin
      # Unix and Mac only
      cssh_cmd = shell_out!("which #{cmd}").stdout.strip
      break
    rescue Mixlib::ShellOut::ShellCommandFailed
    end
  end
  raise Chef::Exceptions::Exec, "no command found for cssh" unless cssh_cmd

  session.servers_for.each do |server|
    cssh_cmd << " #{server.user ? "#{server.user}@#{server.host}" : server.host}"
  end
  Chef::Log.debug("starting cssh session with command: #{cssh_cmd}")
  exec(cssh_cmd)
end

#extract_nested_value(data_structure, path_spec) ⇒ Object 



418
419
420
 
# File 'lib/chef/knife/ssh.rb', line 418

def extract_nested_value(data_structure, path_spec)
  ui.presenter.extract_nested_value(data_structure, path_spec)
end

#fixup_sudo(command) ⇒ Object 



201
202
203
 
# File 'lib/chef/knife/ssh.rb', line 201

def fixup_sudo(command)
  command.sub(/^sudo/, 'sudo -p \'knife sudo password: \'')
end

#get_password ⇒ Object 



239
240
241
 
# File 'lib/chef/knife/ssh.rb', line 239

def get_password
  @password ||= prompt_for_password
end

#get_stripped_unfrozen_value(value) ⇒ Object 



403
404
405
406
 
# File 'lib/chef/knife/ssh.rb', line 403

def get_stripped_unfrozen_value(value)
  return nil if value.nil?
  value.strip
end

#interactive ⇒ Object 



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/chef/knife/ssh.rb', line 272

def interactive
  puts "Connected to #{ui.list(session.servers_for.collect { |s| ui.color(s.host, :cyan) }, :inline, " and ")}"
  puts
  puts "To run a command on a list of servers, do:"
  puts "  on SERVER1 SERVER2 SERVER3; COMMAND"
  puts "  Example: on latte foamy; echo foobar"
  puts
  puts "To exit interactive mode, use 'quit!'"
  puts
  while 1
    command = read_line
    case command
    when 'quit!'
      puts 'Bye!'
      break
    when /^on (.+?); (.+)$/
      raw_list = $1.split(" ")
      server_list = Array.new
      session.servers.each do |session_server|
        server_list << session_server if raw_list.include?(session_server.host)
      end
      command = $2
      ssh_command(command, session.on(*server_list))
    else
      ssh_command(command)
    end
  end
end

#macterm ⇒ Object 



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/chef/knife/ssh.rb', line 348

def macterm
  begin
    require 'appscript'
  rescue LoadError
    STDERR.puts "you need the rb-appscript gem to use knife ssh macterm. `(sudo) gem install rb-appscript` to install"
    raise
  end

  Appscript.app("/Applications/Utilities/Terminal.app").windows.first.activate
  Appscript.app("System Events").application_processes["Terminal.app"].keystroke("n", :using=>:command_down)
  term = Appscript.app('Terminal')
  window = term.windows.first.get

  (session.servers_for.size - 1).times do |i|
    window.activate
    Appscript.app("System Events").application_processes["Terminal.app"].keystroke("t", :using=>:command_down)
  end

  session.servers_for.each_with_index do |server, tab_number|
    cmd = "unset PROMPT_COMMAND; echo -e \"\\033]0;#{server.host}\\007\"; ssh #{server.user ? "#{server.user}@#{server.host}" : server.host}"
    Appscript.app('Terminal').do_script(cmd, :in => window.tabs[tab_number + 1].get)
  end
end

#print_data(host, data) ⇒ Object 



205
206
207
208
209
210
211
212
213
 
# File 'lib/chef/knife/ssh.rb', line 205

def print_data(host, data)
  if data =~ /\n/
    data.split(/\n/).each { |d| print_data(host, d) }
  else
    padding = @longest - host.length
    str = ui.color(host, :cyan) + (" " * (padding + 1)) + data
    ui.msg(str)
  end
end

#prompt_for_password(prompt = "Enter your password: ") ⇒ Object 



243
244
245
 
# File 'lib/chef/knife/ssh.rb', line 243

def prompt_for_password(prompt = "Enter your password: ")
  ui.ask(prompt) { |q| q.echo = false }
end

#read_line ⇒ Object

Present the prompt and read a single line from the console. It also detects ^D and returns “exit” in that case. Adds the input to the history, unless the input is empty. Loops repeatedly until a non-empty line is input.



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/chef/knife/ssh.rb', line 251

def read_line
  loop do
    command = reader.readline("#{ui.color('knife-ssh>', :bold)} ", true)

    if command.nil?
      command = "exit"
      puts(command)
    else
      command.strip!
    end

    unless command.empty?
      return command
    end
  end
end

#reader ⇒ Object 



268
269
270
 
# File 'lib/chef/knife/ssh.rb', line 268

def reader
  Readline
end

#run ⇒ Object 



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/chef/knife/ssh.rb', line 422

def run
  extend Chef::Mixin::Command

  @longest = 0

  configure_attribute
  configure_user
  configure_identity_file
  configure_gateway
  configure_session

  exit_status =
  case @name_args[1]
  when "interactive"
    interactive
  when "screen"
    screen
  when "tmux"
    tmux
  when "macterm"
    macterm
  when "cssh"
    cssh
  when "csshx"
    Chef::Log.warn("knife ssh csshx will be deprecated in a future release")
    Chef::Log.warn("please use knife ssh cssh instead")
    cssh
  else
    ssh_command(@name_args[1..-1].join(" "))
  end

  session.close
  if exit_status != 0
    exit exit_status
  else
    exit_status
  end
end

#screen ⇒ Object 



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

def screen
  tf = Tempfile.new("knife-ssh-screen")
  if File.exist? "#{ENV["HOME"]}/.screenrc"
    tf.puts("source #{ENV["HOME"]}/.screenrc")
  end
  tf.puts("caption always '%-Lw%{= BW}%50>%n%f* %t%{-}%+Lw%<'")
  tf.puts("hardstatus alwayslastline 'knife ssh #{@name_args[0]}'")
  window = 0
  session.servers_for.each do |server|
    tf.print("screen -t \"#{server.host}\" #{window} ssh ")
    tf.print("-i #{config[:identity_file]} ") if config[:identity_file]
    server.user ? tf.puts("#{server.user}@#{server.host}") : tf.puts(server.host)
    window += 1
  end
  tf.close
  exec("screen -c #{tf.path}")
end

#session ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/chef/knife/ssh.rb', line 94

def session
  config[:on_error] ||= :skip
  ssh_error_handler = Proc.new do |server|
    if config[:manual]
      node_name = server.host
    else
      @action_nodes.each do |n|
        node_name = n if format_for_display(n)[config[:attribute]] == server.host
      end
    end
    case config[:on_error]
    when :skip
      ui.warn "Failed to connect to #{node_name} -- #{$!.class.name}: #{$!.message}"
      $!.backtrace.each { |l| Chef::Log.debug(l) }
    when :raise
      #Net::SSH::Multi magic to force exception to be re-raised.
      throw :go, :raise
    end
  end

  @session ||= Net::SSH::Multi.start(:concurrent_connections => config[:concurrency], :on_error => ssh_error_handler)
end

#session_from_list(list) ⇒ Object 



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/chef/knife/ssh.rb', line 172

def session_from_list(list)
  list.each do |item|
    Chef::Log.debug("Adding #{item}")
    session_opts = {}

    ssh_config = Net::SSH.configuration_for(item)

    # Chef::Config[:knife][:ssh_user] is parsed in #configure_user and written to config[:ssh_user]
    user = config[:ssh_user] || ssh_config[:user]
    hostspec = user ? "#{user}@#{item}" : item
    session_opts[:keys] = File.expand_path(config[:identity_file]) if config[:identity_file]
    session_opts[:keys_only] = true if config[:identity_file]
    session_opts[:password] = config[:ssh_password] if config[:ssh_password]
    session_opts[:port] = config[:ssh_port] || Chef::Config[:knife][:ssh_port] || ssh_config[:port]
    session_opts[:logger] = Chef::Log.logger if Chef::Log.level == :debug

    if !config[:host_key_verify]
      session_opts[:paranoid] = false
      session_opts[:user_known_hosts_file] = "/dev/null"
    end

    session.use(hostspec, session_opts)

    @longest = item.length if item.length > @longest
  end

  session
end

#ssh_command(command, subsession = nil) ⇒ Object 



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/chef/knife/ssh.rb', line 215

def ssh_command(command, subsession=nil)
  exit_status = 0
  subsession ||= session
  command = fixup_sudo(command)
  command.force_encoding('binary') if command.respond_to?(:force_encoding)
  subsession.open_channel do |ch|
    ch.request_pty
    ch.exec command do |ch, success|
      raise ArgumentError, "Cannot execute #{command}" unless success
      ch.on_data do |ichannel, data|
        print_data(ichannel[:host], data)
        if data =~ /^knife sudo password: /
          ichannel.send_data("#{get_password}\n")
        end
      end
      ch.on_request "exit-status" do |ichannel, data|
        exit_status = [exit_status, data.read_long].max
      end
    end
  end
  session.loop
  exit_status
end

#tmux ⇒ Object 



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/chef/knife/ssh.rb', line 319

def tmux
  ssh_dest = lambda do |server|
    identity = "-i #{config[:identity_file]} " if config[:identity_file]
    prefix = server.user ? "#{server.user}@" : ""
    "'ssh #{identity}#{prefix}#{server.host}'"
  end

  new_window_cmds = lambda do
    if session.servers_for.size > 1
      [""] + session.servers_for[1..-1].map do |server|
        "new-window -a -n '#{server.host}' #{ssh_dest.call(server)}"
      end
    else
      []
    end.join(" \\; ")
  end

  tmux_name = "'knife ssh #{@name_args[0].gsub(/:/,'=')}'"
  begin
    server = session.servers_for.first
    cmd = ["tmux new-session -d -s #{tmux_name}",
           "-n '#{server.host}'", ssh_dest.call(server),
           new_window_cmds.call].join(" ")
    shell_out!(cmd)
    exec("tmux attach-session -t #{tmux_name}")
  rescue Chef::Exceptions::Exec
  end
end