/GuardianConnect-Android

API / VPN Framework for Guardian Firewall Android application

Primary LanguageKotlinMIT LicenseMIT

GuardianConnect

A work-in-progress framework for Android applications written in Kotlin or Java to integrate with the Guardian Connect API and establish VPN connections to the Guardian Firewall infrastructure. All lower level components are exposed but the use of high level APIs in GRDVPNHelper are recommended. This framework includes everything to establish a WireGuard connection through another dependency. Instructions on how to build and integrate all required components are forthcoming (see section: Sample Application)

For more information and a direct contact visit https://guardianapp.com/company/partners/

Integration

For easy integration it is recommended to use the Guardian Connect library published on Sonatype

implementation 'com.guardianapp.connect:GuardianConnect:$GuardianConnectVersion'

Sample Application

The project contains a sample application built to showcase & test functionality. It is also a reference implementation for the APIs provided by the GuardianConnect library and can be run locally on any Android device

Building

In order to build the library for local development tasks & testing first clone the repo and then run ./gradlew guardian:build from the root of the repo.
The build system will create a new directory with the build output under ./guardian/build/outputs/aar