From 172d42175626120c0c07c768f724e98cfa49d22b Mon Sep 17 00:00:00 2001 From: tony mancill Date: Sun, 16 Jul 2017 10:09:04 -0700 Subject: [PATCH] wordsmith README.md --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index c642434..6e2dc1a 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,13 @@ Benchmark Date: 27 Feb 2017 ## Upgrade -It has been a long time since we update STIG for Debian's framework. I think it's time to upgrade for the comming of Debian 9 stable release. +It has been a long time since we have updated STIG for Debian's framework. I think it's time to upgrade for the release of Debian 9 stable. ## HTML report output supported -For easy to read reports, we decided to output to HTML for the primary (and for now, only) option. +For easy to read reports, we decided to output to HTML as the primary (and for now, only) option. -Thanks to the author [zavoloklom](https://github.com/zavoloklom) for the html table template +Thanks to the author [zavoloklom](https://github.com/zavoloklom) for the HTML table template ## Usage @@ -47,12 +47,12 @@ Ported from DISA RHEL 7 STIG ## How to get involved -This time is only new framework release only. Not much check rule has been port from DISA RHEL 7 STIG for now. +This is a new framework release only. Not many check rules have been ported from DISA RHEL 7 STIG yet. -We(and you) will fill it up soon. +We (and you) will fill it up soon. ### How to add check rule: - 1. Create new check script file in scripts directory for new check rule, and implementation. + 1. Create a new check script file in the scripts directory for the new check rule and implementation. 1. Move new check rule description to stig-debian-9.txt. 1. Call the check script file in stig-4-debian.sh, as follows: @@ -62,7 +62,7 @@ spinner $! output "SV-id_rule" $? ``` -### How to del check rule: +### How to delete a check rule: 1. Delete check rule description from stig-debian-9.txt. 1. Delete the check script file in the scripts directory. 1. Delete calls the check script line in stig-4-debian.sh. @@ -75,24 +75,24 @@ spinner $! output "SV-86561r1_rule" $? ``` -This code snippet, we using a script name `check-nullok.sh` to check nullok in system-auth-ac and using exit status to determine the result of checking. +In this code snippet, we using a script name `check-nullok.sh` to check nullok in system-auth-ac and use exit status to determine the results of the check: `spinner $!` is a small function for administrator to feel this script is running ;) `output "SV-86561r1_rule" $?` using `output` function to output. -When the script is porting, the original text is from DISA RHEL 7 STIG and if some rule is RHEL 7 specific and you should using responding checking method in debian and update the textfile `stig-debian-9.txt` +When the script is ported, note that the original text is from DISA RHEL 7 STIG. If some rule is RHEL 7 specific, you should use a corresponding check method in Debian and update the textfile `stig-debian-9.txt`. -If you encounter some rule that you cannot easily write a small script to check. You can put this rule in `manual.txt` +If you encounter some rule that you cannot easily write a small script to check. You can put this rule in `manual.txt`. #### Addition -In `statics` directory `xml2text.sh` is a script that can extract the information we need from offcial STIG xml file, such as 'U_Red_Hat_Enterprise_Linux_7_STIG_V1R1_Manual-xccdf.xml'. The original text file `stig-debian-9.txt` is copy from `stig-rhel-7.txt`. How to easily update STIG for Debian textfile when the offcial RHEL 7 STIG is under discussion. +In the `statics` directory `xml2text.sh` is a script that can extract the information we need from offcial STIG XML file, such as 'U_Red_Hat_Enterprise_Linux_7_STIG_V1R1_Manual-xccdf.xml'. The original text file `stig-debian-9.txt` is copy of `stig-rhel-7.txt`. How to easily update STIG for Debian textfile when the offcial RHEL 7 STIG changes is under discussion. #### Special Note: -Selinux related items(not match): +SELinux-related items (not matched): * SV-86663r1_rule * SV-86695r2_rule