Index (platform/tools/apksig 0.3 API)

A B C D F G I J M O R S T V Z

A

ApkFormatException - Exception in com.android.apksig.apk: Indicates that an APK is not well-formed.
ApkFormatException(String) - Constructor for exception com.android.apksig.apk.ApkFormatException
ApkFormatException(String, Throwable) - Constructor for exception com.android.apksig.apk.ApkFormatException
ApkSigner - Class in com.android.apksig: APK signer.
ApkSigner.Builder - Class in com.android.apksig: Builder of ApkSigner instances.
ApkSigner.SignerConfig - Class in com.android.apksig: Configuration of a signer.
ApkSigner.SignerConfig.Builder - Class in com.android.apksig: Builder of ApkSigner.SignerConfig instances.
ApkSignerEngine - Interface in com.android.apksig: APK signing logic which is independent of how input and output APKs are stored, parsed, and generated.
ApkSignerEngine.InputJarEntryInstructions - Class in com.android.apksig: Instructions about how to handle an input APK's JAR entry.
ApkSignerEngine.InputJarEntryInstructions.OutputPolicy - Enum in com.android.apksig: Output policy for an input APK's JAR entry.
ApkSignerEngine.InspectJarEntryRequest - Interface in com.android.apksig: Request to inspect the specified JAR entry.
ApkSignerEngine.OutputApkSigningBlockRequest - Interface in com.android.apksig: Request to add the specified APK Signing Block to the output APK.
ApkSignerEngine.OutputJarSignatureRequest - Interface in com.android.apksig: Request to add JAR signature (aka v1 signature) to the output APK.
ApkSignerEngine.OutputJarSignatureRequest.JarEntry - Class in com.android.apksig: JAR entry.
ApkUtils - Class in com.android.apksig.apk: APK utilities.
ApkUtils.ZipSections - Class in com.android.apksig.apk: Information about the ZIP sections of an APK.
ApkVerifier - Class in com.android.apksig: APK signature verifier which mimics the behavior of the Android platform.
ApkVerifier.Builder - Class in com.android.apksig: Builder of ApkVerifier instances.
ApkVerifier.Issue - Enum in com.android.apksig: Error or warning encountered while verifying an APK's signatures.
ApkVerifier.IssueWithParams - Class in com.android.apksig: ApkVerifier.Issue with associated parameters.
ApkVerifier.Result - Class in com.android.apksig: Result of verifying an APKs signatures.
ApkVerifier.Result.V1SchemeSignerInfo - Class in com.android.apksig: Information about a JAR signer associated with the APK's signature.
ApkVerifier.Result.V2SchemeSignerInfo - Class in com.android.apksig: Information about an APK Signature Scheme v2 signer associated with the APK's signature.
asDataSink(OutputStream) - Static method in class com.android.apksig.util.DataSinks: Returns a DataSink which outputs received data into the provided OutputStream.
asDataSink(RandomAccessFile) - Static method in class com.android.apksig.util.DataSinks: Returns a DataSink which outputs received data into the provided file, sequentially, starting at the beginning of the file.
asDataSource(ByteBuffer) - Static method in class com.android.apksig.util.DataSources: Returns a DataSource backed by the provided ByteBuffer.
asDataSource(RandomAccessFile) - Static method in class com.android.apksig.util.DataSources: Returns a DataSource backed by the provided RandomAccessFile.
asDataSource(RandomAccessFile, long, long) - Static method in class com.android.apksig.util.DataSources: Returns a DataSource backed by the provided region of the RandomAccessFile.

B

build() - Method in class com.android.apksig.ApkSigner.Builder: Returns a new ApkSigner instance initialized according to the configuration of this builder.
build() - Method in class com.android.apksig.ApkSigner.SignerConfig.Builder: Returns a new SignerConfig instance configured based on the configuration of this builder.
build() - Method in class com.android.apksig.ApkVerifier.Builder: Returns an ApkVerifier initialized according to the configuration of this builder.
build() - Method in class com.android.apksig.DefaultApkSignerEngine.Builder: Returns a new DefaultApkSignerEngine instance configured based on the configuration of this builder.
build() - Method in class com.android.apksig.DefaultApkSignerEngine.SignerConfig.Builder: Returns a new SignerConfig instance configured based on the configuration of this builder.
Builder(List<ApkSigner.SignerConfig>) - Constructor for class com.android.apksig.ApkSigner.Builder: Constructs a new Builder for an ApkSigner which signs using the provided signer configurations.
Builder(ApkSignerEngine) - Constructor for class com.android.apksig.ApkSigner.Builder: Constructs a new Builder for an ApkSigner which signs using the provided signing engine.
Builder(String, PrivateKey, List<X509Certificate>) - Constructor for class com.android.apksig.ApkSigner.SignerConfig.Builder: Constructs a new Builder.
Builder(File) - Constructor for class com.android.apksig.ApkVerifier.Builder: Constructs a new Builder for verifying the provided APK file.
Builder(DataSource) - Constructor for class com.android.apksig.ApkVerifier.Builder: Constructs a new Builder for verifying the provided APK.
Builder(List<DefaultApkSignerEngine.SignerConfig>, int) - Constructor for class com.android.apksig.DefaultApkSignerEngine.Builder: Constructs a new Builder.
Builder(String, PrivateKey, List<X509Certificate>) - Constructor for class com.android.apksig.DefaultApkSignerEngine.SignerConfig.Builder: Constructs a new Builder.

C

close() - Method in interface com.android.apksig.ApkSignerEngine: Indicates to this engine that it will no longer be used.
close() - Method in class com.android.apksig.DefaultApkSignerEngine
CodenameMinSdkVersionException - Exception in com.android.apksig.apk: Indicates that there was an issue determining the minimum Android platform version supported by an APK because the version is specified as a codename rather than as API Level number.
CodenameMinSdkVersionException(String, String) - Constructor for exception com.android.apksig.apk.CodenameMinSdkVersionException: Constructs a new MinSdkVersionCodenameException with the provided message and codename.
com.android.apksig - package com.android.apksig
com.android.apksig.apk - package com.android.apksig.apk
com.android.apksig.util - package com.android.apksig.util
com.android.apksig.zip - package com.android.apksig.zip
consume(byte[], int, int) - Method in interface com.android.apksig.util.DataSink: Consumes the provided chunk of data.
consume(ByteBuffer) - Method in interface com.android.apksig.util.DataSink: Consumes all remaining data in the provided buffer and advances the buffer's position to the buffer's limit.
containsErrors() - Method in class com.android.apksig.ApkVerifier.Result: Returns true if an error was encountered while verifying the APK.
containsErrors() - Method in class com.android.apksig.ApkVerifier.Result.V1SchemeSignerInfo: Returns true if an error was encountered while verifying this signer's JAR signature.
containsErrors() - Method in class com.android.apksig.ApkVerifier.Result.V2SchemeSignerInfo
copyTo(long, int, ByteBuffer) - Method in interface com.android.apksig.util.DataSource: Copies the specified chunk from this data source into the provided destination buffer, advancing the destination buffer's position by size.

D

DataSink - Interface in com.android.apksig.util: Consumer of input data which may be provided in one go or in chunks.
DataSinks - Class in com.android.apksig.util: Utility methods for working with DataSink abstraction.
DataSource - Interface in com.android.apksig.util: Abstract representation of a source of data.
DataSources - Class in com.android.apksig.util: Utility methods for working with DataSource abstraction.
DefaultApkSignerEngine - Class in com.android.apksig: Default implementation of ApkSignerEngine.
DefaultApkSignerEngine.Builder - Class in com.android.apksig: Builder of DefaultApkSignerEngine instances.
DefaultApkSignerEngine.SignerConfig - Class in com.android.apksig: Configuration of a signer.
DefaultApkSignerEngine.SignerConfig.Builder - Class in com.android.apksig: Builder of DefaultApkSignerEngine.SignerConfig instances.
done() - Method in interface com.android.apksig.ApkSignerEngine.InspectJarEntryRequest: Indicates that entry's data has been provided in full.
done() - Method in interface com.android.apksig.ApkSignerEngine.OutputApkSigningBlockRequest: Indicates that the APK Signing Block was output as requested.
done() - Method in interface com.android.apksig.ApkSignerEngine.OutputJarSignatureRequest: Indicates that the JAR entries contained in this request were added to the output APK.

F

feed(long, long, DataSink) - Method in interface com.android.apksig.util.DataSource: Feeds the specified chunk from this data source into the provided sink.
findZipSections(DataSource) - Static method in class com.android.apksig.apk.ApkUtils: Finds the main ZIP sections of the provided APK.

G

getAdditionalJarEntries() - Method in interface com.android.apksig.ApkSignerEngine.OutputJarSignatureRequest: Returns JAR entries that must be added to the output APK.
getApkSigningBlock() - Method in interface com.android.apksig.ApkSignerEngine.OutputApkSigningBlockRequest: Returns the APK Signing Block.
getByteBuffer(long, int) - Method in interface com.android.apksig.util.DataSource: Returns a buffer holding the contents of the specified chunk of data from this data source.
getCertificate() - Method in class com.android.apksig.ApkVerifier.Result.V1SchemeSignerInfo: Returns this signer's signing certificate or null if not available.
getCertificate() - Method in class com.android.apksig.ApkVerifier.Result.V2SchemeSignerInfo: Returns this signer's signing certificate or null if not available.
getCertificateChain() - Method in class com.android.apksig.ApkVerifier.Result.V1SchemeSignerInfo: Returns the certificate chain for the signer's public key.
getCertificates() - Method in class com.android.apksig.ApkSigner.SignerConfig: Returns the certificate(s) of this signer.
getCertificates() - Method in class com.android.apksig.ApkVerifier.Result.V2SchemeSignerInfo: Returns this signer's certificates.
getCertificates() - Method in class com.android.apksig.DefaultApkSignerEngine.SignerConfig: Returns the certificate(s) of this signer.
getCodename() - Method in exception com.android.apksig.apk.CodenameMinSdkVersionException: Returns the codename.
getData() - Method in class com.android.apksig.ApkSignerEngine.OutputJarSignatureRequest.JarEntry: Returns the uncompressed data of this JAR entry.
getDataSink() - Method in interface com.android.apksig.ApkSignerEngine.InspectJarEntryRequest: Returns the data sink into which the entry's uncompressed data should be sent.
getEntryName() - Method in interface com.android.apksig.ApkSignerEngine.InspectJarEntryRequest: Returns the name of the JAR entry.
getErrors() - Method in class com.android.apksig.ApkVerifier.Result: Returns errors encountered while verifying the APK's signatures.
getErrors() - Method in class com.android.apksig.ApkVerifier.Result.V1SchemeSignerInfo: Returns errors encountered while verifying this signer's JAR signature.
getErrors() - Method in class com.android.apksig.ApkVerifier.Result.V2SchemeSignerInfo
getIndex() - Method in class com.android.apksig.ApkVerifier.Result.V2SchemeSignerInfo: Returns this signer's 0-based index in the list of signers contained in the APK's APK Signature Scheme v2 signature.
getInspectJarEntryRequest() - Method in class com.android.apksig.ApkSignerEngine.InputJarEntryInstructions: Returns the request to inspect the JAR entry or null if there is no need to inspect the entry.
getIssue() - Method in class com.android.apksig.ApkVerifier.IssueWithParams: Returns the type of this issue.
getMinSdkVersionFromBinaryAndroidManifest(ByteBuffer) - Static method in class com.android.apksig.apk.ApkUtils: Returns the lowest Android platform version (API Level) supported by an APK with the provided AndroidManifest.xml.
getName() - Method in class com.android.apksig.ApkSigner.SignerConfig: Returns the name of this signer.
getName() - Method in class com.android.apksig.ApkSignerEngine.OutputJarSignatureRequest.JarEntry: Returns the name of this ZIP entry.
getName() - Method in class com.android.apksig.ApkVerifier.Result.V1SchemeSignerInfo: Returns a user-friendly name of the signer.
getName() - Method in class com.android.apksig.DefaultApkSignerEngine.SignerConfig: Returns the name of this signer.
getOutputPolicy() - Method in class com.android.apksig.ApkSignerEngine.InputJarEntryInstructions: Returns the output policy for this entry.
getParams() - Method in class com.android.apksig.ApkVerifier.IssueWithParams: Returns the parameters of this issue.
getPrivateKey() - Method in class com.android.apksig.ApkSigner.SignerConfig: Returns the signing key of this signer.
getPrivateKey() - Method in class com.android.apksig.DefaultApkSignerEngine.SignerConfig: Returns the signing key of this signer.
getSignatureBlockFileName() - Method in class com.android.apksig.ApkVerifier.Result.V1SchemeSignerInfo: Returns the name of the JAR entry containing this signer's JAR signature block file.
getSignatureFileName() - Method in class com.android.apksig.ApkVerifier.Result.V1SchemeSignerInfo: Returns the name of the JAR entry containing this signer's JAR signature file.
getSignerCertificates() - Method in class com.android.apksig.ApkVerifier.Result: Returns the verified signers' certificates, one per signer.
getV1SchemeIgnoredSigners() - Method in class com.android.apksig.ApkVerifier.Result: Returns information about JAR signers ignored by the APK's signature verification process.
getV1SchemeSigners() - Method in class com.android.apksig.ApkVerifier.Result: Returns information about JAR signers associated with the APK's signature.
getV2SchemeSigners() - Method in class com.android.apksig.ApkVerifier.Result: Returns information about APK Signature Scheme v2 signers associated with the APK's signature.
getWarnings() - Method in class com.android.apksig.ApkVerifier.Result: Returns warnings encountered while verifying the APK's signatures.
getWarnings() - Method in class com.android.apksig.ApkVerifier.Result.V1SchemeSignerInfo: Returns warnings encountered while verifying this signer's JAR signature.
getWarnings() - Method in class com.android.apksig.ApkVerifier.Result.V2SchemeSignerInfo
getZipCentralDirectoryOffset() - Method in class com.android.apksig.apk.ApkUtils.ZipSections: Returns the start offset of the ZIP Central Directory.
getZipCentralDirectoryRecordCount() - Method in class com.android.apksig.apk.ApkUtils.ZipSections: Returns the number of records in the ZIP Central Directory.
getZipCentralDirectorySizeBytes() - Method in class com.android.apksig.apk.ApkUtils.ZipSections: Returns the size (in bytes) of the ZIP Central Directory.
getZipEndOfCentralDirectory() - Method in class com.android.apksig.apk.ApkUtils.ZipSections: Returns the contents of the ZIP End of Central Directory.
getZipEndOfCentralDirectoryOffset() - Method in class com.android.apksig.apk.ApkUtils.ZipSections: Returns the start offset of the ZIP End of Central Directory record.

I

inputApkSigningBlock(DataSource) - Method in interface com.android.apksig.ApkSignerEngine: Indicates to this engine that the input APK contains the provided APK Signing Block.
inputApkSigningBlock(DataSource) - Method in class com.android.apksig.DefaultApkSignerEngine
inputJarEntry(String) - Method in interface com.android.apksig.ApkSignerEngine: Indicates to this engine that the specified JAR entry was encountered in the input APK.
inputJarEntry(String) - Method in class com.android.apksig.DefaultApkSignerEngine
InputJarEntryInstructions(ApkSignerEngine.InputJarEntryInstructions.OutputPolicy) - Constructor for class com.android.apksig.ApkSignerEngine.InputJarEntryInstructions: Constructs a new InputJarEntryInstructions instance with the provided entry output policy and without a request to inspect the entry.
InputJarEntryInstructions(ApkSignerEngine.InputJarEntryInstructions.OutputPolicy, ApkSignerEngine.InspectJarEntryRequest) - Constructor for class com.android.apksig.ApkSignerEngine.InputJarEntryInstructions: Constructs a new InputJarEntryInstructions instance with the provided entry output mode and with the provided request to inspect the entry.
inputJarEntryRemoved(String) - Method in interface com.android.apksig.ApkSignerEngine: Indicates to this engine that the specified JAR entry was removed from the input.
inputJarEntryRemoved(String) - Method in class com.android.apksig.DefaultApkSignerEngine
IssueWithParams(ApkVerifier.Issue, Object[]) - Constructor for class com.android.apksig.ApkVerifier.IssueWithParams: Constructs a new IssueWithParams of the specified type and with provided parameters.
isVerified() - Method in class com.android.apksig.ApkVerifier.Result: Returns true if the APK's signatures verified.
isVerifiedUsingV1Scheme() - Method in class com.android.apksig.ApkVerifier.Result: Returns true if the APK's JAR signatures verified.
isVerifiedUsingV2Scheme() - Method in class com.android.apksig.ApkVerifier.Result: Returns true if the APK's APK Signature Scheme v2 signatures verified.

J

JarEntry(String, byte[]) - Constructor for class com.android.apksig.ApkSignerEngine.OutputJarSignatureRequest.JarEntry: Constructs a new JarEntry with the provided name and data.

M

MinSdkVersionException - Exception in com.android.apksig.apk: Indicates that there was an issue determining the minimum Android platform version supported by an APK.
MinSdkVersionException(String) - Constructor for exception com.android.apksig.apk.MinSdkVersionException: Constructs a new MinSdkVersionException with the provided message.
MinSdkVersionException(String, Throwable) - Constructor for exception com.android.apksig.apk.MinSdkVersionException: Constructs a new MinSdkVersionException with the provided message and cause.

O

outputDone() - Method in interface com.android.apksig.ApkSignerEngine: Indicates to this engine that the signed APK was output.
outputDone() - Method in class com.android.apksig.DefaultApkSignerEngine
outputJarEntries() - Method in interface com.android.apksig.ApkSignerEngine: Indicates to this engine that all JAR entries have been output.
outputJarEntries() - Method in class com.android.apksig.DefaultApkSignerEngine
outputJarEntry(String) - Method in interface com.android.apksig.ApkSignerEngine: Indicates to this engine that the specified JAR entry was output.
outputJarEntry(String) - Method in class com.android.apksig.DefaultApkSignerEngine
outputJarEntryRemoved(String) - Method in interface com.android.apksig.ApkSignerEngine: Indicates to this engine that the specified JAR entry was removed from the output.
outputJarEntryRemoved(String) - Method in class com.android.apksig.DefaultApkSignerEngine
outputZipSections(DataSource, DataSource, DataSource) - Method in interface com.android.apksig.ApkSignerEngine: Indicates to this engine that the ZIP sections comprising the output APK have been output.
outputZipSections(DataSource, DataSource, DataSource) - Method in class com.android.apksig.DefaultApkSignerEngine

R

Result() - Constructor for class com.android.apksig.ApkVerifier.Result

S

setCreatedBy(String) - Method in class com.android.apksig.ApkSigner.Builder: Sets the value of the Created-By field in JAR signature files.
setCreatedBy(String) - Method in class com.android.apksig.DefaultApkSignerEngine.Builder: Sets the value of the Created-By field in JAR signature files.
setInputApk(File) - Method in class com.android.apksig.ApkSigner.Builder: Sets the APK to be signed.
setInputApk(DataSource) - Method in class com.android.apksig.ApkSigner.Builder: Sets the APK to be signed.
setMaxCheckedPlatformVersion(int) - Method in class com.android.apksig.ApkVerifier.Builder: Sets the newest Android platform version for which the APK is verified.
setMinCheckedPlatformVersion(int) - Method in class com.android.apksig.ApkVerifier.Builder: Sets the oldest Android platform version for which the APK is verified.
setMinSdkVersion(int) - Method in class com.android.apksig.ApkSigner.Builder: Sets the minimum Android platform version (API Level) on which APK signatures produced by the signer being built must verify.
setOtherSignersSignaturesPreserved(boolean) - Method in class com.android.apksig.ApkSigner.Builder: Sets whether signatures produced by signers other than the ones configured in this engine should be copied from the input APK to the output APK.
setOtherSignersSignaturesPreserved(boolean) - Method in class com.android.apksig.DefaultApkSignerEngine.Builder: Sets whether signatures produced by signers other than the ones configured in this engine should be copied from the input APK to the output APK.
setOutputApk(File) - Method in class com.android.apksig.ApkSigner.Builder: Sets the location of the output (signed) APK.
setOutputApk(DataSink, DataSource) - Method in class com.android.apksig.ApkSigner.Builder: Sets the sink which will receive the output (signed) APK.
setV1SigningEnabled(boolean) - Method in class com.android.apksig.ApkSigner.Builder: Sets whether the APK should be signed using JAR signing (aka v1 signature scheme).
setV1SigningEnabled(boolean) - Method in class com.android.apksig.DefaultApkSignerEngine.Builder: Sets whether the APK should be signed using JAR signing (aka v1 signature scheme).
setV2SigningEnabled(boolean) - Method in class com.android.apksig.ApkSigner.Builder: Sets whether the APK should be signed using APK Signature Scheme v2 (aka v2 signature scheme).
setV2SigningEnabled(boolean) - Method in class com.android.apksig.DefaultApkSignerEngine.Builder: Sets whether the APK should be signed using APK Signature Scheme v2 (aka v2 signature scheme).
setZipEocdCentralDirectoryOffset(ByteBuffer, long) - Static method in class com.android.apksig.apk.ApkUtils: Sets the offset of the start of the ZIP Central Directory in the APK's ZIP End of Central Directory record.
sign() - Method in class com.android.apksig.ApkSigner: Signs the input APK and outputs the resulting signed APK.
size() - Method in interface com.android.apksig.util.DataSource: Returns the amount of data (in bytes) contained in this data source.
slice(long, long) - Method in interface com.android.apksig.util.DataSource: Returns a data source representing the specified region of data of this data source.

T

toString() - Method in class com.android.apksig.ApkVerifier.IssueWithParams: Returns a readable form of this issue.

V

valueOf(String) - Static method in enum com.android.apksig.ApkSignerEngine.InputJarEntryInstructions.OutputPolicy: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.android.apksig.ApkVerifier.Issue: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.android.apksig.ApkSignerEngine.InputJarEntryInstructions.OutputPolicy: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.android.apksig.ApkVerifier.Issue: Returns an array containing the constants of this enum type, in the order they are declared.
verify() - Method in class com.android.apksig.ApkVerifier: Verifies the APK's signatures and returns the result of verification.

Z

ZipFormatException - Exception in com.android.apksig.zip: Indicates that a ZIP archive is not well-formed.
ZipFormatException(String) - Constructor for exception com.android.apksig.zip.ZipFormatException
ZipFormatException(String, Throwable) - Constructor for exception com.android.apksig.zip.ZipFormatException
ZipSections(long, long, int, long, ByteBuffer) - Constructor for class com.android.apksig.apk.ApkUtils.ZipSections

A B C D F G I J M O R S T V Z