Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imrdjai/cordova-plugin-tun2socks-udp-associate
Cordova plugin to enable a system-wide VPN for Android devices.
https://github.com/imrdjai/cordova-plugin-tun2socks-udp-associate
android cordova network plugin proxy socks tun2socks v5 vpn
Last synced: about 16 hours ago
JSON representation
Cordova plugin to enable a system-wide VPN for Android devices.
- Host: GitHub
- URL: https://github.com/imrdjai/cordova-plugin-tun2socks-udp-associate
- Owner: iMrDJAi
- License: apache-2.0
- Created: 2021-06-05T21:49:33.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-02-08T22:21:08.000Z (almost 3 years ago)
- Last Synced: 2024-04-26T01:06:11.236Z (7 months ago)
- Topics: android, cordova, network, plugin, proxy, socks, tun2socks, v5, vpn
- Language: C
- Homepage:
- Size: 2.19 MB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# cordova-plugin-tun2socks-udp-associate
[](https://www.npmjs.com/package/cordova-plugin-tun2socks-udp-associate) [](https://github.com/iMrDJAi/cordova-plugin-tun2socks-udp-associate)
(This is a fork of [Xmader/cordova-plugin-tun2socks#xmader-udp](https://github.com/Xmader/cordova-plugin-tun2socks/tree/xmader-udp). Original repo: [UWNetworksLab/cordova-plugin-tun2socks](https://github.com/UWNetworksLab/cordova-plugin-tun2socks))
This Cordova plugin provides the ability to start a system-wide VPN for Android devices.
We use [tun2socks](https://github.com/ambrop72/badvpn-googlecode-export/blob/master/tun2socks/badvpn-tun2socks.8) as an adapter; it receives all of the device’s traffic through the VPN network interface (TUN) and forwards it to a SOCKS server.
To handle DNS resolution, we use the UDP associate feature of SOCKS v5 proxy to intercept DNS queries over UDP.
Tested to work with [socks5.js](https://github.com/iMrDJAi/socks5.js) running on localhost.
### Table of Contents
- [Installation](#installation)
- [Re-building the .so](#re-building-the-so)
- [Target Devices](#target-devices)
- [Javascript API](#javascript-api)
- [Code Sources](#code-sources)
### Installation
Run the following commands on the root of your Cordova project folder:
```shell
$ npm i cordova-plugin-tun2socks-udp-associate -S
```
```shell
$ cordova plugin add cordova-plugin-tun2socks-udp-associate
```
```shell
$ cordova prepare android
```
### Re-building the .so
```shell
$ ndk-build -C android
```
Pre-built binaries for "armeabi-v7a", "arm64-v8a", "x86" and "x86_64" are included.
### Target Devices
This plugin targets Android devices running Lollipop (API 21), or higher. This requirement stems from calling `addDisallowedApplication`, a [VPNService.Builder API](https://developer.android.com/reference/android/net/VpnService.Builder.html#addDisallowedApplication(java.lang.String)) introduced in version 21, which allows the specified application's traffic to bypass the VPN.
### Javascript API
`start(socksServerAddress:string) : Promise;`
Starts the VPN service, and tunnels all the traffic to the SOCKS5 server at `socksServerAddress`.
Restarts tunneling while preserving the VPN connection if called when the plugin is already running.
`stop(): Promise;`
Stops the VPN service.
`onDisconnect(): Promise;`
Sets a success callback on the returned promise, to be called if the VPN service gets revoked or disconnected.
`deviceSupportsPlugin(): Promise;`
Retruns true if the device runs the minimum required version for the plugin to function properly.
### Code Sources
We re-use and have used as a starting point open source code from [Psiphon](https://psiphon.ca/uz@Latn/open-source.html), specifically https://github.com/mei3am/ps.
* `src/android`:
* starting point: https://github.com/mei3am/ps/tree/master/Android/app
* `Android/app/src/main/java/ca/psiphon/PsiphonTunnel.java` -> `src/android/org/uproxy/tun2socks/Tunnel.java`
* `Android/app/src/main/java/com/psiphon3/psiphonlibrary/TunnelManager.java` -> `src/android/org/uproxy/tun2socks/TunnelManager.java`
* `Android/app/src/main/java/com/psiphon3/psiphonlibrary/TunnelVpnService.java` -> `src/android/org/uproxy/tun2socks/TunnelVpnService.java`
* `src/badvpn`:
* built upon Psiphon's fork of [badvpn](https://github.com/ambrop72/badvpn).
* starting point: https://github.com/mei3am/ps/tree/master/Android/badvpn
* uProxy-specific changes mostly confined to tun2socks/tun2socks.c and marked with `// ==== UPROXY ====` (like Psiphon-specific changes)
* `src/android/libs/jsocks.jar`:
* http://jsocks.sourceforge.net/