Python¶

Utilities¶

lief.is_oat(*args) → bool¶

lief.is_oat(path: str) → bool

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

Overloaded function.

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

Check if the Binary given in parameter is an OAT

2. is_oat(path: str) -> bool

Check if the file given in parameter is an OAT

3. 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.

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

Return the OAT version of the Binary given in parameter

2. version(file: str) -> int

Return the OAT version of the file given in parameter

3. 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

lief.OAT.parse(obj: io.IOBase | os.PathLike) → lief._lief.OAT.Binary | None

Overloaded function.

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

Parse the given OAT file and return a Binary object

2. 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

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

Parse the given raw data and return a Binary object

4. parse(obj: Union[io.IOBase | os.PathLike]) -> 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(*args) → lief.OAT.Class¶

Overloaded function.

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

Return the Class from its name

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

Return the Class from its index

has_class(self, arg: str) → bool¶

Check if the class if the given name is present in the current OAT binary

property header → lief.OAT.Header¶

Return the OAT Header

class it_classes¶

Bases: object

Iterator over lief._lief.OAT.Class

class it_dex_files¶

Bases: object

Iterator over lief._lief.DEX.File

class it_methods¶

Bases: object

Iterator over lief._lief.OAT.Method

class it_oat_dex_files¶

Bases: object

Iterator over lief._lief.OAT.DexFile

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.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

class it_key_values_t¶

Bases: object

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 registred 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.OAT.HEADER_KEYS, value: str) → 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¶

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(*args) → bool¶

Overloaded function.

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

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

2. is_quickened(self, method_index: int) -> bool

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

class it_methods¶

Bases: object

Iterator over lief._lief.OAT.Method

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¶

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¶

Class associated with the method (or None)

property quick_code → list[int]¶

Quick code associated with the method

Enums¶