autoload :IPAddr, 'ipaddr' module LeapCli; module Commands ## ## COMMANDS ## desc 'Node management' command :node do |node| node.desc 'Create a new configuration file for a node named NAME.' node.long_desc ["If specified, the optional argument SEED can be used to seed values in the node configuration file.", "The format is property_name:value.", "For example: `leap node add web1 ip_address:1.2.3.4 services:webapp`.", "To set nested properties, property name can contain '.', like so: `leap node add web1 ssh.port:44`", "Separeate multiple values for a single property with a comma, like so: `leap node add mynode services:webapp,dns`"].join("\n\n") node.arg_name 'NAME [SEED]' # , :optional => false, :multiple => false node.command :add do |add| add.switch :local, :desc => 'Make a local testing node (by automatically assigning the next available local IP address). Local nodes are run as virtual machines on your computer.', :negatable => false add.action do |global_options,options,args| # argument sanity checks name = args.first assert_valid_node_name!(name, options[:local]) assert_files_missing! [:node_config, name] # create and seed new node node = Config::Node.new(manager) if options[:local] node['ip_address'] = pick_next_vagrant_ip_address end seed_node_data(node, args[1..-1]) validate_ip_address(node) begin write_file! [:node_config, name], node.dump_json + "\n" node['name'] = name if file_exists? :ca_cert, :ca_key generate_cert_for_node(manager.reload_node!(node)) end rescue LeapCli::ConfigError => exc remove_node_files(name) end end end node.desc 'Bootstraps a node or nodes, setting up SSH keys and installing prerequisite packages' node.long_desc "This command prepares a server to be used with the LEAP Platform by saving the server's SSH host key, " + "copying the authorized_keys file, installing packages that are required for deploying, and registering important facts. " + "Node init must be run before deploying to a server, and the server must be running and available via the network. " + "This command only needs to be run once, but there is no harm in running it multiple times." node.arg_name 'FILTER' #, :optional => false, :multiple => false node.command :init do |init| init.switch 'echo', :desc => 'If set, passwords are visible as you type them (default is hidden)', :negatable => false init.flag :port, :desc => 'Override the default SSH port.', :arg_name => 'PORT' init.flag :ip, :desc => 'Override the default SSH IP address.', :arg_name => 'IPADDRESS' init.action do |global,options,args| assert! args.any?, 'You must specify a FILTER' finished = [] manager.filter!(args).each_node do |node| is_node_alive(node, options) save_public_host_key(node, global, options) unless node.vagrant? update_compiled_ssh_configs ssh_connect_options = connect_options(options).merge({:bootstrap => true, :echo => options[:echo]}) ssh_connect(node, ssh_connect_options) do |ssh| if node.vagrant? ssh.install_insecure_vagrant_key end ssh.install_authorized_keys ssh.install_prerequisites ssh.leap.capture(facter_cmd) do |response| if response[:exitcode] == 0 update_node_facts(node.name, response[:data]) else log :failed, "to run facter on #{node.name}" end end end finished << node.name end log :completed, "initialization of nodes #{finished.join(', ')}" end end node.desc 'Renames a node file, and all its related files.' node.arg_name 'OLD_NAME NEW_NAME' node.command :mv do |mv| mv.action do |global_options,options,args| node = get_node_from_args(args) new_name = args.last assert_valid_node_name!(new_name, node.vagrant?) ensure_dir [:node_files_dir, new_name] Leap::Platform.node_files.each do |path| rename_file! [path, node.name], [path, new_name] end remove_directory! [:node_files_dir, node.name] rename_node_facts(node.name, new_name) end end node.desc 'Removes all the files related to the node named NAME.' node.arg_name 'NAME' #:optional => false #, :multiple => false node.command :rm do |rm| rm.action do |global_options,options,args| node = get_node_from_args(args) remove_node_files(node.name) if node.vagrant? vagrant_command("destroy --force", [node.name]) end remove_node_facts(node.name) end end end ## ## PUBLIC HELPERS ## # # generates the known_hosts file. # # we do a 'late' binding on the hostnames and ip part of the ssh pub key record in order to allow # for the possibility that the hostnames or ip has changed in the node configuration. # def update_known_hosts buffer = StringIO.new buffer << "#\n" buffer << "# This file is automatically generated by the command `leap`. You should NOT modify this file.\n" buffer << "# Instead, rerun `leap node init` on whatever node is causing SSH problems.\n" buffer << "#\n" manager.nodes.keys.sort.each do |node_name| node = manager.nodes[node_name] hostnames = [node.name, node.domain.internal, node.domain.full, node.ip_address].join(',') pub_key = read_file([:node_ssh_pub_key,node.name]) if pub_key buffer << [hostnames, pub_key].join(' ') buffer << "\n" end end write_file!(:known_hosts, buffer.string) end def get_node_from_args(args, options={}) node_name = args.first node = manager.node(node_name) if node.nil? && options[:include_disabled] node = manager.disabled_node(node_name) end assert!(node, "Node '#{node_name}' not found.") node end private ## ## PRIVATE HELPERS ## # # saves the public ssh host key for node into the provider directory. # # see `man sshd` for the format of known_hosts # def save_public_host_key(node, global, options) log :fetching, "public SSH host key for #{node.name}" address = options[:ip] || node.ip_address port = options[:port] || node.ssh.port public_key = get_public_key_for_ip(address, port) pub_key_path = Path.named_path([:node_ssh_pub_key, node.name]) if Path.exists?(pub_key_path) if public_key == SshKey.load(pub_key_path) log :trusted, "- Public SSH host key for #{node.name} matches previously saved key", :indent => 1 else bail! do log :error, "The public SSH host key we just fetched for #{node.name} doesn't match what we have saved previously.", :indent => 1 log "Remove the file #{pub_key_path} if you really want to change it.", :indent => 2 end end elsif public_key.in_known_hosts?(node.name, node.ip_address, node.domain.name) log :trusted, "- Public SSH host key for #{node.name} is trusted (key found in your ~/.ssh/known_hosts)" else puts say("This is the SSH host key you got back from node \"#{node.name}\"") say("Type -- #{public_key.bits} bit #{public_key.type.upcase}") say("Fingerprint -- " + public_key.fingerprint) say("Public Key -- " + public_key.key) if !global[:yes] && !agree("Is this correct? ") bail! else puts write_file! [:node_ssh_pub_key, node.name], public_key.to_s end end end # # get the public host key for a host. # return SshKey object representation of the key. # # Only supports ecdsa or rsa host keys. rsa is preferred if both are available. # def get_public_key_for_ip(address, port=22) assert_bin!('ssh-keyscan') output = assert_run! "ssh-keyscan -p #{port} #{address}", "Could not get the public host key from #{address}:#{port}. Maybe sshd is not running?" if output.empty? bail! :failed, "ssh-keyscan returned empty output." end # key arrays [ip, key_type, public_key] rsa_key = nil ecdsa_key = nil lines = output.split("\n").grep(/^[^#]/) lines.each do |line| if line =~ /No route to host/ bail! :failed, 'ssh-keyscan: no route to %s' % address elsif line =~ / ssh-rsa / rsa_key = line.split(' ') elsif line =~ / ecdsa-sha2-nistp256 / ecdsa_key = line.split(' ') end end if rsa_key.nil? && ecdsa_key.nil? bail! "ssh-keyscan got zero host keys back! Output was: #{output}" else key = rsa_key || ecdsa_key return SshKey.load(key[2], key[1]) end end def is_node_alive(node, options) address = options[:ip] || node.ip_address port = options[:port] || node.ssh.port log :connecting, "to node #{node.name}" assert_run! "nc -zw3 #{address} #{port}", "Failed to reach #{node.name} (address #{address}, port #{port}). You can override the configured IP address and port with --ip or --port." end def seed_node_data(node, args) args.each do |seed| key, value = seed.split(':') value = format_seed_value(value) assert! key =~ /^[0-9a-z\._]+$/, "illegal characters used in property '#{key}'" if key =~ /\./ key_parts = key.split('.') final_key = key_parts.pop current_object = node key_parts.each do |key_part| current_object[key_part] ||= Config::Object.new current_object = current_object[key_part] end current_object[final_key] = value else node[key] = value end end end def remove_node_files(node_name) (Leap::Platform.node_files + [:node_files_dir]).each do |path| remove_file! [path, node_name] end end # # conversions: # # "x,y,z" => ["x","y","z"] # # "22" => 22 # # "5.1" => 5.1 # def format_seed_value(v) if v =~ /,/ v = v.split(',') v.map! do |i| i = i.to_i if i.to_i.to_s == i i = i.to_f if i.to_f.to_s == i i end else v = v.to_i if v.to_i.to_s == v v = v.to_f if v.to_f.to_s == v end return v end def validate_ip_address(node) IPAddr.new(node['ip_address']) rescue ArgumentError bail! do if node['ip_address'] log :invalid, "ip_address #{node['ip_address'].inspect}" else log :missing, "ip_address" end end end def assert_valid_node_name!(name, local=false) assert! name, 'No specified.' if local assert! name =~ /^[0-9a-z]+$/, "illegal characters used in node name '#{name}' (note: Vagrant does not allow hyphens or underscores)" else assert! name =~ /^[0-9a-z-]+$/, "illegal characters used in node name '#{name}' (note: Linux does not allow underscores)" end end end; end