Python¶

Utilities¶

lief.is_oat(*args) → bool¶

lief.is_oat(path: str) → bool

lief.is_oat(raw: collections.abc.Sequence[int]) → bool

Overloaded function.

is_oat(binary: lief._lief.ELF.Binary) -> bool

Check if the Binary given in parameter is an OAT

is_oat(path: str) -> bool

Check if the file given in parameter is an OAT

is_oat(raw: collections.abc.Sequence[int]) -> bool

Check if the raw data given in parameter is an OAT

lief.OAT.version(*args) → int¶

lief.OAT.version(file: str) → int

lief.OAT.version(raw: collections.abc.Sequence[int]) → int

Overloaded function.

version(binary: lief._lief.ELF.Binary) -> int

Return the OAT version of the Binary given in parameter

version(file: str) -> int

Return the OAT version of the file given in parameter

version(raw: collections.abc.Sequence[int]) -> int

Return the OAT version of the raw data given in parameter

lief.OAT.android_version(arg: int) → lief.Android.ANDROID_VERSIONS¶: Return the ANDROID_VERSIONS associated with the given OAT version

Parser¶

lief.OAT.parse(*args) → lief.OAT.Binary | None¶

lief.OAT.parse(oat_file: str, vdex_file: str) → lief._lief.OAT.Binary | None

lief.OAT.parse(raw: collections.abc.Sequence[int]) → lief._lief.OAT.Binary | None

Overloaded function.

parse(oat_file: str) -> Optional[lief._lief.OAT.Binary]

Parse the given OAT file and return a Binary object

parse(oat_file: str, vdex_file: str) -> Optional[lief._lief.OAT.Binary]

Parse the given OAT with its VDEX file and return a Binary object

parse(raw: collections.abc.Sequence[int]) -> Optional[lief._lief.OAT.Binary]

Parse the given raw data and return a Binary object

parse(obj: Union[str | io.IOBase | os.PathLike | bytes | list[int]]) -> Optional[lief._lief.OAT.Binary]

Binary¶

class lief.OAT.Binary¶

Bases: Binary

OAT binary representation

property classes → lief.OAT.Binary.it_classes¶: Return an iterator over Class

property dex2dex_json_info → str¶

property dex_files → lief.OAT.Binary.it_dex_files¶: Return an iterator over File

get_class(self, class_name: str) → lief._lief.OAT.Class | None¶

get_class(self, class_index: int) → lief._lief.OAT.Class | None

Overloaded function.

get_class(self, class_name: str) -> lief._lief.OAT.Class | None

Return the Class from its name

get_class(self, class_index: int) -> lief._lief.OAT.Class | None

Return the Class from its index

has_class(self, arg: str, /) → bool¶: Check if the class with the given name is present in the current OAT binary

property header → lief.OAT.Header¶: Return the OAT Header

property methods → lief.OAT.Binary.it_methods¶: Return an iterator over Method

property oat_dex_files → lief.OAT.Binary.it_oat_dex_files¶: Return an iterator over DexFile

Header¶

class lief.OAT.Header(self)¶

Bases: Object

OAT Header representation

property checksum → int¶: Checksum of the OAT file

class element_t¶

Bases: object

property key → lief.OAT.HEADER_KEYS¶

property value → str¶

property executable_offset → int¶

get(self, key: lief._lief.OAT.HEADER_KEYS) → str¶

property i2c_code_bridge_offset → int¶

property i2i_bridge_offset → int¶

property image_file_location_oat_checksum → int¶

property image_file_location_oat_data_begin → int¶

property image_patch_delta → int¶

property instruction_set → lief.OAT.INSTRUCTION_SETS¶: List of INSTRUCTION_SETS

property jni_dlsym_lookup_offset → int¶

property key_value_size → int¶

property key_values → lief.OAT.Header.it_key_values_t¶: Configuration used for the dex2oat transformation

property keys → list[lief.OAT.HEADER_KEYS]¶: List of HEADER_KEYS present

property magic → list[int]¶: Magic number which shoud be oat\x0A

property nb_dex_files → int¶: Number of lief.DEX.File registered in the current OAT

property oat_dex_files_offset → int¶: Offset to the raw lief.OAT.Dexfile

Warning
This attribute is only relevant for OAT for which the version is above 131

property quick_generic_jni_trampoline_offset → int¶

property quick_imt_conflict_trampoline_offset → int¶

property quick_resolution_trampoline_offset → int¶

property quick_to_interpreter_bridge_offset → int¶

set(self, key: lief._lief.OAT.HEADER_KEYS, value: str) → lief._lief.OAT.Header¶

property values → list[str]¶: List of values associated with keys

property version → int¶: Underlying version of the OAT file

DexFile¶

class lief.OAT.DexFile(self)¶

Bases: Object

OAT DexFile representation

property checksum → int¶: Checksum of the underlying DEX file

property dex_file → lief.DEX.File | None¶: Associated lief.DEX.File

property dex_offset → int¶: Offset to the raw lief.DEX.File

property has_dex_file → bool¶: Check if the lief.DEX.File is present

property location → str¶: Original location of the DEX file

Class¶

class lief.OAT.Class(self)¶

Bases: Object

OAT Class representation

property bitmap → list[int]¶: Bitmap information used to quickly find which methods are optimized

property fullname → str¶: Class mangled name (e.g. Lcom/android/MyActivity;)

has_dex_class(self) → bool¶: True if a lief.DEX.Class object is associated with this OAT Class

property index → int¶: Index the DEX classes pool (lief.DEX.File.classes)

is_quickened(self, dex_method: lief._lief.DEX.Method) → bool¶

is_quickened(self, method_index: int) → bool

Overloaded function.

is_quickened(self, dex_method: lief._lief.DEX.Method) -> bool

Check if the given lief.DEX.Method is compiled into native code

is_quickened(self, method_index: int) -> bool

Check if the Method at the given index is compiled into native code

method_offsets_index(self, arg: lief._lief.DEX.Method, /) → int¶
method_offsets_index(self, arg: int, /) → int

property methods → lief.OAT.Class.it_methods¶: Iterator over lief.OAT.Method

property status → lief.OAT.OAT_CLASS_STATUS¶: Class OAT_CLASS_STATUS

property type → lief.OAT.OAT_CLASS_TYPES¶: Information (OAT_CLASS_TYPES) about how methods are optimized

Method¶

class lief.OAT.Method(self)¶

Bases: Object

OAT Method representation

property dex_method → lief.DEX.Method | None¶: Mirrored Method associated with the OAT method (or None)

property has_dex_method → bool¶: Check if a Method is associated with the OAT method

property is_compiled → bool¶: True if the optimization is native

property is_dex2dex_optimized → bool¶: True if the optimization is DEX

property name → str¶: Method’s name

property oat_class → lief.OAT.Class | None¶: Class associated with the method (or None)

property quick_code → list[int]¶: Quick code associated with the method

Enums¶

OAT Class types¶

class lief.OAT.OAT_CLASS_TYPES(*values)¶

Bases: Enum

ALL_COMPILED = 0¶

NONE_COMPILED = 2¶

SOME_COMPILED = 1¶

OAT Class Status¶

class lief.OAT.OAT_CLASS_STATUS(*values)¶

Bases: Enum

ERROR = -1¶

IDX = 1¶

INITIALIZED = 10¶

INITIALIZING = 9¶

LOADED = 2¶

NOTREADY = 0¶

RESOLVED = 4¶

RESOLVING = 3¶

RETIRED = -2¶

VERIFICATION_AT_RUNTIME = 6¶

VERIFIED = 8¶

VERIFYING = 5¶

VERIFYING_AT_RUNTIME = 7¶

Header Keys¶

class lief.OAT.HEADER_KEYS(*values)¶

Bases: Enum

BOOT_CLASS_PATH = 9¶

CLASS_PATH = 8¶

COMPILER_FILTER = 7¶

CONCURRENT_COPYING = 10¶

DEBUGGABLE = 5¶

DEX2OAT_CMD_LINE = 1¶

DEX2OAT_HOST = 2¶

HAS_PATCH_INFO = 4¶

IMAGE_LOCATION = 0¶

NATIVE_DEBUGGABLE = 6¶

PIC = 3¶

Instruction sets¶

class lief.OAT.INSTRUCTION_SETS(*values)¶

Bases: Enum

ARM = 1¶

ARM_64 = 2¶

MIPS = 6¶

MIPS_64 = 7¶

NONE = 0¶

THUMB2 = 3¶

X86 = 4¶

X86_64 = 5¶