Skip to content

Commit 804abd9

Browse files
authored
Merge pull request #32 from angelej/document-supported-sinks
Update README.md documentation
2 parents 8eadec9 + ca7fad3 commit 804abd9

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

Diff for: README.md

+36-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
PHP-Insider is a static application security testing tool (SAST), which is specialized in finding dangerous sinks.
33
It's not designed to be a fully-automated tool for identifying vulnerabilities, but rather an aid for analysts finding them.
44

5-
## Basic usage
5+
> **Warning!** This repository is currently under development and may contain breaking changes.
6+
7+
## Basic Usage
68
```shell
79
insider@linux:~$ ./bin/insider analyse src/
810
ExecSink found in file src/Command.php › Ⓒ Command › ⓜ execute
@@ -16,10 +18,42 @@ insider@linux:~$ ./bin/insider analyse src/
1618
Summary: 1 sink found
1719
```
1820

21+
## Supported Sinks
22+
### Code Execution
23+
- [`` `backtick` ``](https://www.php.net/manual/en/language.operators.execution)
24+
- [`eval()`](https://www.php.net/manual/en/function.eval)
25+
- [`exec()`](https://www.php.net/manual/en/function.exec)
26+
- [`passthru()`](https://www.php.net/manual/en/function.passthru)
27+
- [`pcntl_exec()`](https://www.php.net/manual/en/function.pcntl-exec)
28+
- [`popen()`](https://www.php.net/manual/en/function.popen)
29+
- [`proc_open()`](https://www.php.net/manual/en/function.proc-open)
30+
- [`shell_exec()`](https://www.php.net/manual/en/function.shell-exec)
31+
- [`system()`](https://www.php.net/manual/en/function.system)
32+
33+
### File Inclusion
34+
- [`include()`](https://www.php.net/manual/en/function.include)
35+
- [`include_once()`](https://www.php.net/manual/en/function.include-once)
36+
- [`require()`](https://www.php.net/manual/en/function.require)
37+
- [`require_once()`](https://www.php.net/manual/en/function.require-once)
38+
39+
### File Read
40+
- [`file_get_contents()`](https://www.php.net/manual/en/function.file-get-contents)
41+
- [`file()`](https://www.php.net/manual/en/function.file)
42+
- [`readfile()`](https://www.php.net/manual/en/function.readfile)
43+
44+
### File Write
45+
- [`copy()`](https://www.php.net/manual/en/function.copy)
46+
- [`file_put_contents()`](https://www.php.net/manual/en/function.file-put-contents)
47+
48+
### Information Disclosure
49+
- [`phpinfo()`](https://www.php.net/manual/en/function.phpinfo)
50+
51+
<br/>
52+
1953
## Testing
2054
```shell
2155
composer test
2256
```
2357

2458
## Security Vulnerabilities
25-
If you discovered a security vulnerability, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.
59+
If you discovered a security vulnerability, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

0 commit comments

Comments
 (0)