json-kit

json-kit is a Python 3 package for working with JSON files.

Features

One of the main features of json-kit is the ability to visualize the structure of JSON files as directed graphs with NetworkX and GraphViz.

This is useful when writing parsers, or when simply trying to better understand the structure of a given JSON file.

For example, we can visualize the structure of the CISA Known Exploited Vulnerabilities (KEV) Catalog as follows:

Comparatively, the JSON Schema can be visualized as follows:

Usage

• json-kit
  • Features
  • Usage
    • Command line
      • List keys in a JSON file
      • Generate a JSON Schema from a JSON file
      • Visualize JSON files as directed graphs with GraphViz

Command line

List keys in a JSON file

To list the keys in a particular JSON file:

poetry run json-kit keys examples/cisa-kev/known_exploited_vulnerabilities.json

catalogVersion
count
dateReleased
title
vulnerabilities[]
vulnerabilities[].cveID
vulnerabilities[].dateAdded
vulnerabilities[].dueDate
vulnerabilities[].knownRansomwareCampaignUse
vulnerabilities[].notes
vulnerabilities[].product
vulnerabilities[].requiredAction
vulnerabilities[].shortDescription
vulnerabilities[].vendorProject
vulnerabilities[].vulnerabilityName

Generate a JSON Schema from a JSON file

To generate a JSON Schema from a JSON file:

poetry run json-kit json-schema examples/cisa-kev/known_exploited_vulnerabilities.json

{
    "$schema": "http://json-schema.org/schema#",
    "type": "object",
    "properties": {
        "title": {
            "type": "string"
        },
        "catalogVersion": {
            "type": "string"
        },
        "dateReleased": {
            "type": "string"
        },
        "count": {
            "type": "integer"
        },
        "vulnerabilities": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "cveID": {
                        "type": "string"
                    },
                    "vendorProject": {
                        "type": "string"
                    },
                    "product": {
                        "type": "string"
                    },
                    "vulnerabilityName": {
                        "type": "string"
                    },
                    "dateAdded": {
                        "type": "string"
                    },
                    "shortDescription": {
                        "type": "string"
                    },
                    "requiredAction": {
                        "type": "string"
                    },
                    "dueDate": {
                        "type": "string"
                    },
                    "knownRansomwareCampaignUse": {
                        "type": "string"
                    },
                    "notes": {
                        "type": "string"
                    }
                },
                "required": [
                    "cveID",
                    "dateAdded",
                    "dueDate",
                    "knownRansomwareCampaignUse",
                    "notes",
                    "product",
                    "requiredAction",
                    "shortDescription",
                    "vendorProject",
                    "vulnerabilityName"
                ]
            }
        }
    },
    "required": [
        "catalogVersion",
        "count",
        "dateReleased",
        "title",
        "vulnerabilities"
    ]
}

Visualize JSON files as directed graphs with GraphViz

To convert a JSON file to DOT format:

poetry run json-kit draw examples/cisa-kev/known_exploited_vulnerabilities.json -o examples/cisa-kev/known_exploited_vulnerabilities.dot

To convert a JSON file to an image in PNG format:

poetry run json-kit draw examples/cisa-kev/known_exploited_vulnerabilities.json -o examples/cisa-kev/known_exploited_vulnerabilities.png

To convert a JSON file to an image in SVG format:

poetry run json-kit draw examples/cisa-kev/known_exploited_vulnerabilities.json -o examples/cisa-kev/known_exploited_vulnerabilities.svg