Add ability to limit output size for zip unarchiver #115
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -16,22 +16,22 @@ | |
| */ | ||
| package org.codehaus.plexus.archiver.zip; | ||
|
|
||
| import org.apache.commons.compress.archivers.zip.UnicodePathExtraField; | ||
| import org.apache.commons.compress.archivers.zip.ZipArchiveEntry; | ||
| import org.apache.commons.compress.archivers.zip.ZipFile; | ||
| import org.codehaus.plexus.archiver.AbstractUnArchiver; | ||
| import org.codehaus.plexus.archiver.ArchiverException; | ||
| import org.codehaus.plexus.components.io.resources.PlexusIoResource; | ||
|
|
||
| import javax.annotation.Nonnull; | ||
| import javax.annotation.Nullable; | ||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.io.UnsupportedEncodingException; | ||
| import java.net.URL; | ||
| import java.util.Date; | ||
| import java.util.Enumeration; | ||
|
|
||
| /** | ||
| * @author <a href="mailto:[email protected]">Emmanuel Venisse</a> | ||
|
|
@@ -44,6 +44,9 @@ public abstract class AbstractZipUnArchiver | |
|
|
||
| private String encoding = "UTF8"; | ||
|
|
||
| @Nullable | ||
| private Long maxOutputSize; | ||
|
There was a problem hiding this comment. Would it make sense to use There was a problem hiding this comment. Would it makes sense to have it for other archives (such as tar)? |
||
|
|
||
| public AbstractZipUnArchiver() | ||
| { | ||
| } | ||
|
|
@@ -68,6 +71,14 @@ public void setEncoding( String encoding ) | |
| this.encoding = encoding; | ||
| } | ||
|
|
||
| /** | ||
| * Set produced output size limit as a way of protection against zip bombs | ||
| * @param maxOutputSize - max size of produced output in bytes | ||
| */ | ||
| public void setMaxOutputSize(Long maxOutputSize) { | ||
| this.maxOutputSize = maxOutputSize; | ||
| } | ||
|
|
||
| private static class ZipEntryFileInfo | ||
| implements PlexusIoResource | ||
| { | ||
|
|
@@ -160,78 +171,58 @@ public boolean isExisting() | |
| protected void execute() | ||
| throws ArchiverException | ||
| { | ||
| try(ZipFile zipFile = new ZipFile( getSourceFile(), encoding, true )) | ||
|
There was a problem hiding this comment. Would you please keep the diff minimal. I think this change makes the diff difficult to read. Using try-with-resource is better, but it would be better if this refactoring is made in separate merge request in order to make the commit easier to understand. |
||
| { | ||
| getLogger().debug( "Expanding: " + getSourceFile() + " into " + getDestDirectory() ); | ||
| Long remainingSpace = maxOutputSize; | ||
| final Enumeration e = zipFile.getEntriesInPhysicalOrder(); | ||
|
There was a problem hiding this comment. The same here. Initially I thought the order in which the entries are iterated is changed :) Refactoring unrelated to the change(like renaming variables, changing the lines order, etc) is best left in separate merge request. |
||
| while ( e.hasMoreElements() ) | ||
| { | ||
| final ZipArchiveEntry ze = (ZipArchiveEntry) e.nextElement(); | ||
| final ZipEntryFileInfo fileInfo = new ZipEntryFileInfo( zipFile, ze ); | ||
| if ( isSelected( fileInfo.getName(), fileInfo ) ) | ||
| { | ||
| try (InputStream in = zipFile.getInputStream(ze)) { | ||
|
|
||
| if (remainingSpace != null) | ||
| { | ||
| File file = extractFile(getSourceFile(), getDestDirectory(), in, remainingSpace, | ||
| fileInfo.getName(), new Date(ze.getTime()), ze.isDirectory(), | ||
| ze.getUnixMode() != 0 ? ze.getUnixMode() : null, | ||
| resolveSymlink(zipFile, ze), getFileMappers()); | ||
| if (file != null) | ||
| { | ||
| remainingSpace -= file.length(); | ||
| if (remainingSpace <= 0) | ||
| { | ||
| throw new ArchiverException("Maximum output size limit reached"); | ||
| } | ||
| } | ||
| } | ||
| else | ||
| { | ||
| extractFile(getSourceFile(), getDestDirectory(), in, fileInfo.getName(), | ||
| new Date(ze.getTime()), ze.isDirectory(), | ||
| ze.getUnixMode() != 0 ? ze.getUnixMode() : null, | ||
| resolveSymlink(zipFile, ze), getFileMappers()); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| getLogger().debug( "expand complete" ); | ||
| } | ||
| catch ( final IOException ioe ) | ||
| { | ||
| throw new ArchiverException( "Error while expanding " + getSourceFile().getAbsolutePath(), ioe ); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| protected void execute( final String path, final File outputDirectory ) | ||
| throws ArchiverException | ||
| { | ||
| try(ZipFile zipFile = new ZipFile( getSourceFile(), encoding, true )) | ||
| { | ||
| Long remainingSpace = maxOutputSize; | ||
| final Enumeration e = zipFile.getEntriesInPhysicalOrder(); | ||
|
|
||
| while ( e.hasMoreElements() ) | ||
|
|
@@ -245,30 +236,49 @@ protected void execute( final String path, final File outputDirectory ) | |
|
|
||
| if ( ze.getName().startsWith( path ) ) | ||
| { | ||
| try(InputStream in = zipFile.getInputStream( ze )) { | ||
| if (remainingSpace != null) | ||
| { | ||
| File file = extractFile(getSourceFile(), outputDirectory, in, remainingSpace, | ||
| ze.getName(), new Date(ze.getTime()), ze.isDirectory(), | ||
| ze.getUnixMode() != 0 ? ze.getUnixMode() : null, | ||
| resolveSymlink(zipFile, ze), getFileMappers()); | ||
| if (file != null) | ||
| { | ||
| remainingSpace -= file.length(); | ||
|
There was a problem hiding this comment. Is
|
||
| if (remainingSpace <= 0) | ||
| { | ||
| throw new ArchiverException("Maximum output size limit reached"); | ||
| } | ||
| } | ||
| } | ||
| else | ||
| { | ||
| extractFile(getSourceFile(), outputDirectory, in, | ||
| ze.getName(), new Date(ze.getTime()), ze.isDirectory(), | ||
| ze.getUnixMode() != 0 ? ze.getUnixMode() : null, | ||
| resolveSymlink(zipFile, ze), getFileMappers()); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| catch ( final IOException ioe ) | ||
| { | ||
| throw new ArchiverException( "Error while expanding " + getSourceFile().getAbsolutePath(), ioe ); | ||
| } | ||
| } | ||
|
|
||
| private String resolveSymlink( ZipFile zf, ZipArchiveEntry ze ) | ||
|
|
||
| throws IOException | ||
| { | ||
| if ( ze.isUnixSymlink() ) | ||
| { | ||
| return zf.getUnixSymlink( ze ); | ||
| } | ||
| else | ||
| { | ||
| return null; | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we usually not use stars import (please avoid changing the order of import)