The Mobile Security Testing Guide (MSTG) is a comprehensive manual for mobile app security testing and reverse engineering.
Clone or download
Latest commit cac7ecc Oct 15, 2018

README.md

OWASP Mobile Security Testing Guide Twitter Follow

Creative Commons License OWASP Labs Build Status

This is the official GitHub Repository of the OWASP Mobile Security Testing Guide (MSTG). The MSTG is a comprehensive manual for mobile app security testing and reverse engineering. It describes technical processes for verifying the controls listed in the OWASP Mobile Application Verification Standard (MASVS). You can also read the MSTG on Gitbook or download it as an e-book.

Table-of-Contents

Introduction

General Testing Guide

Android Testing Guide

iOS Testing Guide

Appendix

Reading the Mobile Security Testing Guide

The release 1.0 of the MSTG was published in June 2018. You can get intermediate builds in multiple formats.

  1. Read it on Gitbook. The book is automatically synchronized with the main repo.

  2. Check the releases. Here you can find a PDF, an archive containing the sources and a DocX document for any given tagged version. Please note that the documents are generated automatically per tag.

  3. Get the e-book. The book is available for free, but you can choose to purchase it at a price of your choosing if you wish to support our project. All funds raised through sales of the e-book go directly into the project budget and will be used to fund production of future releases.

  4. Clone the repository and run the document generator (requires pandoc). This produces docx and HTML files in the "Generated" subdirectory.

$ git clone https://github.com/OWASP/owasp-mstg/
$ cd owasp-mstg/Tools/
$ ./generate_document.sh
  1. Clone the repository and run the gitbook generator. This produces PDF, Epub and Mobi files in the "Generated" subdirectory.
$ git clone https://github.com/OWASP/owasp-mstg/
$ cd owasp-mstg/Tools/
$ ./gitbookandpdf.sh

You can also use the document index to navigate the master branch of the MSTG.

Contributions, feature requests and feedback

We are searching for additional authors, reviewers and editors. The best way to get started is to browse the existing content. Also, check the issues and the project page for a list of open tasks.

Drop a us line on the Slack channel before you start working on a topic. This helps us to keep track of what everyone is doing and prevent conflicts. You can create a Slack account here:

https://owasp.slack.com/

Before you start contributing, please read our brief style guide which contains a few basic writing rules.

Please note that the MSTG focuses primarely on the native apps. These are apps built with Java or Kotlin using the Android SDK for Android or built with Swift or Objective-C using the Apple SDKs for iOS. Nativescript/React-native/Xamarin/Cordova/... apps are not within the focus of the MSTG. However, some key-controls, such as pinning, have been explained already for some of these platforms.

If there's something you really want to see in the guide, or you want to suggest an improvement, create an issue issue or ping us on Slack. If the issue is accepted, we will schedule it into one of our milestones.

Translating

Our current goal is to publish one minor release every 6 months. Next, we will often create patch updates in order to provide intermediary updates in PDF and DocX format. Releases that have been tagged can then be translated into preferred languages. (Note we use semantic versioning: major.minor.patch)

Contributing

  • Fork it ( https://github.com/[my-github-username]/owasp-mstg/ )
  • Create your feature branch (git checkout -b my-new-feature)
  • Commit your changes (git commit -am 'Add some feature')
  • Push to the branch (git push origin my-new-feature)
  • Create a new Pull Request
  • The project leaders will QA and give feedback before it's merged.

Authoring Credit

Contributors are added to the acknowledgements table based on their contributions logged by GitHub. The list of names is sorted by the number of lines added. Authors are categorized as follows:

  • Project Leader / Author: Manage development of the guide continuously and write a large amount of content.
  • Co-Author: Consistently contribute quality content, at least 2,000 additions logged.
  • Top Contributor: Consistently contribute quality content, at least 500 additions logged.
  • Contributor: Any form of contribution, at least 50 additions logged.
  • Mini-contributor: Everything below 50 additions, e.g. committing a single word or sentence.
  • Reviewer: People that haven't submitted their own pull requests, but have created issues or given useful feedback in other ways.

Please ping us or create a pull request if you are missing from the table or in the wrong column (note that we update the table frequently, but not in realtime).

If you are willing to write a large portion of the guide and help consistently drive the project forward, you can join as an author. Be aware that you'll be expected to invest lots of time over several months. Contact Sven Schleier (Slack: sushi2k) or Jeroen Willemsen (Slack: jeroenwillemsen) for more information.

Crackmes

In the Crackmes folder, you can find a set of mobile apps to hack. Are you able to find the secrets? For more details: check the README.md at the Crackmes folder.