Merge branch 'jenkins-build-15' into 'master'

Auto-merge for build 15

See merge request puppet/clamav_cd!12

doc/puppet_classes/clamav_cd_3A_3Amain_3A_3Aconfig.html

@@ -140,10 +140,10 @@ class clamav_cd::main::config (
 
   # create a cron job to run a daily scan
   cron { 'clamscan':
-    command => '/bin/clamscan -r / >> /var/log/clamav/daily-scan.log',
+    command => $cv_shell_script,
-    user    => 'root',
+    user    => $cv_cron_user,
-    hour    => 2,
+    hour    => $cv_cron_hour,
-    minute  => 0,
+    minute  => $cv_cron_minute,
   }
 }</pre>
       </td>

doc/puppet_classes/clamav_cd_3A_3Amain_3A_3Afiles.html

@@ -145,7 +145,20 @@
 47
 48
 49
-50</pre>
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63</pre>
       </td>
       <td>
         <pre class="code"><span class="info file"># File 'manifests/main/files.pp', line 6</span>
@@ -194,6 +207,19 @@ class clamav_cd::main::files (
     seluser  =&gt; system_u,
     content  =&gt; template($cv_freshclam_svc_erb),
   }
+
+  # shell script for scanning and alerting
+  file { $cv_shell_script  :
+    ensure   =&gt; file,
+    owner    =&gt; &#39;root&#39;,
+    group    =&gt; &#39;root&#39;,
+    mode     =&gt; &#39;0750&#39;,
+    selrange =&gt; s0,
+    selrole  =&gt; object_r,
+    seltype  =&gt; etc_t,
+    seluser  =&gt; system_u,
+    content  =&gt; template($cv_shell_script_erb),
+  }
 }</pre>
       </td>
     </tr>

doc/puppet_classes/clamav_cd_3A_3Aparams.html

@@ -115,7 +115,7 @@ inherited by all classes except defines.
         <span class='type'>(<tt>Array</tt>)</span>
       
       
-        <em class="default">(defaults to: <tt>[&#39;clamav&#39;,&#39;clamd&#39;]</tt>)</em>
+        <em class="default">(defaults to: <tt>[&#39;clamav&#39;,&#39;clamd&#39;,&#39;s-nail&#39;]</tt>)</em>
       
       
         &mdash;
@@ -373,6 +373,114 @@ inherited by all classes except defines.
         &mdash;
         <div class='inline'>
 <p>ip address to listen on</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>cv_alert_email</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>&#39;you@example.com&#39;</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>email address to send alerts</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>cv_cron_hour</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>&#39;2&#39;</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>which hour the scan should start</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>cv_cron_minute</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>&#39;0&#39;</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>which minute the scan should start</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>cv_cron_user</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>&#39;root&#39;</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>which user should run the cron job</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>cv_scan_dir</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>&#39;/&#39;</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>which directory should be scanned</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>cv_alert_file</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>&#39;tmp/clamav-alert.txt&#39;</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>location and name of the alert file</p>
 </div>
       
     </li>
@@ -388,12 +496,6 @@ inherited by all classes except defines.
         <pre class="lines">
 
 
-31
-32
-33
-34
-35
-36
 37
 38
 39
@@ -428,15 +530,30 @@ inherited by all classes except defines.
 68
 69
 70
-71</pre>
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86</pre>
       </td>
       <td>
-        <pre class="code"><span class="info file"># File 'manifests/params.pp', line 31</span>
+        <pre class="code"><span class="info file"># File 'manifests/params.pp', line 37</span>
 
 class clamav_cd::params (
 
 # installation
-  Array $reqpackages              = [&#39;clamav&#39;,&#39;clamd&#39;],
+  Array $reqpackages              = [&#39;clamav&#39;,&#39;clamd&#39;,&#39;s-nail&#39;],
   String $pkg_ensure              = &#39;present&#39;,
 
 # clamd
@@ -453,6 +570,13 @@ class clamav_cd::params (
   String $cv_preludeanalyzername  = &#39;ClamAV&#39;,
   String $cv_tcpsocket            = &#39;3310&#39;,
   String $cv_tcpaddress           = &#39;localhost&#39;,
+  String $cv_alert_email          = &#39;you@example.com&#39;,
+  String $cv_cron_hour            = &#39;2&#39;,
+  String $cv_cron_minute          = &#39;0&#39;,
+  String $cv_cron_user            = &#39;root&#39;,
+  String $cv_scan_dir             = &#39;/&#39;,
+  String $cv_alert_file           = &#39;tmp/clamav-alert.txt&#39;,
+
 
 ) {
   # service
@@ -469,6 +593,8 @@ class clamav_cd::params (
   $cv_freshclam_erb       = &#39;clamav_cd/freshclam_conf.erb&#39;
   $cv_freshclam_svc       = &#39;/usr/lib/systemd/system/freshclam.service&#39;
   $cv_freshclam_svc_erb   = &#39;clamav_cd/freshclam_svc.erb&#39;
+  $cv_shell_script        = &quot;${cv_config_d_dir}/scan.sh&quot;
+  $cv_shell_script_erb    = &#39;clamav_cd/scan.sh.erb&#39;
 
   # includes must be last
 

manifests/main/config.pp

@@ -18,9 +18,9 @@ class clamav_cd::main::config (
 
   # create a cron job to run a daily scan
   cron { 'clamscan':
-    command => '/bin/clamscan -r / >> /var/log/clamav/daily-scan.log',
+    command => $cv_shell_script,
-    user    => 'root',
+    user    => $cv_cron_user,
-    hour    => 2,
+    hour    => $cv_cron_hour,
-    minute  => 0,
+    minute  => $cv_cron_minute,
   }
 }

manifests/main/files.pp

@@ -47,4 +47,17 @@ class clamav_cd::main::files (
     seluser  => system_u,
     content  => template($cv_freshclam_svc_erb),
   }
+
+  # shell script for scanning and alerting
+  file { $cv_shell_script  :
+    ensure   => file,
+    owner    => 'root',
+    group    => 'root',
+    mode     => '0750',
+    selrange => s0,
+    selrole  => object_r,
+    seltype  => etc_t,
+    seluser  => system_u,
+    content  => template($cv_shell_script_erb),
+  }
 }

manifests/params.pp

@@ -27,11 +27,17 @@
 #   prelude-admin.
 # @param [String] cv_tcpsocket socket port
 # @param [String] cv_tcpaddress ip address to listen on
+# @param [String] cv_alert_email email address to send alerts
+# @param [String] cv_cron_hour which hour the scan should start
+# @param [String] cv_cron_minute which minute the scan should start
+# @param [String] cv_cron_user which user should run the cron job
+# @param [String] cv_scan_dir which directory should be scanned
+# @param [String] cv_alert_file location and name of the alert file
 ##############################################################################
 class clamav_cd::params (
 
 # installation
-  Array $reqpackages              = ['clamav','clamd'],
+  Array $reqpackages              = ['clamav','clamd','s-nail'],
   String $pkg_ensure              = 'present',
 
 # clamd
@@ -48,6 +54,13 @@ class clamav_cd::params (
   String $cv_preludeanalyzername  = 'ClamAV',
   String $cv_tcpsocket            = '3310',
   String $cv_tcpaddress           = 'localhost',
+  String $cv_alert_email          = 'you@example.com',
+  String $cv_cron_hour            = '2',
+  String $cv_cron_minute          = '0',
+  String $cv_cron_user            = 'root',
+  String $cv_scan_dir             = '/',
+  String $cv_alert_file           = 'tmp/clamav-alert.txt',
+
 
 ) {
   # service
@@ -64,6 +77,8 @@ class clamav_cd::params (
   $cv_freshclam_erb       = 'clamav_cd/freshclam_conf.erb'
   $cv_freshclam_svc       = '/usr/lib/systemd/system/freshclam.service'
   $cv_freshclam_svc_erb   = 'clamav_cd/freshclam_svc.erb'
+  $cv_shell_script        = "${cv_config_d_dir}/scan.sh"
+  $cv_shell_script_erb    = 'clamav_cd/scan.sh.erb'
 
   # includes must be last
 

templates/scan.sh.erb

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+# Set paths
+SCAN_DIR="<%= @cv_scan_dir %>"
+LOG_FILE="<%= @cv_logfile %>"
+TMP_ALERT="<%= @cv_alert_file %>"
+EMAIL="<%= @cv_alert_email %>"
+
+# Run clamscan
+clamscan -r --infected --log="$LOG_FILE" "$SCAN_DIR" > /dev/null
+
+# Check if infections were found
+if grep -q "Infected files: [^0]" "$LOG_FILE"; then
+    echo "ClamAV has found infected files on $(hostname)!" > "$TMP_ALERT"
+    echo "" >> "$TMP_ALERT"
+    grep "FOUND" "$LOG_FILE" >> "$TMP_ALERT"
+
+    # Send the alert email
+    mail -s "⚠️ ClamAV Alert on $(hostname)" "$EMAIL" < "$TMP_ALERT"
+fi
+
+# Clean up
+rm -f "$TMP_ALERT"