Skip to content

Commit 40f03a3

Browse files
committed
Update comments and readonly properties
1 parent 8326d72 commit 40f03a3

3 files changed

Lines changed: 15 additions & 26 deletions

File tree

auditing/Lynis Installer/lynis-installer.bash

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
#!/bin/bash
22
#
3-
# Name: lynis-installer.bash
4-
#
5-
# Description:
6-
# This script downloads a security auditing tool called Lynis, designed to scan a
7-
# system and identify security issues, and provides recommendations on how to better
8-
# secure it. Lynis, unless an error is encountered, will always be downloaded to the
9-
# user's root directory (/home/USERNAME/).
3+
# This script downloads a security auditing tool called Lynis. It is designed to scan a
4+
# system, identify security issues, and provide recommendations on how to better secure
5+
# it. Unless an error is encountered, Lynis will always be downloaded to the current
6+
# user's root directory (`/home/USERNAME/`).
107
#
118
# Version: v1.0.7
129
# License: MIT License

hardening/Root Locker/root-locker.bash

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
#!/bin/bash
22
#
3-
# Name: root-locker.bash
4-
#
5-
# Description:
6-
# This script locks the root account, preventing users from direct logins as root.
3+
# This script locks the root account, preventing users from directly logging in as root.
74
#
85
# Note:
96
# Locking the root account doesn't prevent users from using something like `sudo su`

hardening/SSHD Hardening/harden-sshd.bash

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
11
#!/bin/bash
22
#
3-
# Name: harden-sshd.bash
4-
#
5-
# Description:
6-
# This script hardens the sshd-server, by modifying it's configuration file
7-
# (sshd_config).
3+
# This script hardens the ssh server by modifying its configuration file, 'sshd_config'.
84
#
95
# Note:
10-
# This configures sshd_config to the recommendations of the security auditing tool
11-
# knonw as Lynis (https://github.com/CISOfy/lynis).
6+
# These configurations align with the recommendations of the security auditing tool
7+
# known as Lynis (https://github.com/CISOfy/lynis).
128
#
139
# Version: v2.0.0
1410
# License: MIT License
@@ -31,11 +27,11 @@ C_NC="$(printf '\033[0m')"
3127
readonly C_GREEN C_CYAN C_RED C_NC
3228

3329
## Short-hand colorized messages.
34-
C_SUCCESS="${C_GREEN}==>${C_NC} "
35-
C_WARNING="${C_YELLOW}==>${C_NC} "
36-
C_ERROR="${C_RED}ERROR:${C_NC} "
37-
C_INFO="${C_BLUE}==>${C_NC} "
38-
C_NOTE="${C_CYAN}==>${C_NC} "
30+
readonly C_SUCCESS="${C_GREEN}==>${C_NC} "
31+
readonly C_WARNING="${C_YELLOW}==>${C_NC} "
32+
readonly C_ERROR="${C_RED}ERROR:${C_NC} "
33+
readonly C_INFO="${C_BLUE}==>${C_NC} "
34+
readonly C_NOTE="${C_CYAN}==>${C_NC} "
3935

4036
# Associative array containing the configuration settings for sshd_config.
4137
declare -A C_SSHD_CONFIG=(
@@ -83,10 +79,9 @@ readonly C_SSHD_CONFIG
8379

8480

8581
####
86-
# Description:
87-
# Cleanly exit the script.
82+
# Cleanly exit the script.
8883
#
89-
# Arguments:
84+
# PARAMETERS:
9085
# - $1: exit_code (Required)
9186
# - The exit code to exit the script with.
9287
clean_exit() {

0 commit comments

Comments
 (0)