net.jsign

Interface Signable

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

APPXFile, CatalogFile, JScript, MSCabinetFile, MSIFile, NAVXFile, NugetFile, PEFile, PowerShellScript, PowerShellXMLScript, VBScript, WindowsScript

public interface Signable
extends Closeable

A file that can be signed with Authenticode.

Author:

Emmanuel Bourg

Method Summary

Modifier and Type	Method and Description
default byte[]	computeDigest(net.jsign.DigestAlgorithm digestAlgorithm) Computes the digest of the file.
org.bouncycastle.asn1.ASN1Object	createIndirectData(net.jsign.DigestAlgorithm digestAlgorithm) Creates the SpcIndirectDataContent structure containing the digest of the file.
default List<org.bouncycastle.asn1.cms.Attribute>	createSignedAttributes(X509Certificate certificate) Creates the signed attributes to include in the signature.
default org.bouncycastle.cms.CMSTypedData	createSignedContent(net.jsign.DigestAlgorithm digestAlgorithm) Creates the ContentInfo or EncapsulatedContentInfo structure to be signed.
List<org.bouncycastle.cms.CMSSignedData>	getSignatures() Returns the Authenticode signatures on the file.
static Signable	of(File file) Returns a signable object for the file specified.
static Signable	of(File file, Charset encoding) Returns a signable object for the file specified.
void	save() Saves the file.
void	setSignature(org.bouncycastle.cms.CMSSignedData signature) Sets the signature of the file, overwriting the previous one.
default void	setSignatures(List<org.bouncycastle.cms.CMSSignedData> signatures) Sets the signatures of the file, overwriting the previous ones.
default void	validate(Certificate certificate) Checks if the specified certificate is suitable for signing the file.

Methods inherited from interface java.io.Closeable

close

Method Detail

computeDigest

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

Computes the digest of the file.

Parameters:

digestAlgorithm - the digest algorithm to use

Returns:

the digest of the file

Throws:

IOException - if an I/O error occurs

Since:

6.0

createIndirectData

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

Creates the SpcIndirectDataContent structure containing the digest of the file.

Parameters:

digestAlgorithm - the digest algorithm to use

Returns:

the SpcIndirectDataContent structure in ASN.1 format

Throws:

IOException - if an I/O error occurs

createSignedAttributes

default List<org.bouncycastle.asn1.cms.Attribute> createSignedAttributes(X509Certificate certificate)
                                                                  throws CertificateEncodingException

Creates the signed attributes to include in the signature.

Parameters:

certificate - the signing certificate

Throws:

CertificateEncodingException

Since:

7.0

createSignedContent

default org.bouncycastle.cms.CMSTypedData createSignedContent(net.jsign.DigestAlgorithm digestAlgorithm)
                                                       throws IOException

Creates the ContentInfo or EncapsulatedContentInfo structure to be signed.

Parameters:

digestAlgorithm - the digest algorithm to use

Returns:

the ContentInfo or EncapsulatedContentInfo structure

Throws:

IOException - if an I/O error occurs

Since:

7.0

getSignatures

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

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

Returns:

the signatures (empty if the file is not signed)

Throws:

IOException - if an I/O error occurs

of

static Signable of(File file)
            throws IOException

Returns a signable object for the file specified.

Parameters:

file - the file that is intended to be signed

Returns:

the signable object for the specified file

Throws:

IOException - if an I/O error occurs

UnsupportedOperationException - if the file specified isn't supported

of

static Signable of(File file,
                   Charset encoding)
            throws IOException

Returns a signable object for the file specified.

Parameters:

file - the file that is intended to be signed

encoding - the character encoding (for text files only). If the file has a byte order mark this parameter is ignored.

Returns:

the signable object for the specified file

Throws:

IOException - if an I/O error occurs

UnsupportedOperationException - if the file specified isn't supported

save

void save()
   throws IOException

Saves the file.

Throws:

IOException - if an I/O error occurs

setSignature

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

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

Parameters:

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

Throws:

IOException - if an I/O error occurs

setSignatures

default void setSignatures(List<org.bouncycastle.cms.CMSSignedData> signatures)
                    throws IOException

Sets the signatures of the file, overwriting the previous ones. The default implementation folds all the signatures into the first one (using a SPC_NESTED_SIGNATURE_OBJID unauthenticated attribute) and then calls setSignature(CMSSignedData).

Parameters:

signatures - the signatures to put, empty or null to remove the signatures

Throws:

IOException - if an I/O error occurs

Since:

7.3

validate

default void validate(Certificate certificate)
               throws IOException,
                      IllegalArgumentException

Checks if the specified certificate is suitable for signing the file.

Parameters:

certificate - the certificate to validate

Throws:

IOException - if an I/O error occurs

IllegalArgumentException - if the certificate doesn't match the publisher identity

Since:

7.0