Skip to content

Commit ed93fab

Browse files
authored
Merge pull request #24 from CoreTrace/feat/detectors
feat: security detectors and plugin models
2 parents 0e69eac + 9dccaeb commit ed93fab

23 files changed

Lines changed: 671 additions & 65 deletions

File tree

‎README.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,12 @@ coretrace-python-analyzer --check app.py --plugins plugins/ --format sarif > rep
3232
```
3333

3434
`--plugins` is a directory searched recursively for `plugin.toml` manifests and may be
35-
repeated. `--format` is `text` (default), `json` or `sarif`. Exit status is 0 when nothing
35+
repeated. The repository ships a first set under `plugins/`: standard-library security
36+
models (`models/python_stdlib`), taint detectors for SQL injection, command injection,
37+
path traversal, SSRF and XSS (`security/`), and syntactic detectors for `eval`/`exec`
38+
and weak hashes (`syntax/`). Model plugins contribute sources, sinks and sanitizers;
39+
detectors consume the shared taint result, so adding a framework model makes every
40+
detector aware of it. `--format` is `text` (default), `json` or `sarif`. Exit status is 0 when nothing
3641
was found, 1 when findings were reported, and 2 on a usage or analysis error.
3742

3843
## Emit PyIR
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name = "python-stdlib-models"
2+
version = "1.0.0"
3+
plugin_api = ">=1,<2"
4+
requires = []
5+
provides = ["model.python-stdlib"]
6+
7+
[entrypoint]
8+
module = "python_stdlib"
9+
class = "PythonStdlibModels"
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
"""Security models for the Python standard library (architecture §16)."""
2+
3+
from __future__ import annotations
4+
5+
from typing import ClassVar
6+
7+
from coretrace_python.plugins import ModelPlugin
8+
from coretrace_python.semantic.symbols import SymbolId
9+
from coretrace_python.taint import Model, Sanitizer, Sink, Source, TaintKind
10+
11+
12+
def _sym(path: str) -> SymbolId:
13+
return SymbolId(f"python.{path}")
14+
15+
16+
class PythonStdlibModels(ModelPlugin):
17+
name: ClassVar[str] = "python-stdlib-models"
18+
models: ClassVar[tuple[Model, ...]] = (
19+
Source(_sym("builtins.input"), "stdin"),
20+
Source(_sym("sys.stdin"), "stdin"),
21+
Source(_sym("sys.argv"), "argv"),
22+
Source(_sym("os.environ"), "environment"),
23+
Sink(_sym("os.system"), TaintKind.COMMAND),
24+
Sink(_sym("os.popen"), TaintKind.COMMAND),
25+
Sink(_sym("subprocess.run"), TaintKind.COMMAND),
26+
Sink(_sym("subprocess.call"), TaintKind.COMMAND),
27+
Sink(_sym("subprocess.check_call"), TaintKind.COMMAND),
28+
Sink(_sym("subprocess.check_output"), TaintKind.COMMAND),
29+
Sink(_sym("subprocess.Popen"), TaintKind.COMMAND),
30+
Sink(_sym("builtins.eval"), TaintKind.CODE),
31+
Sink(_sym("builtins.exec"), TaintKind.CODE),
32+
Sink(_sym("builtins.open"), TaintKind.PATH),
33+
Sink(_sym("os.remove"), TaintKind.PATH),
34+
Sink(_sym("os.unlink"), TaintKind.PATH),
35+
Sink(_sym("os.rmdir"), TaintKind.PATH),
36+
Sink(_sym("shutil.rmtree"), TaintKind.PATH),
37+
Sink(_sym("urllib.request.urlopen"), TaintKind.SSRF),
38+
Sanitizer(_sym("shlex.quote"), TaintKind.COMMAND),
39+
Sanitizer(_sym("html.escape"), TaintKind.HTML),
40+
Sanitizer(_sym("os.path.basename"), TaintKind.PATH),
41+
)
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
"""Command injection: attacker-controlled input reaching a COMMAND sink."""
2+
3+
from __future__ import annotations
4+
5+
from typing import ClassVar
6+
7+
from coretrace_python.findings import Severity
8+
from coretrace_python.plugins import TaintDetector
9+
from coretrace_python.taint import TaintKind
10+
11+
12+
class CommandInjectionPlugin(TaintDetector):
13+
name: ClassVar[str] = "command-injection"
14+
rule_id: ClassVar[str] = "command-injection"
15+
kind: ClassVar[TaintKind] = TaintKind.COMMAND
16+
severity: ClassVar[Severity] = Severity.HIGH
17+
title: ClassVar[str] = "Command injection"
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name = "command-injection"
2+
version = "1.0.0"
3+
plugin_api = ">=1,<2"
4+
requires = ["taint.flows"]
5+
provides = ["vulnerability.command-injection"]
6+
7+
[entrypoint]
8+
module = "command_injection"
9+
class = "CommandInjectionPlugin"
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
"""Path traversal: attacker-controlled input reaching a PATH sink."""
2+
3+
from __future__ import annotations
4+
5+
from typing import ClassVar
6+
7+
from coretrace_python.findings import Severity
8+
from coretrace_python.plugins import TaintDetector
9+
from coretrace_python.taint import TaintKind
10+
11+
12+
class PathTraversalPlugin(TaintDetector):
13+
name: ClassVar[str] = "path-traversal"
14+
rule_id: ClassVar[str] = "path-traversal"
15+
kind: ClassVar[TaintKind] = TaintKind.PATH
16+
severity: ClassVar[Severity] = Severity.HIGH
17+
title: ClassVar[str] = "Path traversal"
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name = "path-traversal"
2+
version = "1.0.0"
3+
plugin_api = ">=1,<2"
4+
requires = ["taint.flows"]
5+
provides = ["vulnerability.path-traversal"]
6+
7+
[entrypoint]
8+
module = "path_traversal"
9+
class = "PathTraversalPlugin"
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name = "sql-injection"
2+
version = "1.0.0"
3+
plugin_api = ">=1,<2"
4+
requires = ["taint.flows"]
5+
provides = ["vulnerability.sql-injection"]
6+
7+
[entrypoint]
8+
module = "sql_injection"
9+
class = "SqlInjectionPlugin"
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
"""SQL injection: attacker-controlled input reaching a SQL sink."""
2+
3+
from __future__ import annotations
4+
5+
from typing import ClassVar
6+
7+
from coretrace_python.findings import Severity
8+
from coretrace_python.plugins import TaintDetector
9+
from coretrace_python.taint import TaintKind
10+
11+
12+
class SqlInjectionPlugin(TaintDetector):
13+
name: ClassVar[str] = "sql-injection"
14+
rule_id: ClassVar[str] = "sql-injection"
15+
kind: ClassVar[TaintKind] = TaintKind.SQL
16+
severity: ClassVar[Severity] = Severity.HIGH
17+
title: ClassVar[str] = "SQL injection"

‎plugins/security/ssrf/plugin.toml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name = "ssrf"
2+
version = "1.0.0"
3+
plugin_api = ">=1,<2"
4+
requires = ["taint.flows"]
5+
provides = ["vulnerability.ssrf"]
6+
7+
[entrypoint]
8+
module = "ssrf"
9+
class = "SsrfPlugin"

0 commit comments

Comments
 (0)