com.fr.base.frpx.util

类 ZipSecureFile

java.lang.Object

java.util.zip.ZipFile

com.fr.base.frpx.util.ZipSecureFile

所有已实现的接口:

java.io.Closeable, java.lang.AutoCloseable

public class ZipSecureFile
extends java.util.zip.ZipFile

This class wraps a ZipFile in order to check the entries for zip bombs while reading the archive. If a ZipInputStream is directly used, the wrapper can be applied via addThreshold(InputStream). The alert limits can be globally defined via setMaxEntrySize(long) and setMinInflateRatio(double).

import From poi

字段概要

字段

限定符和类型	字段和说明
static int	CENATT
static int	CENATX
static int	CENCOM
static int	CENCRC
static int	CENDSK
static int	CENEXT
static int	CENFLG
static int	CENHDR
static int	CENHOW
static int	CENLEN
static int	CENNAM
static int	CENOFF
static long	CENSIG
static int	CENSIZ
static int	CENTIM
static int	CENVEM
static int	CENVER
static int	ENDCOM
static int	ENDHDR
static int	ENDOFF
static long	ENDSIG
static int	ENDSIZ
static int	ENDSUB
static int	ENDTOT
static int	EXTCRC
static int	EXTHDR
static int	EXTLEN
static long	EXTSIG
static int	EXTSIZ
static int	LOCCRC
static int	LOCEXT
static int	LOCFLG
static int	LOCHDR
static int	LOCHOW
static int	LOCLEN
static int	LOCNAM
static long	LOCSIG
static int	LOCSIZ
static int	LOCTIM
static int	LOCVER

从类继承的字段 java.util.zip.ZipFile

OPEN_DELETE, OPEN_READ

构造器概要

构造器

构造器和说明
ZipSecureFile(java.io.File file)
ZipSecureFile(java.io.File file, int mode)
ZipSecureFile(java.lang.String name)

方法概要

方法

限定符和类型	方法和说明
static ThresholdInputStream	addThreshold(java.io.InputStream zipIS)
java.io.InputStream	getInputStream(java.util.zip.ZipEntry entry) Returns an input stream for reading the contents of the specified zip file entry.
static long	getMaxEntrySize() Returns the current maximum allowed uncompressed file size.
static long	getMaxTextSize() Returns the current maximum allowed text size.
static double	getMinInflateRatio() Returns the current minimum compression rate that is used.
static void	setMaxEntrySize(long maxEntrySize) Sets the maximum file size of a single zip entry.
static void	setMaxTextSize(long maxTextSize) Sets the maximum number of characters of text that are extracted before an exception is thrown during extracting text from documents.
static void	setMinInflateRatio(double ratio) Sets the ratio between de- and inflated bytes to detect zipbomb.

从类继承的方法 java.util.zip.ZipFile

close, entries, finalize, getComment, getEntry, getName, size

从类继承的方法 java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

LOCSIG

public static final long LOCSIG

另请参阅:

常量字段值

EXTSIG

public static final long EXTSIG

另请参阅:

常量字段值

CENSIG

public static final long CENSIG

另请参阅:

常量字段值

ENDSIG

public static final long ENDSIG

另请参阅:

常量字段值

LOCHDR

public static final int LOCHDR

另请参阅:

常量字段值

EXTHDR

public static final int EXTHDR

另请参阅:

常量字段值

CENHDR

public static final int CENHDR

另请参阅:

常量字段值

ENDHDR

public static final int ENDHDR

另请参阅:

常量字段值

LOCVER

public static final int LOCVER

另请参阅:

常量字段值

LOCFLG

public static final int LOCFLG

另请参阅:

常量字段值

LOCHOW

public static final int LOCHOW

另请参阅:

常量字段值

LOCTIM

public static final int LOCTIM

另请参阅:

常量字段值

LOCCRC

public static final int LOCCRC

另请参阅:

常量字段值

LOCSIZ

public static final int LOCSIZ

另请参阅:

常量字段值

LOCLEN

public static final int LOCLEN

另请参阅:

常量字段值

LOCNAM

public static final int LOCNAM

另请参阅:

常量字段值

LOCEXT

public static final int LOCEXT

另请参阅:

常量字段值

EXTCRC

public static final int EXTCRC

另请参阅:

常量字段值

EXTSIZ

public static final int EXTSIZ

另请参阅:

常量字段值

EXTLEN

public static final int EXTLEN

另请参阅:

常量字段值

CENVEM

public static final int CENVEM

另请参阅:

常量字段值

CENVER

public static final int CENVER

另请参阅:

常量字段值

CENFLG

public static final int CENFLG

另请参阅:

常量字段值

CENHOW

public static final int CENHOW

另请参阅:

常量字段值

CENTIM

public static final int CENTIM

另请参阅:

常量字段值

CENCRC

public static final int CENCRC

另请参阅:

常量字段值

CENSIZ

public static final int CENSIZ

另请参阅:

常量字段值

CENLEN

public static final int CENLEN

另请参阅:

常量字段值

CENNAM

public static final int CENNAM

另请参阅:

常量字段值

CENEXT

public static final int CENEXT

另请参阅:

常量字段值

CENCOM

public static final int CENCOM

另请参阅:

常量字段值

CENDSK

public static final int CENDSK

另请参阅:

常量字段值

CENATT

public static final int CENATT

另请参阅:

常量字段值

CENATX

public static final int CENATX

另请参阅:

常量字段值

CENOFF

public static final int CENOFF

另请参阅:

常量字段值

ENDSUB

public static final int ENDSUB

另请参阅:

常量字段值

ENDTOT

public static final int ENDTOT

另请参阅:

常量字段值

ENDSIZ

public static final int ENDSIZ

另请参阅:

常量字段值

ENDOFF

public static final int ENDOFF

另请参阅:

常量字段值

ENDCOM

public static final int ENDCOM

另请参阅:

常量字段值

构造器详细资料

ZipSecureFile

public ZipSecureFile(java.io.File file,
             int mode)
              throws java.util.zip.ZipException,
                     java.io.IOException

抛出:

java.util.zip.ZipException

java.io.IOException

ZipSecureFile

public ZipSecureFile(java.io.File file)
              throws java.util.zip.ZipException,
                     java.io.IOException

抛出:

java.util.zip.ZipException

java.io.IOException

ZipSecureFile

public ZipSecureFile(java.lang.String name)
              throws java.util.zip.ZipException,
                     java.io.IOException

抛出:

java.util.zip.ZipException

java.io.IOException

方法详细资料

setMinInflateRatio

public static void setMinInflateRatio(double ratio)

Sets the ratio between de- and inflated bytes to detect zipbomb. It defaults to 1% (= 0.01d), i.e. when the compression is better than 1% for any given read package part, the parsing will fail indicating a Zip-Bomb.

参数:

ratio - the ratio between de- and inflated bytes to detect zipbomb

getMinInflateRatio

public static double getMinInflateRatio()

Returns the current minimum compression rate that is used.

See setMinInflateRatio() for details.

返回:

The min accepted compression-ratio.

setMaxEntrySize

public static void setMaxEntrySize(long maxEntrySize)

Sets the maximum file size of a single zip entry. It defaults to 4GB, i.e. the 32-bit zip format maximum.

This can be used to limit memory consumption and protect against security vulnerabilities when documents are provided by users.

参数:

maxEntrySize - the max. file size of a single zip entry

getMaxEntrySize

public static long getMaxEntrySize()

Returns the current maximum allowed uncompressed file size.

See setMaxEntrySize() for details.

返回:

The max accepted uncompressed file size.

setMaxTextSize

public static void setMaxTextSize(long maxTextSize)

Sets the maximum number of characters of text that are extracted before an exception is thrown during extracting text from documents.

This can be used to limit memory consumption and protect against security vulnerabilities when documents are provided by users.

参数:

maxTextSize - the max. file size of a single zip entry

getMaxTextSize

public static long getMaxTextSize()

Returns the current maximum allowed text size.

See setMaxTextSize() for details.

返回:

The max accepted text size.

getInputStream

public java.io.InputStream getInputStream(java.util.zip.ZipEntry entry)
                                   throws java.io.IOException

Returns an input stream for reading the contents of the specified zip file entry.

Closing this ZIP file will, in turn, close all input streams that have been returned by invocations of this method.

覆盖:

getInputStream 在类中 java.util.zip.ZipFile

参数:

entry - the zip file entry

返回:

the input stream for reading the contents of the specified zip file entry.

抛出:

java.util.zip.ZipException - if a ZIP format error has occurred

java.io.IOException - if an I/O error has occurred

java.lang.IllegalStateException - if the zip file has been closed

addThreshold

public static ThresholdInputStream addThreshold(java.io.InputStream zipIS)
                                         throws java.io.IOException

抛出:

java.io.IOException