{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://catalog.lintel.tools/schemas/schemastore/oscal-component-definition-cdef/versions/1.0.4.json", "x-lintel": { "source": "https://github.com/usnistgov/OSCAL/releases/download/v1.0.4/oscal_component_schema.json", "sourceSha256": "55c57a34adb70319e691cdce3caa657dbbf84f54e5721928ef12b0ceb02ffad6", "fileMatch": [ "oscal*component.json", "oscal*cdef.json" ], "parsers": [ "json" ] }, "type": "object", "properties": { "component-definition": { "$ref": "#assembly_oscal-component-definition_component-definition" } }, "$defs": { "oscal-component-definition-oscal-component-definition:component-definition": { "title": "Component Definition", "description": "A collection of component descriptions, which may optionally be grouped by capability.", "required": [ "uuid", "metadata" ], "type": "object", "properties": { "uuid": { "title": "Component Definition Universally Unique Identifier", "description": "A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this component definition elsewhere in this or other OSCAL instances. The locally defined UUID of the component definition can be used to reference the data item locally or globally (e.g., in an imported OSCAL instance). This UUID should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.", "type": "string", "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "metadata": { "$ref": "#assembly_oscal-metadata_metadata" }, "import-component-definitions": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-component-definition_import-component-definition" } }, "components": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-component-definition_defined-component" } }, "capabilities": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-component-definition_capability" } }, "back-matter": { "$ref": "#assembly_oscal-metadata_back-matter" } }, "additionalProperties": false }, "oscal-component-definition-oscal-component-definition:import-component-definition": { "title": "Import Component Definition", "description": "Loads a component definition from another resource.", "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Hyperlink Reference", "description": "A link to a resource that defines a set of components and/or capabilities to import into this collection.", "type": "string", "format": "uri-reference" } }, "additionalProperties": false }, "oscal-component-definition-oscal-component-definition:defined-component": { "title": "Component", "description": "A defined component that can be part of an implemented system.", "required": [ "uuid", "type", "title", "description" ], "type": "object", "properties": { "uuid": { "title": "Component Identifier", "description": "A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this component elsewhere in this or other OSCAL instances. The locally defined UUID of the component can be used to reference the data item locally or globally (e.g., in an imported OSCAL instance). This UUID should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.", "type": "string", "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "type": { "title": "Component Type", "description": "A category describing the purpose of the component.", "type": "string", "pattern": "^\\S(.*\\S)?$" }, "title": { "title": "Component Title", "description": "A human readable name for the component.", "type": "string" }, "description": { "title": "Component Description", "description": "A description of the component, including information about its function.", "type": "string" }, "purpose": { "title": "Purpose", "description": "A summary of the technological or business purpose of the component.", "type": "string" }, "props": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_property" } }, "links": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_link" } }, "responsible-roles": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_responsible-role" } }, "protocols": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-implementation-common_protocol" } }, "control-implementations": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-component-definition_control-implementation" } }, "remarks": { "$ref": "#field_oscal-metadata_remarks" } }, "additionalProperties": false }, "oscal-component-definition-oscal-component-definition:capability": { "title": "Capability", "description": "A grouping of other components and/or capabilities.", "required": [ "uuid", "name", "description" ], "type": "object", "properties": { "uuid": { "title": "Capability Identifier", "description": "A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this capability elsewhere in this or other OSCAL instances. The locally defined UUID of the capability can be used to reference the data item locally or globally (e.g., in an imported OSCAL instance).This UUID should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.", "type": "string", "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "name": { "title": "Capability Name", "description": "The capability's human-readable name.", "type": "string", "pattern": "^\\S(.*\\S)?$" }, "description": { "title": "Capability Description", "description": "A summary of the capability.", "type": "string" }, "props": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_property" } }, "links": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_link" } }, "incorporates-components": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-component-definition_incorporates-component" } }, "control-implementations": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-component-definition_control-implementation" } }, "remarks": { "$ref": "#field_oscal-metadata_remarks" } }, "additionalProperties": false }, "oscal-component-definition-oscal-component-definition:incorporates-component": { "title": "Incorporates Component", "description": "TBD", "required": [ "component-uuid", "description" ], "type": "object", "properties": { "component-uuid": { "title": "Component Reference", "description": "A machine-oriented identifier reference to a component.", "type": "string", "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "description": { "title": "Component Description", "description": "A description of the component, including information about its function.", "type": "string" } }, "additionalProperties": false }, "oscal-component-definition-oscal-component-definition:control-implementation": { "title": "Control Implementation Set", "description": "Defines how the component or capability supports a set of controls.", "required": [ "uuid", "source", "description", "implemented-requirements" ], "type": "object", "properties": { "uuid": { "title": "Control Implementation Set Identifier", "description": "A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference a set of implemented controls elsewhere in this or other OSCAL instances. The locally defined UUID of the control implementation set can be used to reference the data item locally or globally (e.g., in an imported OSCAL instance). This UUID should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.", "type": "string", "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "source": { "title": "Source Resource Reference", "description": "A reference to an OSCAL catalog or profile providing the referenced control or subcontrol definition.", "type": "string", "format": "uri-reference" }, "description": { "title": "Control Implementation Description", "description": "A description of how the specified set of controls are implemented for the containing component or capability.", "type": "string" }, "props": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_property" } }, "links": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_link" } }, "set-parameters": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-implementation-common_set-parameter" } }, "implemented-requirements": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-component-definition_implemented-requirement" } } }, "additionalProperties": false }, "oscal-component-definition-oscal-component-definition:implemented-requirement": { "title": "Control Implementation", "description": "Describes how the containing component or capability implements an individual control.", "required": [ "uuid", "control-id", "description" ], "type": "object", "properties": { "uuid": { "title": "Control Implementation Identifier", "description": "A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference a specific control implementation elsewhere in this or other OSCAL instances. The locally defined UUID of the control implementation can be used to reference the data item locally or globally (e.g., in an imported OSCAL instance).This UUID should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.", "type": "string", "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "control-id": { "title": "Control Identifier Reference", "description": "A human-oriented identifier reference to a control with a corresponding id value. When referencing an externally defined control, the Control Identifier Reference must be used in the context of the external / imported OSCAL instance (e.g., uri-reference).", "type": "string", "pattern": "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$" }, "description": { "title": "Control Implementation Description", "description": "A suggestion for how the specified control may be implemented if the containing component or capability is instantiated in a system security plan.", "type": "string" }, "props": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_property" } }, "links": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_link" } }, "set-parameters": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-implementation-common_set-parameter" } }, "responsible-roles": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_responsible-role" } }, "statements": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-component-definition_statement" } }, "remarks": { "$ref": "#field_oscal-metadata_remarks" } }, "additionalProperties": false }, "oscal-component-definition-oscal-component-definition:statement": { "title": "Control Statement Implementation", "description": "Identifies which statements within a control are addressed.", "required": [ "statement-id", "uuid", "description" ], "type": "object", "properties": { "statement-id": { "title": "Control Statement Reference", "description": "A human-oriented identifier reference to a control statement.", "type": "string", "pattern": "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$" }, "uuid": { "title": "Control Statement Reference Universally Unique Identifier", "description": "A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this control statement elsewhere in this or other OSCAL instances. The UUID of the control statement in the source OSCAL instance is sufficient to reference the data item locally or globally (e.g., in an imported OSCAL instance).", "type": "string", "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "description": { "title": "Statement Implementation Description", "description": "A summary of how the containing control statement is implemented by the component or capability.", "type": "string" }, "props": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_property" } }, "links": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_link" } }, "responsible-roles": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_responsible-role" } }, "remarks": { "$ref": "#field_oscal-metadata_remarks" } }, "additionalProperties": false }, "oscal-component-definition-oscal-implementation-common:system-component": { "title": "Component", "description": "A defined component that can be part of an implemented system.", "required": [ "uuid", "type", "title", "description", "status" ], "type": "object", "properties": { "uuid": { "title": "Component Identifier", "description": "A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this component elsewhere in this or other OSCAL instances. The locally defined UUID of the component can be used to reference the data item locally or globally (e.g., in an imported OSCAL instance). This UUID should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.", "type": "string", "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "type": { "title": "Component Type", "description": "A category describing the purpose of the component.", "type": "string", "pattern": "^\\S(.*\\S)?$" }, "title": { "title": "Component Title", "description": "A human readable name for the system component.", "type": "string" }, "description": { "title": "Component Description", "description": "A description of the component, including information about its function.", "type": "string" }, "purpose": { "title": "Purpose", "description": "A summary of the technological or business purpose of the component.", "type": "string" }, "props": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_property" } }, "links": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_link" } }, "status": { "title": "Status", "description": "Describes the operational status of the system component.", "type": "object", "properties": { "state": { "title": "State", "description": "The operational status.", "type": "string", "pattern": "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$", "enum": [ "under-development", "operational", "disposition", "other" ] }, "remarks": { "$ref": "#field_oscal-metadata_remarks" } }, "required": [ "state" ], "additionalProperties": false }, "responsible-roles": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_responsible-role" } }, "protocols": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-implementation-common_protocol" } }, "remarks": { "$ref": "#field_oscal-metadata_remarks" } }, "additionalProperties": false }, "oscal-component-definition-oscal-implementation-common:protocol": { "title": "Service Protocol Information", "description": "Information about the protocol used to provide a service.", "required": [ "name" ], "type": "object", "properties": { "uuid": { "title": "Service Protocol Information Universally Unique Identifier", "description": "A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this service protocol information elsewhere in this or other OSCAL instances. The locally defined UUID of the service protocol can be used to reference the data item locally or globally (e.g., in an imported OSCAL instance). This UUID should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.", "type": "string", "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "name": { "title": "Protocol Name", "description": "The common name of the protocol, which should be the appropriate \"service name\" from the IANA Service Name and Transport Protocol Port Number Registry.", "type": "string", "pattern": "^\\S(.*\\S)?$" }, "title": { "title": "Protocol Title", "description": "A human readable name for the protocol (e.g., Transport Layer Security).", "type": "string" }, "port-ranges": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-implementation-common_port-range" } } }, "additionalProperties": false }, "oscal-component-definition-oscal-implementation-common:port-range": { "title": "Port Range", "description": "Where applicable this is the IPv4 port range on which the service operates.", "properties": { "start": { "title": "Start", "description": "Indicates the starting port number in a port range", "type": "integer", "multipleOf": 1, "minimum": 0 }, "end": { "title": "End", "description": "Indicates the ending port number in a port range", "type": "integer", "multipleOf": 1, "minimum": 0 }, "transport": { "title": "Transport", "description": "Indicates the transport type.", "type": "string", "pattern": "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$", "enum": [ "TCP", "UDP" ] } }, "type": "object", "additionalProperties": false }, "oscal-component-definition-oscal-implementation-common:implementation-status": { "title": "Implementation Status", "description": "Indicates the degree to which the a given control is implemented.", "required": [ "state" ], "type": "object", "properties": { "state": { "title": "Implementation State", "description": "Identifies the implementation status of the control or control objective.", "type": "string", "pattern": "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$" }, "remarks": { "$ref": "#field_oscal-metadata_remarks" } }, "additionalProperties": false }, "oscal-component-definition-oscal-implementation-common:system-user": { "title": "System User", "description": "A type of user that interacts with the system based on an associated role.", "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "title": "User Universally Unique Identifier", "description": "A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this user class elsewhere in this or other OSCAL instances. The locally defined UUID of the system user can be used to reference the data item locally or globally (e.g., in an imported OSCAL instance). This UUID should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.", "type": "string", "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "title": { "title": "User Title", "description": "A name given to the user, which may be used by a tool for display and navigation.", "type": "string" }, "short-name": { "title": "User Short Name", "description": "A short common name, abbreviation, or acronym for the user.", "type": "string", "pattern": "^\\S(.*\\S)?$" }, "description": { "title": "User Description", "description": "A summary of the user's purpose within the system.", "type": "string" }, "props": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_property" } }, "links": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_link" } }, "role-ids": { "type": "array", "minItems": 1, "items": { "$ref": "#field_oscal-metadata_role-id" } }, "authorized-privileges": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-implementation-common_authorized-privilege" } }, "remarks": { "$ref": "#field_oscal-metadata_remarks" } }, "additionalProperties": false }, "oscal-component-definition-oscal-implementation-common:authorized-privilege": { "title": "Privilege", "description": "Identifies a specific system privilege held by the user, along with an associated description and/or rationale for the privilege.", "required": [ "title", "functions-performed" ], "type": "object", "properties": { "title": { "title": "Privilege Title", "description": "A human readable name for the privilege.", "type": "string" }, "description": { "title": "Privilege Description", "description": "A summary of the privilege's purpose within the system.", "type": "string" }, "functions-performed": { "type": "array", "minItems": 1, "items": { "$ref": "#field_oscal-implementation-common_function-performed" } } }, "additionalProperties": false }, "oscal-component-definition-oscal-implementation-common:function-performed": { "title": "Functions Performed", "description": "Describes a function performed for a given authorized privilege by this user class.", "pattern": "^\\S(.*\\S)?$", "type": "string" }, "oscal-component-definition-oscal-implementation-common:inventory-item": { "title": "Inventory Item", "description": "A single managed inventory item within the system.", "required": [ "uuid", "description" ], "type": "object", "properties": { "uuid": { "title": "Inventory Item Universally Unique Identifier", "description": "A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this inventory item elsewhere in this or other OSCAL instances. The locally defined UUID of the inventory item can be used to reference the data item locally or globally (e.g., in an imported OSCAL instance). This UUID should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.", "type": "string", "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "description": { "title": "Inventory Item Description", "description": "A summary of the inventory item stating its purpose within the system.", "type": "string" }, "props": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_property" } }, "links": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_link" } }, "responsible-parties": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_responsible-party" } }, "implemented-components": { "type": "array", "minItems": 1, "items": { "title": "Implemented Component", "description": "The set of components that are implemented in a given system inventory item.", "type": "object", "properties": { "component-uuid": { "title": "Component Universally Unique Identifier Reference", "description": "A machine-oriented identifier reference to a component that is implemented as part of an inventory item.", "type": "string", "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "props": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_property" } }, "links": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_link" } }, "responsible-parties": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_responsible-party" } }, "remarks": { "$ref": "#field_oscal-metadata_remarks" } }, "required": [ "component-uuid" ], "additionalProperties": false } }, "remarks": { "$ref": "#field_oscal-metadata_remarks" } }, "additionalProperties": false }, "oscal-component-definition-oscal-implementation-common:set-parameter": { "title": "Set Parameter Value", "description": "Identifies the parameter that will be set by the enclosed value.", "required": [ "param-id", "values" ], "type": "object", "properties": { "param-id": { "title": "Parameter ID", "description": "A human-oriented reference to a parameter within a control, who's catalog has been imported into the current implementation context.", "type": "string", "pattern": "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$" }, "values": { "type": "array", "minItems": 1, "items": { "title": "Parameter Value", "description": "A parameter value or set of values.", "type": "string", "pattern": "^\\S(.*\\S)?$" } }, "remarks": { "$ref": "#field_oscal-metadata_remarks" } }, "additionalProperties": false }, "oscal-component-definition-oscal-implementation-common:system-id": { "title": "System Identification", "description": "A human-oriented, globally unique identifier with cross-instance scope that can be used to reference this system identification property elsewhere in this or other OSCAL instances. When referencing an externally defined system identification, the system identification must be used in the context of the external / imported OSCAL instance (e.g., uri-reference). This string should be assigned per-subject, which means it should be consistently used to identify the same system across revisions of the document.", "required": [ "id" ], "type": "object", "properties": { "identifier-type": { "title": "Identification System Type", "description": "Identifies the identification system from which the provided identifier was assigned.", "type": "string", "format": "uri", "pattern": "^[a-zA-Z][a-zA-Z0-9+\\-.]+:.+$" }, "id": { "type": "string" } }, "additionalProperties": false }, "oscal-component-definition-oscal-metadata:metadata": { "title": "Publication metadata", "description": "Provides information about the publication and availability of the containing document.", "required": [ "title", "last-modified", "version", "oscal-version" ], "type": "object", "properties": { "title": { "title": "Document Title", "description": "A name given to the document, which may be used by a tool for display and navigation.", "type": "string" }, "published": { "$ref": "#field_oscal-metadata_published" }, "last-modified": { "$ref": "#field_oscal-metadata_last-modified" }, "version": { "$ref": "#field_oscal-metadata_version" }, "oscal-version": { "$ref": "#field_oscal-metadata_oscal-version" }, "revisions": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_revision" } }, "document-ids": { "type": "array", "minItems": 1, "items": { "$ref": "#field_oscal-metadata_document-id" } }, "props": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_property" } }, "links": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_link" } }, "roles": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_role" } }, "locations": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_location" } }, "parties": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_party" } }, "responsible-parties": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_responsible-party" } }, "remarks": { "$ref": "#field_oscal-metadata_remarks" } }, "additionalProperties": false }, "oscal-component-definition-oscal-metadata:revision": { "title": "Revision History Entry", "description": "An entry in a sequential list of revisions to the containing document in reverse chronological order (i.e., most recent previous revision first).", "required": [ "version" ], "type": "object", "properties": { "title": { "title": "Document Title", "description": "A name given to the document revision, which may be used by a tool for display and navigation.", "type": "string" }, "published": { "$ref": "#field_oscal-metadata_published" }, "last-modified": { "$ref": "#field_oscal-metadata_last-modified" }, "version": { "$ref": "#field_oscal-metadata_version" }, "oscal-version": { "$ref": "#field_oscal-metadata_oscal-version" }, "props": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_property" } }, "links": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_link" } }, "remarks": { "$ref": "#field_oscal-metadata_remarks" } }, "additionalProperties": false }, "oscal-component-definition-oscal-metadata:location": { "title": "Location", "description": "A location, with associated metadata that can be referenced.", "required": [ "uuid", "address" ], "type": "object", "properties": { "uuid": { "title": "Location Universally Unique Identifier", "description": "A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this defined location elsewhere in this or other OSCAL instances. The locally defined UUID of the location can be used to reference the data item locally or globally (e.g., from an importing OSCAL instance). This UUID should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.", "type": "string", "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "title": { "title": "Location Title", "description": "A name given to the location, which may be used by a tool for display and navigation.", "type": "string" }, "address": { "$ref": "#assembly_oscal-metadata_address" }, "email-addresses": { "type": "array", "minItems": 1, "items": { "$ref": "#field_oscal-metadata_email-address" } }, "telephone-numbers": { "type": "array", "minItems": 1, "items": { "$ref": "#field_oscal-metadata_telephone-number" } }, "urls": { "type": "array", "minItems": 1, "items": { "title": "Location URL", "description": "The uniform resource locator (URL) for a web site or Internet presence associated with the location.", "type": "string", "format": "uri", "pattern": "^[a-zA-Z][a-zA-Z0-9+\\-.]+:.+$" } }, "props": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_property" } }, "links": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_link" } }, "remarks": { "$ref": "#field_oscal-metadata_remarks" } }, "additionalProperties": false }, "oscal-component-definition-oscal-metadata:location-uuid": { "title": "Location Reference", "description": "A machine-oriented identifier reference to a location defined in the metadata section of this or another OSCAL instance. The UUID of the location in the source OSCAL instance is sufficient to reference the data item locally or globally (e.g., in an imported OSCAL instance).", "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$", "type": "string" }, "oscal-component-definition-oscal-metadata:party": { "title": "Party (organization or person)", "description": "A responsible entity which is either a person or an organization.", "required": [ "uuid", "type" ], "type": "object", "properties": { "uuid": { "title": "Party Universally Unique Identifier", "description": "A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this defined party elsewhere in this or other OSCAL instances. The locally defined UUID of the party can be used to reference the data item locally or globally (e.g., from an importing OSCAL instance). This UUID should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.", "type": "string", "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "type": { "title": "Party Type", "description": "A category describing the kind of party the object describes.", "type": "string", "pattern": "^\\S(.*\\S)?$", "enum": [ "person", "organization" ] }, "name": { "title": "Party Name", "description": "The full name of the party. This is typically the legal name associated with the party.", "type": "string", "pattern": "^\\S(.*\\S)?$" }, "short-name": { "title": "Party Short Name", "description": "A short common name, abbreviation, or acronym for the party.", "type": "string", "pattern": "^\\S(.*\\S)?$" }, "external-ids": { "type": "array", "minItems": 1, "items": { "title": "Party External Identifier", "description": "An identifier for a person or organization using a designated scheme. e.g. an Open Researcher and Contributor ID (ORCID)", "type": "object", "properties": { "scheme": { "title": "External Identifier Schema", "description": "Indicates the type of external identifier.", "type": "string", "format": "uri", "pattern": "^[a-zA-Z][a-zA-Z0-9+\\-.]+:.+$" }, "id": { "type": "string" } }, "required": [ "id", "scheme" ], "additionalProperties": false } }, "props": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_property" } }, "links": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_link" } }, "email-addresses": { "type": "array", "minItems": 1, "items": { "$ref": "#field_oscal-metadata_email-address" } }, "telephone-numbers": { "type": "array", "minItems": 1, "items": { "$ref": "#field_oscal-metadata_telephone-number" } }, "addresses": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_address" } }, "location-uuids": { "type": "array", "minItems": 1, "items": { "$ref": "#field_oscal-metadata_location-uuid" } }, "member-of-organizations": { "type": "array", "minItems": 1, "items": { "title": "Organizational Affiliation", "description": "A machine-oriented identifier reference to another party (person or organization) that this subject is associated with. The UUID of the party in the source OSCAL instance is sufficient to reference the data item locally or globally (e.g., in an imported OSCAL instance).", "type": "string", "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" } }, "remarks": { "$ref": "#field_oscal-metadata_remarks" } }, "additionalProperties": false }, "oscal-component-definition-oscal-metadata:party-uuid": { "title": "Party Reference", "description": "A machine-oriented identifier reference to another party defined in metadata. The UUID of the party in the source OSCAL instance is sufficient to reference the data item locally or globally (e.g., in an imported OSCAL instance).", "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$", "type": "string" }, "oscal-component-definition-oscal-metadata:role": { "title": "Role", "description": "Defines a function assumed or expected to be assumed by a party in a specific situation.", "required": [ "id", "title" ], "type": "object", "properties": { "id": { "title": "Role Identifier", "description": "A human-oriented, locally unique identifier with cross-instance scope that can be used to reference this defined role elsewhere in this or other OSCAL instances. When referenced from another OSCAL instance, the locally defined ID of the Role from the imported OSCAL instance must be referenced in the context of the containing resource (e.g., import, import-component-definition, import-profile, import-ssp or import-ap). This ID should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.", "type": "string", "pattern": "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$" }, "title": { "title": "Role Title", "description": "A name given to the role, which may be used by a tool for display and navigation.", "type": "string" }, "short-name": { "title": "Role Short Name", "description": "A short common name, abbreviation, or acronym for the role.", "type": "string", "pattern": "^\\S(.*\\S)?$" }, "description": { "title": "Role Description", "description": "A summary of the role's purpose and associated responsibilities.", "type": "string" }, "props": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_property" } }, "links": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_link" } }, "remarks": { "$ref": "#field_oscal-metadata_remarks" } }, "additionalProperties": false }, "oscal-component-definition-oscal-metadata:role-id": { "title": "Role Identifier Reference", "description": "A human-oriented identifier reference to roles served by the user.", "pattern": "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$", "type": "string" }, "oscal-component-definition-oscal-metadata:back-matter": { "title": "Back matter", "description": "A collection of resources, which may be included directly or by reference.", "properties": { "resources": { "type": "array", "minItems": 1, "items": { "title": "Resource", "description": "A resource associated with content in the containing document. A resource may be directly included in the document base64 encoded or may point to one or more equivalent internet resources.", "type": "object", "properties": { "uuid": { "title": "Resource Universally Unique Identifier", "description": "A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this defined resource elsewhere in this or other OSCAL instances. This UUID should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.", "type": "string", "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "title": { "title": "Resource Title", "description": "A name given to the resource, which may be used by a tool for display and navigation.", "type": "string" }, "description": { "title": "Resource Description", "description": "A short summary of the resource used to indicate the purpose of the resource.", "type": "string" }, "props": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_property" } }, "document-ids": { "type": "array", "minItems": 1, "items": { "$ref": "#field_oscal-metadata_document-id" } }, "citation": { "title": "Citation", "description": "A citation consisting of end note text and optional structured bibliographic data.", "type": "object", "properties": { "text": { "title": "Citation Text", "description": "A line of citation text.", "type": "string" }, "props": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_property" } }, "links": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_link" } } }, "required": [ "text" ], "additionalProperties": false }, "rlinks": { "type": "array", "minItems": 1, "items": { "title": "Resource link", "description": "A pointer to an external resource with an optional hash for verification and change detection.", "type": "object", "properties": { "href": { "title": "Hypertext Reference", "description": "A resolvable URI reference to a resource.", "type": "string", "format": "uri-reference" }, "media-type": { "title": "Media Type", "description": "Specifies a media type as defined by the Internet Assigned Numbers Authority (IANA) Media Types Registry.", "type": "string", "pattern": "^\\S(.*\\S)?$" }, "hashes": { "type": "array", "minItems": 1, "items": { "$ref": "#field_oscal-metadata_hash" } } }, "required": [ "href" ], "additionalProperties": false } }, "base64": { "title": "Base64", "description": "The Base64 alphabet in RFC 2045 - aligned with XSD.", "type": "object", "properties": { "filename": { "title": "File Name", "description": "Name of the file before it was encoded as Base64 to be embedded in a resource. This is the name that will be assigned to the file when the file is decoded.", "type": "string", "format": "uri-reference" }, "media-type": { "title": "Media Type", "description": "Specifies a media type as defined by the Internet Assigned Numbers Authority (IANA) Media Types Registry.", "type": "string", "pattern": "^\\S(.*\\S)?$" }, "value": { "type": "string" } }, "required": [ "value" ], "additionalProperties": false }, "remarks": { "$ref": "#field_oscal-metadata_remarks" } }, "required": [ "uuid" ], "additionalProperties": false } } }, "type": "object", "additionalProperties": false }, "oscal-component-definition-oscal-metadata:property": { "title": "Property", "description": "An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair. The value of a property is a simple scalar value, which may be expressed as a list of values.", "required": [ "name", "value" ], "type": "object", "properties": { "name": { "title": "Property Name", "description": "A textual label that uniquely identifies a specific attribute, characteristic, or quality of the property's containing object.", "type": "string", "pattern": "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$" }, "uuid": { "title": "Property Universally Unique Identifier", "description": "A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this defined property elsewhere in this or other OSCAL instances. This UUID should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.", "type": "string", "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$" }, "ns": { "title": "Property Namespace", "description": "A namespace qualifying the property's name. This allows different organizations to associate distinct semantics with the same name.", "type": "string", "format": "uri", "pattern": "^[a-zA-Z][a-zA-Z0-9+\\-.]+:.+$" }, "value": { "title": "Property Value", "description": "Indicates the value of the attribute, characteristic, or quality.", "type": "string", "pattern": "^\\S(.*\\S)?$" }, "class": { "title": "Property Class", "description": "A textual label that provides a sub-type or characterization of the property's name. This can be used to further distinguish or discriminate between the semantics of multiple properties of the same object with the same name and ns.", "type": "string", "pattern": "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$" }, "remarks": { "$ref": "#field_oscal-metadata_remarks" } }, "additionalProperties": false }, "oscal-component-definition-oscal-metadata:link": { "title": "Link", "description": "A reference to a local or remote resource", "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Hypertext Reference", "description": "A resolvable URL reference to a resource.", "type": "string", "format": "uri-reference" }, "rel": { "title": "Relation", "description": "Describes the type of relationship provided by the link. This can be an indicator of the link's purpose.", "type": "string", "pattern": "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$" }, "media-type": { "title": "Media Type", "description": "Specifies a media type as defined by the Internet Assigned Numbers Authority (IANA) Media Types Registry.", "type": "string", "pattern": "^\\S(.*\\S)?$" }, "text": { "title": "Link Text", "description": "A textual label to associate with the link, which may be used for presentation in a tool.", "type": "string" } }, "additionalProperties": false }, "oscal-component-definition-oscal-metadata:responsible-party": { "title": "Responsible Party", "description": "A reference to a set of organizations or persons that have responsibility for performing a referenced role in the context of the containing object.", "required": [ "role-id", "party-uuids" ], "type": "object", "properties": { "role-id": { "title": "Responsible Role", "description": "A human-oriented identifier reference to roles served by the user.", "type": "string", "pattern": "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$" }, "party-uuids": { "type": "array", "minItems": 1, "items": { "$ref": "#field_oscal-metadata_party-uuid" } }, "props": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_property" } }, "links": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_link" } }, "remarks": { "$ref": "#field_oscal-metadata_remarks" } }, "additionalProperties": false }, "oscal-component-definition-oscal-metadata:responsible-role": { "title": "Responsible Role", "description": "A reference to one or more roles with responsibility for performing a function relative to the containing object.", "required": [ "role-id" ], "type": "object", "properties": { "role-id": { "title": "Responsible Role ID", "description": "A human-oriented identifier reference to roles responsible for the business function.", "type": "string", "pattern": "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$" }, "props": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_property" } }, "links": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_link" } }, "party-uuids": { "type": "array", "minItems": 1, "items": { "$ref": "#field_oscal-metadata_party-uuid" } }, "remarks": { "$ref": "#field_oscal-metadata_remarks" } }, "additionalProperties": false }, "oscal-component-definition-oscal-metadata:hash": { "title": "Hash", "description": "A representation of a cryptographic digest generated over a resource using a specified hash algorithm.", "required": [ "value", "algorithm" ], "type": "object", "properties": { "algorithm": { "title": "Hash algorithm", "description": "Method by which a hash is derived", "type": "string", "pattern": "^\\S(.*\\S)?$" }, "value": { "type": "string" } }, "additionalProperties": false }, "oscal-component-definition-oscal-metadata:remarks": { "title": "Remarks", "description": "Additional commentary on the containing object.", "type": "string" }, "oscal-component-definition-oscal-metadata:published": { "title": "Publication Timestamp", "description": "The date and time the document was published. The date-time value must be formatted according to RFC 3339 with full time and time zone included.", "pattern": "^((2000|2400|2800|(19|2[0-9](0[48]|[2468][048]|[13579][26])))-02-29)|(((19|2[0-9])[0-9]{2})-02-(0[1-9]|1[0-9]|2[0-8]))|(((19|2[0-9])[0-9]{2})-(0[13578]|10|12)-(0[1-9]|[12][0-9]|3[01]))|(((19|2[0-9])[0-9]{2})-(0[469]|11)-(0[1-9]|[12][0-9]|30))T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$", "type": "string", "format": "date-time" }, "oscal-component-definition-oscal-metadata:last-modified": { "title": "Last Modified Timestamp", "description": "The date and time the document was last modified. The date-time value must be formatted according to RFC 3339 with full time and time zone included.", "pattern": "^((2000|2400|2800|(19|2[0-9](0[48]|[2468][048]|[13579][26])))-02-29)|(((19|2[0-9])[0-9]{2})-02-(0[1-9]|1[0-9]|2[0-8]))|(((19|2[0-9])[0-9]{2})-(0[13578]|10|12)-(0[1-9]|[12][0-9]|3[01]))|(((19|2[0-9])[0-9]{2})-(0[469]|11)-(0[1-9]|[12][0-9]|30))T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$", "type": "string", "format": "date-time" }, "oscal-component-definition-oscal-metadata:version": { "title": "Document Version", "description": "A string used to distinguish the current version of the document from other previous (and future) versions.", "pattern": "^\\S(.*\\S)?$", "type": "string" }, "oscal-component-definition-oscal-metadata:oscal-version": { "title": "OSCAL version", "description": "The OSCAL model version the document was authored against.", "pattern": "^\\S(.*\\S)?$", "type": "string" }, "oscal-component-definition-oscal-metadata:email-address": { "title": "Email Address", "description": "An email address as defined by RFC 5322 Section 3.4.1.", "pattern": "^.+@.+$", "type": "string", "format": "email" }, "oscal-component-definition-oscal-metadata:telephone-number": { "title": "Telephone Number", "description": "Contact number by telephone.", "required": [ "number" ], "type": "object", "properties": { "type": { "title": "type flag", "description": "Indicates the type of phone number.", "type": "string", "pattern": "^\\S(.*\\S)?$" }, "number": { "type": "string" } }, "additionalProperties": false }, "oscal-component-definition-oscal-metadata:address": { "title": "Address", "description": "A postal address for the location.", "properties": { "type": { "title": "Address Type", "description": "Indicates the type of address.", "type": "string", "pattern": "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$" }, "addr-lines": { "type": "array", "minItems": 1, "items": { "$ref": "#field_oscal-metadata_addr-line" } }, "city": { "title": "City", "description": "City, town or geographical region for the mailing address.", "type": "string", "pattern": "^\\S(.*\\S)?$" }, "state": { "title": "State", "description": "State, province or analogous geographical region for mailing address", "type": "string", "pattern": "^\\S(.*\\S)?$" }, "postal-code": { "title": "Postal Code", "description": "Postal or ZIP code for mailing address", "type": "string", "pattern": "^\\S(.*\\S)?$" }, "country": { "title": "Country Code", "description": "The ISO 3166-1 alpha-2 country code for the mailing address.", "type": "string", "pattern": "^\\S(.*\\S)?$" } }, "type": "object", "additionalProperties": false }, "oscal-component-definition-oscal-metadata:addr-line": { "title": "Address line", "description": "A single line of an address.", "pattern": "^\\S(.*\\S)?$", "type": "string" }, "oscal-component-definition-oscal-metadata:document-id": { "title": "Document Identifier", "description": "A document identifier qualified by an identifier scheme. A document identifier provides a globally unique identifier with a cross-instance scope that is used for a group of documents that are to be treated as different versions of the same document. If this element does not appear, or if the value of this element is empty, the value of \"document-id\" is equal to the value of the \"uuid\" flag of the top-level root element.", "required": [ "identifier" ], "type": "object", "properties": { "scheme": { "title": "Document Identification Scheme", "description": "Qualifies the kind of document identifier using a URI. If the scheme is not provided the value of the element will be interpreted as a string of characters.", "type": "string", "format": "uri", "pattern": "^[a-zA-Z][a-zA-Z0-9+\\-.]+:.+$" }, "identifier": { "type": "string" } }, "additionalProperties": false }, "oscal-component-definition-oscal-catalog-common:part": { "title": "Part", "description": "A partition of a control's definition or a child of another part.", "required": [ "name" ], "type": "object", "properties": { "id": { "title": "Part Identifier", "description": "A human-oriented, locally unique identifier with cross-instance scope that can be used to reference this defined part elsewhere in this or other OSCAL instances. When referenced from another OSCAL instance, this identifier must be referenced in the context of the containing resource (e.g., import-profile). This id should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.", "type": "string", "pattern": "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$" }, "name": { "title": "Part Name", "description": "A textual label that uniquely identifies the part's semantic type.", "type": "string", "pattern": "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$" }, "ns": { "title": "Part Namespace", "description": "A namespace qualifying the part's name. This allows different organizations to associate distinct semantics with the same name.", "type": "string", "format": "uri", "pattern": "^[a-zA-Z][a-zA-Z0-9+\\-.]+:.+$" }, "class": { "title": "Part Class", "description": "A textual label that provides a sub-type or characterization of the part's name. This can be used to further distinguish or discriminate between the semantics of multiple parts of the same control with the same name and ns.", "type": "string", "pattern": "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$" }, "title": { "title": "Part Title", "description": "A name given to the part, which may be used by a tool for display and navigation.", "type": "string" }, "props": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_property" } }, "prose": { "title": "Part Text", "description": "Permits multiple paragraphs, lists, tables etc.", "type": "string" }, "parts": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-catalog-common_part" } }, "links": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_link" } } }, "additionalProperties": false }, "oscal-component-definition-oscal-catalog-common:parameter": { "title": "Parameter", "description": "Parameters provide a mechanism for the dynamic assignment of value(s) in a control.", "required": [ "id" ], "type": "object", "properties": { "id": { "title": "Parameter Identifier", "description": "A human-oriented, locally unique identifier with cross-instance scope that can be used to reference this defined parameter elsewhere in this or other OSCAL instances. When referenced from another OSCAL instance, this identifier must be referenced in the context of the containing resource (e.g., import-profile). This id should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.", "type": "string", "pattern": "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$" }, "class": { "title": "Parameter Class", "description": "A textual label that provides a characterization of the parameter.", "type": "string", "pattern": "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$" }, "depends-on": { "title": "Depends on", "description": "**(deprecated)** Another parameter invoking this one. This construct has been deprecated and should not be used.", "type": "string", "pattern": "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$" }, "props": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_property" } }, "links": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-metadata_link" } }, "label": { "title": "Parameter Label", "description": "A short, placeholder name for the parameter, which can be used as a substitute for a value if no value is assigned.", "type": "string" }, "usage": { "title": "Parameter Usage Description", "description": "Describes the purpose and use of a parameter", "type": "string" }, "constraints": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-catalog-common_parameter-constraint" } }, "guidelines": { "type": "array", "minItems": 1, "items": { "$ref": "#assembly_oscal-catalog-common_parameter-guideline" } }, "values": { "type": "array", "minItems": 1, "items": { "$ref": "#field_oscal-catalog-common_parameter-value" } }, "select": { "$ref": "#assembly_oscal-catalog-common_parameter-selection" }, "remarks": { "$ref": "#field_oscal-metadata_remarks" } }, "additionalProperties": false }, "oscal-component-definition-oscal-catalog-common:parameter-constraint": { "title": "Constraint", "description": "A formal or informal expression of a constraint or test", "properties": { "description": { "title": "Constraint Description", "description": "A textual summary of the constraint to be applied.", "type": "string" }, "tests": { "type": "array", "minItems": 1, "items": { "title": "Constraint Test", "description": "A test expression which is expected to be evaluated by a tool.", "type": "object", "properties": { "expression": { "title": "Constraint test", "description": "A formal (executable) expression of a constraint", "type": "string", "pattern": "^\\S(.*\\S)?$" }, "remarks": { "$ref": "#field_oscal-metadata_remarks" } }, "required": [ "expression" ], "additionalProperties": false } } }, "type": "object", "additionalProperties": false }, "oscal-component-definition-oscal-catalog-common:parameter-guideline": { "title": "Guideline", "description": "A prose statement that provides a recommendation for the use of a parameter.", "required": [ "prose" ], "type": "object", "properties": { "prose": { "title": "Guideline Text", "description": "Prose permits multiple paragraphs, lists, tables etc.", "type": "string" } }, "additionalProperties": false }, "oscal-component-definition-oscal-catalog-common:parameter-value": { "title": "Parameter Value", "description": "A parameter value or set of values.", "pattern": "^\\S(.*\\S)?$", "type": "string" }, "oscal-component-definition-oscal-catalog-common:parameter-selection": { "title": "Selection", "description": "Presenting a choice among alternatives", "properties": { "how-many": { "title": "Parameter Cardinality", "description": "Describes the number of selections that must occur. Without this setting, only one value should be assumed to be permitted.", "type": "string", "pattern": "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$", "enum": [ "one", "one-or-more" ] }, "choice": { "type": "array", "minItems": 1, "items": { "title": "Choice", "description": "A value selection among several such options", "type": "string" } } }, "type": "object", "additionalProperties": false }, "oscal-component-definition-oscal-catalog-common:include-all": { "title": "Include All", "description": "Include all controls from the imported catalog or profile resources.", "type": "object", "additionalProperties": false } }, "additionalProperties": false, "$comment": "OSCAL Component Definition Model: JSON Schema", "required": [ "component-definition" ], "maxProperties": 1 }