vagrant-winrm-s 0.0.1

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.vagrant/
+Vagrantfile

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  Exclude:
+    - '*.gemspec'
+
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20
+
+StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/FileName:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in vagrant-winrm-s.gemspec
+gemspec
+
+group :development do
+  gem "vagrant", git: "https://github.com/mitchellh/vagrant.git"
+  gem "vagrant-spec", git: "https://github.com/mitchellh/vagrant-spec.git"
+end
+
+group :plugins do
+  gem "vagrant-winrm-s", path: "."
+  gem "vagrant-managed-servers"
+  gem "vagrant-orchestrate"
+end

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2015 Cimpress
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,77 @@
+# Vagrant-WinRM-S
+
+A Vagrant communicator that uses the `winrm-s` gem to communicate over winrm. Notably, allows for SSPI authentication of domain accounts when using a Windows host.
+
+## Installation
+
+```bash
+$ vagrant plugin install vagrant-winrm-s
+```
+
+Or, to install and test a locally-developed version:
+```bash
+$ rake install
+```
+
+## Use
+
+Vargrant-WinRM-S uses the `:winrm` communicator built in to vagrant as
+its base, so existing Vagrantfiles should continue to work with this plugin.
+
+The extra configuration value that gets exposed is `config.winrm.transport`.
+The default transport is `:plaintext`. This is for basic authentication of
+local accounts over HTTP. The plugin exposes the `:sspinegotiate`
+transport from the `winrm-s` gem in order to do Negotiate authentication
+of domain accounts (still only over HTTP).
+
+An example Vagrant communicator block for `:sspinegotiate` would look something
+like:
+
+```ruby
+config.vm.provision "shell", inline: "echo Hello, World!"
+config.vm.communicator = :winrm
+config.winrm.username = "domain\\auser"
+config.winrm.password = "It5@p455w0rd!"
+config.winrm.transport = :sspinegotiate
+```
+
+### What about the SSL transport?
+
+The `:ssl` transport is available and can be used to authenticate local accounts.
+However, the versions of `WinRM` and `HTTPClient` bundled with Vagrant make it
+difficult to ignore untrusted/self-signed certificates. But users with proper
+certificates should have no problem.
+
+## Setting up your server
+
+For authentication of local accounts over HTTP, the `winrm quickconfig`
+command should suffice. This will enable the HTTP listener for basic authentication.
+
+In order to connect via the `:plaintext` transport, you should ensure that
+`winrm/config/service/auth/Basic` and `winrm/config/service/AllowUnencrypted` are enabled.
+
+```
+winrm set winrm/config/service/auth @{Basic="true"}
+winrm set winrm/config/service @{AllowUnencrypted="true"}
+```
+
+For the `:sspinegotiate` transport, ensure `winrm/config/service/auth/Negotiate` is true and `winrm/config/service/AllowUnencrypted` is false.
+
+```
+winrm set winrm/config/service/auth @{Negotiate="true"}
+winrm set winrm/config/service @{AllowUnencrypted="false"}
+```
+
+See also:
+
+* [MSDN article about configuring WinRM](http://msdn.microsoft.com/en-us/library/aa384372\(v=vs.85\).aspx)
+* [WinRM gem](https://github.com/WinRb/WinRM/blob/master/README.md#troubleshooting)
+* [WinRM-S gem](https://github.com/opscode/winrm-s/blob/master/README.md)
+
+## Contributing
+
+1. Fork it ( https://github.com/Cimpress-MCP/vagrant-winrm-s/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task :install_local do
+  system("rake build")
+  system("vagrant plugin install ./pkg/vagrant-winrm-s-0.0.1.gem")
+end

data/lib/vagrant-winrm-s.rb

@@ -0,0 +1,17 @@
+require "vagrant-winrm-s/version"
+require "vagrant-winrm-s/plugin"
+require "vagrant-winrm-s/config"
+
+module VagrantPlugins
+  module CommunicatorWinRM
+    lib_path = Pathname.new(File.expand_path("../vagrant-winrm-s", __FILE__))
+    autoload :Communicator, lib_path.join("communicator")
+
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+  end
+end

data/lib/vagrant-winrm-s/communicator.rb

@@ -0,0 +1,32 @@
+require "timeout"
+require "log4r"
+
+require "vagrant/../../plugins/communicators/winrm/helper"
+require_relative "shell"
+require "vagrant/../../plugins/communicators/winrm/communicator"
+
+module VagrantPlugins
+  module CommunicatorWinRM
+    class WinrmSCommunicator < Communicator
+      def initialize(machine)
+        super(machine)
+      end
+
+      protected
+
+      def create_shell
+        winrm_info = Helper.winrm_info(@machine)
+
+        WinRMSShell.new(
+          winrm_info[:host],
+          @machine.config.winrm.username,
+          @machine.config.winrm.password,
+          transport: @machine.config.winrm.transport,
+          port: @machine.config.winrm.port,
+          timeout_in_seconds: @machine.config.winrm.timeout,
+          max_tries: @machine.config.winrm.max_tries)
+      end
+
+    end
+  end
+end

data/lib/vagrant-winrm-s/config.rb

@@ -0,0 +1,40 @@
+require "vagrant/../../plugins/communicators/winrm/config"
+
+module VagrantPlugins
+  module CommunicatorWinRM
+    class WinrmSConfig < Config
+
+      attr_accessor :transport
+
+      def initialize
+        super
+        @transport  = UNSET_VALUE
+      end
+
+      def finalize!
+        @username = "vagrant"   if @username == UNSET_VALUE
+        @password = "vagrant"   if @password == UNSET_VALUE
+        @host = nil             if @host == UNSET_VALUE
+        @port = 5985            if @port == UNSET_VALUE
+        @guest_port = 5985      if @guest_port == UNSET_VALUE
+        @max_tries = 20         if @max_tries == UNSET_VALUE
+        @timeout = 1800         if @timeout == UNSET_VALUE
+        @transport = :plaintext if @transport == UNSET_VALUE
+      end
+
+      def validate(_machine)
+        errors = []
+
+        errors << "winrm.username cannot be nil."   if @username.nil?
+        errors << "winrm.password cannot be nil."   if @password.nil?
+        errors << "winrm.port cannot be nil."       if @port.nil?
+        errors << "winrm.guest_port cannot be nil." if @guest_port.nil?
+        errors << "winrm.max_tries cannot be nil."  if @max_tries.nil?
+        errors << "winrm.timeout cannot be nil."    if @timeout.nil?
+        errors << "winrm.transport cannot be nil."  if @transport.nil?
+
+        { "WinRM" => errors }
+      end
+    end
+  end
+end

data/lib/vagrant-winrm-s/plugin.rb

@@ -0,0 +1,30 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "vagrant-winrm-s must be run from within vagrant."
+end
+
+require "vagrant/../../plugins/communicators/winrm/plugin"
+
+module VagrantPlugins
+  module CommunicatorWinRM
+    class WinrmSPlugin < Plugin
+      name "winrms communicator"
+      description <<-DESC
+      This plugin allows Vagrant to communicate with remote machines using
+      SSPINegotiate when run from Windows Hosts.
+      DESC
+
+      communicator("winrm") do
+        require File.expand_path("../communicator", __FILE__)
+        init!
+        WinrmSCommunicator
+      end
+
+      config("winrm") do
+        require_relative "config"
+        WinrmSConfig
+      end
+    end
+  end
+end

data/lib/vagrant-winrm-s/shell.rb

@@ -0,0 +1,59 @@
+require "timeout"
+require "log4r"
+require "vagrant/util/retryable"
+require "vagrant/util/silence_warnings"
+
+Vagrant::Util::SilenceWarnings.silence! do
+  require "winrm-s"
+end
+
+require "vagrant/../../plugins/communicators/winrm/file_manager"
+require "vagrant/../../plugins/communicators/winrm/shell"
+
+module VagrantPlugins
+  module CommunicatorWinRM
+    class WinRMSShell < WinRMShell
+      include Vagrant::Util::Retryable
+
+      attr_reader :transport
+      attr_reader :protocol
+
+      def initialize(host, username, password, options = {})
+        super(host, username, password, options)
+
+        @logger = Log4r::Logger.new("vagrant::communication::winrmsshell")
+        @transport =  options[:transport] || :plaintext
+        @protocol =  (options[:transport] == :ssl) ? "https" : "http"
+      end
+
+      protected
+
+      def new_session
+        @logger.info("Attempting to connect to WinRM...")
+        @logger.info("  - Host: #{@host}")
+        @logger.info("  - Port: #{@port}")
+        @logger.info("  - Username: #{@username}")
+        @logger.info("  - Transport: #{@transport}")
+        @logger.info("  - Endpoint: #{endpoint}")
+
+        client = ::WinRM::WinRMWebService.new(endpoint, @transport, endpoint_options)
+        client.set_timeout(@timeout_in_seconds)
+        client.toggle_nori_type_casting(:off)
+        client
+      end
+
+      def endpoint
+        "#{@protocol}://#{@host}:#{@port}/wsman"
+      end
+
+      def endpoint_options
+        { user: @username,
+          pass: @password,
+          host: @host,
+          port: @port,
+          operation_timeout: @timeout_in_seconds,
+          basic_auth_only: (@transport == :plaintext) }
+      end
+    end # WinShell class
+  end
+end

data/lib/vagrant-winrm-s/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module CommunicatorWinRMS
+    VERSION = "0.0.1"
+  end
+end

data/vagrant-winrm-s.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-winrm-s/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-winrm-s"
+  spec.version       = VagrantPlugins::CommunicatorWinRMS::VERSION
+  spec.authors       = ["Norm MacLennan"]
+  spec.email         = ["nmaclennan@cimpress.com"]
+  spec.summary       = "Secure WinRM vagrant communicator"
+  spec.description   = "A Vagrant plugin that allows for secure communication over WinRM"
+  spec.homepage      = "https://github.com/Cimpress-MCP/vagrant-winrm-s"
+  spec.license       = "Apache 2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "winrm-s", "~>0.1.0"
+  spec.add_dependency "httpclient", "~>2.4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 2.99"
+  spec.add_development_dependency "rubocop", "~> 0.28"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-winrm-s
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Norm MacLennan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: winrm-s
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.28'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.28'
+description: A Vagrant plugin that allows for secure communication over WinRM
+email:
+- nmaclennan@cimpress.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant-winrm-s.rb
+- lib/vagrant-winrm-s/communicator.rb
+- lib/vagrant-winrm-s/config.rb
+- lib/vagrant-winrm-s/plugin.rb
+- lib/vagrant-winrm-s/shell.rb
+- lib/vagrant-winrm-s/version.rb
+- vagrant-winrm-s.gemspec
+homepage: https://github.com/Cimpress-MCP/vagrant-winrm-s
+licenses:
+- Apache 2.0
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Secure WinRM vagrant communicator
+test_files: []