logstash-filter-dns 3.1.2 → 3.1.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/LICENSE +199 -10
- data/README.md +1 -1
- data/docs/index.asciidoc +3 -3
- data/lib/logstash/filters/dns.rb +75 -24
- data/logstash-filter-dns.gemspec +5 -1
- data/spec/filters/dns_spec.rb +71 -12
- metadata +18 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2bfbc599a24bf91ca96cb549cbee80394e3660b968178c94739437b96b2639b4
|
4
|
+
data.tar.gz: 18f7cde848f00e8164cabd416e4fb1f2f0f6ee699bae018ae4c1f327e781adb1
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4b899b43f760b97f33f88637591cd4367edc9c919c2d55db9d7726e783ba424396a2641a1f54c3cba1eb1562d54eb0d413456e70f21cf83c5585bb766eb3f104
|
7
|
+
data.tar.gz: a94cd76f11a1f4f85e4981f8b3b8d6d8cd9de2f625a1a87c22544876254f899c0099915eb39f1cea38b5c2075663826768c9ee663c30fe135d6b05def2508b63
|
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,13 @@
|
|
1
|
+
## 3.1.5
|
2
|
+
- Fixed an issue where a non-string value existing in the resolve/reverse field could cause the plugin to crash
|
3
|
+
|
4
|
+
## 3.1.4
|
5
|
+
- Replaced Timeout::timeout block with `Resolv::DNS::timeouts=` [#62](https://github.com/logstash-plugins/logstash-filter-dns/pull/62)
|
6
|
+
- Added restriction for ruby version > 2.0, effectively making Logstash 6.x+ a requirement [#62](https://github.com/logstash-plugins/logstash-filter-dns/pull/62)
|
7
|
+
|
8
|
+
## 3.1.3
|
9
|
+
- Fixed an issue where each missed lookup could result in unreclaimed memory ([jruby bug](https://github.com/jruby/jruby/issues/6015)) by handling lookup misses without raising exceptions [#61](https://github.com/logstash-plugins/logstash-filter-dns/pull/61)
|
10
|
+
|
1
11
|
## 3.1.2
|
2
12
|
- Added restriction on JRuby resolv.rb patch to versions prior to 9.2.9.0 [#58](https://github.com/logstash-plugins/logstash-filter-dns/pull/58)
|
3
13
|
|
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
|
-
[![Travis Build Status](https://travis-ci.
|
3
|
+
[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-filter-dns.svg)](https://travis-ci.com/logstash-plugins/logstash-filter-dns)
|
4
4
|
|
5
5
|
This is a plugin for [Logstash](https://github.com/elastic/logstash).
|
6
6
|
|
data/docs/index.asciidoc
CHANGED
@@ -79,7 +79,7 @@ specified under `reverse` and `resolve`.
|
|
79
79
|
===== `failed_cache_size`
|
80
80
|
|
81
81
|
* Value type is <<number,number>>
|
82
|
-
* Default value is `0`
|
82
|
+
* Default value is `0` (cache disabled)
|
83
83
|
|
84
84
|
cache size for failed requests
|
85
85
|
|
@@ -95,7 +95,7 @@ how long to cache failed requests (in seconds)
|
|
95
95
|
===== `hit_cache_size`
|
96
96
|
|
97
97
|
* Value type is <<number,number>>
|
98
|
-
* Default value is `0`
|
98
|
+
* Default value is `0` (cache disabled)
|
99
99
|
|
100
100
|
set the size of cache for successful requests
|
101
101
|
|
@@ -176,4 +176,4 @@ Reverse resolve one or more fields.
|
|
176
176
|
|
177
177
|
|
178
178
|
[id="plugins-{type}s-{plugin}-common-options"]
|
179
|
-
include::{include_path}/{type}.asciidoc[]
|
179
|
+
include::{include_path}/{type}.asciidoc[]
|
data/lib/logstash/filters/dns.rb
CHANGED
@@ -3,7 +3,6 @@ require "logstash/filters/base"
|
|
3
3
|
require "logstash/namespace"
|
4
4
|
require "lru_redux"
|
5
5
|
require "resolv"
|
6
|
-
require "timeout"
|
7
6
|
require "logstash/filters/dns/resolv_patch"
|
8
7
|
|
9
8
|
java_import 'java.net.IDN'
|
@@ -29,7 +28,6 @@ java_import 'java.net.IDN'
|
|
29
28
|
# milliseconds, the maximum throughput you can achieve with a single filter
|
30
29
|
# worker is 500 events per second (1000 milliseconds / 2 milliseconds).
|
31
30
|
class LogStash::Filters::DNS < LogStash::Filters::Base
|
32
|
-
# TODO(sissel): The timeout limitation does seem to be fixed in here: http://redmine.ruby-lang.org/issues/5100 # but isn't currently in JRuby.
|
33
31
|
# TODO(sissel): make `action` required? This was always the intent, but it
|
34
32
|
# due to a typo it was never enforced. Thus the default behavior in past
|
35
33
|
# versions was `append` by accident.
|
@@ -94,7 +92,7 @@ class LogStash::Filters::DNS < LogStash::Filters::Base
|
|
94
92
|
public
|
95
93
|
def register
|
96
94
|
if @nameserver.nil? && @hostsfile.nil?
|
97
|
-
@resolv = Resolv.new
|
95
|
+
@resolv = Resolv.new(default_resolvers)
|
98
96
|
else
|
99
97
|
@resolv = Resolv.new(build_resolvers)
|
100
98
|
end
|
@@ -125,6 +123,20 @@ class LogStash::Filters::DNS < LogStash::Filters::Base
|
|
125
123
|
|
126
124
|
private
|
127
125
|
|
126
|
+
def default_resolvers
|
127
|
+
[::Resolv::Hosts.new, default_dns_resolver]
|
128
|
+
end
|
129
|
+
|
130
|
+
def default_dns_resolver
|
131
|
+
dns_resolver(nil)
|
132
|
+
end
|
133
|
+
|
134
|
+
def dns_resolver(args=nil)
|
135
|
+
dns_resolver = ::Resolv::DNS.new(args)
|
136
|
+
dns_resolver.timeouts = @timeout
|
137
|
+
dns_resolver
|
138
|
+
end
|
139
|
+
|
128
140
|
def build_resolvers
|
129
141
|
build_user_host_resolvers.concat([::Resolv::Hosts.new]).concat(build_user_dns_resolver)
|
130
142
|
end
|
@@ -136,8 +148,7 @@ class LogStash::Filters::DNS < LogStash::Filters::Base
|
|
136
148
|
|
137
149
|
def build_user_dns_resolver
|
138
150
|
return [] if @nameserver.nil? || @nameserver.empty?
|
139
|
-
|
140
|
-
[::Resolv::DNS.new(normalised_nameserver)]
|
151
|
+
[dns_resolver(normalised_nameserver)]
|
141
152
|
end
|
142
153
|
|
143
154
|
def normalised_nameserver
|
@@ -183,6 +194,11 @@ class LogStash::Filters::DNS < LogStash::Filters::Base
|
|
183
194
|
raw = raw.first
|
184
195
|
end
|
185
196
|
|
197
|
+
if !raw.kind_of?(String)
|
198
|
+
@logger.warn("DNS: skipping resolve, can't deal with non-string values", :field => field, :value => raw)
|
199
|
+
return
|
200
|
+
end
|
201
|
+
|
186
202
|
begin
|
187
203
|
return if @failed_cache && @failed_cache[raw] # recently failed resolv, skip
|
188
204
|
if @hit_cache
|
@@ -195,12 +211,13 @@ class LogStash::Filters::DNS < LogStash::Filters::Base
|
|
195
211
|
else
|
196
212
|
address = retriable_getaddress(raw)
|
197
213
|
end
|
198
|
-
|
199
|
-
|
200
|
-
|
201
|
-
|
202
|
-
|
203
|
-
|
214
|
+
if address.nil?
|
215
|
+
@failed_cache[raw] = true if @failed_cache
|
216
|
+
@logger.debug("DNS: couldn't resolve the hostname.",
|
217
|
+
:field => field, :value => raw)
|
218
|
+
return
|
219
|
+
end
|
220
|
+
rescue Resolv::ResolvTimeout
|
204
221
|
@failed_cache[raw] = true if @failed_cache
|
205
222
|
@logger.warn("DNS: timeout on resolving the hostname.",
|
206
223
|
:field => field, :value => raw)
|
@@ -257,6 +274,11 @@ class LogStash::Filters::DNS < LogStash::Filters::Base
|
|
257
274
|
end
|
258
275
|
raw = raw.first
|
259
276
|
end
|
277
|
+
|
278
|
+
if !raw.kind_of?(String)
|
279
|
+
@logger.warn("DNS: skipping reverse, can't deal with non-string values", :field => field, :value => raw)
|
280
|
+
return
|
281
|
+
end
|
260
282
|
|
261
283
|
if ! @ip_validator.match(raw)
|
262
284
|
@logger.debug("DNS: not an address",
|
@@ -275,12 +297,13 @@ class LogStash::Filters::DNS < LogStash::Filters::Base
|
|
275
297
|
else
|
276
298
|
hostname = retriable_getname(raw)
|
277
299
|
end
|
278
|
-
|
279
|
-
|
280
|
-
|
281
|
-
|
282
|
-
|
283
|
-
|
300
|
+
if hostname.nil?
|
301
|
+
@failed_cache[raw] = true if @failed_cache
|
302
|
+
@logger.debug("DNS: couldn't resolve the address.",
|
303
|
+
:field => field, :value => raw)
|
304
|
+
return
|
305
|
+
end
|
306
|
+
rescue Resolv::ResolvTimeout
|
284
307
|
@failed_cache[raw] = true if @failed_cache
|
285
308
|
@logger.warn("DNS: timeout on resolving address.",
|
286
309
|
:field => field, :value => raw)
|
@@ -321,10 +344,8 @@ class LogStash::Filters::DNS < LogStash::Filters::Base
|
|
321
344
|
def retriable_request(&block)
|
322
345
|
tries = 0
|
323
346
|
begin
|
324
|
-
|
325
|
-
|
326
|
-
end
|
327
|
-
rescue Timeout::Error, SocketError
|
347
|
+
block.call
|
348
|
+
rescue Resolv::ResolvTimeout, SocketError
|
328
349
|
if tries < @max_retries
|
329
350
|
tries = tries + 1
|
330
351
|
retry
|
@@ -350,13 +371,43 @@ class LogStash::Filters::DNS < LogStash::Filters::Base
|
|
350
371
|
|
351
372
|
private
|
352
373
|
def getname(address)
|
353
|
-
name = @resolv
|
354
|
-
|
374
|
+
name = resolv_getname_or_nil(@resolv, address)
|
375
|
+
name && name.force_encoding(Encoding::UTF_8)
|
376
|
+
name && IDN.toUnicode(name)
|
355
377
|
end
|
356
378
|
|
357
379
|
private
|
358
380
|
def getaddress(name)
|
359
381
|
idn = IDN.toASCII(name)
|
360
|
-
@resolv
|
382
|
+
address = resolv_getaddress_or_nil(@resolv, idn)
|
383
|
+
address && address.force_encoding(Encoding::UTF_8)
|
384
|
+
end
|
385
|
+
|
386
|
+
private
|
387
|
+
def resolv_getname_or_nil(resolver, address)
|
388
|
+
# `Resolv#each_name` yields to the provided block zero or more times;
|
389
|
+
# to prevent it from yielding multiple times when more than one match
|
390
|
+
# is found, we return directly in the block.
|
391
|
+
# See also `Resolv#getname`
|
392
|
+
resolver.each_name(address) do |name|
|
393
|
+
return name
|
394
|
+
end
|
395
|
+
|
396
|
+
# If no match was found, we return nil.
|
397
|
+
return nil
|
398
|
+
end
|
399
|
+
|
400
|
+
private
|
401
|
+
def resolv_getaddress_or_nil(resolver, name)
|
402
|
+
# `Resolv#each_address` yields to the provided block zero or more times;
|
403
|
+
# to prevent it from yielding multiple times when more than one match
|
404
|
+
# is found, we return directly in the block.
|
405
|
+
# See also `Resolv#getaddress`
|
406
|
+
resolver.each_address(name) do |address|
|
407
|
+
return address
|
408
|
+
end
|
409
|
+
|
410
|
+
# If no match was found, we return nil.
|
411
|
+
return nil
|
361
412
|
end
|
362
413
|
end # class LogStash::Filters::DNS
|
data/logstash-filter-dns.gemspec
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
Gem::Specification.new do |s|
|
2
2
|
|
3
3
|
s.name = 'logstash-filter-dns'
|
4
|
-
s.version = '3.1.
|
4
|
+
s.version = '3.1.5'
|
5
5
|
s.licenses = ['Apache License (2.0)']
|
6
6
|
s.summary = "Performs a standard or reverse DNS lookup"
|
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"
|
@@ -10,6 +10,9 @@ Gem::Specification.new do |s|
|
|
10
10
|
s.homepage = "http://www.elastic.co/guide/en/logstash/current/index.html"
|
11
11
|
s.require_paths = ["lib"]
|
12
12
|
|
13
|
+
# This effectively requires Logstash >= 6.x
|
14
|
+
s.required_ruby_version = '>= 2.0.0'
|
15
|
+
|
13
16
|
# Files
|
14
17
|
s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
|
15
18
|
|
@@ -24,4 +27,5 @@ Gem::Specification.new do |s|
|
|
24
27
|
s.add_runtime_dependency 'lru_redux', "~> 1.1.0"
|
25
28
|
|
26
29
|
s.add_development_dependency 'logstash-devutils'
|
30
|
+
s.add_development_dependency 'insist'
|
27
31
|
end
|
data/spec/filters/dns_spec.rb
CHANGED
@@ -1,18 +1,24 @@
|
|
1
1
|
# encoding: utf-8
|
2
2
|
require "logstash/devutils/rspec/spec_helper"
|
3
|
+
require "insist"
|
3
4
|
require "logstash/filters/dns"
|
4
5
|
require "resolv"
|
6
|
+
require "logstash/filters/dns/resolv_patch"
|
7
|
+
|
5
8
|
|
6
9
|
describe LogStash::Filters::DNS do
|
7
10
|
describe "with stubbed Resolv" do
|
8
11
|
before(:each) do
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
allow_any_instance_of(Resolv).to receive(:
|
13
|
-
allow_any_instance_of(Resolv).to receive(:
|
14
|
-
allow_any_instance_of(Resolv).to receive(:
|
15
|
-
allow_any_instance_of(Resolv).to receive(:
|
12
|
+
# We use `Resolv#each_address` and `Resolv#each_name`, which have
|
13
|
+
# undefined return values but _yield_ once per result, so our stubs
|
14
|
+
# need to either yield a result or not yield at all if there is no result.
|
15
|
+
allow_any_instance_of(Resolv).to receive(:each_address).with("carrera.databits.net").and_yield("199.192.228.250")
|
16
|
+
allow_any_instance_of(Resolv).to receive(:each_address).with("does.not.exist") # no yield
|
17
|
+
allow_any_instance_of(Resolv).to receive(:each_address).with("nonexistanthostname###.net") # no yield
|
18
|
+
allow_any_instance_of(Resolv).to receive(:each_name).with("199.192.228.250").and_yield("carrera.databits.net")
|
19
|
+
allow_any_instance_of(Resolv).to receive(:each_name).with("127.0.0.1").and_yield("localhost")
|
20
|
+
allow_any_instance_of(Resolv).to receive(:each_name).with("128.0.0.1") # no yield
|
21
|
+
allow_any_instance_of(Resolv).to receive(:each_name).with("199.192.228.250").and_yield("carrera.databits.net")
|
16
22
|
end
|
17
23
|
|
18
24
|
describe "dns reverse lookup, replace (on a field)" do
|
@@ -66,6 +72,27 @@ describe LogStash::Filters::DNS do
|
|
66
72
|
insist { subject.get("foo")[1] } == "carrera.databits.net"
|
67
73
|
end
|
68
74
|
end
|
75
|
+
|
76
|
+
describe "dns reverse lookup, non-string field" do
|
77
|
+
let(:plugin) { ::LogStash::Filters::DNS.new("reverse" => "foo") }
|
78
|
+
let(:event) { ::LogStash::Event.new("foo" => {"ip" => "1.2.3.4"} ) }
|
79
|
+
|
80
|
+
before do
|
81
|
+
plugin.register
|
82
|
+
allow(plugin.logger).to receive(:warn).with(any_args)
|
83
|
+
end
|
84
|
+
|
85
|
+
it "does not throw an error when filtering" do
|
86
|
+
expect do
|
87
|
+
plugin.filter(event)
|
88
|
+
end.not_to raise_error
|
89
|
+
end
|
90
|
+
|
91
|
+
it "logs an informative warning" do
|
92
|
+
plugin.filter(event)
|
93
|
+
expect(plugin.logger).to have_received(:warn).with("DNS: skipping reverse, can't deal with non-string values", :field => "foo", value: {"ip" => "1.2.3.4"})
|
94
|
+
end
|
95
|
+
end
|
69
96
|
|
70
97
|
describe "dns reverse lookup, not an IP" do
|
71
98
|
config <<-CONFIG
|
@@ -205,6 +232,21 @@ describe LogStash::Filters::DNS do
|
|
205
232
|
end
|
206
233
|
end
|
207
234
|
|
235
|
+
describe "dns resolve lookup, skip non-string value" do
|
236
|
+
config <<-CONFIG
|
237
|
+
filter {
|
238
|
+
dns {
|
239
|
+
resolve => "foo"
|
240
|
+
action => "replace"
|
241
|
+
}
|
242
|
+
}
|
243
|
+
CONFIG
|
244
|
+
|
245
|
+
sample("foo" => { "hostname" => "carrera.databits.net" }) do
|
246
|
+
insist { subject.get("foo") } == { "hostname" => "carrera.databits.net" }
|
247
|
+
end
|
248
|
+
end
|
249
|
+
|
208
250
|
describe "dns resolve lookup, append" do
|
209
251
|
config <<-CONFIG
|
210
252
|
filter {
|
@@ -305,7 +347,7 @@ describe LogStash::Filters::DNS do
|
|
305
347
|
let(:event2) { LogStash::Event.new("message" => "unkownhost") }
|
306
348
|
|
307
349
|
before(:each) do
|
308
|
-
allow(subject).to receive(:getaddress).
|
350
|
+
allow(subject).to receive(:getaddress).and_return(nil)
|
309
351
|
subject.register
|
310
352
|
end
|
311
353
|
|
@@ -374,7 +416,7 @@ describe LogStash::Filters::DNS do
|
|
374
416
|
|
375
417
|
context "when failing permanently" do
|
376
418
|
before(:each) do
|
377
|
-
allow(subject).to receive(:getaddress).and_raise(
|
419
|
+
allow(subject).to receive(:getaddress).and_raise(Resolv::ResolvTimeout)
|
378
420
|
end
|
379
421
|
|
380
422
|
it "should fail a resolve after max_retries" do
|
@@ -382,7 +424,24 @@ describe LogStash::Filters::DNS do
|
|
382
424
|
subject.filter(event)
|
383
425
|
end
|
384
426
|
|
385
|
-
it "should cache the
|
427
|
+
it "should cache the failure" do
|
428
|
+
expect do
|
429
|
+
subject.filter(event)
|
430
|
+
end.to change { subject.failed_cache[host] }.from(nil).to(true)
|
431
|
+
end
|
432
|
+
end
|
433
|
+
|
434
|
+
context "when unable to resolve an address" do
|
435
|
+
before(:each) do
|
436
|
+
allow(subject).to receive(:getaddress).and_return(nil)
|
437
|
+
end
|
438
|
+
|
439
|
+
it "should fail a resolve after max_retries" do
|
440
|
+
expect(subject).to receive(:getaddress).once
|
441
|
+
subject.filter(event)
|
442
|
+
end
|
443
|
+
|
444
|
+
it "should cache the failure" do
|
386
445
|
expect do
|
387
446
|
subject.filter(event)
|
388
447
|
end.to change { subject.failed_cache[host] }.from(nil).to(true)
|
@@ -403,7 +462,7 @@ describe LogStash::Filters::DNS do
|
|
403
462
|
@try ||= 0
|
404
463
|
if @try < 2
|
405
464
|
@try = @try + 1
|
406
|
-
raise
|
465
|
+
raise SocketError
|
407
466
|
else
|
408
467
|
"127.0.0.1"
|
409
468
|
end
|
@@ -524,7 +583,7 @@ describe LogStash::Filters::DNS do
|
|
524
583
|
# Resolv::DNS.new will be called without arguments thus reading /etc/resolv.conf
|
525
584
|
# for its configuration which is the desired behaviour for backward compatibility
|
526
585
|
|
527
|
-
expect(Resolv::DNS).to receive(:new).once.with(
|
586
|
+
expect(Resolv::DNS).to receive(:new).once.with(nil).and_call_original
|
528
587
|
dns_filter_plugin.register
|
529
588
|
end
|
530
589
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: logstash-filter-dns
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.1.
|
4
|
+
version: 3.1.5
|
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: 2022-04-20 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
requirement: !ruby/object:Gem::Requirement
|
@@ -58,6 +58,20 @@ dependencies:
|
|
58
58
|
- - ">="
|
59
59
|
- !ruby/object:Gem::Version
|
60
60
|
version: '0'
|
61
|
+
- !ruby/object:Gem::Dependency
|
62
|
+
requirement: !ruby/object:Gem::Requirement
|
63
|
+
requirements:
|
64
|
+
- - ">="
|
65
|
+
- !ruby/object:Gem::Version
|
66
|
+
version: '0'
|
67
|
+
name: insist
|
68
|
+
prerelease: false
|
69
|
+
type: :development
|
70
|
+
version_requirements: !ruby/object:Gem::Requirement
|
71
|
+
requirements:
|
72
|
+
- - ">="
|
73
|
+
- !ruby/object:Gem::Version
|
74
|
+
version: '0'
|
61
75
|
description: This gem is a Logstash plugin required to be installed on top of the
|
62
76
|
Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This
|
63
77
|
gem is not a stand-alone program
|
@@ -93,15 +107,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
93
107
|
requirements:
|
94
108
|
- - ">="
|
95
109
|
- !ruby/object:Gem::Version
|
96
|
-
version:
|
110
|
+
version: 2.0.0
|
97
111
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
98
112
|
requirements:
|
99
113
|
- - ">="
|
100
114
|
- !ruby/object:Gem::Version
|
101
115
|
version: '0'
|
102
116
|
requirements: []
|
103
|
-
|
104
|
-
rubygems_version: 2.6.13
|
117
|
+
rubygems_version: 3.1.6
|
105
118
|
signing_key:
|
106
119
|
specification_version: 4
|
107
120
|
summary: Performs a standard or reverse DNS lookup
|