knife-windows 3.0.6 → 3.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9432834ebf7782938c60391d85dc2af81228c917839f361692416ccf22659da7
-  data.tar.gz: 129c34c1074fd2bfb7f3e3ac6b7c4a6cb160f74a23cc68f1f347e94dc8e58b1a
+  metadata.gz: 429cae6c473c57982b128b35647dc1616c0571bc24edce1a46b1eb3604700379
+  data.tar.gz: 4a99a1b6187c711adf545a8ce16e7f1fe9659751b39cedf0be96cbfb33eb2dc9
 SHA512:
-  metadata.gz: bbc994bc3cbb06657e5ed5073a2a73d97623cc0c3d7d9b7365202a4a4bfd9df285fc475c5cf43ce6c95edbf9e5a08dc87c42b7665b5b5a4cb00260deb8ba41b1
-  data.tar.gz: cedc907a3a7f52cab7bcfd8586dbfd2cfebac0081c135efc87d2d1a0428d8cb406c8371a4546c50d7bd8813b34f37d00a20f6b6f2dae709ca61aa68d7d942642
+  metadata.gz: cc0a6dc93a56a940f11bd5ff22774b0c02d799cb11465d523c18125335a708c7a50efa67fc63ac53e3325f8219305292fbb8abb5f2c4fabe8c5dbb38f5e4f3ec
+  data.tar.gz: 55a995dcd21e06fc8420f502f27d9fe7bacf2d4ded1a0c7e890bb3504fd9e4ce5b87f1b8aae43961c468232c24da861c3c458f9b9424edd39e02f5d00a974b75

data/lib/chef/knife/bootstrap_windows_base.rb

@@ -16,11 +16,11 @@
 # limitations under the License.
 #
 
-require 'chef/knife'
-require 'chef/knife/bootstrap'
-require 'chef/encrypted_data_bag_item'
-require_relative 'knife_windows_base'
-require 'chef/util/path_helper'
+require "chef/knife"
+require "chef/knife/bootstrap"
+require "chef/encrypted_data_bag_item"
+require_relative "knife_windows_base"
+require "chef/util/path_helper"
 
 class Chef
   class Knife
@@ -35,129 +35,130 @@ class Chef
         includer.class_eval do
 
           deps do
-            require 'readline'
-            require 'chef/json_compat'
+            require "readline"
+            require "chef/json_compat"
           end
 
           option :chef_node_name,
-            :short => "-N NAME",
-            :long => "--node-name NAME",
-            :description => "The Chef node name for your new node"
+            short: "-N NAME",
+            long: "--node-name NAME",
+            description: "The Chef node name for your new node"
 
           option :prerelease,
-            :long => "--prerelease",
-            :description => "Install the pre-release chef gems"
+            long: "--prerelease",
+            description: "Install the pre-release chef gems"
 
           option :bootstrap_version,
-            :long => "--bootstrap-version VERSION",
-            :description => "The version of Chef to install",
-            :proc => Proc.new { |v| Chef::Config[:knife][:bootstrap_version] = v }
+            long: "--bootstrap-version VERSION",
+            description: "The version of Chef to install",
+            proc: Proc.new { |v| Chef::Config[:knife][:bootstrap_version] = v }
 
           option :bootstrap_proxy,
-            :long => "--bootstrap-proxy PROXY_URL",
-            :description => "The proxy server for the node being bootstrapped",
-            :proc => Proc.new { |p| Chef::Config[:knife][:bootstrap_proxy] = p }
+            long: "--bootstrap-proxy PROXY_URL",
+            description: "The proxy server for the node being bootstrapped",
+            proc: Proc.new { |p| Chef::Config[:knife][:bootstrap_proxy] = p }
 
           option :bootstrap_no_proxy,
-            :long => "--bootstrap-no-proxy [NO_PROXY_URL|NO_PROXY_IP]",
-            :description => "Do not proxy locations for the node being bootstrapped; this option is used internally by Opscode",
-            :proc => Proc.new { |np| Chef::Config[:knife][:bootstrap_no_proxy] = np }
+            long: "--bootstrap-no-proxy [NO_PROXY_URL|NO_PROXY_IP]",
+            description: "Do not proxy locations for the node being bootstrapped; this option is used internally by Opscode",
+            proc: Proc.new { |np| Chef::Config[:knife][:bootstrap_no_proxy] = np }
 
           option :bootstrap_install_command,
-            :long        => "--bootstrap-install-command COMMANDS",
-            :description => "Custom command to install chef-client",
-            :proc        => Proc.new { |ic| Chef::Config[:knife][:bootstrap_install_command] = ic }
+            long: "--bootstrap-install-command COMMANDS",
+            description: "Custom command to install chef-client",
+            proc: Proc.new { |ic| Chef::Config[:knife][:bootstrap_install_command] = ic }
 
           option :bootstrap_template,
-            :short => "-t TEMPLATE",
-            :long => "--bootstrap-template TEMPLATE",
-            :description => "Bootstrap Chef using a built-in or custom template. Set to the full path of an erb template or use one of the built-in templates."
+            short: "-t TEMPLATE",
+            long: "--bootstrap-template TEMPLATE",
+            description: "Bootstrap Chef using a built-in or custom template. Set to the full path of an erb template or use one of the built-in templates."
 
           option :run_list,
-            :short => "-r RUN_LIST",
-            :long => "--run-list RUN_LIST",
-            :description => "Comma separated list of roles/recipes to apply",
-            :proc => lambda { |o| o.split(",") },
-            :default => []
+            short: "-r RUN_LIST",
+            long: "--run-list RUN_LIST",
+            description: "Comma separated list of roles/recipes to apply",
+            proc: lambda { |o| o.split(",") },
+            default: []
 
           option :hint,
-            :long => "--hint HINT_NAME[=HINT_FILE]",
-            :description => "Specify Ohai Hint to be set on the bootstrap target. Use multiple --hint options to specify multiple hints.",
-            :proc => Proc.new { |h|
-              Chef::Config[:knife][:hints] ||= Hash.new
+            long: "--hint HINT_NAME[=HINT_FILE]",
+            description: "Specify Ohai Hint to be set on the bootstrap target. Use multiple --hint options to specify multiple hints.",
+            proc: Proc.new { |h|
+              Chef::Config[:knife][:hints] ||= {}
               name, path = h.split("=")
-              Chef::Config[:knife][:hints][name] = path ? Chef::JSONCompat.parse(::File.read(path)) : Hash.new
+              Chef::Config[:knife][:hints][name] = path ? Chef::JSONCompat.parse(::File.read(path)) : {}
             }
 
           option :first_boot_attributes,
-            :short => "-j JSON_ATTRIBS",
-            :long => "--json-attributes",
-            :description => "A JSON string to be added to the first run of chef-client",
-            :proc => lambda { |o| JSON.parse(o) },
-            :default => nil
+            short: "-j JSON_ATTRIBS",
+            long: "--json-attributes",
+            description: "A JSON string to be added to the first run of chef-client",
+            proc: lambda { |o| JSON.parse(o) },
+            default: nil
 
           option :first_boot_attributes_from_file,
-            :long => "--json-attribute-file FILE",
-            :description => "A JSON file to be used to the first run of chef-client",
-            :proc => lambda { |o| Chef::JSONCompat.parse(File.read(o)) },
-            :default => nil
+            long: "--json-attribute-file FILE",
+            description: "A JSON file to be used to the first run of chef-client",
+            proc: lambda { |o| Chef::JSONCompat.parse(File.read(o)) },
+            default: nil
 
           # Mismatch between option 'encrypted_data_bag_secret' and it's long value '--secret' is by design for compatibility
           option :encrypted_data_bag_secret,
-            :short => "-s SECRET",
-            :long  => "--secret ",
-            :description => "The secret key to use to decrypt data bag item values. Will be rendered on the node at c:/chef/encrypted_data_bag_secret and set in the rendered client config.",
-            :default => false
+            short: "-s SECRET",
+            long: "--secret ",
+            description: "The secret key to use to decrypt data bag item values. Will be rendered on the node at c:/chef/encrypted_data_bag_secret and set in the rendered client config.",
+            default: false
 
           # Mismatch between option 'encrypted_data_bag_secret_file' and it's long value '--secret-file' is by design for compatibility
           option :encrypted_data_bag_secret_file,
-            :long => "--secret-file SECRET_FILE",
-            :description => "A file containing the secret key to use to encrypt data bag item values. Will be rendered on the node at c:/chef/encrypted_data_bag_secret and set in the rendered client config."
+            long: "--secret-file SECRET_FILE",
+            description: "A file containing the secret key to use to encrypt data bag item values. Will be rendered on the node at c:/chef/encrypted_data_bag_secret and set in the rendered client config."
 
           option :auth_timeout,
-            :long => "--auth-timeout MINUTES",
-            :description => "The maximum time in minutes to wait to for authentication over the transport to the node to succeed. The default value is 2 minutes.",
-            :default => 2
+            long: "--auth-timeout MINUTES",
+            description: "The maximum time in minutes to wait to for authentication over the transport to the node to succeed. The default value is 2 minutes.",
+            default: 2
 
           option :node_ssl_verify_mode,
-            :long        => "--node-ssl-verify-mode [peer|none]",
-            :description => "Whether or not to verify the SSL cert for all HTTPS requests.",
-            :proc        => Proc.new { |v|
-              valid_values = ["none", "peer"]
+            long: "--node-ssl-verify-mode [peer|none]",
+            description: "Whether or not to verify the SSL cert for all HTTPS requests.",
+            proc: Proc.new { |v|
+              valid_values = %w{none peer}
               unless valid_values.include?(v)
                 raise "Invalid value '#{v}' for --node-ssl-verify-mode. Valid values are: #{valid_values.join(", ")}"
               end
+
               v
             }
 
           option :node_verify_api_cert,
-            :long        => "--[no-]node-verify-api-cert",
-            :description => "Verify the SSL cert for HTTPS requests to the Chef server API.",
-            :boolean     => true
+            long: "--[no-]node-verify-api-cert",
+            description: "Verify the SSL cert for HTTPS requests to the Chef server API.",
+            boolean: true
 
           option :msi_url,
-            :short => "-u URL",
-            :long => "--msi-url URL",
-            :description => "Location of the Chef Client MSI. The default templates will prefer to download from this location. The MSI will be downloaded from chef.io if not provided.",
-            :default => ''
+            short: "-u URL",
+            long: "--msi-url URL",
+            description: "Location of the Chef Client MSI. The default templates will prefer to download from this location. The MSI will be downloaded from chef.io if not provided.",
+            default: ""
 
           option :install_as_service,
-            :long => "--install-as-service",
-            :description => "Install chef-client as a Windows service",
-            :default => false
+            long: "--install-as-service",
+            description: "Install chef-client as a Windows service",
+            default: false
 
           option :bootstrap_vault_file,
-          :long        => '--bootstrap-vault-file VAULT_FILE',
-          :description => 'A JSON file with a list of vault(s) and item(s) to be updated'
+            long: "--bootstrap-vault-file VAULT_FILE",
+            description: "A JSON file with a list of vault(s) and item(s) to be updated"
 
           option :bootstrap_vault_json,
-            :long        => '--bootstrap-vault-json VAULT_JSON',
-            :description => 'A JSON string with the vault(s) and item(s) to be updated'
+            long: "--bootstrap-vault-json VAULT_JSON",
+            description: "A JSON string with the vault(s) and item(s) to be updated"
 
           option :bootstrap_vault_item,
-            :long        => '--bootstrap-vault-item VAULT_ITEM',
-            :description => 'A single vault and item to update as "vault:item"',
-            :proc        => Proc.new { |i|
+            long: "--bootstrap-vault-item VAULT_ITEM",
+            description: 'A single vault and item to update as "vault:item"',
+            proc: Proc.new { |i|
               (vault, item) = i.split(/:/)
               Chef::Config[:knife][:bootstrap_vault_item] ||= {}
               Chef::Config[:knife][:bootstrap_vault_item][vault] ||= []
@@ -166,20 +167,20 @@ class Chef
             }
 
           option :policy_name,
-            :long         => "--policy-name POLICY_NAME",
-            :description  => "Policyfile name to use (--policy-group must also be given)",
-            :default      => nil
+            long: "--policy-name POLICY_NAME",
+            description: "Policyfile name to use (--policy-group must also be given)",
+            default: nil
 
           option :policy_group,
-            :long         => "--policy-group POLICY_GROUP",
-            :description  => "Policy group name to use (--policy-name must also be given)",
-            :default      => nil
+            long: "--policy-group POLICY_GROUP",
+            description: "Policy group name to use (--policy-name must also be given)",
+            default: nil
 
           option :tags,
-            :long => "--tags TAGS",
-            :description => "Comma separated list of tags to apply to the node",
-            :proc => lambda { |o| o.split(/[\s,]+/) },
-            :default => []
+            long: "--tags TAGS",
+            description: "Comma separated list of tags to apply to the node",
+            proc: lambda { |o| o.split(/[\s,]+/) },
+            default: []
         end
       end
     end

data/lib/chef/knife/bootstrap_windows_ssh.rb

@@ -16,7 +16,7 @@
 # limitations under the License.
 #
 
-require_relative 'bootstrap_windows_base'
+require_relative "bootstrap_windows_base"
 
 class Chef
   class Knife
@@ -25,11 +25,11 @@ class Chef
       include Chef::Knife::BootstrapWindowsBase
 
       deps do
-        require 'chef/json_compat'
-        require 'tempfile'
-        require 'highline'
-        require 'net/ssh'
-        require 'net/ssh/multi'
+        require "chef/json_compat"
+        require "tempfile"
+        require "highline"
+        require "net/ssh"
+        require "net/ssh/multi"
         Chef::Knife::Ssh.load_deps
         Chef::Knife::Bootstrap.load_deps
       end
@@ -37,59 +37,59 @@ class Chef
       banner "knife bootstrap windows ssh FQDN (options)"
 
       option :ssh_user,
-        :short => "-x USERNAME",
-        :long => "--ssh-user USERNAME",
-        :description => "The ssh username",
-        :default => "root"
+        short: "-x USERNAME",
+        long: "--ssh-user USERNAME",
+        description: "The ssh username",
+        default: "root"
 
       option :ssh_password,
-        :short => "-P PASSWORD",
-        :long => "--ssh-password PASSWORD",
-        :description => "The ssh password"
+        short: "-P PASSWORD",
+        long: "--ssh-password PASSWORD",
+        description: "The ssh password"
 
       option :ssh_port,
-        :short => "-p PORT",
-        :long => "--ssh-port PORT",
-        :description => "The ssh port",
-        :proc => Proc.new { |key| Chef::Config[:knife][:ssh_port] = key.strip }
+        short: "-p PORT",
+        long: "--ssh-port PORT",
+        description: "The ssh port",
+        proc: Proc.new { |key| Chef::Config[:knife][:ssh_port] = key.strip }
 
       option :ssh_gateway,
-        :short => "-G GATEWAY",
-        :long => "--ssh-gateway GATEWAY",
-        :description => "The ssh gateway",
-        :proc => Proc.new { |key| Chef::Config[:knife][:ssh_gateway] = key }
+        short: "-G GATEWAY",
+        long: "--ssh-gateway GATEWAY",
+        description: "The ssh gateway",
+        proc: Proc.new { |key| Chef::Config[:knife][:ssh_gateway] = key }
 
       option :forward_agent,
-        :short => "-A",
-        :long => "--forward-agent",
-        :description => "Enable SSH agent forwarding",
-        :boolean => true
+        short: "-A",
+        long: "--forward-agent",
+        description: "Enable SSH agent forwarding",
+        boolean: true
 
       option :identity_file,
-        :long => "--identity-file IDENTITY_FILE",
-        :description => "The SSH identity file used for authentication. [DEPRECATED] Use --ssh-identity-file instead."
+        long: "--identity-file IDENTITY_FILE",
+        description: "The SSH identity file used for authentication. [DEPRECATED] Use --ssh-identity-file instead."
 
       option :ssh_identity_file,
-        :short => "-i IDENTITY_FILE",
-        :long => "--ssh-identity-file IDENTITY_FILE",
-        :description => "The SSH identity file used for authentication"
+        short: "-i IDENTITY_FILE",
+        long: "--ssh-identity-file IDENTITY_FILE",
+        description: "The SSH identity file used for authentication"
 
       option :host_key_verify,
-        :long => "--[no-]host-key-verify",
-        :description => "Verify host key, enabled by default.",
-        :boolean => true,
-        :default => true
+        long: "--[no-]host-key-verify",
+        description: "Verify host key, enabled by default.",
+        boolean: true,
+        default: true
 
       def run
-         Chef::Application.fatal!(<<~EOM
-         *knife windows bootstrap ssh*
-          Core Chef now supports bootstrapping Windows systems without a knife plugin
-          
-          Use 'knife bootstrap -o ssh' instead.
-          
-          For more detail https://github.com/chef/chef/blob/master/RELEASE_NOTES.md#knife-bootstrap
-          EOM
-          )
+        Chef::Application.fatal!(<<~EOM
+          *knife windows bootstrap ssh*
+           Core Chef now supports bootstrapping Windows systems without a knife plugin
+
+           Use 'knife bootstrap -o ssh' instead.
+
+           For more detail https://github.com/chef/chef/blob/master/RELEASE_NOTES.md#knife-bootstrap
+        EOM
+                                )
       end
 
     end

data/lib/chef/knife/bootstrap_windows_winrm.rb

@@ -16,11 +16,10 @@
 # limitations under the License.
 #
 
-require_relative 'bootstrap_windows_base'
-require_relative 'winrm'
-require_relative 'winrm_base'
-require_relative 'winrm_knife_base'
-
+require_relative "bootstrap_windows_base"
+require_relative "winrm"
+require_relative "winrm_base"
+require_relative "winrm_knife_base"
 
 class Chef
   class Knife
@@ -31,24 +30,24 @@ class Chef
       include Chef::Knife::WinrmCommandSharedFunctions
 
       deps do
-        require 'chef/json_compat'
-        require 'tempfile'
+        require "chef/json_compat"
+        require "tempfile"
         Chef::Knife::Winrm.load_deps
         Chef::Knife::Bootstrap.load_deps
       end
 
-      banner 'knife bootstrap windows winrm FQDN (options)'
+      banner "knife bootstrap windows winrm FQDN (options)"
 
       def run
-         Chef::Application.fatal!(<<~EOM
-         *knife windows bootstrap winrm*
-          Core Chef now supports bootstrapping Windows systems without a knife plugin
-          
-          Use 'knife bootstrap -o winrm' instead.
-          
-          For more detail https://github.com/chef/chef/blob/master/RELEASE_NOTES.md#knife-bootstrap
-          EOM
-          )
+        Chef::Application.fatal!(<<~EOM
+          *knife windows bootstrap winrm*
+           Core Chef now supports bootstrapping Windows systems without a knife plugin
+
+           Use 'knife bootstrap -o winrm' instead.
+
+           For more detail https://github.com/chef/chef/blob/master/RELEASE_NOTES.md#knife-bootstrap
+        EOM
+                                )
       end
 
     end

data/lib/chef/knife/knife_windows_base.rb

@@ -30,4 +30,3 @@ class Chef
     end
   end
 end
-

data/lib/chef/knife/windows_cert_generate.rb

@@ -15,10 +15,10 @@
 # limitations under the License.
 #
 
-require 'chef/knife'
-require_relative 'winrm_base'
-require 'openssl'
-require 'socket'
+require "chef/knife"
+require_relative "winrm_base"
+require "openssl"
+require "socket"
 
 class Chef
   class Knife
@@ -29,34 +29,34 @@ class Chef
       banner "knife windows cert generate FILE_PATH (options)"
 
       option :hostname,
-        :short => "-H HOSTNAME",
-        :long => "--hostname HOSTNAME",
-        :description => "Use to specify the hostname for the listener.
+        short: "-H HOSTNAME",
+        long: "--hostname HOSTNAME",
+        description: "Use to specify the hostname for the listener.
         For example, --hostname something.mydomain.com or *.mydomain.com.",
-        :required => true
+        required: true
 
       option :output_file,
-        :short => "-o PATH",
-        :long => "--output-file PATH",
-        :description => "Specifies the file path at which to generate the 3 certificate files of type .pfx, .b64, and .pem. The default is './winrmcert'.",
-        :default => "winrmcert"
+        short: "-o PATH",
+        long: "--output-file PATH",
+        description: "Specifies the file path at which to generate the 3 certificate files of type .pfx, .b64, and .pem. The default is './winrmcert'.",
+        default: "winrmcert"
 
       option :key_length,
-        :short => "-k LENGTH",
-        :long => "--key-length LENGTH",
-        :description => "Default is 2048",
-        :default => "2048"
+        short: "-k LENGTH",
+        long: "--key-length LENGTH",
+        description: "Default is 2048",
+        default: "2048"
 
       option :cert_validity,
-        :short => "-cv MONTHS",
-        :long => "--cert-validity MONTHS",
-        :description => "Default is 24 months",
-        :default => "24"
+        short: "-cv MONTHS",
+        long: "--cert-validity MONTHS",
+        description: "Default is 24 months",
+        default: "24"
 
       option :cert_passphrase,
-        :short => "-cp PASSWORD",
-        :long => "--cert-passphrase PASSWORD",
-        :description => "Password for certificate."
+        short: "-cp PASSWORD",
+        long: "--cert-passphrase PASSWORD",
+        description: "Password for certificate."
 
       def generate_keypair
         OpenSSL::PKey::RSA.new(config[:key_length].to_i)
@@ -69,16 +69,17 @@ class Chef
           print "Enter certificate passphrase (empty for no passphrase):"
           passphrase = STDIN.gets
           return passphrase.strip if passphrase == "\n"
+
           print "Enter same passphrase again:"
           confirm_passphrase = STDIN.gets
         end until passphrase == confirm_passphrase
         passphrase.strip
       end
 
-      def generate_certificate rsa_key
+      def generate_certificate(rsa_key)
         @hostname = config[:hostname] if config[:hostname]
 
-        #Create a self-signed X509 certificate from the rsa_key (unencrypted)
+        # Create a self-signed X509 certificate from the rsa_key (unencrypted)
         cert = OpenSSL::X509::Certificate.new
         cert.version = 2
         cert.serial = Random.rand(65534) + 1 # 2 digit byte range random number for better security aspect
@@ -91,8 +92,8 @@ class Chef
         ef = OpenSSL::X509::ExtensionFactory.new
         ef.subject_certificate = cert
         ef.issuer_certificate = cert
-        cert.add_extension(ef.create_extension("subjectKeyIdentifier","hash",false))
-        cert.add_extension(ef.create_extension("authorityKeyIdentifier","keyid:always",false))
+        cert.add_extension(ef.create_extension("subjectKeyIdentifier", "hash", false))
+        cert.add_extension(ef.create_extension("authorityKeyIdentifier", "keyid:always", false))
         cert.add_extension(ef.create_extension("extendedKeyUsage", "1.3.6.1.5.5.7.3.1", false))
         cert.sign(rsa_key, OpenSSL::Digest::SHA1.new)
         @thumbprint = OpenSSL::Digest::SHA1.new(cert.to_der)
@@ -110,7 +111,7 @@ class Chef
       def certificates_already_exist?(file_path)
         certs_exists = false
         %w{pem pfx b64}.each do |extn|
-          if !Dir.glob("#{file_path}.*#{extn}").empty?
+          unless Dir.glob("#{file_path}.*#{extn}").empty?
             certs_exists = true
             break
           end
@@ -119,7 +120,7 @@ class Chef
         if certs_exists
           begin
             confirm("Do you really want to overwrite existing certificates")
-          rescue SystemExit   # Need to handle this as confirming with N/n raises SystemExit exception
+          rescue SystemExit # Need to handle this as confirming with N/n raises SystemExit exception
             exit!
           end
         end
@@ -129,7 +130,7 @@ class Chef
         STDOUT.sync = STDERR.sync = true
 
         # takes user specified first cli value as a destination file path for generated cert.
-        file_path = @name_args.empty? ? config[:output_file].sub(/\.(\w+)$/,'') : @name_args.first
+        file_path = @name_args.empty? ? config[:output_file].sub(/\.(\w+)$/, "") : @name_args.first
 
         # check if certs already exists at given file path
         certificates_already_exist? file_path
@@ -152,4 +153,3 @@ class Chef
     end
   end
 end
-