references/formats.md
SARIF and weAudit Format Reference
SARIF 2.1.0
SARIF (Static Analysis Results Interchange Format) is an OASIS standard for encoding static analysis results as JSON.
Structure Used by Trailmark
sarifLog
├── version: "2.1.0"
└── runs[]
├── tool.driver.name → source field ("sarif:<name>")
└── results[]
├── ruleId → included in description
├── message.text → included in description
├── level → "error" | "warning" | "note"
└── locations[]
└── physicalLocation
├── artifactLocation.uri → matched to node file
└── region
├── startLine → matched to node lines
└── endLine → matched to node lines
Level Values
| Level | Subgraph |
|-------|----------|
| error | sarif:error |
| warning (default) | sarif:warning |
| note | sarif:note |
Example SARIF Result
{
"ruleId": "python.lang.security.audit.exec-detected",
"level": "warning",
"message": {"text": "Detected use of exec()"},
"locations": [{
"physicalLocation": {
"artifactLocation": {"uri": "src/handler.py"},
"region": {"startLine": 42, "endLine": 42}
}
}]
}
weAudit
weAudit is a VSCode extension by Trail of Bits for collaborative security
auditing. Files are stored as .vscode/<username>.weaudit.
Structure Used by Trailmark
root
├── clientRemote → fallback author extraction
├── treeEntries[] → active findings/notes
│ ├── label → included in description
│ ├── entryType → 0=Finding, 1=Note
│ ├── author → source field ("weaudit:<author>")
│ ├── details
│ │ ├── severity → "High" | "Medium" | "Low" | "Informational"
│ │ ├── type → finding category
│ │ └── description → included in annotation
│ └── locations[]
│ ├── path → relative to git root
│ ├── startLine → 0-indexed (converted to 1-indexed)
│ └── endLine → 0-indexed (converted to 1-indexed)
└── resolvedEntries[] → same structure as treeEntries
Entry Types
| entryType | AnnotationKind | Subgraph |
|-----------|---------------|----------|
| 0 (Finding) | finding | weaudit:findings |
| 1 (Note) | audit_note | weaudit:notes |
Severity Values
| Severity | Subgraph |
|----------|----------|
| High | weaudit:high |
| Medium | weaudit:medium |
| Low | weaudit:low |
| Informational | weaudit:informational |
Example weAudit Entry
{
"label": "SQL Injection in user input",
"entryType": 0,
"author": "alice",
"details": {
"severity": "High",
"difficulty": "Low",
"type": "Data Validation",
"description": "User input not sanitized before SQL query.",
"exploit": "Attacker injects malicious SQL.",
"recommendation": "Use parameterized queries."
},
"locations": [{
"path": "src/database/queries.py",
"startLine": 41,
"endLine": 44,
"label": "executeQuery function",
"description": ""
}]
}
Line Indexing
weAudit uses 0-indexed line numbers. Trailmark uses 1-indexed (from
tree-sitter). The augmentation module adds 1 to both startLine and endLine
during conversion.