com.android.apksig

Enum ApkVerifier.Issue

java.lang.Object

java.lang.Enum<ApkVerifier.Issue>

com.android.apksig.ApkVerifier.Issue

All Implemented Interfaces:

Serializable, Comparable<ApkVerifier.Issue>

Enclosing class:

ApkVerifier

public static enum ApkVerifier.Issue
extends Enum<ApkVerifier.Issue>

Error or warning encountered while verifying an APK's signatures.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APK_SIG_BLOCK_UNKNOWN_ENTRY_ID APK Signing Block contains an unknown entry.
JAR_SIG_DID_NOT_VERIFY JAR signature contained in a signature block file did not verify against the signature file.
JAR_SIG_DUPLICATE_MANIFEST_SECTION JAR manifest contains a section with a duplicate name.
JAR_SIG_DUPLICATE_SIG_FILE_SECTION JAR signature file contains a section with a duplicate name.
JAR_SIG_DUPLICATE_ZIP_ENTRY APK contains multiple entries with the same name.
JAR_SIG_MALFORMED_CERTIFICATE An exception was encountered while parsing a certificate contained in the JAR signature block.
JAR_SIG_MANIFEST_MAIN_SECTION_DIGEST_DID_NOT_VERIFY Digest of the JAR manifest main section did not verify.
JAR_SIG_MANIFEST_SECTION_DIGEST_DID_NOT_VERIFY Digest of the specified JAR manifest section does not match the digest expected by the JAR signature.
JAR_SIG_MISSING APK which is both JAR-signed and signed using APK Signature Scheme v2 contains an APK Signature Scheme v2 signature from this signer, but does not contain a JAR signature from this signer.
JAR_SIG_MISSING_APK_SIG_REFERENCED JAR signature file indicates that the APK is supposed to be signed with a supported APK signature scheme (in addition to the JAR signature) but no such signature was found in the APK.
JAR_SIG_MISSING_FILE JAR signature of the signer is missing a file/entry.
JAR_SIG_MISSING_VERSION_ATTR_IN_SIG_FILE JAR signature file's main section doesn't contain the mandatory Signature-Version attribute.
JAR_SIG_MISSING_ZIP_ENTRY_REFERENCED_IN_MANIFEST JAR manifest references an entry which is not there in the APK.
JAR_SIG_NO_APK_SIG_STRIP_PROTECTION APK is signed using APK Signature Scheme v2 or newer, but JAR signature file does not contain protections against stripping of these newer scheme signatures.
JAR_SIG_NO_MANIFEST APK is missing the JAR manifest entry (META-INF/MANIFEST.MF).
JAR_SIG_NO_MANIFEST_DIGEST_IN_SIG_FILE JAR signature file does not contain the whole-file digest of the JAR manifest file.
JAR_SIG_NO_SIGNATURES APK is not JAR-signed.
JAR_SIG_NO_SIGNED_ZIP_ENTRIES APK does not contain any entries covered by JAR signatures.
JAR_SIG_NO_SIGNERS JAR signature contains no verified signers.
JAR_SIG_NO_ZIP_ENTRY_DIGEST_IN_MANIFEST JAR manifest does not list a digest for the specified entry.
JAR_SIG_NO_ZIP_ENTRY_DIGEST_IN_SIG_FILE JAR signature does not list a digest for the specified entry.
JAR_SIG_PARSE_EXCEPTION An exception was encountered while parsing JAR signature contained in a signature block.
JAR_SIG_UNKNOWN_APK_SIG_SCHEME_ID JAR signature file references an unknown APK signature scheme ID.
JAR_SIG_UNNNAMED_MANIFEST_SECTION JAR manifest contains a section without a name.
JAR_SIG_UNNNAMED_SIG_FILE_SECTION JAR signature file contains a section without a name.
JAR_SIG_UNPROTECTED_ZIP_ENTRY JAR entry is not covered by signature and thus unauthorized modifications to its contents will not be detected.
JAR_SIG_UNSUPPORTED_SIG_ALG JAR signature contains unsupported digest algorithm.
JAR_SIG_VERIFY_EXCEPTION An exception was encountered while verifying JAR signature contained in a signature block against the signature file.
JAR_SIG_ZIP_ENTRY_DIGEST_DID_NOT_VERIFY Digest of the specified ZIP entry's data does not match the digest expected by the JAR signature.
JAR_SIG_ZIP_ENTRY_NOT_SIGNED The specified JAR entry is not covered by JAR signature.
JAR_SIG_ZIP_ENTRY_SIGNERS_MISMATCH JAR signature uses different set of signers to protect the two specified ZIP entries.
V2_SIG_APK_DIGEST_DID_NOT_VERIFY The APK's digest does not match the digest contained in the APK Signature Scheme v2 signature.
V2_SIG_DID_NOT_VERIFY APK Signature Scheme v2 signature over this signer's signed-data block did not verify.
V2_SIG_MALFORMED_ADDITIONAL_ATTRIBUTE This APK Signature Scheme v2 signer contains a malformed additional attribute.
V2_SIG_MALFORMED_CERTIFICATE This APK Signature Scheme v2 signer's certificate could not be parsed.
V2_SIG_MALFORMED_DIGEST Failed to parse this signer's digest record contained in the APK Signature Scheme v2 signature.
V2_SIG_MALFORMED_PUBLIC_KEY Public key embedded in the APK Signature Scheme v2 signature of this signer could not be parsed.
V2_SIG_MALFORMED_SIGNATURE Failed to parse this signer's signature record contained in the APK Signature Scheme v2 signature.
V2_SIG_MALFORMED_SIGNER Failed to parse this signer's signer block contained in the APK Signature Scheme v2 signature.
V2_SIG_MALFORMED_SIGNERS Failed to parse the list of signers contained in the APK Signature Scheme v2 signature.
V2_SIG_MISSING APK which is both JAR-signed and signed using APK Signature Scheme v2 contains a JAR signature from this signer, but does not contain an APK Signature Scheme v2 signature from this signer.
V2_SIG_NO_CERTIFICATES This APK Signature Scheme v2 signer offers no certificates.
V2_SIG_NO_SIGNATURES This APK Signature Scheme v2 signer offers no signatures.
V2_SIG_NO_SIGNERS APK Signature Scheme v2 signature contains no signers.
V2_SIG_NO_SUPPORTED_SIGNATURES This APK Signature Scheme v2 signer offers signatures but none of them are supported.
V2_SIG_PUBLIC_KEY_MISMATCH_BETWEEN_CERTIFICATE_AND_SIGNATURES_RECORD This APK Signature Scheme v2 signer's public key listed in the signer's certificate does not match the public key listed in the signatures record.
V2_SIG_SIG_ALG_MISMATCH_BETWEEN_SIGNATURES_AND_DIGESTS_RECORDS This APK Signature Scheme v2 signer's signature algorithms listed in the signatures record do not match the signature algorithms listed in the signatures record.
V2_SIG_UNKNOWN_ADDITIONAL_ATTRIBUTE This APK Signature Scheme v2 signer contains an unknown additional attribute.
V2_SIG_UNKNOWN_SIG_ALGORITHM This APK Signature Scheme v2 signer contains a signature produced using an unknown algorithm.
V2_SIG_VERIFY_EXCEPTION An exception was encountered while verifying APK Signature Scheme v2 signature of this signer.

Method Summary

Modifier and Type	Method and Description
static ApkVerifier.Issue	valueOf(String name) Returns the enum constant of this type with the specified name.
static ApkVerifier.Issue[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

JAR_SIG_NO_SIGNATURES

public static final ApkVerifier.Issue JAR_SIG_NO_SIGNATURES

APK is not JAR-signed.

JAR_SIG_NO_SIGNED_ZIP_ENTRIES

public static final ApkVerifier.Issue JAR_SIG_NO_SIGNED_ZIP_ENTRIES

APK does not contain any entries covered by JAR signatures.

JAR_SIG_DUPLICATE_ZIP_ENTRY

public static final ApkVerifier.Issue JAR_SIG_DUPLICATE_ZIP_ENTRY

APK contains multiple entries with the same name.

• Parameter 1: name (String)

JAR_SIG_DUPLICATE_MANIFEST_SECTION

public static final ApkVerifier.Issue JAR_SIG_DUPLICATE_MANIFEST_SECTION

JAR manifest contains a section with a duplicate name.

• Parameter 1: section name (String)

JAR_SIG_UNNNAMED_MANIFEST_SECTION

public static final ApkVerifier.Issue JAR_SIG_UNNNAMED_MANIFEST_SECTION

JAR manifest contains a section without a name.

• Parameter 1: section index (1-based) (Integer)

JAR_SIG_UNNNAMED_SIG_FILE_SECTION

public static final ApkVerifier.Issue JAR_SIG_UNNNAMED_SIG_FILE_SECTION

JAR signature file contains a section without a name.

• Parameter 1: signature file name (String)
• Parameter 2: section index (1-based) (Integer)

JAR_SIG_NO_MANIFEST

public static final ApkVerifier.Issue JAR_SIG_NO_MANIFEST

APK is missing the JAR manifest entry (META-INF/MANIFEST.MF).

JAR_SIG_MISSING_ZIP_ENTRY_REFERENCED_IN_MANIFEST

public static final ApkVerifier.Issue JAR_SIG_MISSING_ZIP_ENTRY_REFERENCED_IN_MANIFEST

JAR manifest references an entry which is not there in the APK.

• Parameter 1: entry name (String)

JAR_SIG_NO_ZIP_ENTRY_DIGEST_IN_MANIFEST

public static final ApkVerifier.Issue JAR_SIG_NO_ZIP_ENTRY_DIGEST_IN_MANIFEST

JAR manifest does not list a digest for the specified entry.

• Parameter 1: entry name (String)

JAR_SIG_NO_ZIP_ENTRY_DIGEST_IN_SIG_FILE

public static final ApkVerifier.Issue JAR_SIG_NO_ZIP_ENTRY_DIGEST_IN_SIG_FILE

JAR signature does not list a digest for the specified entry.

• Parameter 1: entry name (String)
• Parameter 2: signature file name (String)

JAR_SIG_ZIP_ENTRY_NOT_SIGNED

public static final ApkVerifier.Issue JAR_SIG_ZIP_ENTRY_NOT_SIGNED

The specified JAR entry is not covered by JAR signature.

• Parameter 1: entry name (String)

JAR_SIG_ZIP_ENTRY_SIGNERS_MISMATCH

public static final ApkVerifier.Issue JAR_SIG_ZIP_ENTRY_SIGNERS_MISMATCH

JAR signature uses different set of signers to protect the two specified ZIP entries.

• Parameter 1: first entry name (String)
• Parameter 2: first entry signer names (List<String>)
• Parameter 3: second entry name (String)
• Parameter 4: second entry signer names (List<String>)

JAR_SIG_ZIP_ENTRY_DIGEST_DID_NOT_VERIFY

public static final ApkVerifier.Issue JAR_SIG_ZIP_ENTRY_DIGEST_DID_NOT_VERIFY

Digest of the specified ZIP entry's data does not match the digest expected by the JAR signature.

• Parameter 1: entry name (String)
• Parameter 2: digest algorithm (e.g., SHA-256) (String)
• Parameter 3: name of the entry in which the expected digest is specified (String)
• Parameter 4: base64-encoded actual digest (String)
• Parameter 5: base64-encoded expected digest (String)

JAR_SIG_MANIFEST_MAIN_SECTION_DIGEST_DID_NOT_VERIFY

public static final ApkVerifier.Issue JAR_SIG_MANIFEST_MAIN_SECTION_DIGEST_DID_NOT_VERIFY

Digest of the JAR manifest main section did not verify.

• Parameter 1: digest algorithm (e.g., SHA-256) (String)
• Parameter 2: name of the entry in which the expected digest is specified (String)
• Parameter 3: base64-encoded actual digest (String)
• Parameter 4: base64-encoded expected digest (String)

JAR_SIG_MANIFEST_SECTION_DIGEST_DID_NOT_VERIFY

public static final ApkVerifier.Issue JAR_SIG_MANIFEST_SECTION_DIGEST_DID_NOT_VERIFY

Digest of the specified JAR manifest section does not match the digest expected by the JAR signature.

• Parameter 1: section name (String)
• Parameter 2: digest algorithm (e.g., SHA-256) (String)
• Parameter 3: name of the signature file in which the expected digest is specified (String)
• Parameter 4: base64-encoded actual digest (String)
• Parameter 5: base64-encoded expected digest (String)

JAR_SIG_NO_MANIFEST_DIGEST_IN_SIG_FILE

public static final ApkVerifier.Issue JAR_SIG_NO_MANIFEST_DIGEST_IN_SIG_FILE

JAR signature file does not contain the whole-file digest of the JAR manifest file. The digest speeds up verification of JAR signature.

• Parameter 1: name of the signature file (String)

JAR_SIG_NO_APK_SIG_STRIP_PROTECTION

public static final ApkVerifier.Issue JAR_SIG_NO_APK_SIG_STRIP_PROTECTION

APK is signed using APK Signature Scheme v2 or newer, but JAR signature file does not contain protections against stripping of these newer scheme signatures.

• Parameter 1: name of the signature file (String)

JAR_SIG_MISSING_FILE

public static final ApkVerifier.Issue JAR_SIG_MISSING_FILE

JAR signature of the signer is missing a file/entry.

• Parameter 1: name of the encountered file (String)
• Parameter 2: name of the missing file (String)

JAR_SIG_VERIFY_EXCEPTION

public static final ApkVerifier.Issue JAR_SIG_VERIFY_EXCEPTION

An exception was encountered while verifying JAR signature contained in a signature block against the signature file.

• Parameter 1: name of the signature block file (String)
• Parameter 2: name of the signature file (String)
• Parameter 3: exception (Throwable)

JAR_SIG_UNSUPPORTED_SIG_ALG

public static final ApkVerifier.Issue JAR_SIG_UNSUPPORTED_SIG_ALG

JAR signature contains unsupported digest algorithm.

• Parameter 1: name of the signature block file (String)
• Parameter 2: digest algorithm OID (String)
• Parameter 2: signature algorithm OID (String)
• Parameter 3: API Levels on which this combination of algorithms is not supported (String)

JAR_SIG_PARSE_EXCEPTION

public static final ApkVerifier.Issue JAR_SIG_PARSE_EXCEPTION

An exception was encountered while parsing JAR signature contained in a signature block.

• Parameter 1: name of the signature block file (String)
• Parameter 2: exception (Throwable)

JAR_SIG_MALFORMED_CERTIFICATE

public static final ApkVerifier.Issue JAR_SIG_MALFORMED_CERTIFICATE

An exception was encountered while parsing a certificate contained in the JAR signature block.

• Parameter 1: name of the signature block file (String)
• Parameter 2: exception (Throwable)

JAR_SIG_DID_NOT_VERIFY

public static final ApkVerifier.Issue JAR_SIG_DID_NOT_VERIFY

JAR signature contained in a signature block file did not verify against the signature file.

• Parameter 1: name of the signature block file (String)
• Parameter 2: name of the signature file (String)

JAR_SIG_NO_SIGNERS

public static final ApkVerifier.Issue JAR_SIG_NO_SIGNERS

JAR signature contains no verified signers.

• Parameter 1: name of the signature block file (String)

JAR_SIG_DUPLICATE_SIG_FILE_SECTION

public static final ApkVerifier.Issue JAR_SIG_DUPLICATE_SIG_FILE_SECTION

JAR signature file contains a section with a duplicate name.

• Parameter 1: signature file name (String)
• Parameter 1: section name (String)

JAR_SIG_MISSING_VERSION_ATTR_IN_SIG_FILE

public static final ApkVerifier.Issue JAR_SIG_MISSING_VERSION_ATTR_IN_SIG_FILE

JAR signature file's main section doesn't contain the mandatory Signature-Version attribute.

• Parameter 1: signature file name (String)

JAR_SIG_UNKNOWN_APK_SIG_SCHEME_ID

public static final ApkVerifier.Issue JAR_SIG_UNKNOWN_APK_SIG_SCHEME_ID

JAR signature file references an unknown APK signature scheme ID.

• Parameter 1: name of the signature file (String)
• Parameter 2: unknown APK signature scheme ID ( Integer)

JAR_SIG_MISSING_APK_SIG_REFERENCED

public static final ApkVerifier.Issue JAR_SIG_MISSING_APK_SIG_REFERENCED

JAR signature file indicates that the APK is supposed to be signed with a supported APK signature scheme (in addition to the JAR signature) but no such signature was found in the APK.

• Parameter 1: name of the signature file (String)
• Parameter 2: APK signature scheme ID ( Integer)
• Parameter 3: APK signature scheme English name ( String)

JAR_SIG_UNPROTECTED_ZIP_ENTRY

public static final ApkVerifier.Issue JAR_SIG_UNPROTECTED_ZIP_ENTRY

JAR entry is not covered by signature and thus unauthorized modifications to its contents will not be detected.

• Parameter 1: entry name (String)

JAR_SIG_MISSING

public static final ApkVerifier.Issue JAR_SIG_MISSING

APK which is both JAR-signed and signed using APK Signature Scheme v2 contains an APK Signature Scheme v2 signature from this signer, but does not contain a JAR signature from this signer.

V2_SIG_MISSING

public static final ApkVerifier.Issue V2_SIG_MISSING

APK which is both JAR-signed and signed using APK Signature Scheme v2 contains a JAR signature from this signer, but does not contain an APK Signature Scheme v2 signature from this signer.

V2_SIG_MALFORMED_SIGNERS

public static final ApkVerifier.Issue V2_SIG_MALFORMED_SIGNERS

Failed to parse the list of signers contained in the APK Signature Scheme v2 signature.

V2_SIG_MALFORMED_SIGNER

public static final ApkVerifier.Issue V2_SIG_MALFORMED_SIGNER

Failed to parse this signer's signer block contained in the APK Signature Scheme v2 signature.

V2_SIG_MALFORMED_PUBLIC_KEY

public static final ApkVerifier.Issue V2_SIG_MALFORMED_PUBLIC_KEY

Public key embedded in the APK Signature Scheme v2 signature of this signer could not be parsed.

• Parameter 1: error details (Throwable)

V2_SIG_MALFORMED_CERTIFICATE

public static final ApkVerifier.Issue V2_SIG_MALFORMED_CERTIFICATE

This APK Signature Scheme v2 signer's certificate could not be parsed.

• Parameter 1: index (0-based) of the certificate in the signer's list of certificates (Integer)
• Parameter 2: sequence number (1-based) of the certificate in the signer's list of certificates (Integer)
• Parameter 3: error details (Throwable)

V2_SIG_MALFORMED_SIGNATURE

public static final ApkVerifier.Issue V2_SIG_MALFORMED_SIGNATURE

Failed to parse this signer's signature record contained in the APK Signature Scheme v2 signature.

• Parameter 1: record number (first record is 1) (Integer)

V2_SIG_MALFORMED_DIGEST

public static final ApkVerifier.Issue V2_SIG_MALFORMED_DIGEST

Failed to parse this signer's digest record contained in the APK Signature Scheme v2 signature.

• Parameter 1: record number (first record is 1) (Integer)

V2_SIG_MALFORMED_ADDITIONAL_ATTRIBUTE

public static final ApkVerifier.Issue V2_SIG_MALFORMED_ADDITIONAL_ATTRIBUTE

This APK Signature Scheme v2 signer contains a malformed additional attribute.

• Parameter 1: attribute number (first attribute is 1) Integer)

V2_SIG_NO_SIGNERS

public static final ApkVerifier.Issue V2_SIG_NO_SIGNERS

APK Signature Scheme v2 signature contains no signers.

V2_SIG_UNKNOWN_SIG_ALGORITHM

public static final ApkVerifier.Issue V2_SIG_UNKNOWN_SIG_ALGORITHM

This APK Signature Scheme v2 signer contains a signature produced using an unknown algorithm.

• Parameter 1: algorithm ID (Integer)

V2_SIG_UNKNOWN_ADDITIONAL_ATTRIBUTE

public static final ApkVerifier.Issue V2_SIG_UNKNOWN_ADDITIONAL_ATTRIBUTE

This APK Signature Scheme v2 signer contains an unknown additional attribute.

• Parameter 1: attribute ID (Integer)

V2_SIG_VERIFY_EXCEPTION

public static final ApkVerifier.Issue V2_SIG_VERIFY_EXCEPTION

An exception was encountered while verifying APK Signature Scheme v2 signature of this signer.

• Parameter 1: signature algorithm (SignatureAlgorithm)
• Parameter 2: exception (Throwable)

V2_SIG_DID_NOT_VERIFY

public static final ApkVerifier.Issue V2_SIG_DID_NOT_VERIFY

APK Signature Scheme v2 signature over this signer's signed-data block did not verify.

• Parameter 1: signature algorithm (SignatureAlgorithm)

V2_SIG_NO_SIGNATURES

public static final ApkVerifier.Issue V2_SIG_NO_SIGNATURES

This APK Signature Scheme v2 signer offers no signatures.

V2_SIG_NO_SUPPORTED_SIGNATURES

public static final ApkVerifier.Issue V2_SIG_NO_SUPPORTED_SIGNATURES

This APK Signature Scheme v2 signer offers signatures but none of them are supported.

V2_SIG_NO_CERTIFICATES

public static final ApkVerifier.Issue V2_SIG_NO_CERTIFICATES

This APK Signature Scheme v2 signer offers no certificates.

V2_SIG_PUBLIC_KEY_MISMATCH_BETWEEN_CERTIFICATE_AND_SIGNATURES_RECORD

public static final ApkVerifier.Issue V2_SIG_PUBLIC_KEY_MISMATCH_BETWEEN_CERTIFICATE_AND_SIGNATURES_RECORD

This APK Signature Scheme v2 signer's public key listed in the signer's certificate does not match the public key listed in the signatures record.

• Parameter 1: hex-encoded public key from certificate (String)
• Parameter 2: hex-encoded public key from signatures record (String)

V2_SIG_SIG_ALG_MISMATCH_BETWEEN_SIGNATURES_AND_DIGESTS_RECORDS

public static final ApkVerifier.Issue V2_SIG_SIG_ALG_MISMATCH_BETWEEN_SIGNATURES_AND_DIGESTS_RECORDS

This APK Signature Scheme v2 signer's signature algorithms listed in the signatures record do not match the signature algorithms listed in the signatures record.

• Parameter 1: signature algorithms from signatures record (List<Integer>)
• Parameter 2: signature algorithms from digests record (List<Integer>)

V2_SIG_APK_DIGEST_DID_NOT_VERIFY

public static final ApkVerifier.Issue V2_SIG_APK_DIGEST_DID_NOT_VERIFY

The APK's digest does not match the digest contained in the APK Signature Scheme v2 signature.

• Parameter 1: content digest algorithm (ContentDigestAlgorithm)
• Parameter 2: hex-encoded expected digest of the APK (String)
• Parameter 3: hex-encoded actual digest of the APK (String)

APK_SIG_BLOCK_UNKNOWN_ENTRY_ID

public static final ApkVerifier.Issue APK_SIG_BLOCK_UNKNOWN_ENTRY_ID

APK Signing Block contains an unknown entry.

• Parameter 1: entry ID (Integer)

Method Detail

values

public static ApkVerifier.Issue[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ApkVerifier.Issue c : ApkVerifier.Issue.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ApkVerifier.Issue valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null