You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/testing.rst
+20-21Lines changed: 20 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,47 +15,46 @@ Then we could test one of the apk in `apk-malware-samples` by the rules `quark-r
15
15
16
16
$ quark -a Ahmyth.apk -s
17
17
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.
18
+
Running in Docker
19
+
=================
22
20
23
-
.. _`Rizin`: https://github.com/rizinorg/rizin
21
+
We could build the corresponding docker image by this command:
24
22
25
23
.. code-block:: bash
26
24
27
-
quark -a Ahmyth.apk -s --core-library rizin
28
-
25
+
docker build . -t quark
29
26
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
27
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``).
28
+
When the image is ready, let's run an example to test the image:
33
29
34
-
You can use option ``--rizin-path`` to specify the path of the Rizin executable.
30
+
You may also interactively use quark in the docker container. For example:
35
31
36
32
.. code-block:: bash
37
33
38
-
quark -a Ahmyth.apk -s --core-library rizin --rizin-path path_to_a_rizin_executable
34
+
$ docker run -v $(pwd):/tmp -it quark bash
35
+
(in-docker): /app/quark# cd /tmp
36
+
(in-docker)::/tmp# quark -a Ahmyth.apk -s
39
37
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.
38
+
Running analyses based on Rizin (Upcoming unstable feature)
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.
44
42
45
-
We could build the corresponding docker image by this command:
43
+
.. _`Rizin`: https://github.com/rizinorg/rizin
46
44
47
45
.. code-block:: bash
48
46
49
-
docker build . -t quark
47
+
quark -a Ahmyth.apk -s --core-library rizin
50
48
51
49
52
-
When the image is ready, let's run an example to test the image:
50
+
For now, Quark is compatible with Rizin v0.3.4. 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.
53
51
54
-
You may also interactively use quark in the docker container. For example:
52
+
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``).
53
+
54
+
You can use option ``--rizin-path`` to specify the path of the Rizin executable.
55
55
56
56
.. code-block:: bash
57
57
58
-
$ docker run -v $(pwd):/tmp -it quark bash
59
-
(in-docker): /app/quark# cd /tmp
60
-
(in-docker)::/tmp# quark -a Ahmyth.apk -s
58
+
quark -a Ahmyth.apk -s --core-library rizin --rizin-path path_to_a_rizin_executable
61
59
60
+
Moreover, if you don't want Quark to install an independent Rizin, you can use the flag ``--disable-rizin-installation`` to disable this feature.
0 commit comments