eu.chainfire.libsuperuser

Class Shell.SU

java.lang.Object

eu.chainfire.libsuperuser.Shell.SU

Enclosing class:

Shell

public static class Shell.SU
extends java.lang.Object

This class provides utility functions to easily execute commands using SU (root shell), as well as detecting whether or not root is available, and if so which version.

Constructor Summary

Constructors

Constructor and Description
SU()

Method Summary

Modifier and Type	Method and Description
static boolean	available() Detects whether or not superuser access is available, by checking the output of the "id" command if available, checking if a shell runs at all otherwise
static void	clearCachedResults() Clears results cached by isSELinuxEnforcing() and version(boolean internal) calls.
static boolean	isSELinuxEnforcing() Detect if SELinux is set to enforcing, caches result
static boolean	isSU(java.lang.String shell) Attempts to deduce if the shell command refers to a su shell
static java.util.List<java.lang.String>	run(java.util.List<java.lang.String> commands) Runs commands as root (if available) and return output
static java.util.List<java.lang.String>	run(java.lang.String command) Runs command as root (if available) and return output
static java.util.List<java.lang.String>	run(java.lang.String[] commands) Runs commands as root (if available) and return output
static java.lang.String	shell(int uid, java.lang.String context) Constructs a shell command to start a su shell using the supplied uid and SELinux context.
static java.lang.String	shellMountMaster() Constructs a shell command to start a su shell connected to mount master daemon, to perform public mounts on Android 4.3+ (or 4.2+ in SELinux enforcing mode)
static java.lang.String	version(boolean internal) Detects the version of the su binary installed (if any), if supported by the binary.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SU

public SU()

Method Detail

run

public static java.util.List<java.lang.String> run(java.lang.String command)

Runs command as root (if available) and return output

Parameters:

command - The command to run

Returns:

Output of the command, or null if root isn't available or in case of an error

run

public static java.util.List<java.lang.String> run(java.util.List<java.lang.String> commands)

Runs commands as root (if available) and return output

Parameters:

commands - The commands to run

Returns:

Output of the commands, or null if root isn't available or in case of an error

run

public static java.util.List<java.lang.String> run(java.lang.String[] commands)

Runs commands as root (if available) and return output

Parameters:

commands - The commands to run

Returns:

Output of the commands, or null if root isn't available or in case of an error

available

public static boolean available()

Detects whether or not superuser access is available, by checking the output of the "id" command if available, checking if a shell runs at all otherwise

Returns:

True if superuser access available

version

public static java.lang.String version(boolean internal)

Detects the version of the su binary installed (if any), if supported by the binary. Most binaries support two different version numbers, the public version that is displayed to users, and an internal version number that is used for version number comparisons. Returns null if su not available or retrieving the version isn't supported.

Note that su binary version and GUI (APK) version can be completely different.

This function caches its result to improve performance on multiple calls

Parameters:

internal - Request human-readable version or application internal version

Returns:

String containing the su version or null

isSU

public static boolean isSU(java.lang.String shell)

Attempts to deduce if the shell command refers to a su shell

Parameters:

shell - Shell command to run

Returns:

Shell command appears to be su

shell

public static java.lang.String shell(int uid,
                                     java.lang.String context)

Constructs a shell command to start a su shell using the supplied uid and SELinux context. This is can be an expensive operation, consider caching the result.

Parameters:

uid - Uid to use (0 == root)

context - (SELinux) context name to use or null

Returns:

Shell command

shellMountMaster

public static java.lang.String shellMountMaster()

Constructs a shell command to start a su shell connected to mount master daemon, to perform public mounts on Android 4.3+ (or 4.2+ in SELinux enforcing mode)

Returns:

Shell command

isSELinuxEnforcing

public static boolean isSELinuxEnforcing()

Detect if SELinux is set to enforcing, caches result

Returns:

true if SELinux set to enforcing, or false in the case of permissive or not present

clearCachedResults

public static void clearCachedResults()

Clears results cached by isSELinuxEnforcing() and version(boolean internal) calls.

Most apps should never need to call this, as neither enforcing status nor su version is likely to change on a running device - though it is not impossible.