diff --git a/src/content/concepts/layer/_index.md b/src/content/concepts/layer/_index.md index b8c734eb..f3f7df2a 100644 --- a/src/content/concepts/layer/_index.md +++ b/src/content/concepts/layer/_index.md @@ -124,13 +124,13 @@ The following is the release state of each model, along with download links for | Layer | Model | Current State | Reference | Schemas | |:--- |:--- |:--- |:--- |:--- | -| [Control](control/) | [Catalog](control/catalog/) | Released | [XML, JSON, YAML](https://pages.nist.gov/OSCAL-Reference/models/latest/catalog/) | [XML](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_catalog_schema.xsd), [JSON/YAML](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_catalog_schema.json) | -| [Control](control/) | [Profile](control/profile/) | Released | [XML, JSON, YAML](https://pages.nist.gov/OSCAL-Reference/models/latest/profile/) | [XML](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_profile_schema.xsd), [JSON/YAML](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_profile_schema.json) | -| [Implementation](implementation/) | [Component Definition](implementation/component-definition/) | Released | [XML, JSON, YAML](https://pages.nist.gov/OSCAL-Reference/models/latest/component-definition/) | [XML](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_component_schema.xsd), [JSON/YAML](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_component_schema.json) | -| [Implementation](implementation/) | [System Security Plan](implementation/ssp/) | Released | [XML, JSON, YAML](https://pages.nist.gov/OSCAL-Reference/models/latest/system-security-plan/) | [XML](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_ssp_schema.xsd), [JSON/YAML](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_ssp_schema.json) | -| [Assessment](assessment/) | [Assessment Plan](assessment/assessment-plan/) | Released | [XML, JSON, YAML](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-plan/) | [XML](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_assessment-plan_schema.xsd), [JSON/YAML](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_assessment-plan_schema.json) | -| [Assessment](assessment/) | [Assessment Results](assessment/assessment-results/) | Released | [XML, JSON, YAML](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-results/) | [XML](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_assessment-results_schema.xsd), [JSON/YAML](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_assessment-results_schema.json) | -| [Assessment](assessment/) | [Plan of Action and Milestones](assessment/poam/) | Released | [XML, JSON, YAML](https://pages.nist.gov/OSCAL-Reference/models/latest/plan-of-action-and-milestones/) | [XML](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_poam_schema.xsd), [JSON/YAML](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_poam_schema.json) | +| [Control](control/) | [Catalog](control/catalog/) | Released | [XML, JSON, YAML](https://pages.nist.gov/OSCAL-Reference/models/latest/catalog/) | [XML](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_catalog_schema.xsd), [JSON/YAML](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_catalog_schema.json) | +| [Control](control/) | [Profile](control/profile/) | Released | [XML, JSON, YAML](https://pages.nist.gov/OSCAL-Reference/models/latest/profile/) | [XML](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_profile_schema.xsd), [JSON/YAML](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_profile_schema.json) | +| [Implementation](implementation/) | [Component Definition](implementation/component-definition/) | Released | [XML, JSON, YAML](https://pages.nist.gov/OSCAL-Reference/models/latest/component-definition/) | [XML](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_component_schema.xsd), [JSON/YAML](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_component_schema.json) | +| [Implementation](implementation/) | [System Security Plan](implementation/ssp/) | Released | [XML, JSON, YAML](https://pages.nist.gov/OSCAL-Reference/models/latest/system-security-plan/) | [XML](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_ssp_schema.xsd), [JSON/YAML](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_ssp_schema.json) | +| [Assessment](assessment/) | [Assessment Plan](assessment/assessment-plan/) | Released | [XML, JSON, YAML](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-plan/) | [XML](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_assessment-plan_schema.xsd), [JSON/YAML](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_assessment-plan_schema.json) | +| [Assessment](assessment/) | [Assessment Results](assessment/assessment-results/) | Released | [XML, JSON, YAML](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-results/) | [XML](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_assessment-results_schema.xsd), [JSON/YAML](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_assessment-results_schema.json) | +| [Assessment](assessment/) | [Plan of Action and Milestones](assessment/poam/) | Released | [XML, JSON, YAML](https://pages.nist.gov/OSCAL-Reference/models/latest/plan-of-action-and-milestones/) | [XML](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_poam_schema.xsd), [JSON/YAML](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_poam_schema.json) | ## Well-formed Data and Valid OSCAL diff --git a/src/content/concepts/layer/assessment/assessment-plan/_index.md b/src/content/concepts/layer/assessment/assessment-plan/_index.md index dfc478f3..b0b15eb2 100644 --- a/src/content/concepts/layer/assessment/assessment-plan/_index.md +++ b/src/content/concepts/layer/assessment/assessment-plan/_index.md @@ -12,8 +12,8 @@ aliases: | Assessment Plan Schema | Assessment Plan Converters | Reference |:--- |:--- |:--- | -| [JSON Schema](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_assessment-plan_schema.json) | [XML to JSON Converter](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_assessment-plan_xml-to-json-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/json#converting-oscal-xml-content-to-json)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-plan/json-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-plan/json-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-plan/json-index/) | -| [XML Schema](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_assessment-plan_schema.xsd) | [JSON to XML Converter](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_assessment-plan_json-to-xml-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/xml#converting-oscal-json-content-to-xml)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-plan/xml-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-plan/xml-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-plan/xml-index/) | +| [JSON Schema](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_assessment-plan_schema.json) | [XML to JSON Converter](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_assessment-plan_xml-to-json-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/json#converting-oscal-xml-content-to-json)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-plan/json-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-plan/json-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-plan/json-index/) | +| [XML Schema](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_assessment-plan_schema.xsd) | [JSON to XML Converter](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_assessment-plan_json-to-xml-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/xml#converting-oscal-json-content-to-xml)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-plan/xml-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-plan/xml-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-plan/xml-index/) | ## Purpose diff --git a/src/content/concepts/layer/assessment/assessment-results/_index.md b/src/content/concepts/layer/assessment/assessment-results/_index.md index 77ba66c0..fd88f360 100644 --- a/src/content/concepts/layer/assessment/assessment-results/_index.md +++ b/src/content/concepts/layer/assessment/assessment-results/_index.md @@ -12,8 +12,8 @@ aliases: | Assessment Results Schema | Assessment Results Converters | Reference |:--- |:--- |:--- | -| [JSON Schema](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_assessment-results_schema.json) | [XML to JSON Converter](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_assessment-results_xml-to-json-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/json#converting-oscal-xml-content-to-json)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-results/json-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-results/json-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-results/json-index/) | -| [XML Schema](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_assessment-results_schema.xsd) | [JSON to XML Converter](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_assessment-results_json-to-xml-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/xml#converting-oscal-json-content-to-xml)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-results/xml-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-results/xml-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-results/xml-index/) | +| [JSON Schema](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_assessment-results_schema.json) | [XML to JSON Converter](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_assessment-results_xml-to-json-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/json#converting-oscal-xml-content-to-json)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-results/json-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-results/json-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-results/json-index/) | +| [XML Schema](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_assessment-results_schema.xsd) | [JSON to XML Converter](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_assessment-results_json-to-xml-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/xml#converting-oscal-json-content-to-xml)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-results/xml-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-results/xml-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/assessment-results/xml-index/) | ## Purpose diff --git a/src/content/concepts/layer/assessment/poam/_index.md b/src/content/concepts/layer/assessment/poam/_index.md index 6e2494d7..38fd3ee2 100644 --- a/src/content/concepts/layer/assessment/poam/_index.md +++ b/src/content/concepts/layer/assessment/poam/_index.md @@ -12,8 +12,8 @@ aliases: | POA&M Schema | POA&M Converters | Reference |:--- |:--- |:--- | -| [JSON Schema](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_poam_schema.json) | [XML to JSON Converter](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_poam_xml-to-json-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/json#converting-oscal-xml-content-to-json)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/plan-of-action-and-milestones/json-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/plan-of-action-and-milestones/json-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/plan-of-action-and-milestones/json-index/) | -| [XML Schema](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_poam_schema.xsd) | [JSON to XML Converter](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_poam_json-to-xml-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/xml#converting-oscal-json-content-to-xml)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/plan-of-action-and-milestones/xml-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/plan-of-action-and-milestones/xml-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/plan-of-action-and-milestones/xml-index/) | +| [JSON Schema](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_poam_schema.json) | [XML to JSON Converter](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_poam_xml-to-json-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/json#converting-oscal-xml-content-to-json)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/plan-of-action-and-milestones/json-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/plan-of-action-and-milestones/json-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/plan-of-action-and-milestones/json-index/) | +| [XML Schema](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_poam_schema.xsd) | [JSON to XML Converter](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_poam_json-to-xml-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/xml#converting-oscal-json-content-to-xml)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/plan-of-action-and-milestones/xml-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/plan-of-action-and-milestones/xml-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/plan-of-action-and-milestones/xml-index/) | ## Purpose diff --git a/src/content/concepts/layer/control/catalog/_index.md b/src/content/concepts/layer/control/catalog/_index.md index aec0d003..ae667847 100644 --- a/src/content/concepts/layer/control/catalog/_index.md +++ b/src/content/concepts/layer/control/catalog/_index.md @@ -16,8 +16,8 @@ suppresstopiclist: true | Catalog Schema | Catalog Converters | Reference |:--- |:--- |:--- | -| [JSON Schema](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_catalog_schema.json) | [XML to JSON Converter](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_catalog_xml-to-json-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/json#converting-oscal-xml-content-to-json)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/catalog/json-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/catalog/json-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/catalog/json-index/) | -| [XML Schema](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_catalog_schema.xsd) | [JSON to XML Converter](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_catalog_json-to-xml-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/xml#converting-oscal-json-content-to-xml)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/catalog/xml-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/catalog/xml-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/catalog/xml-index/) | +| [JSON Schema](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_catalog_schema.json) | [XML to JSON Converter](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_catalog_xml-to-json-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/json#converting-oscal-xml-content-to-json)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/catalog/json-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/catalog/json-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/catalog/json-index/) | +| [XML Schema](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_catalog_schema.xsd) | [JSON to XML Converter](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_catalog_json-to-xml-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/xml#converting-oscal-json-content-to-xml)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/catalog/xml-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/catalog/xml-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/catalog/xml-index/) | ## Purpose diff --git a/src/content/concepts/layer/control/profile/_index.md b/src/content/concepts/layer/control/profile/_index.md index 4def075e..f58f188e 100644 --- a/src/content/concepts/layer/control/profile/_index.md +++ b/src/content/concepts/layer/control/profile/_index.md @@ -14,8 +14,8 @@ aliases: | Profile Schema | Profile Converters | Reference | |:--- |:--- |:--- | -| [JSON Schema](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_profile_schema.json) | [XML to JSON Converter](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_profile_xml-to-json-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/json#converting-oscal-xml-content-to-json)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/profile/json-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/profile/json-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/profile/json-index/) | -| [XML Schema](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_profile_schema.xsd) | [JSON to XML Converter](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_profile_json-to-xml-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/xml#converting-oscal-json-content-to-xml)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/profile/xml-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/profile/xml-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/profile/xml-index/) | +| [JSON Schema](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_profile_schema.json) | [XML to JSON Converter](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_profile_xml-to-json-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/json#converting-oscal-xml-content-to-json)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/profile/json-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/profile/json-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/profile/json-index/) | +| [XML Schema](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_profile_schema.xsd) | [JSON to XML Converter](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_profile_json-to-xml-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/xml#converting-oscal-json-content-to-xml)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/profile/xml-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/profile/xml-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/profile/xml-index/) | ## Purpose diff --git a/src/content/concepts/layer/implementation/component-definition/_index.md b/src/content/concepts/layer/implementation/component-definition/_index.md index 910d7f2f..c1ac397d 100644 --- a/src/content/concepts/layer/implementation/component-definition/_index.md +++ b/src/content/concepts/layer/implementation/component-definition/_index.md @@ -13,8 +13,8 @@ aliases: | Component Schema | Component Converters | Reference | |:--- |:--- |:--- | -| [JSON Schema](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_component_schema.json) | [XML to JSON Converter](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_component_xml-to-json-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/json#converting-oscal-xml-content-to-json)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/component-definition/json-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/component-definition/json-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/component-definition/json-index/) | -| [XML Schema](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_component_schema.xsd) | [JSON to XML Converter](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_component_json-to-xml-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/xml#converting-oscal-json-content-to-xml)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/component-definition/xml-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/component-definition/xml-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/component-definition/xml-index/) | +| [JSON Schema](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_component_schema.json) | [XML to JSON Converter](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_component_xml-to-json-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/json#converting-oscal-xml-content-to-json)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/component-definition/json-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/component-definition/json-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/component-definition/json-index/) | +| [XML Schema](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_component_schema.xsd) | [JSON to XML Converter](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_component_json-to-xml-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/xml#converting-oscal-json-content-to-xml)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/component-definition/xml-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/component-definition/xml-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/component-definition/xml-index/) | ## Purpose diff --git a/src/content/concepts/layer/implementation/ssp/_index.md b/src/content/concepts/layer/implementation/ssp/_index.md index 9f189068..264ca78d 100644 --- a/src/content/concepts/layer/implementation/ssp/_index.md +++ b/src/content/concepts/layer/implementation/ssp/_index.md @@ -11,8 +11,8 @@ aliases: | SSP Schema | SSP Converters | Reference | |:--- |:--- |:--- | -| [JSON Schema](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_ssp_schema.json) | [XML to JSON Converter](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_ssp_xml-to-json-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/json#converting-oscal-xml-content-to-json)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/system-security-plan/json-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/system-security-plan/json-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/system-security-plan/json-index/) | -| [XML Schema](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_ssp_schema.xsd) | [JSON to XML Converter](https://github.com/usnistgov/OSCAL/releases/download/v1.1.0/oscal_ssp_json-to-xml-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/xml#converting-oscal-json-content-to-xml)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/system-security-plan/xml-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/system-security-plan/xml-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/system-security-plan/xml-index/) | +| [JSON Schema](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_ssp_schema.json) | [XML to JSON Converter](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_ssp_xml-to-json-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/json#converting-oscal-xml-content-to-json)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/system-security-plan/json-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/system-security-plan/json-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/system-security-plan/json-index/) | +| [XML Schema](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_ssp_schema.xsd) | [JSON to XML Converter](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_ssp_json-to-xml-converter.xsl)
([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/xml#converting-oscal-json-content-to-xml)) | [Outline](https://pages.nist.gov/OSCAL-Reference/models/latest/system-security-plan/xml-outline/)
[Reference](https://pages.nist.gov/OSCAL-Reference/models/latest/system-security-plan/xml-reference/)
[Index](https://pages.nist.gov/OSCAL-Reference/models/latest/system-security-plan/xml-index/) | ## Purpose diff --git a/src/content/concepts/layer/overview.md b/src/content/concepts/layer/overview.md index 17f378a2..83e04b98 100644 --- a/src/content/concepts/layer/overview.md +++ b/src/content/concepts/layer/overview.md @@ -231,5 +231,4 @@ This allows developers to use their preferred format. A tool designed for one fo Currently, converters are available to convert XML-based OSCAL files to JSON and JSON-based OSCAL files to XML. -- [XML to JSON converters](https://github.com/usnistgov/OSCAL/tree/main/json/convert) ([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/json#converting-oscal-xml-content-to-json)) -- [JSON to XML converters](https://github.com/usnistgov/OSCAL/tree/main/xml/convert) ([How do I use this?](https://github.com/usnistgov/OSCAL/tree/main/xml#converting-oscal-json-content-to-xml)) +For more details on converter usage, see the build and usage instructions on the [tools page](../../tools/_index.md#data-conversion). diff --git a/src/content/learn/tutorials/general/releases.md b/src/content/learn/tutorials/general/releases.md index d5842180..3b639ad6 100644 --- a/src/content/learn/tutorials/general/releases.md +++ b/src/content/learn/tutorials/general/releases.md @@ -37,11 +37,15 @@ For example, a release for version 1.0.0 would be tagged `v1.0.0`. To test a specific release, [clone the repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) and checkout the release's associated tag. Be sure to [clone the repository with submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules#_cloning_submodules). -As an example, to test the [OSCAL 1.0.5 pre-release](https://github.com/usnistgov/OSCAL/releases/tag/v1.0.5), you could clone the repository directly at the release tag: +As an example, to test the [OSCAL 1.1.0 release](https://github.com/usnistgov/OSCAL/releases/tag/v1.1.0), you could clone the repository directly at the release tag: + +{{% callout note %}}Checking out a repository on a tag may yield a warning about being in a "detached HEAD" state, for more details, see the [Git documentation](https://git-scm.com/docs/git-checkout#_detached_head){{% /callout %}} ```sh -# Clone the OSCAL repository with submodules at the 1.0.5 release -git clone --recurse-submodules https://github.com/usnistgov/OSCAL.git --branch v1.0.5 +# Clone the OSCAL repository with submodules at the 1.1.0 release +# Note: this will create a sparse commit, and Git will warn you about being in a "detached head" state. +# Alternatively clone the repository with the default branch, and subsequently checkout a branch with the `release-` prefix or tag accordingly. +git clone --recurse-submodules https://github.com/usnistgov/OSCAL.git --branch v1.1.0 cd OSCAL ``` @@ -52,8 +56,8 @@ Or you could checkout the tag on an existing copy of the repository: cd path/to/OSCAL # Fetch the newest changes to the repository from GitHub git fetch --all -# Checkout the "v1.0.5" tag -git checkout v1.0.5 +# Checkout the "v1.1.0" tag +git checkout v1.1.0 ``` ### How do I validate existing content against a new release? @@ -68,17 +72,20 @@ These constraints can be validated using downstream tools, such as the [OSCAL CL Accompanying pre-releases for these tools may be created as appropriate. For more details see ["How do I test downstream tooling?"](#how-do-i-test-downstream-oscal-tooling). +{{% callout warning %}}Starting with [release 1.1.0](https://github.com/usnistgov/OSCAL/releases/tag/v1.1.0), build artifacts (schemas, converters) are now distributed as part of a release and are no longer tracked within the OSCAL Git repository.{{% /callout %}} + #### Validating XML OSCAL content {{}}We appreciate the community using [example content from NIST](https://github.com/usnistgov/oscal-content/blob/main/examples/) and others, but we strongly encourage the community to test validation against real-world, production-grade data.{{}} -XML OSCAL content can be validated using many tools that support XML Schema (XSD) files. -Schemas are located in the OSCAL repository at the path [`/xml/schema`](https://github.com/usnistgov/OSCAL/tree/main/xml/schema). +To obtain XML Schemas (XSDs) from a release, first follow the build instructions located in [`/build/README.md`](https://github.com/usnistgov/OSCAL/tree/main/build) or download the assets directly from the [corresponding GitHub release](https://github.com/usnistgov/OSCAL/releases). + +OSCAL XML content can be validated using many tools that support XML Schema (XSD) files. As an example, a piece of OSCAL content can be validated against a schema using [`libxml2`](https://gitlab.gnome.org/GNOME/libxml2)'s [`xmllint`](https://gnome.pages.gitlab.gnome.org/libxml2/xmllint.html): ```sh $ xmllint --noout \ - --schema OSCAL/xml/schema/oscal_complete_schema.xsd \ + --schema OSCAL/build/generated/oscal_complete_schema.xsd \ example_oscal_content.xml ``` @@ -86,14 +93,14 @@ $ xmllint --noout \ {{}}We appreciate the community using [example content from NIST](https://github.com/usnistgov/oscal-content/blob/main/examples/) and others, but we strongly encourage the community to test validation against real-world, production-grade data.{{}} -JSON and YAML OSCAL content can be validated using many tools that support [JSON Schema](http://json-schema.org/implementations.html). -Schemas are located in the OSCAL repository at the path [`/json/schema/`](https://github.com/usnistgov/OSCAL/tree/main/json/schema). +To obtain JSON schemas from a release, first follow the build instructions located in [`/build/README.md`](https://github.com/usnistgov/OSCAL/tree/main/build) or download the assets directly from the [corresponding GitHub release](https://github.com/usnistgov/OSCAL/releases). +OSCAL JSON and YAML content can be validated using many tools that support [JSON Schema](http://json-schema.org/implementations.html). As an example, a piece of OSCAL content can be validated against a schema using the [AJV CLI](https://github.com/ajv-validator/ajv-cli): ```sh $ ajv validate \ - -s OSCAL/json/schema/oscal_complete_schema.json \ + -s OSCAL/build/generated/oscal_complete_schema.json \ -d example_oscal_content.json ``` @@ -104,21 +111,19 @@ Currently the underlying XML tooling is also used to generate the XML and JSON s Relevant changes to the XML tooling are provided as part of the [patch notes](https://github.com/usnistgov/OSCAL/releases/) for a release. -To use the XML tools from a release, first follow the environment setup instructions located in [`/build/README.md`](https://github.com/usnistgov/OSCAL/tree/main/build) and [`/build/ci-cd/README.md`](https://github.com/usnistgov/OSCAL/tree/main/build/ci-cd). -The [Docker](https://www.docker.com/) container definition (located in [`/build/Dockerfile`](https://github.com/usnistgov/OSCAL/blob/main/build/Dockerfile)) provides a simple way to replicate the build environment reproducibly. +To use the XML tools from a release, first follow the build instructions located in [`/build/README.md`](https://github.com/usnistgov/OSCAL/tree/main/build) or download the assets directly from the [corresponding GitHub release](https://github.com/usnistgov/OSCAL/releases). #### Conversion {{}}We appreciate the community using [example content from NIST](https://github.com/usnistgov/oscal-content/blob/main/examples/) and others, but we strongly encourage the community to test content conversion against real-world, production-grade data.{{}} -Detailed instructions for performing OSCAL content conversion from XML to JSON are located at [`/json/README.md`](https://github.com/usnistgov/OSCAL/tree/main/json). -Detailed instructions for performing OSCAL content conversion from JSON to XML are located at [`/xml/README.md`](https://github.com/usnistgov/OSCAL/tree/main/xml). +Detailed instructions for performing OSCAL content conversion from XML to JSON and back are located at [`/build/README.md`](https://github.com/usnistgov/OSCAL/blob/main/build/README.md) #### Profile Resolution {{}}We appreciate the community using [example content from NIST](https://github.com/usnistgov/oscal-content/blob/main/examples/) and others, but we strongly encourage the community to test profile resolution against real-world, production-grade data.{{}} -Detailed instructions for performing profile resolution are located at [`/src/utils/util/resolver-pipeline/readme.md`](https://github.com/usnistgov/OSCAL/tree/main/src/utils/util/resolver-pipeline). +Detailed instructions for performing profile resolution are located at [`/src/utils/resolver-pipeline/readme.md`](https://github.com/usnistgov/OSCAL/tree/main/src/utils/resolver-pipeline). ### How do I test downstream OSCAL tooling? diff --git a/src/content/tools/_index.md b/src/content/tools/_index.md index 8c560006..04cffcda 100644 --- a/src/content/tools/_index.md +++ b/src/content/tools/_index.md @@ -21,11 +21,15 @@ The following types of tools are developed by NIST OSCAL team: In order to support data interchange and semantic interoperability in this heterogeneous environment, the OSCAL project publishes some basic software components along with the OSCAL specifications, to help serve as reference points or "scaffolding" for developers and for partners in data exchange. -See the OSCAL [XML](https://github.com/usnistgov/OSCAL/tree/main/xml) and [JSON/YAML](https://github.com/usnistgov/OSCAL/tree/main/json) resource pages in the project repository for more details. +See the [OSCAL build resource page](https://github.com/usnistgov/OSCAL/blob/main/build/README.md) in the project repository for more details. ### Validation -OSCAL can be formally *validated* to help confirm its correctness and fitness for processing. Validation of any OSCAL content instance can be accomplished by applying the appropriate schema for the respective format. For example, a System Security Plan (SSP) represented in OSCAL XML can be validated against the [SSP XML Schema](https://github.com/usnistgov/OSCAL/blob/main/xml/schema/oscal_ssp_schema.xsd), which defines (in machinable form) the validation rules for OSCAL SSPs in XML. Validation operations are based entirely on non-proprietary, standardized processes available in multiple tool implementations, by reference to open, publicly available schemas, located in the [OSCAL repository](https://github.com/usnistgov/OSCAL/) for [XML](https://github.com/usnistgov/OSCAL/tree/main/xml/schema) and [JSON/YAML](https://github.com/usnistgov/OSCAL/tree/main/json/schema) respectively. +OSCAL can be formally *validated* to help confirm its correctness and fitness for processing. +Validation of any OSCAL content instance can be accomplished by applying the appropriate schema for the respective format. +For example, a System Security Plan (SSP) represented in OSCAL XML can be validated against the [SSP XML Schema](https://pages.nist.gov/OSCAL-Reference/release-assets/latest/oscal_ssp_schema.xsd), which defines (in machine-readable form) the validation rules for OSCAL SSPs in XML. +Validation operations are based entirely on non-proprietary, standardized processes available in multiple tool implementations, by reference to open, publicly available schemas, located in the [OSCAL repository](https://github.com/usnistgov/OSCAL/) for XML and JSON/YAML respectively. +For details on how to use and obtain OSCAL schemas, see the [OSCAL repository build resource](https://github.com/usnistgov/OSCAL/blob/main/build/README.md#schemas) YAML developers should take note that the JSON Schemas can be applied to YAML content instances. @@ -37,10 +41,7 @@ Because OSCAL can be XML, JSON or YAML, it is sometimes useful to convert OSCAL Additionally, OSCAL applications such as those listed below, when reading and writing OSCAL, may themselves support more than one syntax. Check the features of your processor in case you do not need a standalone tool for data conversion. -Details on acquiring and running the converters: - -- converting *into* JSON - [XML to JSON](https://github.com/usnistgov/OSCAL/tree/main/json) -- converting *into* XML - [JSON to XML](https://github.com/usnistgov/OSCAL/tree/main/xml) +For details on how to use and obtain OSCAL converters, see the [OSCAL repository build resource](https://github.com/usnistgov/OSCAL/blob/main/build/README.md#converters) ## NIST's OSCAL Application Frameworks, Tools and Libraries @@ -51,4 +52,4 @@ Valid OSCAL is open-ended in application. Some of the tools described provide va | [OSCAL Deep Diff](https://github.com/usnistgov/oscal-deep-diff) | A Typescript-based CLI application and library that produces machine readable and human-consumable comparisons of JSON OSCAL artifacts. | open source | | [OSCAL Java Library](https://github.com/usnistgov/liboscal-java) | A Java-based programming API for reading and writing content conformant to the OSCAL XML, JSON, and YAML based models. | open source | | [XSLT Tooling](https://github.com/usnistgov/oscal-tools/tree/main/xslt) | A variety of Extensible Stylesheet Language (XSL) Transformations (XSLT), Cascading Style Sheets (CSS), and related utilities for authoring, converting, and publishing OSCAL content in various forms. | open source | -| [OSCAL Java CLI](https://github.com/usnistgov/oscal-cli) | An OSCAL Java command-line tool able to validate OSCAL content and metaschema for well formatting, to convert such content between the OSCAL XML, JSON and YAML formats, to resolve OSCAL profiles, and to generateXML and JSON schemas from a Metachema model definition. | open source | \ No newline at end of file +| [OSCAL Java CLI](https://github.com/usnistgov/oscal-cli) | An OSCAL Java command-line tool able to validate OSCAL content and metaschema for well formatting, to convert such content between the OSCAL XML, JSON and YAML formats, to resolve OSCAL profiles, and to generateXML and JSON schemas from Metaschema module(s). | open source | \ No newline at end of file