heimdall_tools 1.3.20 → 1.3.22.5.g8e14377
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +17 -1
- data/README.md +62 -32
- data/lib/heimdall_tools/version.rb +6 -2
- metadata +18 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 34e960e8080495375aa4778b8fbaf77809725d322eeaa36b31b01a6e702e9a87
|
|
4
|
+
data.tar.gz: d07b44069af91999c40f044a89a2092ee846f4b939a73f59e013213df4331d2f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 747c9337d29927aa4c2cac16a8b9af2a2b6a8652b21fb4c8b07b961dce3dde84a049690c1e1267a64b22f65bca9dd1a3bf60b682e93504eaafc79ca05a730158
|
|
7
|
+
data.tar.gz: 6365360fca354bc1f9d646fa923e2e719a405d630eb2a75a3fd5c466a3daf4bc78df1b0fadc9bb41a950960544ebd99d55548ba1a0d03af0cc704a3a82c34c30
|
data/CHANGELOG.md
CHANGED
|
@@ -2,7 +2,23 @@
|
|
|
2
2
|
|
|
3
3
|
## [Unreleased](https://github.com/mitre/heimdall_tools/tree/HEAD)
|
|
4
4
|
|
|
5
|
-
[Full Changelog](https://github.com/mitre/heimdall_tools/compare/v1.3.
|
|
5
|
+
[Full Changelog](https://github.com/mitre/heimdall_tools/compare/v1.3.22...HEAD)
|
|
6
|
+
|
|
7
|
+
**Merged pull requests:**
|
|
8
|
+
|
|
9
|
+
- Restructure workflow for publishing gem [\#37](https://github.com/mitre/heimdall_tools/pull/37) ([rbclark](https://github.com/rbclark))
|
|
10
|
+
|
|
11
|
+
## [v1.3.22](https://github.com/mitre/heimdall_tools/tree/v1.3.22) (2020-03-31)
|
|
12
|
+
|
|
13
|
+
[Full Changelog](https://github.com/mitre/heimdall_tools/compare/v1.3.21...v1.3.22)
|
|
14
|
+
|
|
15
|
+
## [v1.3.21](https://github.com/mitre/heimdall_tools/tree/v1.3.21) (2020-03-31)
|
|
16
|
+
|
|
17
|
+
[Full Changelog](https://github.com/mitre/heimdall_tools/compare/v1.3.20...v1.3.21)
|
|
18
|
+
|
|
19
|
+
## [v1.3.20](https://github.com/mitre/heimdall_tools/tree/v1.3.20) (2020-03-30)
|
|
20
|
+
|
|
21
|
+
[Full Changelog](https://github.com/mitre/heimdall_tools/compare/v1.3.19...v1.3.20)
|
|
6
22
|
|
|
7
23
|
**Fixed bugs:**
|
|
8
24
|
|
data/README.md
CHANGED
|
@@ -1,34 +1,54 @@
|
|
|
1
1
|
# Heimdall Tools
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
|
|
4
4
|
|
|
5
|
-
|
|
6
6
|
|
|
7
|
-
HeimdallTools supplies several methods to convert output from various tools to "Heimdall Data Format"(HDF) format to be viewable in Heimdall. The converters
|
|
7
|
+
HeimdallTools supplies several methods to convert output from various tools to "Heimdall Data Format"(HDF) format to be viewable in Heimdall. The current converters are:
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
9
|
+
- **sonarqube_mapper** - open-source static code analysis tool
|
|
10
|
+
- **fortify_mapper** - commercial static code analysis tool
|
|
11
|
+
- **zap_mapper** - OWASP ZAP - open-source dynamic code analysis tool
|
|
12
12
|
|
|
13
|
-
#
|
|
13
|
+
# Prerequisites
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Ruby 2.4 or higher (check using "ruby -v")
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
gem 'heimdall_tools', :git => "https://github.com/mitre/heimdall_tools"
|
|
19
|
-
```
|
|
17
|
+
If installation of Ruby is required, perform these steps:
|
|
20
18
|
|
|
21
|
-
|
|
19
|
+
## Linux Installation of Ruby
|
|
22
20
|
|
|
23
|
-
|
|
24
|
-
$ bundle
|
|
25
|
-
```
|
|
21
|
+
### Installation on RHEL-based systems
|
|
26
22
|
|
|
27
|
-
|
|
23
|
+
To install Ruby using RVM (Ruby Version Manager):
|
|
28
24
|
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
25
|
+
`sudo yum install curl gpg gcc gcc-c++ make patch autoconf automake bison libffi-devel libtool patch readline-devel sqlite-devel zlib-devel openssl-devel`
|
|
26
|
+
|
|
27
|
+
`sudo gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB`
|
|
28
|
+
|
|
29
|
+
`curl -sSL https://get.rvm.io | bash -s stable`
|
|
30
|
+
|
|
31
|
+
`source ~/.rvm/scripts/rvm`
|
|
32
|
+
|
|
33
|
+
Finally, install the latest version of Ruby (stable), currently 2.6.x:
|
|
34
|
+
|
|
35
|
+
`rvm install 2.6`
|
|
36
|
+
|
|
37
|
+
`rvm use 2.6 --default`
|
|
38
|
+
|
|
39
|
+
Verify the installed version number:
|
|
40
|
+
|
|
41
|
+
`ruby -v`
|
|
42
|
+
|
|
43
|
+
`ruby 2.6.5p114 (2019-10-01 revision 67812) [x86_64-linux]`
|
|
44
|
+
|
|
45
|
+
### Installation on Ubuntu-based systems
|
|
46
|
+
|
|
47
|
+
<https://github.com/rvm/ubuntu_rvm>
|
|
48
|
+
|
|
49
|
+
# Installation of Heimdall Tools:
|
|
50
|
+
|
|
51
|
+
`gem install heimdall_tools`
|
|
32
52
|
|
|
33
53
|
## Command line Usage
|
|
34
54
|
|
|
@@ -49,7 +69,7 @@ FLAGS:
|
|
|
49
69
|
-o --output <scan-results> : path to output scan-results json.
|
|
50
70
|
-V --verbose : verbose run [optional].
|
|
51
71
|
|
|
52
|
-
example:
|
|
72
|
+
example:
|
|
53
73
|
|
|
54
74
|
heimdall_tools sonarqube_mapper -n sonar_project_key -u http://sonar:9000/api -o scan_results.json
|
|
55
75
|
|
|
@@ -87,7 +107,7 @@ FLAGS:
|
|
|
87
107
|
example: heimdall_tools zap_mapper -j zap_results.json -n site_name -o scan_results.json
|
|
88
108
|
```
|
|
89
109
|
|
|
90
|
-
## version
|
|
110
|
+
## version
|
|
91
111
|
|
|
92
112
|
Prints out the gem version
|
|
93
113
|
|
|
@@ -97,9 +117,9 @@ USAGE: heimdall_tools version
|
|
|
97
117
|
|
|
98
118
|
# Development
|
|
99
119
|
|
|
100
|
-
## Submitting a PR
|
|
120
|
+
## Submitting a PR
|
|
101
121
|
|
|
102
|
-
### A complete PR should include 7 core elements:
|
|
122
|
+
### A complete PR should include 7 core elements:
|
|
103
123
|
|
|
104
124
|
- A signed PR ( aka `git commit -a -s` )
|
|
105
125
|
- Code for the new functionality
|
|
@@ -110,7 +130,7 @@ USAGE: heimdall_tools version
|
|
|
110
130
|
- Scripts / Scaffolding code for the Example / Template files ( `generate_map` is an example )
|
|
111
131
|
- Example Output of the new functionality if it produces an artifact
|
|
112
132
|
|
|
113
|
-
### Overview of our PR process
|
|
133
|
+
### Overview of our PR process
|
|
114
134
|
|
|
115
135
|
1. open an issue on the main inspec_tools website noting the issues your PR will address
|
|
116
136
|
2. fork the repo
|
|
@@ -131,6 +151,16 @@ USAGE: heimdall_tools version
|
|
|
131
151
|
17. git commit -a -s `<your_branch>`
|
|
132
152
|
18. Open a PRs aginst the MITRE inspec_tools repo
|
|
133
153
|
|
|
154
|
+
# Publishing a Release
|
|
155
|
+
|
|
156
|
+
If you are a maintainer, it is very easy to cut a release of this gem:
|
|
157
|
+
|
|
158
|
+
1. Click on "Releases" and there should be a draft pending.
|
|
159
|
+
2. Make sure the Tag version and Release title match!
|
|
160
|
+
3. Add any additional notes can be added in the Description box.
|
|
161
|
+
4. Click "Publish release".
|
|
162
|
+
5. Release notes will be posted and a new gem will be pushed to Rubygems & Github Packages with the version you specified on step 2.
|
|
163
|
+
|
|
134
164
|
# Testing
|
|
135
165
|
|
|
136
166
|
This gem was developed using the [CLI Template](https://github.com/tongueroo/cli-template), a generator tool that builds a starter CLI project.
|
|
@@ -139,7 +169,6 @@ There are a set of unit tests. Run `rake test` to run the tests.
|
|
|
139
169
|
|
|
140
170
|
To release a new version, update the version number in `version.rb` according to the [Semantic Versioning Policy](https://semver.org/). Then, run `bundle exec rake release` which will create a git tag for the specified version, push git commits and tags, and push the `.gem` file to [github.com](https://github.com/mitre/heimdall_tools).
|
|
141
171
|
|
|
142
|
-
|
|
143
172
|
# License and Author
|
|
144
173
|
|
|
145
174
|
### Authors
|
|
@@ -147,19 +176,20 @@ To release a new version, update the version number in `version.rb` according to
|
|
|
147
176
|
- Author:: Rony Xavier [rx294](https://github.com/rx294)
|
|
148
177
|
- Author:: Dan Mirsky [mirskiy](https://github.com/mirskiy)
|
|
149
178
|
|
|
150
|
-
### NOTICE
|
|
179
|
+
### NOTICE
|
|
151
180
|
|
|
152
|
-
© 2018 The MITRE Corporation.
|
|
181
|
+
© 2018 The MITRE Corporation.
|
|
153
182
|
|
|
154
|
-
Approved for Public Release; Distribution Unlimited. Case Number 18-3678.
|
|
183
|
+
Approved for Public Release; Distribution Unlimited. Case Number 18-3678.
|
|
155
184
|
|
|
156
185
|
### NOTICE
|
|
186
|
+
|
|
157
187
|
MITRE hereby grants express written permission to use, reproduce, distribute, modify, and otherwise leverage this software to the extent permitted by the licensed terms provided in the LICENSE.md file included with this project.
|
|
158
188
|
|
|
159
|
-
### NOTICE
|
|
189
|
+
### NOTICE
|
|
160
190
|
|
|
161
|
-
This software was produced for the U. S. Government under Contract Number HHSM-500-2012-00008I, and is subject to Federal Acquisition Regulation Clause 52.227-14, Rights in Data-General.
|
|
191
|
+
This software was produced for the U. S. Government under Contract Number HHSM-500-2012-00008I, and is subject to Federal Acquisition Regulation Clause 52.227-14, Rights in Data-General.
|
|
162
192
|
|
|
163
|
-
No other use other than that granted to the U. S. Government, or to those acting on behalf of the U. S. Government under that Clause is authorized without the express written permission of The MITRE Corporation.
|
|
193
|
+
No other use other than that granted to the U. S. Government, or to those acting on behalf of the U. S. Government under that Clause is authorized without the express written permission of The MITRE Corporation.
|
|
164
194
|
|
|
165
|
-
For further information, please contact The MITRE Corporation, Contracts Management Office, 7515 Colshire Drive, McLean, VA
|
|
195
|
+
For further information, please contact The MITRE Corporation, Contracts Management Office, 7515 Colshire Drive, McLean, VA 22102-7539, (703) 983-6000.
|
|
@@ -1,4 +1,8 @@
|
|
|
1
|
+
require 'git-version-bump'
|
|
2
|
+
|
|
1
3
|
module HeimdallTools
|
|
2
|
-
|
|
4
|
+
# Enable lite-tags (2nd parameter to git-version-bump version command)
|
|
5
|
+
# Lite tags are tags that are used by GitHub releases that do not contain
|
|
6
|
+
# annotations
|
|
7
|
+
VERSION = GVB.version(false, true)
|
|
3
8
|
end
|
|
4
|
-
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: heimdall_tools
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.3.
|
|
4
|
+
version: 1.3.22.5.g8e14377
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Robert Thew
|
|
@@ -110,6 +110,20 @@ dependencies:
|
|
|
110
110
|
- - "~>"
|
|
111
111
|
- !ruby/object:Gem::Version
|
|
112
112
|
version: '2.6'
|
|
113
|
+
- !ruby/object:Gem::Dependency
|
|
114
|
+
name: git-lite-version-bump
|
|
115
|
+
requirement: !ruby/object:Gem::Requirement
|
|
116
|
+
requirements:
|
|
117
|
+
- - ">="
|
|
118
|
+
- !ruby/object:Gem::Version
|
|
119
|
+
version: '0.17'
|
|
120
|
+
type: :runtime
|
|
121
|
+
prerelease: false
|
|
122
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
123
|
+
requirements:
|
|
124
|
+
- - ">="
|
|
125
|
+
- !ruby/object:Gem::Version
|
|
126
|
+
version: '0.17'
|
|
113
127
|
- !ruby/object:Gem::Dependency
|
|
114
128
|
name: bundler
|
|
115
129
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -227,11 +241,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
227
241
|
version: '0'
|
|
228
242
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
229
243
|
requirements:
|
|
230
|
-
- - "
|
|
244
|
+
- - ">"
|
|
231
245
|
- !ruby/object:Gem::Version
|
|
232
|
-
version:
|
|
246
|
+
version: 1.3.1
|
|
233
247
|
requirements: []
|
|
234
|
-
rubygems_version: 3.
|
|
248
|
+
rubygems_version: 3.1.2
|
|
235
249
|
signing_key:
|
|
236
250
|
specification_version: 4
|
|
237
251
|
summary: Convert Forify, Openzap and Sonarqube results to HDF
|