Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Updated documentation, ReadMe.md file.
  • Loading branch information
Michal Zobec committed Jan 18, 2020
1 parent 6da7fb6 commit 662be0d
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@
# PS STIG Scanner
# PS STIG Scanner - Documentation

## About the PS STIG Scanner
<a name="documenttitle"></a>

Copyright &copy; 2019-2020 ZOBEC Consulting. All Rights Reserved.
Portions &copy; 2018 NSA Cybersecurity Directorate. All Rights Reserved.

## Version 2001.1 (20.01.19.004959) WIP DEV version

Development version, Work in progress (WIP).

## Introduction

PS STIG Scanner (PowerShell module) can be used to verify compliance against using audit files. This PowerShell module makes it simple to scan a single standalone system and verify a configuration has been applied to a system in a non-domain context.

Note that Nessus is not required to be installed on the system that is being checked with the script.

[*Back to top*](#documenttitle "Top of the document")

## Getting started

To get started using the tools:
Expand All @@ -16,10 +27,14 @@ To get started using the tools:
1. [Apply the policies](#applying-the-policies)
1. [Check compliance](#checking-compliance)

[*Back to top*](#documenttitle "Top of the document")

## Downloading the repository

Download the [current code](https://github.com/michalzobec/PS-STIG-Scanner/archive/master.zip) to your **Downloads** folder. It will be saved as **PS-STIG-Scanner-master.zip** by default.

[*Back to top*](#documenttitle "Top of the document")

## Configuring the PowerShell environment

The PowerShell commands are meant to run from a system with at least PowerShell 3.0 installed. PowerShell may need to be configured to run the commands.
Expand Down Expand Up @@ -71,10 +86,14 @@ Nessus audit files are included in this repository. Compliance checks are availa
* Windows
* Windows Firewall

[*Back to top*](#documenttitle "Top of the document")

## Running Compliance Checks

Use a the provided Compliance PowerShell script (Nessus not required).

[*Back to top*](#documenttitle "Top of the document")

## Standalone Scan with PowerShell

The **Test-Compliance** command in the [Compliance PowerShell module](./Compliance/) can be used to verify compliance against using any of the above listed .audit files. This PowerShell script makes it simple to scan a single standalone system and verify a configuration has been applied to a system in a non-domain context. Note that Nessus is not required to be installed on the system that is being checked with the script. The following instructions can be used to execute a compliance check locally.
Expand Down Expand Up @@ -104,16 +123,24 @@ After capturing the output into a file, the failed STIG checks can be filtered u

```Select-String -Path .\ComplianceReport.txt -Pattern 'FAILED'```

[*Back to top*](#documenttitle "Top of the document")

## Links

* [Nessus Compliance Checks Reference (PDF)](https://docs.tenable.com/nessus/compliancechecksreference/Content/Resources/PDF/NessusComplianceChecksReference.pdf)
* [Nessus Compliance Checks Reference (HTML)](https://docs.tenable.com/nessus/compliancechecksreference/Content/ComplianceCheckTypes.htm)
* [Nessus Compliance Checks Overview (PDF)](https://support.tenable.com/support-center/nessus_compliance_checks.pdf)

[*Back to top*](#documenttitle "Top of the document")

## License

See [LICENSE](./LICENSE.md).

[*Back to top*](#documenttitle "Top of the document")

## Disclaimer

See [DISCLAIMER](./DISCLAIMER.md).

[*Back to top*](#documenttitle "Top of the document")

0 comments on commit 662be0d

Please sign in to comment.