logstash-input-snmptrap 3.0.6 → 3.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +3 -0
- data/LICENSE +199 -10
- data/README.md +1 -1
- data/docs/index.asciidoc +39 -1
- data/lib/logstash/inputs/snmptrap.rb +44 -16
- data/logstash-input-snmptrap.gemspec +5 -3
- data/spec/inputs/snmptrap_spec.rb +100 -1
- metadata +47 -6
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ba1d2c2bd7c02fdb88a9f064c411d85c0b296d8bf9075f9d8c0ba04daaca8f24
|
|
4
|
+
data.tar.gz: c2a4c72caa48fe47a43c1d09aaf5122136145547904a52f30b6a22ad70d8f1a1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b57f275dc44b133fd1a6e89200690b575dd649662b1efb5282e152e09457381a5db6af06028ad3e4d7fc1ed7d45f9bbc204406e019bce99cfa7c71f04e351a59
|
|
7
|
+
data.tar.gz: a622f211c0400fa4c86e3cdf721fb3012dae7a07ad54f2a1e44ce521c55ff8e9d57c75b946b5d0b7afd8e5198983e85f67482d24629df1e74cf3b9c31f59b9c8
|
data/CHANGELOG.md
CHANGED
data/LICENSE
CHANGED
|
@@ -1,13 +1,202 @@
|
|
|
1
|
-
Copyright (c) 2012-2018 Elasticsearch <http://www.elastic.co>
|
|
2
1
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
6
5
|
|
|
7
|
-
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
8
7
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
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 2020 Elastic and contributors
|
|
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
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Logstash Plugin
|
|
2
2
|
|
|
3
|
-
[](https://travis-ci.com/logstash-plugins/logstash-input-snmptrap)
|
|
4
4
|
|
|
5
5
|
This is a plugin for [Logstash](https://github.com/elastic/logstash).
|
|
6
6
|
|
data/docs/index.asciidoc
CHANGED
|
@@ -23,7 +23,7 @@ include::{include_path}/plugin_header.asciidoc[]
|
|
|
23
23
|
|
|
24
24
|
Read snmp trap messages as events
|
|
25
25
|
|
|
26
|
-
Resulting
|
|
26
|
+
Resulting `message` field resembles:
|
|
27
27
|
[source,ruby]
|
|
28
28
|
#<SNMP::SNMPv1_Trap:0x6f1a7a4 @varbind_list=[#<SNMP::VarBind:0x2d7bcd8f @value="teststring",
|
|
29
29
|
@name=[1.11.12.13.14.15]>], @timestamp=#<SNMP::TimeTicks:0x1af47e9d @value=55>, @generic_trap=6,
|
|
@@ -31,6 +31,18 @@ Resulting `@message` looks like :
|
|
|
31
31
|
@specific_trap=99>
|
|
32
32
|
|
|
33
33
|
|
|
34
|
+
[id="plugins-{type}s-{plugin}-ecs"]
|
|
35
|
+
==== Compatibility with the Elastic Common Schema (ECS)
|
|
36
|
+
|
|
37
|
+
Because SNMP data has specific field names based on OIDs, we recommend setting a <<plugins-{type}s-{plugin}-target>>.
|
|
38
|
+
The source host field changes based on <<plugins-{type}s-{plugin}-ecs_compatibility>>.
|
|
39
|
+
|
|
40
|
+
[cols="<l,<l,e,<e"]
|
|
41
|
+
|=======================================================================
|
|
42
|
+
|ECS disabled |ECS v1, v8 |Description
|
|
43
|
+
|[host] |[host][ip] |IP address of the host e.g. "192.168.1.11"
|
|
44
|
+
|=======================================================================
|
|
45
|
+
|
|
34
46
|
[id="plugins-{type}s-{plugin}-options"]
|
|
35
47
|
==== Snmptrap Input Configuration Options
|
|
36
48
|
|
|
@@ -40,8 +52,10 @@ This plugin supports the following configuration options plus the <<plugins-{typ
|
|
|
40
52
|
|=======================================================================
|
|
41
53
|
|Setting |Input type|Required
|
|
42
54
|
| <<plugins-{type}s-{plugin}-community>> |<<array,array>>|No
|
|
55
|
+
| <<plugins-{type}s-{plugin}-ecs_compatibility>> |<<string,string>>|No
|
|
43
56
|
| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|No
|
|
44
57
|
| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
|
|
58
|
+
| <<plugins-{type}s-{plugin}-target>> |<<string,string>>|No
|
|
45
59
|
| <<plugins-{type}s-{plugin}-yamlmibdir>> |<<string,string>>|No
|
|
46
60
|
|=======================================================================
|
|
47
61
|
|
|
@@ -58,6 +72,19 @@ input plugins.
|
|
|
58
72
|
|
|
59
73
|
SNMP Community String to listen for.
|
|
60
74
|
|
|
75
|
+
[id="plugins-{type}s-{plugin}-ecs_compatibility"]
|
|
76
|
+
===== `ecs_compatibility`
|
|
77
|
+
|
|
78
|
+
* Value type is <<string,string>>
|
|
79
|
+
* Supported values are:
|
|
80
|
+
** `disabled`: does not use ECS-compatible field names (fields might be set at the root of the event)
|
|
81
|
+
** `v1`, `v8`: avoids field names that might conflict with Elastic Common Schema (for example, the `host` field)
|
|
82
|
+
* Default value depends on which version of Logstash is running:
|
|
83
|
+
** When Logstash provides a `pipeline.ecs_compatibility` setting, its value is used as the default
|
|
84
|
+
** Otherwise, the default value is `disabled`.
|
|
85
|
+
|
|
86
|
+
Controls this plugin's compatibility with the {ecs-ref}[Elastic Common Schema (ECS)].
|
|
87
|
+
|
|
61
88
|
[id="plugins-{type}s-{plugin}-host"]
|
|
62
89
|
===== `host`
|
|
63
90
|
|
|
@@ -75,6 +102,17 @@ The address to listen on
|
|
|
75
102
|
The port to listen on. Remember that ports less than 1024 (privileged
|
|
76
103
|
ports) may require root to use. hence the default of 1062.
|
|
77
104
|
|
|
105
|
+
[id="plugins-{type}s-{plugin}-target"]
|
|
106
|
+
===== `target`
|
|
107
|
+
|
|
108
|
+
* Value type is <<string,string>>
|
|
109
|
+
* There is no default value for this setting
|
|
110
|
+
|
|
111
|
+
The name of the field under which SNMP payloads are assigned.
|
|
112
|
+
If not specified data will be stored in the root of the event.
|
|
113
|
+
|
|
114
|
+
Setting a target is recommended when <<plugins-{type}s-{plugin}-ecs_compatibility>> is enabled.
|
|
115
|
+
|
|
78
116
|
[id="plugins-{type}s-{plugin}-yamlmibdir"]
|
|
79
117
|
===== `yamlmibdir`
|
|
80
118
|
|
|
@@ -5,6 +5,11 @@ require "logstash/namespace"
|
|
|
5
5
|
require "snmp"
|
|
6
6
|
require_relative "snmptrap/patches/trap_listener"
|
|
7
7
|
|
|
8
|
+
require 'logstash/plugin_mixins/ecs_compatibility_support'
|
|
9
|
+
require 'logstash/plugin_mixins/ecs_compatibility_support/target_check'
|
|
10
|
+
require 'logstash/plugin_mixins/event_support/event_factory_adapter'
|
|
11
|
+
require 'logstash/plugin_mixins/validator_support/field_reference_validation_adapter'
|
|
12
|
+
|
|
8
13
|
# Read snmp trap messages as events
|
|
9
14
|
#
|
|
10
15
|
# Resulting `@message` looks like :
|
|
@@ -16,6 +21,14 @@ require_relative "snmptrap/patches/trap_listener"
|
|
|
16
21
|
#
|
|
17
22
|
|
|
18
23
|
class LogStash::Inputs::Snmptrap < LogStash::Inputs::Base
|
|
24
|
+
|
|
25
|
+
include LogStash::PluginMixins::ECSCompatibilitySupport(:disabled, :v1, :v8 => :v1)
|
|
26
|
+
include LogStash::PluginMixins::ECSCompatibilitySupport::TargetCheck
|
|
27
|
+
|
|
28
|
+
include LogStash::PluginMixins::EventSupport::EventFactoryAdapter
|
|
29
|
+
|
|
30
|
+
extend LogStash::PluginMixins::ValidatorSupport::FieldReferenceValidationAdapter
|
|
31
|
+
|
|
19
32
|
config_name "snmptrap"
|
|
20
33
|
|
|
21
34
|
# The address to listen on
|
|
@@ -31,9 +44,16 @@ class LogStash::Inputs::Snmptrap < LogStash::Inputs::Base
|
|
|
31
44
|
# directory of YAML MIB maps (same format ruby-snmp uses)
|
|
32
45
|
config :yamlmibdir, :validate => :string
|
|
33
46
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
47
|
+
# Defines a target field for placing fields.
|
|
48
|
+
# If this setting is omitted, data gets stored at the root (top level) of the event.
|
|
49
|
+
# The target is only relevant while decoding data into a new event.
|
|
50
|
+
config :target, :validate => :field_reference
|
|
51
|
+
|
|
52
|
+
def initialize(params={})
|
|
53
|
+
super(params)
|
|
54
|
+
|
|
55
|
+
@host_ip_field = ecs_select[disabled: 'host', v1: '[host][ip]']
|
|
56
|
+
end
|
|
37
57
|
|
|
38
58
|
def register
|
|
39
59
|
@snmptrap = nil
|
|
@@ -51,7 +71,7 @@ class LogStash::Inputs::Snmptrap < LogStash::Inputs::Base
|
|
|
51
71
|
def run(output_queue)
|
|
52
72
|
begin
|
|
53
73
|
# snmp trap server
|
|
54
|
-
snmptrap_listener(output_queue)
|
|
74
|
+
snmptrap_listener(output_queue).join
|
|
55
75
|
rescue => e
|
|
56
76
|
@logger.warn("SNMP Trap listener died", :exception => e, :backtrace => e.backtrace)
|
|
57
77
|
Stud.stoppable_sleep(5) { stop? }
|
|
@@ -72,26 +92,34 @@ class LogStash::Inputs::Snmptrap < LogStash::Inputs::Base
|
|
|
72
92
|
traplistener_opts.merge!({:MibDir => @yamlmibdir, :MibModules => @yaml_mibs})
|
|
73
93
|
end
|
|
74
94
|
@logger.info("It's a Trap!", traplistener_opts.dup)
|
|
75
|
-
|
|
95
|
+
SNMP::TrapListener.new(traplistener_opts)
|
|
76
96
|
end
|
|
77
97
|
|
|
78
98
|
def snmptrap_listener(output_queue)
|
|
79
|
-
build_trap_listener
|
|
99
|
+
@snmptrap = build_trap_listener
|
|
80
100
|
|
|
81
101
|
@snmptrap.on_trap_default do |trap|
|
|
82
102
|
begin
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
event.set(vb.name.to_s, vb.value.to_s)
|
|
87
|
-
end
|
|
88
|
-
@logger.debug("SNMP Trap received: ", :trap_object => trap.inspect)
|
|
89
|
-
output_queue << event
|
|
90
|
-
rescue => event
|
|
91
|
-
@logger.error("Failed to create event", :trap_object => trap.inspect)
|
|
103
|
+
output_queue << process_trap(trap)
|
|
104
|
+
rescue => e
|
|
105
|
+
@logger.error("Failed to create event", :exception => e, :backtrace => e.backtrace, :trap_object => trap)
|
|
92
106
|
end
|
|
93
107
|
end
|
|
94
|
-
@snmptrap
|
|
108
|
+
@snmptrap
|
|
95
109
|
end # def snmptrap_listener
|
|
96
110
|
|
|
111
|
+
def process_trap(trap)
|
|
112
|
+
@logger.debug? && @logger.debug("SNMP Trap received: ", :trap_object => trap.inspect)
|
|
113
|
+
|
|
114
|
+
data = Hash.new
|
|
115
|
+
trap.each_varbind do |vb|
|
|
116
|
+
data[vb.name.to_s] = vb.value.to_s
|
|
117
|
+
end
|
|
118
|
+
event = targeted_event_factory.new_event(data)
|
|
119
|
+
event.set(@host_ip_field, trap.source_ip) if trap.source_ip
|
|
120
|
+
event.set('message', trap.inspect)
|
|
121
|
+
decorate(event)
|
|
122
|
+
event
|
|
123
|
+
end
|
|
124
|
+
|
|
97
125
|
end # class LogStash::Inputs::Snmptrap
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
Gem::Specification.new do |s|
|
|
2
2
|
|
|
3
3
|
s.name = 'logstash-input-snmptrap'
|
|
4
|
-
s.version = '3.0
|
|
4
|
+
s.version = '3.1.0'
|
|
5
5
|
s.licenses = ['Apache License (2.0)']
|
|
6
6
|
s.summary = "Creates events based on SNMP trap messages"
|
|
7
7
|
s.description = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
|
|
@@ -21,9 +21,11 @@ Gem::Specification.new do |s|
|
|
|
21
21
|
|
|
22
22
|
# Gem dependencies
|
|
23
23
|
s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
|
|
24
|
-
|
|
25
|
-
s.add_runtime_dependency '
|
|
24
|
+
s.add_runtime_dependency 'logstash-mixin-ecs_compatibility_support', '~> 1.3'
|
|
25
|
+
s.add_runtime_dependency 'logstash-mixin-event_support', '~> 1.0'
|
|
26
|
+
s.add_runtime_dependency 'logstash-mixin-validator_support', '~> 1.0'
|
|
26
27
|
s.add_runtime_dependency 'logstash-codec-plain'
|
|
28
|
+
s.add_runtime_dependency 'snmp'
|
|
27
29
|
|
|
28
30
|
s.add_development_dependency 'logstash-devutils'
|
|
29
31
|
end
|
|
@@ -1,7 +1,10 @@
|
|
|
1
1
|
require "logstash/devutils/rspec/spec_helper"
|
|
2
|
+
require "logstash/devutils/rspec/shared_examples"
|
|
3
|
+
require 'logstash/plugin_mixins/ecs_compatibility_support/spec_helper'
|
|
2
4
|
require 'logstash/inputs/snmptrap'
|
|
3
5
|
|
|
4
|
-
describe LogStash::Inputs::Snmptrap do
|
|
6
|
+
describe LogStash::Inputs::Snmptrap, :ecs_compatibility_support do
|
|
7
|
+
|
|
5
8
|
it_behaves_like "an interruptible input plugin" do
|
|
6
9
|
# as there is no mocking the run method will
|
|
7
10
|
# raise a connection error and put the run method
|
|
@@ -9,4 +12,100 @@ describe LogStash::Inputs::Snmptrap do
|
|
|
9
12
|
# meaning that the stoppable sleep impl is tested
|
|
10
13
|
let(:config) { {} }
|
|
11
14
|
end
|
|
15
|
+
|
|
16
|
+
let(:config) { Hash.new }
|
|
17
|
+
|
|
18
|
+
subject(:input) { described_class.new(config) }
|
|
19
|
+
|
|
20
|
+
let(:source_ip) { '192.168.1.11' }
|
|
21
|
+
|
|
22
|
+
let(:snmp_manager) do
|
|
23
|
+
SNMP::Manager.new.tap do |manager|
|
|
24
|
+
def manager.send_request(trap, community, host, port)
|
|
25
|
+
trap # dummy manager - we're just using the Manager API to create traps
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
ecs_compatibility_matrix(:disabled, :v1, :v8) do |ecs_select|
|
|
31
|
+
|
|
32
|
+
let(:config) { super().merge 'ecs_compatibility' => ecs_compatibility }
|
|
33
|
+
|
|
34
|
+
context 'with an SNMP v1 trap' do
|
|
35
|
+
|
|
36
|
+
let(:trap) do
|
|
37
|
+
trap = snmp_manager.trap_v1("enterprises.9", "10.1.2.3", :enterpriseSpecific, 42, 12345,
|
|
38
|
+
[SNMP::VarBind.new("1.3.6.1.2.3.4", SNMP::Integer.new(111))])
|
|
39
|
+
trap.source_ip = source_ip
|
|
40
|
+
trap
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
before { @event = input.send :process_trap, trap }
|
|
44
|
+
|
|
45
|
+
it "extract snmp payload" do
|
|
46
|
+
expect( @event.get('message') ).to be_a String # #<SNMP::SNMPv1_Trap:0x664c6bbc @enterprise=[1.3.6.1.4.1.9] ... >
|
|
47
|
+
expect( @event.get('1.3.6.1.2.3.4') ).to eql '111'
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
it "sets source host" do
|
|
51
|
+
if ecs_select.active_mode == :disabled
|
|
52
|
+
expect( @event.get('host') ).to eql source_ip
|
|
53
|
+
else
|
|
54
|
+
expect( @event.get('host') ).to eql 'ip' => source_ip
|
|
55
|
+
end
|
|
56
|
+
end
|
|
57
|
+
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
context 'with an SNMP v2 trap' do
|
|
61
|
+
|
|
62
|
+
let(:trap) do
|
|
63
|
+
trap = snmp_manager.trap_v2(1011, "1.3.6.1.2.1.1.1.0", ["1.2.3", "1.4.5.6"])
|
|
64
|
+
trap.source_ip = source_ip
|
|
65
|
+
trap
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
before { @event = input.send :process_trap, trap }
|
|
69
|
+
|
|
70
|
+
it "extract snmp payload" do
|
|
71
|
+
expect( @event.get('message') ).to be_a String
|
|
72
|
+
|
|
73
|
+
expect( @event.get('1.2.3') ).to eql 'Null'
|
|
74
|
+
expect( @event.get('1.3.6.1.2.1.1.3.0') ).to eql '00:00:10.11' # uptime tick
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
it "sets source host" do
|
|
78
|
+
if ecs_select.active_mode == :disabled
|
|
79
|
+
expect( @event.get('host') ).to eql source_ip
|
|
80
|
+
else
|
|
81
|
+
expect( @event.get('host') ).to eql 'ip' => source_ip
|
|
82
|
+
end
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
context 'with target' do
|
|
86
|
+
|
|
87
|
+
let(:config) { super().merge 'target' => '[snmp]' }
|
|
88
|
+
|
|
89
|
+
it "extract snmp payload" do
|
|
90
|
+
expect( @event.include?('1.2.3') ).to be false
|
|
91
|
+
expect( @event.include?('1.3.6.1.2.1.1.3.0') ).to be false
|
|
92
|
+
expect( @event.get('[snmp][1.2.3]') ).to eql 'Null'
|
|
93
|
+
expect( @event.get('[snmp][1.3.6.1.2.1.1.3.0]') ).to eql '00:00:10.11' # uptime tick
|
|
94
|
+
|
|
95
|
+
expect( @event.get('message') ).to be_a String
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
it "sets source host" do
|
|
99
|
+
if ecs_select.active_mode == :disabled
|
|
100
|
+
expect( @event.get('host') ).to eql source_ip
|
|
101
|
+
else
|
|
102
|
+
expect( @event.get('host') ).to eql 'ip' => source_ip
|
|
103
|
+
end
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
end
|
|
12
111
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: logstash-input-snmptrap
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 3.0
|
|
4
|
+
version: 3.1.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Elastic
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2021-11-19 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -30,13 +30,55 @@ dependencies:
|
|
|
30
30
|
- - "<="
|
|
31
31
|
- !ruby/object:Gem::Version
|
|
32
32
|
version: '2.99'
|
|
33
|
+
- !ruby/object:Gem::Dependency
|
|
34
|
+
requirement: !ruby/object:Gem::Requirement
|
|
35
|
+
requirements:
|
|
36
|
+
- - "~>"
|
|
37
|
+
- !ruby/object:Gem::Version
|
|
38
|
+
version: '1.3'
|
|
39
|
+
name: logstash-mixin-ecs_compatibility_support
|
|
40
|
+
prerelease: false
|
|
41
|
+
type: :runtime
|
|
42
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
43
|
+
requirements:
|
|
44
|
+
- - "~>"
|
|
45
|
+
- !ruby/object:Gem::Version
|
|
46
|
+
version: '1.3'
|
|
47
|
+
- !ruby/object:Gem::Dependency
|
|
48
|
+
requirement: !ruby/object:Gem::Requirement
|
|
49
|
+
requirements:
|
|
50
|
+
- - "~>"
|
|
51
|
+
- !ruby/object:Gem::Version
|
|
52
|
+
version: '1.0'
|
|
53
|
+
name: logstash-mixin-event_support
|
|
54
|
+
prerelease: false
|
|
55
|
+
type: :runtime
|
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
57
|
+
requirements:
|
|
58
|
+
- - "~>"
|
|
59
|
+
- !ruby/object:Gem::Version
|
|
60
|
+
version: '1.0'
|
|
61
|
+
- !ruby/object:Gem::Dependency
|
|
62
|
+
requirement: !ruby/object:Gem::Requirement
|
|
63
|
+
requirements:
|
|
64
|
+
- - "~>"
|
|
65
|
+
- !ruby/object:Gem::Version
|
|
66
|
+
version: '1.0'
|
|
67
|
+
name: logstash-mixin-validator_support
|
|
68
|
+
prerelease: false
|
|
69
|
+
type: :runtime
|
|
70
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
71
|
+
requirements:
|
|
72
|
+
- - "~>"
|
|
73
|
+
- !ruby/object:Gem::Version
|
|
74
|
+
version: '1.0'
|
|
33
75
|
- !ruby/object:Gem::Dependency
|
|
34
76
|
requirement: !ruby/object:Gem::Requirement
|
|
35
77
|
requirements:
|
|
36
78
|
- - ">="
|
|
37
79
|
- !ruby/object:Gem::Version
|
|
38
80
|
version: '0'
|
|
39
|
-
name:
|
|
81
|
+
name: logstash-codec-plain
|
|
40
82
|
prerelease: false
|
|
41
83
|
type: :runtime
|
|
42
84
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -50,7 +92,7 @@ dependencies:
|
|
|
50
92
|
- - ">="
|
|
51
93
|
- !ruby/object:Gem::Version
|
|
52
94
|
version: '0'
|
|
53
|
-
name:
|
|
95
|
+
name: snmp
|
|
54
96
|
prerelease: false
|
|
55
97
|
type: :runtime
|
|
56
98
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -112,8 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
112
154
|
- !ruby/object:Gem::Version
|
|
113
155
|
version: '0'
|
|
114
156
|
requirements: []
|
|
115
|
-
|
|
116
|
-
rubygems_version: 2.6.11
|
|
157
|
+
rubygems_version: 3.1.6
|
|
117
158
|
signing_key:
|
|
118
159
|
specification_version: 4
|
|
119
160
|
summary: Creates events based on SNMP trap messages
|