mvt/README.md

38 lines
2.5 KiB
Markdown
Raw Permalink Normal View History

2021-07-16 06:05:01 +00:00
<p align="center">
<img src="https://docs.mvt.re/en/latest/mvt.png" width="200" />
2021-07-16 06:05:01 +00:00
</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-30 19:26:48 +00:00
[![Documentation Status](https://readthedocs.org/projects/mvt/badge/?version=latest)](https://docs.mvt.re/en/latest/?badge=latest)
2022-02-02 11:45:06 +00:00
[![CI](https://github.com/mvt-project/mvt/actions/workflows/python-package.yml/badge.svg)](https://github.com/mvt-project/mvt/actions/workflows/python-package.yml)
[![Downloads](https://pepy.tech/badge/mvt)](https://pepy.tech/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.
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 evidence](https://www.amnesty.org/en/latest/research/2021/07/forensic-methodology-report-how-to-catch-nso-groups-pegasus/).
2021-07-21 08:25:02 +00:00
2021-07-26 19:39:49 +00:00
*Warning*: MVT is a forensic research tool intended for technologists and investigators. Using it requires understanding the basics of forensic analysis and using command-line tools. This is not intended for end-user self-assessment. If you are concerned with the security of your device please seek expert assistance.
2021-07-21 11:59:54 +00:00
2022-05-08 12:57:33 +00:00
## Installation
2021-10-25 07:19:10 +00:00
MVT can be installed from sources or from [PyPi](https://pypi.org/project/mvt/) (you will need some dependencies, check the [documentation](https://docs.mvt.re/en/latest/install/)):
2021-07-26 17:33:12 +00:00
```
pip3 install mvt
```
2022-05-08 12:57:33 +00:00
For alternative installation options and known issues, please refer to the [documentation](https://docs.mvt.re/en/latest/install/) as well as [GitHub Issues](https://github.com/mvt-project/mvt/issues).
2021-07-18 14:31:25 +00:00
## Usage
2021-08-18 15:03:49 +00:00
MVT provides two commands `mvt-ios` and `mvt-android`. [Check out the documentation to learn how to use them!](https://docs.mvt.re/)
2021-07-18 14:31:25 +00:00
2022-05-08 12:57:33 +00:00
2021-07-18 14:31:25 +00:00
## License
2021-10-25 07:19:10 +00:00
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. In order to achieve this, MVT is released under its own license. [Read more here.](https://docs.mvt.re/en/latest/license/)