train-winrm 0.2.3 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bedb30ef9245e5953c85b86be962be97d177335bdc3ec5714f5eb4a3a83e407
-  data.tar.gz: 4a0beebeea34e8db4b989beac547d67d88cf57b915ae372d6ccf48689c1b74c3
+  metadata.gz: 045fc82d7501aa62025f81b295fd89486b7bba3766e9559b3457ac706d489eee
+  data.tar.gz: b87548aef58d07f7a5d071366a19b6be78939e0046c87ced256a9184b38f0580
 SHA512:
-  metadata.gz: 07d7e9550cf28e75d4f7c16fc266ccdb7a4a81d16438554fc6a6bb964dddd8a4cac4fea13efeb3551dfea2cab3bf148c86f20af982b7b5caa10ee59aabf382da
-  data.tar.gz: 79ef8219d7655d87cb58706c037dae54e6b67063d2b20b4bce459148c27a9f91d35beb8afb7185b91c4deb8020d492b4947cec302595703341b0ab39ee285352
+  metadata.gz: 43aa548d919c0d47ff77e0d3c0961fa0c0c39e1fd3262bdd0af0f549ebad2f2e8e06147f505b9411a9d82467e9e66a64e51875fc0611a126e5c9a4cf7f559394
+  data.tar.gz: 16fbf2a183e63959cb03c351472887cffbbe7d1dd2ee7cbc71c919b5dea514459ba77794da54cafc1f2fce480f805d5077fd945ca70b6e099469a43d50aafbc8

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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/lib/train-winrm.rb

@@ -11,10 +11,10 @@
 libdir = File.dirname(__FILE__)
 $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
-# It's traditonal to keep your gem version in a separate file, so CI can find it easier.
-require "train-winrm/version"
+# It's traditional to keep your gem version in a separate file, so CI can find it easier.
+require_relative "train-winrm/version"
 
 # A train plugin has three components: Transport, Connection, and (optionally) Platform.
 # Transport acts as the glue.
-require "train-winrm/transport"
-require "train-winrm/connection"
+require_relative "train-winrm/transport"
+require_relative "train-winrm/connection"

data/lib/train-winrm/connection.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 #
 # Author:: Salim Afiune (<salim@afiunemaya.com.mx>)
 # Author:: Matt Wrock (<matt@mattwrock.com>)
@@ -35,6 +33,8 @@
 
 require "train"
 require "train/plugins"
+# This module may need to directly require WinRM to reference its exception classes
+require "winrm" unless defined?(WinRM)
 
 module TrainPlugins
   module WinRM
@@ -49,6 +49,7 @@ module TrainPlugins
         @connection_retry_sleep = @options.delete(:connection_retry_sleep)
         @max_wait_until_ready   = @options.delete(:max_wait_until_ready)
         @operation_timeout      = @options.delete(:operation_timeout)
+        @shell_type             = @options.delete(:winrm_shell_type)
       end
 
       # (see Base::Connection#close)
@@ -109,15 +110,47 @@ module TrainPlugins
         Train::File::Remote::Windows.new(self, path)
       end
 
-      def run_command_via_connection(command, &data_handler)
+      def run_command_via_connection(command, opts = {}, &data_handler)
         return if command.nil?
 
         logger.debug("[WinRM] #{self} (#{command})")
         out = ""
+        response = nil
+        timeout = opts[:timeout]&.to_i
+
+        # Run the command in a thread, to support timing out the command
+        thr = Thread.new do
+          # Surface any exceptions in this thread back to this method
+          Thread.current.report_on_exception = false
+          Thread.current.abort_on_exception = true
+          begin
+            response = session.run(command) do |stdout, _|
+              yield(stdout) if data_handler && stdout
+              out << stdout if stdout
+            end
+          rescue ::WinRM::WinRMHTTPTransportError => e
+            # If this command hits timeout, there is also a potential race in the HTTP transport
+            # where decryption is attempted on an empty message.
+            raise e unless timeout && e.to_s == "Could not decrypt NTLM message. ()."
+          rescue RuntimeError => e
+            # Ref: https://github.com/WinRb/WinRM/issues/315
+            # If this command hits timeout, calling close with the command currently running causes
+            # a RuntimeError error in WinRM's cleanup code. This specific error can be ignored.
+            # The command will be terminated and further commands can be sent on the connection.
+            raise e unless timeout && e.to_s == "opts[:shell_id] is required"
+          end
+        end
 
-        response = session.run(command) do |stdout, _|
-          yield(stdout) if data_handler && stdout
-          out << stdout if stdout
+        if timeout
+          res = thr.join(timeout)
+          unless res
+            msg = "PowerShell command '(#{command})' reached timeout (#{timeout}s)"
+            logger.info("[WinRM] #{msg}")
+            close
+            raise Train::CommandTimeoutReached.new msg
+          end
+        else
+          thr.join
         end
 
         CommandResult.new(out, response.stderr, response.exitcode)
@@ -148,7 +181,7 @@ module TrainPlugins
         @file_manager ||= begin
           # Ensure @service is available:
           wait_until_ready
-          WinRM::FS::FileManager.new(@service)
+          ::WinRM::FS::FileManager.new(@service)
         end
       end
 
@@ -197,7 +230,7 @@ module TrainPlugins
           opts[:operation_timeout] = @operation_timeout unless @operation_timeout.nil?
           @service = ::WinRM::Connection.new(options.merge(opts))
           @service.logger = logger
-          @service.shell(:powershell)
+          @service.shell(@shell_type)
         end
       end
 

data/lib/train-winrm/transport.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 #
 # Author:: Salim Afiune (<salim@afiunemaya.com.mx>)
 # Author:: Matt Wrock (<matt@mattwrock.com>)
@@ -21,8 +19,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "rbconfig"
-require "uri"
 require "train"
 require "train/errors"
 require "train/plugins"
@@ -46,10 +42,11 @@ module TrainPlugins
     class Transport < Train.plugin(1) # rubocop:disable Metrics/ClassLength
       name "winrm"
 
-      require "train-winrm/connection"
+      require_relative "connection"
 
       # ref: https://github.com/winrb/winrm#transports
       SUPPORTED_WINRM_TRANSPORTS = %i{negotiate ssl plaintext kerberos}.freeze
+      SUPPORTED_WINRM_SHELL_TYPES = %i{powershell elevated cmd}.freeze
 
       # common target configuration
       option :host, required: true
@@ -76,6 +73,7 @@ module TrainPlugins
       # from the winrm endpoint. Does not mean that the command has
       # completed in this time, only that the server has ack'd the request.
       option :operation_timeout, default: nil
+      option :winrm_shell_type , default: "powershell"
 
       def initialize(opts)
         super(opts)
@@ -109,6 +107,11 @@ module TrainPlugins
           raise Train::ClientError, "Unsupported transport type: #{winrm_transport.inspect}"
         end
 
+        winrm_shell_type = opts[:winrm_shell_type].to_sym
+        unless SUPPORTED_WINRM_SHELL_TYPES.include?(winrm_shell_type)
+          raise Train::ClientError, "Unsupported winrm shell type: #{winrm_shell_type.inspect}"
+        end
+
         # remove leading '/'
         path = (opts[:path] || "").sub(%r{^/+}, "")
 
@@ -116,6 +119,7 @@ module TrainPlugins
       end
 
       WINRM_FS_SPEC_VERSION = "~> 1.0".freeze
+      WINRM_ELEVATED_SPEC_VERSION = "~> 1.2.2".freeze
 
       # Builds the hash of options needed by the Connection object on
       # construction.
@@ -142,13 +146,14 @@ module TrainPlugins
           service: opts[:kerberos_service],
           ca_trust_file: opts[:ca_trust_file],
           ssl_peer_fingerprint: opts[:ssl_peer_fingerprint],
+          winrm_shell_type: opts[:winrm_shell_type],
         }
       end
 
       # Creates a new WinRM Connection instance and save it for potential
       # future reuse.
       #
-      # @param options [Hash] conneciton options
+      # @param options [Hash] connection options
       # @return [WinRM::Connection] a WinRM Connection instance
       # @api private
       def create_new_connection(options, &block)
@@ -166,32 +171,41 @@ module TrainPlugins
         spec_version = WINRM_FS_SPEC_VERSION.dup
         logger.debug("winrm-fs requested," \
           " loading WinRM::FS gem (#{spec_version})")
-        gem "winrm-fs", spec_version
-        first_load = require "winrm-fs"
-        load_winrm_transport!
+        load_dependency("winrm-fs", spec_version)
+
+        spec_version = WINRM_ELEVATED_SPEC_VERSION.dup
+        logger.debug("winrm-elevated requested," \
+          " loading WinRM-elevated gem (#{spec_version})")
+        load_dependency("winrm-elevated", spec_version)
+      end
+
+      def load_dependency(gem_name, spec_version)
+        gem gem_name, spec_version
+        first_load = require gem_name
+        load_winrm_transport!(gem_name)
 
         if first_load
-          logger.debug("WinRM::FS library loaded")
+          logger.debug("#{gem_name} library loaded")
         else
-          logger.debug("WinRM::FS previously loaded")
+          logger.debug("#{gem_name} previously loaded")
         end
       rescue LoadError => e
         logger.fatal(
-          "The `winrm-fs' gem is missing and must" \
+          "The `#{gem_name}' gem is missing and must" \
           " be installed or cannot be properly activated. Run" \
-          " `gem install winrm-fs --version '#{spec_version}'`" \
+          " `gem install #{gem_name}  --version '#{spec_version}'`" \
           " or add the following to your Gemfile if you are using Bundler:" \
-          " `gem 'winrm-fs', '#{spec_version}'`."
+          " `gem '#{gem_name}', '#{spec_version}'`."
         )
         raise Train::UserError,
-          "Could not load or activate WinRM::FS (#{e.message})"
+          "Could not load or activate #{gem_name} (#{e.message})"
       end
 
       # Load WinRM::Transport code.
       #
       # @api private
-      def load_winrm_transport!
-        silence_warnings { require "winrm-fs" }
+      def load_winrm_transport!(gem_name)
+        silence_warnings { require gem_name }
       end
 
       # Return the last saved WinRM connection instance.

data/lib/train-winrm/version.rb

@@ -5,6 +5,6 @@
 
 module TrainPlugins
   module WinRM
-    VERSION = "0.2.3".freeze
+    VERSION = "0.2.12".freeze
   end
 end

metadata

@@ -1,29 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: train-winrm
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.12
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-09 00:00:00.000000000 Z
+date: 2021-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: winrm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: winrm-elevated
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.2.2
 - !ruby/object:Gem::Dependency
   name: winrm-fs
   requirement: !ruby/object:Gem::Requirement
@@ -46,13 +66,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Gemfile
-- README.md
+- LICENSE
 - lib/train-winrm.rb
 - lib/train-winrm/connection.rb
 - lib/train-winrm/transport.rb
 - lib/train-winrm/version.rb
-- train-winrm.gemspec
 homepage: https://github.com/inspec/train-winrm
 licenses:
 - Apache-2.0
@@ -72,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Windows WinRM API Transport for Train

data/Gemfile

@@ -1,26 +0,0 @@
-# encoding: utf-8
-
-source "https://rubygems.org"
-
-# This is a Gemfile, which is used by bundler
-# to ensure a coherent set of gems is installed.
-# This file lists dependencies needed when outside
-# of a gem (the gemspec lists deps for gem deployment)
-
-# Bundler should refer to the gemspec for any dependencies.
-gemspec
-
-# Remaining group is only used for development.
-group :development do
-  # Depend on this here, not in the gemspec - to avoid having to have
-  # client applications induce circular dependencies
-  gem "train-core", "~> 3.0"
-  gem "bundler"
-  gem "byebug"
-  gem "m"
-  gem "minitest"
-  gem "mocha"
-  gem "pry"
-  gem "rake"
-  gem "chefstyle"
-end

data/README.md

@@ -1,105 +0,0 @@
-# train-winrm - Train Plugin for connecting to Windows via Remote Management
-
-* **Project State: Active**
-* **Issues Response SLA: 3 business days**
-* **Pull Request Response SLA: 3 business days**
-
-This plugin allows applications that rely on Train to communicate with the WinRM API.  For example, you could use this to audit Windows Server 2016 machines.
-
-This plugin relies on the `winrm` and `winrm-fs` gems for implementation.
-
-Train itself has no CLI, nor a sophisticated test harness.  Chef InSpec does have such facilities, so installing Train plugins will require a Chef InSpec installation.  You do not need to use or understand Chef InSpec.
-
-Train plugins may be developed without a Chef InSpec installation.
-
-## To Install this as a User
-
-### ChefDK Installation
-
-After August 2019, this plugin will be distributed with ChefDK; you do not need to install it separately.
-
-### Manual Installation using `inspec plugin install`
-
-Train plugins are distributed as gems.  You may choose to manage the gem yourself, but if you are an Chef InSpec user, Chef InSpec can handle it for you.
-
-You will need Chef InSpec v2.3 or later.
-
-Simply run:
-
-```
-$ inspec plugin install train-winrm
-```
-
-You can then run, using Chef InSpec as an example:
-
-```
-you@home $ inspec some-profile winrm://someuser@somehost --password somepassword
-```
-
-From Ruby code, you may use this plugin as follows:
-```
-require 'train'
-transport = Train.create(
-  'winrm',
-  host: '1.2.3.4',
-  user: 'Administrator',
-  password: '...',
-  ssl: true,
-  self_signed: true
-)
-conn = transport.connection
-```
-
-## Target Options for Train-WinRM
-
-### host
-
-Required `String`. The hostname or IP address used for connection.
-
-#### port
-
-Optional `Integer`, default 5985 (plain) or 5896 (SSL). The port number to which the connection should be made.
-
-### user
-
-Optional `String`, username used for sign in.  Default `Administrator`.
-
-### password
-
-Optional `String`, password used for sign in. None sent if not provided.
-
-### ssl
-
-Optional `Boolean`. Defaults to `false`. Determines whether to use SSL to encrypt communications.
-
-Several other options exist. To see these options, run:
-
-```
-puts Train.options('winrm')
-```
-
-## Reporting Issues
-
-Bugs, typos, limitations, and frustrations are welcome to be reported through the [GitHub issues page for the train-winrm project](https://github.com/inspec/train-winrm/issues).
-
-You may also ask questions in the #inspec channel of the Chef Community Slack team.  However, for an issue to get traction, please report it as a github issue.
-
-## Development on this Plugin
-
-### Development Process
-
-If you wish to contribute to this plugin, please use the usual fork-branch-push-PR cycle.  All functional changes need new tests, and bugfixes are expected to include a new test that demonstrates the bug.
-
-### Reference Information
-
-[Plugin Development](https://github.com/inspec/train/blob/master/docs/dev/plugins.md) is documented on the `train` project on GitHub.
-
-### Unit tests
-
-Run `bundle exec rake test:unit` to run the unit tests.
-
-### Testing changes against a Windows Machine
-
-Install Vagrant and VirtualBox. Check the Vagrantfile to verify that it references a Windows 2016 evaluation VagrantBox to which you have access.
-
-Then, run `bundle exec rake test:integration`. There are sub-tasks you can use to run only the integration tests; to see a list of all tasks, run `rake -aT`.

data/train-winrm.gemspec

@@ -1,44 +0,0 @@
-# As plugins are usually packaged and distributed as a RubyGem,
-# we have to provide a .gemspec file, which controls the gembuild
-# and publish process.  This is a fairly generic gemspec.
-
-# It is traditional in a gemspec to dynamically load the current version
-# from a file in the source tree.  The next three lines make that happen.
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "train-winrm/version"
-
-Gem::Specification.new do |spec|
-  # Importantly, all Train plugins must be prefixed with `train-`
-  spec.name = "train-winrm"
-
-  # It is polite to namespace your plugin under InspecPlugins::YourPluginInCamelCase
-  spec.version       = TrainPlugins::WinRM::VERSION
-  spec.authors       = ["Chef InSpec Team"]
-  spec.email         = ["inspec@chef.io"]
-  spec.summary       = "Windows WinRM API Transport for Train"
-  spec.description   = "Allows applictaions using Train to speak to Windows using Remote Management; handles authentication, cacheing, and SDK dependency management."
-  spec.homepage      = "https://github.com/inspec/train-winrm"
-  spec.license       = "Apache-2.0"
-
-  # Though complicated-looking, this is pretty standard for a gemspec.
-  # It just filters what will actually be packaged in the gem (leaving
-  # out tests, etc)
-  spec.files = %w{
-    README.md train-winrm.gemspec Gemfile
-  } + Dir.glob(
-    "lib/**/*", File::FNM_DOTMATCH
-  ).reject { |f| File.directory?(f) }
-  spec.require_paths = ["lib"]
-
-  # If you rely on any other gems, list them here with any constraints.
-  # This is how `inspec plugin install` is able to manage your dependencies.
-
-  # If you only need certain gems during development or testing, list
-  # them in Gemfile, not here.
-
-  # Do not list inspec as a dependency of a train plugin.
-  # Do not list train or train-core as a dependency of a train plugin.
-  spec.add_dependency "winrm", "~> 2.0"
-  spec.add_dependency "winrm-fs", "~> 1.0"
-end