Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/module and meta constraints namespace prefixes #686

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Feature/module and meta constraints namespace prefixes #686

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b567c1e
Some work towards representing the XSLT-based metaschema-composition-…
david-waltermire Mar 15, 2024
d5e81d6
Added Metaschema module based on the Static Analysis Results Intercha…
david-waltermire Jun 16, 2024
5ec4066
Added support for prefix to namespace bindings for use in Metapath mo…
david-waltermire Jul 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions schema/metaschema/metaschema-module-constraints.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,67 @@
<metaschema-meta-constraints xmlns="http://csrc.nist.gov/ns/oscal/metaschema/1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://csrc.nist.gov/ns/oscal/metaschema/1.0 ../xml/metaschema-meta-constraints.xsd">
<context>
<metapath target="/METASCHEMA"/>
<constraints>
<let var="all-imports" expression="recurse-depth('doc(resolve-uri(import/@href))/METASCHEMA')"/>
<index id="module-short-name-unique" target="(.|$all-imports)" name="metaschema-metadata-short-name-index">
<formal-name>Index Module Short Names</formal-name>
<description>Ensures that the current and all imported modules have a unique short name.</description>
<key-field target="@short-name"/>
</index>
<expect id="module-top-level-version-required" target=".[not(@abstract) or @abstract='yes']" test="@version">
<formal-name>Require Version for Top-Level Modules</formal-name>
<description>A top-level module, a module that is not marked as @abstract='yes', must have a version specified.</description>
<message>Unless marked as @abstract='yes', a Metaschema module (or an imported module) should have a version.</message>
</expect>
<expect id="module-top-level-root-required" target=".[not(@abstract) or @abstract='yes']" test="define-assembly/root-name">
<formal-name>Require Root Assembly for Top-Level Modules</formal-name>
<description>A top-level module, a module that is not marked as @abstract='yes', must have at least one assembly with a root-name.</description>
<message>Unless marked as @abstract='yes', a Metaschema module (or an imported module) should have at least one assembly with a root-name.</message>
</expect>
<is-unique id="module-namespace-unique-entry" target="namespace">
<formal-name>Require Unique Namespace Entries</formal-name>
<description>Ensures that all declared namespace entries are unique.</description>
<key-field target="@prefix"/>
<key-field target="@uri"/>
</is-unique>
<is-unique id="module-namespace-unique-prefix" target="namespace">
<formal-name>Require Unique Namespace Entry Prefixes</formal-name>
<description>Ensures that all declared namespace entries have a unique prefix.</description>
<key-field target="@prefix"/>
</is-unique>
</constraints>
<context>
<metapath target="import"/>
<constraints>
<expect id="module-import-href-available" target="." test="document-available(resolve-uri(import/@href))">
<formal-name>Import is Resolvable</formal-name>
<description>Ensure each import has a resolvable @href.</description>
<message>Unable to access a Metaschema module at '{{ resolve-uri(@href) }}'.</message>
</expect>
<expect id="module-import-href-is-module" target="." test="doc(resolve-uri(import/@href))/METASCHEMA ! exists(.)">
<formal-name>Import is Resolvable</formal-name>
<description>Ensure each import is a Metaschema module.</description>
<message>Unable the resource at '{{ resolve-uri(@href) }}' is not a Metaschema module.</message>
</expect>
</constraints>
</context>
</context>
<context>
<metapath target="/metaschema-meta-constraints"/>
<constraints>
<is-unique id="meta-constraints-namespace-unique-entry" target="namespace">
<formal-name>Require Unique Namespace Entries</formal-name>
<description>Ensures that all declared namespace entries are unique.</description>
<key-field target="@prefix"/>
<key-field target="@uri"/>
</is-unique>
<is-unique id="meta-constraints-namespace-unique-prefix" target="namespace">
<formal-name>Require Unique Namespace Entry Prefixes</formal-name>
<description>Ensures that all declared namespace entries have a unique prefix.</description>
<key-field target="@prefix"/>
</is-unique>
</constraints>
</context>
</metaschema-meta-constraints>
33 changes: 31 additions & 2 deletions schema/metaschema/metaschema-module-metaschema.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@
<description>A relative or absolute URI for retrieving an out-of-line Metaschema definition.</description>
</define-flag>
</define-assembly>
<assembly ref="metapath-namespace" max-occurs="unbounded">
<group-as name="namespace-bindings" />
</assembly>
<choice-group max-occurs="unbounded">
<group-as name="definitions" in-json="ARRAY"/>
<discriminator>object-type</discriminator>
Expand Down Expand Up @@ -183,6 +186,21 @@
</constraint>
</define-assembly>

<define-assembly name="metapath-namespace">
<formal-name>Metapath Namespace Declaration</formal-name>
<description>Assigns a Metapath namespace to a prefix for use in a Metapath expression in a lexical qualified name.</description>
<use-name>namespace-binding</use-name>
<define-flag name="uri" as-type="uri" required="yes">
<formal-name>Metapath Namespace URI</formal-name>
<description>The namespace URI to bind to the prefix.</description>
</define-flag>
<define-flag name="prefix" as-type="token" required="yes">
<formal-name>Metapath Namespace Prefix</formal-name>
<description>The prefix that is bound to the namespace.</description>
</define-flag>
</define-assembly>


<define-assembly name="inline-define-assembly">
<formal-name>Inline Assembly Definition</formal-name>
<use-name>define-assembly</use-name>
Expand Down Expand Up @@ -1238,6 +1256,11 @@
<description>A relative or absolute URI for retrieving an out-of-line Metaschema constraint definition.</description>
</define-flag>
</define-assembly>

<assembly ref="metapath-namespace" max-occurs="unbounded">
<group-as name="namespace-bindings" />
</assembly>

<define-assembly name="scope" min-occurs="1" max-occurs="unbounded">
<group-as name="scopes" in-json="ARRAY"/>
<define-flag name="metaschema-namespace" as-type="uri" required="yes"/>
Expand Down Expand Up @@ -1302,6 +1325,10 @@
<description>Defines constraint rules to be applied to an existing set of Metaschema module-based models.</description>
<root-name>metaschema-meta-constraints</root-name>
<model>
<assembly ref="metapath-namespace" max-occurs="unbounded">
<group-as name="namespace-bindings" />
</assembly>

<define-assembly name="definition-context">
<define-flag name="name" as-type="token" required="yes"/>
<define-flag name="namespace" as-type="uri" required="yes"/>
Expand All @@ -1313,7 +1340,8 @@
</model>
</define-assembly>
<assembly ref="metapath-context" min-occurs="1" max-occurs="unbounded">
<group-as name="metapath-contexts" in-json="ARRAY"/>
<use-name>context</use-name>
<group-as name="contexts" in-json="ARRAY"/>
</assembly>
</model>
</define-assembly>
Expand All @@ -1334,7 +1362,8 @@
<use-name>constraints</use-name>
</assembly>
<assembly ref="metapath-context" max-occurs="unbounded">
<group-as name="metapath-contexts" in-json="ARRAY"/>
<use-name>context</use-name>
<group-as name="contexts" in-json="ARRAY"/>
</assembly>
<field ref="remarks"/>
</model>
Expand Down
Loading
Loading