Repository navigation
Expand file tree
/
Copy pathengine.py
More file actions
309 lines (264 loc) · 10.8 KB
/
Copy pathengine.py
File metadata and controls
309 lines (264 loc) · 10.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
"""Composition root: the full analysis DAG, plugin loading and one check run.
This is the only module that knows every layer. The CLI and future hosts call it;
plugins and analyses never import it.
"""
from __future__ import annotations
from collections.abc import Iterable, Sequence
from dataclasses import dataclass, field
from pathlib import Path
from typing import ClassVar
from coretrace_python import __version__
from coretrace_python.abstract import ConstantPropagation
from coretrace_python.analysis import (
AnalysisContext,
AnalysisManager,
AnyAnalysis,
TransformationPass,
)
from coretrace_python.cfg import CFGAnalysis, CFGError, DominanceAnalysis, PostDominanceAnalysis
from coretrace_python.dependency import (
DEPENDENCY_FILES,
DependencyAnalysis,
DependencyGraph,
parse_dependencies,
)
from coretrace_python.dependency.correlation import advisory_sinks, affected_symbols, correlate
from coretrace_python.findings import Confidence, Finding, Severity
from coretrace_python.findings.refutation import RefutationAnalysis
from coretrace_python.frontend import HIRBuildError, ParseError, build_hir
from coretrace_python.hir import nodes
from coretrace_python.interprocedural import (
CallGraphAnalysis,
FunctionSummary,
ModuleGraph,
ProjectSummaries,
SummaryAnalysis,
SummaryIndex,
build_module_graph,
discover_sources,
project_symbol,
)
from coretrace_python.ir.defuse import DefUseAnalysis
from coretrace_python.ir.lowering import (
LoweringError,
ModuleIRAnalysis,
PyIRAnalysis,
analyzable_functions,
)
from coretrace_python.ir.ssa import SSAAnalysis
from coretrace_python.plugins import (
Plugin,
PluginRegistry,
ProjectContext,
ProjectPlugin,
discover_plugins,
run_plugins,
)
from coretrace_python.reporters import Report
from coretrace_python.semantic import SEMANTIC_ANALYSES
from coretrace_python.semantic.imports import ImportAnalysis, ImportResolutionError, ImportTable
from coretrace_python.semantic.scopes import ScopeError
from coretrace_python.source import SourceFile, SourceManager, SourceSpan
from coretrace_python.taint import (
ModelTable,
SecurityModelAnalysis,
SecurityModelRegistry,
TaintAnalysis,
)
TOOL_NAME = "coretrace-python-analyzer"
ALL_ANALYSES: tuple[AnyAnalysis, ...] = (
*SEMANTIC_ANALYSES,
CFGAnalysis,
DominanceAnalysis,
PostDominanceAnalysis,
PyIRAnalysis,
ModuleIRAnalysis,
SSAAnalysis,
DefUseAnalysis,
ConstantPropagation,
CallGraphAnalysis,
SummaryAnalysis,
ProjectSummaries,
SecurityModelAnalysis,
TaintAnalysis,
RefutationAnalysis,
DependencyAnalysis,
)
# Named so the set stays right whichever analyses a build registers.
_PROJECT_DEPENDANT_NAMES = frozenset(
{"interprocedural.project", "interprocedural.summaries", "taint.flows", "findings.refutation"}
)
_PROJECT_DEPENDANTS: frozenset[AnyAnalysis] = frozenset(
a for a in ALL_ANALYSES if a.name in _PROJECT_DEPENDANT_NAMES
)
MAX_PROJECT_ITERATIONS = 20
class ProjectSummariesUpdated(TransformationPass):
"""Invalidates every result that depends on the project-wide summary index."""
name: ClassVar[str] = "project.summaries-updated"
preserves: ClassVar[frozenset[AnyAnalysis]] = frozenset(
a for a in ALL_ANALYSES if a not in _PROJECT_DEPENDANTS
)
@classmethod
def run(cls, ctx: AnalysisContext) -> None:
pass
@dataclass(frozen=True)
class ProjectAnalysis:
graph: ModuleGraph
index: SummaryIndex
findings: tuple[Finding, ...]
dependencies: DependencyGraph = field(default_factory=DependencyGraph)
def build_manager(
module: nodes.Module, models: SecurityModelRegistry | None = None
) -> AnalysisManager:
"""A manager with every engine analysis registered and the engine inputs provided."""
manager = _register_all(module)
manager.provide(SecurityModelAnalysis, (models or SecurityModelRegistry()).freeze())
manager.provide(ProjectSummaries, SummaryIndex())
return manager
def load_plugins(plugin_roots: Sequence[Path], manager: AnalysisManager) -> PluginRegistry:
registry = PluginRegistry()
for root in plugin_roots:
for loaded in discover_plugins(root, manager):
registry.add(loaded)
return registry
def plugin_models(plugins: Iterable[Plugin]) -> ModelTable:
models = SecurityModelRegistry()
for plugin in plugins:
models.register(*plugin.models)
return models.freeze()
def check(source: SourceFile, plugin_roots: Sequence[Path]) -> tuple[Finding, ...]:
"""Run every plugin found under ``plugin_roots`` against one file."""
manager = _register_all(build_hir(source))
registry = load_plugins(plugin_roots, manager)
manager.provide(SecurityModelAnalysis, plugin_models(loaded.plugin for loaded in registry))
manager.provide(ProjectSummaries, SummaryIndex())
return _check_module(manager, tuple(loaded.plugin for loaded in registry))[0]
def resolve_dependencies(root: Path, sources: SourceManager) -> DependencyGraph:
"""The requirements declared or pinned by the dependency files at ``root`` (§26)."""
graph = DependencyGraph()
candidates = sorted(root.glob("requirements*.txt")) + [root / name for name in DEPENDENCY_FILES]
for path in candidates:
if path.is_file():
graph = graph.merge(parse_dependencies(sources.load_file(path)))
return graph
def analyze_project(
root: Path, plugin_roots: Sequence[Path] = (), plugins: Sequence[Plugin] = ()
) -> ProjectAnalysis:
"""Analyse every Python file under ``root`` with a shared summary index (§21) and the
dependency graph of its manifests (§26). ``plugins`` adds plugin instances to the
ones discovered under ``plugin_roots``."""
sources = SourceManager()
findings: list[Finding] = []
dependencies = resolve_dependencies(root, sources)
for error in dependencies.errors:
findings.append(_note("syntax-error", error, sources.add_source(error.split(":")[0], ""), 1))
modules: dict[str, nodes.Module] = {}
files: dict[str, SourceFile] = {}
for source in discover_sources(root, sources):
try:
modules[source.module_name] = build_hir(source)
except (ParseError, HIRBuildError) as error:
findings.append(_note("syntax-error", str(error), source, 1))
continue
files[source.module_name] = source
managers = {name: _register_all(module) for name, module in modules.items()}
probe = next(iter(managers.values()), None) or _register_all(build_hir(sources.add_source("<empty>", "")))
registry = load_plugins(plugin_roots, probe)
all_plugins: tuple[Plugin, ...] = (*(loaded.plugin for loaded in registry), *plugins)
advisories = tuple(a for plugin in all_plugins for a in plugin.advisories)
affected = affected_symbols(dependencies, advisories)
models = plugin_models(all_plugins).extended(*advisory_sinks(affected))
index = SummaryIndex()
for manager in managers.values():
manager.provide(SecurityModelAnalysis, models)
manager.provide(ProjectSummaries, index)
manager.provide(DependencyAnalysis, dependencies)
imports: dict[str, ImportTable] = {}
analysable: dict[str, AnalysisManager] = {}
for name, manager in managers.items():
try:
imports[name] = manager.get(ImportAnalysis)
except (ImportResolutionError, ScopeError) as error:
findings.append(_note("syntax-error", str(error), files[name], 1))
continue
analysable[name] = manager
graph = build_module_graph(
{name: files[name] for name in analysable}, {name: modules[name] for name in analysable}, imports
)
for _ in range(MAX_PROJECT_ITERATIONS):
updated = SummaryIndex(
{
project_symbol(name, function): summary
for name, manager in analysable.items()
for function, summary in _summaries_of(manager).items()
}
)
if updated == index:
break
index = updated
for manager in analysable.values():
manager.run(ProjectSummariesUpdated)
manager.provide(ProjectSummaries, index)
module_plugins = tuple(p for p in all_plugins if not isinstance(p, ProjectPlugin))
for name in sorted(analysable):
manager = analysable[name]
module_findings, supported = _check_module(manager, module_plugins)
findings.extend(module_findings)
if affected:
graph_of_module = manager.get(CallGraphAnalysis)
for function in supported:
findings.extend(
correlate(
graph_of_module.name_of(function),
manager.get(TaintAnalysis, function).flows,
manager.get(RefutationAnalysis, function),
affected,
)
)
context = ProjectContext(graph, dependencies, advisories, analysable)
for plugin in all_plugins:
if isinstance(plugin, ProjectPlugin):
findings.extend(plugin.analyze_project(context))
return ProjectAnalysis(graph, index, tuple(findings), dependencies)
def _summaries_of(manager: AnalysisManager) -> dict[str, FunctionSummary]:
table = manager.get(SummaryAnalysis)
return {name: table.summary(name) for name in table.names}
def _check_module(
manager: AnalysisManager, plugins: tuple[Plugin, ...]
) -> tuple[tuple[Finding, ...], tuple[nodes.Function, ...]]:
"""Findings of the module plugins plus notes for unsupported functions, and the
functions that could be analysed."""
supported: list[nodes.Function] = []
notes: list[Finding] = []
for function in analyzable_functions(manager.module):
try:
manager.get(SSAAnalysis, function)
except (LoweringError, CFGError) as error:
notes.append(
Finding(
rule_id="unsupported-syntax",
message=str(error),
severity=Severity.INFO,
confidence=Confidence.HIGH,
span=function.span,
function=function.name,
)
)
else:
supported.append(function)
findings = run_plugins(manager, plugins, tuple(supported))
return (*findings, *notes), tuple(supported)
def _note(rule_id: str, message: str, source: SourceFile, line: int) -> Finding:
return Finding(
rule_id=rule_id,
message=message,
severity=Severity.INFO,
confidence=Confidence.HIGH,
span=SourceSpan(source.source_id, line, 1),
)
def _register_all(module: nodes.Module) -> AnalysisManager:
manager = AnalysisManager(module)
manager.register(*ALL_ANALYSES)
return manager
def report(findings: Sequence[Finding]) -> Report:
return Report(tuple(findings), TOOL_NAME, __version__)