Skip to content

Commit 63e5f7b

Browse files
sydowmasydowma
committed
WIP:add zh-cn version
add zh-cn version
1 parent 0f915f0 commit 63e5f7b

12 files changed

+527
-1
lines changed

‎_navbar.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,8 @@
1111
* [MobSF Docker Options](docker.md)
1212
* [Updating MobSF](updating.md)
1313
* [Running Tests](tests.md)
14-
* [Extras](extras.md)
14+
* [Extras](extras.md)
15+
16+
* Translations
17+
* [:uk: English](/)
18+
* [:cn: 中文](/zh-cn/)

‎zh-cn/README.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Getting Started
2+
![MobSF](https://cloud.githubusercontent.com/assets/4301109/20019521/cc61f7fc-a2f2-11e6-95f3-407030d9fdde.png)
3+
Mobile Security Framework (MobSF) is an automated, all-in-one mobile application (Android/iOS/Windows) pen-testing, malware analysis and security assessment framework capable of performing static and dynamic analysis.
4+
5+
### Project Developers
6+
7+
[Ajin Abraham](https://in.linkedin.com/in/ajinabraham) ![india](https://user-images.githubusercontent.com/4301109/37564171-6549d678-2ab6-11e8-9b9d-21327c7f5d5b.png) | [Dominik Schlecht](https://github.com/sn0b4ll) ![germany](https://user-images.githubusercontent.com/4301109/37564176-743238ba-2ab6-11e8-9666-5d98f0a1d127.png) | [Magaofei](https://github.com/magaofei) ![china](https://user-images.githubusercontent.com/4301109/44515364-00bbe880-a6e0-11e8-944d-5b48a86427da.png) | [Matan Dobrushin](https://github.com/matandobr) ![israel](https://user-images.githubusercontent.com/4301109/37564177-782f1758-2ab6-11e8-91e5-c76bde37b330.png) | [Vincent Nadal](https://github.com/superpoussin22) ![france](https://user-images.githubusercontent.com/4301109/37564175-71d6d92c-2ab6-11e8-89d7-d21f5aa0bda8.png)
8+
9+
**Donate via Paypal:** [![Donate via Paypal](https://user-images.githubusercontent.com/4301109/76471686-c43b0500-63c9-11ea-8225-2a305efb3d87.gif)](https://paypal.me/ajinabraham) or **Donate Bitcoins:** [![Donate Bitcoin](https://user-images.githubusercontent.com/4301109/30631105-cb8063c8-9e00-11e7-95df-43c20b840e52.png)](https://mobsf.github.io/Mobile-Security-Framework-MobSF/donate.html)
10+
11+
### MobSF e-Learning Courses & Certification
12+
13+
We have 2 self paced e-learning courses that covers MobSF and other Android Security tools.
14+
15+
![MobSF Course](https://user-images.githubusercontent.com/4301109/76344880-ad68b580-62d8-11ea-8cde-9e3475fc92f6.png) [Automated Mobile Application Security Assessment with MobSF -MAS](https://opsecx.com/index.php/product/automated-mobile-application-security-assessment-with-mobsf/)
16+
17+
![Android Security Tools Course](https://user-images.githubusercontent.com/4301109/76344939-c709fd00-62d8-11ea-8208-774f1d5a7c52.png) [Android Security Tools Expert -ATX](https://opsecx.com/index.php/product/android-security-tools-expert-atx/)
18+
19+
20+
### MobSF Support
21+
22+
* **Free Support:** For free limited support, questions and help, join our Slack channel ![MobSF Slack Channel](https://user-images.githubusercontent.com/4301109/76471928-6e1a9180-63ca-11ea-88fb-b43d75153f74.png) [mobsf.slack.com](https://mobsf.slack.com/join/shared_invite/enQtNzM2NTAyNzA1MjgxLTdjMzkzNDc3ZjdiMjkwZTZhMmFhNDlkZmMwZDhjNDNmYTAzYWE5NGZlMDIzYzliNTdiMDQ2MTRlYjU1MjkyNGM)
23+
* **Enterprise Support:** For enterprise support, priority feature requests and live training, see [MobSF Support Packages](https://mobsf.github.io/Mobile-Security-Framework-MobSF/support.html)
24+
25+
***

‎zh-cn/_navbar.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<!-- _navbar.md -->
2+
<!-- docs/_sidebar.md -->
3+
* 入门
4+
* [入门](/)
5+
* [要求](requirements.md)
6+
* [安装]](installation.md)
7+
* [运行 MobSF](running.md)
8+
* [配置动态分析](dynamic_analyzer.md)
9+
10+
* 附加
11+
* [MobSF Docker 选项](docker.md)
12+
* [升级 MobSF](updating.md)
13+
* [执行测试](tests.md)
14+
* [附加](extras.md)
15+
16+
* Translations
17+
- [:uk: English](/)
18+
- [:cn: 中文](/zh-cn/)

‎zh-cn/_sidebar.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- docs/_sidebar.md -->
2+
3+
* [入门](/)
4+
* [要求](requirements.md)
5+
* [安装](installation.md)
6+
* [运行 MobSF](running.md)
7+
* [配置动态分析](dynamic_analyzer.md)
8+
* [MobSF Docker 选项](docker.md)
9+
* [升级 MobSF](updating.md)
10+
* [运行测试](tests.md)
11+
* [附加](extras.md)

‎zh-cn/docker.md

+116
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
# MobSF Docker Options
2+
3+
!> Dynamic Analysis is not supported with Docker
4+
5+
?> Feeling too lazy to setup MobSF? Use the latest prebuilt image from [DockerHub](https://hub.docker.com/r/opensecurity/mobile-security-framework-mobsf/).
6+
7+
**Prebuilt Docker image from DockerHub**
8+
9+
```bash
10+
docker pull opensecurity/mobile-security-framework-mobsf
11+
# Static Analysis Only
12+
docker run -it -p 8000:8000 opensecurity/mobile-security-framework-mobsf:latest
13+
```
14+
15+
**For persistence**
16+
17+
```bash
18+
docker run -it --name mobsf -p 8000:8000 -v <your_local_dir>:/root/.MobSF opensecurity/mobile-security-framework-mobsf:latest
19+
```
20+
21+
**Building Image from Dockerfile**
22+
23+
```bash
24+
git clone https://github.com/MobSF/Mobile-Security-Framework-MobSF.git
25+
cd Mobile-Security-Framework-MobSF
26+
docker build -t mobsf .
27+
docker run -it -p 8000:8000 mobsf
28+
```
29+
30+
**Building Image behind a proxy from Dockerfile**
31+
32+
```bash
33+
docker build --build-arg https_proxy="https://${PROXY_IP}:${PROXY_PORT}" --build-arg http_proxy="${PROXY_IP}:${PROXY_PORT}" --build-arg NO_PROXY="127.0.0.1" -t mobsf .
34+
```
35+
36+
Set the environment variable `PROXY_IP` with the value of your proxy ip address and `PROXY_PORT` with the proxy port used.
37+
38+
**Rebuilding Image from Dockerfile from Scratch**
39+
40+
```bash
41+
docker rmi ubuntu:18.04
42+
docker build --no-cache --rm -t mobsf .
43+
```
44+
45+
**For postgres support**
46+
47+
You will need docker-compose, (See: <https://docs.docker.com/compose/install>).
48+
49+
* Build the images
50+
51+
`docker-compose build`
52+
53+
* Launch the services
54+
55+
`docker-compose up -d` (in background)
56+
57+
or
58+
59+
`docker-compose up ` (in foreground )
60+
61+
Then verify the 2 services are up:
62+
63+
`docker ps`
64+
65+
```bash
66+
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
67+
7de107c5b853 mobile-security-framework-mobsf_mobsf "python3 manage.py r…" 5 weeks ago Up 5 weeks 0.0.0.0:8000->8000/tcp mobile-security-framework-mobsf_mobsf_1
68+
149a3ffa61ca postgres:latest "docker-entrypoint.s…" 5 weeks ago Up 5 weeks 5432/tcp mobile-security-framework-mobsf_postgres_1
69+
```
70+
71+
If you don't want to use docker-compose, you will need to start a postgres container first , then start MobSF container with the `build-arg` **POSTGRES=True**.
72+
73+
```bash
74+
docker build --build-arg POSTGRES=True -t mobsf .
75+
```
76+
77+
You can change postgres connection information in `postgres_support.sh`
78+
79+
**This must be done before building the image**
80+
81+
```bash
82+
#!/bin/bash
83+
set -e
84+
POSTGRES=$1
85+
echo "Postgres support : ${POSTGRES}"
86+
if [ "$POSTGRES" == True ]; then
87+
echo "Installing Postgres"
88+
pip3 install psycopg2-binary
89+
#Enable postgres support
90+
sed -i '/# Sqlite3 suport/,/# End Sqlite3 support/d' ./MobSF/settings.py && \
91+
sed -i "/# Postgres DB - Install psycopg2/,/'''/d" ./MobSF/settings.py && \
92+
sed -i "/# End Postgres support/,/'''/d" ./MobSF/settings.py && \
93+
sed -i "s/'PASSWORD': '',/'PASSWORD': 'password',/" ./MobSF/settings.py && \
94+
sed -i "s/'HOST': 'localhost',/'HOST': 'postgres',/" ./MobSF/settings.py
95+
fi
96+
````
97+
98+
**If you have error at first launch**
99+
100+
```bash
101+
docker exec -it mobile-security-framework-mobsf_mobsf_1 python3 manage.py makemigrations
102+
docker exec -it mobile-security-framework-mobsf_mobsf_1 python3 manage.py makemigrations StaticAnalyzer
103+
docker exec -it mobile-security-framework-mobsf_mobsf_1 python3 manage.py migrate
104+
```
105+
106+
**To see what's happened in container if launched with `-d` instead of `-it`**
107+
108+
```bash
109+
docker logs -f --tail 100 mobsf
110+
```
111+
112+
**To have shell access in the container**
113+
114+
```bash
115+
docker exec -it mobsf /bin/bash
116+
```

‎zh-cn/dynamic_analyzer.md

+101
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Dynamic Analyzer
2+
3+
!> Dynamic analysis using real mobile device is possible, **but not supported by us.** If you need Dynamic Analysis, do not setup MobSF inside Docker or Virtual Machine.
4+
5+
## Genymotion Android x86
6+
?> Supports x86 architecture Android **4.1 - 9.0**, upto **API 28**
7+
8+
Genymotion is the preferred dynamic analysis environment that you can setup with the least friction. Run a Genymotion Android VM **before starting MobSF.** Everything will be configured automatically at runtime. We recommend using **Android 7.0** and above.
9+
10+
* **Android 5.0 - 9.0** - These versions uses **Frida** and works out of the box with zero configuration or setup.
11+
* **Android 4.1 - 4.4** - These versions uses **Xposed Framework** and requires that you should MobSFy the runtime prior to Dynamic Analysis for the first time. These versions also require VM reboot after installing Xposed Modules.
12+
13+
Click **MobSFy Android Runtime** button in Dynamic Analyzer page to MobSFy the android runtime environment.
14+
15+
![MobSFy](https://user-images.githubusercontent.com/4301109/77839885-11033780-714f-11ea-9d52-df7b0bd314a0.png)
16+
17+
**HTTPS Proxy**
18+
19+
* For Android versions **4.4 - 9.0**, global proxy settings are automatically applied at runtime.
20+
* For Android version **4.1 - 4.3**, set Android VM proxy as displayed in Dynamic Analyzer page.
21+
22+
If Dynamic Analyzer doesn't detect your android device, you need to manually configure `ANALYZER_IDENTIFIER` in `MobSF/settings.py`.
23+
24+
Example: `ANALYZER_IDENTIFIER = '192.168.56.101:5555'`.
25+
You can find the Android Device IP from the Genymotion title bar and the default port is `5555`.
26+
27+
![Dynamic Analyzer IP](https://user-images.githubusercontent.com/4301109/65379210-0b312300-dce2-11e9-8827-f63d3b95dfd1.png)
28+
29+
## Android Studio Emulator
30+
?> Supports arm, arm64 and x86 architecture Android **5.0 - 9.0**, upto **API 28**
31+
32+
Android Emulator image with Google Play Store is considered as production image and you cannot use that with MobSF.
33+
Create an Android Virtual Device (AVD) **without Google Play Store**. Do not start the AVD from Android Studio, instead start the AVD with writable system using `emulator` command line options.
34+
35+
For that, add your Android SDK emulator directory to `PATH`.
36+
37+
Some example locations
38+
39+
* Mac - `/Users/<user>/Library/Android/sdk/emulator`
40+
* Linux - `/home/<user>/Android/Sdk/emulator`
41+
* Windows - `C:\Users\<user>\AppData\Local\Android\Sdk\emulator`
42+
43+
**List available Android Virtual Devices (AVD)**
44+
45+
```bash
46+
$ emulator -list-avds
47+
Pixel_2_API_29
48+
Pixel_3_API_28
49+
Pixel_XL_API_24
50+
Pixel_XL_API_25
51+
```
52+
53+
!>Only Android images upto **API 28** are supported!
54+
55+
56+
Set `ADB_BINARY` path in `MobSF/settings.py`.
57+
58+
Make sure that you are using the adb binary that comes with Android Studio. If you use a different version, that might cause conflicts and introduce issues while attempting dynamic analysis.
59+
60+
Some example locations
61+
62+
```python
63+
ADB_BINARY = '/Users/<user>/Library/Android/sdk/platform-tools/adb' # Mac
64+
ADB_BINARY = '/home/<user>/Android/Sdk/platform-tools/adb' # Linux
65+
ADB_BINARY = 'C:\\Users\\<user>\\AppData\\Local\\Android\\Sdk\\platform-tools\\adb.exe' # Windows
66+
ADB_BINARY = 'C:/Users/<user>/AppData/Local/Android/sdk/platform-tools/adb.exe' # Windows
67+
```
68+
69+
**Run Android Virtual Device (AVD)**
70+
71+
Run an AVD **before starting MobSF** using `emulator` command line options.
72+
73+
```bash
74+
$ emulator -avd <non_production_avd_name> -writable-system -no-snapshot
75+
```
76+
77+
Everything will be configured automatically at runtime. MobSF requires AVD version **5.0 to 9.0** for dynamic analysis. We recommend using **Android 7.0** and above.
78+
79+
**HTTPS Proxy**
80+
81+
* For Android versions **5.0 - 9.0**, global proxy settings are automatically applied at runtime.
82+
83+
**GApps on AVD (Optional)**
84+
85+
If you need GApps, find the appropriate package from <https://opengapps.org/>
86+
87+
```bash
88+
unzip open_gapps-<your-version>.zip 'Core/*'
89+
rm Core/setup*
90+
lzip -d Core/*.lz
91+
for f in $(ls Core/*.tar); do
92+
tar -x --strip-components 2 -f $f
93+
done
94+
adb remount
95+
adb push etc /system
96+
adb push framework /system
97+
adb push app /system
98+
adb push priv-app /system
99+
adb shell stop
100+
adb shell start
101+
```

0 commit comments

Comments
 (0)