Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 4.43 KB

README.md

File metadata and controls

53 lines (37 loc) · 4.43 KB
Raw

JSON schemas for validating CACAO Security Playbooks

Note: In December 2023, Cyentific AS offered and transferred the content of this repository, meaning the CACAO JSON validation schemas, to the OASIS CACAO TC (https://github.com/oasis-open/cacao-json-schemas), which will be further maintained as an open-source product.

Deprecated

This repository contains JSON schemas for validating CACAO Security Playbooks. The JSON schemas provided are intended to follow the CACAO specification and its versions as specified by the OASIS CACAO Technical Committee.

In particular, JSON validation schemas for a specific version of CACAO are provided in different branches of this repository or can be accessed by pivoting from the table below.

CACAO Specification Version URL for JSON schemas Reference
Version 2.0 Committee Specification 01 https://github.com/cyentific-rni/cacao-json-schemas/tree/cacao-v2.0-cs01 CACAO Security Playbooks Version 2.0. Edited by Bret Jordan and Allan Thomson. 27 November 2023. OASIS Committee Specification 01. https://docs.oasis-open.org/cacao/security-playbooks/v2.0/cs01/security-playbooks-v2.0-cs01.html. Latest version: https://docs.oasis-open.org/cacao/security-playbooks/v2.0/security-playbooks-v2.0.html.
Version 2.0 Committee Specification Draft 03 https://github.com/cyentific-rni/cacao-json-schemas/tree/cacao-v2.0-csd03 CACAO Security Playbooks Version 2.0. Edited by Bret Jordan and Allan Thomson. 15 August 2023. OASIS Committee Specification Draft 03. https://docs.oasis-open.org/cacao/security-playbooks/v2.0/csd03/security-playbooks-v2.0-csd03.html. Latest version: https://docs.oasis-open.org/cacao/security-playbooks/v2.0/security-playbooks-v2.0.html.
Version 2.0 Committee Specification Draft 01 https://github.com/cyentific-rni/cacao-json-schemas/tree/cacao-v2.0-csd01 CACAO Security Playbooks Version 2.0. Edited by Bret Jordan and Allan Thomson. 21 February 2023. OASIS Committee Specification Draft 01. https://docs.oasis-open.org/cacao/security-playbooks/v2.0/csd01/security-playbooks-v2.0-csd01.html. Latest version: https://docs.oasis-open.org/cacao/security-playbooks/v2.0/security-playbooks-v2.0.html.
Version 1.0 Committee Specification 02 https://github.com/cyentific-rni/cacao-json-schemas/tree/cacao-v1.0-cs02 CACAO Security Playbooks Version 1.0. Edited by Bret Jordan and Allan Thomson. 23 June 2021. OASIS Committee Specification 02. https://docs.oasis-open.org/cacao/security-playbooks/v1.0/cs02/security-playbooks-v1.0-cs02.html. Latest stage: https://docs.oasis-open.org/cacao/security-playbooks/v1.0/security-playbooks-v1.0.html.

Validation Example with Python

The Python code below validates a CACAO playbook using the CACAO JSON schemas hosted in this repository. Specifically, the Python package "jsonschema" is used. For further details, please head to the official documentation. The example runs on Python version 3.11.

from jsonschema import validate, ValidationError, SchemaError
import requests
import json

# Reads CACAO JSON schemas from this repo (branch: cacao-v2.0-csd03).
url = "https://raw.githubusercontent.com/cyentific-rni/cacao-json-schemas/cacao-v2.0-csd03/schemas/playbook.json"
cacao_schema = requests.get(url).json()


# Read CACAO JSON from a local file
with open('./cacao_playbook.json') as file:
      cacao_json = json.load(file)

# Validate CACAO JSON with JSON schemas and look for errors.
try:
    validate(instance=cacao_json, schema=cacao_schema)
 
# Hits when the JSON schema itself contains error.
except SchemaError as schemaError:
    print("There is an error with the schema")
    print(schemaError)

# Hits when the CACAO JSON is not compliant with JSON schemas. 
# The error are appearing in chronological order one by one. 
except ValidationError as validationError:
    print(validationError)

For other packages and languages for validating JSON schemas, please head to the official documentation of json-schema.org -> implementations -> validators.