First Commit

.gitignore

@@ -0,0 +1,14 @@
+*.iml
+.gradle
+/local.properties
+/.idea/caches
+/.idea/libraries
+/.idea/modules.xml
+/.idea/workspace.xml
+/.idea/navEditor.xml
+/.idea/assetWizardSettings.xml
+.DS_Store
+/build
+/captures
+.externalNativeBuild
+.cxx

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "libjpeg-turbo"]
+	path = libjpeg-turbo
+	url = https://github.com/libjpeg-turbo/libjpeg-turbo.git
+[submodule "libvncserver"]
+	path = libvncserver
+	url = https://github.com/LibVNC/libvncserver.git

README.md

@@ -0,0 +1,228 @@
+# droidVNC-NG
+
+[![Join the chat at https://gitter.im/droidVNC-NG/community](https://badges.gitter.im/droidVNC-NG/community.svg)](https://gitter.im/droidVNC-NG/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+This is an Android VNC server using contemporary Android 5+ APIs. It therefore does not require
+root access. In reverence to the venerable [droid-VNC-server](https://github.com/oNaiPs/droidVncServer)
+is is called droidVNC-NG.
+
+If you have a general question, it's best to [ask in the community chat](https://gitter.im/droidVNC-NG/community). If your concern is about a bug or feature request instead, please use [the issue tracker](https://github.com/bk138/droidVNC-NG/issues).
+
+[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
+     alt="Get it on F-Droid"
+     height="80">](https://f-droid.org/packages/net.christianbeier.droidvnc_ng/)
+[<img src="https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png"
+     alt="Get it on Google Play"
+     height="80">](https://play.google.com/store/apps/details?id=net.christianbeier.droidvnc_ng)
+
+## Features
+
+* Network export of device frame buffer with optional server-side scaling.
+* Injection of remote pointer events.
+* Handling of client-to-server text copy & paste. Note that server-to-client copy & paste does not
+  work in a generic way due to [Android security restrictions](https://developer.android.com/about/versions/10/privacy/changes#clipboard-data).
+* Handling of special keys to trigger 'Recent Apps' overview, Home button and Back button.
+* Android permission handling.
+* Screen rotation handling.
+* File transfer via the local network, assuming TightVNC viewer for Windows version 1.3.x is used.
+* Password protection for secure-in-terms-of-VNC connection.
+* Ability to specify the port used.
+* Start of background service on device boot.
+* Reverse VNC.
+* Ability to connect to a UltraVNC-style Mode-2 repeater.
+* Functionality to provide default configuration via a JSON file.
+* Zeroconf/Bonjour publishing for VNC server auto-discovery.
+* Per-client mouse pointers on the controlled device.
+
+
+## How to use
+
+1. Install the app from either marketplace.
+2. Get it all the permissions required.
+3. Set a good password and consider turning the `Start on Boot` off.
+4. Connect to your local Wi-Fi. For accepting a connection your device should be connected to some Local Area Network that you can control, normally it is a router. Connections via data networks (i.e. your mobile provider) are not supported.
+5. Click `Start` and connect to your device.
+
+### Keyboard Shortcuts From a VNC Viewer
+
+* **Ctrl-Shift-Esc** triggers 'Recent Apps' overview
+* **Home/Pos1** acts as Home button
+* **Escape** acts as Back button
+
+### For accepting connections from outside
+
+1. You should allow [Port Forwarding](https://en.wikipedia.org/wiki/Port_forwarding) in your router's Firewall settings. Login to your router's settings (usually open 192.168.1.1 in your browser, some routers have password written on them).
+2. Find Port Forwarding, usually it's somewhere in **Network - Firewall - Port Forwards**.
+3. Create a new rule, this is an example from OpenWRT firmware.
+
+   Name: **VNC forwarding**
+
+   Protocol: **TCP**
+
+   Source zone: **wan** may be "internet", "modem", something that suggests the external source.
+
+   External port: **5900** by default or whatever you specified in the app.
+
+   Destination zone: **lan** something that suggests local network.
+
+   Internal IP address: your device's local IP address, leaving **any** is less secure. The device's address may change over time! You can look it up in your routers' connected clients info.
+
+   Internal port: same as external port.
+
+4. Apply the settings, sometimes it requires rebooting a router.
+5. Figure out your public adress i.e. <https://www.hashemian.com/whoami/>.
+6. Use this address and port from above to connect to your device.
+
+### How to Pre-seed Preferences
+
+DroidVNC-NG can read a JSON file with default settings that apply if settings were not changed
+by the user. A file named `defaults.json` needs to created under
+`<external files directory>/Android/data/com.appknox.knoxvnc/files/` where
+depending on your device, `<external files directory>` is something like `/storage/emulated/0` if
+the device shows two external storages or simply `/sdcard` if the device has one external storage.
+
+An example `defaults.json` with completely new defaults (not all entries need to be provided) is:
+
+```json
+{
+    "port": 5901,
+    "portReverse": 5555,
+    "portRepeater": 5556,
+    "scaling": 0.7,
+    "viewOnly": false,
+    "showPointers": true,
+    "fileTransfer": true,
+    "password": "supersecure",
+    "accessKey": "evenmoresecure",
+    "startOnBoot": true,
+    "startOnBootDelay": 0
+}
+```
+
+### Remote Control via the Intent Interface
+
+droidVNC-NG features a remote control interface by means of Intents. This allows starting the VNC
+server from other apps or on certain events. It is designed to be working with automation apps
+like [MacroDroid](https://www.macrodroid.com/), [Automate](https://llamalab.com/automate/) or
+[Tasker](https://tasker.joaoapps.com/) as well as to be called from code.
+
+You basically send an explicit Intent to `com.appknox.knoxvnc.MainService` with one of
+the following Actions and associated Extras set:
+
+* `com.appknox.knoxvnc.ACTION_START`: Starts the server.
+  * `com.appknox.knoxvnc.EXTRA_ACCESS_KEY`: Required String Extra containing the remote control interface's access key. You can get/set this from the Admin Panel. 
+  * `com.appknox.knoxvnc.EXTRA_REQUEST_ID`: Optional String Extra containing a unique id for this request. Used to identify the answer from the service.
+  * `com.appknox.knoxvnc.EXTRA_PORT`: Optional Integer Extra setting the listening port. Set to `-1` to disable listening.
+  * `com.appknox.knoxvnc.EXTRA_PASSWORD`: Optional String Extra containing VNC password.
+  * `com.appknox.knoxvnc.EXTRA_SCALING`: Optional Float Extra between 0.0 and 1.0 describing the server-side framebuffer scaling.
+  * `com.appknox.knoxvnc.EXTRA_VIEW_ONLY`:  Optional Boolean Extra toggling view-only mode.
+  * `com.appknox.knoxvnc.EXTRA_SHOW_POINTERS`:  Optional Boolean Extra toggling per-client mouse pointers.
+  * `com.appknox.knoxvnc.EXTRA_FILE_TRANSFER`: Optional Boolean Extra toggling the file transfer feature.
+
+* `com.appknox.knoxvnc.ACTION_CONNECT_REVERSE`: Make an outbound connection to a listening viewer.
+  * `com.appknox.knoxvnc.EXTRA_ACCESS_KEY`: Required String Extra containing the remote control interface's access key. You can get/set this from the Admin Panel.
+  * `com.appknox.knoxvnc.EXTRA_REQUEST_ID`: Optional String Extra containing a unique id for this request. Used to identify the answer from the service.
+  * `com.appknox.knoxvnc.EXTRA_HOST`: Required String Extra setting the host to connect to.
+  * `com.appknox.knoxvnc.EXTRA_PORT`: Optional Integer Extra setting the remote port.
+
+* `com.appknox.knoxvnc.ACTION_CONNECT_REPEATER` Make an outbound connection to a repeater.
+  * `com.appknox.knoxvnc.EXTRA_ACCESS_KEY`: Required String Extra containing the remote control interface's access key. You can get/set this from the Admin Panel.
+  * `com.appknox.knoxvnc.EXTRA_REQUEST_ID`: Optional String Extra containing a unique id for this request. Used to identify the answer from the service.
+  * `com.appknox.knoxvnc.EXTRA_HOST`: Required String Extra setting the host to connect to.
+  * `com.appknox.knoxvnc.EXTRA_PORT`: Optional Integer Extra setting the remote port.
+  * `com.appknox.knoxvnc.EXTRA_REPEATER_ID`: Required String Extra setting the ID on the repeater.
+
+* `com.appknox.knoxvnc.ACTION_STOP`: Stops the server.
+  * `com.appknox.knoxvnc.EXTRA_ACCESS_KEY`: Required String Extra containing the remote control interface's access key. You can get/set this from the Admin Panel.
+  * `com.appknox.knoxvnc.EXTRA_REQUEST_ID`: Optional String Extra containing a unique id for this request. Used to identify the answer from the service.
+
+The service answers with a Broadcast Intent with its Action mirroring your request:
+
+* Action: one of the above Actions you requested
+  * `com.appknox.knoxvnc.EXTRA_REQUEST_ID`: The request id this answer is for.
+  * `com.appknox.knoxvnc.EXTRA_REQUEST_SUCCESS`: Boolean Extra describing the outcome of the request.
+
+There is one special case where the service sends a Broadcast Intent with action
+`com.appknox.knoxvnc.ACTION_STOP` without any extras: that is when it is stopped by the
+system.
+
+#### Examples
+
+##### Start a password-protected view-only server on port 5901
+
+Using `adb shell am` syntax:
+
+```shell
+adb shell am start-foreground-service \
+ -n com.appknox.knoxvnc.knoxvnc/.MainService \
+ -a com.appknox.knoxvnc.knoxvnc.ACTION_START \
+ --es com.appknox.knoxvnc.knoxvnc.EXTRA_ACCESS_KEY de32550a6efb43f8a5d145e6c07b2cde \
+ --es com.appknox.knoxvnc.knoxvnc.EXTRA_REQUEST_ID abc123 \
+ --ei com.appknox.knoxvnc.knoxvnc.EXTRA_PORT 5901 \
+ --es com.appknox.knoxvnc.knoxvnc.EXTRA_PASSWORD supersecure \
+ --ez com.appknox.knoxvnc.knoxvnc.EXTRA_VIEW_ONLY true
+```
+
+##### Start a server with defaults from Tasker
+
+- Tasker action-category in menu is System -> Send Intent
+- In there:
+  - Action `com.appknox.knoxvnc.ACTION_START`
+  - Extra `com.appknox.knoxvnc.EXTRA_ACCESS_KEY:<your api key from DroidVNC-NG start screen>`
+  - Package `com.appknox.knoxvnc`
+  - Class `com.appknox.knoxvnc.MainService`
+  - Target: Service
+
+##### Make an outbound connection to a listening viewer from the running server
+
+For example from Java code:
+
+See [MainActivity.java](app/src/main/java/net/christianbeier/knoxvnc/MainActivity.java).
+
+##### Stop the server again
+
+Using `adb shell am` syntax again:
+
+```shell
+adb shell am start-foreground-service \
+ -n com.appknox.knoxvnc.knoxvnc/.MainService \
+ -a com.appknox.knoxvnc.knoxvnc.ACTION_STOP \
+ --es com.appknox.knoxvnc.knoxvnc.EXTRA_ACCESS_KEY de32550a6efb43f8a5d145e6c07b2cde \
+ --es com.appknox.knoxvnc.knoxvnc.EXTRA_REQUEST_ID def456
+```
+
+## Building
+
+* After cloning the repo, make sure you have the required git submodules set up via `git submodule update --init`.
+* Then simply build via Android Studio or `gradlew`.
+
+
+## Contributing
+
+Contributions to the project are very welcome and encouraged! They can come in many forms.
+You can:
+
+  * Submit a feature request or bug report as an [issue](https://github.com/bk138/droidVNC-NG/issues).
+  * Provide info for [issues that require feedback](https://github.com/bk138/droidVNC-NG/labels/answer-needed).
+  * Add features or fix bugs via [pull requests](https://github.com/bk138/droidVNC-NG/pulls).
+    Please note [there's a list of issues](https://github.com/bk138/droidVNC-NG/labels/help%20wanted)
+	where contributions are especially welcome. Also, please adhere to the [contribution guidelines](CONTRIBUTING.md).
+
+
+## Notes
+
+* Requires at least Android 7.
+
+* [Since Android 10](https://developer.android.com/about/versions/10/privacy/changes#screen-contents),
+the permission to access the screen contents has to be given on each start and is not saved. You can,
+however, work around this by installing [adb](https://developer.android.com/studio/command-line/adb)
+(or simply Android Studio) on a PC, connecting the device running droidVNC-NG to that PC and running
+`adb shell cmd appops set com.appknox.knoxvnc PROJECT_MEDIA allow` once.
+
+* You can also use adb to manually give input permission prior to app start via `adb shell settings put secure enabled_accessibility_services com.appknox.knoxvnc/.InputService:$(adb shell settings get secure enabled_accessibility_services)`.
+
+* If you are getting a black screen in a connected VNC viewer despite having given all permissions, it
+might be that your device does not support Android's MediaProjection API correctly. To find out, you can
+try screen recording with another app, [ScreenRecorder](https://gitlab.com/vijai/screenrecorder). If it
+fails as well, your device most likely does not support screen recording via MediaProjection. This is
+known to be the case for [Android-x86](https://www.android-x86.org).

app/.gitignore

@@ -0,0 +1 @@
+/build

app/build.gradle

@@ -0,0 +1,63 @@
+plugins {
+    id 'com.android.application'
+    id 'kotlin-android'
+    id 'org.jetbrains.kotlin.plugin.serialization' version "$kotlin_version"
+}
+
+android {
+    compileSdkVersion 34
+
+    defaultConfig {
+        applicationId "com.appknox.vnc"
+        minSdkVersion 24
+        targetSdkVersion 33
+        versionCode 28
+        versionName "2.1.7"
+
+        externalNativeBuild {
+            cmake {
+                // specify explicit target list to exclude examples, tests, utils. etc from used libraries
+                targets "turbojpeg-static", "vncserver", "vnc"
+            }
+        }
+
+        ndk {
+            debugSymbolLevel = 'FULL'
+        }
+
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+        }
+    }
+
+    externalNativeBuild {
+        cmake {
+            version '3.22.1'
+            path 'src/main/cpp/CMakeLists.txt'
+        }
+    }
+    namespace 'com.appknox.vnc'
+    // needed for Gradle 8.x w/ Kotlin 1.8.x
+    kotlinOptions {
+        jvmTarget = '1.8'
+    }
+}
+
+dependencies {
+    implementation 'androidx.appcompat:appcompat:1.6.1'
+    implementation 'androidx.preference:preference:1.2.1'
+    implementation "androidx.core:core:1.12.0"
+    implementation 'com.google.android.material:material:1.10.0'
+    testImplementation 'junit:junit:4.13.2'
+    androidTestImplementation 'androidx.test.ext:junit:1.1.5'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1'
+    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
+    implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:1.5.1"
+}
+repositories {
+    mavenCentral()
+}