README.md

   1 ## Why another Superuser?
   2 * Superuser should be open source. It's the gateway to root on your device. It must be open for independent security analysis. Obscurity (closed source) is not security.
   3 * Superuser should be NDK buildable. No internal Android references.
   4 * Superuser should also be AOSP buildable for those that want to embed it in their ROM.
   5 * Superuser should also be AOSP _embeddable_, meaning a ROM can easily embed it into their Settings app.
   6 * Maintenance and updates on both the market and source repositories should be timely.
   7 * I want to be able to point users of my app to a Superuser solution that I wrote, that I know works, and that I can fix if something is wrong. Yes, this is selfish: Carbon does not work with some versions of Chainsdd's Superuser. SuperSU works great, but I am not comfortable pointing a user to a closed source su implementation.
   8 * Handle multiuser (4.2+) properly
   9 * Handle concurrent su requests properly
  10
  11 ## Checking out the source
  12
  13 You'll need the "Widgets" dependency.
  14
  15 * $ mkdir /path/to/src
  16 * $ cd /path/to/src
  17 * $ git clone git://github.com/koush/Superuser
  18 * $ git clone git://github.com/koush/Widgets
  19
  20 These repositories do not keep the actual projects in the top level directory.
  21 This is because they contain tests, libs, and samples.
  22
  23 ## Eclipse
  24
  25 In Eclipse, import Widgets/Widgets and Superuser/Superuser. It should Just Work (TM).
  26
  27 ## Ant
  28
  29 * $ mkdir /path/to/src
  30 * $ cd /path/to/src
  31 * $ cd Superuser/Superuser
  32
  33 In this directory, create a file called local.properties. This file is used by ant for custom properties. You need to specify the location of the ndk directory:
  34
  35 ```
  36 ndk.dir=/Users/koush/src/android-ndk
  37 ```
  38
  39 Then you can build:
  40
  41 * $ ant release
  42
  43 Outputs:
  44 * bin/update.zip - Recovery installable zip
  45 * bin/Superuser.apk - Superuser Android app
  46 * libs/armeabi/su - ARM su binary
  47 * libs/x86/su - x86 su binary
  48
  49 ## Building the su binary
  50
  51 You can use ant as shown above, to build the binary, but it can also be built without building the APK.
  52
  53 Make sure you have the android-ndk downloaded with the tool "ndk-build" in your path.
  54
  55 * $ cd /path/to/src/
  56 * $ cd Superuser/Superuser
  57 * $ ndk-build
  58
  59 The su binary will built into Superuser/Superuser/libs/armeabi/su.
  60
  61
  62
  63 ## Building with AOSP, CyanogenMod, etc
  64
  65 ROM developers are welcome to distribute the official Superuser APK and binary that I publish. That will
  66 allow them to receive updates with Google Play. However, you can also build Superuser as part of your
  67 build, if you choose to.
  68
  69 There are two ways to include Superuser in your build. The easiest is to build the APK as a separate app.
  70 To do that, simply add the local_manifest.xml as described below. The second way is by embedding it
  71 into the native Android System Settings.
  72
  73 #### Repo Setup
  74 Add the [local_manifest.xml](https://github.com/koush/Superuser/blob/master/local_manifest.xml) to your .repo/local_manifests
  75
  76 #### Configuring the Package Name
  77 The Superuser distributed on Google Play is in the package name com.koushikdutta.superuser.
  78 To prevent conflicts with the Play store version, the build process changes the package
  79 name to com.thirdparty.superuser. You can configure this value by setting the following
  80 in your vendor makefile or BoardConfig:
  81
  82 ```
  83 SUPERUSER_PACKAGE := com.mypackagename.superuser
  84 ```
  85
  86 #### Advanced - Embedding Superuser into System Settings
  87
  88 You will not need to change the package name as described above. Superuser will simply go
  89 into the com.android.settings package.
  90
  91 First, in a product makefile (like vendor/cm/config/common.mk), specify the following:
  92
  93 ```
  94 SUPERUSER_EMBEDDED := true
  95 ```
  96
  97 To modify packages/apps/Settings, you will need this [patch](http://review.cyanogenmod.org/#/c/32957/).
  98 The patch simply references the sources checked out to external/koush and makes changes
  99 to XML preference files and the AndroidManifest.xml. It is a very minimal change.
 100