HIRS/package/scripts/aca/aca_check_setup.sh

308 lines
10 KiB
Bash
Raw Normal View History

2023-08-23 20:30:06 +00:00
#!/bin/bash
############################################################################################
# Checks the setup for the ACA:
# takes a -v option to provide verbose output
2023-08-23 20:30:06 +00:00
############################################################################################
SCRIPT_DIR=$( dirname -- "$( readlink -f -- "$0"; )"; )
LOG_FILE=/dev/null
CERT_PATH="/etc/hirs/certificates/HIRS/"
RSA_PATH=rsa_3k_sha384_certs
ECC_PATH=ecc_512_sha384_certs
RSA_HIRS_ROOT="HIRS_root_ca_rsa_3k_sha384.pem"
RSA_HIRS_INTERMEDIATE="HIRS_intermediate_ca_rsa_3k_sha384.pem"
RSA_HIRS_CA1="HIRS_leaf_ca1_rsa_3k_sha384.pem"
RSA_HIRS_CA2="HIRS_leaf_ca2_rsa_3k_sha384.pem"
RSA_HIRS_CA3="HIRS_leaf_ca3_rsa_3k_sha384.pem"
RSA_TRUST_STORE="HIRS_rsa_3k_sha384_Cert_Chain.pem"
RSA_RIM_SIGNER="HIRS_rim_signer_rsa_3k_sha384.pem"
RSA_DB_CLIENT_CERT="HIRS_db_client_rsa_3k_sha384.pem"
RSA_DN_SRV_CERT="HIRS_db_srv_rsa_3k_sha384.pem"
RSA_WEB_TLS_CERT="HIRS_aca_tls_rsa_3k_sha384.pem"
ECC_HIRS_ROOT="HIRS_root_ca_ecc_512_sha384.pem"
ECC_HIRS_INTERMEDIATE="HIRS_intermediate_ca_ecc_512_sha384.pem"
ECC_HIRS_CA1="HIRS_leaf_ca1_ecc_512_sha384.pem"
ECC_HIRS_CA2="HIRS_leaf_ca2_ecc_512_sha384.pem"
ECC_HIRS_CA3="HIRS_leaf_ca3_ecc_512_sha384.pem"
ECC_TRUST_STORE="HIRS_ecc_512_sha384_Cert_Chain.pem"
ECC_RIM_SIGNER="HIRS_rim_signer_ecc_512_sha384.pem"
ECC_DB_CLIENT_CERT="HIRS_db_client_ecc_512_sha384.pem"
ECC_DN_SRV_CERT="HIRS_db_srv_ecc_512_sha384.pem"
ECC_WEB_TLS_CERT="HIRS_aca_tls_ecc_512_sha384.pem"
DB_SRV_CONF="/etc/my.cnf.d/mariadb-server.cnf"
DB_CLIENT_CONF="/etc/my.cnf.d/client.cnf"
ALL_CHECKS_PASSED=true
2023-08-28 20:18:08 +00:00
ALL_CERTS_PASSED=true
2023-10-05 20:05:21 +00:00
2023-09-18 20:48:29 +00:00
source $SCRIPT_DIR/../db/mysql_util.sh
2023-10-05 20:05:21 +00:00
source /etc/os-release
# Setup distro specifc paths and variables
if [ $ID = "ubuntu" ]; then
DB_SRV_CONF="/etc/mysql/mariadb.conf.d/50-server.cnf"
DB_CLIENT_CONF="/etc/mysql/mariadb.conf.d/50-client.cnf"
fi
2023-08-23 20:30:06 +00:00
# Check for Admin privileges
if [ "$EUID" -ne 0 ]; then
echo "This script requires root. Please run as root"
exit 1
fi
2023-08-28 20:18:08 +00:00
# Argument handling
while [[ $# -gt 0 ]]; do
case $1 in
-v|--verbose)
ARG_VERBOSE=YES
echo "verbose parameters"
shift # past argument
;;
-*|--*)
echo "Unknown option $1"
exit 1
;;
*)
echo "Unknown argument $1"
exit 1
shift # past argument
;;
esac
done
2023-09-18 20:48:29 +00:00
echo "Checking HIRS ACA Setup on this device..."
# Check if aca setup was performed
# Check is RPM was installed via RPM package
2023-10-05 20:05:21 +00:00
if [ $ID = "rhel" ]; then
echo "RHEL distro detected"
rpm -q --quiet HIRS_AttestationCA
elif [ $ID = 'ubuntu' ]; then
echo "Ubuntu distro detected"
2023-10-11 19:56:36 +00:00
dpkg -l "hirs-attestationca" > /dev/null
2023-10-05 20:05:21 +00:00
else
echo "Unsupported OS Distro encountered"
fi
if [ $? -eq 0 ]; then
2023-10-05 20:05:21 +00:00
echo "HIRS ACA was installed via an OS package on this device"
if [[ $(cat /etc/crontab | grep -c hirs/aca) > 0 ]]; then
echo " HIRS ACA is set to start on boot via crontab file"
else
echo " HIRS ACA is NOT set to start on boot via crontab file"
fi
else
2023-10-05 20:05:21 +00:00
echo "HIRS ACA was NOT installed via an OS package on this device"
fi
2023-09-18 20:48:29 +00:00
# Check install setup pki files
if [ ! -d $CERT_PATH ]; then
2023-09-18 20:48:29 +00:00
check_db_cleared
echo " $CERT_PATH directory does not exist."
echo " Exiting..."
echo "Please run aca_setup.sh and try again"
exit 1;
fi
2023-08-23 20:30:06 +00:00
source /etc/hirs/aca/aca.properties;
2023-09-18 20:48:29 +00:00
2023-08-23 20:30:06 +00:00
check_pwds () {
PRESENT=true
echo "Checking if ACA passwords are present..."
2023-08-23 20:30:06 +00:00
if [ -z $hirs_pki_password ]; then
echo "ACA pki password not set"
2023-08-23 20:30:06 +00:00
PRESENT=false
fi
if [ -z $hirs_db_username ]; then
echo "hirs db username not set"
PRESENT=false
fi
if [ -z $hirs_db_password ]; then
echo "hirs db user password not set"
2023-08-23 20:30:06 +00:00
PRESENT=false
fi
if [ $PRESENT ]; then
echo " ACA passwords were found"
2023-08-23 20:30:06 +00:00
else
echo " ERROR finding ACA passwords"
2023-08-23 20:30:06 +00:00
ALL_CHECKS_PASSED=false
fi
}
2023-08-28 20:18:08 +00:00
check_mysql_setup () {
# make sure mysql is running and restart if its not...
check_mysql
2023-08-23 20:30:06 +00:00
# Check DB server/client TLS setup.
2023-10-05 20:05:21 +00:00
if [[ $(cat "$DB_SRV_CONF" | grep -c "HIRS") < 1 ]]; then
2023-08-28 20:18:08 +00:00
echo " Mysql server ($DB_SRV_CONF) is NOT configured for Server Side TLS"
2023-08-23 20:30:06 +00:00
ALL_CHECKS_PASSED=false
else
2023-08-28 20:18:08 +00:00
echo " Mysql server ($DB_SRV_CONF) is configured for Server Side TLS"
2023-08-23 20:30:06 +00:00
fi
2023-10-05 20:05:21 +00:00
if [[ $(cat "$DB_CLIENT_CONF" | grep -c "HIRS") < 1 ]]; then
2023-08-28 20:18:08 +00:00
echo " Mysql client ($DB_CLIENT_CONF)is NOT configured for command line use of TLS without provding key/cert ino the commandline"
2023-08-23 20:30:06 +00:00
ALL_CHECKS_PASSED=false
else
2023-08-28 20:18:08 +00:00
echo " Mysql client ($DB_CLIENT_CONF) is configured for command line use of TLS"
2023-08-23 20:30:06 +00:00
fi
if [ ! -z $mysql_admin_password ]; then
2023-08-28 20:18:08 +00:00
if [ ! -z "${ARG_VERBOSE}" ]; then
echo "Mysql status:"
mysql -u root --password=$mysql_admin_password -e "STATUS;"
2023-08-23 20:30:06 +00:00
echo "Listing mysql users:"
mysql -u root --password=$mysql_admin_password -e "Select user from mysql.user;"
echo "Listing all databses:"
mysql -u root --password=$mysql_admin_password -e "show databases;"
2023-08-28 20:18:08 +00:00
fi
2023-08-23 20:30:06 +00:00
fi
}
2023-08-28 20:18:08 +00:00
check_cert () {
TRUST_STORE=$1
CERT=$2
RESULT=$(openssl verify -CAfile "$TRUST_STORE" $CERT)
if [ $? -ne 0 ]; then
ALL_CHECKS_PASSED=false
ALL_CERTS_PASSED=false
fi
if [ ! -z "${ARG_VERBOSE}" ]; then
2023-08-28 20:18:08 +00:00
echo " "$RESULT
fi
2023-08-28 20:18:08 +00:00
}
2023-08-23 20:30:06 +00:00
check_pki () {
echo "Checking ACA PKI certificates..."
2023-08-23 20:30:06 +00:00
if [ ! -d "/etc/hirs/certificates" ]; then
echo "/etc/hirs/certificates doesn't exists, was aca_setup.sh run ? /
Skipping PKI Checks."
fi
2023-08-28 20:18:08 +00:00
pushd $CERT_PATH$RSA_PATH > /dev/null
check_cert $RSA_TRUST_STORE $RSA_HIRS_ROOT
check_cert $RSA_TRUST_STORE $RSA_HIRS_INTERMEDIATE
check_cert $RSA_TRUST_STORE $RSA_HIRS_CA1
check_cert $RSA_TRUST_STORE $RSA_HIRS_CA2
check_cert $RSA_TRUST_STORE $RSA_HIRS_CA3
check_cert $RSA_TRUST_STORE $RSA_RIM_SIGNER
check_cert $RSA_TRUST_STORE $RSA_DN_SRV_CERT
check_cert $RSA_TRUST_STORE $RSA_DB_CLIENT_CERT
check_cert $RSA_TRUST_STORE $RSA_WEB_TLS_CERT
2023-08-23 20:30:06 +00:00
popd > /dev/null
2023-08-28 20:18:08 +00:00
pushd $CERT_PATH$ECC_PATH > /dev/null
check_cert $ECC_TRUST_STORE $ECC_HIRS_ROOT
check_cert $ECC_TRUST_STORE $ECC_HIRS_INTERMEDIATE
check_cert $ECC_TRUST_STORE $ECC_HIRS_CA1
check_cert $ECC_TRUST_STORE $ECC_HIRS_CA2
check_cert $ECC_TRUST_STORE $ECC_HIRS_CA3
check_cert $ECC_TRUST_STORE $ECC_RIM_SIGNER
check_cert $ECC_TRUST_STORE $ECC_DN_SRV_CERT
check_cert $ECC_TRUST_STORE $ECC_DB_CLIENT_CERT
check_cert $ECC_TRUST_STORE $ECC_WEB_TLS_CERT
2023-08-23 20:30:06 +00:00
popd > /dev/null
2023-08-28 20:18:08 +00:00
if [ -z "${ARG_VERBOSE}" ]; then
if [ $ALL_CERTS_PASSED == true ]; then
echo " All RSA and ECC certificates under $CERT_PATH are valid"
else
echo " There were error in the certificates under $CERT_PATH"
fi
keytool -list -keystore /etc/hirs/certificates/HIRS/TrustStore.jks -storepass $hirs_pki_password | grep hirs | sed -e 's/^/ /' > /dev/null
else #verbose
echo " Checking KeyStore, Keystore aliases, and pki password"
echo " Keystore alias list:"
keytool -list -keystore /etc/hirs/certificates/HIRS/TrustStore.jks -storepass $hirs_pki_password | grep hirs | sed -e 's/^/ /'
fi
2023-08-23 20:30:06 +00:00
if [ $? -eq 0 ]; then
2023-08-28 20:18:08 +00:00
echo " JKS Trust Store File (/etc/hirs/certificates/HIRS/TrustStore.jks) is correct: HIRS pki password is correct"
2023-08-23 20:30:06 +00:00
else
2023-08-28 20:18:08 +00:00
echo " Error with JKS Trust Store: HIRS pki password is NOT correct"
2023-08-23 20:30:06 +00:00
ALL_CHECKS_PASSED=false
fi
}
check_db () {
echo "Checking DB server TLS configuration..."
2023-08-28 20:18:08 +00:00
RESULT=$(mysql -u root --password=$mysql_admin_password -e "SHOW VARIABLES LIKE '%have_ssl%'" | grep -o YES )
2023-08-23 20:30:06 +00:00
if [ "$RESULT" == "YES" ]; then
2023-08-28 20:18:08 +00:00
echo " Mysql Server side TLS is enabled:"
2023-08-23 20:30:06 +00:00
else
2023-08-28 20:18:08 +00:00
echo " Mysql Sever side TLS is NOT enabled:"
2023-08-23 20:30:06 +00:00
ALL_CHECKS_PASSED=false
fi
2023-08-28 20:18:08 +00:00
2023-08-23 20:30:06 +00:00
RESULT=$(mysqlshow --user=hirs_db --password=$hirs_db_password hirs_db| grep -o hirs_db)
if [ "$RESULT" == "hirs_db" ]; then
echo " The hirs_db database is visable by the hirs_db user"
else
echo " The hirs_db database is NOT visable by the hirs_db user"
ALL_CHECKS_PASSED=false
fi
2023-08-28 20:18:08 +00:00
if [ ! -z "${ARG_VERBOSE}" ]; then
echo " Show hirs_db user config using hirs_db password"
mysql -u hirs_db --password=$hirs_db_password -e "SHOW CREATE USER 'hirs_db'@'localhost';" \
--ssl-ca=/etc/hirs/certificates/HIRS/rsa_3k_sha384_certs/HIRS_rsa_3k_sha384_Cert_Chain.pem \
--ssl-cert=/etc/hirs/certificates/HIRS/rsa_3k_sha384_certs/HIRS_db_client_rsa_3k_sha384.pem \
--ssl-key=/etc/hirs/certificates/HIRS/rsa_3k_sha384_certs/HIRS_db_client_rsa_3k_sha384.key
echo "Mysql TLS configuration"
mysql -u root --password=$mysql_admin_password -e "SHOW VARIABLES LIKE '%ssl%'"
echo "hirs_db user database access:"
mysql -u hirs_db --password=$hirs_db_password -e "SHOW DATABASES;";
echo "Privileges for the hirs_db user:"
mysql -u hirs_db --password=$hirs_db_password -e "SHOW GRANTS FOR 'hirs_db'@'localhost'"
2023-10-05 20:05:21 +00:00
echo "MYSQL Log:"
mysql -u root --password=$mysql_admin_password -e "SHOW GLOBAL VARIABLES LIKE 'log_error'"
2023-08-28 20:18:08 +00:00
fi
}
# Check selinux status and files that require specific contexts
check_selinux () {
2023-10-05 20:05:21 +00:00
if [ $ID = "ubuntu" ]; then
echo "Skipping selinux check on ubuntu"
return
fi
2023-08-28 20:18:08 +00:00
SELINUXSTATUS=$(getenforce)
DB_SRV_CONTEXT=$(ls -Z $DB_SRV_CONF)
DB_CLIENT_CONTEXT=$(ls -Z $DB_CLIENT_CONF)
echo "Checking device selinux status..."
2023-08-28 20:18:08 +00:00
if [[ "$SELINUXSTATUS" == *"Enforcing"* ]]; then
echo " Selinux is in Enforcing mode."
2023-08-28 20:18:08 +00:00
if [[ "$DB_SRV_CONTEXT" == *"mysqld_etc_t"* && "$DB_CLIENT_CONTEXT" == *"mysqld_etc_t"* ]]; then
echo " Selinux status is $SELINUXSTATUS and both $DB_SRV_CONF and $DB_CLIENT_CONF contexts are correct"
2023-08-28 20:18:08 +00:00
elif [[ "$DB_CLIENT_CONTEXT" == *"mysqld_etc_t"* ]]; then
echo " Selinux status is $SELINUXSTATUS and $DB_CLIENT_CONF context is incorrect: $DB_CLIENT_CONTEXT"
2023-08-28 20:18:08 +00:00
ALL_CHECKS_PASSED=false
else
echo " Selinux status is $SELINUXSTATUS and $DB_SRV_CONF context is incorrect: $DB_SRV_CONTEXT"
2023-08-28 20:18:08 +00:00
ALL_CHECKS_PASSED=false
fi
else
echo " Selinux is in NOT in Enforcing mode."
2023-08-28 20:18:08 +00:00
fi
2023-08-23 20:30:06 +00:00
}
check_fips () {
echo "Checking FIPS mode on this device..."
echo " "$(sysctl -a | grep crypto.fips_enabled)
}
# Run Checks
2023-09-18 20:48:29 +00:00
check_for_container -p
2023-08-23 20:30:06 +00:00
check_pwds
check_pki
check_mysql_setup
2023-08-23 20:30:06 +00:00
check_db
2023-08-28 20:18:08 +00:00
check_selinux
check_fips
2023-08-23 20:30:06 +00:00
if [ $ALL_CHECKS_PASSED = true ]; then
echo "ACA setup checks passed!"
else
echo "ACA setup checks failed."
2023-10-05 20:05:21 +00:00
fi