Skip to content

Commit

Permalink
fix: update Readme to clarify project usage
Browse files Browse the repository at this point in the history
fixes: #219
  • Loading branch information
ThibaultDewailly committed Dec 26, 2023
1 parent 19f59f3 commit 912f8eb
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@
Modular Debian 10/11/12 security hardening scripts based on [cisecurity.org](https://www.cisecurity.org)
recommendations. We use it at [OVHcloud](https://www.ovhcloud.com) to harden our PCI-DSS infrastructure.

NB : Although Debian 12 CIS Hardening guide is still in development, we do use this set of scripts
in production at OVHcloud.

```console
$ bin/hardening.sh --audit-all
[...]
Expand Down Expand Up @@ -243,6 +246,19 @@ built a secure environment. While we use it at OVHcloud to harden our PCI-DSS co
infrastructure, we can not guarantee that it will work for you. It will not
magically secure any random host.

A word about numbering, implementation and sustainability over time of this repository:
This project is born with the Debian 7 distribution in 2016. Over time, CIS Benchmark PDF
has evolved, changing it's numbering, deleting obsolete checks.
In order to keep retro-compatiblity with the last maintained Debian, the numbering
has not been changed along witrh the PDF, because the configuration script are named after it.
Changin the numbering might break automation for people using it for years, and handling
this issue without breaking anything would require a huge refactoring.
As a consequence, please do not worry about numbering, the checks are there,
but the numbering accross PDFs might differ.
Please also note that all the check might not be implemented in this set of scripts.
We did choose the most relevant to us, do not hesitate to make a Pull Request in order
to add the missing script you might find.

Additionally, quoting the License:

> THIS SOFTWARE IS PROVIDED BY OVH SAS AND CONTRIBUTORS ``AS IS'' AND ANY
Expand All @@ -256,6 +272,7 @@ Additionally, quoting the License:
> (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
> SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

## :satellite: Reference

- **Center for Internet Security**: https://www.cisecurity.org/
Expand Down

0 comments on commit 912f8eb

Please sign in to comment.