From 0ccf804fb65842f36078832ca0cff6dd2d7be9f7 Mon Sep 17 00:00:00 2001 From: Arne Schwabe Date: Wed, 29 May 2013 21:53:38 +0200 Subject: Move files around --HG-- rename : LICENSE.txt => doc/LICENSE.txt rename : README.txt => doc/README.txt rename : todo.txt => doc/todo.txt rename : genFAQ.py => misc/genFAQ.py --- doc/LICENSE.txt | 21 ++++++++++++++++++++ doc/README.txt | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/todo.txt | 34 +++++++++++++++++++++++++++++++++ 3 files changed, 114 insertions(+) create mode 100644 doc/LICENSE.txt create mode 100644 doc/README.txt create mode 100644 doc/todo.txt (limited to 'doc') diff --git a/doc/LICENSE.txt b/doc/LICENSE.txt new file mode 100644 index 00000000..7836430f --- /dev/null +++ b/doc/LICENSE.txt @@ -0,0 +1,21 @@ +License for OpenVPN for Android. Please note that the thirdparty libraries/executables may have other license (OpenVPN, lzo, OpenSSL, Google Breakpad) + +Copyright (c) 2012-2013, Arne Schwabe + All rights reserved. + +If you need a non GPLv2 license of the source please contact me. + +This program is free software; you can redistribute it and/or +modify it under the terms of the GNU General Public License +as published by the Free Software Foundation; version 2 +of the License only. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + diff --git a/doc/README.txt b/doc/README.txt new file mode 100644 index 00000000..50424d14 --- /dev/null +++ b/doc/README.txt @@ -0,0 +1,59 @@ +This is my first Android project, so some things may be done in a completely stupid way. + +See the file todo.txt for ideas/not yet implemented features (and the bug tracker). + +Build instraction: + +Disable Google breakcode (WITH_BREAKPAD=0 in jni/Android.mk) or checkout google breakcode + +svn co http://google-breakpad.googlecode.com/svn/trunk/ google-breakpad + + +- Install sdk +- Install ndk (Version 8d gives strange linker errors, use 8b for now) +- Make sure that ndk-build is in your build path. + +Do ./build-native.(sh|bat) in the root directory of the project. +You may need to refresh the project and clean the project in eclipse + to have the libraries included the resulting apk. + +Use eclipse with android plugins to build the project. + + +FAQ + +Q: How is the OpenVPN version different from normal OpenVPN + +A: OpenVPN for Android uses a OpenVPN 2.3 master branch + Android patches + dual stack client patches. + A git repository of the OpenVPN source code and changes is under: + https://github.com/schwabe/openvpn/tree/android_2.3rc1%2Bds + +Q: what is minivpn? + +A: minivpn is only a executable thats links against libopenvpn which is the normal openvpn build as + library. It is done this way so the Android Play/Store apk will treat the library as normal library + and update it on updates of the application. Also the application does not need to take care of + keeping minivpn up to date because it contains no code. For almost all intents and purposes + minivpn + libopenvpn.so is the same as the normal openvpn binary + +Q: How to a VPN by name from an external app + +A: public class StartOpenVPNActivity extends Activity { + @Override + public void onCreate(Bundle savedInstanceState) { + super.onCreate(savedInstanceState); + setContentView(R.layout.main); + + final String EXTRA_NAME = "de.blinkt.openvpn.shortcutProfileName"; + + Intent shortcutIntent = new Intent(Intent.ACTION_MAIN); + shortcutIntent.setClassName("de.blinkt.openvpn", "de.blinkt.openvpn.LaunchVPN"); + shortcutIntent.putExtra(EXTRA_NAME,"upb ssl"); + startActivity(shortcutIntent); + } +} + +or from the shell: + +am start -a android.intent.action.MAIN -n de.blinkt.openvpn/.LaunchVPN -e de.blinkt.openvpn.shortcutProfileName Home + diff --git a/doc/todo.txt b/doc/todo.txt new file mode 100644 index 00000000..25b59a47 --- /dev/null +++ b/doc/todo.txt @@ -0,0 +1,34 @@ +Ideas: + +- Do cert+key+ca => p12 inside the app, import directly to keystore + +- general settings dialog + - encryption of profiles + +- Give the notification a nice speed bar + +- The app https://play.google.com/store/apps/details?id=org.proxydroid + has a nice feature: auto connect. Run a profile if a specified + network is available (a user defined WIFI profile and/or "WIFI/2G/3G" + and/or "WIFI" and/or "2G/3G" - selection of more than one network type + is possible) + +- Copy/Duplicate an existing profile (to create a new one with nearly + exact settings) + +- implement an encryption for profiles, so no sensitive data has be stored in plain text + - encrypt/decrypt with android private storage key (+no user input required) + + - hibernate when screen off and < 50 kB min + + +Missing configuration options: + +Tap support: +- Actually it is possible to emulate tap with tun device, a minimal implementation would have to do: + - generate random mac + - strip macs header on receive + - append mac header on send + - implement arp, possible the most difficult task ... + - need to chose right mac of receiver + -- cgit v1.2.3