target. This value cannot be less than the
corresponding value defined on the target.target. This value must be less than the corresponding
@@ -881,7 +975,7 @@
This reference should be to the globally scoped flag "global-flag" from the imported metaschema.
-This reference should be to the globally scoped flag "global-flag" from the importing metaschema. This definition is taking precedence over the other definition imported (with the same name).
-This is the imported "imported-flags" assembly.
-Exercises features wrt naming JSON properties on fields static value key assignment dynamic value key assignment
+Exercises features wrt naming JSON properties on fields + static value key assignment + dynamic value key assignment
+For exercising Metaschema semantics with respect to modular assembly and composition.
This contains all modules common to the assessment plan, assessment results, and POAM models.
-The root of the OSCAL Assessment Plan format is assessment-plan.
The root of the OSCAL Assessment Results format is assessment-results.
The root of the OSCAL Plan of Action and Milestones (POA&M) format is plan-of-action-and-milestones.
The value of the href can be an internet resource, or a local reference using a fragment e.g. #fragment that points to a back-matter resource in the same document.
If a local reference using a fragment is used, this will be indicated by a fragment "#" followed by an identifier which references an identified resource in the document's back-matter or another object that is within the scope of the containing OSCAL document.
If an internet resource is used, the href value will be an absolute or relative URI pointing to the location of the referenced resource. A relative URI will be resolved relative to the location of the document containing the link.
The specified control-id must be a valid value within the baseline identified by the target system's SSP via the import-profile statement.
This can be optionally used to define the set of controls and control objectives that are assessed by this step.
-Identifies the roles, and optionally the parties, associated with this step that is part of an assessment activity.
-Since multiple party-uuid entries can be provided, each role-id must be referenced only once.
This can be optionally used to define the set of controls and control objectives that are assessed or remediated by this activity.
-Since responsible-role associates multiple party-uuid entries with a single role-id, each role-id must be referenced only once.
Since responsible-role associates multiple party-uuid entries with a single role-id, each role-id must be referenced only once.
Identifies the person or organization responsible for performing a specific role defined by the activity.
-Since responsible-role associates multiple party-uuid entries with a single role-id, each role-id must be referenced only once.
The assessment subjects that the activity was performed against.
-Identifies the person or organization responsible for performing a specific role related to the task.
-Used to select a control for inclusion by the control's identifier. Specific control statements can be selected by their statement identifier.
-Used to select a control for exclusion by the control's identifier. Specific control statements can be excluded by their statement identifier.
-The include-all, specifies all control identified in the baseline are included in the scope if this assessment, as specified by the include-profile statement within the linked SSP.
Any control specified within exclude-controls must first be within a range of explicitly included controls, via include-controls or include-all.
Used to select a control objective for inclusion by the control objective's identifier.
-Used to select a control objective for exclusion by the control objective's identifier.
-The include-all field, specifies all control objectives for any in-scope control. In-scope controls are defined in the control-selection.
Any control objective specified within exclude-controls must first be within a range of explicitly included control objectives, via include-objectives or include-all.
In the context of an assessment plan, this construct is used to identify the controls and control objectives that are to be assessed. In the context of an assessment result, this construct is used to identify the actual controls and objectives that were assessed, reflecting any changes from the plan.
-When resolving the selection of controls and control objectives, the following processing will occur:
-1. Controls will be resolved by creating a set of controls based on the control-selections by first handling the includes, and then removing any excluded controls.
-2. The set of control objectives will be resolved from the set of controls that was generated in the previous step. The set of control objectives is based on the control-objective-selection by first handling the includes, and then removing any excluded control objectives.
-local-definitions of an Assessment Plan or Assessment Results.local-definitions of an Assessment Plan or Assessment Results.location defined in the metadata of the SSP, Assessment Plan, or Assessment Results.party in the metadata of the SSP, Assessment Plan, or Assessment Results.user defined in the SSP, or in the local-definitions of an Assessment Plan or Assessment Results.Processing of an include/exclude pair starts with processing the include, then removing matching entries in the exclude.
-uuid-ref within a subject.The subject reference UUID could point to an item defined in the SSP, AP, or AR.
-Tools should check look for the ID in every file imported directly or indirectly.
-Used to add any components for tools used during the assessment. These are represented here to avoid mixing with system components.
-The technology tools used by the assessor to perform the assessment, such as vulnerability scanners. In the assessment plan these are the intended tools. In the assessment results, these are the actual tools used, including any differences from the assessment plan.
-Since responsible-party associates multiple party-uuid entries with a single role-id, each role-id must be referenced only once.
Since multiple assessment component entries can be provided, each component must have a unique uuid.
The target will always be a reference to: 1) a control statement, or 2) a control objective. In the former case, there is always a single top-level statement within a control. Thus, if the entire control is targeted, this statement identifier can be used.
-type.Reason may contain any value, and should be used to communicate additional information regarding the status.
-The implementation-status is used to qualify the status value to indicate the degree to which the control was found to be implemented.
Used to identify the individual and/or tool that gathered the evidence resulting in the observation identification.
-Identifies who was interviewed, or what was tested or inspected.
-The value of the href can be an internet resource, or a local reference using a fragment e.g. #fragment that points to a back-matter resource in the same document.
If a local reference using a fragment is used, this will be indicated by a fragment "#" followed by an identifier which references an identified resource in the document's back-matter or another object that is within the scope of the containing OSCAL document.
If an internet resource is used, the href value will be an absolute or relative URI pointing to the location of the referenced resource. A relative URI will be resolved relative to the location of the document containing the link.
Identifies the person or organization responsible for performing a specific role defined by the activity.
-The assessment subjects that the task was performed against.
-The assessment subjects that the task identified, which will be used by another task through a subject-placeholder reference. Such a task will "consume" these subjects.
-Since responsible-party associates multiple party-uuid entries with a single role-id, each role-id must be referenced only once.
Used to identify the individual and/or tool that identified this risk.
-Links identifiable elements of the system to this mitigating factor, such as an inventory-item or component.
-Identifies a change in risk status made resulting from the task described by this risk log entry. This allows the risk's status history to be captured as a sequence of risk log entries.
-This is used to identify the task(s) that this log entry was generated for.
-metadata about the specific actor that generated this descriptive data.
-class can be used to specify 'initial' and 'adjusted' risk states.class can be used to specify 'initial' and 'adjusted' risk states.class can be used to specify 'initial' and 'adjusted' risk states.Used to identify the individual and/or tool that generated this recommended or planned response.
-Identifies an asset associated with this requirement, such as a party, system component, or inventory-item.
-Provides a means to segment the value space for the name, so that different organizations and individuals can assert control over the allowed names and associated text used in a part. This allows the semantics associated with a given name to be defined on an organization-by-organization basis.
An organization MUST use a URI that they have control over. e.g., a domain registered to the organization in a URI, a registered uniform resource names (URN) namespace.
-When a ns is not provided, its value should be assumed to be http://csrc.nist.gov/ns/oscal and the name should be a name defined by the associated OSCAL model.
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 class can be used in validation rules to express extra constraints over named items of a specific class value.
A class can also be used in an OSCAL profile as a means to target an alteration to control content.
A part provides for logical partitioning of prose, and can be thought of as a grouping structure (e.g., section). A part can have child parts allowing for arbitrary nesting of prose content (e.g., statement hierarchy). A part can contain prop objects that allow for enriching prose text with structured name/value information.
A part can be assigned an optional id, which allows for internal and external references to the textual concept contained within a part. A id provides a means for an OSCAL profile, or a higher layer OSCAL model to reference a specific part within a catalog. For example, an id can be used to reference or to make modifications to a control statement in a profile.
Use of part and prop provides for a wide degree of extensibility within the OSCAL catalog model. The optional ns provides a means to qualify a part's name, allowing for organization-specific vocabularies to be defined with clear semantics. Any organization that extends OSCAL in this way should consistently assign a ns value that represents the organization, making a given namespace qualified name unique to that organization. This allows the combination of ns and name to always be unique and unambiguous, even when mixed with extensions from other organizations. Each organization is responsible for governance of their own extensions, and is strongly encouraged to publish their extensions as standards to their user community. If no ns is provided, the name is expected to be in the "OSCAL" namespace.
To ensure a ns is unique to an organization and naming conflicts are avoided, a URI containing a DNS or other globally defined organization name should be used. For example, if FedRAMP and DoD both extend OSCAL, FedRAMP will use the ns "https://fedramp.gov", while DoD will use the ns "https://defense.gov" for any organization specific name.
Tools that process OSCAL content are not required to interpret unrecognized OSCAL extensions; however, OSCAL compliant tools should not modify or remove unrecognized extensions, unless there is a compelling reason to do so, such as data sensitivity.
-The OSCAL assessment plan format is used to describe the information typically provided by an assessor during the preparation for an assessment.
-The root of the OSCAL assessment plan format is assessment-plan.
-
Used by the SAP to import information about the system being assessed.
-Used to add any components, not defined via the System Security Plan (AR->AP->SSP)
-Used to add any inventory-items, not defined via the System Security Plan (AR->AP->SSP)
-Used to add any users, not defined via the System Security Plan (AR->AP->SSP)
-Since multiple component entries can be provided, each component must have a unique uuid.
A given uuid must be assigned only once to a user.
The OSCAL assessment results format is used to describe the information typically provided by an assessor following an assessment.
-The root of the OSCAL assessment results format is assessment-results.
-
Used by the SAR to import information about the original plan for assessing the system.
-Used to add any components, not defined via the System Security Plan (AR->AP->SSP)
-Used to add any inventory-items, not defined via the System Security Plan (AR->AP->SSP)
-Used to add any users, not defined via the System Security Plan (AR->AP->SSP)
-This needs to be defined in the results if an assessment platform used is different from the one described in the assessment plan. Else the platform(s) defined in the plan may be referenced within the results.
-Since multiple component entries can be provided, each component must have a unique uuid.
A given uuid must be assigned only once to a user.
The Assessment Results control-selection ignores any control selection in the Assessment Plan and re-selects controls from the baseline identified by the SSP.
The Assessment Results control-objective-selection ignores any control objective selection in the Assessment Plan and re-selects control objectives from the baseline identified by the SSP.
Any additional control objectives defined in the Assessment Plan local-definitions do not need to be re-defined in the Assessment Results local-definitions; however, if they were explicitly referenced with an Assessment Plan control-objective-selection, they need to be selected again in the Assessment Results control-objective-selection.
Since responsible-party associates multiple party-uuid entries with a single role-id, each role-id must be referenced only once.
Used to identify the individual and/or tool generated this finding.
-The value of the href can be an internet resource, or a local reference using a fragment e.g. #fragment that points to a back-matter
- resource in the same document.
If a local reference using a fragment is used, this will be indicated by a fragment "#" followed by an identifier which references an identified resource in the document's back-matter or another object that is within the scope of the containing OSCAL document.
If an internet resource is used, the href value will be an absolute or relative URI pointing to the location of the referenced resource. A relative URI will be resolved relative to the location of the document containing the link.
The OSCAL Control Catalog format can be used to describe a collection of security controls and related control enhancements, along with contextualizing documentation and metadata. The root of the Control Catalog format is catalog.
-
Back matter including references and resources.
-Catalogs may use one or more group objects to subdivide the control contents of a catalog.
An OSCAL catalog model provides a structured representation of control information.
-A class can be used in validation rules to express extra constraints over named items of a specific class value.
A class can also be used in an OSCAL profile as a means to target an alteration to control content.
Catalogs can use a group to collect related controls into a single grouping. That can be useful to group controls into a family or other logical grouping.
A group may have its own properties, statements, parameters, and references, which are inherited by all members of that group.
A class can be used in validation rules to express extra constraints over named items of a specific class value.
A class can also be used in an OSCAL profile as a means to target an alteration to control content.
control. For example, a value of 'withdrawn' can indicate that the control has been withdrawn and should no longer be used.Controls may be grouped using group, and controls may be partitioned using part or further enhanced (extended) using control.
A control must have a part with the name "statement", which represents the textual narrative of the control. This "statement" part must occur only once, but may have nested parts to allow for multiple paragraphs or sections of text.
-This format represents a combination of all of the OSCAL models.
-The OSCAL Component Definition Model can be used to describe the implementation of controls in a component or a set of components grouped as a capability. A component can be either a technical component, or a documentary component. A technical component is a component that is implemented in hardware (physical or virtual) or software. A documentary component is a component implemented in a document, such as a process, procedure, or policy.
The root of the OSCAL Implementation Component format is component-definition.
-
NOTE: This documentation is a work in progress. As a result, documentation for many of the information elements is missing or incomplete.
-Since multiple component entries can be provided, each component must have a unique uuid.
A given component must not be referenced more than once within the same capability.
Used for service components to define the protocols supported by the service.
Since responsible-role associates multiple party-uuid entries with a single role-id, each role-id must be referenced only once.
Components may be products, services, APIs, policies, processes, plans, guidance, standards, or other tangible items that enable security and/or privacy.
-The type indicates which of these component types is represented.
A group of components may be aggregated into a capability. For example, an account management capability that consists of an account management process, and a Lightweight Directory Access Protocol (LDAP) software implementation.
Capabilities are expressed by combining one or more components.
-A given component must not be referenced more than once within the same capability.
A URL reference to the source catalog or profile for which this component is implementing controls for.
-Since multiple set-parameter entries can be provided, each parameter must be set only once.
Use of set-parameter in this context, sets the parameter for all related controls referenced in an implemented-requirement. If the same parameter is also set in a specific implemented-requirement, then the new value will override this value.
Since multiple set-parameter entries can be provided, each parameter must be set only once.
Since responsible-role associates multiple party-uuid entries with a single role-id, each role-id must be referenced only once.
Since statement entries can be referenced using the statement's statement-id, each statement must be referenced only once.
A reference to the specific implemented statement associated with a control.
-Since responsible-role associates multiple party-uuid entries with a single role-id, each role-id must be referenced only once.
Provides a means to segment the value space for the name, so that different organizations and individuals can assert control over the allowed names and associated text used in a part. This allows the semantics associated with a given name to be defined on an organization-by-organization basis.
An organization MUST use a URI that they have control over. e.g., a domain registered to the organization in a URI, a registered uniform resource names (URN) namespace.
-When a ns is not provided, its value should be assumed to be http://csrc.nist.gov/ns/oscal and the name should be a name defined by the associated OSCAL model.
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 class can be used in validation rules to express extra constraints over named items of a specific class value.
A class can also be used in an OSCAL profile as a means to target an alteration to control content.
A part provides for logical partitioning of prose, and can be thought of as a grouping structure (e.g., section). A part can have child parts allowing for arbitrary nesting of prose content (e.g., statement hierarchy). A part can contain prop objects that allow for enriching prose text with structured name/value information.
A part can be assigned an optional id, which allows for internal and external references to the textual concept contained within a part. A id provides a means for an OSCAL profile, or a higher layer OSCAL model to reference a specific part within a catalog. For example, an id can be used to reference or to make modifications to a control statement in a profile.
Use of part and prop provides for a wide degree of extensibility within the OSCAL catalog model. The optional ns provides a means to qualify a part's name, allowing for organization-specific vocabularies to be defined with clear semantics. Any organization that extends OSCAL in this way should consistently assign a ns value that represents the organization, making a given namespace qualified name unique to that organization. This allows the combination of ns and name to always be unique and unambiguous, even when mixed with extensions from other organizations. Each organization is responsible for governance of their own extensions, and is strongly encouraged to publish their extensions as standards to their user community. If no ns is provided, the name is expected to be in the "OSCAL" namespace.
To ensure a ns is unique to an organization and naming conflicts are avoided, a URI containing a DNS or other globally defined organization name should be used. For example, if FedRAMP and DoD both extend OSCAL, FedRAMP will use the ns "https://fedramp.gov", while DoD will use the ns "https://defense.gov" for any organization specific name.
-
Tools that process OSCAL content are not required to interpret unrecognized OSCAL extensions; however, OSCAL compliant tools should not modify or remove unrecognized extensions, unless there is a compelling reason to do so, such as data sensitivity.
-A class can be used in validation rules to express extra constraints over named items of a specific class value.
value if no value is assigned.The label value should be suitable for inline display in a rendered catalog.
-A set of values provided in a catalog can be redefined at any higher layer of OSCAL (e.g., Profile).
-A set of parameter value choices, that may be picked from to set the parameter value.
-In a catalog, a parameter is typically used as a placeholder for the future assignment of a parameter value, although the OSCAL model allows for the direct assignment of a value if desired by the control author. The value may be optionally used to specify one or more values. If no value is provided, then it is expected that the value will be provided at the Profile or Implementation layer.
A parameter can include a variety of metadata options that support the future solicitation of one or more values. A label provides a textual placeholder that can be used in a tool to solicit parameter value input, or to display in catalog documentation. The desc provides a short description of what the parameter is used for, which can be used in tooling to help a user understand how to use the parameter. A constraint can be used to provide criteria for the allowed values. A guideline provides a recommendation for the use of a parameter.
A set of parameter value choices, that may be picked from to set the parameter value.
-id value.Used for service components to define the protocols supported by the service.
Since responsible-role associates multiple party-uuid entries with a single role-id, each role-id must be referenced only once.
Components may be products, services, application programming interface (APIs), policies, processes, plans, guidance, standards, or other tangible items that enable security and/or privacy.
-The type indicates which of these component types is represented.
When defining a service component where are relationship to other components is known, one or more link entries with rel values of provided-by and used-by can be used to link to the specific component identifier(s) that provide and use the service respectively.
The short name of the protocol (e.g., https).
-Should be a number within a permitted range
-Should be a number within a permitted range
-To be validated as a natural number (integer >= 1). A single port uses the same value for start and end. Use multiple 'port-range' entries for non-contiguous ranges.
-Permissible values to be determined closer to the application, such as by a receiving authority.
-This construct is used to either: 1) associate a party or parties to a role defined on the component using the responsible-role construct, or 2) to define a party or parties that are responsible for a role defined within the context of the containing inventory-item.
-
Since responsible-party associates multiple party-uuid entries with a single role-id, each role-id must be referenced only once.
Since responsible-party associates multiple party-uuid entries with a single role-id, each role-id must be referenced only once.
Since responsible-party associates multiple party-uuid entries with a single role-id, each role-id must be referenced only once.
While published, last-modified, oscal-version, and version are not required, values for these entries should be provided if the information is known. For a revision entry to be considered valid, at least one of the following items must be provided: published, last-modified, version, or a link with a rel of source
.
Typically, the physical address of the location will be used here. If this information is sensitive, then a mailing address can be used instead.
-This is a contact email associated with the location.
-A phone number used to contact the location.
-class can be used to indicate a subclass of data-center.location defined in metadata.
- location defined in metadata.
- This is a contact email associated with the party.
-A phone number used to contact the party.
-Parties of both the person or organization type can be associated with an organization using the member-of-organization.
-
party defined in metadata.
- OSCAL has defined a set of standardized roles for consistent use in OSCAL documents. This allows tools consuming OSCAL content to infer specific semantics when these roles are used. These roles are documented in the specific contexts of their use (e.g., responsible-party, responsible-role). When using such a role, it is necessary to define these roles in this list, which will then allow such a role to be referenced.
-Permissible values to be determined closer to the application (e.g. by a receiving authority).
-The text is used to define the endnote text, without any required bibliographic structure. If structured bibliographic data is needed, then the biblio can be used for this purpose.
A biblio can be used to capture a structured bibliographical citation in an appropriate format.
When appearing as part of a resource/rlink, the hash applies to the resource referenced by the href.
-
This construct is different from link, which makes no provision for a hash or formal title.
Multiple rlink can be included for a resource. In such a case, all provided rlink items are intended to be equivalent in content, but may differ in structure. A media-type is used to identify the format of a given rlink, and can be used to differentiate a items in a collection of rlinks. The media-type also provides a hint to the OSCAL document consumer about the structure of the resource referenced by the rlink.
-
resource. This is the name that will be assigned to the file when the file is decoded.Ensures that each rlink item references a unique resource.
-Ensures that all base64 resources have a unique filename.
-
A title is required when a citation is provided.
A resource can be used in two ways. 1) it may point to an specific retrievable network resource using a rlink, or 2) it may be included as an attachment using a base64. A resource may contain multiple rlink and base64 entries that represent alternative download locations (rlink) and attachments (base64) for the same resource. Both rlink and base64 allow for a media-type to be specified, which is used to distinguish between different representations of the same resource (e.g., Microsoft Word, PDF). When multiple rlink and base64 items are included for a given resource, all items must contain equivalent information. This allows the document consumer to choose a preferred item to process based on a the selected item's media-type. This is extremely important when the items represent OSCAL content that is represented in alternate formats (i.e., XML, JSON, YAML), allowing the same OSCAL data to be processed from any of the available formats indicated by the items.
When a resource includes a citation, then the title and citation properties must both be included.
Provides a collection of identified resource objects that can be referenced by a link with a rel value of "reference" and an href value that is a fragment "#" followed by a reference to a reference identifier. Other specialized link "rel" values also use this pattern when indicated in that context of use.
The following is a contrived example to show the use of link, citation, and resource.
-Provides a means to segment the value space for the name, so that different organizations and individuals can assert control over the allowed names and associated values used in a property. This allows the semantics associated with a given name/value pair to be defined on an organization-by-organization basis.
An organization MUST use a URI that they have control over. e.g., a domain registered to the organization in a URI, a registered uniform resource names (URN) namespace.
-When a ns is not provided, its value should be assumed to be http://csrc.nist.gov/ns/oscal and the name should be a name defined by the associated OSCAL model.
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 class can be used in validation rules to express extra constraints over named items of a specific class value.
Properties permit the deployment and management of arbitrary controlled values, within OSCAL objects. A property can be included for any purpose useful to an application or implementation. Typically, properties will be used to sort, filter, select, order, and arrange OSCAL content objects, to relate OSCAL objects to one another, or to associate an OSCAL object to class hierarchies, taxonomies, or external authorities. Thus, the lexical composition of properties may be constrained by external processes to ensure consistency.
-Property allows for associated remarks that describe why the specific property value was applied to the containing object, or the significance of the value in the context of the containing object.
-The value of the href can be an internet resource, or a local reference using a fragment e.g. #fragment that points to a back-matter
- resource in the same document.
If a local reference using a fragment is used, this will be indicated by a fragment "#" followed by an identifier which references an identified resource in the document's back-matter or another object that is within the scope of the containing OSCAL document.
If an internet resource is used, the href value will be an absolute or relative URI pointing to the location of the referenced resource. A relative URI will be resolved relative to the location of the document containing the link.
The media-type provides a hint about the content model of the referenced resource. A valid entry from the IANA Media Types registry SHOULD be used.
To provide a cryptographic hash for a remote target resource, a local reference to a back matter resource is needed. The resource allows one or more hash values to be provided using the rlink/hash object.
The OSCAL link is a roughly based on the HTML link element.
-
The following is a contrived example to show the use of link, citation, and resource.
-Specifies one or more parties that are responsible for performing the associated role.
-
Any other value used MUST be a value defined in the W3C XML Security Algorithm Cross-Reference Digest Methods (W3C, April 2013) or RFC 6931 Section 2.1.5 New SHA Functions.
-A hash value can be used to authenticate that a referenced resource is the same resources as was pointed to by the author of the reference.
-This value represents the point in time when the OSCAL document was published. Typically, this date value will be machine generated at the time the containing document is published.
-In some cases, an OSCAL document may be derived from some source material in a different format. In such a case, the published value should indicate when the OSCAL document was published, not the source material. Where necessary, the publication date of the original source material can be captured as a named property or custom metadata construct.
A publisher of OSCAL content can use this data point along with its siblings last-modified and version to establish a sequence of successive revisions of a given OSCAL-based publication. The metadata for previous revisions can be represented as a revision in this object.
This value represents the point in time when the OSCAL document was last updated, or at the point of creation the creation date. Typically, this date value will be machine generated at time of creation or modification.
-In some cases, an OSCAL document may be derived from some source material in a different format. In such a case, the last-modified value should indicate the modification time of the OSCAL document, not the source material.
A publisher of OSCAL content can use this data point along with its siblings published and version to establish a sequence of successive revisions of a given OSCAL-based publication. The metadata for previous revisions can be represented as a revision in this object.
A version string may be a release number, sequence number, date, or other identifier suffcient to distinguish between different document versions. This version is typically set by the document owner or by the tool used to maintain the content.
-While not required, it is recommended that OSCAL content authors use Semantic Versioning as a format for version strings. This allows for the easy identification of a version tree consisting of major, minor, and patch numbers.
-A publisher of OSCAL content can use this data point along with its siblings published and last-modified to establish a sequence of successive revisions of a given OSCAL-based publication. The metadata for previous revisions can be represented as a revision in this object.
Indicates the version of the OSCAL model to which this data set conforms, for example 1.1.0
or 1.0.0-M1
. That can be used as a hint by a tool to indicate which version of the OSCAL XML or JSON schema to use for validation.
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.This element is optional, but it will always have a valid value, as if it is missing the value of "document-id" is assumed to be equal to the UUID of the root. This requirement allows for document creators to retroactively link an update to the original version, by providing a document-id on the new document that is equal to the uuid of the original document.
-The OSCAL Plan of Action and Milestones (POA&M) format is used to describe the information typically provided by an assessor during the preparation for an assessment.
-The root of the OSCAL Plan of Action and Milestones (POA&M) format is plan-action-milestones.
-
Used by the POA&M to import information about the system.
-Either an OSCAL-based SSP must be imported, or a unique system-id must be specified. Both may be present.
-Used to add any components, not defined via the System Security Plan (AR->AP->SSP)
-Used to add any inventory-items, not defined via the System Security Plan (AR->AP->SSP)
-Since multiple component entries can be provided, each component must have a unique uuid.
Used to identify the individual and/or tool generated this poam-item.
-A profile designates a selection and configuration of controls from one or more catalogs, along with a series of operations over them. The topmost element in the OSCAL profile XML schema is profile.
An OSCAL document that describes a tailoring of controls from one or more catalogs, with possible modification of multiple controls. It provides mechanisms by which controls may be selected (import), merged or (re)structured (merge), and amended (modify). OSCAL profiles may select subsets of controls, set parameter values for them in application, and even adjust the representation of controls as given in and by a catalog. They may also serve as sources for further modification in and by other profiles, that import them.
import designates a catalog, profile, or other resource to be included (referenced and potentially modified) by this profile. The import also identifies which controls to select using the include-all, include-controls, and exclude-controls directives.The value of the href can be an internet resource, or a local reference using a fragment e.g. #fragment that points to a back-matter
- resource in the same document.
If a local reference using a fragment is used, this will be indicated by a fragment "#" followed by an identifier which references an identified resource in the document's back-matter or another object that is within the scope of the containing OSCAL document.
If an internet resource is used, the href value will be an absolute or relative URL pointing to the location of the referenced resource. A relative URL will be resolved relative to the location of the document containing the link.
Identifies that all controls are to be included from the imported catalog or profile.
-Identifies a subset of controls to import from the referenced catalog or profile by control identifier or match pattern.
-Identifies which controls to exclude, or eliminate, from the set of included controls by control identifier or match pattern.
-A profile must be based on an existing OSCAL catalog or another OSCAL profile. An import indicates such a source whose controls are to be included (referenced and modified) in a profile. This source will either be a catalog whose controls are given (by value
), or a profile with its own control imports.
The contents of the import element indicate which controls from the source will be included. Controls from the source catalog or profile may be either selected, using the include-all or include-controls directives, or de-selected (using an exclude-controls directive).
The contents of the merge element may be used to reorder
or restructure
controls by indicating an order and/or structure in resolution.
Implicitly, a merge element is also a filter: controls that are included in a profile, but not included (implicitly or explicitly) in the scope of a merge element, will not be merged into (will be dropped) in the resulting resolution.
Whenever combining controls from multiple (import) pathways, an issue arises of what to do with clashing invocations (multiple competing versions of a control).
-This setting permits a profile designer to apply a rule for the resolution of such cases. In a well-designed profile, such collisions would ordinarily be avoided, but this setting can be useful for defining what to do when it occurs.
-The custom element represents a custom arrangement or organization of controls in the resolution of a catalog.
While the as-is element provides for a restitution of a control set's organization (in one or more source catalogs), this element permits the definition of an entirely different structure.
A class can be used in validation rules to express extra constraints over named items of a specific class value.
A class can also be used in an OSCAL profile as a means to target an alteration to control content.
This construct mirrors the same construct that exists in an OSCAL catalog.
-A class can be used in validation rules to express extra constraints over named items of a specific class value.
value if no value is assigned.The label value should be suitable for inline display in a rendered catalog.
-Used to (re)define a parameter value.
-Since multiple set-parameter entries can be provided, each parameter must be set only once.
Identifies which controls to exclude, or eliminate, from the set of matching includes.
-To be schema-valid, this element must contain either (but not both) a single include-all directive, or a sequence of include-controls directives.
If this directive is not provided, then no controls are to be inserted; i.e., all controls are included explicitly.
-import directive.This element provides an alternative to calling controls individually from a catalog.
-If with-child-controls is yes
on the call to a control, no sibling callelements need to be used to call any controls appearing within it. Since generally, this is how control enhancements are represented (as controls within controls), this provides a way to include controls with all their dependent controls (enhancements) without having to call them individually.
Use @control-id to indicate the scope of alteration.
It is an error for two alter elements to apply to the same control. In practice, multiple alterations can be applied (together), but it creates confusion.
At present, no provision is made for altering many controls at once (for example, to systematically remove properties or add global properties); extending this element to match multiple control IDs could provide for this.
-class.id.title or propns, which is the namespace associated with a part, or prop.Use name-ref, class-ref, id-ref or generic-identifier to indicate class tokens or ID reference, or the formal name, of the component to be removed or erased from a control, when a catalog is resolved. The control affected is indicated by the pointer on the removal's parent (containing) alter element.
To change an element, use remove to remove the element, then add to add it back again with changes.
When no id-ref is given, the addition is inserted into the control targeted by the alteration at the start or end as indicated by position. Only position values of "starting" or "ending" are permitted when there is no id-ref.
id-ref, when given, should indicate, by its ID, an element inside the control to serve as the anchor point for the addition. In this case, position value may be any of the permitted values.
The OSCAL Control SSP format can be used to describe the information typically specified in a system security plan, such as those defined in NIST SP 800-18.
-The root of the OSCAL System Security Plan (SSP) format is system-security-plan.
The value of the href can be an internet resource, or a local reference using a fragment e.g. #fragment that points to a back-matter
- resource in the same document.
If a local reference using a fragment is used, this will be indicated by a fragment "#" followed by an identifier which references an identified resource in the document's back-matter or another object that is within the scope of the containing OSCAL document.
If an internet resource is used, the href value will be an absolute or relative URI pointing to the location of the referenced resource. A relative URI will be resolved relative to the location of the document containing the link.
Often, organizations require the security sensitivity level to correspond with the highest confidentiality, integrity, or availability level identified by security-impact-level.
-
The hybrid cloud deployment model, as defined by The NIST Definition of Cloud Computing, can be supported by selecting two or more of the existing deployment models.
-Since responsible-party associates multiple party-uuid entries with a single role-id, each role-id must be referenced only once.
system used, such as NIST SP 800-60.system used, such as NIST SP 800-60.FIPS-199 taxonomy is provided here as a starting point. We will provide other taxonomies based on community requests.
-If 'other' is selected, a remark must be included to describe the current state.
-A visual depiction of the system's authorization boundary.
-A given uuid must be assigned only once to a diagram.
This description is intended to be used as alternate text to support compliance with requirements from Section 508 of the United States Workforce Rehabilitation Act of 1973. -
-A diagram must include a link with a rel value of "diagram", who's href references a remote URI or an internal reference within this document containing the diagram.
The internal reference "#diagram1" points to an attached resource defined in the back-matter as a resource. The media-type indicates that the image is a Portable Network Graphics (PNG) image.
A given uuid must be assigned only once to a diagram.
A given uuid must be assigned only once to a diagram.
A set of inventory-item entries that represent the managed inventory instances of the system.
A given uuid must be assigned only once to a user.
Since multiple set-parameter entries can be provided, each parameter must be set only once.
Use of set-parameter in this context, sets the parameter for all related controls referenced in an implemented-requirement. If the same parameter is also set in a specific implemented-requirement, then the new value will override this value.
Since all implementation statements are defined at the by-component level (e.g., type=this-system), there must be at least one by-component.
-Since multiple set-parameter entries can be provided, each parameter must be set only once.
Since responsible-role associates multiple party-uuid entries with a single role-id, each role-id must be referenced only once.
Since statement entries can be referenced using the statement's statement-id, each statement must be referenced only once.
Since by-component can reference component entries using the component's uuid, each component must be referenced only once. This ensures that all implementation statements are contained in the same by-component entry.
A reference to the specific implemented statement associated with a control.
-Since responsible-role associates multiple party-uuid entries with a single role-id, each role-id must be referenced only once.
Since by-component can reference component entries using the component's uuid, each component must be referenced only once. This ensures that all implementation statements are contained in the same by-component entry.
The implementation-status is used to qualify the status value to indicate the degree to which the control is implemented.
Since responsible-role associates multiple party-uuid entries with a single role-id, each role-id must be referenced only once.
A role defined at the by-component level takes precedence over the same role defined on the parent implemented-requirement or on the referenced component.
-Since responsible-role associates multiple party-uuid entries with a single role-id, each role-id must be referenced only once.
Since responsible-role associates multiple party-uuid entries with a single role-id, each role-id must be referenced only once.
Since responsible-role associates multiple party-uuid entries with a single role-id, each role-id must be referenced only once.
Since multiple set-parameter entries can be provided, each parameter must be set only once.
One
-Three
-Five
-Seven
-Nine
-Eleven
-Two
-Four
-Six
-Eight
-Ten
-New Year's Day 2020
-Leap Day 2020
-July Fourth 2020
-"-"
`
-
- \*\*\*one-dot-oh
-one-dot-one
-Z
-E
-F
-G
-H
-system used, such as NIST SP 800-60.Based on the - section identifiers in NIST Special Publication 800-60 Volume II - Revision 1
-For exercising Metaschema semantics with respect to modular assembly and composition.
For exercising Metaschema semantics with respect to modular assembly and composition.
-For exercising Metaschema semantics with respect to modular assembly and composition.
For exercising Metaschema semantics with respect to modular assembly and composition.
+A mini metaschema produced for testing purposes. Use at your own risk.
+A mini
metaschema produced for testing purposes. Use at your own risk.
A mini metaschema produced for testing purposes. Use at your own risk.
-Demo anthology
-Compiled for purposes of testing and demonstrating validations against constraints - defined by NIST Metaschema.
+Compiled for purposes of testing and demonstrating validations defined by NIST + Metaschema.
δῶς μοι πᾶ στῶ καὶ τὰν γᾶν κινάσω
+ +Give me someplace to stand and I'll move the earth.
+Gib mir was Stehplatz und die Erde bewege ich.
+Donnez-moi un point d’appui et je soulèverai le monde.
+Computer Science in the 1960s to 80s spent a lot of effort making languages that were + as powerful as possible. Nowadays we have to appreciate the reasons for picking not + the most powerful solution but the least powerful. The reason for this is that the + less powerful the language, the more you can do with the data stored in that + language. If you write it in a simple declarative form, anyone can write a program + to analyze it in many ways. The Semantic Web is an attempt, largely, to map large + quantities of existing data onto a common language so that the data can be analyzed + in ways never dreamed of by its creators. If, for example, a web page with weather + data has RDF describing that data, a user can retrieve it as a table, perhaps + average it, plot it, deduce things from it in combination with other information. At + the other end of the scale is the weather information portrayed by the cunning Java + applet. While this might allow a very cool user interface, it cannot be analyzed at + all. The search engine finding the page will have no idea of what the data is or + what it is about. The only way to find out what a Java applet means is to set it + running in front of a person.
+Anthology Metaschema1.0
diff --git a/test-suite/worked-examples/anthology/valid-flag-check.xml b/test-suite/worked-examples/anthology/valid-flag-check.xml
deleted file mode 100644
index cd3d1c0b7..000000000
--- a/test-suite/worked-examples/anthology/valid-flag-check.xml
+++ /dev/null
@@ -1,14 +0,0 @@
-
-
-
-
-- anthology - [0 or 1]: { ... } - -
-
-
- - ▪ - id: NCName - [0 or 1] - , -
-
-
- - meta - [1]: { ... }, - -
-
-
-
-
-
-
- - date - [0 or 1]: { ... }, - -
- -- }, -
-- ▪ - remarks: string - [0 or 1] -
-- }, -
-
-
- - pieces: [0 or 1] - [ ... ] - -
-
-
-
-
- - 'piece' objects - [0 to ∞]: { -
-
-
-
-
- - meta - [0 or 1]: { ... }, - -
-
-
-
-
-
-
- - date - [0 or 1]: { ... }, - -
- -- }, -
-- ▪ - remarks: string - [0 or 1] -
-- }, -
-
-
- - ▪ A choice:
-
-
-
-
-
- - ▪ - prose: string - [0 or 1] -
-- } -
-- ], -
-
-
- - back - [0 or 1]: { ... } - -
-
-
-
-
- - author-index - [0 or 1]: { ... } - -
-
-
-
-
- - authors - [0 or 1]: { ... } - -
-
-
-
-
- - {{ id }} - [0 to ∞]: { ... } - -
-
-
- - ▪ - name: string - [0 or 1] - , -
-
-
- - dates - [0 or 1]: { ... }, - -
-
-
- - ▪ - birth: date - [0 or 1] - , -
-- ▪ - death: date - [0 or 1] - , -
-- ▪ - floruit: date - [0 or 1] - , -
-- ▪ - range: empty - [0 or 1] -
-- }, -
-
-
- - publications: [0 or 1] - [ ... ] - -
-
-
-
-
- - 'publication' objects - [0 to ∞]: { -
- -- } -
-- ], -
-
-
- - bio - [0 or 1]: { ... } - -
-
-
-
-
- - also-known-as: [0 or 1] - [ ... ] - -
-
-
- - ▪ - 'name' strings: string - [0 to ∞] -
-- ], -
-
-
- - fact-statements: [0 or 1] - [ ... ] - -
-
-
-
- - ], -
-
-
- - colorful-details - [0 or 1]: { ... } - -
- -- } -
-- } -
-- } -
-- } -
-- } -
-- } -
-- } -
-thousand
-A mini metaschema produced for testing purposes. Use at your own risk.
A mini metaschema produced for testing purposes. Use at your own risk.
-A mini metaschema produced for testing purposes. Use at your own risk.
-Date type
-Color
-Lexically, a whole number (\d+)
-A unique identifier
-Couplet
-Tercet
-Quatrain
-type
-date
-role reference
-a unique set of values
-A mini metaschema produced for testing purposes. Use at your own risk.
-
-
-
-
- <everything - todays-date="date"> [0 or 1] -
-
-
-
-
- <one-string - todays-date="date" required-ncname="NCName">string</one-string> [0 or 1] -
- - -<everything/> [0 to 3] -
-</everything>
-
-
</> [0 or 1]
-
-
-
diff --git a/test-suite/worked-examples/everything-metaschema/kitchen-sink.json b/test-suite/worked-examples/everything-metaschema/kitchen-sink.json
deleted file mode 100644
index 2765b4eab..000000000
--- a/test-suite/worked-examples/everything-metaschema/kitchen-sink.json
+++ /dev/null
@@ -1,7 +0,0 @@
-{
- "EVERYTHING": { "todays-date": "2020-02-19",
- "one-string": "Alpha",
- "required-integer": 3,
- "required-local-field": "um",
- "SINGLETON": { "title": "My Summer Vacation" } }
-}
\ No newline at end of file
diff --git a/toolchains/xslt-M4/README.md b/toolchains/xslt-M4/README.md
index c37d16d7b..a4408dfe4 100644
--- a/toolchains/xslt-M4/README.md
+++ b/toolchains/xslt-M4/README.md
@@ -92,7 +92,7 @@ The XSLT `nist-metaschema-metaprocess.xsl` is a utility XSLT providing a unified
### Metaschema schemas / `validate` folder
-Any metaschema, metaschema module, or composed metaschema, should all be valid to the Metaschema XSD `validate/metaschema.xsd` and to the `validate/metaschema-check.sch` Schematron.
+Any metaschema, metaschema module, or composed metaschema, should all be valid to the Metaschema XSD `../../../schema/xml/metaschema.xsd` and to the `validate/metaschema-check.sch` Schematron.
A composed metaschema is essentially what a metaschema will look like with all imports resolved (last appearing definition prevailing, imports read before main definitions); so a metaschema with no imports maps directly to its own composed expression. In composition, pointers are also written into the metaschema representation to provide useful information for downstream processing in resolving referential ambiguities (resulting from unintended or intended import clashes).
diff --git a/toolchains/xslt-M4/compose/make-model-map.xsl b/toolchains/xslt-M4/compose/make-model-map.xsl
index 4019b89a2..82160952f 100644
--- a/toolchains/xslt-M4/compose/make-model-map.xsl
+++ b/toolchains/xslt-M4/compose/make-model-map.xsl
@@ -16,7 +16,7 @@
@@ -26,6 +26,8 @@
<one-string - todays-date="date" required-ncname="NCName">string</one-string> [0 or 1] -
- - -<everything/> [0 to 3] -
-A mini metaschema produced for documentation testing purposes.
This metaschema exercises modeling with a mix of global, modular (local) and inline
@@ -146,7 +144,7 @@
value key { . }
object key flag { @flag-name }
object key flag { @flag-ref }
value key flag { @flag-name }
value key flag { @flag-ref }
+
id-ref. This insert mechanism allows the selection of which text value from the object to dynamically include based on the application's display requirements.type. The specific value to include is based on the application's display requirements, which will likely use a specific data element associated with the type (e.g., title, identifier, value, etc.) that is appropriate for the application.
- Wrapped up prose
-This is prose. All wrapped up.