Clean and tidy up various functions

Author: elicn

qiling/utils.py

@@ -7,9 +7,10 @@
 This module is intended for general purpose functions that can be used
 thoughout the qiling framework
 """
-import importlib, os, copy, re, pefile, configparser, logging, sys
+import importlib, os, copy, re, pefile, logging, sys
+from configparser import ConfigParser
 from logging import LogRecord
-from typing import Any, Container, Optional, Mapping, Sequence, Tuple, Type
+from typing import Any, Container, Optional, Sequence, Tuple, Type
 from enum import Enum
 
 from unicorn import UC_ERR_READ_UNMAPPED, UC_ERR_FETCH_UNMAPPED
@@ -187,9 +188,7 @@ def ql_is_valid_arch(arch: QL_ARCH) -> bool:
     return arch in enum_values(QL_ARCH)
 
 def loadertype_convert_str(ostype: QL_OS) -> Optional[str]:
-    adapter = {}
-    adapter.update(loader_map)
-    return adapter.get(ostype)
+    return loader_map.get(ostype)
 
 def __value_to_key(e: Type[Enum], val: Any) -> Optional[str]:
     key = e._value2member_map_[val]
@@ -210,14 +209,9 @@ def arch_convert_str(arch: QL_ARCH) -> Optional[str]:
 
 def arch_convert(arch: str) -> Optional[QL_ARCH]:
     return arch_map.get(arch)
-    
-def arch_os_convert(arch):
-    adapter = {}
-    adapter.update(arch_os_map)
-    if arch in adapter:
-        return adapter[arch]
-    # invalid
-    return None
+
+def arch_os_convert(arch: QL_ARCH) -> Optional[QL_OS]:
+    return arch_os_map.get(arch)
 
 def debugger_convert(debugger: str) -> Optional[QL_DEBUGGER]:
     return debugger_map.get(debugger)
@@ -244,19 +238,13 @@ def ql_get_module_function(module_name: str, function_name: str):
     return module_function
 
 def ql_elf_parse_emu_env(path: str) -> Tuple[Optional[QL_ARCH], Optional[QL_OS], Optional[QL_ENDIAN]]:
-    def getident():
-        return elfdata
-
     with open(path, "rb") as f:
         size = os.fstat(f.fileno()).st_size
-        if size >= 512:
-            elfdata = f.read(512)
-        else:
-            elfdata = f.read(20)
 
-    ident = getident()
-    ostype = None
+        ident = f.read(512 if size >= 512 else 20)
+
     arch = None
+    ostype = None
     archendian = None
 
     if ident[:4] == b'\x7fELF':
@@ -276,65 +264,60 @@ def getident():
         if e_machine == b"\x03\x00":
             archendian = QL_ENDIAN.EL
             arch = QL_ARCH.X86
+
         elif e_machine == b"\x08\x00" and endian == 1 and elfbit == 1:
             archendian = QL_ENDIAN.EL
             arch = QL_ARCH.MIPS
+
         elif e_machine == b"\x00\x08" and endian == 2 and elfbit == 1:
             archendian = QL_ENDIAN.EB
             arch = QL_ARCH.MIPS
+
         elif e_machine == b"\x28\x00" and endian == 1 and elfbit == 1:
             archendian = QL_ENDIAN.EL
             arch = QL_ARCH.ARM
+
         elif e_machine == b"\x00\x28" and endian == 2 and elfbit == 1:
             archendian = QL_ENDIAN.EB
             arch = QL_ARCH.ARM
+
         elif e_machine == b"\xB7\x00":
             archendian = QL_ENDIAN.EL
             arch = QL_ARCH.ARM64
+
         elif e_machine == b"\x3E\x00":
             archendian = QL_ENDIAN.EL
             arch = QL_ARCH.X8664
-        else:
-            arch = None
 
     return arch, ostype, archendian
 
 def ql_macho_parse_emu_env(path: str) -> Tuple[Optional[QL_ARCH], Optional[QL_OS], Optional[QL_ENDIAN]]:
-   
-    def getident():
-        return machodata
-
-    with open(path, "rb") as f:
-        machodata = f.read(32)
-
-    ident = getident()
-
     macho_macos_sig64 = b'\xcf\xfa\xed\xfe'
     macho_macos_sig32 = b'\xce\xfa\xed\xfe'
     macho_macos_fat = b'\xca\xfe\xba\xbe'  # should be header for FAT
 
-    ostype = None
     arch = None
-    archendian = None
+    ostype = None
+    endian = None
 
-    if ident[: 4] in (macho_macos_sig32, macho_macos_sig64, macho_macos_fat):
+    with open(path, 'rb') as f:
+        ident = f.read(32)
+
+    if ident[:4] in (macho_macos_sig32, macho_macos_sig64, macho_macos_fat):
         ostype = QL_OS.MACOS
-    else:
-        ostype = None
 
-    if ostype:
-        # if ident[0x7] == 0: # 32 bit
+        # if ident[7] == 0: # 32 bit
         #    arch = QL_ARCH.X86
-        if ident[0x4] == 7 and ident[0x7] == 1:  # X86 64 bit
-            archendian = QL_ENDIAN.EL
+
+        if ident[4] == 0x07 and ident[7] == 0x01:  # X86 64 bit
+            endian = QL_ENDIAN.EL
             arch = QL_ARCH.X8664
-        elif ident[0x4] == 12 and ident[0x7] == 1:  # ARM64  ident[0x4] = 0x0C
-            archendian = QL_ENDIAN.EL
+
+        elif ident[4] == 0x0c and ident[7] == 0x01:  # ARM64
+            endian = QL_ENDIAN.EL
             arch = QL_ARCH.ARM64
-        else:
-            arch = None
 
-    return arch, ostype, archendian
+    return arch, ostype, endian
 
 
 def ql_pe_parse_emu_env(path: str) -> Tuple[Optional[QL_ARCH], Optional[QL_OS], Optional[QL_ENDIAN]]:
@@ -343,64 +326,67 @@ def ql_pe_parse_emu_env(path: str) -> Tuple[Optional[QL_ARCH], Optional[QL_OS],
     except:
         return None, None, None
 
-    ostype = None
     arch = None
+    ostype = None
     archendian = None
 
     machine_map = {
-        pefile.MACHINE_TYPE['IMAGE_FILE_MACHINE_I386']: QL_ARCH.X86,
-        pefile.MACHINE_TYPE['IMAGE_FILE_MACHINE_AMD64']: QL_ARCH.X8664,
-        pefile.MACHINE_TYPE['IMAGE_FILE_MACHINE_ARM']: QL_ARCH.ARM,
-        pefile.MACHINE_TYPE['IMAGE_FILE_MACHINE_THUMB']: QL_ARCH.ARM,
-        # pefile.MACHINE_TYPE['IMAGE_FILE_MACHINE_ARM64']     :   QL_ARCH.ARM64       #pefile does not have the definition
+        pefile.MACHINE_TYPE['IMAGE_FILE_MACHINE_I386']  : QL_ARCH.X86,
+        pefile.MACHINE_TYPE['IMAGE_FILE_MACHINE_AMD64'] : QL_ARCH.X8664,
+        pefile.MACHINE_TYPE['IMAGE_FILE_MACHINE_ARM']   : QL_ARCH.ARM,
+        pefile.MACHINE_TYPE['IMAGE_FILE_MACHINE_THUMB'] : QL_ARCH.ARM,
+        # pefile.MACHINE_TYPE['IMAGE_FILE_MACHINE_ARM64'] :   QL_ARCH.ARM64       #pefile does not have the definition
         # for IMAGE_FILE_MACHINE_ARM64
         0xAA64: QL_ARCH.ARM64  # Temporary workaround for Issues #21 till pefile gets updated
     }
+
     # get arch
-    archendian = QL_ENDIAN.EL
     arch = machine_map.get(pe.FILE_HEADER.Machine)
 
     if arch:
-        if pe.OPTIONAL_HEADER.Subsystem >= pefile.SUBSYSTEM_TYPE['IMAGE_SUBSYSTEM_EFI_APPLICATION'] and \
-        pe.OPTIONAL_HEADER.Subsystem <= pefile.SUBSYSTEM_TYPE['IMAGE_SUBSYSTEM_EFI_ROM'] :
+        subsystem_uefi = (
+            pefile.SUBSYSTEM_TYPE['IMAGE_SUBSYSTEM_EFI_APPLICATION'],
+            pefile.SUBSYSTEM_TYPE['IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER'],
+            pefile.SUBSYSTEM_TYPE['IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER'],
+            pefile.SUBSYSTEM_TYPE['IMAGE_SUBSYSTEM_EFI_ROM']
+        )
+
+        if pe.OPTIONAL_HEADER.Subsystem in subsystem_uefi:
             ostype = QL_OS.UEFI
         else:
             ostype = QL_OS.WINDOWS
-    else:
-        ostype = None
+
+        archendian = QL_ENDIAN.EL
 
     return arch, ostype, archendian
 
 
 def ql_guess_emu_env(path: str) -> Tuple[Optional[QL_ARCH], Optional[QL_OS], Optional[QL_ENDIAN]]:
     arch = None
     ostype = None
-    archendian = None
+    endian = None
 
-    if os.path.isdir(path) and (str(path)).endswith(".kext"):
+    if os.path.isdir(path) and path.endswith('.kext'):
         return QL_ARCH.X8664, QL_OS.MACOS, QL_ENDIAN.EL
 
-    if os.path.isfile(path) and (str(path)).endswith(".DOS_COM"):
+    if os.path.isfile(path) and path.endswith('.DOS_COM'):
         return QL_ARCH.A8086, QL_OS.DOS, QL_ENDIAN.EL
 
-    if os.path.isfile(path) and (str(path)).endswith(".DOS_MBR"):
+    if os.path.isfile(path) and path.endswith('.DOS_MBR'):
         return QL_ARCH.A8086, QL_OS.DOS, QL_ENDIAN.EL
 
-    if os.path.isfile(path) and (str(path)).endswith(".DOS_EXE"):
+    if os.path.isfile(path) and path.endswith('.DOS_EXE'):
         return QL_ARCH.A8086, QL_OS.DOS, QL_ENDIAN.EL
 
-    arch, ostype, archendian = ql_elf_parse_emu_env(path)
+    arch, ostype, endian = ql_elf_parse_emu_env(path)
 
-    if arch == None or ostype == None or archendian == None:
-        arch, ostype, archendian = ql_macho_parse_emu_env(path)
+    if arch is None or ostype is None or endian is None:
+        arch, ostype, endian = ql_macho_parse_emu_env(path)
 
-    if arch == None or ostype == None or archendian == None:
-        arch, ostype, archendian = ql_pe_parse_emu_env(path)
-  
-    if ostype not in (QL_OS):
-        raise QlErrorOsType("File does not belong to either 'linux', 'windows', 'freebsd', 'macos', 'ios', 'dos', 'qnx'")
+    if arch is None or ostype is None or endian is None:
+        arch, ostype, endian = ql_pe_parse_emu_env(path)
 
-    return arch, ostype, archendian
+    return arch, ostype, endian
 
 
 def loader_setup(ostype: QL_OS, ql):
@@ -475,7 +461,7 @@ def profile_setup(ql):
         return ql_hw_profile_setup(ql)
 
     _profile = "Default"
-    
+
     if ql.profile != None:
         _profile = ql.profile
     debugmsg = "Profile: %s" % _profile
@@ -487,24 +473,23 @@ def profile_setup(ql):
     else:
         profiles = [os_profile]
 
-    config = configparser.ConfigParser()
+    config = ConfigParser()
     config.read(profiles)
-    
+
     return config, debugmsg
 
 def ql_hw_profile_setup(ql):
-    config = configparser.ConfigParser()
-    debugmsg = "Profile: %s" % ql.profile
+    config = ConfigParser()
 
-    profile_name = '%s.ql' % ql.profile
+    profile_name = f'{ql.profile}.ql'
     profile_dir  = os.path.join(os.path.dirname(os.path.abspath(__file__)), "profiles")
 
     for path, _, files in os.walk(profile_dir):
-        if profile_name in files:            
+        if profile_name in files:
             config.read(os.path.join(profile_dir, path, profile_name))
             break
 
-    return config, debugmsg
+    return config, f'Profile: {ql.profile}'
 
 def ql_resolve_logger_level(verbose: QL_VERBOSE) -> int:
     return {
@@ -585,7 +570,7 @@ def verify_ret(ql, err):
                     pass
                 else:
                     raise
-        
+
         if ql.archtype == QL_ARCH.X8664: # Win64
             if ql.os.init_sp == ql.reg.arch_sp or ql.os.init_sp + 8 == ql.reg.arch_sp or ql.os.init_sp + 0x10 == ql.reg.arch_sp:  # FIXME
                 # 0x11626	 c3	  	ret
@@ -600,4 +585,4 @@ def verify_ret(ql, err):
             else:
                 raise
     else:
-        raise        
+        raise