ssh-config 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2008-2009 David Brady github@shinybit.com
+ 
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,66 @@
+= ssh-config: A Tool for Managing ssh Config Files
+
+== Overview
+
+It's not THAT much trouble to update your .ssh/config file every time
+a host changes, but when it starts happening often enough, even that
+hassle starts to add up. This is a quick tool I wrote to help handle
+them.
+
+It takes great care to not trash your config file, so you can continue
+to edit your config files by hand before and after running the tool.
+
+ssh-config will make a backup of your ~/.ssh/config file as
+~/.ssh/config~.
+
+Probably the most useful command is "copy", which intelligently copies
+an existing host section.
+
+== Commands
+
+=== set <host> <key> <value>
+
+Adds or updates the value for a given host.
+
+=== unset <host> <key>
+
+Removes a key value for a given host. NOTE: If all values are removed
+from a section, the section is NOT removed; use rm <host> for that.
+
+=== rm <host>
+
+Removes an entire host section.
+
+=== copy <old_host> <new_host>
+
+Copies the entire section named <old_host> to a new section called
+<new_host>. If old_host has a Hostname section, ssh-config will try to
+update it to reflect the new_host name. For example, if you had a
+section like
+
+  Host rails01
+    Hostname rails01.example.com
+
+And you did ssh-config copy rails01 rails02, the new section would
+look like this:
+
+  Host rails02
+    Hostname rails02.example.com
+
+=== dump
+
+Dumps the entire file.
+
+=== show <host>
+
+Dumps one section. (Similar to ssh-what.)
+
+=== search <pattern>
+
+Shows all sections that have any line (key OR value) that matches
+pattern. (Similar to ssh-what.)
+
+=== list
+
+Lists all section names (just the Host line)
+

data/bin/ssh-config

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+require 'ftools'
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'ssh-config'))
+
+# ssh-config - Manipulate config values in the .ssh/config file.
+# 
+# ssh-config help
+# ssh-config dump
+# ssh-config list
+# ssh-config show <host-nickname>
+# ssh-config find <regex>
+# ssh-config set <host-nickname> <setting> <value> [<setting> <value> [...]]
+#     Note: "<setting> -" deletes a setting
+# ssh-config rm <host-nickname> # delete config settings for that host
+# ssh-config copy <host-nickname> <new-host-nickname> # copy settings from one to the other. 
+
+config = ConfigFile.new
+argv = ARGV
+command = argv.shift
+
+def usage
+  str =<<HELP
+ssh-config - Configure your .ssh/config file
+
+Usage:
+  ssh-config <command> <params>
+
+Commands:
+  help - show this message
+  dump - parse and dump the config file
+  list - list configured hosts
+  show <host> - display the settings for host
+  find <pattern> - find all hosts with any detail matching pattern
+  set <host> <setting> <value> [<setting> <value> [...]] - set a value
+    NOTE: If host does not exist, it will be created
+    NOTE: If value is -, setting will be deleted, e.g. set User -
+    NOTE: If all values are deleted, section will NOT be removed, use rm instead
+  unset <host> <setting> - Remove a setting from a host section
+  rm <host> - Remove configuration for a host
+  copy <host> <newhost> - Duplicate the settings for a host
+    NOTE: If Hostname contains Host, new host will be automagically updated
+HELP
+
+end
+
+case command
+when 'help'
+  puts usage
+when 'list'
+  puts config.list
+when 'show'
+  puts config.show(argv.shift)
+when 'search'
+  puts config.search(argv.shift)
+when 'cp', 'copy'
+  config.copy! argv.shift, argv.shift
+when 'unset'
+  config.unset!(argv.shift, *argv)
+when 'set'
+  config.set!(*argv)
+when 'rm', 'del', 'delete'
+  config.rm! argv.shift 
+when 'dump'
+  puts config.dump
+end
+

data/lib/config_file.rb

@@ -0,0 +1,126 @@
+class ConfigFile
+  def initialize
+    @make_backups = true
+    @header_lines = []
+    @sections = []
+    @sections_by_name = {}
+    read_config
+  end
+  
+  def add_section(name)
+    section = ConfigSection.new(name)
+    @sections << section
+    @sections_by_name[name] = section
+    section
+  end
+  
+  def read_config
+    current_section = nil
+    IO.readlines(File.expand_path("~/.ssh/config")).each_with_index do |line, i|
+      line.rstrip!
+      if line =~ /\bHost\s+(.+)/
+        current_section = add_section($1)
+      else
+        if current_section
+          current_section.lines << line
+        else
+          @header_lines << line
+        end        
+      end
+    end
+  end
+  
+  def show(host_nick)
+    @sections_by_name[host_nick]
+  end
+  
+  def list()
+    to_text(@sections_by_name.keys.sort.map {|name| "Host #{name}"})
+  end
+  
+  def search(text)
+    to_text(@sections.find_all {|section| section.matches?(text)}.sort_by {|section| section.name})
+  end
+
+  def set!(host_nick, *args)
+    backup if @make_backups
+    while args.length > 0
+      key, value = args.shift, args.shift
+      section = set(host_nick, key, value)
+    end
+    save
+    section
+  end
+  
+  def set(host_nick, key, value)
+    section = @sections_by_name[host_nick] || add_section(host_nick)
+    section[key] = value
+  end
+  
+  def unset!(host_nick, *keys)
+    backup if @make_backups
+    while keys.length > 0
+      section = unset(host_nick, keys.shift)
+    end
+    save
+    section
+  end
+  
+  def unset(host_nick, key)
+    if section = @sections_by_name[host_nick]
+      section.unset(key)
+    end
+  end
+  
+  def dump
+    to_text([@header_lines, @sections].flatten)
+  end
+
+  def rm!(host_nick)
+    backup if @make_backups
+    rm(host_nick)
+    save
+  end
+  
+  def rm(host_nick)
+    if @sections_by_name.key?(host_nick)
+      @sections_by_name.delete host_nick
+      @sections.delete_at(@sections.index{|s| s.name == host_nick})
+    end
+  end
+  
+  def copy!(old_host_nick, new_host_nick)
+    backup if @make_backups
+    copy(old_host_nick, new_host_nick)
+    save
+  end
+  
+  def copy(old_host_nick, new_host_nick)
+    if @sections_by_name.key?(old_host_nick)
+      old_section = @sections_by_name[old_host_nick]
+      new_section = @sections_by_name[new_host_nick] || add_section(new_host_nick)
+      new_section.lines = old_section.lines.dup
+      
+      if old_section["Hostname"]
+        new_section["Hostname"] = old_section["Hostname"].gsub(old_host_nick, new_host_nick)
+      end
+    end
+  end
+    
+  def save
+    File.open(File.expand_path("~/.ssh/config"), "w") do |file|
+      file.puts dump
+    end
+  end
+  
+  def backup
+    File.copy(File.expand_path("~/.ssh/config"), File.expand_path("~/.ssh/config~"))
+  end
+    
+  private
+  
+  def to_text(ray)
+    ray.map {|s| s.to_s } * "\n"
+  end
+end
+

data/lib/config_section.rb

@@ -0,0 +1,57 @@
+class ConfigSection
+  attr_accessor :name, :lines, :settings
+
+  def initialize(name)
+    @name = name
+    @settings = {}
+    @lines = []
+  end
+  
+  def [](setting)
+    unless @settings.key? setting
+      if line = lines[setting_index(setting)]
+        key,val = line.split(nil, 2)
+        @settings[key] = val
+      end
+    end
+    @settings[setting]
+  end
+  
+  def unset(setting)
+    if line_num = setting_index(setting)
+      @settings.delete setting
+      @lines.delete_at line_num
+    end
+  end
+  
+  def to_s
+    ["Host #{name}", *lines] * "\n"
+  end
+  
+  def []=(setting, value)
+    if value != '-'
+      line_num = setting_index(setting) || lines.length
+      lines[line_num] = format_line(setting, value)
+    else
+      @settings.delete(setting)
+      @lines.delete_at(setting_index(setting))
+    end
+  end
+  
+  def matches?(text)
+    r = Regexp.new text
+    name =~ r || lines.any? {|line| line =~ r}
+  end
+  
+  protected
+  
+  def format_line(setting, value)
+    "    #{setting} #{value}"
+  end
+  
+  def setting_index(setting)
+    r = Regexp.new(setting)
+    lines.index {|line| line =~ r}
+  end
+end
+

data/lib/ssh-config.rb

@@ -0,0 +1,3 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'config_file'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'config_section'))
+

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: ssh-config
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- David Brady
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-26 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: Ssh-Config, a tool that lets you quickly add, update, remove, and copy ssh config file entries.
+email: github@shinybit.com
+executables: 
+- ssh-config
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- MIT-LICENSE
+files: 
+- bin/ssh-config
+- lib/config_file.rb
+- lib/config_section.rb
+- lib/ssh-config.rb
+- README.rdoc
+- MIT-LICENSE
+has_rdoc: true
+homepage: http://github.com/dbrady/ssh-config/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README.rdoc
+- --title
+- Ssh-Config - A Tool for ssh config files
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ssh-Config - tool for managing your .ssh/config file
+test_files: []
+