-
Notifications
You must be signed in to change notification settings - Fork 178
/
oscal_catalog_metaschema.xml
321 lines (319 loc) · 22.6 KB
/
oscal_catalog_metaschema.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
<?xml version="1.0" encoding="UTF-8"?>
<?xml-model href="../../build/metaschema-xslt/src/validate/metaschema-composition-check.sch" type="application/xml" schematypens="http://purl.oclc.org/dsdl/schematron"?>
<!-- OSCAL CATALOG METASCHEMA -->
<!-- validate with XSD and Schematron (linked) -->
<!DOCTYPE METASCHEMA [
<!ENTITY allowed-values-control-group-property-name SYSTEM "shared-constraints/allowed-values-control-group-property-name.ent">
]>
<?xml-stylesheet type="text/css" href="metaschema-author.css"?>
<METASCHEMA xmlns="http://csrc.nist.gov/ns/oscal/metaschema/1.0">
<schema-name>OSCAL Control Catalog Model</schema-name>
<schema-version>1.1.2</schema-version>
<short-name>oscal-catalog</short-name>
<namespace>http://csrc.nist.gov/ns/oscal/1.0</namespace>
<json-base-uri>http://csrc.nist.gov/ns/oscal</json-base-uri>
<remarks>
<p>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 <code>catalog</code>.</p>
</remarks>
<import href="oscal_control-common_metaschema.xml"/>
<import href="oscal_metadata_metaschema.xml"/>
<define-assembly name="catalog">
<formal-name>Catalog</formal-name>
<description>A structured, <a href="https://pages.nist.gov/OSCAL/concepts/terminology/#catalog">organized collection</a> of control information.</description>
<root-name>catalog</root-name>
<define-flag name="uuid" as-type="uuid" required="yes">
<formal-name>Catalog Universally Unique Identifier</formal-name>
<description>Provides a globally unique means to identify a given catalog instance.</description>
<prop name="value-type" value="identifier"/>
<prop name="identifier-type" value="machine-oriented"/>
<prop name="identifier-uniqueness" value="global"/>
<prop name="identifier-scope" value="cross-instance"/>
<prop name="identifier-persistence" value="change-on-write"/>
</define-flag>
<model>
<assembly ref="metadata" min-occurs="1"/>
<assembly ref="parameter" max-occurs="unbounded">
<group-as name="params" in-json="ARRAY"/>
</assembly>
<assembly ref="control" max-occurs="unbounded">
<group-as name="controls" in-json="ARRAY"/>
</assembly>
<assembly ref="group" max-occurs="unbounded">
<group-as name="groups" in-json="ARRAY"/>
</assembly>
<assembly ref="back-matter">
<remarks>
<p>Back matter including references and resources.</p>
</remarks>
</assembly>
</model>
<constraint>
<allowed-values target="metadata/prop[has-oscal-namespace('http://csrc.nist.gov/ns/oscal')]/@name">
<enum value="resolution-tool">The tool used to produce a resolved profile.</enum>
<enum value="source-profile-uuid">The document-level <code>uuid</code> of the source profile from which the catalog was produced by <a href="https://pages.nist.gov/OSCAL/concepts/processing/profile-resolution/">profile resolution</a>.</enum>
</allowed-values>
<allowed-values target="metadata/link/@rel" allow-other="yes">
<enum value="source-profile">The profile from which the catalog was produced by <a href="https://pages.nist.gov/OSCAL/concepts/processing/profile-resolution/">profile resolution</a>.</enum>
<enum value="source-profile-uuid">The document-level <code>uuid</code> of the profile from which the catalog was produced by <a href="https://pages.nist.gov/OSCAL/concepts/processing/profile-resolution/">profile resolution</a>.</enum>
</allowed-values>
<index name="catalog-parts" target="//part" >
<key-field target="@id"/>
</index>
<index name="catalog-props" target="//prop" >
<key-field target="@uuid"/>
</index>
<index name="catalog-groups-controls-parts" target="//(control|group|part)">
<key-field target="@id"/>
</index>
<index name="catalog-controls" target="//control" >
<key-field target="@id"/>
</index>
<index name="catalog-params" target="//param" >
<key-field target="@id"/>
</index>
<index name="catalog-groups" target="//group" >
<key-field target="@id"/>
</index>
</constraint>
<remarks>
<p>Catalogs may use one or more <code>group</code> objects to subdivide the control contents of a catalog.</p>
</remarks>
<example>
<description>A small catalog with a single control.</description>
<catalog xmlns="http://csrc.nist.gov/ns/oscal/1.0" uuid="35566cd4-7331-43ba-b023-988c38d62673">
<title>A Miniature Catalog</title>
<control id="single">
<title>A Single Control</title>
<!-- TODO: this is not a complete valid example. Fix this. -->
</control>
</catalog>
</example>
</define-assembly>
<define-assembly name="group">
<formal-name>Control Group</formal-name>
<description>A group of controls, or of groups of controls.</description>
<define-flag name="id" as-type="token">
<!-- This is an id because the identifier is assigned and managed externally by humans. -->
<formal-name>Group Identifier</formal-name>
<!-- Identifier Declaration -->
<description>Identifies the group for the purpose of cross-linking within the defining instance or from other instances that reference the catalog.</description>
<prop name="value-type" value="identifier"/>
<prop name="identifier-type" value="human-oriented"/>
<prop name="identifier-uniqueness" value="instance"/>
<prop name="identifier-scope" value="cross-instance"/>
<prop name="identifier-persistence" value="per-subject"/>
</define-flag>
<define-flag name="class" as-type="token">
<formal-name>Group Class</formal-name>
<description>A textual label that provides a sub-type or characterization of the group.</description>
<remarks>
<p>A <code>class</code> can be used in validation rules to express extra constraints over named items of a specific <code>class</code> value.</p>
<p>A <code>class</code> can also be used in an OSCAL profile as a means to target an alteration to control content.</p>
</remarks>
</define-flag>
<model>
<define-field name="title" as-type="markup-line" min-occurs="1">
<formal-name>Group Title</formal-name>
<description>A name given to the group, which may be used by a tool for display and navigation.</description>
</define-field>
<assembly ref="parameter" max-occurs="unbounded">
<group-as name="params" in-json="ARRAY"/>
</assembly>
<assembly ref="property" max-occurs="unbounded">
<group-as name="props" in-json="ARRAY"/>
</assembly>
<assembly ref="link" max-occurs="unbounded">
<group-as name="links" in-json="ARRAY"/>
</assembly>
<assembly ref="part" max-occurs="unbounded">
<group-as name="parts" in-json="ARRAY"/>
</assembly>
<choice>
<assembly ref="group" max-occurs="unbounded">
<group-as name="groups" in-json="ARRAY"/>
</assembly>
<assembly ref="control" max-occurs="unbounded">
<group-as name="controls" in-json="ARRAY"/>
</assembly>
</choice>
<!--<any/>-->
</model>
<constraint>
<allowed-values target="prop[has-oscal-namespace('http://csrc.nist.gov/ns/oscal')]/@name">
&allowed-values-control-group-property-name;
</allowed-values>
<allowed-values target="part[has-oscal-namespace('http://csrc.nist.gov/ns/oscal')]/@name">
<enum value="overview">An introduction to a control or a group of controls.</enum>
<enum value="instruction">Information providing directions for a control or a group of controls.</enum>
</allowed-values>
</constraint>
<remarks>
<p>Catalogs can use the catalog <code>group</code> construct to organize related controls into a single grouping, such as a family of controls or other logical organizational structure.</p>
<p>A <code>group</code> may have its own properties, statements, parameters, and references, which are inherited by all controls of that are a member of the group.</p>
</remarks>
<example>
<group xmlns="http://csrc.nist.gov/ns/oscal/1.0" id="xyz">
<title>My Group</title>
<prop name="required" value="some value"/>
<control id="xyz1">
<title>Control</title>
</control>
</group>
</example>
</define-assembly>
<define-assembly name="control">
<formal-name>Control</formal-name>
<description>A <a href="https://pages.nist.gov/OSCAL/concepts/terminology/#control"
>structured object</a> representing a requirement or guideline, which when
implemented will reduce an aspect of risk related to an information system and its
information.</description>
<define-flag name="id" as-type="token" required="yes">
<!-- This is an id because the idenfier is managed externally. -->
<formal-name>Control Identifier</formal-name>
<!-- Identifier Declaration -->
<description>Identifies a control such that it can be referenced in the defining
catalog and other OSCAL instances (e.g., profiles).</description>
<prop name="value-type" value="identifier"/>
<prop name="identifier-type" value="human-oriented"/>
<prop name="identifier-uniqueness" value="local"/>
<prop name="identifier-scope" value="instance"/>
<prop name="identifier-persistence" value="per-subject"/>
</define-flag>
<define-flag name="class" as-type="token">
<formal-name>Control Class</formal-name>
<description>A textual label that provides a sub-type or characterization of the
control.</description>
<remarks>
<p>A <code>class</code> can be used in validation rules to express extra
constraints over named items of a specific <code>class</code>
value.</p>
<p>A <code>class</code> can also be used in an OSCAL profile as a means to
target an alteration to control content.</p>
</remarks>
</define-flag>
<model>
<define-field name="title" as-type="markup-line" min-occurs="1">
<formal-name>Control Title</formal-name>
<description>A name given to the control, which may be used by a tool for
display and navigation.</description>
</define-field>
<assembly ref="parameter" max-occurs="unbounded">
<group-as name="params" in-json="ARRAY"/>
</assembly>
<!-- TODO: Need to be able to add valid values in context -->
<assembly ref="property" max-occurs="unbounded">
<group-as name="props" in-json="ARRAY"/>
</assembly>
<assembly ref="link" max-occurs="unbounded">
<group-as name="links" in-json="ARRAY"/>
</assembly>
<assembly ref="part" max-occurs="unbounded">
<group-as name="parts" in-json="ARRAY"/>
</assembly>
<assembly ref="control" max-occurs="unbounded">
<group-as name="controls" in-json="ARRAY"/>
</assembly>
<!--<assembly named="ref-list"/>-->
<!-- <any/> -->
</model>
<constraint>
<expect id="catalog-control-require-statement-when-not-withdrawn" target="."
test="prop[@name='status']/@value=('withdrawn','Withdrawn') or part[@name='statement']"/>
<allowed-values
target="prop[has-oscal-namespace('http://csrc.nist.gov/ns/oscal')]/@name">
&allowed-values-control-group-property-name;
<enum value="status">The status of a <code>control</code>. For example, a
value of 'withdrawn' can indicate that the <code>control</code> has
been withdrawn and should no longer be used.</enum>
</allowed-values>
<allowed-values
target="prop[has-oscal-namespace('http://csrc.nist.gov/ns/oscal') and @name='status']/@value">
<enum value="withdrawn">The control is no longer used.</enum>
<enum value="Withdrawn" deprecated="1.0.0">**(deprecated)*** Use 'withdrawn'
instead.</enum>
</allowed-values>
<allowed-values target="link/@rel" allow-other="yes">
<enum value="reference">The link cites an external resource related to this
control.</enum>
<enum value="related">The link identifies another control with bearing to
this control.</enum>
<enum value="required">The link identifies another control that must be
present if this control is present.</enum>
<enum value="incorporated-into">The link identifies other control content
where this control content is now addressed.</enum>
<enum value="moved-to">The containing control definition was moved to the
referenced control.</enum>
</allowed-values>
<!-- TODO: add expect constraint to check for controls that reference themselves -->
<index-has-key name="catalog-groups-controls-parts"
target="link[@rel=('related','required','incorporated-into','moved-to') and starts-with(@href,'#')]">
<key-field target="@href" pattern="#(.*)"/>
</index-has-key>
<allowed-values
target="part[has-oscal-namespace('http://csrc.nist.gov/ns/oscal')]/@name">
<enum value="overview">An introduction to a control or a group of
controls.</enum>
<enum value="statement">A set of implementation requirements or recommendations.</enum>
<enum value="guidance">Additional information to consider when selecting,
implementing, assessing, and monitoring a control.</enum>
<enum value="example">An example of an implemented requirement or control statement.</enum>
<enum value="assessment" deprecated="1.0.1">**(deprecated)** Use
'assessment-method' instead.</enum>
<enum value="assessment-method">The part describes a method-based assessment
over a set of assessment objects.</enum>
</allowed-values>
<allowed-values
target="part[has-oscal-namespace('http://csrc.nist.gov/ns/oscal') and @name='statement']//part[has-oscal-namespace('http://csrc.nist.gov/ns/oscal')]/@name">
<enum value="item">An individual item within a control statement.</enum>
<remarks>
<p>Nested statement parts are "item" parts.</p>
</remarks>
</allowed-values>
<allowed-values
target=".//part[has-oscal-namespace('http://csrc.nist.gov/ns/oscal')]/@name">
<enum value="objective" deprecated="1.0.1">**(deprecated)** Use
'assessment-objective' instead.</enum>
<enum value="assessment-objective">The part describes a set of assessment
objectives.</enum>
<remarks>
<p>Objectives can be nested.</p>
</remarks>
</allowed-values>
<allowed-values
target="part[has-oscal-namespace('http://csrc.nist.gov/ns/oscal') and @name=('assessment','assessment-method')]/part[has-oscal-namespace('http://csrc.nist.gov/ns/oscal')]/@name">
<enum value="objects" deprecated="1.0.1">**(deprecated)** Use
'assessment-objects' instead.</enum>
<enum value="assessment-objects">Provides a listing of assessment
objects.</enum>
<remarks>
<p>Assessment objects appear on assessment methods.</p>
</remarks>
</allowed-values>
<allowed-values
target="part[has-oscal-namespace('http://csrc.nist.gov/ns/oscal') and @name=('assessment','assessment-method')]/prop[has-oscal-namespace('http://csrc.nist.gov/ns/oscal')]/@name">
<enum value="method" deprecated="1.0.1">**(deprecated)** Use 'method' in the 'http://csrc.nist.gov/ns/rmf' namespace. The assessment method to use. This typically appears on parts with the name "assessment-method".</enum>
</allowed-values>
<allowed-values
target="part[has-oscal-namespace('http://csrc.nist.gov/ns/oscal') and @name=('assessment','assessment-method')]/prop[has-oscal-namespace('http://csrc.nist.gov/ns/rmf')]/@name">
<enum value="method">The assessment method to use. This typically appears on
parts with the name "assessment-method".</enum>
</allowed-values>
<expect level="WARNING" target="part[has-oscal-namespace('http://csrc.nist.gov/ns/oscal') and @name=('assessment','assessment-method')]" test="prop[has-oscal-namespace(('http://csrc.nist.gov/ns/oscal','http://csrc.nist.gov/ns/rmf')) and @name='method']"/>
<allowed-values
target="part[has-oscal-namespace('http://csrc.nist.gov/ns/oscal') and @name=('assessment','assessment-method')]/prop[has-oscal-namespace(('http://csrc.nist.gov/ns/oscal','http://csrc.nist.gov/ns/rmf')) and @name='method']/@value">
<enum value="INTERVIEW">The process of holding discussions with individuals or groups of individuals within an organization to once again, facilitate assessor understanding, achieve clarification, or obtain evidence.</enum>
<enum value="EXAMINE">The process of reviewing, inspecting, observing, studying, or analyzing one or more assessment objects (i.e., specifications, mechanisms, or activities).</enum>
<enum value="TEST">The process of exercising one or more assessment objects (i.e., activities or mechanisms) under specified conditions to compare actual with expected behavior.</enum>
</allowed-values>
</constraint>
<remarks>
<p>Each security or privacy control within the catalog is defined by a distinct control instance. Controls may be as complex or as simple as a catalog defines them. They may be decomposed or further specified into child <code>control</code> objects, for example to represent control enhancements or specific breakouts of control functionality, to be maintained as discrete requirements. Controls may also contain structured parts (using <code>part</code>) and they may be grouped together in families or classes with <code>group</code>.</p>
<p>Control structures in OSCAL will also exhibit regularities and rules that are not codified in OSCAL but in its applications or domains of application. For example, for catalogs describing controls as defined by NIST SP 800-53, 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 organization supports addressability of this data content as long as, and only insofar as, it is consistently implemented across the control set. As given with these model definitions, constraints defined and assigned here can aid in ensuring this regularity; but other such constraints and other useful patterns of use remain to be discovered and described.</p>
</remarks>
<example>
<control xmlns="http://csrc.nist.gov/ns/oscal/1.0" id="x">
<title>Control 1</title>
</control>
</example>
</define-assembly>
</METASCHEMA>