Wazuh image improvements (#188)

wazuh/Dockerfile

@@ -1,55 +1,43 @@
 # Wazuh App Copyright (C) 2019 Wazuh Inc. (License GPLv2)
 FROM phusion/baseimage:latest
+
+# Arguments
 ARG FILEBEAT_VERSION=6.8.0
 ARG WAZUH_VERSION=3.9.2-1
 
+# Environment variables
 ENV API_USER="foo" \
     API_PASS="bar"
 
-# Set repositories.
+# Install packages
-RUN set -x && echo "deb https://packages.wazuh.com/3.x/apt/ stable main" | tee /etc/apt/sources.list.d/wazuh.list && \
+RUN set -x && \ 
+    echo "deb https://packages.wazuh.com/3.x/apt/ stable main" | tee /etc/apt/sources.list.d/wazuh.list && \
     curl -s https://packages.wazuh.com/key/GPG-KEY-WAZUH | apt-key add - && \
     curl --silent --location https://deb.nodesource.com/setup_8.x | bash - && \
     echo "postfix postfix/mailname string wazuh-manager" | debconf-set-selections && \
     echo "postfix postfix/main_mailer_type string 'Internet Site'" | debconf-set-selections && \
-   groupadd -g 1000 ossec && useradd -u 1000 -g 1000 -d /var/ossec ossec
+    groupadd -g 1000 ossec && \
-
+    useradd -u 1000 -g 1000 -d /var/ossec ossec && \
-RUN add-apt-repository universe && apt-get update && apt-get upgrade -y -o Dpkg::Options::="--force-confold" && \
+    add-apt-repository universe && \
-   apt-get --no-install-recommends --no-install-suggests -y install openssl postfix bsd-mailx python-boto python-pip  \
+    apt-get update && \
-   apt-transport-https vim expect nodejs python-cryptography mailutils libsasl2-modules wazuh-manager=${WAZUH_VERSION} \
+    apt-get upgrade -y -o Dpkg::Options::="--force-confold" && \
-   wazuh-api=${WAZUH_VERSION} && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* && rm -f \
+    apt-get --no-install-recommends --no-install-suggests -y install openssl apt-transport-https vim expect python-boto python-pip python-cryptography && \
-   /var/ossec/logs/alerts/*/*/* && rm -f /var/ossec/logs/archives/*/*/* && rm -f /var/ossec/logs/firewall/*/*/* && rm -f \
+    apt-get --no-install-recommends --no-install-suggests -y install postfix bsd-mailx mailutils libsasl2-2 ca-certificates libsasl2-modules && \
-   /var/ossec/logs/api/*/*/* && rm -f /var/ossec/logs/cluster/*/*/* && rm -f /var/ossec/logs/ossec/*/*/*
+    apt-get --no-install-recommends --no-install-suggests -y install wazuh-manager=${WAZUH_VERSION} && \
-
+    apt-get --no-install-recommends --no-install-suggests -y install nodejs wazuh-api=${WAZUH_VERSION} && \
-# Adding first run script and entrypoint
+    apt-get clean && \
-COPY config/data_dirs.env /data_dirs.env
+    rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* && \
-COPY config/init.bash /init.bash
+    rm -f /var/ossec/logs/alerts/*/*/* && \
-RUN mkdir /entrypoint-scripts
+    rm -f /var/ossec/logs/archives/*/*/* && \
-COPY config/entrypoint.sh /entrypoint.sh
+    rm -f /var/ossec/logs/firewall/*/*/* && \ 
-COPY config/00-wazuh.sh /entrypoint-scripts/00-wazuh.sh
+    rm -f /var/ossec/logs/api/*/*/* && \
-
+    rm -f /var/ossec/logs/cluster/*/*/* && \
-# Sync calls are due to https://github.com/docker/docker/issues/9547
+    rm -f /var/ossec/logs/ossec/*/*/* && \
-RUN chmod 755 /init.bash && \
+    rm /var/ossec/var/run/* && \
-    sync && /init.bash && \
-    sync && rm /init.bash && \
     curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-${FILEBEAT_VERSION}-amd64.deb && \
-    dpkg -i filebeat-${FILEBEAT_VERSION}-amd64.deb && rm -f filebeat-${FILEBEAT_VERSION}-amd64.deb && \
+    dpkg -i filebeat-${FILEBEAT_VERSION}-amd64.deb && rm -f filebeat-${FILEBEAT_VERSION}-amd64.deb
-    chmod 755 /entrypoint.sh && \
-    chmod 755 /entrypoint-scripts/00-wazuh.sh 
 
-COPY config/filebeat.yml /etc/filebeat/
+# Services
-RUN chmod go-w /etc/filebeat/filebeat.yml 
-
-# Setting volumes
-VOLUME ["/var/ossec/data"]
-VOLUME ["/etc/filebeat"]
-VOLUME ["/etc/postfix"]
-VOLUME ["/var/lib/filebeat"]
-
-# Services ports
-EXPOSE 55000/tcp 1514/udp 1515/tcp 514/udp 1516/tcp
-
-# Adding services
 RUN mkdir /etc/service/wazuh && \
     mkdir /etc/service/wazuh-api && \
     mkdir /etc/service/postfix && \
@@ -65,6 +53,44 @@ RUN chmod +x /etc/service/wazuh-api/run && \
     chmod +x /etc/service/postfix/run && \
     chmod +x /etc/service/filebeat/run 
 
+# Copy configuration files from repository
+COPY config/filebeat.yml /etc/filebeat/
+RUN chmod go-w /etc/filebeat/filebeat.yml 
+
+# Prepare permanent data
+# Sync calls are due to https://github.com/docker/docker/issues/9547
+COPY config/permanent_data.env /permanent_data.env
+COPY config/permanent_data.sh /permanent_data.sh
+RUN chmod 755 /permanent_data.sh && \
+    sync && \
+    /permanent_data.sh && \
+    sync && \
+    rm /permanent_data.sh 
+
+# Expose ports
+EXPOSE 55000/tcp 1514/udp 1515/tcp 514/udp 1516/tcp
+
+# Setting volumes
+# Once we declared a volume in the Dockerfile, changes made to that path will have no effect. In other words, any changes made
+# to the these paths from here to the end of the Dockerfile will not be taken into account when mounting the volume.
+VOLUME ["/var/ossec/api/configuration"]
+VOLUME ["/var/ossec/etc"]
+VOLUME ["/var/ossec/logs"]
+VOLUME ["/var/ossec/queue"]
+VOLUME ["/var/ossec/var/multigroups"]
+VOLUME ["/etc/filebeat"]
+VOLUME ["/etc/postfix"]
+VOLUME ["/var/lib/filebeat"]
+
+# Prepare entrypoint scripts
+# Entrypoint scripts must be added to the entrypoint-scripts directory
+RUN mkdir /entrypoint-scripts
+
+COPY config/entrypoint.sh /entrypoint.sh
+COPY config/00-wazuh.sh /entrypoint-scripts/00-wazuh.sh
+
+RUN chmod 755 /entrypoint.sh && \
+    chmod 755 /entrypoint-scripts/00-wazuh.sh
+
 # Run all services
 ENTRYPOINT ["/entrypoint.sh"]
-

wazuh/config/00-wazuh.sh

@@ -1,26 +1,18 @@
 #!/bin/bash
 # Wazuh App Copyright (C) 2019 Wazuh Inc. (License GPLv2)
 
-#
+# Variables
-# OSSEC container bootstrap. See the README for information of the environment
+source /permanent_data.env
-# variables expected by this script.
-#
-
-#
-
-#
-# Startup the services
-#
-
-source /data_dirs.env
-
-FIRST_TIME_INSTALLATION=false
 
 WAZUH_INSTALL_PATH=/var/ossec
-DATA_PATH=${WAZUH_INSTALL_PATH}/data
-
 WAZUH_CONFIG_MOUNT=/wazuh-config-mount
+AUTO_ENROLLMENT_ENABLED=${AUTO_ENROLLMENT_ENABLED:-true}
+API_GENERATE_CERTS=${API_GENERATE_CERTS:-true}
 
+
+##############################################################################
+# Aux functions
+##############################################################################
 print() {
   echo -e $1
 }
@@ -39,83 +31,117 @@ exec_cmd_stdout() {
   eval $1 2>&1 || error_and_exit "$1"
 }
 
+
+##############################################################################
+# Edit configuration
+##############################################################################
+
 edit_configuration() { # $1 -> setting,  $2 -> value
-    sed -i "s/^config.$1\s=.*/config.$1 = \"$2\";/g" "${DATA_PATH}/api/configuration/config.js" || error_and_exit "sed (editing configuration)"
+  sed -i "s/^config.$1\s=.*/config.$1 = \"$2\";/g" "${WAZUH_INSTALL_PATH}/api/configuration/config.js" || error_and_exit "sed (editing configuration)"
 }
 
-for ossecdir in "${DATA_DIRS[@]}"; do
+##############################################################################
-  if [ ! -e "${DATA_PATH}/${ossecdir}" ]
+# This function will attempt to mount every directory in PERMANENT_DATA 
-  then
+# into the respective path. 
-    print "Installing ${ossecdir}"
+# If the path is empty means permanent data volume is also empty, so a backup  
-    exec_cmd "mkdir -p $(dirname ${DATA_PATH}/${ossecdir})"
+# will be copied into it. Otherwise it will not be copied because there is  
-    exec_cmd "cp -pr /var/ossec/${ossecdir}-template ${DATA_PATH}/${ossecdir}"
+# already data inside the volume for the specified path.
-    FIRST_TIME_INSTALLATION=true
+##############################################################################
+
+mount_permanent_data() {
+  for permanent_dir in "${PERMANENT_DATA[@]}"; do
+    # Check if the path is not empty
+    if find ${permanent_dir} -mindepth 1 | read; then
+      print "The path ${permanent_dir} is already mounted"
+    else
+      print "Installing ${permanent_dir}"
+      exec_cmd "cp -a ${WAZUH_INSTALL_PATH}/data_tmp/permanent${permanent_dir}/. ${permanent_dir}"
     fi
   done
+}
 
-if [  -e ${WAZUH_INSTALL_PATH}/etc-template  ]
+##############################################################################
+# This function will replace from the permanent data volume every file 
+# contained in PERMANENT_DATA_EXCP
+# Some files as 'internal_options.conf' are saved as permanent data, but 
+# they must be updated to work properly if wazuh version is changed.
+##############################################################################
+
+apply_exclusion_data() {
+  for exclusion_file in "${PERMANENT_DATA_EXCP[@]}"; do
+    if [  -e ${WAZUH_INSTALL_PATH}/data_tmp/exclusion/${exclusion_file}  ]
     then
-    cp -p /var/ossec/etc-template/internal_options.conf /var/ossec/etc/internal_options.conf
+      print "Updating ${exclusion_file}"
+      exec_cmd "cp -p ${WAZUH_INSTALL_PATH}/data_tmp/exclusion/${exclusion_file} ${exclusion_file}"
     fi
-rm /var/ossec/queue/db/.template.db
+  done
+}
 
-touch ${DATA_PATH}/process_list
+##############################################################################
-chgrp ossec ${DATA_PATH}/process_list
+# This function will delete from the permanent data volume every file 
-chmod g+rw ${DATA_PATH}/process_list
+# contained in PERMANENT_DATA_DEL
+##############################################################################
 
-AUTO_ENROLLMENT_ENABLED=${AUTO_ENROLLMENT_ENABLED:-true}
+remove_data_files() {
-API_GENERATE_CERTS=${API_GENERATE_CERTS:-true}
+  for del_file in "${PERMANENT_DATA_DEL[@]}"; do
+    print "Removing ${del_file}"
+    exec_cmd "rm ${del_file}"
+  done
+}
 
-if [ $FIRST_TIME_INSTALLATION == true ]
+##############################################################################
-then
+# Create certificates: Manager
-  if [ $AUTO_ENROLLMENT_ENABLED == true ]
+##############################################################################
-  then
+
-    if [ ! -e ${DATA_PATH}/etc/sslmanager.key ]
+create_ossec_key_cert() {
-    then
   print "Creating ossec-authd key and cert"
-      exec_cmd "openssl genrsa -out ${DATA_PATH}/etc/sslmanager.key 4096"
+  exec_cmd "openssl genrsa -out ${WAZUH_INSTALL_PATH}/etc/sslmanager.key 4096"
-      exec_cmd "openssl req -new -x509 -key ${DATA_PATH}/etc/sslmanager.key -out ${DATA_PATH}/etc/sslmanager.cert -days 3650 -subj /CN=${HOSTNAME}/"
+  exec_cmd "openssl req -new -x509 -key ${WAZUH_INSTALL_PATH}/etc/sslmanager.key -out ${WAZUH_INSTALL_PATH}/etc/sslmanager.cert -days 3650 -subj /CN=${HOSTNAME}/"
-    fi
+}
-  fi
+
-  if [ $API_GENERATE_CERTS == true ]
+##############################################################################
-  then
+# Create certificates: API
-    if [ ! -e ${DATA_PATH}/api/configuration/ssl/server.crt ]
+##############################################################################
-    then
+
+create_api_key_cert() {
   print "Enabling Wazuh API HTTPS"
   edit_configuration "https" "yes"
   print "Create Wazuh API key and cert"
-      exec_cmd "openssl genrsa -out ${DATA_PATH}/api/configuration/ssl/server.key 4096"
+  exec_cmd "openssl genrsa -out ${WAZUH_INSTALL_PATH}/api/configuration/ssl/server.key 4096"
-      exec_cmd "openssl req -new -x509 -key ${DATA_PATH}/api/configuration/ssl/server.key -out ${DATA_PATH}/api/configuration/ssl/server.crt -days 3650 -subj /CN=${HOSTNAME}/"
+  exec_cmd "openssl req -new -x509 -key ${WAZUH_INSTALL_PATH}/api/configuration/ssl/server.key -out ${WAZUH_INSTALL_PATH}/api/configuration/ssl/server.crt -days 3650 -subj /CN=${HOSTNAME}/"
-    fi
+
-  fi
+  # Granting proper permissions 
-fi
+  chmod 400 ${WAZUH_INSTALL_PATH}/api/configuration/ssl/server.key
+  chmod 400 ${WAZUH_INSTALL_PATH}/api/configuration/ssl/server.crt
+}
 
 ##############################################################################
-# Copy all files from $WAZUH_CONFIG_MOUNT to $DATA_PATH and respect
+# Copy all files from $WAZUH_CONFIG_MOUNT to $WAZUH_INSTALL_PATH and respect
 # destination files permissions
 #
 # For example, to mount the file /var/ossec/data/etc/ossec.conf, mount it at
 # $WAZUH_CONFIG_MOUNT/etc/ossec.conf in your container and this code will
 # replace the ossec.conf file in /var/ossec/data/etc with yours.
 ##############################################################################
+
+mount_files() {
   if [ -e "$WAZUH_CONFIG_MOUNT" ]
   then
     print "Identified Wazuh configuration files to mount..."
-
+    exec_cmd_stdout "cp --verbose -r $WAZUH_CONFIG_MOUNT/* $WAZUH_INSTALL_PATH"
-  exec_cmd_stdout "cp --verbose -r $WAZUH_CONFIG_MOUNT/* $DATA_PATH"
   else
     print "No Wazuh configuration files to mount..."
   fi
+}
+
+##############################################################################
+# Stop OSSEC
+##############################################################################
 
 function ossec_shutdown(){
   ${WAZUH_INSTALL_PATH}/bin/ossec-control stop;
 }
 
-# Trap exit signals and do a proper shutdown
-trap "ossec_shutdown; exit" SIGINT SIGTERM
-
-chmod -R g+rw ${DATA_PATH}
-
 ##############################################################################
 # Interpret any passed arguments (via docker command to this entrypoint) as
 # paths or commands, and execute them. 
@@ -123,29 +149,87 @@ chmod -R g+rw ${DATA_PATH}
 # This can be useful for actions that need to be run before the services are
 # started, such as "/var/ossec/bin/ossec-control enable agentless".
 ##############################################################################
+
+docker_custom_args() {
   for CUSTOM_COMMAND in "$@"
   do
     echo "Executing command \`${CUSTOM_COMMAND}\`"
     exec_cmd_stdout "${CUSTOM_COMMAND}"
   done
+}
 
 ##############################################################################
 # Change Wazuh API user credentials.
 ##############################################################################
 
+change_api_user_credentials() {
   pushd /var/ossec/api/configuration/auth/
-
   echo "Change Wazuh API user credentials"
   change_user="node htpasswd -b -c user $API_USER $API_PASS"
   eval $change_user
-
   popd
-
+}
 
 ##############################################################################
 # Customize filebeat output ip
 ##############################################################################
+
+custom_filebeat_output_ip() {
   if [ "$FILEBEAT_OUTPUT" != "" ]; then
     sed -i "s/logstash:5000/$FILEBEAT_OUTPUT:5000/" /etc/filebeat/filebeat.yml
   fi
+}
 
+
+##############################################################################
+# Main function
+##############################################################################
+
+main() {
+  # Mount permanent data  (i.e. ossec.conf)
+  mount_permanent_data
+
+  # Restore files stored in permanent data that are not permanent  (i.e. internal_options.conf)
+  apply_exclusion_data
+
+  # Remove some files in permanent_data (i.e. .template.db)
+  remove_data_files
+
+  # Generate ossec-authd certs if AUTO_ENROLLMENT_ENABLED is true and does not exist
+  if [ $AUTO_ENROLLMENT_ENABLED == true ]
+  then
+    if [ ! -e ${WAZUH_INSTALL_PATH}/etc/sslmanager.key ]
+    then
+      create_ossec_key_cert
+    fi
+  fi
+
+  # Generate API certs if API_GENERATE_CERTS is true and does not exist
+  if [ $API_GENERATE_CERTS == true ]
+  then
+    if [ ! -e ${WAZUH_INSTALL_PATH}/api/configuration/ssl/server.crt ]
+    then
+      create_api_key_cert
+    fi
+  fi
+
+  # Mount selected files (WAZUH_CONFIG_MOUNT) to container
+  mount_files
+
+  # Trap exit signals and do a proper shutdown
+  trap "ossec_shutdown; exit" SIGINT SIGTERM
+
+  # Execute custom args
+  docker_custom_args
+
+  # Change API user credentials
+  change_api_user_credentials
+
+  # Update filebeat configuration
+  custom_filebeat_output_ip
+
+  # Delete temporary data folder
+  rm -rf ${WAZUH_INSTALL_PATH}/data_tmp
+}
+
+main

wazuh/config/data_dirs.env

@@ -1,15 +0,0 @@
-i=0
-DATA_DIRS[((i++))]="api/configuration"
-DATA_DIRS[((i++))]="etc"
-DATA_DIRS[((i++))]="logs"
-DATA_DIRS[((i++))]="queue/db"
-DATA_DIRS[((i++))]="queue/rootcheck"
-DATA_DIRS[((i++))]="queue/agent-groups"
-DATA_DIRS[((i++))]="queue/agent-info"
-DATA_DIRS[((i++))]="queue/agents-timestamp"
-DATA_DIRS[((i++))]="queue/agentless"
-DATA_DIRS[((i++))]="queue/cluster"
-DATA_DIRS[((i++))]="queue/rids"
-DATA_DIRS[((i++))]="queue/fts"
-DATA_DIRS[((i++))]="var/multigroups"
-export DATA_DIRS

wazuh/config/entrypoint.sh

@@ -4,7 +4,6 @@
 # It will run every .sh script located in entrypoint-scripts folder in lexicographical order
 for script in `ls /entrypoint-scripts/*.sh | sort -n`; do
   bash "$script"
-
 done
 
 ##############################################################################

wazuh/config/init.bash

@@ -1,13 +0,0 @@
-#!/bin/bash
-# Wazuh App Copyright (C) 2019 Wazuh Inc. (License GPLv2)
-
-#
-# Initialize the custom data directory layout
-#
-source /data_dirs.env
-
-cd /var/ossec
-for ossecdir in "${DATA_DIRS[@]}"; do
-  mv ${ossecdir} ${ossecdir}-template
-  ln -s $(realpath --relative-to=$(dirname ${ossecdir}) data)/${ossecdir} ${ossecdir}
-done

wazuh/config/permanent_data.env

@@ -0,0 +1,20 @@
+# Permanent data mounted in volumes
+i=0
+PERMANENT_DATA[((i++))]="/var/ossec/api/configuration"
+PERMANENT_DATA[((i++))]="/var/ossec/etc"
+PERMANENT_DATA[((i++))]="/var/ossec/logs"
+PERMANENT_DATA[((i++))]="/var/ossec/queue"
+PERMANENT_DATA[((i++))]="/var/ossec/var/multigroups"
+PERMANENT_DATA[((i++))]="/etc/filebeat"
+PERMANENT_DATA[((i++))]="/etc/postfix"
+export PERMANENT_DATA
+
+# Files mounted in a volume that should not be permanent
+i=0
+PERMANENT_DATA_EXCP[((i++))]="/var/ossec/etc/internal_options.conf"
+export PERMANENT_DATA_EXCP
+
+# Files mounted in a volume that should be deleted 
+i=0
+PERMANENT_DATA_DEL[((i++))]="/var/ossec/queue/db/.template.db"
+export PERMANENT_DATA_DEL

wazuh/config/permanent_data.sh

@@ -0,0 +1,40 @@
+#!/bin/bash
+# Wazuh App Copyright (C) 2019 Wazuh Inc. (License GPLv2)
+
+# Variables
+source /permanent_data.env
+
+WAZUH_INSTALL_PATH=/var/ossec
+DATA_TMP_PATH=${WAZUH_INSTALL_PATH}/data_tmp
+mkdir ${DATA_TMP_PATH}
+
+# Move exclusion files to EXCLUSION_PATH
+EXCLUSION_PATH=${DATA_TMP_PATH}/exclusion
+mkdir ${EXCLUSION_PATH}
+
+for exclusion_file in "${PERMANENT_DATA_EXCP[@]}"; do
+  # Create the directory for the exclusion file if it does not exist
+  if [ ! -e ${EXCLUSION_PATH}/${exclusion_file}  ]
+  then
+    DIR=$(dirname "${exclusion_file}")
+    mkdir -p ${EXCLUSION_PATH}/${DIR}
+  fi
+
+  mv ${exclusion_file} ${EXCLUSION_PATH}/${exclusion_file}
+done
+
+# Move permanent files to PERMANENT_PATH
+PERMANENT_PATH=${DATA_TMP_PATH}/permanent
+mkdir ${PERMANENT_PATH}
+
+for permanent_dir in "${PERMANENT_DATA[@]}"; do
+  # Create the directory for the permanent file if it does not exist
+  if [ ! -e ${PERMANENT_PATH}${permanent_dir}  ]
+  then
+    DIR=$(dirname "${permanent_dir}")
+    mkdir -p ${PERMANENT_PATH}${DIR}
+  fi
+  
+  mv ${permanent_dir} ${PERMANENT_PATH}${permanent_dir}
+
+done

wazuh/config/wazuh-api.runit.service

@@ -1,4 +1,4 @@
 #!/bin/sh
 service wazuh-api start
-tail -f /var/ossec/data/logs/api.log
+tail -f /var/ossec/logs/api.log
 

wazuh/config/wazuh.runit.service

@@ -1,4 +1,4 @@
 #!/bin/sh
 service wazuh-manager start
-tail -f /var/ossec/data/logs/ossec.log
+tail -f /var/ossec/logs/ossec.log