Skip to content

Commit 5ac50aa

Browse files
Merge pull request #31 from StrangeRanger/dev
Refine README documentation
2 parents 5b05c02 + 7f53ead commit 5ac50aa

5 files changed

Lines changed: 33 additions & 16 deletions

File tree

auditing/Lynis Installer/README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,29 @@ Downloads [Lynis](https://github.com/CISOfy/lynis), a security auditing tool for
1414

1515
## Usage
1616

17-
Run the installer from the repository root:
17+
From the repository root:
1818

1919
```bash
2020
./auditing/Lynis\ Installer/lynis-installer.bash
2121
```
2222

23+
OR from the script directory:
24+
25+
```bash
26+
./lynis-installer.bash
27+
```
28+
2329
## After Installation
2430

2531
To run a Lynis system audit:
2632

2733
```bash
2834
cd ~/lynis
35+
clear
2936
sudo ./lynis audit system
3037
```
3138

32-
Review the Lynis output before applying any hardening changes. Lynis findings are recommendations, not a replacement for understanding the system's role and access requirements.
39+
Before applying hardening changes, review the Lynis output carefully. Treat its findings as recommendations, not as a replacement for understanding your system’s security posture.
3340

3441
## Tested On
3542

hardening/Nginx WAF/README.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,11 @@
55
66
Installs and configures ModSecurity with the OWASP Core Rule Set for Nginx.
77

8-
This script builds software from source, installs packages, writes Nginx configuration, enables ModSecurity, tests the Nginx configuration, and restarts Nginx.
9-
108
## Requirements
119

1210
- Bash 4.0 or newer
1311
- Root privileges
14-
- Nginx installed and available in `PATH`
12+
- Nginx 1.24.0 or newer, installed and available in `PATH`
1513
- A Debian/Ubuntu-style system with `apt-get` and `dpkg`
1614
- Internet access
1715

@@ -79,7 +77,6 @@ The script also creates or reuses build directories in the current working direc
7977

8078
## Safety Notes
8179

82-
- Run this in a test environment before using it on a production web server.
8380
- Review local Nginx packaging conventions before running it on systems with custom Nginx builds.
8481
- The OWASP Core Rule Set can block legitimate traffic until tuned for the application.
8582
- Existing local changes in reused `ModSecurity`, `ModSecurity-nginx`, or CRS clone directories may affect the run.

hardening/Root Locker/README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Root Locker
22

3-
Locks the root account to prevent direct root login.
3+
Locks the root account password to prevent password-based root logins.
44

55
> [!NOTE]
66
> This does not remove administrative access for users who already have valid sudo privileges. Users may still be able to gain a root shell through tools such as `sudo su` or `sudo -i`.
@@ -13,16 +13,17 @@ Locks the root account to prevent direct root login.
1313

1414
## Usage
1515

16-
Run the script from the repository root:
16+
From the repository root:
1717

1818
```bash
1919
sudo ./hardening/Root\ Locker/root-locker.bash
2020
```
2121

22-
## Safety Notes
22+
OR from the script directory:
2323

24-
- Confirm that at least one non-root user has working sudo access before running this script.
25-
- Do not run this on a system where direct root login is the only available administrative access path.
24+
```bash
25+
sudo ./root-locker.bash
26+
```
2627

2728
## Verify
2829

@@ -32,6 +33,8 @@ Check the root account state with:
3233
sudo passwd -S root
3334
```
3435

36+
The second field in the output shows the account status. `L` means the password is locked.
37+
3538
You can also confirm sudo access from a non-root administrative account:
3639

3740
```bash

hardening/SSHD Hardening/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Hardens the OpenSSH server configuration using settings aligned with Lynis recommendations.
44

5-
> [!NOTE]
5+
> [!CAUTION]
66
> This script modifies the system SSH daemon configuration. Treat it as a high-risk change on remote systems because an invalid or overly restrictive SSH configuration can lock you out.
77
88
## Requirements
@@ -15,12 +15,18 @@ Hardens the OpenSSH server configuration using settings aligned with Lynis recom
1515

1616
## Usage
1717

18-
Run the script from the repository root:
18+
From the repository root:
1919

2020
```bash
2121
sudo ./hardening/SSHD\ Hardening/harden-sshd.bash
2222
```
2323

24+
OR from the script directory:
25+
26+
```bash
27+
sudo ./harden-sshd.bash
28+
```
29+
2430
## Changes Made
2531

2632
The script updates supported settings in `/etc/ssh/sshd_config` when those settings are already present in the file:
@@ -59,7 +65,6 @@ If `/etc/ssh/sshd_config.bak` already exists, the script asks whether to overwri
5965
## Safety Notes
6066

6167
- Keep your current SSH session open while testing a new login.
62-
- Make sure you have console, provider, or other recovery access before running this on a remote system.
6368
- Review whether agent forwarding, TCP forwarding, X11 forwarding, and session limits are compatible with your use case.
6469

6570
## Verify

hardening/UFW Cloudflare/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,18 @@ Use this script for hosts where public web traffic should reach the origin serve
1515

1616
## Usage
1717

18-
Run the script from the repository root:
18+
From the repository root:
1919

2020
```bash
2121
sudo ./hardening/UFW\ Cloudflare/ufw-cloudflare.bash
2222
```
2323

24+
OR from the script directory:
25+
26+
```bash
27+
sudo ./ufw-cloudflare.bash
28+
```
29+
2430
## Execution Summary
2531

2632
- Reads existing UFW rules marked with the `Cloudflare IP` comment.
@@ -50,7 +56,6 @@ The temporary backup is removed during normal cleanup.
5056

5157
## Safety Notes
5258

53-
- Make sure you have recovery access before running it on a remote system.
5459
- Direct origin access may remain possible through other open ports or non-UFW firewall layers.
5560

5661
## Verify

0 commit comments

Comments
 (0)