knife 18.2.7 → 18.3.0

data/lib/chef/knife/user_key_list.rb

@@ -1,73 +1,73 @@
-#
-# Author:: Tyler Cloke (tyler@chef.io)
-# Copyright:: Copyright (c) Chef Software Inc.
-# License:: Apache License, Version 2.0
-#
-# 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.
-#
-
-require_relative "../knife"
-require_relative "key_list_base"
-
-class Chef
-  class Knife
-    # Implements knife user key list using Chef::Knife::KeyList
-    # as a service class.
-    #
-    # @author Tyler Cloke
-    #
-    # @attr_reader [String] actor the name of the client that this key is for
-    class UserKeyList < Knife
-      include Chef::Knife::KeyListBase
-
-      banner "knife user key list USER (options)"
-
-      deps do
-        require_relative "key_list"
-      end
-
-      attr_reader :actor
-
-      def initialize(argv = [])
-        super(argv)
-        @service_object = nil
-      end
-
-      def run
-        apply_params!(@name_args)
-        service_object.run
-      end
-
-      def list_method
-        :list_by_user
-      end
-
-      def actor_missing_error
-        "You must specify a user name"
-      end
-
-      def service_object
-        @service_object ||= Chef::Knife::KeyList.new(@actor, list_method, ui, config)
-      end
-
-      def apply_params!(params)
-        @actor = params[0]
-        if @actor.nil?
-          show_usage
-          ui.fatal(actor_missing_error)
-          exit 1
-        end
-      end
-    end
-  end
-end
+#
+# Author:: Tyler Cloke (tyler@chef.io)
+# Copyright:: Copyright (c) Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require_relative "../knife"
+require_relative "key_list_base"
+
+class Chef
+  class Knife
+    # Implements knife user key list using Chef::Knife::KeyList
+    # as a service class.
+    #
+    # @author Tyler Cloke
+    #
+    # @attr_reader [String] actor the name of the client that this key is for
+    class UserKeyList < Knife
+      include Chef::Knife::KeyListBase
+
+      banner "knife user key list USER (options)"
+
+      deps do
+        require_relative "key_list"
+      end
+
+      attr_reader :actor
+
+      def initialize(argv = [])
+        super(argv)
+        @service_object = nil
+      end
+
+      def run
+        apply_params!(@name_args)
+        service_object.run
+      end
+
+      def list_method
+        :list_by_user
+      end
+
+      def actor_missing_error
+        "You must specify a user name"
+      end
+
+      def service_object
+        @service_object ||= Chef::Knife::KeyList.new(@actor, list_method, ui, config)
+      end
+
+      def apply_params!(params)
+        @actor = params[0]
+        if @actor.nil?
+          show_usage
+          ui.fatal(actor_missing_error)
+          exit 1
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/user_key_show.rb

@@ -1,80 +1,80 @@
-#
-# Author:: Tyler Cloke (tyler@chef.io)
-# Copyright:: Copyright (c) Chef Software Inc.
-# License:: Apache License, Version 2.0
-#
-# 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.
-#
-
-require_relative "../knife"
-
-class Chef
-  class Knife
-    # Implements knife user key show using Chef::Knife::KeyShow
-    # as a service class.
-    #
-    # @author Tyler Cloke
-    #
-    # @attr_reader [String] actor the name of the client that this key is for
-    class UserKeyShow < Knife
-      banner "knife user key show USER KEYNAME (options)"
-
-      deps do
-        require_relative "key_show"
-      end
-
-      attr_reader :actor
-
-      def initialize(argv = [])
-        super(argv)
-        @service_object = nil
-      end
-
-      def run
-        apply_params!(@name_args)
-        service_object.run
-      end
-
-      def load_method
-        :load_by_user
-      end
-
-      def actor_missing_error
-        "You must specify a user name"
-      end
-
-      def keyname_missing_error
-        "You must specify a key name"
-      end
-
-      def service_object
-        @service_object ||= Chef::Knife::KeyShow.new(@name, @actor, load_method, ui)
-      end
-
-      def apply_params!(params)
-        @actor = params[0]
-        if @actor.nil?
-          show_usage
-          ui.fatal(actor_missing_error)
-          exit 1
-        end
-        @name = params[1]
-        if @name.nil?
-          show_usage
-          ui.fatal(keyname_missing_error)
-          exit 1
-        end
-      end
-    end
-  end
-end
+#
+# Author:: Tyler Cloke (tyler@chef.io)
+# Copyright:: Copyright (c) Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require_relative "../knife"
+
+class Chef
+  class Knife
+    # Implements knife user key show using Chef::Knife::KeyShow
+    # as a service class.
+    #
+    # @author Tyler Cloke
+    #
+    # @attr_reader [String] actor the name of the client that this key is for
+    class UserKeyShow < Knife
+      banner "knife user key show USER KEYNAME (options)"
+
+      deps do
+        require_relative "key_show"
+      end
+
+      attr_reader :actor
+
+      def initialize(argv = [])
+        super(argv)
+        @service_object = nil
+      end
+
+      def run
+        apply_params!(@name_args)
+        service_object.run
+      end
+
+      def load_method
+        :load_by_user
+      end
+
+      def actor_missing_error
+        "You must specify a user name"
+      end
+
+      def keyname_missing_error
+        "You must specify a key name"
+      end
+
+      def service_object
+        @service_object ||= Chef::Knife::KeyShow.new(@name, @actor, load_method, ui)
+      end
+
+      def apply_params!(params)
+        @actor = params[0]
+        if @actor.nil?
+          show_usage
+          ui.fatal(actor_missing_error)
+          exit 1
+        end
+        @name = params[1]
+        if @name.nil?
+          show_usage
+          ui.fatal(keyname_missing_error)
+          exit 1
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/user_list.rb

@@ -1,43 +1,43 @@
-#
-# Author:: Steven Danna (<steve@chef.io>)
-# Copyright:: Copyright (c) Chef Software Inc.
-# License:: Apache License, Version 2.0
-#
-# 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.
-#
-
-require_relative "../knife"
-
-class Chef
-  class Knife
-    class UserList < Knife
-
-      deps do
-        # is not used there, only in knife.
-        require "chef/user_v1" unless defined?(Chef::UserV1)
-      end
-
-      banner "knife user list (options)"
-
-      option :with_uri,
-        short: "-w",
-        long: "--with-uri",
-        description: "Show corresponding URIs."
-
-      def run
-        output(format_list_for_display(Chef::UserV1.list))
-      end
-
-    end
-  end
-end
+#
+# Author:: Steven Danna (<steve@chef.io>)
+# Copyright:: Copyright (c) Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require_relative "../knife"
+
+class Chef
+  class Knife
+    class UserList < Knife
+
+      deps do
+        # is not used there, only in knife.
+        require "chef/user_v1" unless defined?(Chef::UserV1)
+      end
+
+      banner "knife user list (options)"
+
+      option :with_uri,
+        short: "-w",
+        long: "--with-uri",
+        description: "Show corresponding URIs."
+
+      def run
+        output(format_list_for_display(Chef::UserV1.list))
+      end
+
+    end
+  end
+end

data/lib/chef/knife/user_password.rb

@@ -1,70 +1,70 @@
-#
-# Author:: Tyler Cloke (<tyler@getchef.com>)
-# Copyright:: Copyright (c) Chef Software Inc.
-# License:: Apache License, Version 2.0
-#
-# 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.
-#
-
-class Chef
-  class Knife
-    class UserPassword < Knife
-      banner "knife user password USERNAME [PASSWORD | --enable-external-auth]"
-
-      option :enable_external_auth,
-        long: "--enable-external-auth",
-        short: "-e",
-        description: "Enable external authentication for this user (such as LDAP)"
-
-      def run
-        # check that correct number of args was passed, should be either
-        # USERNAME PASSWORD or USERNAME --enable-external-auth
-        #
-        # note that you can't pass USERNAME PASSWORD --enable-external-auth
-        unless (@name_args.length == 2 && !config[:enable_external_auth]) || (@name_args.length == 1 && config[:enable_external_auth])
-          show_usage
-          ui.fatal("You must pass two arguments")
-          ui.fatal("Note that --enable-external-auth cannot be passed with a password")
-          exit 1
-        end
-
-        user_name = @name_args[0]
-
-        # note that this will be nil if config[:enable_external_auth] is true
-        password = @name_args[1]
-
-        # since the API does not pass back whether recovery_authentication_enabled is
-        # true or false, there is no way of knowing if the user is using ldap or not,
-        # so we will update the user every time, instead of checking if we are actually
-        # changing anything before we PUT.
-        result = root_rest.get("users/#{user_name}")
-
-        result["password"] = password unless password.nil?
-
-        # if --enable-external-auth was passed, enable it, else disable it.
-        # there is never a situation where we would want to enable ldap
-        # AND change the password. changing the password means that the user
-        # wants to disable ldap and put user in recover (if they are using ldap).
-        result["recovery_authentication_enabled"] = !config[:enable_external_auth]
-
-        begin
-          root_rest.put("users/#{user_name}", result)
-        rescue => e
-          raise e
-        end
-
-        ui.msg("Authentication info updated for #{user_name}.")
-      end
-    end
-  end
-end
+#
+# Author:: Tyler Cloke (<tyler@getchef.com>)
+# Copyright:: Copyright (c) Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+class Chef
+  class Knife
+    class UserPassword < Knife
+      banner "knife user password USERNAME [PASSWORD | --enable-external-auth]"
+
+      option :enable_external_auth,
+        long: "--enable-external-auth",
+        short: "-e",
+        description: "Enable external authentication for this user (such as LDAP)"
+
+      def run
+        # check that correct number of args was passed, should be either
+        # USERNAME PASSWORD or USERNAME --enable-external-auth
+        #
+        # note that you can't pass USERNAME PASSWORD --enable-external-auth
+        unless (@name_args.length == 2 && !config[:enable_external_auth]) || (@name_args.length == 1 && config[:enable_external_auth])
+          show_usage
+          ui.fatal("You must pass two arguments")
+          ui.fatal("Note that --enable-external-auth cannot be passed with a password")
+          exit 1
+        end
+
+        user_name = @name_args[0]
+
+        # note that this will be nil if config[:enable_external_auth] is true
+        password = @name_args[1]
+
+        # since the API does not pass back whether recovery_authentication_enabled is
+        # true or false, there is no way of knowing if the user is using ldap or not,
+        # so we will update the user every time, instead of checking if we are actually
+        # changing anything before we PUT.
+        result = root_rest.get("users/#{user_name}")
+
+        result["password"] = password unless password.nil?
+
+        # if --enable-external-auth was passed, enable it, else disable it.
+        # there is never a situation where we would want to enable ldap
+        # AND change the password. changing the password means that the user
+        # wants to disable ldap and put user in recover (if they are using ldap).
+        result["recovery_authentication_enabled"] = !config[:enable_external_auth]
+
+        begin
+          root_rest.put("users/#{user_name}", result)
+        rescue => e
+          raise e
+        end
+
+        ui.msg("Authentication info updated for #{user_name}.")
+      end
+    end
+  end
+end

data/lib/chef/knife/user_reregister.rb

@@ -1,59 +1,59 @@
-#
-# Author:: Steven Danna (<steve@chef.io>)
-# Copyright:: Copyright (c) Chef Software Inc.
-# License:: Apache License, Version 2.0
-#
-# 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.
-#
-
-require_relative "../knife"
-
-class Chef
-  class Knife
-    class UserReregister < Knife
-
-      deps do
-        require "chef/user_v1" unless defined?(Chef::UserV1)
-      end
-
-      banner "knife user reregister USER (options)"
-
-      option :file,
-        short: "-f FILE",
-        long: "--file FILE",
-        description: "Write the private key to a file."
-
-      def run
-        @user_name = @name_args[0]
-
-        if @user_name.nil?
-          show_usage
-          ui.fatal("You must specify a user name")
-          exit 1
-        end
-
-        user = Chef::UserV1.load(@user_name)
-        user.reregister
-        Chef::Log.trace("Updated user data: #{user.inspect}")
-        key = user.private_key
-        if config[:file]
-          File.open(config[:file], "w") do |f|
-            f.print(key)
-          end
-        else
-          ui.msg key
-        end
-      end
-    end
-  end
-end
+#
+# Author:: Steven Danna (<steve@chef.io>)
+# Copyright:: Copyright (c) Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require_relative "../knife"
+
+class Chef
+  class Knife
+    class UserReregister < Knife
+
+      deps do
+        require "chef/user_v1" unless defined?(Chef::UserV1)
+      end
+
+      banner "knife user reregister USER (options)"
+
+      option :file,
+        short: "-f FILE",
+        long: "--file FILE",
+        description: "Write the private key to a file."
+
+      def run
+        @user_name = @name_args[0]
+
+        if @user_name.nil?
+          show_usage
+          ui.fatal("You must specify a user name")
+          exit 1
+        end
+
+        user = Chef::UserV1.load(@user_name)
+        user.reregister
+        Chef::Log.trace("Updated user data: #{user.inspect}")
+        key = user.private_key
+        if config[:file]
+          File.open(config[:file], "w") do |f|
+            f.print(key)
+          end
+        else
+          ui.msg key
+        end
+      end
+    end
+  end
+end