OSCAL Component Definition (CDef)
1.0.1Schema URL
Properties
Definitions
A collection of component descriptions, which may optionally be grouped by capability.
A globally unique identifier for this component definition instance. This UUID should be changed when this document is revised.
Loads a component definition from another resource.
A link to a resource that defines a set of components and/or capabilities to import into this collection.
A defined component that can be part of an implemented system.
The unique identifier for the component.
A category describing the purpose of the component.
A human readable name for the component.
A description of the component, including information about its function.
A summary of the technological or business purpose of the component.
A grouping of other components and/or capabilities.
A unique identifier for a capability.
The capability's human-readable name.
A summary of the capability.
TBD
A reference to a component by its identifier
A description of the component, including information about its function.
Defines how the component or capability supports a set of controls.
A unique identifier for the set of implemented controls.
A reference to an OSCAL catalog or profile providing the referenced control or subcontrol definition.
A description of how the specified set of controls are implemented for the containing component or capability.
Describes how the containing component or capability implements an individual control.
A unique identifier for a specific control implementation.
A reference to a control with a corresponding id value.
A description of how the specified control is implemented for the containing component or capability.
Identifies which statements within a control are addressed.
A reference to a control statement by its identifier
A globally unique identifier that can be used to reference this control statement entry elsewhere in an OSCAL document. A UUID should be consistently used for a given resource across revisions of the document.
A summary of how the containing control statement is implemented by the component or capability.
A defined component that can be part of an implemented system.
The unique identifier for the component.
A category describing the purpose of the component.
A human readable name for the system component.
A description of the component, including information about its function.
Describes the operational status of the system component.
2 nested properties
The operational status.
A summary of the technological or business purpose of the component.
Information about the protocol used to provide a service.
The common name of the protocol, which should be the appropriate "service name" from the IANA Service Name and Transport Protocol Port Number Registry.
A globally unique identifier that can be used to reference this service protocol entry elsewhere in an OSCAL document. A UUID should be consistently used for a given resource across revisions of the document.
A human readable name for the protocol (e.g., Transport Layer Security).
Where applicable this is the IPv4 port range on which the service operates.
Indicates the starting port number in a port range
Indicates the ending port number in a port range
Indicates the transport type.
Indicates the degree to which the a given control is implemented.
Identifies the implementation status of the control or control objective.
A type of user that interacts with the system based on an associated role.
The unique identifier for the user class.
A name given to the user, which may be used by a tool for display and navigation.
A short common name, abbreviation, or acronym for the user.
A summary of the user's purpose within the system.
Identifies a specific system privilege held by the user, along with an associated description and/or rationale for the privilege.
A human readable name for the privilege.
A summary of the privilege's purpose within the system.
Describes a function performed for a given authorized privilege by this user class.
A single managed inventory item within the system.
A globally unique identifier that can be used to reference this inventory item entry elsewhere in an OSCAL document. A UUID should be consistently used for a given resource across revisions of the document.
A summary of the inventory item stating its purpose within the system.
Identifies the parameter that will be set by the enclosed value.
A reference to a parameter within a control, who's catalog has been imported into the current implementation context.
A unique identifier for the system described by this system security plan.
Identifies the identification system from which the provided identifier was assigned.
Provides information about the publication and availability of the containing document.
A name given to the document, which may be used by a tool for display and navigation.
An entry in a sequential list of revisions to the containing document in reverse chronological order (i.e., most recent previous revision first).
A name given to the document revision, which may be used by a tool for display and navigation.
A location, with associated metadata that can be referenced.
A unique identifier that can be used to reference this defined location elsewhere in an OSCAL document. A UUID should be consistently used for a given location across revisions of the document.
A name given to the location, which may be used by a tool for display and navigation.
References a location defined in metadata.
A responsible entity which is either a person or an organization.
A unique identifier that can be used to reference this defined location elsewhere in an OSCAL document. A UUID should be consistently used for a given party across revisions of the document.
A category describing the kind of party the object describes.
The full name of the party. This is typically the legal name associated with the party.
A short common name, abbreviation, or acronym for the party.
References a party defined in metadata.
Defines a function assumed or expected to be assumed by a party in a specific situation.
A unique identifier for a specific role instance. This identifier's uniqueness is document scoped and is intended to be consistent for the same role across minor revisions of the document.
A name given to the role, which may be used by a tool for display and navigation.
A short common name, abbreviation, or acronym for the role.
A summary of the role's purpose and associated responsibilities.
A reference to the roles served by the user.
A collection of resources, which may be included directly or by reference.
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.
A textual label that uniquely identifies a specific attribute, characteristic, or quality of the property's containing object.
Indicates the value of the attribute, characteristic, or quality.
A unique identifier that can be used to reference this property elsewhere in an OSCAL document. A UUID should be consistently used for a given location across revisions of the document.
A namespace qualifying the property's name. This allows different organizations to associate distinct semantics with the same name.
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.
A reference to a local or remote resource
A resolvable URL reference to a resource.
Describes the type of relationship provided by the link. This can be an indicator of the link's purpose.
Specifies a media type as defined by the Internet Assigned Numbers Authority (IANA) Media Types Registry.
A textual label to associate with the link, which may be used for presentation in a tool.
A reference to a set of organizations or persons that have responsibility for performing a referenced role in the context of the containing object.
The role that the party is responsible for.
A reference to one or more roles with responsibility for performing a function relative to the containing object.
The role that is responsible for the business function.
A representation of a cryptographic digest generated over a resource using a specified hash algorithm.
Method by which a hash is derived
Additional commentary on the containing object.
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.
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.
A string used to distinguish the current version of the document from other previous (and future) versions.
The OSCAL model version the document was authored against.
An email address as defined by RFC 5322 Section 3.4.1.
Contact number by telephone.
Indicates the type of phone number.
A postal address for the location.
Indicates the type of address.
City, town or geographical region for the mailing address.
State, province or analogous geographical region for mailing address
Postal or ZIP code for mailing address
The ISO 3166-1 alpha-2 country code for the mailing address.
A single line of an address.
A document identifier qualified by an identifier scheme. A document identifier provides a globally unique identifier 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.
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.
A partition of a control's definition or a child of another part.
A textual label that uniquely identifies the part's semantic type.
A unique identifier for a specific part instance. This identifier's uniqueness is document scoped and is intended to be consistent for the same part across minor revisions of the document.
A namespace qualifying the part's name. This allows different organizations to associate distinct semantics with the same name.
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.
A name given to the part, which may be used by a tool for display and navigation.
Permits multiple paragraphs, lists, tables etc.
Parameters provide a mechanism for the dynamic assignment of value(s) in a control.
A unique identifier for a specific parameter instance. This identifier's uniqueness is document scoped and is intended to be consistent for the same parameter across minor revisions of the document.
A textual label that provides a characterization of the parameter.
Another parameter invoking this one
A short, placeholder name for the parameter, which can be used as a substitute for a value if no value is assigned.
Describes the purpose and use of a parameter
A formal or informal expression of a constraint or test
A textual summary of the constraint to be applied.
A prose statement that provides a recommendation for the use of a parameter.
Prose permits multiple paragraphs, lists, tables etc.
A parameter value or set of values.
Presenting a choice among alternatives
Describes the number of selections that must occur. Without this setting, only one value should be assumed to be permitted.