-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
FINERACT-1794: Address improvement in file upload APIs
- Loading branch information
Showing
13 changed files
with
389 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
28 changes: 28 additions & 0 deletions
28
...he/fineract/infrastructure/documentmanagement/contentrepository/ContentPathSanitizer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| /** | ||
| * 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.fineract.infrastructure.documentmanagement.contentrepository; | ||
|
|
||
| import java.io.BufferedInputStream; | ||
|
|
||
| public interface ContentPathSanitizer { | ||
|
|
||
| String sanitize(String path); | ||
|
|
||
| String sanitize(String path, BufferedInputStream is); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
143 changes: 143 additions & 0 deletions
143
...t/infrastructure/documentmanagement/contentrepository/FileSystemContentPathSanitizer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| /** | ||
| * 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.fineract.infrastructure.documentmanagement.contentrepository; | ||
|
|
||
| import java.io.BufferedInputStream; | ||
| import java.nio.file.Path; | ||
| import java.util.List; | ||
| import java.util.regex.Pattern; | ||
| import javax.annotation.PostConstruct; | ||
| import lombok.RequiredArgsConstructor; | ||
| import lombok.extern.slf4j.Slf4j; | ||
| import org.apache.commons.io.FilenameUtils; | ||
| import org.apache.commons.lang3.StringUtils; | ||
| import org.apache.fineract.infrastructure.core.service.ThreadLocalContextUtil; | ||
| import org.apache.fineract.infrastructure.documentmanagement.exception.ContentManagementException; | ||
| import org.apache.tika.Tika; | ||
| import org.apache.tika.io.TikaInputStream; | ||
| import org.apache.tika.metadata.Metadata; | ||
| import org.apache.tika.parser.AutoDetectParser; | ||
| import org.apache.tika.sax.BodyContentHandler; | ||
| import org.springframework.beans.factory.annotation.Value; | ||
| import org.springframework.stereotype.Component; | ||
|
|
||
| @Slf4j | ||
| @RequiredArgsConstructor | ||
| @Component | ||
| public class FileSystemContentPathSanitizer implements ContentPathSanitizer { | ||
|
|
||
| private static Pattern OVERWRITE_SIBLING_IMAGE = Pattern.compile(".*\\.\\./+[0-9]+/+.*"); | ||
|
|
||
| @Value("${fineract.content.regex-whitelist-enabled}") | ||
| private boolean isRegexWhitelistEnabled; | ||
| @Value("${fineract.content.regex-whitelist}") | ||
| private List<String> regexWhitelist; | ||
| @Value("${fineract.content.mime-whitelist-enabled}") | ||
| private boolean isMimeWhitelistEnabled; | ||
| @Value("${fineract.content.mime-whitelist}") | ||
| private List<String> mimeWhitelist; | ||
| private List<Pattern> regexWhitelistPatterns; | ||
|
|
||
| @PostConstruct | ||
| public void init() { | ||
| regexWhitelistPatterns = regexWhitelist.stream().map(Pattern::compile).toList(); | ||
| } | ||
|
|
||
| @Override | ||
| public String sanitize(String path) { | ||
| return sanitize(path, null); | ||
| } | ||
|
|
||
| @Override | ||
| public String sanitize(String path, BufferedInputStream is) { | ||
| try { | ||
| if (OVERWRITE_SIBLING_IMAGE.matcher(path).matches()) { | ||
| throw new RuntimeException(String.format("Trying to overwrite another resource's image: %s", path)); | ||
| } | ||
|
|
||
| String sanitizedPath = Path.of(path).normalize().toString(); | ||
|
|
||
| String fileName = FilenameUtils.getName(sanitizedPath).toLowerCase(); | ||
|
|
||
| if (log.isDebugEnabled()) { | ||
| log.debug("Path: {} -> {} ({})", path, sanitizedPath, fileName); | ||
| } | ||
|
|
||
| if (isRegexWhitelistEnabled) { | ||
| boolean matches = regexWhitelistPatterns.stream().anyMatch(p -> p.matcher(fileName).matches()); | ||
|
|
||
| if (!matches) { | ||
| throw new RuntimeException(String.format("File name not allowed: %s", fileName)); | ||
| } | ||
| } | ||
|
|
||
| if (is != null && isMimeWhitelistEnabled) { | ||
| Tika tika = new Tika(); | ||
| String extensionMimeType = tika.detect(fileName); | ||
|
|
||
| if (StringUtils.isEmpty(extensionMimeType)) { | ||
| throw new RuntimeException(String.format("Could not detect mime type for filename %s!", fileName)); | ||
| } | ||
|
|
||
| if (!mimeWhitelist.contains(extensionMimeType)) { | ||
| throw new RuntimeException( | ||
| String.format("Detected mime type %s for filename %s not allowed!", extensionMimeType, fileName)); | ||
| } | ||
|
|
||
| String contentMimeType = detectContentMimeType(is); | ||
|
|
||
| if (StringUtils.isEmpty(contentMimeType)) { | ||
| throw new RuntimeException(String.format("Could not detect content mime type for %s!", fileName)); | ||
| } | ||
|
|
||
| if (!mimeWhitelist.contains(contentMimeType)) { | ||
| throw new RuntimeException( | ||
| String.format("Detected content mime type %s for %s not allowed!", contentMimeType, fileName)); | ||
| } | ||
|
|
||
| if (!contentMimeType.equalsIgnoreCase(extensionMimeType)) { | ||
| throw new RuntimeException(String.format("Detected filename (%s) and content (%s) mime type do not match!", | ||
| extensionMimeType, contentMimeType)); | ||
| } | ||
| } | ||
|
|
||
| Path target = Path.of(sanitizedPath); | ||
| Path rootFolder = Path.of(FileSystemContentRepository.FINERACT_BASE_DIR, | ||
| ThreadLocalContextUtil.getTenant().getName().replaceAll(" ", "").trim()); | ||
|
|
||
| if (!target.startsWith(rootFolder)) { | ||
| throw new RuntimeException(String.format("Path traversal attempt: %s (%s)", target, rootFolder)); | ||
| } | ||
|
|
||
| return sanitizedPath; | ||
| } catch (Exception e) { | ||
| throw new ContentManagementException(path, e.getMessage(), e); | ||
| } | ||
| } | ||
|
|
||
| private String detectContentMimeType(BufferedInputStream bis) throws Exception { | ||
| TikaInputStream tis = TikaInputStream.get(bis); | ||
| AutoDetectParser parser = new AutoDetectParser(); | ||
| BodyContentHandler handler = new BodyContentHandler(-1); | ||
| Metadata metadata = new Metadata(); | ||
| parser.parse(tis, handler, metadata); | ||
|
|
||
| return metadata.get("Content-Type"); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.