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

public final class ASiCUtils
extends Object

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`MANIFEST_FILENAME`
`static String`	`META_INF_FOLDER`
`static String`	`MIME_TYPE`
`static String`	`MIME_TYPE_COMMENT`
`static String`	`PACKAGE_ZIP`
`static String`	`SIGNATURE_FILENAME`
`static String`	`TIMESTAMP_FILENAME`
`static String`	`TST_EXTENSION`
`static String`	`XML_EXTENSION`
`static String`	`ZIP_ENTRY_DETACHED_FILE`

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>`	`getDSSDocumentNames(List<DSSDocument> documents)`	Returns a list of document names
`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 String`	`getNextASiCEManifestName(String expectedManifestName, List<DSSDocument> existingManifests)`	Generates an unique name for a new ASiC-E Manifest file, avoiding any name collision
`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 List<DSSDocument>`	`getPackageZipContent(DSSDocument packageZip)`	Returns a content of the packageZip container
`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 container, String extension)`	Checks if the container contains a signature with the expected `extension`
`static boolean`	`isArchiveContainsCorrectTimestamp(DSSDocument container)`	Checks if the container contains a timestamp
`static boolean`	`isArchiveManifest(String fileName)`
`static boolean`	`isAsic(List<DSSDocument> documents)`
`static boolean`	`isASiCE(ASiCParameters asicParameters)`
`static boolean`	`isASiCMimeType(MimeType asicMimeType)`
`static boolean`	`isASiCS(ASiCParameters asicParameters)`
`static boolean`	`isASiCSArchive(DSSDocument document)`	Checks if the current document an ASiC-E ZIP specific archive
`static boolean`	`isASiCWithCAdES(DSSDocument archive)`
`static boolean`	`isCAdES(String entryName)`
`static boolean`	`isOpenDocument(DSSDocument mimeTypeDoc)`
`static boolean`	`isOpenDocumentMimeType(MimeType mimeType)`
`static boolean`	`isSignature(String entryName)`	Verifies if the `entryName` represents a signature file name
`static boolean`	`isTimestamp(String entryName)`	Verifies if the `entryName` represents a timestamp file name
`static boolean`	`isXAdES(String entryName)`
`static boolean`	`isZip(DSSDocument dssDocument)`
`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 Details
- MANIFEST_FILENAME
  
  public static final String MANIFEST_FILENAME
  
  See Also:
  
  Constant Field Values
- 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
- SIGNATURE_FILENAME
  
  public static final String SIGNATURE_FILENAME
  
  See Also:
  
  Constant Field Values
- TIMESTAMP_FILENAME
  
  public static final String TIMESTAMP_FILENAME
  
  See Also:
  
  Constant Field Values
- TST_EXTENSION
  
  public static final String TST_EXTENSION
  
  See Also:
  
  Constant Field Values
- XML_EXTENSION
  
  public static final String XML_EXTENSION
  
  See Also:
  
  Constant Field Values
- ZIP_ENTRY_DETACHED_FILE
  
  public static final String ZIP_ENTRY_DETACHED_FILE
  
  See Also:
  
  Constant Field Values
Method Details
- isSignature
  
  public static boolean isSignature(String entryName)
  
  Verifies if the entryName represents a signature file name
  
  Parameters:
  
  entryName - String name to check
  
  Returns:
  
  TRUE if the entryName represents a signature file name, FALSE otherwise
- isTimestamp
  
  public static boolean isTimestamp(String entryName)
  
  Verifies if the entryName represents a timestamp file name
  
  Parameters:
  
  entryName - String name to check
  
  Returns:
  
  TRUE if the entryName represents a timestamp file name, FALSE otherwise
- getMimeTypeString
  
  public static String getMimeTypeString(ASiCParameters asicParameters)
- isASiCMimeType
  
  public static boolean isASiCMimeType(MimeType asicMimeType)
- isOpenDocumentMimeType
  
  public static boolean isOpenDocumentMimeType(MimeType mimeType)
- 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 container, String extension)
  
  Checks if the container contains a signature with the expected extension
  
  Parameters:
  
  container - DSSDocument representing an ASiC container
  
  extension - String signature file extension to find
  
  Returns:
  
  TRUE if the container contains the expected signature file, FALSE otherwise
- isArchiveContainsCorrectTimestamp
  
  public static boolean isArchiveContainsCorrectTimestamp(DSSDocument container)
  
  Checks if the container contains a timestamp
  
  Parameters:
  
  container - DSSDocument representing an ASiC container
  
  Returns:
  
  TRUE if the container contains the expected timestamp file, FALSE otherwise
- isArchive
  
  public static boolean isArchive(List<DSSDocument> docs)
- isZip
  
  public static boolean isZip(DSSDocument dssDocument)
- isASiCWithCAdES
  
  public static boolean isASiCWithCAdES(DSSDocument archive)
- isXAdES
  
  public static boolean isXAdES(String entryName)
- isCAdES
  
  public static boolean isCAdES(String entryName)
- isOpenDocument
  
  public static boolean isOpenDocument(DSSDocument mimeTypeDoc)
- 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
- getNextASiCEManifestName
  
  public static String getNextASiCEManifestName(String expectedManifestName, List<DSSDocument> existingManifests)
  
  Generates an unique name for a new ASiC-E Manifest file, avoiding any name collision
  
  Parameters:
  
  expectedManifestName - String defines the expected name of the file without extension (e.g. "ASiCmanifest")
  
  existingManifests - list of existing DSSDocument manifests of the type present in the container
  
  Returns:
  
  String new manifest name
- getDSSDocumentNames
  
  public static List<String> getDSSDocumentNames(List<DSSDocument> documents)
  
  Returns a list of document names
  
  Parameters:
  
  documents - list of DSSDocuments to get file names
  
  Returns:
  
  list of String document names
- isASiCSArchive
  
  public static boolean isASiCSArchive(DSSDocument document)
  
  Checks if the current document an ASiC-E ZIP specific archive
  
  Parameters:
  
  document - DSSDocument to check
  
  Returns:
  
  TRUE if the document if a "package.zip" archive, FALSE otherwise
- getPackageZipContent
  
  public static List<DSSDocument> getPackageZipContent(DSSDocument packageZip)
  
  Returns a content of the packageZip container
  
  Parameters:
  
  packageZip - DSSDocument ZIP container to get entries from
  
  Returns:
  
  list of DSSDocuments

Class ASiCUtils

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Method Details