Skip to main content

Build_Status Coverage Version Documentation Status

cti-stix-validator

NOTE: This is an OASIS TC Open Repository. See the Governance section for more information.

The STIX Validator checks that STIX JSON content conforms to the requirements specified in the STIX 2.1 specification. In addition to checking conformance with the JSON schemas, the validator checks conformance with requirements that cannot be specified in JSON schema, as well as with established “best practices”. This validator is non-normative; in cases of conflict with the STIX 2.1 specification, the specification takes precedence.

The STIX 2.1 specification contains two types of requirements: mandatory “MUST” requirements, and recommended “SHOULD” best practice requirements. The validator checks documents against the “MUST” requirements using JSON schemas. Some of these mandatory requirements cannot be implemented in JSON Schema, however, so the validator uses Python functions to check them. The “SHOULD” requirements are all checked by Python functions, and options may be used to ignore some or all of these recommended “best practices.”

The only exception to this is the mandatory requirement that an object’s ‘type’ be one of those defined by a STIX Object in the specification. This rules out custom objects, so this check was made optional.

The validator also color-codes its output to make it easier to tell at a glance whether validation passed.

Installation

The easiest way to install the STIX validator is with pip:

$ pip install stix2-validator

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 using validate_string(), or a Python dictionary representing a STIX object using validate_instance(). For more information, see the full documentation here.

Governance

This GitHub public repository ( https://github.com/oasis-open/cti- stix-validator ) was proposed and approved [bis] by the OASIS Cyber Threat Intelligence (CTI) TC as an OASIS TC Open Repository to support development of open source resources related to Technical Committee work.

While this TC Open Repository remains associated with the sponsor TC, its development priorities, leadership, intellectual property terms, participation rules, and other matters of governance are separate and distinct from the OASIS TC Process and related policies.

All contributions made to this TC Open Repository are subject to open source license terms expressed in the BSD-3-Clause License. That license was selected as the declared “Applicable License” when the TC Open Repository was created.

As documented in “Public Participation Invited”, contributions to this OASIS TC Open Repository are invited from all parties, whether affiliated with OASIS or not. Participants must have a GitHub account, but no fees or OASIS membership obligations are required. Participation is expected to be consistent with the OASIS TC Open Repository Guidelines and Procedures, the open source LICENSE designated for this particular repository, and the requirement for an Individual Contributor License Agreement that governs intellectual property.

Maintainers

TC Open Repository Maintainers are responsible for oversight of this project’s community development activities, including evaluation of GitHub pull requests and preserving open source principles of openness and fairness. Maintainers are recognized and trusted experts who serve to implement community goals and consensus design preferences.

Initially, the associated TC members have designated one or more persons to serve as Maintainer(s); subsequently, participating community members may select additional or substitute Maintainers, per consensus agreements.

Current Maintainers of this TC Open Repository

About OASIS TC Open Repositories

Feedback

Questions or comments about this TC Open Repository’s activities should be composed as GitHub issues or comments. If use of an issue/comment is not possible or appropriate, questions may be directed by email to the Maintainer(s) listed above. Please send general questions about TC Open Repository participation to OASIS Staff at repository-admin@oasis- open.org and any specific CLA-related questions to repository-cla@oasis-open.org.

Release files for stix2-validator 3.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for stix2-validator 3.3.1
File Size Uploaded
stix2_validator-3.3.1.tar.gz 779.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for stix2-validator 3.3.1
File Interpreter ABI Platform
stix2_validator-3.3.1-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 1.6 MB

Release files / stix2_validator-3.3.1.tar.gz

Download URL stix2_validator-3.3.1.tar.gz
Size 779.7 kB
Tags Source
SHA-256 checksum
How to use checksums
90484bfd8f5e216a4587bb26500bb4503e320b266e3d250281e04db47cb1e441
BLAKE2b-256 checksum
How to use checksums
6bbe10be24a40489373cc8c55ef6e8856449c20c59eea5a177890a48182b0246
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.4

Release files / stix2_validator-3.3.1-py2.py3-none-any.whl

Download URL stix2_validator-3.3.1-py2.py3-none-any.whl
Size 791.2 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
9dd5615524e34b15f98d565b17f33974c420b7a69350597a4f2ba955e3f489ab
BLAKE2b-256 checksum
How to use checksums
7d9acc17955af85bec43fdba381b4e4c07cc63172c9038b585fd4c25f55cc80f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.4

Release history Release notifications | RSS feed

This release

3.3.1 This release

2 release files

3.2.0

2 release files

3.1.4

2 release files

3.1.3

2 release files

3.1.2

2 release files

3.1.0

2 release files

3.0.2

2 release files

3.0.1

1 release file

3.0.0

2 release files

2.0.4

2 release files

2.0.3

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.1.2

1 release file

1.1.1

1 release file

1.1.0

1 release file

1.0.1

1 release file

1.0.0

1 release file

0.5.0

1 release file

0.4.0

1 release file

0.3.0

1 release file

0.2.0

1 release file

0.1.0

1 release file

0.0.2

1 release file

0.0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page