Class: SecretConfig::CLI

Inherits:
Object
  • Object
show all
Defined in:
lib/secret_config/cli.rb

Constant Summary collapse

PROVIDERS = 
%i[ssm].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(argv) ⇒ CLI

Returns a new instance of CLI.



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
 
# File 'lib/secret_config/cli.rb', line 26

def initialize(argv)
  @export       = false
  @import       = false
  @path         = nil
  @key_id       = nil
  @key_alias    = nil
  @region       = ENV["AWS_REGION"]
  @provider     = :ssm
  @random_size  = 32
  @no_filter    = false
  @prune        = false
  @replace      = false
  @copy_path    = nil
  @show_version = false
  @console      = false
  @diff         = false
  @set_key      = nil
  @set_value    = nil
  @fetch_key    = nil
  @delete_key   = nil
  @delete_path  = nil
  @diff_path    = nil
  @import_path  = nil

  if argv.empty?
    puts parser
    exit(-10)
  end
  parser.parse!(argv)
end

Instance Attribute Details

#console ⇒ Object (readonly)

Returns the value of attribute console.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def console
  @console
end

#copy_path ⇒ Object (readonly)

Returns the value of attribute copy_path.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def copy_path
  @copy_path
end

#delete_key ⇒ Object (readonly)

Returns the value of attribute delete_key.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def delete_key
  @delete_key
end

#delete_path ⇒ Object (readonly)

Returns the value of attribute delete_path.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def delete_path
  @delete_path
end

#diff ⇒ Object (readonly)

Returns the value of attribute diff.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def diff
  @diff
end

#diff_path ⇒ Object (readonly)

Returns the value of attribute diff_path.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def diff_path
  @diff_path
end

#export ⇒ Object (readonly)

Returns the value of attribute export.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def export
  @export
end

#fetch_key ⇒ Object (readonly)

Returns the value of attribute fetch_key.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def fetch_key
  @fetch_key
end

#import ⇒ Object (readonly)

Returns the value of attribute import.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def import
  @import
end

#import_path ⇒ Object (readonly)

Returns the value of attribute import_path.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def import_path
  @import_path
end

#key_alias ⇒ Object (readonly)

Returns the value of attribute key_alias.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def key_alias
  @key_alias
end

#key_id ⇒ Object (readonly)

Returns the value of attribute key_id.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def key_id
  @key_id
end

#no_filter ⇒ Object (readonly)

Returns the value of attribute no_filter.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def no_filter
  @no_filter
end

#overwrite ⇒ Object (readonly)

Returns the value of attribute overwrite.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def overwrite
  @overwrite
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def path
  @path
end

#provider ⇒ Object (readonly)

Returns the value of attribute provider.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def provider
  @provider
end

#prune ⇒ Object (readonly)

Returns the value of attribute prune.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def prune
  @prune
end

#random_size ⇒ Object (readonly)

Returns the value of attribute random_size.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def random_size
  @random_size
end

#region ⇒ Object (readonly)

Returns the value of attribute region.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def region
  @region
end

#set_key ⇒ Object (readonly)

Returns the value of attribute set_key.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def set_key
  @set_key
end

#set_value ⇒ Object (readonly)

Returns the value of attribute set_value.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def set_value
  @set_value
end

#show_version ⇒ Object (readonly)

Returns the value of attribute show_version.



11
12
13
 
# File 'lib/secret_config/cli.rb', line 11

def show_version
  @show_version
end

Class Method Details

.run!(argv) ⇒ Object 



22
23
24
 
# File 'lib/secret_config/cli.rb', line 22

def self.run!(argv)
  new(argv).run!
end

Instance Method Details

#parser ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/secret_config/cli.rb', line 86

def parser
  @parser ||= OptionParser.new do |opts|
    opts.banner = <<~BANNER
      Secret Config v#{VERSION}

        For more information, see: https://rocketjob.github.io/secret_config/

      secret_config [options]
    BANNER

    opts.on "-e", "--export [FILE_NAME]", "Export configuration to a file or stdout if no file_name supplied. --path SOURCE_PATH is required." do |file_name|
      @export = file_name || STDOUT
    end

    opts.on "-i", "--import [FILE_NAME]", "Import configuration from a file or stdin if no file_name supplied. --path TARGET_PATH is required." do |file_name|
      @import = file_name || STDIN
    end

    opts.on "--import-path SOURCE_PATH", "Import configuration from the configuration on another path. --path TARGET_PATH is required." do |path|
      @import_path = path
    end

    opts.on "--diff [FILE_NAME]", "Compare configuration from a file or stdin if no file_name supplied. --path TARGET_PATH is required." do |file_name|
      @diff = file_name
    end

    opts.on "--diff-path SOURCE_PATH", "Diff configuration with the configuration on another path. --path TARGET_PATH is required." do |path|
      @diff_path = path
    end

    opts.on "-s", "--set KEY=VALUE", "Set one key to value. Example: --set mysql/database=localhost" do |param|
      @set_key, @set_value = param.split("=")
      unless @set_key && @set_value
        raise(ArgumentError, "Supply key and value separated by '='. Example: --set mysql/database=localhost")
      end
    end

    opts.on "-f", "--fetch KEY", "Fetch the value for one setting. Example: --get mysql/database. " do |key|
      @fetch_key = key
    end

    opts.on "-d", "--delete KEY", "Delete one specific key. See --delete-path to delete all keys under a specific path " do |key|
      @delete_key = key
    end

    opts.on "-r", "--delete-path PATH", "Recursively delete all keys under the specified path.. " do |path|
      @delete_path = path
    end

    opts.on "-c", "--console", "Start interactive console." do
      @console = true
    end

    opts.on "-p", "--path PATH", "Path in central configuration to use." do |path|
      @path = path
    end

    opts.on "--provider PROVIDER", "Provider to use. [ssm | file]. Default: ssm" do |provider|
      @provider = provider.to_sym
    end

    opts.on "--no-filter", "Do not filter passwords and keys." do
      @no_filter = true
    end

    opts.on "--prune", "During import delete all existing keys for which there is no key in the import file. Only applies to --import and --import-path." do
      @prune = true
    end

    opts.on "--key_id KEY_ID", "Encrypt config settings with this AWS KMS key id. Default: AWS Default key." do |key_id|
      @key_id = key_id
    end

    opts.on "--key_alias KEY_ALIAS", "Encrypt config settings with this AWS KMS alias." do |key_alias|
      @key_alias = key_alias
    end

    opts.on "--region REGION", "AWS Region to use. Default: AWS_REGION env var." do |region|
      @region = region
    end

    opts.on "--random_size INTEGER", Integer, "Size to use when generating random values. Whenever #{RANDOM} is encountered during an import. Default: 32" do |random_size|
      @random_size = random_size
    end

    opts.on "-v", "--version", "Display Symmetric Encryption version." do
      @show_version = true
    end

    opts.on("-h", "--help", "Prints this help.") do
      puts opts
      exit
    end
  end
end

#run! ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/secret_config/cli.rb', line 57

def run!
  if show_version
    puts "Secret Config v#{VERSION}"
    puts "Region: #{region}"
  elsif console
    run_console
  elsif export
    run_export(export, path, filtered: !no_filter)
  elsif import
    run_import(import, path, prune)
  elsif import_path
    run_import_path(import_path, path, prune)
  elsif diff
    run_diff(diff, path)
  elsif diff_path
    run_diff_path(diff, path)
  elsif set_key
    run_set(set_key, set_value)
  elsif fetch_key
    run_fetch(fetch_key)
  elsif delete_key
    run_delete(delete_key)
  elsif delete_path
    run_delete_path(delete_path)
  else
    puts parser
  end
end