Usage¶
As A Script¶
The validator comes with a bundled script which you can use to validate a JSON file containing STIX content:
$ stix2_validator <stix_file.json>
As A Library¶
You can also use this library to integrate STIX validation into your own tools. You can validate a JSON file:
from stix2validator import validate_file, print_results
results = validate_file("stix_file.json")
print_results(results)
You can also validate a JSON string, and check if the input passed validation:
from stix2validator import validate_string, print_results
stix_json_string = "..."
results = validate_string(stix_json_string)
if results.is_valid:
print_results(results)
If your STIX is already in a Python dictionary (for example if you
have already run json.loads()
), use validate_instance()
instead:
import json
from stix2validator import validate_instance, print_results
stix_json_string = "..."
stix_obj = json.loads(stix_json_string)
results = validate_instance(stix_obj)
if results.is_valid:
print_results(results)
You can pass a ValidationOptions object into validate_file()
,
validate_string()
, or validate_instance()
if you want behavior
other than the default:
from stix2validator import ValidationOptions
options = ValidationOptions(strict=True)
results = validate_string(stix_json_string, options)
STIX 2 Versions¶
By default the validator will check content against the latest version of
the STIX 2 specification. However, older versions can be checked with the
version
option. For example:
$ stix2_validator --version=2.0 <stix_file.json>
or in Python:
options = ValidationOptions(strict=True, version="2.0")
results = validate_string(stix_json_string, options)
Additional Schemas¶
The validator uses the STIX 2 JSON schemas as the basis for its validation, but you can also validate with your own additional schemas. This can help if you want to validate STIX content using custom objects, properties, or observables.
To do this use the --schema-dir
argument:
$ stix2_validator --schema-dir /path/to/my/schemas <stix_file.json>
or in Python:
from stix2validator import ValidationOptions
options = ValidationOptions(strict=True, version="2.0", schema_dir="/path/to/custom/schemas")
results = validate_file("stix_file.json")
print_results(results)
You can see some examples of custom schemas here. Note that if you want to add a custom property to an existing object type, your custom schema only needs to contain that property; the validator’s built-in schemas are still checked against and will handle the rest.