Skip to content

Commit

Permalink
Get started with custom risk rules documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Yevhen Zavhorodnii committed Nov 11, 2024
1 parent e8e17ca commit 7bdf4b5
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/custom-risk-rules.md
Original file line number Diff line number Diff line change
@@ -1 +1,29 @@
# Custom risk rules

Highly likely this feature is under development and only available in [demo](../cmd/risk_demo/main.go).

Custom risk rule is defined in yaml or json and can be added to threagile via [config](./config.md) **THIS NEEDS TO BE CONFIRMED**.

Fields to describe risk can be found below

| Field | Type | Description |
|--------------------------------|---------------------------------|-------------|
| `id` | string | |
| `title` | string | |
| `description` | string | |
| `impact` | string | |
| `asvs` | string | |
| `cheat_sheet` | string | |
| `action` | string | |
| `mitigation` | string | |
| `check` | string | |
| `function` | string | |
| `stride` | string | |
| `detection_logic` | string | |
| `risk_assessment` | string | |
| `false_positives` | string | |
| `model_failure_possible_reason`| bool | |
| `cwe` | int | |
| `category` | string | |
| `supported-tags` | string | |
| `risk` | map[string]object | |

0 comments on commit 7bdf4b5

Please sign in to comment.