security_report 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +11 -0
- data/.rspec +3 -0
- data/.travis.yml +5 -0
- data/Gemfile +4 -0
- data/Gemfile.lock +46 -0
- data/LICENSE +201 -0
- data/README.md +76 -0
- data/Rakefile +6 -0
- data/exe/security_report +14 -0
- data/lib/security_report/cli.rb +51 -0
- data/lib/security_report/database.rb +9 -0
- data/lib/security_report/grouped_result.rb +30 -0
- data/lib/security_report/insecure_source_result.rb +27 -0
- data/lib/security_report/plain_reporter.rb +42 -0
- data/lib/security_report/problem.rb +19 -0
- data/lib/security_report/scanner.rb +39 -0
- data/lib/security_report/table_reporter.rb +41 -0
- data/lib/security_report/unpatched_gem_result.rb +47 -0
- data/lib/security_report/version.rb +3 -0
- data/lib/security_report.rb +38 -0
- data/security_report.gemspec +31 -0
- metadata +150 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 99b4d40e7864b7321e4fe114f416115a9871ceb1
|
4
|
+
data.tar.gz: ddabf21cb626701b170ec34c3653f16da4a35318
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 404d4bd5a7705fa4141f8e7ea40685cdfeff5712fb85861071fa330de245f25e8c2a2d8f51e35aa5c119baa26608417d2355202b441bc6e6f5a2fb24207f8ae3
|
7
|
+
data.tar.gz: 767fd7bd20cd9fd35dc55e611f9464308ee8610d213bee9d07f47f30213010aafd718d4da92a06ba38cb794d42df00e64e7b9ac91a86262fbd437c59de046802
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,46 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
security_report (0.1.0)
|
5
|
+
bundler-audit (~> 0.6)
|
6
|
+
clap (~> 1.0)
|
7
|
+
terminal-table (~> 1.8)
|
8
|
+
|
9
|
+
GEM
|
10
|
+
remote: https://rubygems.org/
|
11
|
+
specs:
|
12
|
+
bundler-audit (0.6.0)
|
13
|
+
bundler (~> 1.2)
|
14
|
+
thor (~> 0.18)
|
15
|
+
clap (1.0.0)
|
16
|
+
diff-lcs (1.3)
|
17
|
+
rake (12.3.1)
|
18
|
+
rspec (3.8.0)
|
19
|
+
rspec-core (~> 3.8.0)
|
20
|
+
rspec-expectations (~> 3.8.0)
|
21
|
+
rspec-mocks (~> 3.8.0)
|
22
|
+
rspec-core (3.8.0)
|
23
|
+
rspec-support (~> 3.8.0)
|
24
|
+
rspec-expectations (3.8.1)
|
25
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
26
|
+
rspec-support (~> 3.8.0)
|
27
|
+
rspec-mocks (3.8.0)
|
28
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
29
|
+
rspec-support (~> 3.8.0)
|
30
|
+
rspec-support (3.8.0)
|
31
|
+
terminal-table (1.8.0)
|
32
|
+
unicode-display_width (~> 1.1, >= 1.1.1)
|
33
|
+
thor (0.20.0)
|
34
|
+
unicode-display_width (1.4.0)
|
35
|
+
|
36
|
+
PLATFORMS
|
37
|
+
ruby
|
38
|
+
|
39
|
+
DEPENDENCIES
|
40
|
+
bundler (~> 1.16)
|
41
|
+
rake (~> 12.3)
|
42
|
+
rspec (~> 3.0)
|
43
|
+
security_report!
|
44
|
+
|
45
|
+
BUNDLED WITH
|
46
|
+
1.16.3
|
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright 2018 Lucas Dohmen
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,76 @@
|
|
1
|
+
# security_report
|
2
|
+
|
3
|
+
[![Build Status](https://travis-ci.org/innoq/security_report.svg?branch=master)](https://travis-ci.org/innoq/security_report)
|
4
|
+
[![Depfu](https://badges.depfu.com/badges/d566920d877cee415e76cd9a4e680eb0/count.svg)](https://depfu.com/github/innoq/security_report?project=Bundler)
|
5
|
+
|
6
|
+
Check Ruby projects for dependencies with known security problems. This project
|
7
|
+
uses [bundler-audit](https://github.com/rubysec/bundler-audit) to check the
|
8
|
+
Gemfiles. It then generates a report like this:
|
9
|
+
|
10
|
+
# jquery-rails (3.0.4)
|
11
|
+
Projects: spec/examples/project_1
|
12
|
+
Solution: Upgrade to a new version
|
13
|
+
Problems:
|
14
|
+
* CVE-2015-1840 (CSRF Vulnerability in jquery-r...)
|
15
|
+
|
16
|
+
# paperclip (2.8.0)
|
17
|
+
Projects: spec/examples/project_1
|
18
|
+
Solution: Upgrade to a new version
|
19
|
+
Problems:
|
20
|
+
* CVE-2017-0889 (Paperclip ruby gem suffers fro...)
|
21
|
+
* CVE-2015-2963 (Paperclip Gem for Ruby vulnera...)
|
22
|
+
* 103151 (Paperclip Gem for Ruby contain...)
|
23
|
+
|
24
|
+
# rest-client (1.6.7)
|
25
|
+
Projects: spec/examples/project_1
|
26
|
+
Solution: Upgrade to a new version
|
27
|
+
Problems:
|
28
|
+
* CVE-2015-1820 (rubygem-rest-client: session f...)
|
29
|
+
* CVE-2015-3448 (Rest-Client Gem for Ruby logs...)
|
30
|
+
|
31
|
+
# rubyzip (1.1.7)
|
32
|
+
Projects: spec/examples/project_1, spec/examples/project_2
|
33
|
+
Solution: Upgrade to a new version
|
34
|
+
Problems:
|
35
|
+
* CVE-2017-5946 (Directory traversal vulnerabil...)
|
36
|
+
* CVE-2017-5946 (Directory traversal vulnerabil...)
|
37
|
+
|
38
|
+
The goal of this project is to provide a functionality similar to Github's
|
39
|
+
security mail for projects that are self hosted on Bitbucket or other
|
40
|
+
self-hosted version control repository hosting services. You can add a
|
41
|
+
scheduled job that runs security_report every night for each of your Ruby
|
42
|
+
projects and mail out the result to the developers.
|
43
|
+
|
44
|
+
security_report **does not check your code for security problems**. If you need
|
45
|
+
something like that and are using Rails, check out
|
46
|
+
[brakeman](https://github.com/presidentbeef/brakeman).
|
47
|
+
|
48
|
+
## Installation
|
49
|
+
|
50
|
+
$ gem install security_report
|
51
|
+
|
52
|
+
## Usage
|
53
|
+
|
54
|
+
Run security_report like this:
|
55
|
+
|
56
|
+
security_report path_to_your_project
|
57
|
+
|
58
|
+
This will output the security report to your terminal. You can also provide the
|
59
|
+
path to multiple projects. To run the security report for each project in the
|
60
|
+
projects folder, run:
|
61
|
+
|
62
|
+
security_report projects/*
|
63
|
+
|
64
|
+
The tool uses a database of known vulnerabilities. To update the database, use
|
65
|
+
the `--update` option:
|
66
|
+
|
67
|
+
security_report --update projects/*
|
68
|
+
|
69
|
+
You can also use a different output format. The default format is called plain.
|
70
|
+
There is also a table output. If you want to use it instead, run:
|
71
|
+
|
72
|
+
security_report --format table projects/*
|
73
|
+
|
74
|
+
## License
|
75
|
+
|
76
|
+
security_report is licensed under Apache 2.0 License.
|
data/Rakefile
ADDED
data/exe/security_report
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require 'clap'
|
4
|
+
require 'security_report/cli'
|
5
|
+
|
6
|
+
cli = SecurityReport::CLI.new
|
7
|
+
|
8
|
+
files = Clap.run ARGV,
|
9
|
+
"-h" => cli.method(:help),
|
10
|
+
"--help" => cli.method(:help),
|
11
|
+
"--format" => cli.method(:format=),
|
12
|
+
"--update" => cli.method(:update)
|
13
|
+
|
14
|
+
cli.run(files)
|
@@ -0,0 +1,51 @@
|
|
1
|
+
require 'security_report'
|
2
|
+
|
3
|
+
module SecurityReport
|
4
|
+
class CLI
|
5
|
+
attr_accessor :format
|
6
|
+
|
7
|
+
def initialize
|
8
|
+
@format = "plain"
|
9
|
+
end
|
10
|
+
|
11
|
+
def help
|
12
|
+
puts <<~HELPTEXT
|
13
|
+
security_report [options] files...
|
14
|
+
|
15
|
+
-h, --help
|
16
|
+
Print this message
|
17
|
+
--format
|
18
|
+
Provide the format: plain or table (default: plain)
|
19
|
+
--update
|
20
|
+
Update the vulnerability database before running
|
21
|
+
HELPTEXT
|
22
|
+
exit
|
23
|
+
end
|
24
|
+
|
25
|
+
def reporter
|
26
|
+
case format
|
27
|
+
when "plain"
|
28
|
+
require 'security_report/plain_reporter'
|
29
|
+
@reporter = PlainReporter.new
|
30
|
+
when "table"
|
31
|
+
require 'security_report/table_reporter'
|
32
|
+
@reporter = TableReporter.new
|
33
|
+
else
|
34
|
+
puts "Unknown format '#{format}'"
|
35
|
+
exit 1
|
36
|
+
end
|
37
|
+
end
|
38
|
+
|
39
|
+
def update
|
40
|
+
return if Database.update
|
41
|
+
puts "Failed updating database!"
|
42
|
+
exit 1
|
43
|
+
end
|
44
|
+
|
45
|
+
def run(files)
|
46
|
+
auditor = Auditor.audit(files)
|
47
|
+
reporter.report(auditor.results, auditor.skipped)
|
48
|
+
exit 1 if auditor.results.any?
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
@@ -0,0 +1,30 @@
|
|
1
|
+
module SecurityReport
|
2
|
+
class GroupedResult
|
3
|
+
def initialize(results)
|
4
|
+
@results = results
|
5
|
+
end
|
6
|
+
|
7
|
+
def identifier
|
8
|
+
@results.first.identifier
|
9
|
+
end
|
10
|
+
|
11
|
+
def targets
|
12
|
+
@results.map(&:target).uniq
|
13
|
+
end
|
14
|
+
|
15
|
+
def problems
|
16
|
+
@results.map(&:problem)
|
17
|
+
end
|
18
|
+
|
19
|
+
def solution
|
20
|
+
@results.map(&:solution).uniq.join(", ")
|
21
|
+
end
|
22
|
+
|
23
|
+
def criticality
|
24
|
+
criticalities = @results.map(&:criticality).uniq
|
25
|
+
return :high if criticalities.include? :high
|
26
|
+
return :medium if criticalities.include? :high
|
27
|
+
:low
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
@@ -0,0 +1,27 @@
|
|
1
|
+
module SecurityReport
|
2
|
+
class InsecureSourceResult
|
3
|
+
attr_reader :identifier
|
4
|
+
attr_reader :target
|
5
|
+
|
6
|
+
def initialize(scan_result, target)
|
7
|
+
@identifier = scan_result.source
|
8
|
+
@target = target
|
9
|
+
end
|
10
|
+
|
11
|
+
def problem
|
12
|
+
Problem.new("Insecure URI", "Do not use an insecure Source URI", nil)
|
13
|
+
end
|
14
|
+
|
15
|
+
def solution
|
16
|
+
"Use a secure URI"
|
17
|
+
end
|
18
|
+
|
19
|
+
def criticality
|
20
|
+
:high
|
21
|
+
end
|
22
|
+
|
23
|
+
def self.matches?(obj)
|
24
|
+
obj.instance_of? ::Bundler::Audit::Scanner::InsecureSource
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
@@ -0,0 +1,42 @@
|
|
1
|
+
module SecurityReport
|
2
|
+
class PlainReporter
|
3
|
+
def report(results, skipped)
|
4
|
+
if results.any?
|
5
|
+
high, medium_or_lower = results.partition { |result| result.criticality == :high }
|
6
|
+
medium, low_or_unknown = medium_or_lower.partition { |result| result.criticality == :medium }
|
7
|
+
|
8
|
+
puts format_results(high) if high.any?
|
9
|
+
puts format_results(medium) if medium.any?
|
10
|
+
puts format_results(low_or_unknown) if low_or_unknown.any?
|
11
|
+
else
|
12
|
+
puts "No vulnerabilities found"
|
13
|
+
end
|
14
|
+
|
15
|
+
if skipped.any?
|
16
|
+
puts
|
17
|
+
puts "Skipped #{skipped.join(", ")}: No Gemfile.lock found"
|
18
|
+
end
|
19
|
+
end
|
20
|
+
|
21
|
+
private
|
22
|
+
|
23
|
+
def format_results(results)
|
24
|
+
results.map do |result|
|
25
|
+
<<~HELPTEXT
|
26
|
+
# #{result.identifier}"
|
27
|
+
Projects: #{result.targets.join(", ")}"
|
28
|
+
Criticality: #{result.criticality}"
|
29
|
+
Solution: #{result.solution}"
|
30
|
+
Problems:
|
31
|
+
#{format_problems(result.problems)}
|
32
|
+
HELPTEXT
|
33
|
+
end.join("\n") + "\n"
|
34
|
+
end
|
35
|
+
|
36
|
+
def format_problems(problems)
|
37
|
+
problems.map do |problem|
|
38
|
+
"* #{problem.summary}"
|
39
|
+
end.join("\n")
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
module SecurityReport
|
2
|
+
class Problem
|
3
|
+
def initialize(identifier, description, url)
|
4
|
+
@identifier = identifier
|
5
|
+
@description = description
|
6
|
+
@url = url
|
7
|
+
end
|
8
|
+
|
9
|
+
def summary
|
10
|
+
"#{@identifier} (#{truncate(@description, 30)})"
|
11
|
+
end
|
12
|
+
|
13
|
+
private
|
14
|
+
|
15
|
+
def truncate(string, max)
|
16
|
+
string.length > max ? "#{string[0...max].strip}..." : string
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
@@ -0,0 +1,39 @@
|
|
1
|
+
require 'fileutils'
|
2
|
+
require 'bundler/audit/scanner'
|
3
|
+
require 'security_report/unpatched_gem_result'
|
4
|
+
require 'security_report/insecure_source_result'
|
5
|
+
|
6
|
+
module SecurityReport
|
7
|
+
class Scanner
|
8
|
+
def scan(directory)
|
9
|
+
results = with_gemfile do
|
10
|
+
::Bundler::Audit::Scanner.new(directory).scan
|
11
|
+
end
|
12
|
+
|
13
|
+
results.map do |scan_result|
|
14
|
+
detected_matching_result_class(scan_result).new(scan_result, directory)
|
15
|
+
end
|
16
|
+
end
|
17
|
+
|
18
|
+
private
|
19
|
+
|
20
|
+
# This is a weird workaround, for methods that
|
21
|
+
# require a Gemfile in the current directory
|
22
|
+
def with_gemfile
|
23
|
+
if File.exist? 'Gemfile'
|
24
|
+
yield
|
25
|
+
else
|
26
|
+
FileUtils.touch 'Gemfile'
|
27
|
+
return_value = yield
|
28
|
+
FileUtils.rm 'Gemfile'
|
29
|
+
return_value
|
30
|
+
end
|
31
|
+
end
|
32
|
+
|
33
|
+
def detected_matching_result_class(scan_result)
|
34
|
+
[InsecureSourceResult, UnpatchedGemResult].detect do |result_class|
|
35
|
+
result_class.matches? scan_result
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
@@ -0,0 +1,41 @@
|
|
1
|
+
require 'terminal-table'
|
2
|
+
|
3
|
+
module SecurityReport
|
4
|
+
class TableReporter
|
5
|
+
def report(results, skipped)
|
6
|
+
if results.any?
|
7
|
+
high, medium_or_lower = results.partition { |result| result.criticality == :high }
|
8
|
+
medium, low_or_unknown = medium_or_lower.partition { |result| result.criticality == :medium }
|
9
|
+
|
10
|
+
puts tableize("High criticality", high) if high.any?
|
11
|
+
puts tableize("Medium criticality", medium) if medium.any?
|
12
|
+
puts tableize("Low or unknown criticality", low_or_unknown) if low_or_unknown.any?
|
13
|
+
puts
|
14
|
+
puts "Vulnerabilities (#{high.size} high, #{medium.size} medium, #{low_or_unknown.size} low or unkown) found!"
|
15
|
+
else
|
16
|
+
puts "No vulnerabilities found"
|
17
|
+
end
|
18
|
+
|
19
|
+
if skipped.any?
|
20
|
+
puts "Skipped #{skipped.join(", ")}: No Gemfile.lock found"
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
24
|
+
private
|
25
|
+
|
26
|
+
def tableize(title, results)
|
27
|
+
Terminal::Table.new(
|
28
|
+
title: title,
|
29
|
+
headings: ['Identifier', 'Target', 'Solution', 'Problem'],
|
30
|
+
rows: results.map do |result|
|
31
|
+
[
|
32
|
+
result.identifier,
|
33
|
+
result.targets.join(", "),
|
34
|
+
result.solution,
|
35
|
+
result.problems.map(&:summary).join("\n")
|
36
|
+
]
|
37
|
+
end
|
38
|
+
)
|
39
|
+
end
|
40
|
+
end
|
41
|
+
end
|
@@ -0,0 +1,47 @@
|
|
1
|
+
require 'forwardable'
|
2
|
+
require 'security_report/problem'
|
3
|
+
|
4
|
+
module SecurityReport
|
5
|
+
class UnpatchedGemResult
|
6
|
+
extend Forwardable
|
7
|
+
|
8
|
+
attr_reader :identifier
|
9
|
+
attr_reader :target
|
10
|
+
|
11
|
+
def_delegator :advisory, :criticality
|
12
|
+
|
13
|
+
def initialize(scan_result, target)
|
14
|
+
@identifier = scan_result.gem.to_s
|
15
|
+
@advisory = scan_result.advisory
|
16
|
+
@target = target
|
17
|
+
end
|
18
|
+
|
19
|
+
def problem
|
20
|
+
Problem.new(problem_id, advisory.title, advisory.url)
|
21
|
+
end
|
22
|
+
|
23
|
+
def solution
|
24
|
+
if advisory.patched_versions.empty?
|
25
|
+
"Remove or disable this gem until a patch is available!"
|
26
|
+
else
|
27
|
+
"Upgrade to a new version"
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
def self.matches?(obj)
|
32
|
+
obj.instance_of? ::Bundler::Audit::Scanner::UnpatchedGem
|
33
|
+
end
|
34
|
+
|
35
|
+
private
|
36
|
+
|
37
|
+
attr_reader :advisory
|
38
|
+
|
39
|
+
def problem_id
|
40
|
+
if advisory.cve
|
41
|
+
"CVE-#{advisory.cve}"
|
42
|
+
elsif advisory.osvdb
|
43
|
+
advisory.osvdb
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
@@ -0,0 +1,38 @@
|
|
1
|
+
require 'security_report/version'
|
2
|
+
require 'security_report/database'
|
3
|
+
require 'security_report/scanner'
|
4
|
+
require 'security_report/grouped_result'
|
5
|
+
|
6
|
+
module SecurityReport
|
7
|
+
class Auditor
|
8
|
+
def self.audit(directories)
|
9
|
+
auditor = new
|
10
|
+
|
11
|
+
directories.each do |directory|
|
12
|
+
auditor.check(directory)
|
13
|
+
end
|
14
|
+
|
15
|
+
auditor
|
16
|
+
end
|
17
|
+
|
18
|
+
attr_reader :skipped
|
19
|
+
|
20
|
+
def initialize
|
21
|
+
@results = []
|
22
|
+
@skipped = []
|
23
|
+
@scanner = Scanner.new
|
24
|
+
end
|
25
|
+
|
26
|
+
def check(directory)
|
27
|
+
@results.concat(@scanner.scan(directory))
|
28
|
+
rescue Errno::ENOENT
|
29
|
+
@skipped.push(directory)
|
30
|
+
end
|
31
|
+
|
32
|
+
def results
|
33
|
+
@results.group_by(&:identifier).map do |_, results|
|
34
|
+
GroupedResult.new(results)
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
@@ -0,0 +1,31 @@
|
|
1
|
+
lib = File.expand_path("lib", __dir__)
|
2
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
3
|
+
require "security_report/version"
|
4
|
+
|
5
|
+
Gem::Specification.new do |spec|
|
6
|
+
spec.name = "security_report"
|
7
|
+
spec.version = SecurityReport::VERSION
|
8
|
+
spec.authors = ["Lucas Dohmen"]
|
9
|
+
spec.email = ["lucas.dohmen@innoq.com"]
|
10
|
+
spec.license = "Apache-2.0"
|
11
|
+
|
12
|
+
spec.summary = "Generate a security report"
|
13
|
+
spec.description = "Check Ruby projects for dependencies with known security problems"
|
14
|
+
|
15
|
+
# Specify which files should be added to the gem when it is released.
|
16
|
+
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
17
|
+
spec.files = Dir.chdir(File.expand_path(__dir__)) do
|
18
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
|
19
|
+
end
|
20
|
+
spec.bindir = "exe"
|
21
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
22
|
+
spec.require_paths = ["lib"]
|
23
|
+
|
24
|
+
spec.add_dependency "bundler-audit", "~> 0.6"
|
25
|
+
spec.add_dependency "clap", "~> 1.0"
|
26
|
+
spec.add_dependency "terminal-table", "~> 1.8"
|
27
|
+
|
28
|
+
spec.add_development_dependency "bundler", "~> 1.16"
|
29
|
+
spec.add_development_dependency "rake", "~> 12.3"
|
30
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
31
|
+
end
|
metadata
ADDED
@@ -0,0 +1,150 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: security_report
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Lucas Dohmen
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2018-08-16 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler-audit
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0.6'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0.6'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: clap
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1.0'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: terminal-table
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '1.8'
|
48
|
+
type: :runtime
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '1.8'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: bundler
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '1.16'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '1.16'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rake
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - "~>"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '12.3'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - "~>"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '12.3'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: rspec
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - "~>"
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '3.0'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - "~>"
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '3.0'
|
97
|
+
description: Check Ruby projects for dependencies with known security problems
|
98
|
+
email:
|
99
|
+
- lucas.dohmen@innoq.com
|
100
|
+
executables:
|
101
|
+
- security_report
|
102
|
+
extensions: []
|
103
|
+
extra_rdoc_files: []
|
104
|
+
files:
|
105
|
+
- ".gitignore"
|
106
|
+
- ".rspec"
|
107
|
+
- ".travis.yml"
|
108
|
+
- Gemfile
|
109
|
+
- Gemfile.lock
|
110
|
+
- LICENSE
|
111
|
+
- README.md
|
112
|
+
- Rakefile
|
113
|
+
- exe/security_report
|
114
|
+
- lib/security_report.rb
|
115
|
+
- lib/security_report/cli.rb
|
116
|
+
- lib/security_report/database.rb
|
117
|
+
- lib/security_report/grouped_result.rb
|
118
|
+
- lib/security_report/insecure_source_result.rb
|
119
|
+
- lib/security_report/plain_reporter.rb
|
120
|
+
- lib/security_report/problem.rb
|
121
|
+
- lib/security_report/scanner.rb
|
122
|
+
- lib/security_report/table_reporter.rb
|
123
|
+
- lib/security_report/unpatched_gem_result.rb
|
124
|
+
- lib/security_report/version.rb
|
125
|
+
- security_report.gemspec
|
126
|
+
homepage:
|
127
|
+
licenses:
|
128
|
+
- Apache-2.0
|
129
|
+
metadata: {}
|
130
|
+
post_install_message:
|
131
|
+
rdoc_options: []
|
132
|
+
require_paths:
|
133
|
+
- lib
|
134
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
135
|
+
requirements:
|
136
|
+
- - ">="
|
137
|
+
- !ruby/object:Gem::Version
|
138
|
+
version: '0'
|
139
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
140
|
+
requirements:
|
141
|
+
- - ">="
|
142
|
+
- !ruby/object:Gem::Version
|
143
|
+
version: '0'
|
144
|
+
requirements: []
|
145
|
+
rubyforge_project:
|
146
|
+
rubygems_version: 2.6.14.1
|
147
|
+
signing_key:
|
148
|
+
specification_version: 4
|
149
|
+
summary: Generate a security report
|
150
|
+
test_files: []
|