summaryrefslogtreecommitdiff
path: root/lib/chef/knife/key_edit_base.rb
blob: b5f38b5c5652260ed4814336ffca61511940b585 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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.
#

class Chef
  class Knife
    # Extendable module that class_eval's common options into UserKeyEdit and ClientKeyEdit
    #
    # @author Tyler Cloke
    module KeyEditBase
      def self.included(includer)
        includer.class_eval do
          option :public_key,
            short: "-p FILENAME",
            long: "--public-key FILENAME",
            description: "Replace the public_key field from a file on disk. If not passed, the public_key field will not change."

          option :create_key,
            short: "-c",
            long: "--create-key",
            description: "Replace the public_key field with a key generated by the server. The private key will be returned."

          option :file,
            short: "-f FILE",
            long: "--file FILE",
            description: "Write the private key to a file, if you requested the server to create one via --create-key."

          option :key_name,
            short: "-k NAME",
            long: "--key-name NAME",
            description: "The new name for your key. Pass if you wish to update the name field of your key."

          option :expiration_date,
            short: "-e DATE",
            long: "--expiration-date DATE",
            description: "Updates the expiration_date field of your key if passed. Pass in ISO 8601 fomatted string: YYYY-MM-DDTHH:MM:SSZ e.g. 2013-12-24T21:00:00Z or infinity. UTC timezone assumed."
        end
      end
    end
  end
end