Skip to content

Commit 92bffc7

Browse files
committed
Update documents
1 parent 8fc89ac commit 92bffc7

File tree

2 files changed

+33
-5
lines changed

2 files changed

+33
-5
lines changed

docs/source/install.rst

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ Once you see the following msg, then you're all set::
3131
-o, --output FILE Output report in JSON
3232
-a, --apk FILE APK file [required]
3333
-r, --rule PATH Rules directory [default:
34-
/Users/$USER/.quark-engine/quark-rules]
35-
-g, --graph Create call graph to call_graph_image
34+
/home/haeter/.quark-engine/quark-rules]
35+
-g, --graph [png|json] Create call graph to call_graph_image
3636
directory
3737
-c, --classification Show rules classification
3838
-t, --threshold [100|80|60|40|20]
@@ -46,9 +46,14 @@ Once you see the following msg, then you're all set::
4646
--core-library [androguard|rizin]
4747
Specify the core library used to analyze an
4848
APK
49-
--multi-process INTEGER RANGE Allow analyzing APK with N processes,
50-
where N doesn't exceeds the number of usable CPUs - 1
51-
to avoid memory exhaustion.
49+
--multi-process INTEGER RANGE Allow analyzing APK with N processes, where
50+
N doesn't exceeds the number of usable CPUs
51+
- 1 to avoid memory exhaustion. [x>=1]
52+
--rizin-path FILE Specify a Rizin executable for Quark to
53+
perform analyses.
54+
--disable-rizin-installation Don't install Rizin automatically when no
55+
Rizin instance with a compatible version is
56+
found.
5257
--version Show the version and exit.
5358
--help Show this message and exit.
5459

docs/source/testing.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,29 @@ Then we could test one of the apk in `apk-malware-samples` by the rules `quark-r
1515
1616
$ quark -a Ahmyth.apk -s
1717
18+
Running analyses based on Rizin
19+
==================
20+
21+
Now Quark also supports `Rizin`_ as one of our Android analysis frameworks. You can use option ``--core-library`` with ``rizin`` to enable the Rizin-based analysis library.
22+
23+
.. _`Rizin`: https://github.com/rizinorg/rizin
24+
25+
.. code-block:: bash
26+
27+
quark -a Ahmyth.apk -s --core-library rizin
28+
29+
30+
For now, Quark is compatible with Rizin v0.4.0. But, users don't have to installed a Rizin with that version. Quark provides a feature to automatically setup a independent Rizin. In this way, the dependency will not conflict with your environment. Type in the above command and let Quark handle everything else for you.
31+
32+
If there is a working installation of Rizin installed in the system, Quark will check its version to determine if it is compatible. If true, Quark automatically uses it for the analysis. Otherwise, Quark uses the independent Rizin installed in the Quark directory (``~/.quark-engine``).
33+
34+
You can use option ``--rizin-path`` to specify the path of the Rizin executable.
35+
36+
.. code-block:: bash
37+
38+
quark -a Ahmyth.apk -s --core-library rizin --rizin-path path_to_a_rizin_executable
39+
40+
Moreover, if you don't want Quark to install an independent Rizin, you can use the flag ``--disable-rizin-installation`` to disable this feature.
1841

1942
Running in Docker
2043
=================

0 commit comments

Comments
 (0)