fluent-plugin-jfrog-siem 0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +3 -0
- data/LICENSE +202 -0
- data/README.md +79 -0
- data/Rakefile +13 -0
- data/fluent-plugin-jfrog-siem.gemspec +28 -0
- data/lib/fluent/plugin/in_jfrog_siem.rb +273 -0
- data/test/helper.rb +8 -0
- data/test/plugin/test_in_jfrog_siem.rb +33 -0
- metadata +133 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 4b04492f8a59aaa298e6fa79245598e9ba727595663b38f1109b139db49ec98c
|
4
|
+
data.tar.gz: fda6f3902f9897f2681b34c01e98ad4a37f35d8e9706ec350acdf1b14e9ae022
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: e77645f065b8d9802ab802fd85dffa028ee2cb6abe2a522e055fdb84bedd97e34df98e1fe02881613f09b895549fb5602b86e38e5e3f5fa0b18581f86a411f82
|
7
|
+
data.tar.gz: e211bbbe0c4640ee326b314ad0930a0ff25d5ab4c5dafefc6945ad8e117a19a726fbd7863b7e6da57a773f834642ebcf45a5f47075670d65b408887198d99563
|
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,79 @@
|
|
1
|
+
# fluent-plugin-jfrog-siem
|
2
|
+
|
3
|
+
[Fluentd](https://fluentd.org/) input plugin to download JFrog Xray SIEM violations and export them to Fluentd to process into various output plugins
|
4
|
+
|
5
|
+
## Building
|
6
|
+
|
7
|
+
To build / test locally use rake:
|
8
|
+
|
9
|
+
```
|
10
|
+
rake
|
11
|
+
```
|
12
|
+
|
13
|
+
To build install locally use bundler:
|
14
|
+
|
15
|
+
```
|
16
|
+
bundle install
|
17
|
+
```
|
18
|
+
|
19
|
+
This will install the gem shown below from source.
|
20
|
+
|
21
|
+
|
22
|
+
## Installation
|
23
|
+
|
24
|
+
### RubyGems
|
25
|
+
|
26
|
+
```
|
27
|
+
$ gem install rest-client
|
28
|
+
```
|
29
|
+
```
|
30
|
+
$ gem install thread
|
31
|
+
```
|
32
|
+
```
|
33
|
+
$ gem install fluent-plugin-jfrog-siem
|
34
|
+
```
|
35
|
+
|
36
|
+
### Bundler
|
37
|
+
|
38
|
+
Add following line to your Gemfile:
|
39
|
+
|
40
|
+
```ruby
|
41
|
+
gem "fluent-plugin-jfrog-siem"
|
42
|
+
```
|
43
|
+
|
44
|
+
And then execute:
|
45
|
+
|
46
|
+
```
|
47
|
+
$ bundle
|
48
|
+
```
|
49
|
+
|
50
|
+
## Configuration
|
51
|
+
|
52
|
+
You can generate configuration template:
|
53
|
+
|
54
|
+
```
|
55
|
+
$ fluent-plugin-config-format input jfrog-siem
|
56
|
+
```
|
57
|
+
|
58
|
+
You can copy and paste generated documents here.
|
59
|
+
|
60
|
+
###Setup & configuration parameters
|
61
|
+
|
62
|
+
Xray setup is required. Obtain JPD url and access token for API
|
63
|
+
|
64
|
+
* **tag** (string) (required): The value is the tag assigned to the generated events.
|
65
|
+
* **jpd_url** (string) (required): JPD url required to pull Xray SIEM violations
|
66
|
+
* **access_token** (string) (required): [Access token](https://www.jfrog.com/confluence/display/JFROG/Access+Tokens) to authenticate Xray
|
67
|
+
* **pos_file** (string) (required): Position file to record last SIEM violation pulled
|
68
|
+
* **batch_size** (integer) (optional): Batch size for processing violations
|
69
|
+
* Default value: `25`.
|
70
|
+
* **thread_count** (integer) (optional): Number of workers to process violation records in thread pool
|
71
|
+
* Default value: `5`.
|
72
|
+
* **wait_interval** (integer) (optional): Wait interval between pulling new events
|
73
|
+
* Default value: `60`.
|
74
|
+
|
75
|
+
## Copyright
|
76
|
+
|
77
|
+
* Copyright(c) 2020 - JFrog
|
78
|
+
* License
|
79
|
+
* Apache License, Version 2.0
|
data/Rakefile
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
require "bundler"
|
2
|
+
Bundler::GemHelper.install_tasks
|
3
|
+
|
4
|
+
require "rake/testtask"
|
5
|
+
|
6
|
+
Rake::TestTask.new(:test) do |t|
|
7
|
+
t.libs.push("lib", "test")
|
8
|
+
t.test_files = FileList["test/**/test_*.rb"]
|
9
|
+
t.verbose = true
|
10
|
+
t.warning = false
|
11
|
+
end
|
12
|
+
|
13
|
+
task default: [:test]
|
@@ -0,0 +1,28 @@
|
|
1
|
+
lib = File.expand_path("../lib", __FILE__)
|
2
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
3
|
+
|
4
|
+
Gem::Specification.new do |spec|
|
5
|
+
spec.name = "fluent-plugin-jfrog-siem"
|
6
|
+
spec.version = "0.1.1"
|
7
|
+
spec.authors = ["John Peterson", "Mahitha Byreddy"]
|
8
|
+
spec.email = ["johnp@jfrog.com", "mahithab@jfrog.com"]
|
9
|
+
|
10
|
+
spec.summary = %q{JFrog SIEM fluent input plugin will send the SIEM events from JFrog Xray to Fluentd}
|
11
|
+
spec.description = %q{JFrog SIEM fluent input plugin will send the SIEM events from JFrog Xray to Fluentd which can then be delivered to whatever output plugin specified}
|
12
|
+
spec.homepage = "https://github.com/jfrog/log-analytics"
|
13
|
+
spec.license = "Apache-2.0"
|
14
|
+
|
15
|
+
test_files, files = `git ls-files -z`.split("\x0").partition do |f|
|
16
|
+
f.match(%r{^(test|spec|features)/})
|
17
|
+
end
|
18
|
+
spec.files = files
|
19
|
+
spec.executables = files.grep(%r{^bin/}) { |f| File.basename(f) }
|
20
|
+
spec.test_files = test_files
|
21
|
+
spec.require_paths = ["lib"]
|
22
|
+
|
23
|
+
spec.add_development_dependency "bundler", "~> 2.0"
|
24
|
+
spec.add_development_dependency "rake", "~> 12.0"
|
25
|
+
spec.add_development_dependency "test-unit", "~> 3.0"
|
26
|
+
spec.add_development_dependency "rest-client", "~> 2.0"
|
27
|
+
spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
|
28
|
+
end
|
@@ -0,0 +1,273 @@
|
|
1
|
+
#
|
2
|
+
# Copyright 2020 - JFrog
|
3
|
+
#
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
5
|
+
# you may not use this file except in compliance with the License.
|
6
|
+
# You may obtain a copy of the License at
|
7
|
+
#
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
9
|
+
#
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
13
|
+
# See the License for the specific language governing permissions and
|
14
|
+
# limitations under the License.
|
15
|
+
require "fluent/plugin/input"
|
16
|
+
require "rest-client"
|
17
|
+
require "thread/pool"
|
18
|
+
require "json"
|
19
|
+
require "date"
|
20
|
+
require "uri"
|
21
|
+
|
22
|
+
module Fluent
|
23
|
+
module Plugin
|
24
|
+
class JfrogSiemInput < Fluent::Plugin::Input
|
25
|
+
Fluent::Plugin.register_input("jfrog_siem", self)
|
26
|
+
|
27
|
+
|
28
|
+
# `config_param` defines a parameter.
|
29
|
+
# You can refer to a parameter like an instance variable e.g. @port.
|
30
|
+
# `:default` means that the parameter is optional.
|
31
|
+
config_param :tag, :string, default: ""
|
32
|
+
config_param :jpd_url, :string, default: ""
|
33
|
+
config_param :access_token, :string, default: ""
|
34
|
+
config_param :pos_file, :string, default: ""
|
35
|
+
config_param :batch_size, :integer, default: 25
|
36
|
+
config_param :thread_count, :integer, default: 5
|
37
|
+
config_param :wait_interval, :integer, default: 60
|
38
|
+
|
39
|
+
|
40
|
+
# `configure` is called before `start`.
|
41
|
+
# 'conf' is a `Hash` that includes the configuration parameters.
|
42
|
+
# If the configuration is invalid, raise `Fluent::ConfigError`.
|
43
|
+
def configure(conf)
|
44
|
+
super
|
45
|
+
if @tag == ""
|
46
|
+
raise Fluent::ConfigError, "Must define a tag for the SIEM data."
|
47
|
+
end
|
48
|
+
|
49
|
+
if @jpd_url == ""
|
50
|
+
raise Fluent::ConfigError, "Must define the JPD URL to pull Xray SIEM violations."
|
51
|
+
end
|
52
|
+
|
53
|
+
if @access_token == ""
|
54
|
+
raise Fluent::ConfigError, "Must define the access token to use for authentication."
|
55
|
+
end
|
56
|
+
|
57
|
+
if @pos_file == ""
|
58
|
+
raise Fluent::ConfigError, "Must define a position file to record last SIEM violation pulled."
|
59
|
+
end
|
60
|
+
|
61
|
+
if @thread_count < 1
|
62
|
+
raise Fluent::ConfigError, "Must define at least one thread to process violation details."
|
63
|
+
end
|
64
|
+
|
65
|
+
if @thread_count > @batch_size
|
66
|
+
raise Fluent::ConfigError, "Violation detail url thread count exceeds batch size."
|
67
|
+
end
|
68
|
+
|
69
|
+
if @wait_interval < 1
|
70
|
+
raise Fluent::ConfigError, "Wait interval must be greater than 1 to wait between pulling new events."
|
71
|
+
end
|
72
|
+
|
73
|
+
end
|
74
|
+
|
75
|
+
|
76
|
+
# `start` is called when starting and after `configure` is successfully completed.
|
77
|
+
def start
|
78
|
+
super
|
79
|
+
@running = true
|
80
|
+
@thread = Thread.new(&method(:run))
|
81
|
+
end
|
82
|
+
|
83
|
+
|
84
|
+
def shutdown
|
85
|
+
@running = false
|
86
|
+
@thread.join
|
87
|
+
super
|
88
|
+
end
|
89
|
+
|
90
|
+
|
91
|
+
def run
|
92
|
+
call_home(@jpd_url, @access_token)
|
93
|
+
# runs the violation pull
|
94
|
+
last_created_date_string = get_last_item_create_date()
|
95
|
+
begin
|
96
|
+
last_created_date = DateTime.parse(last_created_date_string).strftime("%Y-%m-%dT%H:%M:%SZ")
|
97
|
+
rescue
|
98
|
+
last_created_date = DateTime.parse("1970-01-01T00:00:00Z").strftime("%Y-%m-%dT%H:%M:%SZ")
|
99
|
+
end
|
100
|
+
offset_count=1
|
101
|
+
left_violations=0
|
102
|
+
xray_json={"filters": { "created_from": last_created_date }, "pagination": {"order_by": "created","limit": @batch_size ,"offset": offset_count } }
|
103
|
+
|
104
|
+
while true
|
105
|
+
# Grab the batch of records
|
106
|
+
resp=get_xray_violations(xray_json, @jpd_url, @access_token)
|
107
|
+
number_of_violations = JSON.parse(resp)['total_violations']
|
108
|
+
if left_violations <= 0
|
109
|
+
left_violations = number_of_violations
|
110
|
+
end
|
111
|
+
|
112
|
+
xray_violation_urls_list = []
|
113
|
+
for index in 0..JSON.parse(resp)['violations'].length-1 do
|
114
|
+
# Get the violation
|
115
|
+
item = JSON.parse(resp)['violations'][index]
|
116
|
+
|
117
|
+
# Get the created date and check if we should skip (already processed) or process this record.
|
118
|
+
created_date_string = item['created']
|
119
|
+
created_date = DateTime.parse(created_date_string).strftime("%Y-%m-%dT%H:%M:%SZ")
|
120
|
+
|
121
|
+
# Determine if we need to persist this record or not
|
122
|
+
persistItem = true
|
123
|
+
if created_date < last_created_date
|
124
|
+
persistItem = false
|
125
|
+
end
|
126
|
+
|
127
|
+
# Publish the record to fluentd
|
128
|
+
if persistItem
|
129
|
+
|
130
|
+
now = Fluent::Engine.now
|
131
|
+
router.emit(@tag, now, item)
|
132
|
+
|
133
|
+
# write to the pos_file created_date_string
|
134
|
+
open(@pos_file, 'a') do |f|
|
135
|
+
f << "#{created_date_string}\n"
|
136
|
+
end
|
137
|
+
|
138
|
+
# Mark this as the last record successfully processed
|
139
|
+
last_created_date_string = created_date_string
|
140
|
+
last_created_date = created_date
|
141
|
+
|
142
|
+
# Grab violation detail url and add to url list to process w/ thread pool
|
143
|
+
xray_violation_details_url=item['violation_details_url']
|
144
|
+
xray_violation_urls_list.append(xray_violation_details_url)
|
145
|
+
end
|
146
|
+
end
|
147
|
+
|
148
|
+
# iterate over url array adding to thread pool each url.
|
149
|
+
# limit max workers to thread count to prevent overloading xray.
|
150
|
+
thread_pool = Thread.pool(thread_count)
|
151
|
+
for xray_violation_url in xray_violation_urls_list do
|
152
|
+
thread_pool.process {
|
153
|
+
pull_violation_details(xray_violation_url, @access_token)
|
154
|
+
}
|
155
|
+
end
|
156
|
+
|
157
|
+
thread_pool.shutdown
|
158
|
+
|
159
|
+
# reduce left violations by jump size (not all batches have full item count??)
|
160
|
+
left_violations = left_violations - @batch_size
|
161
|
+
if left_violations <= 0
|
162
|
+
sleep(@wait_interval)
|
163
|
+
else
|
164
|
+
# Grab the next record to process for the violation details url
|
165
|
+
offset_count = offset_count + 1
|
166
|
+
xray_json={"filters": { "created_from": last_created_date_string }, "pagination": {"order_by": "created","limit": @batch_size , "offset": offset_count } }
|
167
|
+
end
|
168
|
+
end
|
169
|
+
end
|
170
|
+
|
171
|
+
|
172
|
+
# pull the last item create date from the pos_file return created_date_string
|
173
|
+
def get_last_item_create_date()
|
174
|
+
if(!(File.exist?(@pos_file)))
|
175
|
+
@pos_file = File.new(@pos_file, "w")
|
176
|
+
end
|
177
|
+
return IO.readlines(@pos_file).last
|
178
|
+
end
|
179
|
+
|
180
|
+
#call home functionality
|
181
|
+
def call_home(jpd_url, access_token)
|
182
|
+
call_home_json = { "productId": "jfrogLogAnalytics/v0.5.1", "features": [ { "featureId": "Platform/Xray" }, { "featureId": "Channel/xrayeventsiem" } ] }
|
183
|
+
response = RestClient::Request.new(
|
184
|
+
:method => :post,
|
185
|
+
:url => jpd_url + "/artifactory/api/system/usage",
|
186
|
+
:payload => call_home_json.to_json,
|
187
|
+
:headers => { :accept => :json, :content_type => :json, Authorization:'Bearer ' + access_token }
|
188
|
+
).execute do |response, request, result|
|
189
|
+
puts "Posting call home information"
|
190
|
+
end
|
191
|
+
end
|
192
|
+
|
193
|
+
# queries the xray API for violations based upon the input json
|
194
|
+
def get_xray_violations_detail(xray_violation_detail_url, access_token)
|
195
|
+
response = RestClient::Request.new(
|
196
|
+
:method => :get,
|
197
|
+
:url => xray_violation_detail_url,
|
198
|
+
headers: {Authorization:'Bearer ' + access_token}
|
199
|
+
).execute do |response, request, result|
|
200
|
+
case response.code
|
201
|
+
when 200
|
202
|
+
return response.to_str
|
203
|
+
else
|
204
|
+
raise Fluent::StandardError, "Cannot reach Artifactory URL to pull Xray SIEM violations."
|
205
|
+
end
|
206
|
+
end
|
207
|
+
end
|
208
|
+
|
209
|
+
|
210
|
+
# queries the xray API for violations based upon the input json
|
211
|
+
def get_xray_violations(xray_json, jpd_url, access_token)
|
212
|
+
response = RestClient::Request.new(
|
213
|
+
:method => :post,
|
214
|
+
:url => jpd_url + "/xray/api/v1/violations",
|
215
|
+
:payload => xray_json.to_json,
|
216
|
+
:headers => { :accept => :json, :content_type => :json, Authorization:'Bearer ' + access_token }
|
217
|
+
).execute do |response, request, result|
|
218
|
+
case response.code
|
219
|
+
when 200
|
220
|
+
return response.to_str
|
221
|
+
else
|
222
|
+
raise Fluent::StandardError, "Cannot reach Artifactory URL to pull Xray SIEM violations."
|
223
|
+
end
|
224
|
+
end
|
225
|
+
end
|
226
|
+
|
227
|
+
# normalizes Xray data according to common information models for all log-vendors
|
228
|
+
def data_normalization(detailResp)
|
229
|
+
detailResp_json = JSON.parse(detailResp)
|
230
|
+
properties = detailResp_json['properties']
|
231
|
+
cve = []
|
232
|
+
cvss_v2_list = []
|
233
|
+
cvss_v3_list = []
|
234
|
+
for index in 0..properties.length-1 do
|
235
|
+
if properties[index].key?('cve')
|
236
|
+
cve.push(properties[index]['cve'])
|
237
|
+
end
|
238
|
+
if properties[index].key?('cvss_v2')
|
239
|
+
cvss_v2_list.push(properties[index]['cvss_v2'])
|
240
|
+
end
|
241
|
+
if properties[index].key?('cvss_v3')
|
242
|
+
cvss_v3_list.push(properties[index]['cvss_v3'])
|
243
|
+
end
|
244
|
+
end
|
245
|
+
detailResp_json["cve"] = cve.sort.reverse[0]
|
246
|
+
cvss_v2 = cvss_v2_list.sort.reverse[0]
|
247
|
+
cvss_v3 = cvss_v3_list.sort.reverse[0]
|
248
|
+
if cvss_v3.length() > 0
|
249
|
+
cvss = cvss_v3
|
250
|
+
elsif cvss_v2.length() > 0
|
251
|
+
cvss = cvss_v2
|
252
|
+
end
|
253
|
+
cvss_score = cvss[0..2]
|
254
|
+
cvss_version = cvss.split(':')[1][0..2]
|
255
|
+
detailResp_json["cvss_score"] = cvss_score
|
256
|
+
detailResp_json["cvss_version"] = cvss_version
|
257
|
+
return detailResp_json
|
258
|
+
end
|
259
|
+
|
260
|
+
def pull_violation_details(xray_violation_detail_url, access_token)
|
261
|
+
begin
|
262
|
+
detailResp=get_xray_violations_detail(xray_violation_detail_url, access_token)
|
263
|
+
time = Fluent::Engine.now
|
264
|
+
detailResp_json = data_normalization(detailResp)
|
265
|
+
router.emit(@tag, time, detailResp_json)
|
266
|
+
rescue
|
267
|
+
raise Fluent::StandardError, "Error pulling violation details url #{xray_violation_detail_url}"
|
268
|
+
end
|
269
|
+
end
|
270
|
+
|
271
|
+
end
|
272
|
+
end
|
273
|
+
end
|
data/test/helper.rb
ADDED
@@ -0,0 +1,8 @@
|
|
1
|
+
$LOAD_PATH.unshift(File.expand_path("../../", __FILE__))
|
2
|
+
require "test-unit"
|
3
|
+
require "fluent/test"
|
4
|
+
require "fluent/test/driver/input"
|
5
|
+
require "fluent/test/helpers"
|
6
|
+
|
7
|
+
Test::Unit::TestCase.include(Fluent::Test::Helpers)
|
8
|
+
Test::Unit::TestCase.extend(Fluent::Test::Helpers)
|
@@ -0,0 +1,33 @@
|
|
1
|
+
require "helper"
|
2
|
+
require "fluent/plugin/in_jfrog_siem.rb"
|
3
|
+
|
4
|
+
class JfrogSiemInputTest < Test::Unit::TestCase
|
5
|
+
setup do
|
6
|
+
Fluent::Test.setup
|
7
|
+
end
|
8
|
+
|
9
|
+
test "failure" do
|
10
|
+
#flunk
|
11
|
+
end
|
12
|
+
|
13
|
+
# Default configuration for tests
|
14
|
+
CONFIG = %[
|
15
|
+
tag "test_tag"
|
16
|
+
jpd_url <jpd_url>
|
17
|
+
access_token <access_token>
|
18
|
+
pos_file "test_pos.txt"
|
19
|
+
]
|
20
|
+
|
21
|
+
private
|
22
|
+
|
23
|
+
def create_driver(conf = CONFIG)
|
24
|
+
Fluent::Test::Driver::Input.new(Fluent::Plugin::JfrogSiemInput).configure(conf)
|
25
|
+
end
|
26
|
+
|
27
|
+
sub_test_case 'Testing' do
|
28
|
+
test 'Testing plugin in_jfrog_siem' do
|
29
|
+
d = create_driver(CONFIG)
|
30
|
+
d.run
|
31
|
+
end
|
32
|
+
end
|
33
|
+
end
|
metadata
ADDED
@@ -0,0 +1,133 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: fluent-plugin-jfrog-siem
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- John Peterson
|
8
|
+
- Mahitha Byreddy
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2020-11-17 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: bundler
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
requirements:
|
18
|
+
- - "~>"
|
19
|
+
- !ruby/object:Gem::Version
|
20
|
+
version: '2.0'
|
21
|
+
type: :development
|
22
|
+
prerelease: false
|
23
|
+
version_requirements: !ruby/object:Gem::Requirement
|
24
|
+
requirements:
|
25
|
+
- - "~>"
|
26
|
+
- !ruby/object:Gem::Version
|
27
|
+
version: '2.0'
|
28
|
+
- !ruby/object:Gem::Dependency
|
29
|
+
name: rake
|
30
|
+
requirement: !ruby/object:Gem::Requirement
|
31
|
+
requirements:
|
32
|
+
- - "~>"
|
33
|
+
- !ruby/object:Gem::Version
|
34
|
+
version: '12.0'
|
35
|
+
type: :development
|
36
|
+
prerelease: false
|
37
|
+
version_requirements: !ruby/object:Gem::Requirement
|
38
|
+
requirements:
|
39
|
+
- - "~>"
|
40
|
+
- !ruby/object:Gem::Version
|
41
|
+
version: '12.0'
|
42
|
+
- !ruby/object:Gem::Dependency
|
43
|
+
name: test-unit
|
44
|
+
requirement: !ruby/object:Gem::Requirement
|
45
|
+
requirements:
|
46
|
+
- - "~>"
|
47
|
+
- !ruby/object:Gem::Version
|
48
|
+
version: '3.0'
|
49
|
+
type: :development
|
50
|
+
prerelease: false
|
51
|
+
version_requirements: !ruby/object:Gem::Requirement
|
52
|
+
requirements:
|
53
|
+
- - "~>"
|
54
|
+
- !ruby/object:Gem::Version
|
55
|
+
version: '3.0'
|
56
|
+
- !ruby/object:Gem::Dependency
|
57
|
+
name: rest-client
|
58
|
+
requirement: !ruby/object:Gem::Requirement
|
59
|
+
requirements:
|
60
|
+
- - "~>"
|
61
|
+
- !ruby/object:Gem::Version
|
62
|
+
version: '2.0'
|
63
|
+
type: :development
|
64
|
+
prerelease: false
|
65
|
+
version_requirements: !ruby/object:Gem::Requirement
|
66
|
+
requirements:
|
67
|
+
- - "~>"
|
68
|
+
- !ruby/object:Gem::Version
|
69
|
+
version: '2.0'
|
70
|
+
- !ruby/object:Gem::Dependency
|
71
|
+
name: fluentd
|
72
|
+
requirement: !ruby/object:Gem::Requirement
|
73
|
+
requirements:
|
74
|
+
- - ">="
|
75
|
+
- !ruby/object:Gem::Version
|
76
|
+
version: 0.14.10
|
77
|
+
- - "<"
|
78
|
+
- !ruby/object:Gem::Version
|
79
|
+
version: '2'
|
80
|
+
type: :runtime
|
81
|
+
prerelease: false
|
82
|
+
version_requirements: !ruby/object:Gem::Requirement
|
83
|
+
requirements:
|
84
|
+
- - ">="
|
85
|
+
- !ruby/object:Gem::Version
|
86
|
+
version: 0.14.10
|
87
|
+
- - "<"
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '2'
|
90
|
+
description: JFrog SIEM fluent input plugin will send the SIEM events from JFrog Xray
|
91
|
+
to Fluentd which can then be delivered to whatever output plugin specified
|
92
|
+
email:
|
93
|
+
- johnp@jfrog.com
|
94
|
+
- mahithab@jfrog.com
|
95
|
+
executables: []
|
96
|
+
extensions: []
|
97
|
+
extra_rdoc_files: []
|
98
|
+
files:
|
99
|
+
- Gemfile
|
100
|
+
- LICENSE
|
101
|
+
- README.md
|
102
|
+
- Rakefile
|
103
|
+
- fluent-plugin-jfrog-siem.gemspec
|
104
|
+
- lib/fluent/plugin/in_jfrog_siem.rb
|
105
|
+
- test/helper.rb
|
106
|
+
- test/plugin/test_in_jfrog_siem.rb
|
107
|
+
homepage: https://github.com/jfrog/log-analytics
|
108
|
+
licenses:
|
109
|
+
- Apache-2.0
|
110
|
+
metadata: {}
|
111
|
+
post_install_message:
|
112
|
+
rdoc_options: []
|
113
|
+
require_paths:
|
114
|
+
- lib
|
115
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
116
|
+
requirements:
|
117
|
+
- - ">="
|
118
|
+
- !ruby/object:Gem::Version
|
119
|
+
version: '0'
|
120
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - ">="
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '0'
|
125
|
+
requirements: []
|
126
|
+
rubygems_version: 3.0.3
|
127
|
+
signing_key:
|
128
|
+
specification_version: 4
|
129
|
+
summary: JFrog SIEM fluent input plugin will send the SIEM events from JFrog Xray
|
130
|
+
to Fluentd
|
131
|
+
test_files:
|
132
|
+
- test/helper.rb
|
133
|
+
- test/plugin/test_in_jfrog_siem.rb
|