Package eu.europa.esig.dss.asic.common

Class ASiCUtils

java.lang.Object

eu.europa.esig.dss.asic.common.ASiCUtils

public final class ASiCUtils
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	META_INF_FOLDER
static String	MIME_TYPE
static String	MIME_TYPE_COMMENT
static String	PACKAGE_ZIP

Method Summary

Modifier and Type	Method	Description
static void	closeEntry(ZipInputStream zis)	This method closes the current Zip Entry.
static ASiCContainerType	getASiCContainerType(MimeType asicMimeType)
static ASiCContainerType	getContainerType(DSSDocument archive, DSSDocument mimetype, String zipComment, List<DSSDocument> signedDocuments)
static DSSDocument	getCurrentDocument(String filepath, ZipInputStream zis, long containerSize)	Returns file from the given ZipInputStream
static List<String>	getFileNames(DSSDocument archive)	Returns the file names for the given archive
static MimeType	getMimeType(ASiCParameters asicParameters)
static MimeType	getMimeType(DSSDocument mimeTypeDocument)
static String	getMimeTypeString(ASiCParameters asicParameters)
static ZipEntry	getNextValidEntry(ZipInputStream zis)	Returns the next entry from the given ZipInputStream by skipping corrupted or not accessible files NOTE: returns null only when the end of ZipInputStream is reached
static String	getPadNumber(int num)	Transforms num with the pattern: "2 -> 002", "10 -> 010", etc.
static boolean	isArchive(List<DSSDocument> docs)
static boolean	isArchiveContainsCorrectSignatureFileWithExtension(DSSDocument toSignDocument, String extension)
static boolean	isArchiveManifest(String fileName)
static boolean	isAsic(List<DSSDocument> documents)
static boolean	isASiCContainer(DSSDocument dssDocument)
static boolean	isASiCE(ASiCParameters asicParameters)
static boolean	isASiCMimeType(MimeType asicMimeType)
static boolean	isASiCS(ASiCParameters asicParameters)
static boolean	isCAdES(String entryName)
static boolean	isOpenDocument(DSSDocument mimeTypeDocument)
static boolean	isSignature(String entryName)
static boolean	isXAdES(String entryName)
static void	secureCopy(InputStream is, OutputStream os, long containerSize)	Reads and copies InputStream in a secure way, depending on the provided container size This method allows to detect "ZipBombing" (large files inside a zip container)

Methods inherited from class java.lang.Object

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

Field Detail

MIME_TYPE

public static final String MIME_TYPE

See Also:

Constant Field Values

MIME_TYPE_COMMENT

public static final String MIME_TYPE_COMMENT

See Also:

Constant Field Values

META_INF_FOLDER

public static final String META_INF_FOLDER

See Also:

Constant Field Values

PACKAGE_ZIP

public static final String PACKAGE_ZIP

See Also:

Constant Field Values

Method Detail

isSignature

public static boolean isSignature(String entryName)

getMimeTypeString

public static String getMimeTypeString(ASiCParameters asicParameters)

isASiCMimeType

public static boolean isASiCMimeType(MimeType asicMimeType)

getASiCContainerType

public static ASiCContainerType getASiCContainerType(MimeType asicMimeType)

isASiCE

public static boolean isASiCE(ASiCParameters asicParameters)

isASiCS

public static boolean isASiCS(ASiCParameters asicParameters)

getMimeType

public static MimeType getMimeType(ASiCParameters asicParameters)

isArchiveContainsCorrectSignatureFileWithExtension

public static boolean isArchiveContainsCorrectSignatureFileWithExtension(DSSDocument toSignDocument,
                                                                         String extension)

isArchive

public static boolean isArchive(List<DSSDocument> docs)

isASiCContainer

public static boolean isASiCContainer(DSSDocument dssDocument)

isXAdES

public static boolean isXAdES(String entryName)

isCAdES

public static boolean isCAdES(String entryName)

isOpenDocument

public static boolean isOpenDocument(DSSDocument mimeTypeDocument)

getMimeType

public static MimeType getMimeType(DSSDocument mimeTypeDocument)

getContainerType

public static ASiCContainerType getContainerType(DSSDocument archive,
                                                 DSSDocument mimetype,
                                                 String zipComment,
                                                 List<DSSDocument> signedDocuments)

getPadNumber

public static String getPadNumber(int num)

Transforms num with the pattern: "2 -> 002", "10 -> 010", etc.

Parameters:

num -

Returns:

String

isAsic

public static boolean isAsic(List<DSSDocument> documents)

isArchiveManifest

public static boolean isArchiveManifest(String fileName)

secureCopy

public static void secureCopy(InputStream is,
                              OutputStream os,
                              long containerSize)
                       throws IOException

Reads and copies InputStream in a secure way, depending on the provided container size This method allows to detect "ZipBombing" (large files inside a zip container)

Parameters:

is - InputStream of file

os - OutputStream where save file to

containerSize - - zip container size

Throws:

IOException

getFileNames

public static List<String> getFileNames(DSSDocument archive)

Returns the file names for the given archive

Parameters:

archive - the archive to be analyzed

Returns:

a list of filename

getNextValidEntry

public static ZipEntry getNextValidEntry(ZipInputStream zis)

Returns the next entry from the given ZipInputStream by skipping corrupted or not accessible files NOTE: returns null only when the end of ZipInputStream is reached

Parameters:

zis - ZipInputStream to get next entry from

Returns:

list of file name Strings

Throws:

DSSException - if too much tries failed

getCurrentDocument

public static DSSDocument getCurrentDocument(String filepath,
                                             ZipInputStream zis,
                                             long containerSize)
                                      throws IOException

Returns file from the given ZipInputStream

Parameters:

filepath - String filepath where the file is located

zis - ZipInputStream of the file

containerSize - - long byte size of the parent container

Returns:

DSSDocument created from the given zis

Throws:

IOException - in case of ZipInputStream read error

closeEntry

public static void closeEntry(ZipInputStream zis)

This method closes the current Zip Entry. If an error occurs, a DSSException is thrown.

Parameters:

zis - the ZipInputStream