MediaWiki  master
MediaWiki\Shell\FirejailCommand Class Reference

Restricts execution of shell commands using firejail. More...

Inheritance diagram for MediaWiki\Shell\FirejailCommand:
Collaboration diagram for MediaWiki\Shell\FirejailCommand:

Public Member Functions

 __construct ( $firejail)
 
 whitelistPaths (array $paths)
 
- Public Member Functions inherited from MediaWiki\Shell\Command
 __construct ()
 Don't call directly, instead use Shell::command() More...
 
 __destruct ()
 Makes sure the programmer didn't forget to execute the command after all. More...
 
 __toString ()
 Returns the final command line before environment/limiting, etc are applied. More...
 
 cgroup ( $cgroup)
 Sets cgroup for this command. More...
 
 environment (array $env)
 Sets environment variables which should be added to the executed command environment. More...
 
 execute ()
 Executes command. More...
 
 includeStderr ( $yesno=true)
 Controls whether stderr should be included in stdout, including errors from limit.sh. More...
 
 input ( $inputString)
 Sends the provided input to the command. More...
 
 limits (array $limits)
 Sets execution limits. More...
 
 logStderr ( $yesno=true)
 When enabled, text sent to stderr will be logged with a level of 'error'. More...
 
 params (... $args)
 Adds parameters to the command. More...
 
 profileMethod ( $method)
 Sets calling function for profiler. More...
 
 restrict ( $restrictions)
 Set additional restrictions for this request. More...
 
 unsafeParams (... $args)
 Adds unsafe parameters to the command. More...
 
 whitelistPaths (array $paths)
 If called, only the files/directories that are whitelisted will be available to the shell command. More...
 

Protected Member Functions

 buildFinalCommand ( $command)
 
- Protected Member Functions inherited from MediaWiki\Shell\Command
 buildFinalCommand ( $command)
 String together all the options and build the final command to execute. More...
 
 hasRestriction ( $restriction)
 Bitfield helper on whether a specific restriction is enabled. More...
 

Private Attributes

string $firejail
 Path to firejail. More...
 
string [] $whitelistedPaths = []
 

Additional Inherited Members

- Protected Attributes inherited from MediaWiki\Shell\Command
string $command = ''
 
int $restrictions = 0
 Bitfield with restrictions. More...
 

Detailed Description

Restricts execution of shell commands using firejail.

See also
https://firejail.wordpress.com/
Since
1.31

Definition at line 31 of file FirejailCommand.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Shell\FirejailCommand::__construct (   $firejail)
Parameters
string$firejailPath to firejail

Definition at line 46 of file FirejailCommand.php.

References MediaWiki\Shell\FirejailCommand\$firejail.

Member Function Documentation

◆ buildFinalCommand()

◆ whitelistPaths()

MediaWiki\Shell\FirejailCommand::whitelistPaths ( array  $paths)

Definition at line 54 of file FirejailCommand.php.

Member Data Documentation

◆ $firejail

string MediaWiki\Shell\FirejailCommand::$firejail
private

◆ $whitelistedPaths

string [] MediaWiki\Shell\FirejailCommand::$whitelistedPaths = []
private

Definition at line 41 of file FirejailCommand.php.


The documentation for this class was generated from the following file: