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

doc: Added a little more about .ckl and data handling #223

Merged
merged 2 commits into from
Mar 31, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file modified docs/_build/doctrees/admin-guide/admin-guide.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/admin-guide/admin-quickstart.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/features/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/_build/doctrees/the-project/related-repos.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/user-guide/user-guide.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/user-guide/user-quickstart.doctree
Binary file not shown.
14 changes: 14 additions & 0 deletions docs/_build/html/_sources/features/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@ Features and Capabilities Overview
====================================


STIG Evaluation Data, Freed From .CKL Files
----------------------------------------------------

STIG Manager maintains a canonical set of STIGs as published by DISA, and relates all Reviews to that set. Working with this data directly in STIGMan, rather than passing .ckl files around, eliminates the possibility of STIG Evaluators using the wrong STIG revision, changing severity, creating malformed .ckls, and other issues that can hamper the efficient flow of Evaluations to Validators. STIG Manager will import .ckl files and create Reviews that match their contents. Any remaining Evaluation gaps can be reviewed manually in the STIGMan interface, or added to with additional imports. STIGMan provide a unified view of overall Evaluation progress, and are not tied to any specific .ckl file.

Instead of relying on .CKL files that could be altered, overridden, or have missing fields, properly formed .CKLs are generated from the current Evaluation state of Assets. Once Validators verify that all reviews are as they want them, they can create an archive of .CKLs on demand for import into eMASS.


RMF Package data represented as Collections, Assets, STIGs, and Reviews
----------------------------------------------------------------------------------

Expand Down Expand Up @@ -121,6 +129,12 @@ STIG Manager is (almost) ready to support a life-cycle approach to RMF. With the
Collaborate on Steps 3 and 4 of the RMF Process
===================================================

STIGMan separates your evaluation data from the .ckls that previously contained them.
Instead of sending .ckls around ahving to check that they are in order, perfect .ckls are generated on demand.
STIG Manager produces .ckls that represent

Based off a canonical STIG, so you don't have to worry if the .ckl STIG is altered.


Collaborate on STIG Evaluation and management. Make use of others expertise.

Expand Down
4 changes: 2 additions & 2 deletions docs/_build/html/_sources/the-project/related-repos.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ If other projects want to contribute a client or other stand-alone enhancements
STIGMan Watcher
===========================

The STIG Manager Watcher utility is maintained by the same group as the main project, and serves as the reference Command Line Utility. It is a Node.js app that will monitor a specific folder for .ckl or XCCDF .xml files and automatically import them into a designated Collection.
The STIG Manager Watcher utility is separately maintained by a member of the NUWCDIVNPT STIG Manager team, and serves as the reference Command Line Utility. It is a Node.js app that will monitor a specific folder for .ckl or XCCDF .xml files and automatically import them into a designated Collection.

See the `STIGMan Watcher Repo <https://github.com/NUWCDIVNPT/stigman-watcher>`_ for more details.
See the `STIGMan Watcher Repo <https://github.com/csmig/stigman-watcher>`_ for more details.


8 changes: 4 additions & 4 deletions docs/_build/html/admin-guide/admin-guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ <h3><span class="section-number">2.2.1. </span>Collections Admin Panel<a class="
</div>
<figure class="">
<a
data-lightbox="group-602555bd-f2f0-4a63-833c-b104f2bd6301"
data-lightbox="group-1001811f-3319-4eec-ae98-c2706961db9f"
href="../_images/admin-collections1.png"
title="Collection Administration"
data-title="Collection Administration"
Expand All @@ -252,7 +252,7 @@ <h3><span class="section-number">2.2.2. </span>User Grants Admin Panel<a class="
<p>Users can be Unregistered from STIG Manager, which will delete STIGMan’s information about the User. If the User accesses STIG Manager again, they will appear as a new User, with no STIG Assignments or Collection Grants.</p>
<figure class="">
<a
data-lightbox="group-6e2fe418-6cd3-48ab-ab98-e9fdecd17bd4"
data-lightbox="group-d5810f13-73c6-4c60-b2d6-bb98b1ad02f2"
href="../_images/admin-user-grants1.png"
title="User Grants Administration"
data-title="User Grants Administration"
Expand All @@ -271,7 +271,7 @@ <h3><span class="section-number">2.2.3. </span>STIG and SCAP Benchmarks Admin Pa
<p>Use the buttons at the top to Add new STIGs (STIGs can be imported individually, or as a .zip library of many STIGs), or delete them.</p>
<figure class="">
<a
data-lightbox="group-5fdee032-b9bc-4e41-904e-c631434259ab"
data-lightbox="group-f84d83a1-66bb-4c99-9570-5b5efbbf7f32"
href="../_images/admin-stigs1.png"
title="STIGs Administration"
data-title="STIGs Administration"
Expand All @@ -293,7 +293,7 @@ <h3><span class="section-number">2.2.3. </span>STIG and SCAP Benchmarks Admin Pa
</div>
<figure class="">
<a
data-lightbox="group-14c5d8f3-3fc6-4548-a150-2512fddab2fd"
data-lightbox="group-708f1561-2215-4b2c-88d8-04e075684824"
href="../_images/admin-app-data1.png"
title="Application Data Import/Export"
data-title="Application Data Import/Export"
Expand Down
6 changes: 3 additions & 3 deletions docs/_build/html/admin-guide/admin-quickstart.html
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ <h3><span class="section-number">1.1.1. </span>Collections Tab<a class="headerli
<p>In most cases, Collection Owners should be administering their own Collections. However, in cases where the Owner is unavailable, or has accidentally removed all owners from a Collection, this interface allows an Admin to assign new Owner Grants to Collections by double-clicking the Collection or using the “Collection Properties” button. The Admin can also delete Collections if required.</p>
<figure class="">
<a
data-lightbox="group-5643db32-7751-4448-86c8-7a38f7284fc1"
data-lightbox="group-f3e7e809-efab-42e2-831a-b6c2339629d8"
href="../_images/CollectionAdmin1.png"
title="Collection Admin"
data-title="Collection Admin"
Expand Down Expand Up @@ -259,7 +259,7 @@ <h4><span class="section-number">1.1.2.3. </span>Modifying Users<a class="header
<p>The only changes that can be made to Users in the STIG Manager interface is their Collection Grants. All other data in the User pop-up is derived from information in the access token, which is managed in Keycloak.</p>
<figure class="">
<a
data-lightbox="group-812a0b41-61aa-4ee0-8b69-a6e8a09ee7d7"
data-lightbox="group-742546ea-e83c-4b39-917a-a68d67c8c0ee"
href="../_images/userAdmin1.png"
title="User Admin"
data-title="User Admin"
Expand All @@ -277,7 +277,7 @@ <h4><span class="section-number">1.1.2.3. </span>Modifying Users<a class="header
<p>This tab shows you a list of STIGs known to this instance of STIG Manager along with some basic statistics about them, such as their rule count and revision date. This interface also allows you to import new STIGs. This can be done individually, or as a .zip file of multiple STIGs (such as the <a class="reference external" href="cyber.mil/stigs/compilations/">quarterly STIG Library Compilations from DISA</a>).</p>
<figure class="">
<a
data-lightbox="group-97a85517-5218-40e4-bb6a-264ad87a3c27"
data-lightbox="group-a012c82b-f432-444d-b6a1-b1d1c33758e6"
href="../_images/StigAdmin1.png"
title="STIG Admin"
data-title="STIG Admin"
Expand Down
6 changes: 6 additions & 0 deletions docs/_build/html/features/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@
<li class="toctree-l2"><a class="reference internal" href="#what-is-stig-manager">What is STIG Manager?</a></li>
<li class="toctree-l2"><a class="reference internal" href="#the-single-source-of-truth-throughout-steps-3-and-4-of-the-rmf-process">The Single Source of Truth throughout Steps 3 and 4 of the RMF Process</a></li>
<li class="toctree-l2"><a class="reference internal" href="#features-and-capabilities-overview">Features and Capabilities Overview</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#stig-evaluation-data-freed-from-ckl-files">STIG Evaluation Data, Freed From .CKL Files</a></li>
<li class="toctree-l3"><a class="reference internal" href="#rmf-package-data-represented-as-collections-assets-stigs-and-reviews">RMF Package data represented as Collections, Assets, STIGs, and Reviews</a></li>
<li class="toctree-l3"><a class="reference internal" href="#create-collections-from-your-existing-ckl-files">Create Collections From Your Existing .CKL Files</a></li>
<li class="toctree-l3"><a class="reference internal" href="#workspaces-for-common-tasks-and-getting-a-handle-on-your-evaluation-data">Workspaces for Common Tasks and Getting a Handle on Your Evaluation Data</a></li>
Expand Down Expand Up @@ -235,6 +236,11 @@ <h2>The Single Source of Truth throughout Steps 3 and 4 of the RMF Process<a cla
<hr class="docutils" />
<div class="section" id="features-and-capabilities-overview">
<h2>Features and Capabilities Overview<a class="headerlink" href="#features-and-capabilities-overview" title="Permalink to this headline">¶</a></h2>
<div class="section" id="stig-evaluation-data-freed-from-ckl-files">
<h3>STIG Evaluation Data, Freed From .CKL Files<a class="headerlink" href="#stig-evaluation-data-freed-from-ckl-files" title="Permalink to this headline">¶</a></h3>
<p>STIG Manager maintains a canonical set of STIGs as published by DISA, and relates all Reviews to that set. Working with this data directly in STIGMan, rather than passing .ckl files around, eliminates the possibility of STIG Evaluators using the wrong STIG revision, changing severity, creating malformed .ckls, and other issues that can hamper the efficient flow of Evaluations to Validators. STIG Manager will import .ckl files and create Reviews that match their contents. Any remaining Evaluation gaps can be reviewed manually in the STIGMan interface, or added to with additional imports. STIGMan provide a unified view of overall Evaluation progress, and are not tied to any specific .ckl file.</p>
<p>Instead of relying on .CKL files that could be altered, overridden, or have missing fields, properly formed .CKLs are generated from the current Evaluation state of Assets. Once Validators verify that all reviews are as they want them, they can create an archive of .CKLs on demand for import into eMASS.</p>
</div>
<div class="section" id="rmf-package-data-represented-as-collections-assets-stigs-and-reviews">
<h3>RMF Package data represented as Collections, Assets, STIGs, and Reviews<a class="headerlink" href="#rmf-package-data-represented-as-collections-assets-stigs-and-reviews" title="Permalink to this headline">¶</a></h3>
<p>STIG Manager’s primary organizational structure is the Collection. A Collection can be created to mirror components of an RMF Package, requirements identified in a Security Assessment Plan, or an entirely different principle that may be more convenient, such as by an organization’s Lab or by Asset OS.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@
<h2><span class="section-number">1.1. </span>Components<a class="headerlink" href="#components" title="Permalink to this headline">¶</a></h2>
<figure class="">
<a
data-lightbox="group-45360716-4166-48af-a920-001f7a8b5839"
data-lightbox="group-43a0ca1e-661b-4ca3-a7ee-7b9b82fee708"
href="../_images/stigman-components-basic1.svg"
title="Component Diagram"
data-title="Component Diagram"
Expand Down
4 changes: 2 additions & 2 deletions docs/_build/html/installation-and-setup/reverse-proxy.html
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ <h2><span class="section-number">5.2. </span>STIG Manager with nginx for TLS<a c
<hr class="docutils" />
<figure class="">
<a
data-lightbox="group-c8e110b7-21a1-4c98-a207-b31378f872a9"
data-lightbox="group-a1f6a14c-a167-4865-b5ad-b9decb7dbe3a"
href="../_images/component-diagram1.svg"
title="Component Diagram with Reverse Proxy"
data-title="Component Diagram with Reverse Proxy"
Expand All @@ -232,7 +232,7 @@ <h2><span class="section-number">5.2. </span>STIG Manager with nginx for TLS<a c
</figure><hr class="docutils" />
<figure class="">
<a
data-lightbox="group-b7219778-37cc-4d14-88b0-929dec2aa416"
data-lightbox="group-734bda92-33e1-4ceb-8b23-1397b7dd3410"
href="../_images/k8-component-diagram1.svg"
title="Component Diagram with Kubernetes"
data-title="Component Diagram with Kubernetes"
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/searchindex.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/_build/html/the-project/related-repos.html
Original file line number Diff line number Diff line change
Expand Up @@ -215,8 +215,8 @@
<p>If other projects want to contribute a client or other stand-alone enhancements to the tool, create a Pull Request and we will link to them here.</p>
<div class="section" id="stigman-watcher">
<h2>STIGMan Watcher<a class="headerlink" href="#stigman-watcher" title="Permalink to this headline">¶</a></h2>
<p>The STIG Manager Watcher utility is maintained by the same group as the main project, and serves as the reference Command Line Utility. It is a Node.js app that will monitor a specific folder for .ckl or XCCDF .xml files and automatically import them into a designated Collection.</p>
<p>See the <a class="reference external" href="https://github.com/NUWCDIVNPT/stigman-watcher">STIGMan Watcher Repo</a> for more details.</p>
<p>The STIG Manager Watcher utility is separately maintained by a member of the NUWCDIVNPT STIG Manager team, and serves as the reference Command Line Utility. It is a Node.js app that will monitor a specific folder for .ckl or XCCDF .xml files and automatically import them into a designated Collection.</p>
<p>See the <a class="reference external" href="https://github.com/csmig/stigman-watcher">STIGMan Watcher Repo</a> for more details.</p>
</div>
</div>

Expand Down
Loading