inspec_tools 1.3.0 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab5612bdc60b04a6dd7d8fd5d975ff5a3f76c6725aaa6a5f5b839e18c1220938
-  data.tar.gz: e4cf768fa8cbebbe8c0a417cf103916026ca2083291f0bf78391ca23c5164410
+  metadata.gz: 4f6fb3f12bf3d1d567d33c0857ee766c293ebffea5c303f0b78d632f62d7fb6f
+  data.tar.gz: 28b8de24e295bd68f875322eea276b653bf9469612aa8ab14e3b9be27a02a9c7
 SHA512:
-  metadata.gz: cbd6887370c90566a49dbcb9a954dd530fdb196017fe3b164dd5dcb2bb49549eb6ce840cb17093411dc8bab9a3201b4fe2e8f9a1083785584fb5134fdbeeec97
-  data.tar.gz: 0db929f5f420127940b1ed1f90b37d9ea2dea25960d903eb56b65e707b960d6152d4eaeb95764d1c699ba7e0998d83c5bdded9798e6679ae6085a2fac98f50b0
+  metadata.gz: b8c3394b14798134b457678c801b1a9b328362eebf5a8832a70c2cf84d5a1b394a7fcca1a7c4245c3dd3dc7f4c2719f86b47993c75074601e148796bcf81e7e3
+  data.tar.gz: c34a859da673318768ac30c402492b3382903c214eb32497791e840c891acdab1d33a2ff4c76886609dbbb22f4df5ac9e793bee87d4bbf3a7edb5b377e0645dd

data/CHANGELOG.md

@@ -1,17 +1,92 @@
 # Change Log
 
-All notable changes to this project will be documented in this file.
-This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
+## [v1.3.4](https://github.com/mitre/inspec_tools/tree/v1.3.4) (2019-05-01)
+[Full Changelog](https://github.com/mitre/inspec_tools/compare/v1.1.6...v1.3.4)
 
-## [1.0.1]
-- Initial internal release.
+**Closed issues:**
 
-## [1.1.0]
-- This gem was refactored using the [CLI Template](https://github.com/tongueroo/cli-template), a generator tool that builds a starter CLI project.
-- Initial public release
+- Needed app is missing [\#49](https://github.com/mitre/inspec_tools/issues/49)
+- 2018   b79e5c3 [\#48](https://github.com/mitre/inspec_tools/issues/48)
 
-## [1.1.4]
-- Replaced Docsplit and pdf2text gems, which rely on command-line tools with pdf-reader gem, which does not
+**Merged pull requests:**
 
-## [1.1.5]
-- Updated gemspec to make some required gem versions more permissive
+- Metadata docs and tools [\#55](https://github.com/mitre/inspec_tools/pull/55) ([samcornwell](https://github.com/samcornwell))
+- Fix bugs introduced by \#51 \(STIGViewer PR\) [\#52](https://github.com/mitre/inspec_tools/pull/52) ([samcornwell](https://github.com/samcornwell))
+- Enhancements to meet working with STIGViewer as well as tracking some custom metadata when converting from xccdf2inspec and inspec2ckl [\#51](https://github.com/mitre/inspec_tools/pull/51) ([kevin-j-smith](https://github.com/kevin-j-smith))
+- Add modules summary, compliance [\#45](https://github.com/mitre/inspec_tools/pull/45) ([rx294](https://github.com/rx294))
+
+## [v1.1.6](https://github.com/mitre/inspec_tools/tree/v1.1.6) (2018-12-13)
+[Full Changelog](https://github.com/mitre/inspec_tools/compare/v1.1.5...v1.1.6)
+
+## [v1.1.5](https://github.com/mitre/inspec_tools/tree/v1.1.5) (2018-12-11)
+[Full Changelog](https://github.com/mitre/inspec_tools/compare/v1.1.2...v1.1.5)
+
+**Implemented enhancements:**
+
+- Add help for the gem usage and or ruby usage [\#7](https://github.com/mitre/inspec_tools/issues/7)
+- add sub-help command output to match README and document each function [\#6](https://github.com/mitre/inspec_tools/issues/6)
+
+**Fixed bugs:**
+
+- Add help for the gem usage and or ruby usage [\#7](https://github.com/mitre/inspec_tools/issues/7)
+- add sub-help command output to match README and document each function [\#6](https://github.com/mitre/inspec_tools/issues/6)
+
+**Closed issues:**
+
+- add rubocop integration or PRs [\#34](https://github.com/mitre/inspec_tools/issues/34)
+- Do we want to expose the --cci flag in the example as it is now not needed by default given it is in the /data directory [\#29](https://github.com/mitre/inspec_tools/issues/29)
+- fix the subcommands help so it works as expected [\#28](https://github.com/mitre/inspec_tools/issues/28)
+- THOR CLI: xccdf2inspec for example was giving me a hard time about the order of -x or --xccdf or --cci or -c and the order they were in - the docs on it seems to give two sets of directions [\#27](https://github.com/mitre/inspec_tools/issues/27)
+- do we have to do anything special for including CIS Benchmarks? [\#21](https://github.com/mitre/inspec_tools/issues/21)
+- clean up debug statements [\#20](https://github.com/mitre/inspec_tools/issues/20)
+- Give attribution for files in /data [\#19](https://github.com/mitre/inspec_tools/issues/19)
+- add copyright statements if necessary [\#15](https://github.com/mitre/inspec_tools/issues/15)
+- check /examples/sample\_json to see if any of the results are sensitive [\#14](https://github.com/mitre/inspec_tools/issues/14)
+
+**Merged pull requests:**
+
+- replaced docsplit with pdf-reader [\#43](https://github.com/mitre/inspec_tools/pull/43) ([robthew](https://github.com/robthew))
+- Updated remove dir statement [\#41](https://github.com/mitre/inspec_tools/pull/41) ([robthew](https://github.com/robthew))
+- Added appveyor config [\#40](https://github.com/mitre/inspec_tools/pull/40) ([robthew](https://github.com/robthew))
+- Travis test [\#39](https://github.com/mitre/inspec_tools/pull/39) ([robthew](https://github.com/robthew))
+- Add rubocop to the process [\#35](https://github.com/mitre/inspec_tools/pull/35) ([aaronlippold](https://github.com/aaronlippold))
+- \* added refernces to external data sources [\#30](https://github.com/mitre/inspec_tools/pull/30) ([aaronlippold](https://github.com/aaronlippold))
+
+## [v1.1.2](https://github.com/mitre/inspec_tools/tree/v1.1.2) (2018-11-08)
+[Full Changelog](https://github.com/mitre/inspec_tools/compare/v1.1.1...v1.1.2)
+
+## [v1.1.1](https://github.com/mitre/inspec_tools/tree/v1.1.1) (2018-11-08)
+[Full Changelog](https://github.com/mitre/inspec_tools/compare/v1.1.0...v1.1.1)
+
+## [v1.1.0](https://github.com/mitre/inspec_tools/tree/v1.1.0) (2018-11-08)
+[Full Changelog](https://github.com/mitre/inspec_tools/compare/v1.0.0...v1.1.0)
+
+**Fixed bugs:**
+
+- Remove unneeded `exe` dir if we are going to standardize on `bin`and update the `.gemspec` file [\#25](https://github.com/mitre/inspec_tools/issues/25)
+
+**Closed issues:**
+
+- when you When build the gem and install it - the command `inspec\_tools` does not seem to install into the path [\#26](https://github.com/mitre/inspec_tools/issues/26)
+- Add MITRE Copyright to the end of the README.md [\#23](https://github.com/mitre/inspec_tools/issues/23)
+- Update email addresses to MITRE addresses [\#18](https://github.com/mitre/inspec_tools/issues/18)
+- update readme.md [\#17](https://github.com/mitre/inspec_tools/issues/17)
+- update inspec\_tools.gemspec [\#16](https://github.com/mitre/inspec_tools/issues/16)
+- update license to apache 2.0 [\#13](https://github.com/mitre/inspec_tools/issues/13)
+- Separate Files defaults to \[False\] [\#10](https://github.com/mitre/inspec_tools/issues/10)
+- Rename repository to 'inspec\_tools' [\#9](https://github.com/mitre/inspec_tools/issues/9)
+
+**Merged pull requests:**
+
+- Cleanup Debug Statetements [\#12](https://github.com/mitre/inspec_tools/pull/12) ([yarick](https://github.com/yarick))
+- Change default separated\_files setting to default to true [\#11](https://github.com/mitre/inspec_tools/pull/11) ([yarick](https://github.com/yarick))
+- Cleanup [\#8](https://github.com/mitre/inspec_tools/pull/8) ([robthew](https://github.com/robthew))
+- Unification [\#5](https://github.com/mitre/inspec_tools/pull/5) ([dromazmj](https://github.com/dromazmj))
+- \* Adds functionality for inspec2csv [\#4](https://github.com/mitre/inspec_tools/pull/4) ([dromazmj](https://github.com/dromazmj))
+- Md/pdf [\#3](https://github.com/mitre/inspec_tools/pull/3) ([dromazmj](https://github.com/dromazmj))
+- Md/csv2inspec [\#2](https://github.com/mitre/inspec_tools/pull/2) ([dromazmj](https://github.com/dromazmj))
+- Writes code in the inspec util to output an inspec json to a directory [\#1](https://github.com/mitre/inspec_tools/pull/1) ([dromazmj](https://github.com/dromazmj))
+
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/README.md

@@ -4,6 +4,9 @@ InspecTools supplies several CLI tools to convert to and from InSpec format.
 
 The inspec_tools support the following modules:
 
+- generate_map
+- generate_ckl_metadata
+- generate_inspec_metadata
 - compliance
 - summary
 - csv2inspec
@@ -54,6 +57,30 @@ xccdf_results = tool.to_xccdf(attribs_json)
 On the Command Line, `inspec_tools help` will print a listing of all the command with a short description.
 For detailed help on any command, run `inspec_tools help [COMMAND]`. Help can also be called with the `-h, --help` flags after any command, like `inspec_tools xccdf2inspec -h`.
 
+## generate_map
+
+This command will generate a `mapping.xml` file that can be passed in to the `csv2inspec` command with the `-m` option.
+
+```
+USAGE: inspec_tools generate_map
+```
+
+## generate_ckl_metadata
+
+This command will generate a `metadata.json` file that can be passed in to the `inspec2ckl` command with the `-m` option.
+
+```
+USAGE: inspec_tools generate_ckl_metadata
+```
+
+## generate_inspec_metadata
+
+This command will generate a `metadata.json` file that can be passed in to the `xccdf2inspec` command with the `-m` option.
+
+```
+USAGE: inspec_tools generate_inspec_metadata
+```
+
 ## compliance
 
 compliance parses an inspec results json to check if the compliance level meets a specified threshold.
@@ -129,6 +156,7 @@ FLAGS:
 	-o --output <profile-path>         : path to the InSpec profile output (default: profile) [optional]
 	-f --format [ruby | hash]          : the format you would like (default: ruby) [optional]
 	-s --separate-files [true | false] : output the resulting controls as one or mutiple files (default: true) [optional]
+	-m --metadata <metadata-json>      : path to json file with additional metadata for the inspec.yml file [optional]
 	-r --replace-tags <array>          : A case-sensitive, comma separated list to replace tags with a $ if found in a group rules description tag [optional]
 
 example: inspec_tools xccdf2inspec -x xccdf_file.xml -a attributes.yml -o myprofile -f ruby -s false
@@ -168,14 +196,6 @@ FLAGS:
 example: inspec_tools csv2inspec -c stig.csv -m map.yml -o mydir -f ruby -s true   # To map stig.csv to InSpec via map.yml
 ```
 
-### generate_map
-
-This command will generate a `mapping.xml` file that can be passed in to the `csv2inspec` command with the `--m` option.
-
-```
-USAGE: inspec_tools generate_map
-```
-
 ## inspec2csv
 
 Convert an InSpec json to a csv file
@@ -201,6 +221,7 @@ USAGE: inspec_tools inspec2ckl [OPTIONS] -j <inspec-json> -o <results-ckl>
 FLAGS:
 	-j --inspec-json <inspec-json> : path to InSpec results json file
 	-o --output <results-ckl>      : path to output checklist file
+	-m --metadata <metadata-json>  : path to json file with additional metadata for the checklist file [optional]
 	-V --verbose                   : verbose run [optional]
 
 example: inspec_tools inspec2ckl -j results.json -o output.ckl

data/lib/inspec_tools/cli.rb

@@ -121,6 +121,45 @@ module InspecTools
       myfile.close
     end
 
+    desc 'generate_ckl_metadata', 'Generate metadata file that can be passed to inspec2ckl'
+    def generate_ckl_metadata
+      metadata = {}
+
+      metadata['stigid'] = ask('STID ID: ')
+      metadata['role'] = ask('Role: ')
+      metadata['type'] = ask('Type: ')
+      metadata['hostname'] = ask('Hostname: ')
+      metadata['ip'] = ask('IP Address: ')
+      metadata['mac'] = ask('MAC Address: ')
+      metadata['fqdn'] = ask('FQDN: ')
+      metadata['tech_area'] = ask('Tech Area: ')
+      metadata['target_key'] = ask('Target Key: ')
+      metadata['web_or_database'] = ask('Web or Database: ')
+      metadata['web_db_site'] = ask('Web DB Site: ')
+      metadata['web_db_instance'] = ask('Web DB Instance: ')
+
+      metadata.delete_if { |_key, value| value.empty? }
+      File.open('metadata.json', 'w') do |f|
+        f.write(metadata.to_json)
+      end
+    end
+
+    desc 'generate_inspec_metadata', 'Generate mapping file that can be passed to xccdf2inspec'
+    def generate_inspec_metadata
+      metadata = {}
+
+      metadata['maintainer'] = ask('Maintainer: ')
+      metadata['copyright'] = ask('Copyright: ')
+      metadata['copyright_email'] = ask('Copyright Email: ')
+      metadata['license'] = ask('License: ')
+      metadata['version'] = ask('Version: ')
+
+      metadata.delete_if { |_key, value| value.empty? }
+      File.open('metadata.json', 'w') do |f|
+        f.write(metadata.to_json)
+      end
+    end
+
     desc 'summary', 'summary parses an inspec results json to create a summary json'
     long_desc Help.text(:summary)
     option :inspec_json, required: true, aliases: '-j'

data/lib/inspec_tools/inspec.rb

@@ -184,7 +184,7 @@ module InspecTools
       asset.host_fqdn = generate_fqdn
       asset.tech_area = !@metadata['tech_area'].nil? ? @metadata['tech_area'] : ''
       asset.target_key = !@metadata['target_key'].nil? ? @metadata['target_key'] : ''
-      asset.web_or_database = !@metadata['web_or_databae'].nil? ? @metadata['web_or_database'] : '0'
+      asset.web_or_database = !@metadata['web_or_database'].nil? ? @metadata['web_or_database'] : '0'
       asset.web_db_site = !@metadata['web_db_site'].nil? ? @metadata['web_db_site'] : ''
       asset.web_db_instance = !@metadata['web_db_instance'].nil? ? @metadata['web_db_instance'] : ''
       asset

data/lib/inspec_tools/version.rb

@@ -1,3 +1,3 @@
 module InspecTools
-  VERSION = '1.3.0'.freeze
+  VERSION = '1.3.5'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inspec_tools
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.5
 platform: ruby
 authors:
 - Robert Thew
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-17 00:00:00.000000000 Z
+date: 2019-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize