GMUCERG / lwc_description_schema

Schema for description of protected LWC hardware implementations

Variant description file for Protected LWC Hardware Implementations

A variant description file is a TOML file describing the details of an LWC protected hardware implementation. As suggested in the "Call for Protected Hardware Implementation", a variant description file serves as an organized container of information and meta-data required for automated evaluation of an LWC hardware implementation.

Schema

The structure of a LWC variant description file is described as a JSON Schema in the file lwc.schema.json. The schema provides a precise specification of the hierarchy as well as type, format, and description of the data fields.

Examples

Example variant description files are provided in the examples subfolder.

examples/TinyJAMBU_DOM/tinyjambu-dom1-v1.toml

Validation

A Python script is provided to assist validation of a variant description file. Requires: Python 3.7+

Install dependencies:

$ python3 -m pip install -U -r validate/requirements.txt

Usage:

$ python3 ./validate/validate.py --help 

Validating a variant description file:

$ python3 ./validate/validate.py <path-to-variant-description-file>

for example:

$ python3 ./validate/validate.py examples/TinyJAMBU_DOM/tinyjambu-dom1-v1.toml

Documentation

Human-readable documentation in Markdown and HTML format is availale in the doc subfolder.