/cti-stix2-json-schemas

OASIS Open Repository: Non-normative schemas and examples for STIX 2

Primary LanguageANTLRBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

cti-stix2-json-schemas

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

This repository contains non-normative JSON schemas and examples for STIX 2. The examples include short examples of particular objects, more complete use-case examples, and complete reports in STIX 2. The repository contains both JSON schemas and JSON STIX documents.

NOTE: The schemas in this repository are intended to follow the STIX 2.0 Specification (TODO: insert link), but some requirements of the specification cannot be enforced in JSON schema alone. As a result, these schemas are insufficient to determine whether a particular example of STIX 2.0 JSON is "valid". Additionally, though care has been taken to ensure that these schemas do not conflict with the specification, in case of conflict, the specification takes precedence.

Some of the checks the schemas do not contain:

  • The 'modified' property must be later or equal to 'created'.
  • Marking Definitions (both object markings and granular markings) cannot refer to themselves (no circular refs).
  • IDs for custom object types must start with the name of that type.
  • Granular Marking selectors must refer to properties or items actually present in the object.
  • Object references in the Cyber Observable layer must be valid within the local scope.
  • Custom observable objects and observable extensions must have at least one custom property.
  • Values for some Cyber Observable object properties must come from official registries (eg. artifact:mime_type must be a valid IANA MIME type).
  • Some Cyber Observable objects' *_ref and *_refs properties must point to specific types of objects (eg. process:binary_ref must point to an object of type 'file').

Governance

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

While this 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 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 Open Repository was created.

As documented in "Public Participation Invited", contributions to this OASIS 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 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

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 Open Repository

About OASIS Open Repositories

Feedback

Questions or comments about this 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 Open Repository participation to OASIS Staff at repository-admin@oasis-open.org and any specific CLA-related questions to repository-cla@oasis-open.org.