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.

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

[do not merge] "oscalkit" utility #65

Closed
wants to merge 79 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
79 commits
Select commit Hold shift + click to select a range
922f2ca
Initial cut and placeholder for Profile Semantics docs
wendellpiez Dec 4, 2017
44420e9
Minor revs
wendellpiez Dec 5, 2017
93dc97d
More various edits
wendellpiez Dec 5, 2017
be63198
More adjustments
wendellpiez Dec 5, 2017
bfeb55b
More revisions to profile semantics docs
wendellpiez Dec 7, 2017
61753db
Mostly more diagrams
wendellpiez Dec 11, 2017
eb326aa
More touchups to docs
wendellpiez Dec 11, 2017
cba0c47
More touchups to docs
wendellpiez Dec 11, 2017
71df185
Correction to top-level readme
wendellpiez Dec 12, 2017
5c2d83d
Merge remote-tracking branch 'remotes/origin/master' into sprint-6
david-waltermire Dec 12, 2017
1c444e7
Sketching implementation layer in XML
wendellpiez Dec 13, 2017
f2a1e57
Merge branch 'sprint-6' of https://github.com/usnistgov/OSCAL.git int…
wendellpiez Dec 13, 2017
b10cf41
oXygen schema documentation
wendellpiez Dec 13, 2017
613ba15
Touches
wendellpiez Dec 13, 2017
b43760c
New page suggesting regrouping logic
wendellpiez Dec 14, 2017
70e5997
Tweaking
wendellpiez Dec 14, 2017
24284ff
More touchups and corrections
wendellpiez Dec 14, 2017
db51d76
Had to rename the spec document
wendellpiez Dec 14, 2017
994692d
Now indexing to SP800-53 controls ... and params too, almost
wendellpiez Dec 18, 2017
87e3209
Now correcting target type
wendellpiez Dec 18, 2017
3cfc08c
New examples conforming to almost-ready new profile model
wendellpiez Dec 19, 2017
c17aa3d
Updating terminology
wendellpiez Dec 20, 2017
47468ba
More corrections
wendellpiez Dec 20, 2017
0d483b0
Towards new profile model
wendellpiez Dec 22, 2017
f98be7e
Merging now working
wendellpiez Dec 22, 2017
c616227
More adjustments to merge
wendellpiez Dec 22, 2017
40be681
Merge now includes provenance tracer
wendellpiez Dec 22, 2017
78b53f4
Updates to 'implementation layer' XML mockups
wendellpiez Dec 22, 2017
44167b7
Updated examples to new profile schema
wendellpiez Dec 26, 2017
e35d7ca
Updating HTML production pipeline
wendellpiez Dec 26, 2017
a3efa7a
Updating tools, Schematrons
wendellpiez Dec 26, 2017
feb54d0
Rearranging to collapse paranoid temp directory
wendellpiez Dec 26, 2017
df92fee
Correction to recursive import logic
wendellpiez Dec 27, 2017
d184c2a
Adjustments and updates
wendellpiez Dec 27, 2017
cbb4cad
More corrections and improvements to profile/resolution/validation
wendellpiez Dec 27, 2017
7849a10
Finishing modify implementation under new design
wendellpiez Dec 29, 2017
e51b7ed
Updates to Merge-Diagrams.html
wendellpiez Dec 29, 2017
4de5318
Adjustments to profiling spec docs
wendellpiez Dec 29, 2017
95d2fd0
Refinements of enhancing "implementation" XML including RNC schema
wendellpiez Jan 2, 2018
f906cb5
Docs; cleanup
wendellpiez Jan 3, 2018
b05e75b
SVGs for all mini-testing examples (testing batch production)
wendellpiez Jan 5, 2018
cfe7f4c
Updated working/FedRAMP with some refinements
wendellpiez Jan 5, 2018
00e917c
More misc
wendellpiez Jan 25, 2018
dc48525
Merge branch 'master' into sprint-6
david-waltermire Jan 25, 2018
a1c3dc1
Create CONTRIBUTING.md
kscarf1 Jan 26, 2018
e11c7ca
Create USERS.md
kscarf1 Jan 26, 2018
2980eac
Merge branch 'sprint-7' of https://github.com/usnistgov/OSCAL.git int…
wendellpiez Jan 27, 2018
9f865a3
Minor adjustments prior to more major adjustments
wendellpiez Jan 27, 2018
d15c2e5
Putting up obfuscated and unobfuscated ISO 27002
wendellpiez Jan 30, 2018
9bbb197
Putting up obfuscated and unobfuscated ISO 27002
wendellpiez Jan 30, 2018
8feede2
Putting up obfuscated and unobfuscated ISO 27002
wendellpiez Jan 30, 2018
3826282
Putting up obfuscated and unobfuscated ISO 27002
wendellpiez Jan 30, 2018
5e9147f
Next-next gen profile resolver, who default results are much simpler --
wendellpiez Jan 30, 2018
d973486
More adjustments to profile semantics
wendellpiez Jan 30, 2018
b24253b
oscalkit updates
Dec 7, 2017
9c3ea8d
update oscalkit
Dec 7, 2017
a39e9eb
update oc conversion
Dec 7, 2017
8cb4f9a
update oscalkit
Dec 11, 2017
53f4b54
unmarshal implementation json
Dec 12, 2017
f89dd68
update oc conversion
Dec 13, 2017
a13c254
update makefile
Dec 14, 2017
5d40858
id url workaround for validation
Dec 15, 2017
bf40e1f
update oc conversion
Dec 15, 2017
236f424
update implementation quoting
Dec 15, 2017
1d9b145
fix unquoting
Dec 18, 2017
396ffc2
update readme
Dec 21, 2017
6cdfe69
fix OC conversion and prose marshaling
Jan 27, 2018
fab9c9f
prune deps
Jan 29, 2018
604ff00
prose updates
Jan 29, 2018
0584a40
command and Makefile updates
Jan 30, 2018
2157f92
oc conversion updates
Jan 30, 2018
c2954a3
raw XML from framework
Jan 31, 2018
773cf76
oscalkit refactor
Feb 1, 2018
45ab8be
update profile parsing
Feb 2, 2018
ef5e3e0
refactor
Feb 2, 2018
dc38f1a
updates
Feb 2, 2018
69d8ae9
refactor
Feb 5, 2018
f22e280
refactor
Feb 5, 2018
b35453a
update README
Feb 5, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
10 changes: 10 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,13 @@ vault

*/working/**/*.pdf

# Go
*.exe
*.dll
*.so
*.dylib
*.test
*.out

.vscode/
debug
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contributing to the OSCAL Project

This page is for potential contributors to the OSCAL project. It provides basic information on the OSCAL project, describes the main ways people can make contributions, explains how to report issues with OSCAL, and lists pointers to additional sources of information.

## Project approach

The approach we’re taking with OSCAL is agile. We’re adopting the philosophy of implementing the 20% of the functionality that solves 80% of the problem. We’re trying to focus on the core capabilities that are needed to provide the greatest amount of benefit. Because we’re working on a small set of capabilities, that allows us to make very fast progress. We’re building the features that we believe solve the biggest problems, so we’re providing the most value.

## Contribution options

The OSCAL project is producing several types of deliverables, including the following:
* *XML schemas* for the OSCAL component models
* *Schematron definitions*, which are basically an extension of the XML schemas that provide more validation capabilities
* *XSL templates* for production of human-readable versions of OSCAL XML content
* *CSS*, so people who are developing catalogs and profiles using XML tools can use CSS for data entry, which offers a much more usable interface
* *Documentation* to define the OSCAL component models, capture the operational model of how to use OSCAL, and explain how you can convert existing content (catalogs, profiles, etc.) into OSCAL formats

Contributions are welcome in any of these areas. For information on the project's current needs and priorities, see the project's GitHub issue tracker (discussed below).

## Issue reporting and handling

All requests for changes and enhancements to OSCAL are initiated through the project's GitHub issue tracker (https://github.com/usnistgov/OSCAL/issues). To initiate a request, please create a new issue. The core OSCAL project team regularly reviews the open issues, prioritizes their handling, and updates the issue statuses and comments as needed.

## Communications mechanisms

There are two mailing lists for the project:
* *oscal-dev@nist.gov* for communication among parties interested in contributing to the development of OSCAL or exchanging ideas. Subscribe by visiting https://email.nist.gov/mailman/listinfo/oscal-dev.
* *oscal-updates@nist.gov* for low-frequency updates on the status of the OSCAL project. To subscribe, visit https://email.nist.gov/mailman/listinfo/oscal-updates.

## Setup instructions

As the OSCAL project matures, instructions will be posted here for how to get the latest OSCAL files from the GitHub repository, set up your environment for OSCAL development/testing, etc. At this time, instructions are limited to README files in the repository that explain what’s on the repository, how the repository is organized, etc.
3,911 changes: 2,929 additions & 982 deletions OSCAL-dev.xpr

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ NIST is proposing the development of the Open Security Controls Assessment Langu

This repository consists of the following directories pertaining to the OSCAL project:
* [docs](docs): Documentation graphics, prose, progress updates, and presentation slides
* [working](working): Development artifacts (e.g., XML, XSLT, CSS, script, Markdown, and sample files, plus supporting files); additional documentation is posted under [working/doc](working/doc):
* [examples](examples): OSCAL examples, including both demo (unit test) and "real world" examples
* [sources](sources): Resources used to produce OSCAL artifacts that are not maintained by the OSCAL project (e.g., a copy of the NIST SP 800-53 control data feed schema)
* [working](working): Development artifacts (e.g., XML, XSLT, CSS, script, Markdown, and sample files, plus supporting files); additional documentation is posted under [working/doc](working/doc):

See [docs/prose/OSCAL-Overview.md](docs/prose/OSCAL-Overview.md) for an introduction to OSCAL and [docs/schema/oscal-tag-library.md](docs/schema/oscal-tag-library.md) for detailed information on the OSCAL data models and XML schema compositions.

Expand Down
9 changes: 9 additions & 0 deletions USERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Documentation for users of OSCAL tools and content

The following types of users are most likely to benefit from consuming OSCAL tools and content when they are available:
* *Operations personnel*, who will be able to rapidly verify that systems comply with organizational security requirements
* *Security and privacy personnel*, who will be able to automatically identify problems and address them quickly before loss or damage occur; for example, a profile could be used to identify incorrect parameter values that are weakening security
* *Auditors/assessors*, who will be able to perform audits/assessments on demand with minimal effort
* *Policy personnel*, who will be able to better identify systemic problems that necessitate changes to organization security policy

At this time, we do not have information available on using OSCAL tools and content because the initial components of OSCAL are still under development and are not yet ready for operational use. As OSCAL development continues, we will add pointers here to examples of OSCAL content so you can get an idea for what operational OSCAL content will look like.
41 changes: 41 additions & 0 deletions docs/graphics/diagrams/01_identity-profile.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
107 changes: 107 additions & 0 deletions docs/graphics/diagrams/01a_param-only-profile.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
63 changes: 63 additions & 0 deletions docs/graphics/diagrams/02_all-profile.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
63 changes: 63 additions & 0 deletions docs/graphics/diagrams/03_all-with-enh-profile.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading