Skip to content

Commit

Permalink
Merge pull request #91 from Cingulara/develop
Browse files Browse the repository at this point in the history
Updating Missing Docs
  • Loading branch information
Cingulara authored Feb 9, 2020
2 parents f433797 + d6f8e42 commit f36e2f8
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 11 deletions.
Binary file modified docs/assets/system-record.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/upload-nessus-scan-file.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 13 additions & 2 deletions docs/systems.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,19 @@ Each listing shows the title, the number of checklists in that system as well as

## System Detailed View

The System detailed page shows televant system information such as the title and description. It also allows you to edit information if you have the correct role. There is detailed audit information on the right such as the create date and last date updated. The compliance date is updated each time you run a compliance report on the system.
The System detailed page shows relevant system information such as the title and description. It also allows you to edit specific information if you have the correct role. There is detailed audit information on the right such as the create date and last date updated. The compliance date is updated each time you run a compliance report on the system.

New features include the ability to upload and view Nessus ACAS scan file data as well as generate exports and reports from that *.nessus file. And you can generate a Test Plan Summary for your system showing all items that are open from your ACAS scan data, SCAP scans, and your manual CKL checklist files across your whole system.

![OpenRMF Checklist Details](/assets/system-record.png)

At the bottom of this page is the list of all checklists for this system linked by title. Their overall score is also displayed in the filtered table. Click the plus sign to expand the score by category of vulnerability to get more detailed information. Click on the actual checklist title to view the detailed information on that checklist.
At the bottom of this page is the list of all checklists for this system linked by title. Their overall score is also displayed in the filtered table. Click the plus sign to expand the score by category of vulnerability to get more detailed information. Click on the actual checklist title to view the detailed information on that checklist.


## Uploading Nessus ACAS Scans

![OpenRMF Upload of Nessus ACAS Scans](/assets/upload-nessus-scan-file.png)

Once you have a System record, you can click the Edit button for the system to upload a *.nessus file for your scan output. OpenRMF will save your file (a single file for the OSS version) and generate export listing for the whole system or by host into MS Excel files. You also can run reports on the Nessus file based on your system in the Reports area.

The Dashboard will also show the total number of Critical, High, Medium, and Low items once your have uploaded a .nessus file as well. Remember, OpenRMF OSS stores a single file. So upload the most up-to-date file that has all your servers in the listing.
10 changes: 9 additions & 1 deletion docs/uploading.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,12 @@ If you upload an XCCDF XML SCAP scan result file (DISA or Nessus SCAP), that fil

You can upload a checklist file as a Template to start from within the system as well. You can use Templates in OpenRMF for a starting point for your checklists. A great example would be you have an infrastructure package and a platform-as-a-service package that your application(s) run on. That infrastructure and PaaS have known good checklists as a baseline that application owners use as a starting point and adjust the remaining vulnerability items accordingly. IT personnel would download this template and then fill out remaining items based on their software or system.

To upload you go to the Template Upload section and enter a title and description for the template. Then lcick the Choose file and upload the template. You can only upload one template at a time.
To upload you go to the Template Upload section and enter a title and description for the template. Then click the Choose file and upload the template. You can only upload one template at a time.

## Uploading Nessus ACAS Scans

![OpenRMF Upload of Nessus ACAS Scans](/assets/upload-nessus-scan-file.png)

Once you have a System record, you can click the Edit button for the system to upload a *.nessus file for your scan output. OpenRMF will save your file (a single file for the OSS version) and generate export listing for the whole system or by host into MS Excel files. You also can run reports on the Nessus file based on your system in the Reports area.

The Dashboard will also show the total number of Critical, High, Medium, and Low items once your have uploaded a .nessus file as well. Remember, OpenRMF OSS stores a single file. So upload the most up-to-date file that has all your servers in the listing.
16 changes: 8 additions & 8 deletions scripts/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ version : '3'
services:
### 1 Web Front End Container
openrmf-web:
image: cingulara/openrmf-web:0.11.2
image: cingulara/openrmf-web:0.12.1
ports:
- 8080:80
depends_on:
Expand All @@ -18,7 +18,7 @@ services:

### 8 API Containers
openrmfapi-scoring:
image: cingulara/openrmf-api-scoring:0.11
image: cingulara/openrmf-api-scoring:0.12
ports:
- 8090:8080
env_file: .env
Expand All @@ -33,7 +33,7 @@ services:
- openrmf

openrmfapi-save:
image: cingulara/openrmf-api-save:0.11
image: cingulara/openrmf-api-save:0.12
ports:
- 8082:8080
env_file: .env
Expand Down Expand Up @@ -66,7 +66,7 @@ services:
- openrmf

openrmfapi-upload:
image: cingulara/openrmf-api-upload:0.11
image: cingulara/openrmf-api-upload:0.12
ports:
- 8086:8080
env_file: .env
Expand All @@ -84,7 +84,7 @@ services:
- openrmf

openrmfapi-read:
image: cingulara/openrmf-api-read:0.11.2
image: cingulara/openrmf-api-read:0.12
ports:
- 8084:8080
env_file: .env
Expand Down Expand Up @@ -139,7 +139,7 @@ services:

### 7 Messaging Containers
openrmfmsg-score:
image: cingulara/openrmf-msg-score:0.11
image: cingulara/openrmf-msg-score:0.12
environment:
- MONGODBCONNECTION=mongodb://openrmfscore:openrmf1234!@scoredb/openrmfscore?authSource=openrmfscore
- MONGODB=openrmfscore
Expand All @@ -151,7 +151,7 @@ services:
- openrmf

openrmfmsg-checklist:
image: cingulara/openrmf-msg-checklist:0.11
image: cingulara/openrmf-msg-checklist:0.12
environment:
- MONGODBCONNECTION=mongodb://openrmf:openrmf1234!@checklistdb/openrmf?authSource=openrmf
- MONGODB=openrmf
Expand Down Expand Up @@ -193,7 +193,7 @@ services:
- openrmf

openrmfmsg-system:
image: cingulara/openrmf-msg-system:0.11
image: cingulara/openrmf-msg-system:0.12
environment:
- MONGODBCONNECTION=mongodb://openrmf:openrmf1234!@checklistdb/openrmf?authSource=openrmf
- MONGODB=openrmf
Expand Down

0 comments on commit f36e2f8

Please sign in to comment.