You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@eventmesh.apache.org by mi...@apache.org on 2022/02/09 03:04:44 UTC
[incubator-eventmesh] branch master updated: [Issue #758] validate subscriber Url (#759)
This is an automated email from the ASF dual-hosted git repository.
mikexue pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-eventmesh.git
The following commit(s) were added to refs/heads/master by this push:
new b8891ee [Issue #758] validate subscriber Url (#759)
b8891ee is described below
commit b8891ee309653ba14ebefdb8f66a328de29d0fbc
Author: jinrongluo <ka...@gmail.com>
AuthorDate: Tue Feb 8 22:04:39 2022 -0500
[Issue #758] validate subscriber Url (#759)
* [Issue #758] validate subscriber Url
* [Issue #758] fix build issue
* [Issue #758] fix checkstyle issue
* [Issue #758] fix license check issue
close #758
---
build.gradle | 2 +
eventmesh-common/build.gradle | 2 +
.../org/apache/eventmesh/common/utils/IPUtils.java | 69 +++++++
eventmesh-runtime/build.gradle | 2 +
eventmesh-runtime/conf/eventmesh.properties | 4 +
.../configuration/EventMeshHTTPConfiguration.java | 46 +++++
.../http/processor/SubscribeProcessor.java | 24 +++
.../known-dependencies.txt | 1 +
.../licenses/LICENSE-ipaddress.txt | 202 +++++++++++++++++++++
9 files changed, 352 insertions(+)
diff --git a/build.gradle b/build.gradle
index 48a05f9..b11fa1b 100644
--- a/build.gradle
+++ b/build.gradle
@@ -463,6 +463,8 @@ subprojects {
dependency "io.cloudevents:cloudevents-core:2.2.0"
dependency "io.cloudevents:cloudevents-json-jackson:2.2.0"
+
+ dependency "com.github.seancfoley:ipaddress:5.3.3"
}
}
}
diff --git a/eventmesh-common/build.gradle b/eventmesh-common/build.gradle
index 67b08aa..58b99fb 100644
--- a/eventmesh-common/build.gradle
+++ b/eventmesh-common/build.gradle
@@ -27,6 +27,8 @@ dependencies {
implementation "org.apache.logging.log4j:log4j-core"
implementation "org.apache.logging.log4j:log4j-slf4j-impl"
+ implementation 'com.github.seancfoley:ipaddress:5.3.3'
+
implementation "com.lmax:disruptor"
api "com.fasterxml.jackson.core:jackson-databind"
diff --git a/eventmesh-common/src/main/java/org/apache/eventmesh/common/utils/IPUtils.java b/eventmesh-common/src/main/java/org/apache/eventmesh/common/utils/IPUtils.java
index b96ed17..e477ea4 100644
--- a/eventmesh-common/src/main/java/org/apache/eventmesh/common/utils/IPUtils.java
+++ b/eventmesh-common/src/main/java/org/apache/eventmesh/common/utils/IPUtils.java
@@ -17,21 +17,35 @@
package org.apache.eventmesh.common.utils;
+import org.apache.commons.lang3.StringUtils;
+
import java.net.Inet6Address;
import java.net.InetAddress;
+import java.net.MalformedURLException;
import java.net.NetworkInterface;
import java.net.SocketAddress;
import java.net.SocketException;
+import java.net.URL;
import java.net.UnknownHostException;
import java.util.ArrayList;
import java.util.Enumeration;
+import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
import io.netty.channel.Channel;
+import inet.ipaddr.HostName;
+import inet.ipaddr.IPAddress;
+import inet.ipaddr.IPAddressString;
+
public class IPUtils {
+ private static final Logger logger = LoggerFactory.getLogger(IPUtils.class);
+
public static String getLocalAddress() {
// if the progress works under docker environment
// return the host ip about this docker located from environment value
@@ -173,4 +187,59 @@ public class IPUtils {
return "";
}
+
+ public static boolean isValidDomainOrIp(String url, List<IPAddress> ipV4ReservedAddrs, List<IPAddress> ipV6ReservedAddrs) {
+ if (StringUtils.isBlank(url)) {
+ return false;
+ }
+ // Engine only need to verify DNS transformed result
+ if (isValidIp(url)) {
+ return true;
+ }
+ IPAddress ipAddress = domain2Ip(url);
+ if (ipAddress == null) {
+ return false;
+ }
+ if (ipAddress.isIPv4()) {
+ return isReservedIp(ipAddress, ipV4ReservedAddrs);
+ } else {
+ return isReservedIp(ipAddress, ipV6ReservedAddrs);
+ }
+ }
+
+ public static boolean isValidIp(String url) {
+ try {
+ IPAddressString ipString = new IPAddressString(url);
+ if (!ipString.isValid()) {
+ return new IPAddressString(new URL(url).getHost()).isValid();
+ }
+ } catch (Exception e) {
+ logger.warn("Invalid URL format url={}", url, e);
+ return false;
+ }
+ return true;
+ }
+
+ public static IPAddress domain2Ip(String url) {
+ HostName hostName = new HostName(url);
+ if (hostName.isValid()) {
+ return hostName.getAddress();
+ }
+ try {
+ String host = new URL(url).getHost();
+ return new HostName(host).getAddress();
+ } catch (MalformedURLException e) {
+ logger.error("Invalid URL format url={}", url, e);
+ return null;
+ }
+ }
+
+ private static boolean isReservedIp(IPAddress ipAddress, List<IPAddress> reservedIps) {
+ for (IPAddress address : reservedIps) {
+ if (address.contains(ipAddress)) {
+ return true;
+ }
+ }
+ return false;
+ }
}
diff --git a/eventmesh-runtime/build.gradle b/eventmesh-runtime/build.gradle
index 6db36c2..d27544f 100644
--- a/eventmesh-runtime/build.gradle
+++ b/eventmesh-runtime/build.gradle
@@ -26,6 +26,8 @@ dependencies {
implementation "org.apache.httpcomponents:httpclient"
implementation 'io.netty:netty-all'
+ implementation 'com.github.seancfoley:ipaddress:5.3.3'
+
implementation project(":eventmesh-common")
implementation project(":eventmesh-spi")
implementation project(":eventmesh-connector-plugin:eventmesh-connector-api")
diff --git a/eventmesh-runtime/conf/eventmesh.properties b/eventmesh-runtime/conf/eventmesh.properties
index 4a4b9dd..23425e1 100644
--- a/eventmesh-runtime/conf/eventmesh.properties
+++ b/eventmesh-runtime/conf/eventmesh.properties
@@ -60,6 +60,10 @@ eventMesh.server.registry.fetchRegistryAddrIntervalInMills=20000
eventMesh.server.gracefulShutdown.sleepIntervalInMills=1000
eventMesh.server.rebalanceRedirect.sleepIntervalInMills=200
+#ip address blacklist
+eventmesh.server.blacklist.ipv4=0.0.0.0/8,127.0.0.0/8,169.254.0.0/16,255.255.255.255/32
+eventmesh.server.blacklist.ipv6=::/128,::1/128,ff00::/8
+
#connector plugin
eventMesh.connector.plugin.type=standalone
diff --git a/eventmesh-runtime/src/main/java/org/apache/eventmesh/runtime/configuration/EventMeshHTTPConfiguration.java b/eventmesh-runtime/src/main/java/org/apache/eventmesh/runtime/configuration/EventMeshHTTPConfiguration.java
index d8cb882..a71b814 100644
--- a/eventmesh-runtime/src/main/java/org/apache/eventmesh/runtime/configuration/EventMeshHTTPConfiguration.java
+++ b/eventmesh-runtime/src/main/java/org/apache/eventmesh/runtime/configuration/EventMeshHTTPConfiguration.java
@@ -22,10 +22,23 @@ import org.apache.eventmesh.common.config.ConfigurationWrapper;
import org.apache.commons.lang3.StringUtils;
+import java.util.Collections;
+import java.util.List;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
import com.google.common.base.Preconditions;
+import com.google.common.base.Splitter;
+import com.google.common.collect.Lists;
+
+import inet.ipaddr.IPAddress;
+import inet.ipaddr.IPAddressString;
public class EventMeshHTTPConfiguration extends CommonConfiguration {
+ public static Logger logger = LoggerFactory.getLogger(EventMeshHTTPConfiguration.class);
+
public int httpServerPort = 10105;
public boolean eventMeshServerBatchMsgBatchEnabled = Boolean.TRUE;
@@ -70,6 +83,10 @@ public class EventMeshHTTPConfiguration extends CommonConfiguration {
public int eventMeshBatchMsgRequestNumPerSecond = 20000;
+ public List<IPAddress> eventMeshIpv4BlackList = Collections.emptyList();
+
+ public List<IPAddress> eventMeshIpv6BlackList = Collections.emptyList();
+
public EventMeshHTTPConfiguration(ConfigurationWrapper configurationWrapper) {
super(configurationWrapper);
}
@@ -248,7 +265,32 @@ public class EventMeshHTTPConfiguration extends CommonConfiguration {
eventMeshHttpMsgReqNumPerSecond = Integer.parseInt(eventMeshHttpMsgReqNumPerSecondStr);
}
+
+ String ipv4BlackList = configurationWrapper.getProp(ConfKeys.KEY_EVENTMESH_SERVER_IPV4_BLACK_LIST);
+ if (StringUtils.isNotEmpty(ipv4BlackList)) {
+ eventMeshIpv4BlackList = getBlacklist(ipv4BlackList);
+ }
+
+ String ipv6BlackList = configurationWrapper.getProp(ConfKeys.KEY_EVENTMESH_SERVER_IPV6_BLACK_LIST);
+ if (StringUtils.isNotEmpty(ipv6BlackList)) {
+ eventMeshIpv6BlackList = getBlacklist(ipv6BlackList);
+ }
+ }
+ }
+
+ private static List<IPAddress> getBlacklist(String cidrs) {
+ List<String> cidrList = Splitter.on(",").omitEmptyStrings()
+ .trimResults().splitToList(cidrs);
+
+ List<IPAddress> ipAddresses = Lists.newArrayList();
+ for (String cidr : cidrList) {
+ try {
+ ipAddresses.add(new IPAddressString(cidr).toAddress());
+ } catch (Exception e) {
+ logger.warn("Invalid cidr={}", cidr, e);
+ }
}
+ return ipAddresses;
}
static class ConfKeys {
@@ -296,5 +338,9 @@ public class EventMeshHTTPConfiguration extends CommonConfiguration {
public static String KEY_EVENTMESH_HTTPS_ENABLED = "eventMesh.server.useTls.enabled";
public static String KEY_EVENTMESH_SERVER_MSG_REQ_NUM_PER_SECOND = "eventMesh.server.http.msgReqnumPerSecond";
+
+ public static String KEY_EVENTMESH_SERVER_IPV4_BLACK_LIST = "eventmesh.server.blacklist.ipv4";
+
+ public static String KEY_EVENTMESH_SERVER_IPV6_BLACK_LIST = "eventmesh.server.blacklist.ipv6";
}
}
\ No newline at end of file
diff --git a/eventmesh-runtime/src/main/java/org/apache/eventmesh/runtime/core/protocol/http/processor/SubscribeProcessor.java b/eventmesh-runtime/src/main/java/org/apache/eventmesh/runtime/core/protocol/http/processor/SubscribeProcessor.java
index 7e28f51..01c156b 100644
--- a/eventmesh-runtime/src/main/java/org/apache/eventmesh/runtime/core/protocol/http/processor/SubscribeProcessor.java
+++ b/eventmesh-runtime/src/main/java/org/apache/eventmesh/runtime/core/protocol/http/processor/SubscribeProcessor.java
@@ -148,6 +148,30 @@ public class SubscribeProcessor implements HttpRequestProcessor {
String url = subscribeRequestBody.getUrl();
String consumerGroup = subscribeRequestBody.getConsumerGroup();
+ // validate URL
+ try {
+ if (!IPUtils.isValidDomainOrIp(url, eventMeshHTTPServer.getEventMeshHttpConfiguration().eventMeshIpv4BlackList,
+ eventMeshHTTPServer.getEventMeshHttpConfiguration().eventMeshIpv6BlackList)) {
+ httpLogger.error("subscriber url {} is not valid", url);
+ responseEventMeshCommand = request.createHttpCommandResponse(
+ subscribeResponseHeader,
+ SubscribeResponseBody
+ .buildBody(EventMeshRetCode.EVENTMESH_PROTOCOL_BODY_ERR.getRetCode(),
+ EventMeshRetCode.EVENTMESH_PROTOCOL_BODY_ERR.getErrMsg() + " invalid URL: " + url));
+ asyncContext.onComplete(responseEventMeshCommand);
+ return;
+ }
+ } catch (Exception e) {
+ httpLogger.error("subscriber url {} is not valid, error {}", url, e.getMessage());
+ responseEventMeshCommand = request.createHttpCommandResponse(
+ subscribeResponseHeader,
+ SubscribeResponseBody
+ .buildBody(EventMeshRetCode.EVENTMESH_PROTOCOL_BODY_ERR.getRetCode(),
+ EventMeshRetCode.EVENTMESH_PROTOCOL_BODY_ERR.getErrMsg() + " invalid URL: " + url));
+ asyncContext.onComplete(responseEventMeshCommand);
+ return;
+ }
+
synchronized (eventMeshHTTPServer.localClientInfoMapping) {
registerClient(subscribeRequestHeader, consumerGroup, subTopicList, url);
diff --git a/tools/third-party-dependencies/known-dependencies.txt b/tools/third-party-dependencies/known-dependencies.txt
index bf60672..53f4cc4 100644
--- a/tools/third-party-dependencies/known-dependencies.txt
+++ b/tools/third-party-dependencies/known-dependencies.txt
@@ -22,6 +22,7 @@ guava-31.0.1-jre.jar
hamcrest-core-1.3.jar
httpclient-4.5.13.jar
httpcore-4.4.13.jar
+ipaddress-5.3.3.jar
j2objc-annotations-1.3.jar
jackson-annotations-2.11.0.jar
jackson-core-2.11.0.jar
diff --git a/tools/third-party-licenses/licenses/LICENSE-ipaddress.txt b/tools/third-party-licenses/licenses/LICENSE-ipaddress.txt
new file mode 100644
index 0000000..7a4a3ea
--- /dev/null
+++ b/tools/third-party-licenses/licenses/LICENSE-ipaddress.txt
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: commits-help@eventmesh.apache.org