Skip to content

Commit 1733a58

Browse files
Rene2mtaj-stein-gsa
andcommitted
Fix namespace, identifier-type and system per issue #773 (#102)
* Fix namespace, identifier-type and system per issue #773 * Update identifier-type in code examples * Update content/documentation/general-concepts/oscal-layers-of-validation.md Co-authored-by: A.J. Stein <[email protected]> * Update namespace in documentation examples --------- Co-authored-by: A.J. Stein <[email protected]>
1 parent ab8e96e commit 1733a58

15 files changed

+247
-247
lines changed
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
https://search.usa.gov/search
22
http://csrc.nist.gov/ns/*
3-
https://fedramp.gov/ns/*
3+
http://fedramp.gov/ns/*
44
http://www.first.org/cvss/v3

content/documentation/general-concepts/3-fedramp-extensions-and-accepted-values.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ cybersecurity frameworks. They designed OSCAL to be extended where
3333
unique needs existed.
3434

3535
{{<callout>}}
36-
_All FedRAMP extensions include a namespace (ns) flag set to `https://fedramp.gov/ns/oscal`._
36+
_All FedRAMP extensions include a namespace (ns) flag set to `http://fedramp.gov/ns/oscal`._
3737
{{</callout>}}
3838

3939
NIST allows organizations to extend OSCAL anyplace `prop` fields or `part`
@@ -57,7 +57,7 @@ in their own name space without concern for overlapping names. The above
5757
approach ensures two different organizations can create their
5858
own extensions without concern for reusing the same name values.
5959

60-
All FedRAMP extensions must have a namespace (`ns`) flag set to `https://fedramp.gov/ns/oscal`.
60+
All FedRAMP extensions must have a namespace (`ns`) flag set to `http://fedramp.gov/ns/oscal`.
6161

6262
For example, if the core OSCAL syntax has a `status` field, but both
6363
FedRAMP and the payment card industry (PCI) require their own
@@ -83,12 +83,12 @@ flag using the syntax above.**
8383

8484
#### FedRAMP Status Representation
8585
{{< highlight xml "linenos=table" >}}
86-
<prop name="status" ns="https://fedramp.gov/ns/oscal" value="FedRAMP Status" />
86+
<prop name="status" ns="http://fedramp.gov/ns/oscal" value="FedRAMP Status" />
8787
{{< /highlight >}}
8888

8989
#### XPath Query
9090
{{< highlight xml "linenos=table" >}}
91-
//prop[@name="status"][@ns="https://fedramp.gov/ns/oscal"]
91+
//prop[@name="status"][@ns="http://fedramp.gov/ns/oscal"]
9292
{{< /highlight >}}
9393

9494
#### (Possible) PCI Status Representation
@@ -109,7 +109,7 @@ and `ns` flags as a pair.
109109

110110
All FedRAMP extensions will appear as:
111111
{{< highlight xml "linenos=table" >}}
112-
<prop name="____" ns="https://fedramp.gov/ns/oscal" value="Value"/>
112+
<prop name="____" ns="http://fedramp.gov/ns/oscal" value="Value"/>
113113
{{< /highlight >}}
114114

115115
**NOTE:** The catalog and profile OSCAL models also allow the `part`

content/documentation/general-concepts/4-expressing-common-fedramp-template-elements-in-oscal.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ OR
5959
<last-modified>2023-03-03T00:00:00.000Z </last-modified>
6060
<version>0.0</version>
6161
<oscal-version>1.1.2</oscal-version>
62-
<prop name="fedramp-version" ns="https://fedramp.gov/ns/oscal" value="3.0.0-rc1"/>
62+
<prop name="fedramp-version" ns="http://fedramp.gov/ns/oscal" value="3.0.0-rc1"/>
6363
<prop name="marking" value="cui"/>
6464
<role id="fedramp-pmo">
6565
<title>FedRAMP PMO</title>
@@ -320,15 +320,15 @@ FedRAMP's revision history requirements.
320320
<published>2022-06-01T00:00:00.000Z</published>
321321
<version>1.0</version>
322322
<oscal-version>1.1.2</oscal-version>
323-
<prop name="party-uuid" ns="https://fedramp.gov/ns/oscal"
323+
<prop name="party-uuid" ns="http://fedramp.gov/ns/oscal"
324324
value="f84d8edc-d83e-440d-96c9-09b28c395ad5"/>
325325
<remarks><p>Initial publication.</p></remarks>
326326
</revision>
327327
<revision>
328328
<published>2022-06-01T00:00:00.000Z</published>
329329
<version>2.0</version>
330330
<oscal-version>1.1.2</oscal-version>
331-
<prop name="party-uuid" ns="https://fedramp.gov/ns/oscal"
331+
<prop name="party-uuid" ns="http://fedramp.gov/ns/oscal"
332332
value="2e0db7cf-08f5-472e-9360-fb3a9698476d"/>
333333
<remarks><p>Updated for annual assessment.</p></remarks>
334334
</revision>
@@ -340,7 +340,7 @@ FedRAMP's revision history requirements.
340340

341341
{{<callout>}}
342342
**FedRAMP Extension (Author)** \
343-
prop (`ns="https://fedramp.gov/ns/oscal"`):
343+
prop (`ns="http://fedramp.gov/ns/oscal"`):
344344
- `name="party-uuid"`
345345

346346
{{</callout>}}
@@ -351,7 +351,7 @@ prop (`ns="https://fedramp.gov/ns/oscal"`):
351351
- Revision Date for Individual Entry: `/*/metadata/revision-history/revision[1]/published`
352352
- Description for Individual Entry: `/*/metadata/revision-history/revision[1]/remarks/string()`
353353
- Version for Individual Entry: `/*/metadata/revision-history/revision[1]/version`
354-
- Author for Individual Entry: `/*/metadata/party[@uuid=/*/metadata/revision-history/revision[1]/prop [@name='party-uuid'][@ns='https://fedramp.gov/ns/oscal']]/org/short-name`
354+
- Author for Individual Entry: `/*/metadata/party[@uuid=/*/metadata/revision-history/revision[1]/prop [@name='party-uuid'][@ns='http://fedramp.gov/ns/oscal']]/org/short-name`
355355

356356
{{<callout>}}
357357
Replace XPath predicate "[1]" with "[2]", "[3]", etc.
@@ -382,12 +382,12 @@ FedRAMP maintains an official list of the versions on the [fedramp-automation re
382382
<last-modified>2023-03-03T00:00:00.000Z </last-modified>
383383
<version>0.0</version>
384384
<oscal-version>1.1.2</oscal-version>
385-
<prop name="fedramp-version" ns="https://fedramp.gov/ns/oscal" value="3.0.0-rc1"/>
385+
<prop name="fedramp-version" ns="http://fedramp.gov/ns/oscal" value="3.0.0-rc1"/>
386386
</metadata>
387387
{{</ highlight >}}
388388

389389
##### XPath Query
390-
`/*/metadata/prop[@name='fedramp-version'][@ns='https://fedramp.gov/ns/oscal']/@value`
390+
`/*/metadata/prop[@name='fedramp-version'][@ns='http://fedramp.gov/ns/oscal']/@value`
391391

392392
### How to Contact Us
393393

@@ -473,12 +473,12 @@ assessor's organization.
473473
</party>
474474
<party uuid="uuid-of-person-1" type="person">
475475
<name>[SAMPLE]Person Name 1</name>
476-
<prop name="title" ns="https://fedramp.gov/ns/oscal">Individual's Title</prop>
476+
<prop name="title" ns="http://fedramp.gov/ns/oscal">Individual's Title</prop>
477477
<member-of-organization>uuid-of-csp</member-of-organization>
478478
</party>
479479
<party uuid="uuid-of-person-2" type="person">
480480
<name>[SAMPLE]Person Name 2</name>
481-
<prop name="title" ns="https://fedramp.gov/ns/oscal">Individual's Title</prop>
481+
<prop name="title" ns="http://fedramp.gov/ns/oscal">Individual's Title</prop>
482482
<member-of-organization>uuid-of-csp</member-of-organization>
483483
</party>
484484
<responsible-party role-id="cloud-service-provider">
@@ -498,14 +498,14 @@ Required Role IDs:
498498
- `cloud-service-provider`
499499

500500
**FedRAMP Extension (Person's Title)** \
501-
prop (`ns="https://fedramp.gov/ns/oscal"`):
501+
prop (`ns="http://fedramp.gov/ns/oscal"`):
502502
- `name="title"`
503503
{{</callout>}}
504504

505505
##### XPath Queries
506506

507507
- Approver’s Name: `(/*/metadata/party[@uuid=[/*/metadata/responsible-party[@role-id='content-approver']/party-uuid]]/party-name)[1]`
508-
- Approver’s Title: `(/*/metadata/party[@uuid=[/*/metadata/responsible-party[@role-id='content-approver'] /party-uuid]]/prop[@name='title'][@ns='https://fedramp.gov/ns/oscal'])[1]`
508+
- Approver’s Title: `(/*/metadata/party[@uuid=[/*/metadata/responsible-party[@role-id='content-approver'] /party-uuid]]/prop[@name='title'][@ns='http://fedramp.gov/ns/oscal'])[1]`
509509

510510
NOTE: For each additional approver, replace the "[1]" with "[2]", "[3]", and so on.
511511

@@ -545,13 +545,13 @@ property type, `fedramp-acronyms`.
545545

546546
<resource uuid="985475ee-d4d6-4581-8fdf-d84d3d8caa48">
547547
<title>FedRAMP Applicable Laws and Regulations</title>
548-
<prop ns="https://fedramp.gov/ns/oscal" name="type" value="fedramp-citations"/>
548+
<prop ns="http://fedramp.gov/ns/oscal" name="type" value="fedramp-citations"/>
549549
<rlink href="https://-cut-/SSP-A12-FedRAMP-Laws-and-Regulations-Template.xlsx"/>
550550
</resource>
551551

552552
<resource uuid="1a23a771-d481-4594-9a1a-71d584fa4123">
553553
<title>FedRAMP Master Acronym and Glossary</title>
554-
<prop ns="https://fedramp.gov/ns/oscal" name="type" value="fedramp-acronyms"/>
554+
<prop ns="http://fedramp.gov/ns/oscal" name="type" value="fedramp-acronyms"/>
555555
<rlink href="https://-cut-/FedRAMP_Master_Acronym_and_Glossary.pdf" />
556556
</resource>
557557

content/documentation/general-concepts/oscal-layers-of-validation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ valid.
1313
|**Well-Formed**|The XML or JSON file follows the rules defined for that format. <br /> Any tool that processes the format will recognize it as "well-formed," which means the tool can proceed with processing the XML or JSON. <br /> XML: [https://www.w3.org/TR/REC-xml/](https://www.w3.org/TR/REC-xml/) <br /> JSON: [https://json.org/](https://json.org/)|
1414
|**OSCAL Syntax**|The XML or JSON file only uses names and values defined by OSCAL. OSCAL publishes schemas to verify syntax compliance based on the following standards: <br /> XML Syntax Validation: [XML Schema Definition Language (XSD) 1.1](https://www.w3.org/TR/xmlschema11-1/) <br /> JSON Syntax Validation: [JSON Schema, draft 07](https://json-schema.org/)|
1515
|**OSCAL Content**| For certain OSCAL fields, the OSCAL syntax validation tools also enforce content - allowing only a pre-defined set of values to be used in certain fields. <br /><br /> For example, Within the SSP model, impact levels within the information type assemblies only allow the following values: `fips-199-low`, `fips-199-moderate`, and `fips-199-high`. Any other value will cause an error when validating the file.|
16-
|**FedRAMP Syntax Extensions** | OSCAL is designed to represent the commonality of most cybersecurity frameworks and provided the ability to extend the language for framework-specific needs. FedRAMP makes use of these extensions. <br /><br />OSCAL provides `prop` fields throughout most of its assemblies, always with a `name`, `class`, and `ns` (namespace) flag: <br /> `<prop name="" class="" ns="">Data</prop>` <br /><br /> In the core OSCAL syntax, the `ns` flag is never used. Where FedRAMP extends OSCAL, the value for `ns` is always: `https://fedramp.gov/ns/oscal` (case sensitive). <br /><br /> When `ns='https://fedramp.gov/ns/oscal'` the `name` flag is as defined by FedRAMP. If the `class` flag is present, that is also defined by FedRAMP.|
16+
|**FedRAMP Syntax Extensions** | OSCAL is designed to represent the commonality of most cybersecurity frameworks and provided the ability to extend the language for framework-specific needs. FedRAMP makes use of these extensions. <br /><br />OSCAL provides `prop` fields throughout most of its assemblies, always with a `name`, `class`, and `ns` (namespace) flag: <br /> `<prop name="" class="" ns="">Data</prop>` <br /><br /> In the core OSCAL syntax, the `ns` flag is never used. Where FedRAMP extends OSCAL, the value for `ns` is always: `http://fedramp.gov/ns/oscal` (case sensitive). <br /><br /> When `ns="http://fedramp.gov/ns/oscal"` the `name` flag is as defined by FedRAMP. If the `class` flag is present, that is also defined by FedRAMP.|
1717
|**FedRAMP Content**| Today, FedRAMP content is enforced programmatically. FedRAMP intends to publish automated validation rules, which may be adopted by tool developers to verify OSCAL-based FedRAMP content is acceptable before submission. <br /><br />Initial validation rules ensure a package has all required elements and will evolve to perform more detailed validation. Separate details will be published about this in the near future.|
1818

content/documentation/poam/3-working-with-oscal-files.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ If the value is a URI fragment, such as #96445439-6ce1-4e22-beae-aa72cfe173d0, t
9292
<back-matter>
9393
<resource uuid="96445439-6ce1-4e22-beae-aa72cfe173d0">
9494
<title>[System Name] [FIPS-199 Level] SSP</title>
95-
<prop name="type" ns="https://fedramp.gov/ns/oscal" value="system-security-plan"/>
95+
<prop name="type" ns="http://fedramp.gov/ns/oscal" value="system-security-plan"/>
9696
<!-- Specify the XML or JSON file location. Only one required. -->
9797
<rlink media-type="application/xml" href="./CSP_System_SSP.xml" />
9898
<rlink media-type="application/json" href="./CSP_System_SSP.json" />
@@ -145,7 +145,7 @@ Finally, any SSP component referenced by POA&M data must be duplicated, whether
145145

146146
##### POA&M Representation
147147
{{< highlight xml "linenos=table" >}}
148-
<system-id identifier-type="https://fedramp.gov">F00000000</system-id>
148+
<system-id identifier-type="http://fedramp.gov/ns/oscal">F00000000</system-id>
149149
<local-definitions>
150150
<component uuid="uuid-value" type="software">
151151
<!-- cut -->
@@ -187,7 +187,7 @@ FedRAMP will be implementing a separate set of automated POA&M validation rules
187187
<!-- cut -->
188188
</revisions>
189189
<!-- New rev 5 prop -->
190-
<prop ns="https://fedramp.gov/ns/oscal" name="resolution-resource" value="ace2963d-ecb4-4be5-bdd0-1f6fd7610f41" />
190+
<prop ns="http://fedramp.gov/ns/oscal" name="resolution-resource" value="ace2963d-ecb4-4be5-bdd0-1f6fd7610f41" />
191191
</metadata>
192192
<!-- cut -->
193193
<back-matter>

0 commit comments

Comments
 (0)