panic-attacker 1.0.1

Universal stress testing and logic-based bug signature detection
Documentation 
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

# panic-attacker JSON Output Schema

Version: 1.0 (stable as of v1.0.0)

## XRayReport

```json
{
  "program_path": "string (path)",
  "language": "string (rust|c|cpp|go|java|python|javascript|ruby|unknown)",
  "frameworks": ["string (webserver|database|messagequeue|cache|filesystem|networking|concurrent|unknown)"],
  "weak_points": [WeakPoint],
  "statistics": ProgramStatistics,
  "file_statistics": [FileStatistics],
  "recommended_attacks": ["string (cpu|memory|disk|network|concurrency|time)"]
}
```

## WeakPoint

```json
{
  "category": "string (uncheckedallocation|unboundedloop|blockingio|unsafecode|panicpath|racecondition|deadlockpotential|resourceleak)",
  "location": "string|null (file path)",
  "severity": "string (low|medium|high|critical)",
  "description": "string",
  "recommended_attack": ["string (cpu|memory|disk|network|concurrency|time)"]
}
```

## ProgramStatistics

```json
{
  "total_lines": "number",
  "unsafe_blocks": "number",
  "panic_sites": "number",
  "unwrap_calls": "number",
  "allocation_sites": "number",
  "io_operations": "number",
  "threading_constructs": "number"
}
```

## FileStatistics

```json
{
  "file_path": "string",
  "lines": "number",
  "unsafe_blocks": "number",
  "panic_sites": "number",
  "unwrap_calls": "number",
  "allocation_sites": "number",
  "io_operations": "number",
  "threading_constructs": "number"
}
```

## AssaultReport

```json
{
  "xray_report": XRayReport,
  "attack_results": [AttackResult],
  "total_crashes": "number",
  "total_signatures": "number",
  "overall_assessment": OverallAssessment
}
```

## AttackResult

```json
{
  "program": "string (path)",
  "axis": "string (cpu|memory|disk|network|concurrency|time)",
  "success": "boolean",
  "exit_code": "number|null",
  "duration": {"secs": "number", "nanos": "number"},
  "peak_memory": "number (bytes)",
  "crashes": [CrashReport],
  "signatures_detected": [BugSignature]
}
```

## CrashReport

```json
{
  "timestamp": "string (RFC3339)",
  "signal": "string|null",
  "backtrace": "string|null",
  "stderr": "string",
  "stdout": "string"
}
```

## BugSignature

```json
{
  "signature_type": "string (useafterfree|doublefree|memoryleak|deadlock|datarace|bufferoverflow|integeroverflow|nullpointerderef|unhandlederror)",
  "confidence": "number (0.0-1.0)",
  "evidence": ["string"],
  "location": "string|null"
}
```

## OverallAssessment

```json
{
  "robustness_score": "number (0.0-100.0)",
  "critical_issues": ["string"],
  "recommendations": ["string"]
}
```

## Version Compatibility

- **v0.1.0**: Initial schema (unstable)
- **v0.2.0**: Added `file_statistics` field to XRayReport, all locations guaranteed non-null
- **v1.0.0**: Schema stabilized, backwards-compatible changes only from here
- **Future**: New fields may be added, but existing fields will not change type or be removed

## Consuming the Schema

### Python

```python
import json

with open("xray-report.json") as f:
    report = json.load(f)

for wp in report["weak_points"]:
    print(f"{wp['severity']}: {wp['description']} @ {wp['location']}")
```

### Rust

```rust
use panic_attacker::types::XRayReport;

let json = std::fs::read_to_string("xray-report.json")?;
let report: XRayReport = serde_json::from_str(&json)?;

for wp in &report.weak_points {
    println!("{:?}: {} @ {:?}", wp.severity, wp.description, wp.location);
}
```

### JavaScript/TypeScript

```typescript
import * as fs from 'fs';

const report = JSON.parse(fs.readFileSync('xray-report.json', 'utf8'));

report.weak_points.forEach((wp: any) => {
  console.log(`${wp.severity}: ${wp.description} @ ${wp.location}`);
});
```

## Breaking Changes Policy

Starting with v1.0.0:
- **MAJOR version**: Breaking changes to schema (removed fields, changed types)
- **MINOR version**: Backwards-compatible additions (new fields, new enum values)
- **PATCH version**: No schema changes

## SPDX License

SPDX-License-Identifier: PMPL-1.0-or-later