The AntMonitor app and library for VPN-based traffic inspection on Android
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
antmonitorlib
app
docs
gradle/wrapper
technical-documentation
.gitignore
LICENSE
README.md
antmonitor.iml
build.gradle
codingStyle.xml
gradle.properties
gradlew
gradlew.bat
settings.gradle

README.md

AntMonitor

This is a repository for AntMonitor - a VPN-based packet capturing system for Android. For an overview of the project, please visit the project website.

License

AntMonitor is licensed under GPLv2.

1. Using the AntMonitor Library

The packet interception and inspection capabilities of AntMonitor have also been packaged as an Android library. If you wish to simply use that capability and write your own app from scratch, please refer to our other GitHub Project - AntMonitorExample.

2. Running the AntMonitor App

For the rest of the document we will refer to the directory to which you have cloned the repo as CODE_ROOT.

  • Download Android Studio
  • Download the Android NDK
  • Set the sdk.dir and the ndk.dir keys found in the CODE_ROOT/app/local.properties file to point to your Android SDK and Android NDK installation paths, respectively.
  • Click the "Run App" button within Android Studio to run the app on a connected Android device or emulator.

Documentation

The Javadoc sits in the documentation directory of the repo and is also available in web form here.

Generating Documentation

To generate the documentation you can use Android Studio:

  • Go to Tools -> Generate Javadoc
  • Select the desired scope and view
  • To add a custom overview page, add the following to the command-line arguments: -overview path_to/overview.html --allow-script-in-comments
  • Copy any resources (e.g. src/javadoc-resources/release) to the output folder

Citing AntMonitor

If you create a publication (including web pages, papers published by a third party, and publicly available presentations) using the AntMonitor app or the AntMonitor Library, please cite the corresponding paper as follows:

@article{shuba2016antmonitor,
  title={AntMonitor: A System for On-Device Mobile Network Monitoring and its Applications},
  author={Shuba, Anastasia and Le, Anh and Alimpertis, Emmanouil and Gjoka, Minas and Markopoulou, Athina},
  journal={arXiv preprint arXiv:1611.04268},
  year={2016}
}

We also encourage you to provide us (antmonitor.uci@gmail.com) with a link to your publication. We use this information in reports to our funding agencies.