Package io.github.pixee.security

Class SystemCommand

java.lang.Object

io.github.pixee.security.SystemCommand

public final class SystemCommand
extends Object

This type offers utility methods to run system commands more safely.

Method Summary

Modifier and Type	Method	Description
static Set<SystemCommandRestrictions>	defaultRestrictions()	The default restrictions if none are specified.
static Process	runCommand(Runtime runtime, String command)	Delegates to runCommand(Runtime, String, Set) with default restrictions.
static Process	runCommand(Runtime runtime, String[] command)	Delegates to runCommand(Runtime, String[], Set) with default restrictions.
static Process	runCommand(Runtime runtime, String[] command, String[] envp)	Delegates to runCommand(Runtime, String[], String[], Set) with default restrictions.
static Process	runCommand(Runtime runtime, String[] command, String[] envp, File dir)	Delegates to runCommand(Runtime, String[], String[], File, Set) with default restrictions.
static Process	runCommand(Runtime runtime, String[] command, String[] envp, File dir, Set<SystemCommandRestrictions> restrictions)	Same as runCommand(Runtime, String[], Set) but also include more data to pass into Runtime.exec(String[], String[], File).
static Process	runCommand(Runtime runtime, String[] command, String[] envp, Set<SystemCommandRestrictions> restrictions)	Same as runCommand(Runtime, String[], Set) but also include more data to pass into Runtime.exec(String[], String[]).
static Process	runCommand(Runtime runtime, String[] command, Set<SystemCommandRestrictions> restrictions)	Does the same as Runtime.exec(String[]), but adds restrictions on what types of commands will be allowed.
static Process	runCommand(Runtime runtime, String command, String[] envp)	Delegates to runCommand(Runtime, String, String[], Set) with default restrictions.
static Process	runCommand(Runtime runtime, String command, String[] envp, File dir)	Delegates to runCommand(Runtime, String, String[], File, Set) with default restrictions.
static Process	runCommand(Runtime runtime, String command, String[] envp, File dir, Set<SystemCommandRestrictions> restrictions)	Same as runCommand(Runtime, String, Set) but also include more data to pass into Runtime.exec(String, String[], File).
static Process	runCommand(Runtime runtime, String command, String[] envp, Set<SystemCommandRestrictions> restrictions)	Same as runCommand(Runtime, String, Set) but also include more data to pass into Runtime.exec(String, String[]).
static Process	runCommand(Runtime runtime, String command, Set<SystemCommandRestrictions> restrictions)	Does the same as Runtime.exec(String), but adds restrictions on what types of commands will be allowed.

Methods inherited from class java.lang.Object

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

Method Detail

defaultRestrictions

public static Set<SystemCommandRestrictions> defaultRestrictions()

The default restrictions if none are specified.

Returns:

a set of restrictions suitable for general use

runCommand

public static Process runCommand(Runtime runtime,
                                 String command,
                                 Set<SystemCommandRestrictions> restrictions)
                          throws IOException

Does the same as Runtime.exec(String), but adds restrictions on what types of commands will be allowed. Will throw a SecurityException if any of the restrictions may be violated by the command found. Note that the method of detecting violations is based on semantic analysis of the command, and so is vulnerable to impedance mismatches between the analysis we perform and whatever shell is interpreting the command. Either way, it's a lot safer.

Parameters:

command - the system command about to be run

runtime - the runtime to run with

restrictions - the set of restrictions to run with

Returns:

the Process that results from the hardened Runtime.exec(String) call

Throws:

SecurityException - if multiple commands are found

IllegalArgumentException - if restriction is null

IOException - from the wrapped system process invocation call

runCommand

public static Process runCommand(Runtime runtime,
                                 String command)
                          throws IOException

Delegates to runCommand(Runtime, String, Set) with default restrictions.

Parameters:

runtime - the runtime to run with

command - the system command about to be run

Returns:

the Process that results from the hardened Runtime.exec(String) call

Throws:

IOException - from the wrapped system process invocation call

runCommand

public static Process runCommand(Runtime runtime,
                                 String[] command,
                                 Set<SystemCommandRestrictions> restrictions)
                          throws IOException

Does the same as Runtime.exec(String[]), but adds restrictions on what types of commands will be allowed. Will throw a SecurityException if any of the restrictions may be violated by the command found. Note that the method of detecting violations is based on semantic analysis of the command, and so is vulnerable to impedance mismatches between the analysis we perform and whatever shell is interpreting the command. Either way, it's a lot safer.

Parameters:

command - the system command about to be run

runtime - the runtime to run with

restrictions - the set of restrictions to run with

Returns:

the Process that results from the hardened Runtime.exec(String[]) call

Throws:

SecurityException - if multiple commands are found

IllegalArgumentException - if restriction is null

IOException - from the wrapped system process invocation call

runCommand

public static Process runCommand(Runtime runtime,
                                 String[] command)
                          throws IOException

Delegates to runCommand(Runtime, String[], Set) with default restrictions.

Parameters:

runtime - the runtime to run with

command - the system command about to be run

Returns:

the Process that results from the hardened Runtime.exec(String[]) call

Throws:

IOException - from the wrapped system process invocation call

runCommand

public static Process runCommand(Runtime runtime,
                                 String[] command,
                                 String[] envp,
                                 Set<SystemCommandRestrictions> restrictions)
                          throws IOException

Same as runCommand(Runtime, String[], Set) but also include more data to pass into Runtime.exec(String[], String[]).

Parameters:

runtime - the runtime to run with

command - the system command about to be run

envp - the environment variables

restrictions - the set of restrictions to run with

Returns:

the Process that results from the hardened Runtime.exec(String[]) call

Throws:

SecurityException - if multiple commands are found

IllegalArgumentException - if restriction is null

IOException - from the wrapped system process invocation call

runCommand

public static Process runCommand(Runtime runtime,
                                 String[] command,
                                 String[] envp)
                          throws IOException

Delegates to runCommand(Runtime, String[], String[], Set) with default restrictions.

Parameters:

runtime - the runtime to run with

command - the system command about to be run

envp - the environment variables

Returns:

the Process that results from the hardened Runtime.exec(String[], String[]) call

Throws:

IOException - from the wrapped system process invocation call

runCommand

public static Process runCommand(Runtime runtime,
                                 String[] command,
                                 String[] envp,
                                 File dir,
                                 Set<SystemCommandRestrictions> restrictions)
                          throws IOException

Same as runCommand(Runtime, String[], Set) but also include more data to pass into Runtime.exec(String[], String[], File).

Parameters:

runtime - the runtime to run with

command - the system command about to be run

envp - the environment variables

dir - the working directory to run the system command in

restrictions - the set of restrictions to run with

Returns:

the Process that results from the hardened Runtime.exec(String[], String[], File) call

Throws:

IOException - from the wrapped system process invocation call

runCommand

public static Process runCommand(Runtime runtime,
                                 String command,
                                 String[] envp,
                                 Set<SystemCommandRestrictions> restrictions)
                          throws IOException

Same as runCommand(Runtime, String, Set) but also include more data to pass into Runtime.exec(String, String[]).

Parameters:

runtime - the runtime to run with

command - the system command about to be run

envp - the environment variables

restrictions - the set of restrictions to run with

Returns:

the Process that results from the hardened Runtime.exec(String, String[]) call

Throws:

IOException - from the wrapped system process invocation call

runCommand

public static Process runCommand(Runtime runtime,
                                 String command,
                                 String[] envp)
                          throws IOException

Delegates to runCommand(Runtime, String, String[], Set) with default restrictions.

Parameters:

runtime - the runtime to run with

command - the system command about to be run

envp - the environment variables

Returns:

the Process that results from the hardened Runtime.exec(String, String[]) call

Throws:

IOException - from the wrapped system process invocation call

runCommand

public static Process runCommand(Runtime runtime,
                                 String command,
                                 String[] envp,
                                 File dir,
                                 Set<SystemCommandRestrictions> restrictions)
                          throws IOException

Same as runCommand(Runtime, String, Set) but also include more data to pass into Runtime.exec(String, String[], File).

Parameters:

runtime - the runtime to run with

command - the system command about to be run

envp - the environment variables

dir - the working directory to run the system command in

restrictions - the set of restrictions to run with

Returns:

the Process that results from the hardened Runtime.exec(String, String[], File) call

Throws:

IOException - from the wrapped system process invocation call

runCommand

public static Process runCommand(Runtime runtime,
                                 String command,
                                 String[] envp,
                                 File dir)
                          throws IOException

Delegates to runCommand(Runtime, String, String[], File, Set) with default restrictions.

Parameters:

runtime - the runtime to run with

command - the system command about to be run

envp - the environment variables

dir - the working directory to run the system command in

Returns:

the Process that results from the hardened Runtime.exec(String, String[], File) call

Throws:

IOException - from the wrapped system process invocation call

runCommand

public static Process runCommand(Runtime runtime,
                                 String[] command,
                                 String[] envp,
                                 File dir)
                          throws IOException

Delegates to runCommand(Runtime, String[], String[], File, Set) with default restrictions.

Parameters:

runtime - the runtime to run with

command - the system command about to be run

envp - the environment variables

dir - the working directory to run the system command in

Returns:

the Process that results from the hardened Runtime.exec(String[], String[], File) call

Throws:

IOException - from the wrapped system process invocation call