abide_dev_utils 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+
3
+ module AbideDevUtils
4
+ module Utils
5
+ def self.deep_copy(hash_obj)
6
+ Marshal.load(Marshal.dump(hash_obj))
7
+ end
8
+ end
9
+ end
@@ -0,0 +1,31 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'abide_dev_utils/errors'
4
+
5
+ module AbideDevUtils
6
+ module Validate
7
+ def self.filesystem_path(path)
8
+ raise AbideDevUtils::Errors::FileNotFoundError, path unless File.exist?(path)
9
+ end
10
+
11
+ def self.file(path)
12
+ filesystem_path(path)
13
+ raise AbideDevUtils::Errors::PathNotFileError, path unless File.file?(path)
14
+ end
15
+
16
+ def self.directory(path)
17
+ filesystem_path(path)
18
+ raise AbideDevUtils::Errors::PathNotDirectoryError, path unless File.directory?(path)
19
+ end
20
+
21
+ def self.not_empty(thing, msg)
22
+ raise AbideDevUtils::Errors::ObjectEmptyError, msg if thing.empty?
23
+ end
24
+
25
+ def self.hashable(obj)
26
+ return if obj.respond_to?(:to_hash) || obj.respond_to?(:to_h)
27
+
28
+ raise AbideDevUtils::Errors::NotHashableError, obj
29
+ end
30
+ end
31
+ end
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module AbideDevUtils
4
+ VERSION = "0.1.0"
5
+ end
@@ -0,0 +1,24 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'abide_dev_utils/output'
4
+ require 'abide_dev_utils/validate'
5
+ require 'abide_dev_utils/xccdf/cis'
6
+
7
+ module AbideDevUtils
8
+ module XCCDF
9
+ def self.parse(xccdf_file)
10
+ AbideDevUtils::Validate.file(xccdf_file)
11
+ Nokogiri.XML(File.open(xccdf_file))
12
+ end
13
+
14
+ def self.to_hiera(xccdf_file, opts = {})
15
+ type = opts.fetch(:type, 'cis')
16
+ case type.downcase
17
+ when 'cis'
18
+ AbideDevUtils::XCCDF::CIS::Hiera.new(xccdf_file, parent_key_prefix: opts[:parent_key_prefix])
19
+ else
20
+ AbideDevUtils::Output.simple("XCCDF type #{type} is unsupported!")
21
+ end
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,3 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'abide_dev_utils/xccdf/cis/hiera'
@@ -0,0 +1,138 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'yaml'
4
+ require 'nokogiri'
5
+ require 'abide_dev_utils/errors'
6
+
7
+ module AbideDevUtils
8
+ module XCCDF
9
+ module CIS
10
+ # Creates a Hiera structure by parsing a CIS XCCDF benchmark
11
+ # @!attribute [r] title
12
+ # @!attribute [r] version
13
+ # @!attribute [r] yaml_title
14
+ class Hiera
15
+ CONTROL_PREFIX = /^[\d.]+_/.freeze
16
+ XPATHS = {
17
+ benchmark: {
18
+ all: 'xccdf:Benchmark',
19
+ title: 'xccdf:Benchmark/xccdf:title',
20
+ version: 'xccdf:Benchmark/xccdf:version'
21
+ },
22
+ profiles: {
23
+ all: 'xccdf:Benchmark/xccdf:Profile',
24
+ relative_title: './xccdf:title',
25
+ relative_select: './xccdf:select'
26
+ }
27
+ }.freeze
28
+
29
+ attr_reader :title, :version
30
+
31
+ # Creates a new Hiera object
32
+ # @param xccdf_file [String] path to an XCCDF file
33
+ # @param parent_key_prefix [String] a string to be prepended to the
34
+ # top-level key in the Hiera structure. Useful for namespacing
35
+ # the top-level key.
36
+ def initialize(xccdf_file, parent_key_prefix: nil)
37
+ @doc = parse(xccdf_file)
38
+ @title = xpath(XPATHS[:benchmark][:title]).children.to_s
39
+ @version = xpath(XPATHS[:benchmark][:version]).children.to_s
40
+ @profiles = xpath(XPATHS[:profiles][:all])
41
+ @parent_key = make_parent_key(@doc, parent_key_prefix)
42
+ @hash = make_hash(@doc, @parent_key)
43
+ end
44
+
45
+ def yaml_title
46
+ normalize_str(@title)
47
+ end
48
+
49
+ # Convert the Hiera object to a hash
50
+ # @return [Hash]
51
+ def to_h
52
+ @hash
53
+ end
54
+
55
+ # Convert the Hiera object to a string
56
+ # @return [String]
57
+ def to_s
58
+ @hash.inspect
59
+ end
60
+
61
+ # Convert the Hiera object to YAML string
62
+ # @return [String] YAML-formatted string
63
+ def to_yaml
64
+ yh = @hash[@parent_key.to_sym].transform_keys do |k|
65
+ "#{@parent_key}::#{k}"
66
+ end
67
+ yh.to_yaml
68
+ end
69
+
70
+ # If a method gets called on the Hiera object which is not defined,
71
+ # this sends that method call to hash, then doc, then super.
72
+ def method_missing(method, *args, &block)
73
+ return true if ['exist?', 'exists?'].include?(method.to_s)
74
+
75
+ return @hash.send(method, *args, &block) if @hash.respond_to?(method)
76
+
77
+ return @doc.send(method, *args, &block) if @doc.respond_to?(method)
78
+
79
+ super(method, *args, &block)
80
+ end
81
+
82
+ # Checks the respond_to? of hash, doc, or super
83
+ def respond_to_missing?(method_name, include_private = false)
84
+ return true if ['exist?', 'exists?'].include?(method_name.to_s)
85
+
86
+ @hash || @doc || super
87
+ end
88
+
89
+ private
90
+
91
+ attr_accessor :doc, :parent_key, :hash, :profiles
92
+
93
+ def parse(xccdf_file)
94
+ raise AbideDevUtils::Errors::FileNotFoundError, xccdf_file unless File.file?(xccdf_file)
95
+
96
+ Nokogiri.XML(File.open(xccdf_file))
97
+ end
98
+
99
+ def make_hash(doc, parent_key)
100
+ hash = { parent_key.to_sym => { title: @title, version: @version } }
101
+ profiles = doc.xpath('xccdf:Benchmark/xccdf:Profile')
102
+ profiles.each do |p|
103
+ title = normalize_profile_name(p.xpath('./xccdf:title').children.to_s)
104
+ hash[parent_key.to_sym][title.to_sym] = []
105
+ selects = p.xpath('./xccdf:select')
106
+ selects.each do |s|
107
+ hash[parent_key.to_sym][title.to_sym] << normalize_ctrl_name(s['idref'].to_s)
108
+ end
109
+ end
110
+ hash
111
+ end
112
+
113
+ def normalize_str(str)
114
+ str.delete('-').gsub(/\s/, '_').downcase
115
+ end
116
+
117
+ def normalize_profile_name(prof)
118
+ normalize_str("profile_#{prof}")
119
+ end
120
+
121
+ def normalize_ctrl_name(ctrl)
122
+ new_ctrl = ctrl.split('_rule_')[-1].gsub(CONTROL_PREFIX, '')
123
+ normalize_str(new_ctrl.gsub(/\./, '_'))
124
+ end
125
+
126
+ def make_parent_key(doc, prefix)
127
+ doc_title = normalize_str(doc.xpath(XPATHS[:benchmark][:title]).children.to_s)
128
+ if prefix.nil?
129
+ doc_title
130
+ else
131
+ sepped_prefix = prefix.end_with?('::') ? prefix : "#{prefix}::"
132
+ "#{sepped_prefix.chomp}#{doc_title}"
133
+ end
134
+ end
135
+ end
136
+ end
137
+ end
138
+ end
metadata ADDED
@@ -0,0 +1,266 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: abide_dev_utils
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Heston Snodgrass
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2021-01-22 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '2.0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '2.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: nokogiri
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.11'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.11'
41
+ - !ruby/object:Gem::Dependency
42
+ name: cmdparse
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: puppet
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "<="
60
+ - !ruby/object:Gem::Version
61
+ version: '6.19'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "<="
67
+ - !ruby/object:Gem::Version
68
+ version: '6.19'
69
+ - !ruby/object:Gem::Dependency
70
+ name: jira-ruby
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '2.1'
76
+ type: :runtime
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '2.1'
83
+ - !ruby/object:Gem::Dependency
84
+ name: ruby-progressbar
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '1.11'
90
+ type: :runtime
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '1.11'
97
+ - !ruby/object:Gem::Dependency
98
+ name: rspec
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: '3.10'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '3.10'
111
+ - !ruby/object:Gem::Dependency
112
+ name: rubocop
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '1.8'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: '1.8'
125
+ - !ruby/object:Gem::Dependency
126
+ name: rubocop-rspec
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: '2.1'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - "~>"
137
+ - !ruby/object:Gem::Version
138
+ version: '2.1'
139
+ - !ruby/object:Gem::Dependency
140
+ name: rubocop-ast
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - "~>"
144
+ - !ruby/object:Gem::Version
145
+ version: '1.4'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - "~>"
151
+ - !ruby/object:Gem::Version
152
+ version: '1.4'
153
+ - !ruby/object:Gem::Dependency
154
+ name: rubocop-performance
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - "~>"
158
+ - !ruby/object:Gem::Version
159
+ version: '1.9'
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - "~>"
165
+ - !ruby/object:Gem::Version
166
+ version: '1.9'
167
+ - !ruby/object:Gem::Dependency
168
+ name: rubocop-i18n
169
+ requirement: !ruby/object:Gem::Requirement
170
+ requirements:
171
+ - - "~>"
172
+ - !ruby/object:Gem::Version
173
+ version: '3.0'
174
+ type: :development
175
+ prerelease: false
176
+ version_requirements: !ruby/object:Gem::Requirement
177
+ requirements:
178
+ - - "~>"
179
+ - !ruby/object:Gem::Version
180
+ version: '3.0'
181
+ - !ruby/object:Gem::Dependency
182
+ name: fast_gettext
183
+ requirement: !ruby/object:Gem::Requirement
184
+ requirements:
185
+ - - "~>"
186
+ - !ruby/object:Gem::Version
187
+ version: '1.1'
188
+ type: :development
189
+ prerelease: false
190
+ version_requirements: !ruby/object:Gem::Requirement
191
+ requirements:
192
+ - - "~>"
193
+ - !ruby/object:Gem::Version
194
+ version: '1.1'
195
+ description: Provides a CLI with helpful utilities for developing Abide
196
+ email:
197
+ - hsnodgrass3@gmail.com
198
+ executables:
199
+ - abide
200
+ extensions: []
201
+ extra_rdoc_files: []
202
+ files:
203
+ - ".gitignore"
204
+ - ".rspec"
205
+ - ".rubocop.yml"
206
+ - ".rubocop_todo.yml"
207
+ - Gemfile
208
+ - LICENSE.txt
209
+ - README.md
210
+ - Rakefile
211
+ - abide_dev_utils.gemspec
212
+ - bin/abide.rb
213
+ - bin/console
214
+ - bin/setup
215
+ - exe/abide
216
+ - lib/abide_dev_utils.rb
217
+ - lib/abide_dev_utils/cli.rb
218
+ - lib/abide_dev_utils/cli/jira.rb
219
+ - lib/abide_dev_utils/cli/puppet.rb
220
+ - lib/abide_dev_utils/cli/test.rb
221
+ - lib/abide_dev_utils/cli/xccdf.rb
222
+ - lib/abide_dev_utils/config.rb
223
+ - lib/abide_dev_utils/constants.rb
224
+ - lib/abide_dev_utils/errors.rb
225
+ - lib/abide_dev_utils/errors/base.rb
226
+ - lib/abide_dev_utils/errors/general.rb
227
+ - lib/abide_dev_utils/errors/jira.rb
228
+ - lib/abide_dev_utils/errors/xccdf.rb
229
+ - lib/abide_dev_utils/files.rb
230
+ - lib/abide_dev_utils/jira.rb
231
+ - lib/abide_dev_utils/output.rb
232
+ - lib/abide_dev_utils/ppt.rb
233
+ - lib/abide_dev_utils/prompt.rb
234
+ - lib/abide_dev_utils/utils/general.rb
235
+ - lib/abide_dev_utils/validate.rb
236
+ - lib/abide_dev_utils/version.rb
237
+ - lib/abide_dev_utils/xccdf.rb
238
+ - lib/abide_dev_utils/xccdf/cis.rb
239
+ - lib/abide_dev_utils/xccdf/cis/hiera.rb
240
+ homepage: https://github.com/hsnodgrass/abide_dev_utils
241
+ licenses:
242
+ - MIT
243
+ metadata:
244
+ homepage_uri: https://github.com/hsnodgrass/abide_dev_utils
245
+ source_code_uri: https://github.com/hsnodgrass/abide_dev_utils
246
+ changelog_uri: https://github.com/hsnodgrass/abide_dev_utils
247
+ post_install_message:
248
+ rdoc_options: []
249
+ require_paths:
250
+ - lib
251
+ required_ruby_version: !ruby/object:Gem::Requirement
252
+ requirements:
253
+ - - ">="
254
+ - !ruby/object:Gem::Version
255
+ version: 2.5.0
256
+ required_rubygems_version: !ruby/object:Gem::Requirement
257
+ requirements:
258
+ - - ">="
259
+ - !ruby/object:Gem::Version
260
+ version: '0'
261
+ requirements: []
262
+ rubygems_version: 3.0.9
263
+ signing_key:
264
+ specification_version: 4
265
+ summary: Helper utilities for developing Abide
266
+ test_files: []