Package sootup.apk.frontend

Class ApkAnalysisInputLocation

java.lang.Object

sootup.apk.frontend.ApkAnalysisInputLocation

All Implemented Interfaces:

AnalysisInputLocation

public class ApkAnalysisInputLocation
extends Object
implements AnalysisInputLocation

Analysis input location for Android APK files.

This class provides an entry point for analyzing Android APK files by extracting and processing DEX (Dalvik Executable) files contained within the APK.

Constructor Summary

Constructors

Constructor	Description
ApkAnalysisInputLocation(Path apkPath, AndroidVersionInfo androidSDKVersionInfo, List<BodyInterceptor> bodyInterceptors)	Creates a new ApkAnalysisInputLocation.

Method Summary

Modifier and Type	Method	Description
@NonNull List<BodyInterceptor>	getBodyInterceptors()
@NonNull Optional<? extends SootClassSource>	getClassSource(@NonNull ClassType type, @NonNull View view)	Create or find a class source for a given type.
@NonNull Stream<? extends SootClassSource>	getClassSources(@NonNull View view)	Scan the input location and create ClassSources for every compilation / interpretation unit.
@NonNull SourceType	getSourceType()	If the AnalysisInputLocation is initialized with the SourceType then this method should return that specific SourceType.

Methods inherited from class java.lang.Object

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

Constructor Details

ApkAnalysisInputLocation

public ApkAnalysisInputLocation(Path apkPath,
 AndroidVersionInfo androidSDKVersionInfo,
 List<BodyInterceptor> bodyInterceptors)

Creates a new ApkAnalysisInputLocation.

Parameters:

apkPath - the path to the APK file to analyze system libraries (android.jar files) for different API levels. This directory is required to resolve method calls and class references that are not defined in the APK itself, but are part of the Android system libraries. The Android platforms directory can be obtained from https://github.com/Sable/android-platforms

bodyInterceptors - the list of body interceptors to apply during analysis

Method Details

getClassSource

public @NonNull Optional<? extends SootClassSource> getClassSource(@NonNull ClassType type,
 @NonNull View view)

Description copied from interface: AnalysisInputLocation

Create or find a class source for a given type.

Specified by:

getClassSource in interface AnalysisInputLocation

Parameters:

type - The type of the class to be found.

Returns:

The source entry for that class.

getClassSources

public @NonNull Stream<? extends SootClassSource> getClassSources(@NonNull View view)

Description copied from interface: AnalysisInputLocation

Scan the input location and create ClassSources for every compilation / interpretation unit.

Specified by:

getClassSources in interface AnalysisInputLocation

Returns:

an Autocloseable resource that must be closed!

getSourceType

public @NonNull SourceType getSourceType()

Description copied from interface: AnalysisInputLocation

If the AnalysisInputLocation is initialized with the SourceType then this method should return that specific SourceType. This is the default implementation and it returns null when no source type is specified.

Specified by:

getSourceType in interface AnalysisInputLocation

Returns:

returns null as source type

getBodyInterceptors

public @NonNull List<BodyInterceptor> getBodyInterceptors()

Specified by:

getBodyInterceptors in interface AnalysisInputLocation