Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add:misconfig spec #12

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 34 additions & 1 deletion data/spec/misconfig.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,36 @@
# Data spec for misconfig

TBD
## Mime type

application/vnd.security.misconfig.report; version=1.0

## Report data model

-> described by json schema

```
{
"title": "misconfig report",
"type": "object",
"properties": {
"config_name": {
"description": "The config name which being analysed",
"type": "string"
},
"value": {
"description": "The config's value",
"type": "string"
},
"risk_level": {
"type": "integer",
"minimum": 0,
"maximum": 3,
"description": "The risk level of config value. 0 means safe, 1 means low risk level, 2 means middle risk level, 3 means high risk level"
},
"suggestion": {
"description": "Describe why config's value has riks and provide config suggestion",
"type": "string"
}
}
}
```