vagrant-multi-putty 1.0.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2012 Nicholas Downs
+
+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.md

@@ -0,0 +1,80 @@
+# vagrant-multi-putty
+
+* Source: https://github.com/nickryand/vagrant-multi-putty
+
+This plugin allows you to use putty to ssh into VMs. It has been tested on
+Windows and should also work on Linux. Multi-vm environments are supported.
+
+## Installation
+### Software
+To install this plugin for the gem version of Vagrant:
+```
+$ gem install vagrant-multi-putty
+```
+
+To install under the non-gem installed version of Vagrant:
+```
+$ vagrant gem install vagrant-multi-putty
+```
+
+### Putty Binary
+Download: http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
+
+Download the putty executable for your platform and place it's location on your
+PATH variable. Seek your operating system manual for instructions on how to
+modify your PATH variable.
+
+### SSH Private Key conversion using PuTTYgen
+Download: http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
+
+Putty uses a custom format for SSH keys. It does not support openssl keys
+directly. Using PuTTYgen, you can convert the private key shipped with vagrant
+or convert a private key of your own.
+
+#### Steps for converting the shipped insecure private key
+ 1. Open puttygen and click the Conversions -> Import Key menu option.
+ 2. Select the insecure_private_key located at ~/.vagrant.d/insecure_private_key
+ 3. Click the "Save private key" button and store the key right along side the
+    insecure key.
+ 4. Answer yes when prompted to save without a password.
+ 5. Save the key using the filename of "insecure_private_key.ppk".
+
+Note: If you do not explicity set the config.putty.private_key_path variable,
+you need to convert the insecure_private_key and store it with the a ".ppk"
+extension. The vagrant-multi-putty plugin appends this extension automatically.
+
+## Configuration
+Most of the ssh configuration options used to control vagrant ssh also
+control vagrant-multi-putty. The following Vagrantfile options are NOT used by
+vagrant-multi-putty:
+
+*    config.ssh.max_tries
+*    config.ssh.timeout
+*    config.ssh.private_key_path
+*    config.ssh.shell
+
+All other config.ssh options should work for vagrant-multi-putty just like they
+do for vagrant ssh.
+
+There are currently two additional configuration parameters available:
+
+*    config.putty.username: Overrides the username set with
+     config.ssh.username.
+*    config.putty.private_key_path: Used to explicity  set the path to the
+     private key variable.
+
+## Usage
+Basic usage:
+```
+vagrant putty
+```
+
+Login into a single vm in a multiple vm environment:
+```
+vagrant putty <name of vm>
+```
+
+Pass putty options directly to the putty binary:
+```
+vagrant putty -- -l testuser -i <path to private key>
+```

data/lib/vagrant-multi-putty.rb

@@ -0,0 +1,2 @@
+require 'vagrant-multi-putty/command'
+require 'vagrant-multi-putty/config'

data/lib/vagrant-multi-putty/command.rb

@@ -0,0 +1,73 @@
+# Pieces of this plugin were taken from the bundled vagrant ssh plugin.
+require 'rubygems'
+require 'optparse'
+
+module VagrantMuliPutty
+  class Command < Vagrant::Command::Base
+    def execute
+      options = {}
+      opts = OptionParser.new do |opts|
+        opts.banner = "Usage: vagrant putty [vm-name...] [-- extra putty args]"
+
+        opts.on("-p", "--plain", "Plain auth mode which will require the user to provide a password.") do |p|
+          options[:plain_auth] = p
+        end
+
+        opts.separator ""
+      end
+
+      argv = parse_options(opts)
+      return if !argv
+
+      # This is borrowed from the ssh base command that ships with vagrant.
+      # It is used to parse out arguments meant for the putty program.
+      putty_args = ARGV.drop_while { |i| i != "--" }
+      putty_args = putty_args[1..-1] if !putty_args.empty?
+      @logger.debug("Putty args: #{putty_args}")
+
+      # argv needs to be purged of the extra putty arguments. The remaining arguments
+      # (if any) will be the VM names to log into.
+      argv = argv - putty_args
+
+      # Since putty is a program with a GUI window, we can perform a spawn and
+      # detach the process from vagrant.
+      with_target_vms(argv) do |vm|
+        # Also borrowed from the base ssh.rb code.
+        # Basic checks needed for a putty connection
+        raise Vagrant::Errors::VMNotCreatedError if !vm.created?
+        raise Vagrant::Errors::VMInaccessible if !vm.state == :inaccessible
+        raise Vagrant::Errors::VMNotRunningError if vm.state != :running
+
+        @logger.info("Launching putty session to: #{vm.name}")
+        putty_connect(vm, putty_args, plain_auth=options[:plain_auth])
+      end
+    end
+
+    def putty_connect(vm, args, plain_auth=False)
+      # Get the path to the private key for VM.
+      private_key = vm.config.putty.private_key_path || "#{vm.env.default_private_key_path}.ppk"
+      pk_path = File.expand_path("#{private_key}", vm.env.root_path)
+      @logger.debug("Putty Private Key: #{pk_path}")
+
+      # Load options set in the Vagrantfile
+      ssh_port = vm.config.ssh.port || vm.driver.ssh_port(vm.config.ssh.guest_port)
+      options = [vm.config.ssh.host]
+      options += ["-l", vm.config.putty.username || vm.config.ssh.username]
+      options += ["-P", ssh_port.to_s]
+      options += ["-i", pk_path] if !plain_auth
+      options += ["-X"] if vm.config.ssh.forward_x11
+      options += ["-A"] if vm.config.ssh.forward_agent
+
+      # Add in additional args from the command line.
+      options.concat(args) if !args.nil?
+
+      # Spawn putty and detach it so we can move on.
+      @logger.debug("Putty cmd line options: #{options.to_s}")
+      pid = spawn("putty", *options)
+      @logger.debug("Putty Child Pid: #{pid}")
+      Process.detach(pid)
+    end
+  end
+
+  Vagrant.commands.register(:putty) { Command }
+end

data/lib/vagrant-multi-putty/config.rb

@@ -0,0 +1,9 @@
+
+module VagrantMultiPutty
+  class PuttyConfig < Vagrant::Config::Base
+    attr_accessor :username
+    attr_accessor :private_key_path
+  end
+
+  Vagrant.config_keys.register(:putty) { PuttyConfig }
+end

data/lib/vagrant-multi-putty/version.rb

@@ -0,0 +1,3 @@
+module VagrantMultiPutty
+  VERSION = "1.0.0"
+end

data/lib/vagrant_init.rb

@@ -0,0 +1 @@
+require 'vagrant-multi-putty'

data/vagrant-multi-putty.gemspec

@@ -0,0 +1,19 @@
+require File.expand_path("../lib/vagrant-multi-putty/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "vagrant-multi-putty"
+  s.version     = VagrantMultiPutty::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Nick Downs"]
+  s.email       = ["nickryand@gmail.com"]
+  s.homepage    = "https://github.com/nickryand/vagrant-multi-putty"
+  s.summary     = "Vagrant plugin to allow VM ssh with PuTTY (multi-vm supported)"
+  s.description = "Vagrant plugin to allow VM ssh with PuTTY (multi-vm supported)"
+
+  s.required_rubygems_version = ">= 1.4.0"
+
+  s.add_dependency "vagrant", "~> 1.0.5"
+
+  s.files        = `git ls-files`.split("\n")
+  s.require_path = 'lib'
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-multi-putty
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Nick Downs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vagrant
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+description: Vagrant plugin to allow VM ssh with PuTTY (multi-vm supported)
+email:
+- nickryand@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/vagrant-multi-putty.rb
+- lib/vagrant-multi-putty/command.rb
+- lib/vagrant-multi-putty/config.rb
+- lib/vagrant-multi-putty/version.rb
+- lib/vagrant_init.rb
+- vagrant-multi-putty.gemspec
+homepage: https://github.com/nickryand/vagrant-multi-putty
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.4.0
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Vagrant plugin to allow VM ssh with PuTTY (multi-vm supported)
+test_files: []