com.android.apksig.apk

Class ApkUtils

java.lang.Object

com.android.apksig.apk.ApkUtils

public abstract class ApkUtils
extends java.lang.Object

APK utilities.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApkUtils.ApkSigningBlock Information about the location of the APK Signing Block inside an APK.
static class	ApkUtils.ZipSections Information about the ZIP sections of an APK.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANDROID_MANIFEST_ZIP_ENTRY_NAME Name of the Android manifest ZIP entry in APKs.

Method Summary

Modifier and Type	Method and Description
static ApkUtils.ApkSigningBlock	findApkSigningBlock(DataSource apk, ApkUtils.ZipSections zipSections) Returns the APK Signing Block of the provided APK.
static ApkUtils.ZipSections	findZipSections(DataSource apk) Finds the main ZIP sections of the provided APK.
static java.nio.ByteBuffer	getAndroidManifest(DataSource apk) Returns the contents of the APK's AndroidManifest.xml.
static boolean	getDebuggableFromBinaryAndroidManifest(java.nio.ByteBuffer androidManifestContents) Returns true if the APK is debuggable according to its AndroidManifest.xml.
static int	getMinSdkVersionFromBinaryAndroidManifest(java.nio.ByteBuffer androidManifestContents) Returns the lowest Android platform version (API Level) supported by an APK with the provided AndroidManifest.xml.
static java.lang.String	getPackageNameFromBinaryAndroidManifest(java.nio.ByteBuffer androidManifestContents) Returns the package name of the APK according to its AndroidManifest.xml or null if package name is not declared.
static void	setZipEocdCentralDirectoryOffset(java.nio.ByteBuffer zipEndOfCentralDirectory, long offset) Sets the offset of the start of the ZIP Central Directory in the APK's ZIP End of Central Directory record.

Methods inherited from class java.lang.Object

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

Field Detail

ANDROID_MANIFEST_ZIP_ENTRY_NAME

public static final java.lang.String ANDROID_MANIFEST_ZIP_ENTRY_NAME

Name of the Android manifest ZIP entry in APKs.

See Also:

Constant Field Values

Method Detail

findZipSections

public static ApkUtils.ZipSections findZipSections(DataSource apk)
                                            throws java.io.IOException,
                                                   ZipFormatException

Finds the main ZIP sections of the provided APK.

Throws:

java.io.IOException - if an I/O error occurred while reading the APK

ZipFormatException - if the APK is malformed

setZipEocdCentralDirectoryOffset

public static void setZipEocdCentralDirectoryOffset(java.nio.ByteBuffer zipEndOfCentralDirectory,
                                                    long offset)

Sets the offset of the start of the ZIP Central Directory in the APK's ZIP End of Central Directory record.

Parameters:

zipEndOfCentralDirectory - APK's ZIP End of Central Directory record

offset - offset of the ZIP Central Directory relative to the start of the archive. Must be between 0 and 2^32 - 1 inclusive.

findApkSigningBlock

public static ApkUtils.ApkSigningBlock findApkSigningBlock(DataSource apk,
                                                           ApkUtils.ZipSections zipSections)
                                                    throws java.io.IOException,
                                                           ApkSigningBlockNotFoundException

Returns the APK Signing Block of the provided APK.

Throws:

java.io.IOException - if an I/O error occurs

ApkSigningBlockNotFoundException - if there is no APK Signing Block in the APK

See Also:

APK Signature Scheme v2

getAndroidManifest

public static java.nio.ByteBuffer getAndroidManifest(DataSource apk)
                                              throws java.io.IOException,
                                                     ApkFormatException

Returns the contents of the APK's AndroidManifest.xml.

Throws:

java.io.IOException - if an I/O error occurs while reading the APK

ApkFormatException - if the APK is malformed

getMinSdkVersionFromBinaryAndroidManifest

public static int getMinSdkVersionFromBinaryAndroidManifest(java.nio.ByteBuffer androidManifestContents)
                                                     throws MinSdkVersionException

Returns the lowest Android platform version (API Level) supported by an APK with the provided AndroidManifest.xml.

Parameters:

androidManifestContents - contents of AndroidManifest.xml in binary Android resource format

Throws:

MinSdkVersionException - if an error occurred while determining the API Level

getDebuggableFromBinaryAndroidManifest

public static boolean getDebuggableFromBinaryAndroidManifest(java.nio.ByteBuffer androidManifestContents)
                                                      throws ApkFormatException

Returns true if the APK is debuggable according to its AndroidManifest.xml. See the android:debuggable attribute of the application element.

Parameters:

androidManifestContents - contents of AndroidManifest.xml in binary Android resource format

Throws:

ApkFormatException - if the manifest is malformed

getPackageNameFromBinaryAndroidManifest

public static java.lang.String getPackageNameFromBinaryAndroidManifest(java.nio.ByteBuffer androidManifestContents)
                                                                throws ApkFormatException

Returns the package name of the APK according to its AndroidManifest.xml or null if package name is not declared. See the package attribute of the manifest element.

Parameters:

androidManifestContents - contents of AndroidManifest.xml in binary Android resource format

Throws:

ApkFormatException - if the manifest is malformed