Merge branch 'dev' into dev

Author: ucgJhe

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,4 +1,41 @@
-- [ ] Have you checked that there aren't other open [pull requests](https://github.com/qilingframework/qiling/pulls) for the same update/change?
-- [ ] Is this pull request for [dev](https://github.com/qilingframework/qiling/tree/dev) branch? (Do not pull request for **master** branch).
+<!-- 
+We highly appreciate your interest and contribution to our project. 
+Before submiting your PR, please finish the checklist below. 
+-->
+
+## Checklist
+
+### Which kind of PR do you create?
+
+- [ ] This PR only contains minor fixes.
+- [ ] This PR contains major feature update.
+- [ ] This PR introduces a new function/api for Qiling Framework.
+
+### Coding convention?
+
+- [ ] The new code conforms to Qiling Framework naming convention.
+- [ ] The imports are arranged properly.
+- [ ] Essential comments are added.
+- [ ] The reference of the new code is pointed out.
+
+### Extra tests?
+
+- [ ] No extra tests are needed for this PR.
+- [ ] I have added enough tests for this PR.
+- [ ] Tests will be added after some discussion and review.
+
+### Changelog?
+
+- [ ] This PR doesn't need to update Changelog.
+- [ ] Changelog will be updated after some proper review.
+- [ ] Changelog has been updated in my PR.
+
+### Target branch?
+
+- [ ] The target branch is dev branch.
+
+### One last thing
+
+- [ ] I have read the [contribution guide](https://docs.qiling.io/en/latest/contribution/)
 
 -----

ChangeLog

@@ -1,5 +1,13 @@
 This file details the changelog of Qiling Framework.
 
+------------------------------------
+BREAK CHANGE
+- ql.multithread can be only set during Qiling.__init__ now.
+- ql.nprint and ql.dpring is depreciated. Please use logging directly instead.
+- ql.filename is renamed to ql.argv.
+- ql.output and ql.verbose now has slightly different meanings and can be adjusted runtime. See their docstring for details.
+- ql.filter now accepts a regular expression.
+
 ------------------------------------
 [Version 1.2.1]: December [SOMETHING], 2020
 - 

examples/doogie_8086_crack.py

@@ -3,7 +3,7 @@
 # Cross Platform and Multi Architecture Advanced Binary Emulation Framework
 # Built on top of Unicorn emulator (www.unicorn-engine.org)
 
-import sys, curses, math, struct, string, time
+import sys, curses, math, struct, string, time, logging
 sys.path.append("..")
 from qiling import *
 from qiling.const import *
@@ -172,7 +172,7 @@ def read_until_zero(ql: Qiling, addr):
     return buf
 
 def set_required_datetime(ql: Qiling):
-    ql.nprint("Setting Feburary 06, 1990")
+    logging.info("Setting Feburary 06, 1990")
     ql.reg.ch = BIN2BCD(19)
     ql.reg.cl = BIN2BCD(1990%100)
     ql.reg.dh = BIN2BCD(2)

examples/hello_arm_linux_custom_syscall.py

@@ -14,12 +14,12 @@ def my_syscall_write(ql, write_fd, write_buf, write_count, *args, **kw):
 
     try:
         buf = ql.mem.read(write_buf, write_count)
-        ql.nprint("\n+++++++++\nmy write(%d,%x,%i) = %d\n+++++++++" % (write_fd, write_buf, write_count, regreturn))
+        logging.info("\n+++++++++\nmy write(%d,%x,%i) = %d\n+++++++++" % (write_fd, write_buf, write_count, regreturn))
         ql.os.fd[write_fd].write(buf)
         regreturn = write_count
     except:
         regreturn = -1
-        ql.nprint("\n+++++++++\nmy write(%d,%x,%i) = %d\n+++++++++" % (write_fd, write_buf, write_count, regreturn))
+        logging.info("\n+++++++++\nmy write(%d,%x,%i) = %d\n+++++++++" % (write_fd, write_buf, write_count, regreturn))
         if ql.output in (QL_OUTPUT.DEBUG, QL_OUTPUT.DUMP):
             raise
 

examples/hello_x8664_windows_customapi.py

@@ -3,7 +3,7 @@
 # Cross Platform and Multi Architecture Advanced Binary Emulation Framework
 # Built on top of Unicorn emulator (www.unicorn-engine.org) 
 
-import sys
+import sys, logging
 sys.path.append("..")
 
 from qiling import *
@@ -16,7 +16,7 @@
 @winsdkapi(cc=CDECL, replace_params={"str": STRING}) 
 def my_puts(ql, address, params):
     ret = 0
-    ql.nprint("\n+++++++++\nmy random Windows API\n+++++++++\n")
+    logging.info("\n+++++++++\nmy random Windows API\n+++++++++\n")
     string = params["str"]
     ret = len(string)
     return ret

examples/hfs_mbr_crack.py

@@ -1,6 +1,6 @@
 from qiling.const import QL_INTERCEPT
 from qiling import Qiling
-import curses
+import curses, logging
 
 def input_index(ql: Qiling):
     return ql.unpack16(ql.mem.read(0x81ba, 2))
@@ -37,7 +37,7 @@ def find_next(ql: Qiling):
             ctx_succ = ql.save()
         ql.restore(ctx)
     if ctx_succ is None:
-        ql.nprint("Can't find any suitbale result.")
+        logging.info("Can't find any suitbale result.")
         return None
     ql.restore(ctx_succ)
     return results
@@ -65,11 +65,11 @@ def main():
     for i in range(9):
         r = find_next(ql)
         if r is None:
-            ql.nprint("Fail to crack.")
+            logging.info("Fail to crack.")
             return
         else:
             r = list(map(lambda x: chr(x), r))
-            ql.nprint(f"Get {r}")
+            logging.info(f"Get {r}")
             results.append(r)
     print_flags(results)
 

examples/multithreading_arm64_linux.py

@@ -8,8 +8,7 @@
 from qiling import *
 
 def my_sandbox(path, rootfs):
-    ql = Qiling(path, rootfs, output = "debug")
-    ql.multithread = True
+    ql = Qiling(path, rootfs, output = "debug", multithread=True)
     ql.run()
 
 

examples/sality.py

@@ -3,7 +3,7 @@
 # Cross Platform and Multi Architecture Advanced Binary Emulation Framework
 # Built on top of Unicorn emulator (www.unicorn-engine.org) 
 
-import struct, sys
+import struct, sys, logging
 
 sys.path.append("..")
 from qiling import *
@@ -105,6 +105,7 @@ def sality_WriteFile(ql, address, params):
             r, nNumberOfBytesToWrite = ql.amsint32_driver.os.io_Write(buffer)
             ql.mem.write(lpNumberOfBytesWritten, ql.pack32(nNumberOfBytesToWrite))
         except Exception as e:
+            logging.exception("")
             print("Exception = %s" % str(e))
             r = 1
         if r:
@@ -143,6 +144,7 @@ def sality_StartServiceA(ql, address, params):
         else:
             return 1
     except Exception as e:
+        logging.exception("")
         print (e)
 
 
@@ -169,7 +171,7 @@ def hook_stop_address(ql):
     ql.os.set_function_args([0])
     ql.hook_address(hook_stop_address, 0x4055FA)
     ql.run(0x4053B2)
-    ql.nprint("[+] test kill thread")
+    logging.info("[+] test kill thread")
     if ql.amsint32_driver:
         ql.amsint32_driver.os.io_Write(struct.pack("<I", 0xdeadbeef))
         ql.amsint32_driver.hook_address(hook_stop_address, 0x10423)

examples/tendaac1518_httpd.py

@@ -13,7 +13,7 @@
 # notes: we are using rootfs in this example, so rootfs = squashfs-root
 # 
 
-import os, socket, sys, threading
+import os, socket, sys, threading, logging
 sys.path.append("..")
 from qiling import *
 
@@ -54,7 +54,7 @@ def nvram_listener():
 
 def myvfork(ql):
     regreturn = 0
-    ql.nprint("vfork() = %d" % regreturn)
+    logging.info("vfork() = %d" % regreturn)
     ql.os.definesyscall_return(regreturn)
 
 

qiling/arch/arm.py

@@ -3,6 +3,8 @@
 # Cross Platform and Multi Architecture Advanced Binary Emulation Framework
 # Built on top of Unicorn emulator (www.unicorn-engine.org) 
 
+import logging
+
 from unicorn import *
 from unicorn.arm_const import *
 
@@ -77,7 +79,7 @@ def enable_vfp(self):
             #self.ql.reg.fpexc = 0x00000040
         else:
             self.ql.reg.fpexc = 0x40000000
-        self.ql.dprint(D_INFO, "[+] Enable ARM VFP")
+        logging.debug("[+] Enable ARM VFP")
 
 
     def check_thumb(self):
@@ -91,5 +93,5 @@ def check_thumb(self):
         mode = UC_MODE_ARM
         if (reg_cpsr & reg_cpsr_v) != 0:
             mode = UC_MODE_THUMB
-            self.ql.dprint(D_INFO, "[+] Enable ARM THUMB")
+            logging.debug("[+] Enable ARM THUMB")
         return mode