penetration-test-report-schema.json

{
    "$schema": "http://json-schema.org/draft-06/schema#",
    "$id": "https://github.com/s-spindler/ptrs/blob/main/penetration-test-report-schema.json",
    "title": "Penetration Test Report Schema (ptrs)",
    "description": "",
    "type": "object",
    "properties": {
        "schemaVersion": {
            "type": "string",
            "$comment": "This pattern covers any valid semver version and is taken from the semver page:\nhttps://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string",
            "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
        },
        "provider": {
            "$ref": "#/$defs/provider"
        },
        "recipient": {
            "$ref": "#/$defs/recipient"
        },
        "findings": {
            "type": "array",
            "items": {
                "$ref": "https://github.com/s-spindler/ptrs/blob/main/penetration-test-finding-schema.json"
            }
        },
        "introduction": {
            "type": "string"
        },
        "scope": {
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "conclusion": {
            "type": "string"
        }
    },
    "required": [
        "schemaVersion",
        "provider",
        "recipient"
    ],
    "additionalProperties": false,
    "$defs": {
        "organization": {
            "type": "object",
            "properties": {
                "name": {
                    "type": "string"
                }
            }
        },
        "provider": {
            "type": "object",
            "properties": {
                "organization": {
                    "$ref": "#/$defs/organization"
                },
                "testers": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                }
            }
        },
        "recipient": {
            "type": "object",
            "properties": {
                "organization": {
                    "$ref": "#/$defs/organization"
                }
            }
        }
    }
}