You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by GitBox <gi...@apache.org> on 2022/01/19 01:21:45 UTC
[GitHub] [nifi] exceptionfactory opened a new pull request #5670: NIFI-9481 Exclude Data Transfer REST methods from DoSFilter
exceptionfactory opened a new pull request #5670:
URL: https://github.com/apache/nifi/pull/5670
#### Description of PR
NIFI-9481 Excludes Site to Site Data Transfer REST resources from the standard Denial-of-Service Filter configured for the Jetty Server.
S2S communication incorporates separate own timeout handling for transactions, and the DoSFilter can result in unexpected transmission failures when transferring large files using S2S with HTTP. The `DataTransferExcludedDoSFilter` is a custom extension of the standard Jetty `DoSFilter` that excludes REST resource methods having a Request URI that starts with `/nifi-api/data-transfer`.
Implementation changes include refactoring Jetty Server request filter configuration to a separate `RequestFilterProvider` interface with implementations for standard and REST API applications. Abstracting request filter configuration following this approach reduces the complexity of the `JettyServer` class and supports related unit testing improvements.
In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:
### For all changes:
- [X] Is there a JIRA ticket associated with this PR? Is it referenced
in the commit message?
- [X] Does your PR title start with **NIFI-XXXX** where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
- [X] Has your PR been rebased against the latest commit within the target branch (typically `main`)?
- [X] Is your initial contribution a single, squashed commit? _Additional commits in response to PR reviewer feedback should be made on this branch and pushed to allow change tracking. Do not `squash` or use `--force` when pushing to allow for clean monitoring of changes._
### For code changes:
- [X] Have you ensured that the full suite of tests is executed via `mvn -Pcontrib-check clean install` at the root `nifi` folder?
- [X] Have you written or updated unit tests to verify your changes?
- [X] Have you verified that the full build is successful on JDK 8?
- [X] Have you verified that the full build is successful on JDK 11?
- [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] If applicable, have you updated the `LICENSE` file, including the main `LICENSE` file under `nifi-assembly`?
- [ ] If applicable, have you updated the `NOTICE` file, including the main `NOTICE` file found under `nifi-assembly`?
- [ ] If adding new Properties, have you added `.displayName` in addition to .name (programmatic access) for each of the new properties?
### For documentation related changes:
- [ ] Have you ensured that format looks appropriate for the output in which it is rendered?
### Note:
Please ensure that once the PR is submitted, you check GitHub Actions CI for build issues and submit an update to your PR as soon as possible.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] gresockj commented on a change in pull request #5670: NIFI-9481 Exclude Data Transfer REST methods from DoSFilter
Posted by GitBox <gi...@apache.org>.
gresockj commented on a change in pull request #5670:
URL: https://github.com/apache/nifi/pull/5670#discussion_r787897716
##########
File path: nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-jetty/src/main/java/org/apache/nifi/web/server/filter/RestApiRequestFilterProvider.java
##########
@@ -0,0 +1,62 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.
+ */
+package org.apache.nifi.web.server.filter;
+
+import org.apache.nifi.util.NiFiProperties;
+import org.eclipse.jetty.servlet.FilterHolder;
+import org.eclipse.jetty.servlets.DoSFilter;
+
+import java.util.List;
+
+/**
+ * Request Filter Provider for REST API Web Application
+ */
+public class RestApiRequestFilterProvider extends StandardRequestFilterProvider {
+ public static final String RELATIVE_PATH_ACCESS_TOKEN = "/access/token";
+
+ private static final int DOS_FILTER_REJECT_REQUEST = -1;
+
+ /**
+ * Get Filters using provided NiFi Properties and append filters for Access Token Requests
+ *
+ * @param properties NiFi Properties required
+ * @return List of Filter Holders
+ */
+ @Override
+ public List<FilterHolder> getFilters(final NiFiProperties properties) {
+ final List<FilterHolder> filters = super.getFilters(properties);
+
+ final FilterHolder accessTokenDenialOfServiceFilter = getAccessTokenDenialOfServiceFilter(properties);
+ filters.add(accessTokenDenialOfServiceFilter);
+
+ return filters;
+ }
+
+ private FilterHolder getAccessTokenDenialOfServiceFilter(final NiFiProperties properties) {
+ final FilterHolder filter = getDenialOfServiceFilter(properties, DoSFilter.class);
+
+ final int maxWebAccessTokenRequestsPerSecond = properties.getMaxWebAccessTokenRequestsPerSecond();
+ filter.setInitParameter("maxRequestsPerSec", Integer.toString(maxWebAccessTokenRequestsPerSecond));
Review comment:
I see `put("ipWhitelist", webRequestAllowed);` in the DoSFilter of `StandardRequestFilterProvider`, but not this one. Was there a reason it was left out here?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] gresockj commented on a change in pull request #5670: NIFI-9481 Exclude Data Transfer REST methods from DoSFilter
Posted by GitBox <gi...@apache.org>.
gresockj commented on a change in pull request #5670:
URL: https://github.com/apache/nifi/pull/5670#discussion_r788074447
##########
File path: nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-jetty/src/main/java/org/apache/nifi/web/server/filter/RestApiRequestFilterProvider.java
##########
@@ -0,0 +1,62 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.
+ */
+package org.apache.nifi.web.server.filter;
+
+import org.apache.nifi.util.NiFiProperties;
+import org.eclipse.jetty.servlet.FilterHolder;
+import org.eclipse.jetty.servlets.DoSFilter;
+
+import java.util.List;
+
+/**
+ * Request Filter Provider for REST API Web Application
+ */
+public class RestApiRequestFilterProvider extends StandardRequestFilterProvider {
+ public static final String RELATIVE_PATH_ACCESS_TOKEN = "/access/token";
+
+ private static final int DOS_FILTER_REJECT_REQUEST = -1;
+
+ /**
+ * Get Filters using provided NiFi Properties and append filters for Access Token Requests
+ *
+ * @param properties NiFi Properties required
+ * @return List of Filter Holders
+ */
+ @Override
+ public List<FilterHolder> getFilters(final NiFiProperties properties) {
+ final List<FilterHolder> filters = super.getFilters(properties);
+
+ final FilterHolder accessTokenDenialOfServiceFilter = getAccessTokenDenialOfServiceFilter(properties);
+ filters.add(accessTokenDenialOfServiceFilter);
+
+ return filters;
+ }
+
+ private FilterHolder getAccessTokenDenialOfServiceFilter(final NiFiProperties properties) {
+ final FilterHolder filter = getDenialOfServiceFilter(properties, DoSFilter.class);
+
+ final int maxWebAccessTokenRequestsPerSecond = properties.getMaxWebAccessTokenRequestsPerSecond();
+ filter.setInitParameter("maxRequestsPerSec", Integer.toString(maxWebAccessTokenRequestsPerSecond));
Review comment:
Ah, got it. Thanks!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] exceptionfactory commented on a change in pull request #5670: NIFI-9481 Exclude Data Transfer REST methods from DoSFilter
Posted by GitBox <gi...@apache.org>.
exceptionfactory commented on a change in pull request #5670:
URL: https://github.com/apache/nifi/pull/5670#discussion_r788072200
##########
File path: nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-jetty/src/main/java/org/apache/nifi/web/server/filter/RestApiRequestFilterProvider.java
##########
@@ -0,0 +1,62 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.
+ */
+package org.apache.nifi.web.server.filter;
+
+import org.apache.nifi.util.NiFiProperties;
+import org.eclipse.jetty.servlet.FilterHolder;
+import org.eclipse.jetty.servlets.DoSFilter;
+
+import java.util.List;
+
+/**
+ * Request Filter Provider for REST API Web Application
+ */
+public class RestApiRequestFilterProvider extends StandardRequestFilterProvider {
+ public static final String RELATIVE_PATH_ACCESS_TOKEN = "/access/token";
+
+ private static final int DOS_FILTER_REJECT_REQUEST = -1;
+
+ /**
+ * Get Filters using provided NiFi Properties and append filters for Access Token Requests
+ *
+ * @param properties NiFi Properties required
+ * @return List of Filter Holders
+ */
+ @Override
+ public List<FilterHolder> getFilters(final NiFiProperties properties) {
+ final List<FilterHolder> filters = super.getFilters(properties);
+
+ final FilterHolder accessTokenDenialOfServiceFilter = getAccessTokenDenialOfServiceFilter(properties);
+ filters.add(accessTokenDenialOfServiceFilter);
+
+ return filters;
+ }
+
+ private FilterHolder getAccessTokenDenialOfServiceFilter(final NiFiProperties properties) {
+ final FilterHolder filter = getDenialOfServiceFilter(properties, DoSFilter.class);
+
+ final int maxWebAccessTokenRequestsPerSecond = properties.getMaxWebAccessTokenRequestsPerSecond();
+ filter.setInitParameter("maxRequestsPerSec", Integer.toString(maxWebAccessTokenRequestsPerSecond));
Review comment:
Thanks for checking @gresockj, the super class `getDenialOfServiceFilter()` method sets the `ipWhitelist` property as well as the other default property values.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] asfgit closed pull request #5670: NIFI-9481 Exclude Data Transfer REST methods from DoSFilter
Posted by GitBox <gi...@apache.org>.
asfgit closed pull request #5670:
URL: https://github.com/apache/nifi/pull/5670
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org