mvt/README.md

89 lines
4.9 KiB
Markdown
Raw Normal View History

2021-07-16 06:05:01 +00:00
<p align="center">
<img src="./docs/mvt.png" width="300" />
</p>
# Mobile Verification Toolkit
2021-07-18 14:31:25 +00:00
[![](https://img.shields.io/pypi/v/mvt)](https://pypi.org/project/mvt/)
2021-07-16 06:05:01 +00:00
Mobile Verification Toolkit (MVT) is a collection of utilities to simplify and automate the process of gathering forensic traces helpful to identify a potential compromise of Android and iOS devices.
2021-07-21 08:25:02 +00:00
It has been developed and released by the [Amnesty International Security Lab](https://www.amnesty.org/en/tech/) in July 2021 in the context of the [Pegasus project](https://forbiddenstories.org/about-the-pegasus-project/) along with [a technical forensic methodology and forensic evidences](https://www.amnesty.org/en/latest/research/2021/07/forensic-methodology-report-how-to-catch-nso-groups-pegasus/).
2021-07-21 11:59:54 +00:00
*Warning*: this tool has been released as a forensic tool for a technical audience. Using it requires some technical skills such as understanding basics of forensic analysis and using command line tools.
2021-07-20 11:42:13 +00:00
[Please check out the documentation.](https://mvt.readthedocs.io/en/latest/)
2021-07-18 14:31:25 +00:00
### Installation using the Docker image
Using Docker is the easiest way of having all the dependencies fixed with a couple of commands.
Install Docker using the [official instructions](https://docs.docker.com/get-docker/) provided in the Website page.
Afterwards, you can build the Docker image once inside:
```bash
git clone https://github.com/mvt-project/mvt.git
cd mvt
docker build -t mvt .
```
Once the image is built, can now be tested using, what will prompt a bash terminal:
```bash
docker run -it mvt
```
If this is correct, close the container (`exit`) and it is time to connect the Android device to analyse to the USB port using the development mode as explained in the official docs [here](https://developer.android.com/studio/debug/dev-options).
To have visibility of the USB, the container WILL need to have access to the USB which is not activated in Docker by default.
This can be done using the `--privileged` parameter when launching Docker as follows and mounting the USB as a volume.
```bash
docker run -it --privileged -v /dev/bus/usb:/dev/bus/usb mvt
```
Note that using the `--privileged` parameter is insecure for a number of reasons explained in detail [here](https://blog.trailofbits.com/2019/07/19/understanding-docker-container-escapes/) as it gives access to the whole system.
As a brief explanation, the `-v <host_path>:<docker_path>` syntax maps the host path to the dockerized path to allow the connection.
Modern versions of Docker have a `--device` option where you can specify the exact USB to mount without the `--privileged` option:
```bash
docker run -it --device=/dev/<your_usb_port> mvt
```
The Docker image contains the dependencies fixed to perform a forensic analysis on an Android device using MVT, including ADB (reachable using `adb` as expected) and ABE (installed under `/opt/abe` and reachable using `abe` from the command line) which is ready to be launched using the installed version of Java.
Thus, the forensic analyst can proceed as expected to grab the evidences needed and performs the required tests.
## Manual Installation
2021-07-18 14:31:25 +00:00
First you need to install dependencies, on Linux `sudo apt install python3 python3-pip libusb-1.0-0` or on MacOS `brew install python3 libusb`.
2021-07-21 09:07:15 +00:00
Then you can install mvt from pypi with `pip3 install mvt`, or directly from sources:
2021-07-18 14:31:25 +00:00
```bash
git clone https://github.com/mvt-project/mvt.git
cd mvt
pip3 install .
```
## Usage
MVT provides two commands `mvt-ios` and `mvt-android` with the following subcommands available:
2021-07-20 11:42:13 +00:00
2021-07-18 14:31:25 +00:00
* `mvt-ios`:
* `check-backup`: Extract artifacts from an iTunes backup
* `check-fs`: Extract artifacts from a full filesystem dump
* `check-iocs`: Compare stored JSON results to provided indicators
* `decrypt-backup`: Decrypt an encrypted iTunes backup
* `mvt-android`:
* `check-backup`: Check an Android Backup
* `download-apks`: Download all or non-safelisted installed APKs
2021-07-20 11:42:13 +00:00
Check out [the documentation to see how to use them](https://mvt.readthedocs.io/en/latest/).
2021-07-18 14:31:25 +00:00
2021-07-18 14:31:25 +00:00
## License
The purpose of MVT is to facilitate the ***consensual forensic analysis*** of devices of those who might be targets of sophisticated mobile spyware attacks, especially members of civil society and marginalized communities. We do not want MVT to enable privacy violations of non-consenting individuals. Therefore, the goal of this license is to prohibit the use of MVT (and any other software licensed the same) for the purpose of *adversarial forensics*.
In order to achieve this, MVT is released under an adaptation of [Mozilla Public License v2.0](https://www.mozilla.org/MPL). This modified license includes a new clause 3.0, "Consensual Use Restriction" which permits the use of the licensed software (and any *"Larger Work"* derived from it) exclusively with the explicit consent of the person/s whose data is being extracted and/or analysed (*"Data Owner"*).
[Read the LICENSE](https://github.com/mvt-project/mvt/blob/main/LICENSE)