diff --git a/README.md b/README.md index 2317113..a8e31d8 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,13 @@ ***Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production*** +## Features +* install all required binaries including s-nail as mail program to send alerts when infected files are found +* manage required config files +* manage cronjob settings via parameters +* run cron job to scan the file system ( by default starting at root, configurable) +* manage services + ## Dependencies All dependencies must be included in the catalogue. diff --git a/doc/file.README.html b/doc/file.README.html index 22e4fd6..072f67f 100644 --- a/doc/file.README.html +++ b/doc/file.README.html @@ -74,6 +74,19 @@

Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production

+

Features

+ +

Dependencies

All dependencies must be included in the catalogue.

diff --git a/doc/index.html b/doc/index.html index f203196..60796b8 100644 --- a/doc/index.html +++ b/doc/index.html @@ -74,6 +74,19 @@

Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production

+

Features

+ +

Dependencies

All dependencies must be included in the catalogue.

diff --git a/doc/puppet_classes/cd_clamav.html b/doc/puppet_classes/cd_clamav.html deleted file mode 100644 index ef04b92..0000000 --- a/doc/puppet_classes/cd_clamav.html +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - Puppet Class: cd_clamav - - — Documentation by YARD 0.9.36 - - - - - - - - - - - - - - - - - -
- -
-
- -
- - -

Puppet Class: cd_clamav

-
- - -
-
Defined in:
-
- manifests/init.pp -
-
-
- -

Summary

- Class initializes the cd_clamav Module. - -

Overview

-
-
- -

cd_clamav::init.pp Module name: cd_clamav Author: Arne Teuke (arne_teuke@confdroid.com)

- -
-
- - - -
- - - -
- - - - - -
- 
-
-
-6
-7
-8
-9
-10
-11
-12
- 		- 
# File 'manifests/init.pp', line 6
-
-class cd_clamav {
-  include cd_clamav::params
-
-  resources { 'firewall':
-    purge => true,
-  }
-}
-
-
-
- - - -
- - \ No newline at end of file diff --git a/doc/puppet_classes/cd_clamav_3A_3Amain_3A_3Aconfig.html b/doc/puppet_classes/cd_clamav_3A_3Amain_3A_3Aconfig.html deleted file mode 100644 index 26e2ce4..0000000 --- a/doc/puppet_classes/cd_clamav_3A_3Amain_3A_3Aconfig.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - Puppet Class: cd_clamav::main::config - - — Documentation by YARD 0.9.36 - - - - - - - - - - - - - - - - - -
- -
-
- -
- - -

Puppet Class: cd_clamav::main::config

-
- -
-
Inherits:
-
cd_clamav::params
-
- - -
-
Defined in:
-
- manifests/main/config.pp -
-
-
- -

Summary

- Class manages all aspects of configuring the module logic for -cd_clamav. - -

Overview

-
-
- -

cd_clamav::main::config.pp Module name: cd_clamav Author: Arne Teuke (arne_teuke@confdroid.com)

- -
-
- - - -
- - - -
- - - - - -
- 
-
-
-7
-8
-9
-10
-11
- 		- 
# File 'manifests/main/config.pp', line 7
-
-class cd_clamav::main::config (
-
-) inherits cd_clamav::params {
-  include cd_clamav::main::service
-}
-
-
-
- - - -
- - \ No newline at end of file diff --git a/doc/puppet_classes/cd_clamav_3A_3Amain_3A_3Adirs.html b/doc/puppet_classes/cd_clamav_3A_3Amain_3A_3Adirs.html deleted file mode 100644 index 8c264e6..0000000 --- a/doc/puppet_classes/cd_clamav_3A_3Amain_3A_3Adirs.html +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - - Puppet Class: cd_clamav::main::dirs - - — Documentation by YARD 0.9.36 - - - - - - - - - - - - - - - - - -
- -
-
- -
- - -

Puppet Class: cd_clamav::main::dirs

-
- -
-
Inherits:
-
cd_clamav::params
-
- - -
-
Defined in:
-
- manifests/main/dirs.pp -
-
-
- -

Summary

- Class manages all directories required for cd_clamav. - -

Overview

-
-
- -

cd_clamav::main::dirs.pp Module name: cd_clamav Author: Arne Teuke (arne_teuke@confdroid.com)

- -
-
- - - -
- - - -
- - - - - -
- 
-
-
-6
-7
-8
-9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
- 		- 
# File 'manifests/main/dirs.pp', line 6
-
-class cd_clamav::main::dirs (
-
-) inherits cd_clamav::params {
-  require cd_clamav::main::install
-
-  # config.d dir
-  file { $cv_config_d_dir:
-    ensure   => directory,
-    owner    => 'root',
-    group    => 'root',
-    mode     => '0755',
-    selrange => s0,
-    selrole  => object_r,
-    seltype  => etc_t,
-    seluser  => system_u,
-  }
-}
-
-
-
- - - -
- - \ No newline at end of file diff --git a/doc/puppet_classes/cd_clamav_3A_3Amain_3A_3Afiles.html b/doc/puppet_classes/cd_clamav_3A_3Amain_3A_3Afiles.html deleted file mode 100644 index 2e571d9..0000000 --- a/doc/puppet_classes/cd_clamav_3A_3Amain_3A_3Afiles.html +++ /dev/null @@ -1,184 +0,0 @@ - - - - - - - Puppet Class: cd_clamav::main::files - - — Documentation by YARD 0.9.36 - - - - - - - - - - - - - - - - - -
- -
-
- -
- - -

Puppet Class: cd_clamav::main::files

-
- -
-
Inherits:
-
cd_clamav::params
-
- - -
-
Defined in:
-
- manifests/main/files.pp -
-
-
- -

Summary

- Class manages all configuration files required for cd_clamav. - -

Overview

-
-
- -

cd_clamav::main::files.pp Module name: cd_clamav Author: Arne Teuke (arne_teuke@confdroid.com)

- -
-
- - - -
- - - -
- - - - - -
- 
-
-
-6
-7
-8
-9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30
-31
-32
-33
-34
-35
-36
-37
- 		- 
# File 'manifests/main/files.pp', line 6
-
-class cd_clamav::main::files (
-
-) inherits cd_clamav::params {
-  require cd_clamav::main::dirs
-
-  # clamd config file
-  file { $cv_clamd_config_file:
-    ensure   => file,
-    owner    => 'root',
-    group    => 'root',
-    mode     => '0644',
-    selrange => s0,
-    selrole  => object_r,
-    seltype  => etc_t,
-    seluser  => system_u,
-    content  => template($cv_clamd_config_erb),
-#    notify   => Service[$cv_service],
-  }
-
-  # freshclam config file
-  file { $cv_freshclam_file:
-    ensure   => file,
-    owner    => 'root',
-    group    => 'root',
-    mode     => '0600',
-    selrange => s0,
-    selrole  => object_r,
-    seltype  => etc_t,
-    seluser  => system_u,
-    content  => template($cv_freshclam_erb),
-  }
-}
-
-
-
- - - -
- - \ No newline at end of file diff --git a/doc/puppet_classes/cd_clamav_3A_3Amain_3A_3Ainstall.html b/doc/puppet_classes/cd_clamav_3A_3Amain_3A_3Ainstall.html deleted file mode 100644 index d9b7179..0000000 --- a/doc/puppet_classes/cd_clamav_3A_3Amain_3A_3Ainstall.html +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - Puppet Class: cd_clamav::main::install - - — Documentation by YARD 0.9.36 - - - - - - - - - - - - - - - - - -
- -
-
- -
- - -

Puppet Class: cd_clamav::main::install

-
- -
-
Inherits:
-
cd_clamav::params
-
- - -
-
Defined in:
-
- manifests/main/install.pp -
-
-
- -

Summary

- Class manage all aspects of installing binaries required for -cd_clamav - -

Overview

-
-
- -

cd_clamav ::main::install.pp Module name: cd_clamav Author: Arne Teuke (arne_teuke@confdroid.com)

- -
-
- - - -
- - - -
- - - - - -
- 
-
-
-7
-8
-9
-10
-11
-12
-13
- 		- 
# File 'manifests/main/install.pp', line 7
-
-class cd_clamav::main::install (
-
-) inherits cd_clamav::params {
-  package { $reqpackages:
-    ensure => $pkg_ensure,
-  }
-}
-
-
-
- - - -
- - \ No newline at end of file diff --git a/doc/puppet_classes/cd_clamav_3A_3Amain_3A_3Aservice.html b/doc/puppet_classes/cd_clamav_3A_3Amain_3A_3Aservice.html deleted file mode 100644 index 869775b..0000000 --- a/doc/puppet_classes/cd_clamav_3A_3Amain_3A_3Aservice.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - - Puppet Class: cd_clamav::main::service - - — Documentation by YARD 0.9.36 - - - - - - - - - - - - - - - - - -
- -
-
- -
- - -

Puppet Class: cd_clamav::main::service

-
- -
-
Inherits:
-
cd_clamav::params
-
- - -
-
Defined in:
-
- manifests/main/service.pp -
-
-
- -

Summary

- Class manages the service(s) for cd_clamav. - -

Overview

-
-
- -

cd_clamav::main::service.pp Module name: cd_clamav Author: Arne Teuke (arne_teuke@confdroid.com)

- -
-
- - - -
- - - -
- - - - - -
- 
-
-
-6
-7
-8
-9
-10
-11
-12
-13
-14
-15
-16
-17
- 		- 
# File 'manifests/main/service.pp', line 6
-
-class cd_clamav::main::service (
-
-) inherits cd_clamav::params {
-  require cd_clamav::main::files
-
-#  service { $cv_service:
-#    ensure     => running,
-#    hasstatus  => true,
-#    hasrestart => true,
-#    enable     => true,
-#  }
-}
-
-
-
- - - -
- - \ No newline at end of file diff --git a/doc/puppet_classes/cd_clamav_3A_3Aparams.html b/doc/puppet_classes/cd_clamav_3A_3Aparams.html deleted file mode 100644 index dd205b2..0000000 --- a/doc/puppet_classes/cd_clamav_3A_3Aparams.html +++ /dev/null @@ -1,443 +0,0 @@ - - - - - - - Puppet Class: cd_clamav::params - - — Documentation by YARD 0.9.36 - - - - - - - - - - - - - - - - - -
- -
-
- -
- - -

Puppet Class: cd_clamav::params

-
- - -
-
Inherited by:
-
- - cd_clamav::main::dirs
- - cd_clamav::main::files
- - cd_clamav::main::config
- - cd_clamav::main::install
- - cd_clamav::main::service
- -
-
- -
-
Defined in:
-
- manifests/params.pp -
-
-
- -

Summary

- Class holds all parameters for the cd_clamav module and is -inherited by all classes except defines. - -

Overview

-
-
- -

cd_clamav::params.pp Module name: cd_clamav Author: Arne Teuke (arne_teuke@confdroid.com)

- -
-
- - - -
-

Parameters:

-
    - -
  • - - reqpackages - - - (String) - - - (defaults to: ['clamav','clamav-update','clamd']) - - - — -
    -

    List of packages to install.

    -
    - -
    • - -
  • - - pkg_ensure - - - (String) - - - (defaults to: 'present') - - - — -
    -

    which package type to choose, i.e. latest or present.

    -
    - -
    • - -
  • - - cv_logfile - - - (String) - - - (defaults to: '/var/log/clamd.scan') - - - — -
    -

    where to log messages for the clamd service.

    -
    - -
    • - -
  • - - cv_logfileunlock - - - (String) - - - (defaults to: 'no') - - - — -
    -

    whether log file should be locked for writing -the lock protects against running clamd multiple times

    -
    - -
    • - -
  • - - cv_logfilemaxsize - - - (String) - - - (defaults to: '2M') - - - — -
    -

    the max size for the logfile. This also enables logrotation.

    -
    - -
    • - -
  • - - cv_logtime - - - (String) - - - (defaults to: 'yes') - - - — -
    -

    Whether to log the time with each message.

    -
    - -
    • - -
  • - - cv_logclean - - - (String) - - - (defaults to: 'no') - - - — -
    -

    whether to log clean files. Useful in debugging but drastically increases the log size.

    -
    - -
    • - -
  • - - cv_logsyslog - - - (String) - - - (defaults to: 'yes') - - - — -
    -

    Use system logger (can work together with LogFile).

    -
    - -
    • - -
  • - - cv_logfacility - - - (String) - - - (defaults to: 'LOG_MAIL') - - - — -
    -

    type of syslog messages - please refer to ‘man syslog’for facility names

    -
    - -
    • - -
  • - - cv_logverbose - - - (String) - - - (defaults to: 'no') - - - — -
    -

    Whether to log verbose.

    -
    - -
    • - -
  • - - cv_logrotate - - - (String) - - - (defaults to: 'yes') - - - — -
    -

    whether to enable log rotation. Always enabled when LogFileMaxSize is enabled.

    -
    - -
    • - -
  • - - cv_preludeenable - - - (String) - - - (defaults to: 'no') - - - — -
    -

    whether to enable prelude output.

    -
    - -
    • - -
  • - - cv_preludeanalyzername - - - (String) - - - (defaults to: 'ClamAV') - - - — -
    -

    name of the analyzer used by prelude-admin.

    -
    - -
    • - -
- - - -
- - - - - -
- 
-
-
-29
-30
-31
-32
-33
-34
-35
-36
-37
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47
-48
-49
-50
-51
-52
-53
-54
-55
-56
-57
-58
-59
-60
-61
-62
-63
-64
- 		- 
# File 'manifests/params.pp', line 29
-
-class cd_clamav::params (
-
-# installation
-  String $reqpackages            = ['clamav','clamav-update','clamd'],
-  String $pkg_ensure             = 'present',
-
-# clamd
-  String $cv_logfile             = '/var/log/clamd.scan',
-  String $cv_logfileunlock       = 'no',
-  String $cv_logfilemaxsize      = '2M',
-  String $cv_logtime             = 'yes',
-  String $cv_logclean            = 'no',
-  String $cv_logsyslog           = 'yes',
-  String $cv_logfacility         = 'LOG_MAIL',
-  String $cv_logverbose          = 'no',
-  String $cv_logrotate           = 'yes',
-  String $cv_preludeenable       = 'no',
-  String $cv_preludeanalyzername = 'ClamAV',
-
-) {
-  # service
-  $cv_service           = 'clamd@.service'
-
-  # dirs
-  $cv_config_d_dir      = '/etc/clamd.d'
-
-  # files
-  $cv_clamd_config_file = "${cv_config_d_dir}/scan.conf"
-  $cv_clamd_config_erb  = 'cd_clamav/scan_conf.erb'
-  $cv_freshclam_file    = '/etc/freshclam.conf'
-  $cv_freshclam_erb     = 'cd_clamav/freshclam_conf.erb'
-
-  # includes must be last
-
-  include cd_clamav::main::config
-}
-
-
-
- - - -
- - \ No newline at end of file