├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── pom.xml └── src ├── deb └── control │ └── control ├── main ├── java │ └── org │ │ └── graylog │ │ └── plugin │ │ └── filter │ │ └── dns │ │ ├── DnsResolverConfiguration.java │ │ ├── DnsResolverFilter.java │ │ ├── DnsResolverFilterMetaData.java │ │ ├── DnsResolverFilterModule.java │ │ └── DnsResolverFilterPlugin.java └── resources │ ├── META-INF │ └── services │ │ └── org.graylog2.plugin.Plugin │ └── org.graylog.plugins.graylog-plugin-dnsresolver │ └── graylog-plugin.properties └── test └── java └── org └── graylog └── plugin └── filter └── dns └── DnsResolverFilterTest.java /.gitignore: -------------------------------------------------------------------------------- 1 | target/ 2 | dependency-reduced-pom.xml 3 | pom.xml.releaseBackup 4 | 5 | out/ 6 | .idea/ 7 | *.iml 8 | *.iws 9 | *.ipr 10 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: false 2 | language: java 3 | jdk: 4 | - oraclejdk8 5 | addons: 6 | apt: 7 | packages: 8 | - rpm 9 | before_deploy: 10 | - mvn jdeb:jdeb && export RELEASE_DEB_FILE=$(ls target/*.deb) 11 | - mvn rpm:rpm && export RELEASE_RPM_FILE=$(find target/ -name '*.rpm' | tail -1) 12 | - rm -f target/original-*.jar 13 | - export RELEASE_PKG_FILE=$(ls target/*.jar) 14 | - echo "Deploying release to GitHub releases" 15 | deploy: 16 | provider: releases 17 | api_key: 18 | secure: "IltfQr/7O90BCKlujv2YZ/UPtbPxkDjrfwaRDKYzKtFcRe4zead2cCHOS6pFkkTiJupzxmiX8U0CvwvfX160k/JMaxR+VN7QmT49UCPgxg3GsCtHrmCjAI4jx+DrIyuJGv94uE9mdC4TEAoLlsB0OyFwSIZQqE2DapDPkzEXzPY=" 19 | file: 20 | - "${RELEASE_PKG_FILE}" 21 | - "${RELEASE_DEB_FILE}" 22 | - "${RELEASE_RPM_FILE}" 23 | skip_cleanup: true 24 | on: 25 | tags: true 26 | jdk: oraclejdk8 27 | repo: graylog-labs/graylog-plugin-dnsresolver 28 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | DNS Resolver Plugin for Graylog 2 | =============================== 3 | 4 | [![Build Status](https://travis-ci.org/graylog-labs/graylog-plugin-dnsresolver.svg)](https://travis-ci.org/graylog-labs/graylog-plugin-dnsresolver) 5 | 6 | This message filter plugin can be used to do DNS lookups for the `source` field in Graylog messages. 7 | 8 | **Required Graylog version:** 2.4.0 and later 9 | 10 | Please use version 1.1.2 of this plugin if you are still running Graylog 1.x 11 | 12 | ## Installation 13 | 14 | [Download the plugin](https://github.com/graylog-labs/graylog-plugin-dnsresolver/releases) 15 | and place the `.jar` file in your Graylog plugin directory. The plugin directory 16 | is the `plugins/` folder relative from your `graylog-server` directory by default 17 | and can be configured in your `graylog.conf` file. 18 | 19 | Restart `graylog-server` and you are done. 20 | 21 | ## Configuration 22 | 23 | The following configuration options can be added to the Graylog configuration file. 24 | 25 | * `dns_resolver_enabled` -- Set to `true` if the message filter should be run. (default `false`) 26 | * `dns_resolver_run_before_extractors` -- Set to `true` if the DNS lookup should be done before running extractors. (default `true`) 27 | * `dns_resolver_timeout` -- The timeout for the DNS lookup. (default `2s`) 28 | 29 | ## Build 30 | 31 | This project is using Maven and requires Java 8 or higher. 32 | 33 | You can build a plugin (JAR) with `mvn package`. 34 | 35 | DEB and RPM packages can be build with `mvn jdeb:jdeb` and `mvn rpm:rpm` respectively. 36 | 37 | ## Plugin Release 38 | 39 | We are using the maven release plugin: 40 | 41 | ``` 42 | $ mvn release:prepare 43 | [...] 44 | $ mvn release:perform 45 | ``` 46 | 47 | This sets the version numbers, creates a tag and pushes to GitHub. TravisCI will build the release artifacts and upload to GitHub automatically. 48 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4.0.0 4 | 5 | 6 | org.graylog.plugins 7 | graylog-plugin-parent 8 | 2.4.0 9 | 10 | 11 | org.graylog.plugins 12 | graylog-plugin-dnsresolver 13 | 1.2.1-SNAPSHOT 14 | jar 15 | 16 | ${project.artifactId} 17 | Graylog ${project.artifactId} plugin. 18 | https://www.graylog.org 19 | 20 | 21 | Graylog, Inc. 22 | https://www.graylog.com/ 23 | 24 | 25 | 26 | scm:git:git@github.com:Graylog2/graylog-plugin-dnsresolver.git 27 | scm:git:git@github.com:Graylog2/graylog-plugin-dnsresolver.git 28 | https://github.com/Graylog2/graylog-plugin-dnsresolver 29 | HEAD 30 | 31 | 32 | 33 | UTF-8 34 | 1.8 35 | 1.8 36 | true 37 | true 38 | true 39 | true 40 | true 41 | 2.4.0 42 | /usr/share/graylog-server/plugin 43 | 44 | 45 | 46 | 47 | com.google.auto.value 48 | auto-value 49 | ${auto-value.version} 50 | provided 51 | 52 | 53 | junit 54 | junit 55 | ${junit.version} 56 | test 57 | 58 | 59 | org.mockito 60 | mockito-core 61 | ${mockito.version} 62 | test 63 | 64 | 65 | 66 | 67 | 68 | 69 | src/main/resources 70 | true 71 | 72 | 73 | 74 | 75 | org.apache.maven.plugins 76 | maven-jar-plugin 77 | 78 | 79 | 80 | ${project.groupId}.${project.artifactId} 81 | 82 | 83 | 84 | 85 | 86 | 87 | com.mycila 88 | license-maven-plugin 89 | 2.11 90 | 91 |
com/mycila/maven/plugin/license/templates/APACHE-2.txt
92 | 93 | ${project.organization.name} 94 | hello@graylog.com 95 | 2015 96 | 97 | 98 | **/src/main/java/** 99 | **/src/test/java/** 100 | 101 | 102 | 103 | 104 | 105 | 106 | -------------------------------------------------------------------------------- /src/deb/control/control: -------------------------------------------------------------------------------- 1 | Package: [[name]] 2 | Version: [[version]] 3 | Architecture: all 4 | Maintainer: Graylog, Inc. 5 | Section: web 6 | Priority: optional 7 | Depends: graylog-server 8 | Description: [[description]] 9 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugin/filter/dns/DnsResolverConfiguration.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright (C) 2015 Graylog, Inc. (hello@graylog.com) 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 | */ 16 | package org.graylog.plugin.filter.dns; 17 | 18 | import com.github.joschi.jadconfig.Parameter; 19 | import org.graylog2.plugin.PluginConfigBean; 20 | import org.joda.time.Period; 21 | 22 | public class DnsResolverConfiguration implements PluginConfigBean { 23 | 24 | @Parameter(value = "dns_resolver_timeout") 25 | private Period resolverTimeout = Period.seconds(2); 26 | 27 | @Parameter(value = "dns_resolver_run_before_extractors") 28 | private boolean runBeforeExtractors = true; 29 | 30 | @Parameter(value = "dns_resolver_enabled") 31 | private boolean enabled = false; 32 | 33 | public boolean isRunBeforeExtractors() { 34 | return runBeforeExtractors; 35 | } 36 | 37 | public Period getResolverTimeout() { 38 | return resolverTimeout; 39 | } 40 | 41 | public boolean isEnabled() { 42 | return enabled; 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugin/filter/dns/DnsResolverFilter.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright (C) 2015 Graylog, Inc. (hello@graylog.com) 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 | */ 16 | package org.graylog.plugin.filter.dns; 17 | 18 | import com.codahale.metrics.Meter; 19 | import com.codahale.metrics.MetricRegistry; 20 | import com.codahale.metrics.Timer; 21 | import com.google.common.annotations.VisibleForTesting; 22 | import com.google.common.net.InetAddresses; 23 | import com.google.common.util.concurrent.SimpleTimeLimiter; 24 | import com.google.common.util.concurrent.ThreadFactoryBuilder; 25 | import com.google.common.util.concurrent.TimeLimiter; 26 | import org.graylog2.plugin.Message; 27 | import org.graylog2.plugin.filters.MessageFilter; 28 | import org.joda.time.Period; 29 | import org.slf4j.Logger; 30 | import org.slf4j.LoggerFactory; 31 | 32 | import javax.inject.Inject; 33 | import javax.inject.Named; 34 | import java.net.InetAddress; 35 | import java.util.concurrent.Callable; 36 | import java.util.concurrent.Executors; 37 | import java.util.concurrent.TimeUnit; 38 | 39 | import static com.codahale.metrics.MetricRegistry.name; 40 | 41 | /** 42 | * This is the plugin. Your class should implement one of the existing plugin 43 | * interfaces. (i.e. AlarmCallback, MessageInput, MessageOutput) 44 | */ 45 | public class DnsResolverFilter implements MessageFilter { 46 | private static final Logger log = LoggerFactory.getLogger(DnsResolverFilter.class); 47 | 48 | private final TimeLimiter timeLimiter; 49 | private final Timer resolveTime; 50 | private final Meter resolveTimeouts; 51 | private final long timeout; 52 | private final boolean shouldRunBeforeExtractors; 53 | private final boolean enabled; 54 | 55 | @Inject 56 | public DnsResolverFilter(@Named("dns_resolver_timeout") Period resolverTimeout, 57 | @Named("dns_resolver_run_before_extractors") boolean shouldRunBeforeExtractors, 58 | @Named("dns_resolver_enabled") boolean enabled, 59 | MetricRegistry metricRegistry) { 60 | this.shouldRunBeforeExtractors = shouldRunBeforeExtractors; 61 | this.enabled = enabled; 62 | timeout = resolverTimeout.toStandardDuration().getMillis(); 63 | timeLimiter = SimpleTimeLimiter.create( 64 | Executors.newSingleThreadExecutor( 65 | new ThreadFactoryBuilder() 66 | .setDaemon(true) 67 | .setNameFormat("dns-resolver-thread-%d") 68 | .build() 69 | ) 70 | ); 71 | this.resolveTime = metricRegistry.timer(name(DnsResolverFilter.class, "resolveTime")); 72 | this.resolveTimeouts = metricRegistry.meter(name(DnsResolverFilter.class, "resolveTimeouts")); 73 | } 74 | 75 | @Override 76 | public boolean filter(Message msg) { 77 | if (!enabled) { 78 | return false; 79 | } 80 | 81 | final String source = msg.getSource(); 82 | try { 83 | try (Timer.Context ignored = resolveTime.time()) { 84 | final String hostname = timeLimiter.callWithTimeout(getLookupCallable(source), timeout, TimeUnit.MILLISECONDS); 85 | 86 | if (hostname != null) { 87 | msg.setSource(hostname); 88 | } 89 | } 90 | 91 | } catch (IllegalArgumentException e) { 92 | log.debug("Source {} of message {} is not an IP literal. Cannot look up the hostname.", source, msg.getId()); 93 | } catch (Exception e) { 94 | resolveTimeouts.mark(); 95 | log.debug("DNS request timed out, skipping looking up {} for message {}", source, msg.getId()); 96 | } 97 | return false; 98 | } 99 | 100 | @VisibleForTesting 101 | protected Callable getLookupCallable(final String source) { 102 | return new Callable() { 103 | @Override 104 | public String call() throws Exception { 105 | final InetAddress inetAddress = InetAddresses.forString(source); 106 | return inetAddress.getCanonicalHostName(); 107 | } 108 | }; 109 | } 110 | 111 | @Override 112 | public String getName() { 113 | return "DNS Resolver"; 114 | } 115 | 116 | @Override 117 | public int getPriority() { 118 | // MAGIC NUMBER: 10 is the priority of the ExtractorFilter, we either run before or after it, depending on what the user wants. 119 | return 10 - (shouldRunBeforeExtractors ? 1 : -1); 120 | } 121 | } 122 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugin/filter/dns/DnsResolverFilterMetaData.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright (C) 2015 Graylog, Inc. (hello@graylog.com) 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 | */ 16 | package org.graylog.plugin.filter.dns; 17 | 18 | import org.graylog2.plugin.PluginMetaData; 19 | import org.graylog2.plugin.ServerStatus; 20 | import org.graylog2.plugin.Version; 21 | 22 | import java.net.URI; 23 | import java.util.Collections; 24 | import java.util.Set; 25 | 26 | /** 27 | * Implement the PluginMetaData interface here. 28 | */ 29 | public class DnsResolverFilterMetaData implements PluginMetaData { 30 | private static final String PLUGIN_PROPERTIES = "org.graylog.plugins.graylog-plugin-dnsresolver/graylog-plugin.properties"; 31 | 32 | @Override 33 | public String getUniqueId() { 34 | return DnsResolverFilterPlugin.class.getCanonicalName(); 35 | } 36 | 37 | @Override 38 | public String getName() { 39 | return "DnsResolverFilter"; 40 | } 41 | 42 | @Override 43 | public String getAuthor() { 44 | return "Graylog, Inc."; 45 | } 46 | 47 | @Override 48 | public URI getURL() { 49 | return URI.create("https://www.graylog.org/"); 50 | } 51 | 52 | @Override 53 | public Version getVersion() { 54 | return Version.fromPluginProperties(getClass(), PLUGIN_PROPERTIES, "version", Version.from(1, 0, 0)); 55 | } 56 | 57 | @Override 58 | public String getDescription() { 59 | return "Resolves host names of message fields."; 60 | } 61 | 62 | @Override 63 | public Version getRequiredVersion() { 64 | return Version.fromPluginProperties(getClass(), PLUGIN_PROPERTIES, "graylog.version", Version.from(2, 4, 0)); 65 | } 66 | 67 | @Override 68 | public Set getRequiredCapabilities() { 69 | return Collections.emptySet(); 70 | } 71 | } 72 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugin/filter/dns/DnsResolverFilterModule.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright (C) 2015 Graylog, Inc. (hello@graylog.com) 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 | */ 16 | package org.graylog.plugin.filter.dns; 17 | 18 | import com.google.common.collect.Sets; 19 | import org.graylog2.plugin.PluginConfigBean; 20 | import org.graylog2.plugin.PluginModule; 21 | 22 | import java.util.Set; 23 | 24 | public class DnsResolverFilterModule extends PluginModule { 25 | 26 | @Override 27 | public Set getConfigBeans() { 28 | return Sets.newHashSet(new DnsResolverConfiguration()); 29 | } 30 | 31 | @Override 32 | protected void configure() { 33 | addMessageFilter(DnsResolverFilter.class); 34 | addConfigBeans(); 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugin/filter/dns/DnsResolverFilterPlugin.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright (C) 2015 Graylog, Inc. (hello@graylog.com) 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 | */ 16 | package org.graylog.plugin.filter.dns; 17 | 18 | import org.graylog2.plugin.Plugin; 19 | import org.graylog2.plugin.PluginMetaData; 20 | import org.graylog2.plugin.PluginModule; 21 | 22 | import java.util.Arrays; 23 | import java.util.Collection; 24 | 25 | /** 26 | * Implement the Plugin interface here. 27 | */ 28 | public class DnsResolverFilterPlugin implements Plugin { 29 | @Override 30 | public PluginMetaData metadata() { 31 | return new DnsResolverFilterMetaData(); 32 | } 33 | 34 | @Override 35 | public Collection modules () { 36 | return Arrays.asList(new DnsResolverFilterModule()); 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/services/org.graylog2.plugin.Plugin: -------------------------------------------------------------------------------- 1 | org.graylog.plugin.filter.dns.DnsResolverFilterPlugin -------------------------------------------------------------------------------- /src/main/resources/org.graylog.plugins.graylog-plugin-dnsresolver/graylog-plugin.properties: -------------------------------------------------------------------------------- 1 | # The plugin version 2 | version=${project.version} 3 | 4 | # The required Graylog server version 5 | graylog.version=${graylog2.version} 6 | 7 | # When set to true (the default) the plugin gets a separate class loader 8 | # when loading the plugin. When set to false, the plugin shares a class loader 9 | # with other plugins that have isolated=false. 10 | # 11 | # Do not disable this unless this plugin depends on another plugin! 12 | #isolated=false -------------------------------------------------------------------------------- /src/test/java/org/graylog/plugin/filter/dns/DnsResolverFilterTest.java: -------------------------------------------------------------------------------- 1 | package org.graylog.plugin.filter.dns; 2 | 3 | import com.codahale.metrics.MetricRegistry; 4 | import com.google.common.util.concurrent.Uninterruptibles; 5 | import org.graylog2.plugin.Message; 6 | import org.graylog2.plugin.Tools; 7 | import org.joda.time.Period; 8 | import org.junit.Before; 9 | import org.junit.Test; 10 | 11 | import java.net.Inet4Address; 12 | import java.net.InetAddress; 13 | import java.net.InetSocketAddress; 14 | import java.util.concurrent.Callable; 15 | import java.util.concurrent.TimeUnit; 16 | 17 | import static com.codahale.metrics.MetricRegistry.name; 18 | import static org.junit.Assert.assertEquals; 19 | import static org.junit.Assert.assertFalse; 20 | import static org.junit.Assert.assertNotEquals; 21 | 22 | public class DnsResolverFilterTest { 23 | 24 | private MetricRegistry metricRegistry; 25 | 26 | @Before 27 | public void init() { 28 | metricRegistry = new MetricRegistry(); 29 | } 30 | 31 | @Test 32 | public void disabledFilter() { 33 | final DnsResolverFilter resolver = new DnsResolverFilter(Period.seconds(1), 34 | false, 35 | false, 36 | metricRegistry); 37 | 38 | final Message msg = new Message("test", "127.0.0.1", Tools.nowUTC()); 39 | final boolean filter = resolver.filter(msg); 40 | 41 | assertFalse("Message should not be filtered out", filter); 42 | 43 | assertEquals("localhost ip should not be resolved, filter is disabled", "127.0.0.1", msg.getSource()); 44 | } 45 | 46 | @Test 47 | public void filterEnabledAndResolvesLocalhost() { 48 | final DnsResolverFilter resolver = new DnsResolverFilter(Period.seconds(1), 49 | false, 50 | true, 51 | metricRegistry); 52 | 53 | final InetAddress loopbackAddress = Inet4Address.getLoopbackAddress(); 54 | final Message msg = new Message("test", "127.0.0.1", Tools.nowUTC()); 55 | final boolean filter = resolver.filter(msg); 56 | 57 | assertFalse("Message should not be filtered out", filter); 58 | 59 | assertEquals("localhost ip should be resolved, filter is enabled", loopbackAddress.getCanonicalHostName(), msg.getSource()); 60 | 61 | assertEquals("should have looked up one time", 1, metricRegistry.timer(name(DnsResolverFilter.class, "resolveTime")).getCount()); 62 | 63 | } 64 | 65 | @Test 66 | public void lookupsTimeout() { 67 | final DnsResolverFilter resolver = new DnsResolverFilter(Period.seconds(1), 68 | false, 69 | true, 70 | metricRegistry) { 71 | @Override 72 | protected Callable getLookupCallable(String source) { 73 | return new Callable() { 74 | @Override 75 | public String call() throws Exception { 76 | Uninterruptibles.sleepUninterruptibly(2, TimeUnit.SECONDS); 77 | return "should not be used"; 78 | } 79 | }; 80 | } 81 | }; 82 | 83 | final Message msg = new Message("test", "127.0.0.1", Tools.nowUTC()); 84 | 85 | final boolean filter = resolver.filter(msg); 86 | assertFalse("Message should not be filtered out", filter); 87 | 88 | assertNotEquals("Late callback results should not be used.", "should not be used", msg.getSource()); 89 | 90 | // check for metrics 91 | assertEquals("should have timed out once", 1, metricRegistry.meter(name(DnsResolverFilter.class, "resolveTimeouts")).getCount()); 92 | } 93 | 94 | } --------------------------------------------------------------------------------