Skip navigation links
A B C D E F G H I J M N O P R S T U V W Z 

A

ANDROID_MANIFEST_ZIP_ENTRY_NAME - Static variable in class com.android.apksig.apk.ApkUtils
Name of the Android manifest ZIP entry in APKs.
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
Deprecated.
ApkSignerEngine.OutputApkSigningBlockRequest2 - 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.
ApkSigningBlock(long, DataSource) - Constructor for class com.android.apksig.apk.ApkUtils.ApkSigningBlock
Constructs a new ApkSigningBlock.
ApkSigningBlockNotFoundException - Exception in com.android.apksig.apk
Indicates that no APK Signing Block was found in an APK.
ApkSigningBlockNotFoundException(String) - Constructor for exception com.android.apksig.apk.ApkSigningBlockNotFoundException
 
ApkSigningBlockNotFoundException(String, Throwable) - Constructor for exception com.android.apksig.apk.ApkSigningBlockNotFoundException
 
ApkUtils - Class in com.android.apksig.apk
APK utilities.
ApkUtils.ApkSigningBlock - Class in com.android.apksig.apk
Information about the location of the APK Signing Block inside an APK.
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.
ApkVerifier.Result.V3SchemeSignerInfo - Class in com.android.apksig
Information about an APK Signature Scheme v3 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.
asDataSink(MessageDigest...) - Static method in class com.android.apksig.util.DataSinks
Returns a DataSink which forwards data into the provided MessageDigest instances via their update method.
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.
build() - Method in class com.android.apksig.SigningCertificateLineage.Builder
 
build() - Method in class com.android.apksig.SigningCertificateLineage.SignerCapabilities.Builder
Returns a new SignerConfig instance configured based on the configuration of this builder.
build() - Method in class com.android.apksig.SigningCertificateLineage.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.
Builder(SigningCertificateLineage.SignerConfig, SigningCertificateLineage.SignerConfig) - Constructor for class com.android.apksig.SigningCertificateLineage.Builder
Constructs a new Builder.
Builder() - Constructor for class com.android.apksig.SigningCertificateLineage.SignerCapabilities.Builder
Constructs a new Builder.
Builder(int) - Constructor for class com.android.apksig.SigningCertificateLineage.SignerCapabilities.Builder
Constructs a new Builder with the initial capabilities set to the provided flags.
Builder(PrivateKey, X509Certificate) - Constructor for class com.android.apksig.SigningCertificateLineage.SignerConfig.Builder
Constructs a new Builder.
ByteRange(long, long) - Constructor for class com.android.apksig.Hints.ByteRange
 

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, and the codename is in an unexpected format.
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
 
consolidateLineages(List<SigningCertificateLineage>) - Static method in class com.android.apksig.SigningCertificateLineage
Consolidates all of the lineages found in an APK into one lineage, which is the longest one.
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
 
containsErrors() - Method in class com.android.apksig.ApkVerifier.Result.V3SchemeSignerInfo
 
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.
createRunnable() - Method in interface com.android.apksig.util.RunnablesProvider
 

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
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
Deprecated.
Indicates that the APK Signing Block was output as requested.
done() - Method in interface com.android.apksig.ApkSignerEngine.OutputApkSigningBlockRequest2
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.

E

encodeByteRangeList(List<Hints.ByteRange>) - Static method in class com.android.apksig.Hints
Create a blob of bytes that PinnerService understands as a sequence of byte ranges to pin.
equals(SigningCertificateLineage.SignerCapabilities) - Method in class com.android.apksig.SigningCertificateLineage.SignerCapabilities
Returns true if the capabilities of this object match those of the provided object.
execute(RunnablesProvider) - Method in interface com.android.apksig.util.RunnablesExecutor
 

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.
findApkSigningBlock(DataSource, ApkUtils.ZipSections) - Static method in class com.android.apksig.apk.ApkUtils
Returns the APK Signing Block of the provided APK.
findZipSections(DataSource) - Static method in class com.android.apksig.apk.ApkUtils
Finds the main ZIP sections of the provided APK.

G

generateV3SignerAttribute() - Method in class com.android.apksig.SigningCertificateLineage
 
getAdditionalJarEntries() - Method in interface com.android.apksig.ApkSignerEngine.OutputJarSignatureRequest
Returns JAR entries that must be added to the output APK.
getAndroidManifest(DataSource) - Static method in class com.android.apksig.apk.ApkUtils
Returns the contents of the APK's AndroidManifest.xml.
getApkSigningBlock() - Method in interface com.android.apksig.ApkSignerEngine.OutputApkSigningBlockRequest
Deprecated.
Returns the APK Signing Block.
getApkSigningBlock() - Method in interface com.android.apksig.ApkSignerEngine.OutputApkSigningBlockRequest2
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.
getCertificate() - Method in class com.android.apksig.ApkVerifier.Result.V3SchemeSignerInfo
Returns this signer's signing certificate or null if not available.
getCertificate() - Method in class com.android.apksig.SigningCertificateLineage.SignerConfig
Returns the certificate(s) of this signer.
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.ApkVerifier.Result.V3SchemeSignerInfo
Returns this signer's certificates.
getCertificates() - Method in class com.android.apksig.DefaultApkSignerEngine.SignerConfig
Returns the certificate(s) of this signer.
getCertificatesInLineage() - Method in class com.android.apksig.SigningCertificateLineage
Returns a list containing all of the certificates in the lineage.
getCodename() - Method in exception com.android.apksig.apk.CodenameMinSdkVersionException
Returns the codename.
getContents() - Method in class com.android.apksig.apk.ApkUtils.ApkSigningBlock
Returns the data source which provides the full contents of the APK Signing Block, including its footer.
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.
getDebuggableFromBinaryAndroidManifest(ByteBuffer) - Static method in class com.android.apksig.apk.ApkUtils
Returns true if the APK is debuggable according to its AndroidManifest.xml.
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
 
getErrors() - Method in class com.android.apksig.ApkVerifier.Result.V3SchemeSignerInfo
 
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.
getIndex() - Method in class com.android.apksig.ApkVerifier.Result.V3SchemeSignerInfo
Returns this signer's 0-based index in the list of signers contained in the APK's APK Signature Scheme v3 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.
getPackageNameFromBinaryAndroidManifest(ByteBuffer) - Static method in class com.android.apksig.apk.ApkUtils
Returns the package name of the APK according to its AndroidManifest.xml or null if package name is not declared.
getPaddingSizeBeforeApkSigningBlock() - Method in interface com.android.apksig.ApkSignerEngine.OutputApkSigningBlockRequest2
Returns the number of 0x00 bytes the caller must place immediately before APK Signing Block.
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.
getPrivateKey() - Method in class com.android.apksig.SigningCertificateLineage.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.
getSignerCapabilities(SigningCertificateLineage.SignerConfig) - Method in class com.android.apksig.SigningCertificateLineage
Returns the SignerCapabilities for the signer in the lineage that matches the provided config.
getSignerCapabilities(X509Certificate) - Method in class com.android.apksig.SigningCertificateLineage
Returns the SignerCapabilities for the signer in the lineage that matches the provided certificate.
getSignerCertificates() - Method in class com.android.apksig.ApkVerifier.Result
Returns the verified signers' certificates, one per signer.
getSigningCertificateLineage() - Method in class com.android.apksig.ApkVerifier.Result
Returns the combined SigningCertificateLineage associated with this APK's APK Signature Scheme v3 signing block.
getStartOffset() - Method in class com.android.apksig.apk.ApkUtils.ApkSigningBlock
Returns the start offset (in bytes, relative to start of file) of the APK Signing Block.
getSubLineage(X509Certificate) - Method in class com.android.apksig.SigningCertificateLineage
Returns a new SigingCertificateLineage which terminates at the node corresponding to the given certificate.
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.
getV3SchemeSigners() - Method in class com.android.apksig.ApkVerifier.Result
Returns information about APK Signature Scheme v3 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
 
getWarnings() - Method in class com.android.apksig.ApkVerifier.Result.V3SchemeSignerInfo
 
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.

H

hasAuth() - Method in class com.android.apksig.SigningCertificateLineage.SignerCapabilities
Returns true if this object has the auth capability.
hasInstalledData() - Method in class com.android.apksig.SigningCertificateLineage.SignerCapabilities
Returns true if this object has the installed data capability.
hasPermission() - Method in class com.android.apksig.SigningCertificateLineage.SignerCapabilities
Returns true if this object has the permission capability.
hasRollback() - Method in class com.android.apksig.SigningCertificateLineage.SignerCapabilities
Returns true if this object has the rollback capability.
hasSharedUid() - Method in class com.android.apksig.SigningCertificateLineage.SignerCapabilities
Returns true if this object has the shared UID capability.
Hints - Class in com.android.apksig
 
Hints() - Constructor for class com.android.apksig.Hints
 
Hints.ByteRange - Class in com.android.apksig
 

I

initWith(byte[], Set<String>) - Method in interface com.android.apksig.ApkSignerEngine
Initializes the signer engine with the data already present in the apk (if any).
initWith(byte[], Set<String>) - Method in class com.android.apksig.DefaultApkSignerEngine
Initializes DefaultApkSignerEngine with the existing MANIFEST.MF.
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
 
isCertificateInLineage(X509Certificate) - Method in class com.android.apksig.SigningCertificateLineage
Returns true if the specified certificate is in the lineage.
isSignerInLineage(SigningCertificateLineage.SignerConfig) - Method in class com.android.apksig.SigningCertificateLineage
Returns true if the specified config is in the lineage.
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.
isVerifiedUsingV3Scheme() - Method in class com.android.apksig.ApkVerifier.Result
Returns true if the APK's APK Signature Scheme v3 signature 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

MAGIC - Static variable in class com.android.apksig.SigningCertificateLineage
 
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.

N

newInMemoryDataSink() - Static method in class com.android.apksig.util.DataSinks
Returns a new in-memory DataSink which exposes all data consumed so far via the DataSource interface.
newInMemoryDataSink(int) - Static method in class com.android.apksig.util.DataSinks
Returns a new in-memory DataSink which exposes all data consumed so far via the DataSource interface.

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
outputZipSections(DataSource, DataSource, DataSource) - Method in class com.android.apksig.DefaultApkSignerEngine
Deprecated.
outputZipSections2(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.
outputZipSections2(DataSource, DataSource, DataSource) - Method in class com.android.apksig.DefaultApkSignerEngine
 

P

parsePinPatterns(byte[]) - Static method in class com.android.apksig.Hints
 
PIN_BYTE_RANGE_ZIP_ENTRY_NAME - Static variable in class com.android.apksig.Hints
Name of hint byte range data file in APK.
PIN_HINT_ASSET_ZIP_ENTRY_NAME - Static variable in class com.android.apksig.Hints
Name of hint pattern asset file in APK.

R

ReadableDataSink - Interface in com.android.apksig.util
DataSink which exposes all data consumed so far as a DataSource.
readFromApkDataSource(DataSource) - Static method in class com.android.apksig.SigningCertificateLineage
Extracts a Signing Certificate Lineage from the proof-of-rotation attribute in the V3 signature block of the provided APK DataSource.
readFromApkFile(File) - Static method in class com.android.apksig.SigningCertificateLineage
Extracts a Signing Certificate Lineage from the proof-of-rotation attribute in the V3 signature block of the provided APK File.
readFromDataSource(DataSource) - Static method in class com.android.apksig.SigningCertificateLineage
 
readFromFile(File) - Static method in class com.android.apksig.SigningCertificateLineage
 
readFromSignedData(ByteBuffer) - Static method in class com.android.apksig.SigningCertificateLineage
Extracts a Signing Certificate Lineage from the proof-of-rotation attribute in the provided signed data portion of a signer in a V3 signature block.
readFromV3AttributeValue(byte[]) - Static method in class com.android.apksig.SigningCertificateLineage
Extracts a Signing Certificate Lineage from a v3 signer proof-of-rotation attribute.
Result() - Constructor for class com.android.apksig.ApkVerifier.Result
 
RunnablesExecutor - Interface in com.android.apksig.util
 
RunnablesProvider - Interface in com.android.apksig.util
 

S

setAuth(boolean) - Method in class com.android.apksig.SigningCertificateLineage.SignerCapabilities.Builder
Set the PAST_CERT_AUTH flag in this capabilities object.
setCallerConfiguredCapabilities(SigningCertificateLineage.SignerCapabilities) - Method in class com.android.apksig.SigningCertificateLineage.SignerCapabilities.Builder
Applies the capabilities that were explicitly set in the provided capabilities object to this builder.
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.
setDebuggableApkPermitted(boolean) - Method in class com.android.apksig.ApkSigner.Builder
Sets whether the APK should be signed even if it is marked as debuggable (android:debuggable="true" in its AndroidManifest.xml).
setDebuggableApkPermitted(boolean) - Method in class com.android.apksig.DefaultApkSignerEngine.Builder
Sets whether the APK should be signed even if it is marked as debuggable (android:debuggable="true" in its AndroidManifest.xml).
setExecutor(RunnablesExecutor) - Method in interface com.android.apksig.ApkSignerEngine
 
setExecutor(RunnablesExecutor) - Method in class com.android.apksig.DefaultApkSignerEngine
 
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.
setInstalledData(boolean) - Method in class com.android.apksig.SigningCertificateLineage.SignerCapabilities.Builder
Set the PAST_CERT_INSTALLED_DATA flag in this capabilities object.
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.
setMinSdkVersion(int) - Method in class com.android.apksig.SigningCertificateLineage.Builder
Sets the minimum Android platform version (API Level) on which this lineage is expected to validate.
setNewCapabilities(SigningCertificateLineage.SignerCapabilities) - Method in class com.android.apksig.SigningCertificateLineage.Builder
Sets capabilities to give mNewSignerConfig.
setOriginalCapabilities(SigningCertificateLineage.SignerCapabilities) - Method in class com.android.apksig.SigningCertificateLineage.Builder
Sets capabilities to give mOriginalSignerConfig.
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(ReadableDataSink) - Method in class com.android.apksig.ApkSigner.Builder
Sets the readable data sink which will receive 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.
setPermission(boolean) - Method in class com.android.apksig.SigningCertificateLineage.SignerCapabilities.Builder
Set the PAST_CERT_PERMISSION flag in this capabilities object.
setRollback(boolean) - Method in class com.android.apksig.SigningCertificateLineage.SignerCapabilities.Builder
Set the PAST_CERT_ROLLBACK flag in this capabilities object.
setSharedUid(boolean) - Method in class com.android.apksig.SigningCertificateLineage.SignerCapabilities.Builder
Set the PAST_CERT_SHARED_USER_ID flag in this capabilities object.
setSigningCertificateLineage(SigningCertificateLineage) - Method in class com.android.apksig.ApkSigner.Builder
Sets the SigningCertificateLineage to use with the v3 signature scheme.
setSigningCertificateLineage(SigningCertificateLineage) - Method in class com.android.apksig.DefaultApkSignerEngine.Builder
Sets the SigningCertificateLineage to use with the v3 signature scheme.
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).
setV3SigningEnabled(boolean) - Method in class com.android.apksig.ApkSigner.Builder
Sets whether the APK should be signed using APK Signature Scheme v3 (aka v3 signature scheme).
setV3SigningEnabled(boolean) - Method in class com.android.apksig.DefaultApkSignerEngine.Builder
Sets whether the APK should be signed using APK Signature Scheme v3 (aka v3 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.
SigningCertificateLineage - Class in com.android.apksig
APK Signer Lineage.
SigningCertificateLineage.Builder - Class in com.android.apksig
Builder of SigningCertificateLineage instances.
SigningCertificateLineage.SignerCapabilities - Class in com.android.apksig
Representation of the capabilities the APK would like to grant to its old signing certificates.
SigningCertificateLineage.SignerCapabilities.Builder - Class in com.android.apksig
SigningCertificateLineage.SignerConfig - Class in com.android.apksig
Configuration of a signer.
SigningCertificateLineage.SignerConfig.Builder - Class in com.android.apksig
SINGLE_THREADED - Static variable in interface com.android.apksig.util.RunnablesExecutor
 
size() - Method in class com.android.apksig.SigningCertificateLineage
The number of signing certificates in the lineage, including the current signer, which means this value can also be used to V2determine the number of signing certificate rotations by subtracting 1.
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.
sortSignerConfigs(List<DefaultApkSignerEngine.SignerConfig>) - Method in class com.android.apksig.SigningCertificateLineage
 
spawnDescendant(SigningCertificateLineage.SignerConfig, SigningCertificateLineage.SignerConfig) - Method in class com.android.apksig.SigningCertificateLineage
Add a new signing certificate to the lineage.
spawnDescendant(SigningCertificateLineage.SignerConfig, SigningCertificateLineage.SignerConfig, SigningCertificateLineage.SignerCapabilities) - Method in class com.android.apksig.SigningCertificateLineage
Add a new signing certificate to the lineage.

T

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

U

updateSignerCapabilities(SigningCertificateLineage.SignerConfig, SigningCertificateLineage.SignerCapabilities) - Method in class com.android.apksig.SigningCertificateLineage
Updates the SignerCapabilities for the signer in the lineage that matches the provided config.

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.

W

writeToDataSink(DataSink) - Method in class com.android.apksig.SigningCertificateLineage
 
writeToFile(File) - Method in class com.android.apksig.SigningCertificateLineage
 

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 E F G H I J M N O P R S T U V W Z 
Skip navigation links