knife 18.2.7 → 18.3.0

data/lib/chef/knife/key_create.rb

@@ -1,112 +1,112 @@
-#
-# 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 "chef/key" unless defined?(Chef::Key)
-require "chef/json_compat" unless defined?(Chef::JSONCompat)
-require "chef/exceptions" unless defined?(Chef::Exceptions)
-
-class Chef
-  class Knife
-    # Service class for UserKeyCreate and ClientKeyCreate,
-    # Implements common functionality of knife [user | org client] key create.
-    #
-    # @author Tyler Cloke
-    #
-    # @attr_accessor [Hash] cli input, see UserKeyCreate and ClientKeyCreate for what could populate it
-    class KeyCreate
-
-      attr_accessor :config
-
-      def initialize(actor, actor_field_name, ui, config)
-        @actor = actor
-        @actor_field_name = actor_field_name
-        @ui = ui
-        @config = config
-      end
-
-      def public_key_or_key_name_error_msg
-        <<~EOS
-          You must pass either --public-key or --key-name, or both.
-          If you only pass --public-key, a key name will be generated from the fingerprint of your key.
-          If you only pass --key-name, a key pair will be generated by the server.
-        EOS
-      end
-
-      def edit_data(key)
-        @ui.edit_data(key)
-      end
-
-      def edit_hash(key)
-        @ui.edit_hash(key)
-      end
-
-      def display_info(input)
-        @ui.info(input)
-      end
-
-      def display_private_key(private_key)
-        @ui.msg(private_key)
-      end
-
-      def output_private_key_to_file(private_key)
-        File.open(@config[:file], "w") do |f|
-          f.print(private_key)
-        end
-      end
-
-      def create_key_from_hash(output)
-        Chef::Key.from_hash(output).create
-      end
-
-      def run
-        key = Chef::Key.new(@actor, @actor_field_name)
-        if !@config[:public_key] && !@config[:key_name]
-          raise Chef::Exceptions::KeyCommandInputError, public_key_or_key_name_error_msg
-        elsif !@config[:public_key]
-          key.create_key(true)
-        end
-
-        if @config[:public_key]
-          key.public_key(File.read(File.expand_path(@config[:public_key])))
-        end
-
-        if @config[:key_name]
-          key.name(@config[:key_name])
-        end
-
-        if @config[:expiration_date]
-          key.expiration_date(@config[:expiration_date])
-        else
-          key.expiration_date("infinity")
-        end
-
-        output = edit_hash(key)
-        key = create_key_from_hash(output)
-
-        display_info("Created key: #{key.name}")
-        if key.private_key
-          if @config[:file]
-            output_private_key_to_file(key.private_key)
-          else
-            display_private_key(key.private_key)
-          end
-        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 "chef/key" unless defined?(Chef::Key)
+require "chef/json_compat" unless defined?(Chef::JSONCompat)
+require "chef/exceptions" unless defined?(Chef::Exceptions)
+
+class Chef
+  class Knife
+    # Service class for UserKeyCreate and ClientKeyCreate,
+    # Implements common functionality of knife [user | org client] key create.
+    #
+    # @author Tyler Cloke
+    #
+    # @attr_accessor [Hash] cli input, see UserKeyCreate and ClientKeyCreate for what could populate it
+    class KeyCreate
+
+      attr_accessor :config
+
+      def initialize(actor, actor_field_name, ui, config)
+        @actor = actor
+        @actor_field_name = actor_field_name
+        @ui = ui
+        @config = config
+      end
+
+      def public_key_or_key_name_error_msg
+        <<~EOS
+          You must pass either --public-key or --key-name, or both.
+          If you only pass --public-key, a key name will be generated from the fingerprint of your key.
+          If you only pass --key-name, a key pair will be generated by the server.
+        EOS
+      end
+
+      def edit_data(key)
+        @ui.edit_data(key)
+      end
+
+      def edit_hash(key)
+        @ui.edit_hash(key)
+      end
+
+      def display_info(input)
+        @ui.info(input)
+      end
+
+      def display_private_key(private_key)
+        @ui.msg(private_key)
+      end
+
+      def output_private_key_to_file(private_key)
+        File.open(@config[:file], "w") do |f|
+          f.print(private_key)
+        end
+      end
+
+      def create_key_from_hash(output)
+        Chef::Key.from_hash(output).create
+      end
+
+      def run
+        key = Chef::Key.new(@actor, @actor_field_name)
+        if !@config[:public_key] && !@config[:key_name]
+          raise Chef::Exceptions::KeyCommandInputError, public_key_or_key_name_error_msg
+        elsif !@config[:public_key]
+          key.create_key(true)
+        end
+
+        if @config[:public_key]
+          key.public_key(File.read(File.expand_path(@config[:public_key])))
+        end
+
+        if @config[:key_name]
+          key.name(@config[:key_name])
+        end
+
+        if @config[:expiration_date]
+          key.expiration_date(@config[:expiration_date])
+        else
+          key.expiration_date("infinity")
+        end
+
+        output = edit_hash(key)
+        key = create_key_from_hash(output)
+
+        display_info("Created key: #{key.name}")
+        if key.private_key
+          if @config[:file]
+            output_private_key_to_file(key.private_key)
+          else
+            display_private_key(key.private_key)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/key_create_base.rb

@@ -1,50 +1,50 @@
-#
-# 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.
-#
-
-class Chef
-  class Knife
-    # Extendable module that class_eval's common options into UserKeyCreate and ClientKeyCreate
-    #
-    # @author Tyler Cloke
-    module KeyCreateBase
-      def self.included(includer)
-        includer.class_eval do
-          option :public_key,
-            short: "-p FILENAME",
-            long: "--public-key FILENAME",
-            description: "Public key for newly created key. If not passed, the server will create a key pair for you, but you must pass --key-name NAME in that case."
-
-          option :file,
-            short: "-f FILE",
-            long: "--file FILE",
-            description: "Write the private key to a file, if you requested the server to create one."
-
-          option :key_name,
-            short: "-k NAME",
-            long: "--key-name NAME",
-            description: "The name for your key. If you do not pass a name, you must pass --public-key, and the name will default to the fingerprint of the public key passed."
-
-          option :expiration_date,
-            short: "-e DATE",
-            long: "--expiration-date DATE",
-            description: "Optionally pass the expiration date for the key in ISO 8601 formatted string: YYYY-MM-DDTHH:MM:SSZ e.g. 2013-12-24T21:00:00Z. Defaults to infinity if not passed. UTC timezone assumed."
-        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.
+#
+
+class Chef
+  class Knife
+    # Extendable module that class_eval's common options into UserKeyCreate and ClientKeyCreate
+    #
+    # @author Tyler Cloke
+    module KeyCreateBase
+      def self.included(includer)
+        includer.class_eval do
+          option :public_key,
+            short: "-p FILENAME",
+            long: "--public-key FILENAME",
+            description: "Public key for newly created key. If not passed, the server will create a key pair for you, but you must pass --key-name NAME in that case."
+
+          option :file,
+            short: "-f FILE",
+            long: "--file FILE",
+            description: "Write the private key to a file, if you requested the server to create one."
+
+          option :key_name,
+            short: "-k NAME",
+            long: "--key-name NAME",
+            description: "The name for your key. If you do not pass a name, you must pass --public-key, and the name will default to the fingerprint of the public key passed."
+
+          option :expiration_date,
+            short: "-e DATE",
+            long: "--expiration-date DATE",
+            description: "Optionally pass the expiration date for the key in ISO 8601 formatted string: YYYY-MM-DDTHH:MM:SSZ e.g. 2013-12-24T21:00:00Z. Defaults to infinity if not passed. UTC timezone assumed."
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/key_delete.rb

@@ -1,55 +1,55 @@
-#
-# 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 "chef/key" unless defined?(Chef::Key)
-
-class Chef
-  class Knife
-    # Service class for UserKeyDelete and ClientKeyDelete, used to delete keys.
-    # Implements common functionality of knife [user | org client] key delete.
-    #
-    # @author Tyler Cloke
-    #
-    # @attr_accessor [Hash] cli input, see UserKeyDelete and ClientKeyDelete for what could populate it
-    class KeyDelete
-      def initialize(name, actor, actor_field_name, ui)
-        @name = name
-        @actor = actor
-        @actor_field_name = actor_field_name
-        @ui = ui
-      end
-
-      def confirm!
-        @ui.confirm("Do you really want to delete the key named #{@name} for the #{@actor_field_name} named #{@actor}")
-      end
-
-      def print_destroyed
-        @ui.info("Deleted key named #{@name} for the #{@actor_field_name} named #{@actor}")
-      end
-
-      def run
-        key = Chef::Key.new(@actor, @actor_field_name)
-        key.name(@name)
-        confirm!
-        key.destroy
-        print_destroyed
-      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 "chef/key" unless defined?(Chef::Key)
+
+class Chef
+  class Knife
+    # Service class for UserKeyDelete and ClientKeyDelete, used to delete keys.
+    # Implements common functionality of knife [user | org client] key delete.
+    #
+    # @author Tyler Cloke
+    #
+    # @attr_accessor [Hash] cli input, see UserKeyDelete and ClientKeyDelete for what could populate it
+    class KeyDelete
+      def initialize(name, actor, actor_field_name, ui)
+        @name = name
+        @actor = actor
+        @actor_field_name = actor_field_name
+        @ui = ui
+      end
+
+      def confirm!
+        @ui.confirm("Do you really want to delete the key named #{@name} for the #{@actor_field_name} named #{@actor}")
+      end
+
+      def print_destroyed
+        @ui.info("Deleted key named #{@name} for the #{@actor_field_name} named #{@actor}")
+      end
+
+      def run
+        key = Chef::Key.new(@actor, @actor_field_name)
+        key.name(@name)
+        confirm!
+        key.destroy
+        print_destroyed
+      end
+
+    end
+  end
+end

data/lib/chef/knife/key_edit.rb

@@ -1,118 +1,118 @@
-#
-# 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 "chef/key" unless defined?(Chef::Key)
-require "chef/json_compat" unless defined?(Chef::JSONCompat)
-require "chef/exceptions" unless defined?(Chef::Exceptions)
-
-class Chef
-  class Knife
-    # Service class for UserKeyEdit and ClientKeyEdit,
-    # Implements common functionality of knife [user | org client] key edit.
-    #
-    # @author Tyler Cloke
-    #
-    # @attr_accessor [Hash] cli input, see UserKeyEdit and ClientKeyEdit for what could populate it
-    class KeyEdit
-
-      attr_accessor :config
-
-      def initialize(original_name, actor, actor_field_name, ui, config)
-        @original_name = original_name
-        @actor = actor
-        @actor_field_name = actor_field_name
-        @ui = ui
-        @config = config
-      end
-
-      def public_key_and_create_key_error_msg
-        <<~EOS
-          You passed both --public-key and --create-key. Only pass one, or the other, or neither.
-          Do not pass either if you do not want to change the public_key field of your key.
-          Pass --public-key if you want to update the public_key field of your key from a specific public key.
-          Pass --create-key if you want the server to generate a new key and use that to update the public_key field of your key.
-        EOS
-      end
-
-      def edit_data(key)
-        @ui.edit_data(key)
-      end
-
-      def edit_hash(key)
-        @ui.edit_hash(key)
-      end
-
-      def display_info(input)
-        @ui.info(input)
-      end
-
-      def display_private_key(private_key)
-        @ui.msg(private_key)
-      end
-
-      def output_private_key_to_file(private_key)
-        File.open(@config[:file], "w") do |f|
-          f.print(private_key)
-        end
-      end
-
-      def update_key_from_hash(output)
-        Chef::Key.from_hash(output).update(@original_name)
-      end
-
-      def run
-        key = Chef::Key.new(@actor, @actor_field_name)
-        if @config[:public_key] && @config[:create_key]
-          raise Chef::Exceptions::KeyCommandInputError, public_key_and_create_key_error_msg
-        end
-
-        if @config[:create_key]
-          key.create_key(true)
-        end
-
-        if @config[:public_key]
-          key.public_key(File.read(File.expand_path(@config[:public_key])))
-        end
-
-        if @config[:key_name]
-          key.name(@config[:key_name])
-        else
-          key.name(@original_name)
-        end
-
-        if @config[:expiration_date]
-          key.expiration_date(@config[:expiration_date])
-        end
-
-        output = edit_hash(key)
-        key = update_key_from_hash(output)
-
-        to_display = "Updated key: #{key.name}"
-        to_display << " (formally #{@original_name})" if key.name != @original_name
-        display_info(to_display)
-        if key.private_key
-          if @config[:file]
-            output_private_key_to_file(key.private_key)
-          else
-            display_private_key(key.private_key)
-          end
-        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 "chef/key" unless defined?(Chef::Key)
+require "chef/json_compat" unless defined?(Chef::JSONCompat)
+require "chef/exceptions" unless defined?(Chef::Exceptions)
+
+class Chef
+  class Knife
+    # Service class for UserKeyEdit and ClientKeyEdit,
+    # Implements common functionality of knife [user | org client] key edit.
+    #
+    # @author Tyler Cloke
+    #
+    # @attr_accessor [Hash] cli input, see UserKeyEdit and ClientKeyEdit for what could populate it
+    class KeyEdit
+
+      attr_accessor :config
+
+      def initialize(original_name, actor, actor_field_name, ui, config)
+        @original_name = original_name
+        @actor = actor
+        @actor_field_name = actor_field_name
+        @ui = ui
+        @config = config
+      end
+
+      def public_key_and_create_key_error_msg
+        <<~EOS
+          You passed both --public-key and --create-key. Only pass one, or the other, or neither.
+          Do not pass either if you do not want to change the public_key field of your key.
+          Pass --public-key if you want to update the public_key field of your key from a specific public key.
+          Pass --create-key if you want the server to generate a new key and use that to update the public_key field of your key.
+        EOS
+      end
+
+      def edit_data(key)
+        @ui.edit_data(key)
+      end
+
+      def edit_hash(key)
+        @ui.edit_hash(key)
+      end
+
+      def display_info(input)
+        @ui.info(input)
+      end
+
+      def display_private_key(private_key)
+        @ui.msg(private_key)
+      end
+
+      def output_private_key_to_file(private_key)
+        File.open(@config[:file], "w") do |f|
+          f.print(private_key)
+        end
+      end
+
+      def update_key_from_hash(output)
+        Chef::Key.from_hash(output).update(@original_name)
+      end
+
+      def run
+        key = Chef::Key.new(@actor, @actor_field_name)
+        if @config[:public_key] && @config[:create_key]
+          raise Chef::Exceptions::KeyCommandInputError, public_key_and_create_key_error_msg
+        end
+
+        if @config[:create_key]
+          key.create_key(true)
+        end
+
+        if @config[:public_key]
+          key.public_key(File.read(File.expand_path(@config[:public_key])))
+        end
+
+        if @config[:key_name]
+          key.name(@config[:key_name])
+        else
+          key.name(@original_name)
+        end
+
+        if @config[:expiration_date]
+          key.expiration_date(@config[:expiration_date])
+        end
+
+        output = edit_hash(key)
+        key = update_key_from_hash(output)
+
+        to_display = "Updated key: #{key.name}"
+        to_display << " (formally #{@original_name})" if key.name != @original_name
+        display_info(to_display)
+        if key.private_key
+          if @config[:file]
+            output_private_key_to_file(key.private_key)
+          else
+            display_private_key(key.private_key)
+          end
+        end
+      end
+    end
+  end
+end