Updated through tag hostap_2_5 from git://w1.fi/hostap.git
[mech_eap.git] / libeap / wpadebug / README
1 wpadebug - wpa_supplicant and Wi-Fi debugging app for Android
2 Copyright (c) 2013, Jouni Malinen <j@w1.fi> and contributors
3 All Rights Reserved.
4
5 This program is licensed under the BSD license (the one with
6 advertisement clause removed). See the top level README for detailed
7 license text.
8
9 If you are submitting changes to the project, please see CONTRIBUTIONS
10 file for more instructions.
11
12
13 NOTE! This Android app is for debugging and testing purposes only. It is
14 not supposed to be installed on a production use device and doing so may
15 result in complete loss of security protections on the device.
16
17
18
19 Build
20 -----
21
22 - Install Android SDK and build tools
23 - update project target if desired; for example:
24   android list targets
25   android update project --target 1 --path $PWD
26 - run: ant debug
27
28
29 Installation (with adb over USB)
30 ------------
31
32 adb install bin/wpadebug-debug.apk
33
34 NOTE: Following steps enable any app on the system to get root access!
35 This is not suitable for any production use. This is needed for direct
36 wpa_supplicant access and some networking operating in general. You can
37 still use rest of the wpadebug app without doing this, but those
38 functions will not work unless this step part of installation is
39 done. It should be obvious that these steps require a rooted device. In
40 addition, if you do not understand what the following commands do,
41 please do not run them.
42
43 adb root
44 adb remount
45 adb shell cp /system/bin/mksh /system/bin/mksh-su
46 adb shell chmod 6755 /system/bin/mksh-su
47
48 Optionally, a text file with a set of command can be installed to allow
49 arbitrary shell commands to be executed. This text file need to be in
50 /data/local/wpadebug.cmds and use title@command format per line. For
51 example:
52 version@cat /proc/version
53
54 Similarly, /data/local/wpadebug.wpacmds can be used to define additional
55 wpa_supplicant control interface commands.
56
57
58 Uninstallation
59 --------------
60
61 adb root
62 adb remount
63 adb shell rm /system/bin/mksh-su
64
65 adb uninstall w1.fi.wpadebug