net.jsign.pe

Class PEFile

java.lang.Object

net.jsign.pe.PEFile

All Implemented Interfaces:

Closeable, AutoCloseable, Signable

public class PEFile
extends Object
implements Signable

Portable Executable File. This class is thread safe.

Since:

1.0

Author:

Emmanuel Bourg

See Also:

Microsoft PE and COFF Specification

Constructor Summary

Constructors

Constructor and Description
PEFile(File file) Create a PEFile from the specified file.
PEFile(SeekableByteChannel channel) Create a PEFile from the specified channel.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the file
byte[]	computeDigest(net.jsign.DigestAlgorithm digestAlgorithm) Compute the digest of the file.
org.bouncycastle.asn1.ASN1Object	createIndirectData(net.jsign.DigestAlgorithm digestAlgorithm) Creates the SpcIndirectDataContent structure containing the digest of the file.
List<org.bouncycastle.cms.CMSSignedData>	getSignatures() Returns the Authenticode signatures on the file.
static boolean	isPEFile(File file) Tells if the specified file is a Portable Executable file.
void	save() Saves the file.
void	setSignature(org.bouncycastle.cms.CMSSignedData signature) Sets the signature of the file, overwriting the previous one.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.jsign.Signable

createSignedAttributes, createSignedContent, of, of, setSignatures, validate

Constructor Detail

PEFile

public PEFile(File file)
       throws IOException

Create a PEFile from the specified file.

Parameters:

file - the file to open

Throws:

IOException - if an I/O error occurs

PEFile

public PEFile(SeekableByteChannel channel)
       throws IOException

Create a PEFile from the specified channel.

Parameters:

channel - the channel to read the file from

Throws:

IOException - if an I/O error occurs

Since:

2.0

Method Detail

close

public void close()
           throws IOException

Closes the file

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if an I/O error occurs

computeDigest

public byte[] computeDigest(net.jsign.DigestAlgorithm digestAlgorithm)
                     throws IOException

Compute the digest of the file. The checksum field, the certificate directory table entry and the certificate table are excluded from the digest.

Specified by:

computeDigest in interface Signable

Parameters:

digestAlgorithm - the digest algorithm to use

Returns:

the digest of the file

Throws:

IOException - if an I/O error occurs

createIndirectData

public org.bouncycastle.asn1.ASN1Object createIndirectData(net.jsign.DigestAlgorithm digestAlgorithm)
                                                    throws IOException

Description copied from interface: Signable

Creates the SpcIndirectDataContent structure containing the digest of the file.

Specified by:

createIndirectData in interface Signable

Parameters:

digestAlgorithm - the digest algorithm to use

Returns:

the SpcIndirectDataContent structure in ASN.1 format

Throws:

IOException - if an I/O error occurs

getSignatures

public List<org.bouncycastle.cms.CMSSignedData> getSignatures()
                                                       throws IOException

Description copied from interface: Signable

Returns the Authenticode signatures on the file. To modify the signatures, use Signable.setSignatures(List).

Specified by:

getSignatures in interface Signable

Returns:

the signatures (empty if the file is not signed)

Throws:

IOException - if an I/O error occurs

isPEFile

public static boolean isPEFile(File file)
                        throws IOException

Tells if the specified file is a Portable Executable file.

Parameters:

file - the file to check

Returns:

true if the file is a Portable Executable, false otherwise

Throws:

IOException - if an I/O error occurs

Since:

3.0

save

public void save()

Description copied from interface: Signable

Saves the file.

Specified by:

save in interface Signable

setSignature

public void setSignature(org.bouncycastle.cms.CMSSignedData signature)
                  throws IOException

Description copied from interface: Signable

Sets the signature of the file, overwriting the previous one.

Specified by:

setSignature in interface Signable

Parameters:

signature - the signature to put, or null to remove the signature

Throws:

IOException - if an I/O error occurs