This is an automated email from the ASF dual-hosted git repository. markt pushed a commit to branch 10.1.x in repository https://gitbox.apache.org/repos/asf/tomcat.git
commit 8a2285f13affa961cc65595aad999db5efae45ce Author: Mark Thomas <ma...@apache.org> AuthorDate: Tue Dec 13 17:55:34 2022 +0000 Update packaged renamed fork of Commons File Upload --- MERGE.txt | 2 +- java/org/apache/catalina/connector/Request.java | 10 ++++- java/org/apache/tomcat/util/http/Parameters.java | 5 +++ .../util/http/fileupload/FileUploadBase.java | 29 +++++++++++++ .../impl/FileCountLimitExceededException.java | 50 ++++++++++++++++++++++ webapps/docs/changelog.xml | 4 ++ webapps/docs/config/ajp.xml | 15 ++++--- webapps/docs/config/http.xml | 15 ++++--- 8 files changed, 116 insertions(+), 14 deletions(-) diff --git a/MERGE.txt b/MERGE.txt index 8c1ed33662..41646180c2 100644 --- a/MERGE.txt +++ b/MERGE.txt @@ -54,7 +54,7 @@ Unused code is removed Sub-tree: src/main/java/org/apache/commons/fileupload2 The SHA1 ID / tag for the most recent commit to be merged to Tomcat is: -aa8eff6f04c939fd99834360415b1ddb2f637cb1 (2022-11-29) +34eb241c051b02eca3b0b1b04f67b3b4e6c3a24d (2023-02-03) Note: Tomcat's copy of fileupload also includes classes copied manually from Commons IO. diff --git a/java/org/apache/catalina/connector/Request.java b/java/org/apache/catalina/connector/Request.java index ecfc7aaa16..340d775b15 100644 --- a/java/org/apache/catalina/connector/Request.java +++ b/java/org/apache/catalina/connector/Request.java @@ -2816,8 +2816,9 @@ public class Request implements HttpServletRequest { } } + int maxParameterCount = getConnector().getMaxParameterCount(); Parameters parameters = coyoteRequest.getParameters(); - parameters.setLimit(getConnector().getMaxParameterCount()); + parameters.setLimit(maxParameterCount); boolean success = false; try { @@ -2869,6 +2870,13 @@ public class Request implements HttpServletRequest { upload.setFileItemFactory(factory); upload.setFileSizeMax(mce.getMaxFileSize()); upload.setSizeMax(mce.getMaxRequestSize()); + if (maxParameterCount > -1) { + // There is a limit. The limit for parts needs to be reduced by + // the number of parameters we have already parsed. + // Must be under the limit else parsing parameters would have + // triggered an exception. + upload.setFileCountMax(maxParameterCount - parameters.size()); + } parts = new ArrayList<>(); try { diff --git a/java/org/apache/tomcat/util/http/Parameters.java b/java/org/apache/tomcat/util/http/Parameters.java index ce765374e7..d233190ddb 100644 --- a/java/org/apache/tomcat/util/http/Parameters.java +++ b/java/org/apache/tomcat/util/http/Parameters.java @@ -125,6 +125,11 @@ public final class Parameters { } + public int size() { + return parameterCount; + } + + public void recycle() { parameterCount = 0; paramHashValues.clear(); diff --git a/java/org/apache/tomcat/util/http/fileupload/FileUploadBase.java b/java/org/apache/tomcat/util/http/fileupload/FileUploadBase.java index acc4aa307f..d527313723 100644 --- a/java/org/apache/tomcat/util/http/fileupload/FileUploadBase.java +++ b/java/org/apache/tomcat/util/http/fileupload/FileUploadBase.java @@ -24,6 +24,7 @@ import java.util.Locale; import java.util.Map; import java.util.Objects; +import org.apache.tomcat.util.http.fileupload.impl.FileCountLimitExceededException; import org.apache.tomcat.util.http.fileupload.impl.FileItemIteratorImpl; import org.apache.tomcat.util.http.fileupload.impl.FileUploadIOException; import org.apache.tomcat.util.http.fileupload.impl.IOFileUploadException; @@ -103,6 +104,12 @@ public abstract class FileUploadBase { */ private long fileSizeMax = -1; + /** + * The maximum permitted number of files that may be uploaded in a single + * request. A value of -1 indicates no maximum. + */ + private long fileCountMax = -1; + /** * The content encoding to use when reading part headers. */ @@ -179,6 +186,24 @@ public abstract class FileUploadBase { this.fileSizeMax = fileSizeMax; } + /** + * Returns the maximum number of files allowed in a single request. + * + * @return The maximum number of files allowed in a single request. + */ + public long getFileCountMax() { + return fileCountMax; + } + + /** + * Sets the maximum number of files allowed per request/ + * + * @param fileCountMax The new limit. {@code -1} means no limit. + */ + public void setFileCountMax(long fileCountMax) { + this.fileCountMax = fileCountMax; + } + /** * Retrieves the character encoding used when reading the headers of an * individual part. When not specified, or {@code null}, the request @@ -253,6 +278,10 @@ public abstract class FileUploadBase { "No FileItemFactory has been set."); final byte[] buffer = new byte[Streams.DEFAULT_BUFFER_SIZE]; while (iter.hasNext()) { + if (items.size() == fileCountMax) { + // The next item will exceed the limit. + throw new FileCountLimitExceededException(ATTACHMENT, getFileCountMax()); + } final FileItemStream item = iter.next(); // Don't use getName() here to prevent an InvalidFileNameException. final String fileName = item.getName(); diff --git a/java/org/apache/tomcat/util/http/fileupload/impl/FileCountLimitExceededException.java b/java/org/apache/tomcat/util/http/fileupload/impl/FileCountLimitExceededException.java new file mode 100644 index 0000000000..958f681276 --- /dev/null +++ b/java/org/apache/tomcat/util/http/fileupload/impl/FileCountLimitExceededException.java @@ -0,0 +1,50 @@ +/* + * 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.tomcat.util.http.fileupload.impl; + +import org.apache.tomcat.util.http.fileupload.FileUploadException; + +/** + * This exception is thrown if a request contains more files than the specified + * limit. + */ +public class FileCountLimitExceededException extends FileUploadException { + + private static final long serialVersionUID = 2408766352570556046L; + + private final long limit; + + /** + * Creates a new instance. + * + * @param message The detail message + * @param limit The limit that was exceeded + */ + public FileCountLimitExceededException(final String message, final long limit) { + super(message); + this.limit = limit; + } + + /** + * Retrieves the limit that was exceeded. + * + * @return The limit that was exceeded by the request + */ + public long getLimit() { + return limit; + } +} diff --git a/webapps/docs/changelog.xml b/webapps/docs/changelog.xml index 3cb080349f..9369ae0221 100644 --- a/webapps/docs/changelog.xml +++ b/webapps/docs/changelog.xml @@ -146,6 +146,10 @@ Update the packaged version of the Apache Tomcat Migration Tool for Jakarta EE to 1.0.6. (markt) </update> + <update> + Update the internal fork of Apache Commons FileUpload to 34eb241 + (2023-01-03, 2.0-SNAPSHOT). (markt) + </update> </changelog> </subsection> </section> diff --git a/webapps/docs/config/ajp.xml b/webapps/docs/config/ajp.xml index 0a3a260bf3..f4de8b0171 100644 --- a/webapps/docs/config/ajp.xml +++ b/webapps/docs/config/ajp.xml @@ -149,12 +149,15 @@ </attribute> <attribute name="maxParameterCount" required="false"> - <p>The maximum number of parameter and value pairs (GET plus POST) which - will be automatically parsed by the container. Parameter and value pairs - beyond this limit will be ignored. A value of less than 0 means no limit. - If not specified, a default of 10000 is used. Note that - <code>FailedRequestFilter</code> <a href="filter.html">filter</a> can be - used to reject requests that hit the limit.</p> + <p>The maximum total number of request parameters (including uploaded + files) obtained from the query string and, for POST requests, the request + body if the content type is + <code>application/x-www-form-urlencoded</code> or + <code>multipart/form-data</code>. Request parameters beyond this limit + will be ignored. A value of less than 0 means no limit. If not specified, + a default of 10000 is used. Note that <code>FailedRequestFilter</code> + <a href="filter.html">filter</a> can be used to reject requests that + exceed the limit.</p> </attribute> <attribute name="maxPostSize" required="false"> diff --git a/webapps/docs/config/http.xml b/webapps/docs/config/http.xml index 5b9fc6c941..98e22bf0e8 100644 --- a/webapps/docs/config/http.xml +++ b/webapps/docs/config/http.xml @@ -145,12 +145,15 @@ </attribute> <attribute name="maxParameterCount" required="false"> - <p>The maximum number of parameter and value pairs (GET plus POST) which - will be automatically parsed by the container. Parameter and value pairs - beyond this limit will be ignored. A value of less than 0 means no limit. - If not specified, a default of 10000 is used. Note that - <code>FailedRequestFilter</code> <a href="filter.html">filter</a> can be - used to reject requests that hit the limit.</p> + <p>The maximum total number of request parameters (including uploaded + files) obtained from the query string and, for POST requests, the request + body if the content type is + <code>application/x-www-form-urlencoded</code> or + <code>multipart/form-data</code>. Request parameters beyond this limit + will be ignored. A value of less than 0 means no limit. If not specified, + a default of 10000 is used. Note that <code>FailedRequestFilter</code> + <a href="filter.html">filter</a> can be used to reject requests that + exceed the limit.</p> </attribute> <attribute name="maxPostSize" required="false"> --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org