com.android.apksig

Class DefaultApkSignerEngine

java.lang.Object

com.android.apksig.DefaultApkSignerEngine

All Implemented Interfaces:

ApkSignerEngine, java.io.Closeable, java.lang.AutoCloseable

public class DefaultApkSignerEngine
extends java.lang.Object
implements ApkSignerEngine

Default implementation of ApkSignerEngine.

Use DefaultApkSignerEngine.SignerConfig.Builder to obtain instances of this engine.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultApkSignerEngine.Builder Builder of DefaultApkSignerEngine instances.
static class	DefaultApkSignerEngine.SignerConfig Configuration of a signer.

Nested classes/interfaces inherited from interface com.android.apksig.ApkSignerEngine

ApkSignerEngine.InputJarEntryInstructions, ApkSignerEngine.InspectJarEntryRequest, ApkSignerEngine.OutputApkSigningBlockRequest, ApkSignerEngine.OutputApkSigningBlockRequest2, ApkSignerEngine.OutputJarSignatureRequest

Method Summary

Modifier and Type	Method and Description
void	close() Indicates to this engine that it will no longer be used.
java.util.Set<java.lang.String>	initWith(byte[] manifestBytes, java.util.Set<java.lang.String> entryNames) Initializes DefaultApkSignerEngine with the existing MANIFEST.MF.
void	inputApkSigningBlock(DataSource apkSigningBlock) Indicates to this engine that the input APK contains the provided APK Signing Block.
ApkSignerEngine.InputJarEntryInstructions	inputJarEntry(java.lang.String entryName) Indicates to this engine that the specified JAR entry was encountered in the input APK.
ApkSignerEngine.InputJarEntryInstructions.OutputPolicy	inputJarEntryRemoved(java.lang.String entryName) Indicates to this engine that the specified JAR entry was removed from the input.
void	outputDone() Indicates to this engine that the signed APK was output.
ApkSignerEngine.OutputJarSignatureRequest	outputJarEntries() Indicates to this engine that all JAR entries have been output.
ApkSignerEngine.InspectJarEntryRequest	outputJarEntry(java.lang.String entryName) Indicates to this engine that the specified JAR entry was output.
void	outputJarEntryRemoved(java.lang.String entryName) Indicates to this engine that the specified JAR entry was removed from the output.
ApkSignerEngine.OutputApkSigningBlockRequest	outputZipSections(DataSource zipEntries, DataSource zipCentralDirectory, DataSource zipEocd) Deprecated.
ApkSignerEngine.OutputApkSigningBlockRequest2	outputZipSections2(DataSource zipEntries, DataSource zipCentralDirectory, DataSource zipEocd) Indicates to this engine that the ZIP sections comprising the output APK have been output.
void	setExecutor(RunnablesExecutor executor)

Methods inherited from class java.lang.Object

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

Method Detail

initWith

public java.util.Set<java.lang.String> initWith(byte[] manifestBytes,
                                                java.util.Set<java.lang.String> entryNames)

Initializes DefaultApkSignerEngine with the existing MANIFEST.MF. This reads existing digests from the MANIFEST.MF file (they are assumed correct) and stores them for the final signature without recalculation. This step has a significant performance benefit in case of incremental build. This method extracts and stored computed digest for every entry that it would compute it for in the outputJarEntry(String) method

Specified by:

initWith in interface ApkSignerEngine

Parameters:

manifestBytes - raw representation of MANIFEST.MF file

entryNames - a set of expected entries names

Returns:

set of entry names which were processed by the engine during the initialization, a subset of entryNames

setExecutor

public void setExecutor(RunnablesExecutor executor)

Specified by:

setExecutor in interface ApkSignerEngine

inputApkSigningBlock

public void inputApkSigningBlock(DataSource apkSigningBlock)

Description copied from interface: ApkSignerEngine

Indicates to this engine that the input APK contains the provided APK Signing Block. The block may contain signatures of the input APK, such as APK Signature Scheme v2 signatures.

Specified by:

inputApkSigningBlock in interface ApkSignerEngine

Parameters:

apkSigningBlock - APK signing block of the input APK. The provided data source is guaranteed to not be used by the engine after this method terminates.

inputJarEntry

public ApkSignerEngine.InputJarEntryInstructions inputJarEntry(java.lang.String entryName)

Description copied from interface: ApkSignerEngine

Indicates to this engine that the specified JAR entry was encountered in the input APK.

When an input entry is updated/changed, it's OK to not invoke ApkSignerEngine.inputJarEntryRemoved(String) before invoking this method.

Specified by:

inputJarEntry in interface ApkSignerEngine

Returns:

instructions about how to proceed with this entry

outputJarEntry

public ApkSignerEngine.InspectJarEntryRequest outputJarEntry(java.lang.String entryName)

Description copied from interface: ApkSignerEngine

Indicates to this engine that the specified JAR entry was output.

It is unnecessary to invoke this method for entries added to output by this engine (e.g., requested by ApkSignerEngine.outputJarEntries()) provided the entries were output with exactly the data requested by the engine.

When an already output entry is updated/changed, it's OK to not invoke ApkSignerEngine.outputJarEntryRemoved(String) before invoking this method.

Specified by:

outputJarEntry in interface ApkSignerEngine

Returns:

request to inspect the entry or null if the engine does not need to inspect the entry. The request must be fulfilled before ApkSignerEngine.outputJarEntries() is invoked.

inputJarEntryRemoved

public ApkSignerEngine.InputJarEntryInstructions.OutputPolicy inputJarEntryRemoved(java.lang.String entryName)

Description copied from interface: ApkSignerEngine

Indicates to this engine that the specified JAR entry was removed from the input. It's safe to invoke this for entries for which ApkSignerEngine.inputJarEntry(String) hasn't been invoked.

Specified by:

inputJarEntryRemoved in interface ApkSignerEngine

Returns:

output policy of this JAR entry. The policy indicates how this input entry affects the output APK. The client of this engine should use this information to determine how the removal of this input APK's JAR entry affects the output APK.

outputJarEntryRemoved

public void outputJarEntryRemoved(java.lang.String entryName)

Description copied from interface: ApkSignerEngine

Indicates to this engine that the specified JAR entry was removed from the output. It's safe to invoke this for entries for which ApkSignerEngine.outputJarEntry(String) hasn't been invoked.

Specified by:

outputJarEntryRemoved in interface ApkSignerEngine

outputJarEntries

public ApkSignerEngine.OutputJarSignatureRequest outputJarEntries()
                                                           throws ApkFormatException,
                                                                  java.security.InvalidKeyException,
                                                                  java.security.SignatureException,
                                                                  java.security.NoSuchAlgorithmException

Description copied from interface: ApkSignerEngine

Indicates to this engine that all JAR entries have been output.

Specified by:

outputJarEntries in interface ApkSignerEngine

Returns:

request to add JAR signature to the output or null if there is no need to add a JAR signature. The request will contain additional JAR entries to be output. The request must be fulfilled before ApkSignerEngine.outputZipSections2(DataSource, DataSource, DataSource) is invoked.

Throws:

ApkFormatException - if the APK is malformed in a way which is preventing this engine from producing a valid signature. For example, if the engine uses the provided META-INF/MANIFEST.MF as a template and the file is malformed.

java.security.InvalidKeyException - if a signature could not be generated because a signing key is not suitable for generating the signature

java.security.SignatureException - if an error occurred while generating a signature

java.security.NoSuchAlgorithmException - if a signature could not be generated because a required cryptographic algorithm implementation is missing

outputZipSections

@Deprecated
public ApkSignerEngine.OutputApkSigningBlockRequest outputZipSections(DataSource zipEntries,
                                                                                  DataSource zipCentralDirectory,
                                                                                  DataSource zipEocd)
                                                                           throws java.io.IOException,
                                                                                  java.security.InvalidKeyException,
                                                                                  java.security.SignatureException,
                                                                                  java.security.NoSuchAlgorithmException

Deprecated.

Description copied from interface: ApkSignerEngine

Indicates to this engine that the ZIP sections comprising the output APK have been output.

The provided data sources are guaranteed to not be used by the engine after this method terminates.

Specified by:

outputZipSections in interface ApkSignerEngine

Parameters:

zipEntries - the section of ZIP archive containing Local File Header records and data of the ZIP entries. In a well-formed archive, this section starts at the start of the archive and extends all the way to the ZIP Central Directory.

zipCentralDirectory - ZIP Central Directory section

zipEocd - ZIP End of Central Directory (EoCD) record

Returns:

request to add an APK Signing Block to the output or null if the output must not contain an APK Signing Block. The request must be fulfilled before ApkSignerEngine.outputDone() is invoked.

Throws:

java.io.IOException - if an I/O error occurs while reading the provided ZIP sections

java.security.InvalidKeyException - if a signature could not be generated because a signing key is not suitable for generating the signature

java.security.SignatureException - if an error occurred while generating a signature

java.security.NoSuchAlgorithmException - if a signature could not be generated because a required cryptographic algorithm implementation is missing

outputZipSections2

public ApkSignerEngine.OutputApkSigningBlockRequest2 outputZipSections2(DataSource zipEntries,
                                                                        DataSource zipCentralDirectory,
                                                                        DataSource zipEocd)
                                                                 throws java.io.IOException,
                                                                        java.security.InvalidKeyException,
                                                                        java.security.SignatureException,
                                                                        java.security.NoSuchAlgorithmException

Description copied from interface: ApkSignerEngine

Indicates to this engine that the ZIP sections comprising the output APK have been output.

The provided data sources are guaranteed to not be used by the engine after this method terminates.

Specified by:

outputZipSections2 in interface ApkSignerEngine

Parameters:

zipEntries - the section of ZIP archive containing Local File Header records and data of the ZIP entries. In a well-formed archive, this section starts at the start of the archive and extends all the way to the ZIP Central Directory.

zipCentralDirectory - ZIP Central Directory section

zipEocd - ZIP End of Central Directory (EoCD) record

Returns:

request to add an APK Signing Block to the output or null if the output must not contain an APK Signing Block. The request must be fulfilled before ApkSignerEngine.outputDone() is invoked.

Throws:

java.io.IOException - if an I/O error occurs while reading the provided ZIP sections

java.security.InvalidKeyException - if a signature could not be generated because a signing key is not suitable for generating the signature

java.security.SignatureException - if an error occurred while generating a signature

java.security.NoSuchAlgorithmException - if a signature could not be generated because a required cryptographic algorithm implementation is missing

outputDone

public void outputDone()

Description copied from interface: ApkSignerEngine

Indicates to this engine that the signed APK was output.

This does not change the output APK. The method helps the client confirm that the current output is signed.

Specified by:

outputDone in interface ApkSignerEngine

close

public void close()

Description copied from interface: ApkSignerEngine

Indicates to this engine that it will no longer be used. Invoking this on an already closed engine is OK.

This does not change the output APK. For example, if the output APK is not yet fully signed, it will remain so after this method terminates.

Specified by:

close in interface ApkSignerEngine

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable