OSCAL Component Definition (CDef)
NIST Open Security Controls Assessment Language (OSCAL) Component Definition. (https://pages.nist.gov/OSCAL-Reference)
| Type | object |
|---|---|
| File match |
oscal*component.json
oscal*cdef.json
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/oscal-component-definition-cdef/latest.json |
| Source | https://github.com/usnistgov/OSCAL/releases/download/v1.1.2/oscal_component_schema.json |
Versions
Validate with Lintel
npx @lintel/lintel checkProperties
Definitions
A URI Reference, either a URI or a relative-reference, formatted according to section 4.1 of RFC3986.
A collection of component descriptions, which may optionally be grouped by capability.
A type 4 ('random' or 'pseudorandom') or type 5 UUID per RFC 4122.
Loads a component definition from another resource.
A URI Reference, either a URI or a relative-reference, formatted according to section 4.1 of RFC3986.
A defined component that can be part of an implemented system.
A type 4 ('random' or 'pseudorandom') or type 5 UUID per RFC 4122.
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 type 4 ('random' or 'pseudorandom') or type 5 UUID per RFC 4122.
A non-empty string with leading and trailing whitespace disallowed. Whitespace is: U+9, U+10, U+32 or [ ]+
A summary of the capability.
The collection of components comprising this capability.
A type 4 ('random' or 'pseudorandom') or type 5 UUID per RFC 4122.
A description of the component, including information about its function.
Defines how the component or capability supports a set of controls.
A type 4 ('random' or 'pseudorandom') or type 5 UUID per RFC 4122.
A URI Reference, either a URI or a relative-reference, formatted according to section 4.1 of RFC3986.
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 type 4 ('random' or 'pseudorandom') or type 5 UUID per RFC 4122.
A non-colonized name as defined by XML Schema Part 2: Datatypes Second Edition. https://www.w3.org/TR/xmlschema11-2/#NCName.
A suggestion from the supplier (e.g., component vendor or author) for how the specified control may be implemented if the containing component or capability is instantiated in a system security plan.
Identifies which statements within a control are addressed.
A non-colonized name as defined by XML Schema Part 2: Datatypes Second Edition. https://www.w3.org/TR/xmlschema11-2/#NCName.
A type 4 ('random' or 'pseudorandom') or type 5 UUID per RFC 4122.
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.
A type 4 ('random' or 'pseudorandom') or type 5 UUID per RFC 4122.
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
A summary of the technological or business purpose of the component.
Information about the protocol used to provide a service.
A non-empty string with leading and trailing whitespace disallowed. Whitespace is: U+9, U+10, U+32 or [ ]+
A type 4 ('random' or 'pseudorandom') or type 5 UUID per RFC 4122.
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 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.
A type 4 ('random' or 'pseudorandom') or type 5 UUID per RFC 4122.
A name given to the user, which may be used by a tool for display and navigation.
A non-empty string with leading and trailing whitespace disallowed. Whitespace is: U+9, U+10, U+32 or [ ]+
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.
A non-empty string with leading and trailing whitespace disallowed. Whitespace is: U+9, U+10, U+32 or [ ]+
A single managed inventory item within the system.
A type 4 ('random' or 'pseudorandom') or type 5 UUID per RFC 4122.
A summary of the inventory item stating its purpose within the system.
Identifies the parameter that will be set by the enclosed value.
A non-colonized name as defined by XML Schema Part 2: Datatypes Second Edition. https://www.w3.org/TR/xmlschema11-2/#NCName.
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.
A non-empty string with leading and trailing whitespace disallowed. Whitespace is: U+9, U+10, U+32 or [ ]+
Identifies the identification system from which the provided identifier was assigned.
Provides information about the containing document, and defines concepts that are shared across the document.
A name given to the document, which may be used by a tool for display and navigation.
A type 4 ('random' or 'pseudorandom') or type 5 UUID per RFC 4122.
A type 4 ('random' or 'pseudorandom') or type 5 UUID per RFC 4122.
A non-colonized name as defined by XML Schema Part 2: Datatypes Second Edition. https://www.w3.org/TR/xmlschema11-2/#NCName.
A collection of resources that may be referenced from within the OSCAL document instance.
An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair.
A non-colonized name as defined by XML Schema Part 2: Datatypes Second Edition. https://www.w3.org/TR/xmlschema11-2/#NCName.
A non-empty string with leading and trailing whitespace disallowed. Whitespace is: U+9, U+10, U+32 or [ ]+
A type 4 ('random' or 'pseudorandom') or type 5 UUID per RFC 4122.
A universal resource identifier (URI) formatted according to RFC3986.
A non-colonized name as defined by XML Schema Part 2: Datatypes Second Edition. https://www.w3.org/TR/xmlschema11-2/#NCName.
A non-colonized name as defined by XML Schema Part 2: Datatypes Second Edition. https://www.w3.org/TR/xmlschema11-2/#NCName.
A reference to a local or remote resource, that has a specific relation to the containing object.
A URI Reference, either a URI or a relative-reference, formatted according to section 4.1 of RFC3986.
Describes the type of relationship provided by the link's hypertext reference. This can be an indicator of the link's purpose.
A non-empty string with leading and trailing whitespace disallowed. Whitespace is: U+9, U+10, U+32 or [ ]+
A non-empty string with leading and trailing whitespace disallowed. Whitespace is: U+9, U+10, U+32 or [ ]+
A textual label to associate with the link, which may be used for presentation in a tool.
A reference to a set of persons and/or organizations that have responsibility for performing the referenced role in the context of the containing object.
A non-colonized name as defined by XML Schema Part 2: Datatypes Second Edition. https://www.w3.org/TR/xmlschema11-2/#NCName.
An action applied by a role within a given party to the content.
A type 4 ('random' or 'pseudorandom') or type 5 UUID per RFC 4122.
A non-colonized name as defined by XML Schema Part 2: Datatypes Second Edition. https://www.w3.org/TR/xmlschema11-2/#NCName.
A universal resource identifier (URI) formatted according to RFC3986.
A string representing a point in time with a required timezone.
A reference to a role with responsibility for performing a function relative to the containing object, optionally associated with a set of persons and/or organizations that perform that role.
A non-colonized name as defined by XML Schema Part 2: Datatypes Second Edition. https://www.w3.org/TR/xmlschema11-2/#NCName.
A representation of a cryptographic digest generated over a resource using a specified hash algorithm.
The digest method by which a hash is derived.
A non-empty string with leading and trailing whitespace disallowed. Whitespace is: U+9, U+10, U+32 or [ ]+
Additional commentary about the containing object.
A string representing a point in time with a required timezone.
A string representing a point in time with a required timezone.
A non-empty string with leading and trailing whitespace disallowed. Whitespace is: U+9, U+10, U+32 or [ ]+
A non-empty string with leading and trailing whitespace disallowed. Whitespace is: U+9, U+10, U+32 or [ ]+
An email address string formatted according to RFC 6531.
A telephone service number as defined by ITU-T E.164.
A non-empty string with leading and trailing whitespace disallowed. Whitespace is: U+9, U+10, U+32 or [ ]+
Indicates the type of phone number.
A postal address for the location.
Indicates the type of address.
A non-empty string with leading and trailing whitespace disallowed. Whitespace is: U+9, U+10, U+32 or [ ]+
A non-empty string with leading and trailing whitespace disallowed. Whitespace is: U+9, U+10, U+32 or [ ]+
A non-empty string with leading and trailing whitespace disallowed. Whitespace is: U+9, U+10, U+32 or [ ]+
A non-empty string with leading and trailing whitespace disallowed. Whitespace is: U+9, U+10, U+32 or [ ]+
A non-empty string with leading and trailing whitespace disallowed. Whitespace is: U+9, U+10, U+32 or [ ]+
A document identifier qualified by an identifier scheme.
A non-empty string with leading and trailing whitespace disallowed. Whitespace is: U+9, U+10, U+32 or [ ]+
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.
An annotated, markup-based textual element of a control's or catalog group's definition, or a child of another part.
A non-colonized name as defined by XML Schema Part 2: Datatypes Second Edition. https://www.w3.org/TR/xmlschema11-2/#NCName.
A non-colonized name as defined by XML Schema Part 2: Datatypes Second Edition. https://www.w3.org/TR/xmlschema11-2/#NCName.
A universal resource identifier (URI) formatted according to RFC3986.
A non-colonized name as defined by XML Schema Part 2: Datatypes Second Edition. https://www.w3.org/TR/xmlschema11-2/#NCName.
An optional 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 non-colonized name as defined by XML Schema Part 2: Datatypes Second Edition. https://www.w3.org/TR/xmlschema11-2/#NCName.
A non-colonized name as defined by XML Schema Part 2: Datatypes Second Edition. https://www.w3.org/TR/xmlschema11-2/#NCName.
A non-colonized name as defined by XML Schema Part 2: Datatypes Second Edition. https://www.w3.org/TR/xmlschema11-2/#NCName.
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 non-empty string with leading and trailing whitespace disallowed. Whitespace is: U+9, U+10, U+32 or [ ]+
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.
Include all controls from the imported catalog or profile resources.
Binary data encoded using the Base 64 encoding algorithm as defined by RFC4648.
A string representing a point in time with a required timezone.
An email address string formatted according to RFC 6531.
A whole number value.
An integer value that is equal to or greater than 0.
A non-empty string with leading and trailing whitespace disallowed. Whitespace is: U+9, U+10, U+32 or [ ]+
A non-colonized name as defined by XML Schema Part 2: Datatypes Second Edition. https://www.w3.org/TR/xmlschema11-2/#NCName.
A universal resource identifier (URI) formatted according to RFC3986.
A URI Reference, either a URI or a relative-reference, formatted according to section 4.1 of RFC3986.
A type 4 ('random' or 'pseudorandom') or type 5 UUID per RFC 4122.