Puppet Class: sendmail

Inherits:
sendmail::params
Defined in:
manifests/init.pp

Overview

Class: sendmail

Manage the Sendmail MTA.

Parameters:

smart_host

Servers that are behind a firewall may not be able to deliver mail directly to the outside world. In this case the host may need to forward the mail to the gateway machine defined by this parameter. All nonlocal mail is forwarded to this gateway. Default value: undef.

domain_name

Sets the official canonical name of the local machine. Normally this parameter is not required as Sendmail uses the fully qualified domain name by default. Setting this parameter will override the value of the ‘$j’ macro in the sendmail.cf file. Default value: undef.

max_message_size

Define the maximum message size that will be accepted. This can be a pure numerical value given in bytes (e.g. 33554432) or a number with a prefixed byte unit (e.g. 32MB). The conversion is done using the 1024 convention (see the ‘to_bytes’ function in the ‘stdlib’ module), so valid prefixes are either ‘k’ for 1024 bytes or ‘M’ for 1048576 bytes. Default value: undef.

log_level

The loglevel for the sendmail process. Valid options: a numeric value. Default value: undef.

dont_probe_interfaces

Sendmail normally probes all network interfaces to get the hostnames that the server may have. These hostnames are then considered local. This option can be used to prevent the reverse lookup of the network addresses. If this option is set to ‘localhost’ then all network interfaces except for the loopback interface is probed. Valid options: the strings ‘true’, ‘false’ or ‘localhost’. Default value: undef.

features

A hash of features to include in the configuration. Each hash key should be a feature name while the value should be a hash itself. The value hash is used as parameters for the ‘sendmail::mc::feature’ defined type. Check the documentation of this type for details. Default value: {}

enable_ipv4_daemon

Should the host accept mail on all IPv4 network adresses. Valid options: ‘true’ or ‘false’. Default value: ‘true’.

enable_ipv6_daemon

Should the host accept mail on all IPv6 network adresses. Valid options: ‘true’ or ‘false’. Default value: ‘true’.

mailers

An array of mailers to add to the configuration. Default value: [ ‘smtp’, ‘local’ ]

local_host_names

An array of hostnames that Sendmail considers for a local delivery. Default values: [ $::fqdn ]

relay_domains

An array of domains that Sendmail accepts as relay target. This setting is required for secondary MX setups. Default value: []

trusted_users

An array of user names that will be written into the trusted users file. Leading or trailing whitespace is ignored. Empty entries are also ignored. Default value: []

trust_auth_mech

The value of the TRUST_AUTH_MECH macro to set. If this is a string it is used as-is. For an array the value will be concatenated into a string. Default value: undef

ca_cert_file

The filename of the SSL CA certificate.

ca_cert_path

The directory where SSL CA certificates are kept.

server_cert_file

The filename of the SSL server certificate for inbound connections.

server_key_file

The filename of the SSL server key for inbound connections.

client_cert_file

The filename of the SSL client certificate for outbound connections.

client_key_file

The filename of the SSL client key for outbound connections.

server_cert_file2

The filename of the secondary SSL server certificate for inbound connections. The parameter is only valid on Sendmail 8.15.1 or later and when ‘server_cert_file’ is set.

server_key_file2

The filename of the secondary SSL server key for inbound connections. The parameter is only valid on Sendmail 8.15.1 or later and when ‘server_key_file’ is set.

client_cert_file2

The filename of the secondary SSL client certificate for outbound connections. The parameter is only valid on Sendmail 8.15.1 or later and when ‘client_cert_file’ is set.

client_key_file2

The filename of the secondary SSL client key for outbound connections. The parameter is only valid on Sendmail 8.15.1 or later and when ‘client_key_file’ is set.

crl_file

The filename with a list of revoked certificates.

dh_params

The DH parameters used for encryption. This can be one of the numbers ‘512’, ‘1024’, ‘2048’ or a filename with generated parameters.

tls_srv_options

The parameter adjusts the server TLS settings. This can currently be either the letter ‘V’ or the empty string. Setting this parameter to ‘V’ disables the request for a client certificate.

cipher_list

Set the available ciphers for encrypted connections.

server_ssl_options

Configure the SSL connection flags for inbound connections.

client_ssl_options

Configure the SSL connection flags for outbound connections.

cf_version

The configuration version string for Sendmail. This string will be appended to the Sendmail version in the HELO message. If unset, no configuration version will be used. Default value: undef.

version_id

The version id string included in the sendmail.mc file. This has no practical meaning other than having a used defined identifier in the file. Default value: undef.

msp_host

The host where the message submission program should deliver to. This can be a hostname or IP address. To prevent MX lookups for the host, put it in square brackets (e.g., [hostname]). Delivery to the local host would therefore use either [127.0.0.1] for IPv4 or [IPv6:::1] for IPv6. Default value: ‘[127.0.0.1]’

msp_port

The port used for the message submission program. Can be a port number (e.g., 25) or the literal ‘MSA’ for delivery to the message submission agent on port 587. Default value: ‘MSA’

enable_msp_trusted_users

Whether the trusted users file feature is enabled for the message submission program. This may be necessary if you want to allow certain users to change the sender address using ‘sendmail -f’. Valid options: ‘true’ or ‘false’. Default value: ‘false’.

manage_sendmail_mc

Whether to automatically manage the ‘sendmail.mc’ file. Valid options: ‘true’ or ‘false’. Default value: ‘true’

manage_submit_mc

Whether to automatically manage the ‘submit.mc’ file. Valid options: ‘true’ or ‘false’. Default value: ‘true’

auxiliary_packages

Additional packages that will be installed by the Sendmail module. Valid options: array of strings. Default value: varies by operating system.

package_ensure

Configure whether the Sendmail package should be installed, and what version. Valid options: ‘present’, ‘latest’, or a specific version number. Default value: ‘present’

package_manage

Configure whether Puppet should manage the Sendmail package(s). Valid options: ‘true’ or ‘false’. Default value: ‘true’.

service_name

The service name to use on this operating system.

service_enable

Configure whether the Sendmail MTA should be enabled at boot. Valid options: ‘true’ or ‘false’. Default value: ‘true’.

service_manage

Configure whether Puppet should manage the Sendmail service. Valid options: ‘true’ or ‘false’. Default value: ‘true’.

service_ensure

Configure whether the Sendmail service should be running. Valid options: ‘running’ or ‘stopped’. Default value: ‘running’.

service_hasstatus

Define whether the service type can rely on a functional status. Valid options: ‘true’ or ‘false’. Default value: ‘true’

Requires:

Nothing.

Sample Usage:

class { 'sendmail': }

Parameters:

  • smart_host (Optional[String]) (defaults to: undef)
  • domain_name (Optional[String]) (defaults to: undef)
  • max_message_size (Optional[String]) (defaults to: undef)
  • log_level (Optional[Sendmail::Loglevel]) (defaults to: undef)
  • dont_probe_interfaces (Optional[Boolean]) (defaults to: undef)
  • enable_ipv4_daemon (Boolean) (defaults to: true)
  • enable_ipv6_daemon (Boolean) (defaults to: true)
  • features (Hash[String,Data]) (defaults to: {})
  • mailers (Array[String]) (defaults to: $::sendmail::params::mailers)
  • local_host_names (Array[String]) (defaults to: [ $::fqdn ])
  • relay_domains (Array[String]) (defaults to: [])
  • trusted_users (Array[String]) (defaults to: [])
  • trust_auth_mech (Optional[Variant[String,Array[String]]]) (defaults to: undef)
  • ca_cert_file (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • ca_cert_path (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • server_cert_file (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • server_key_file (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • client_cert_file (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • client_key_file (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • server_cert_file2 (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • server_key_file2 (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • client_cert_file2 (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • client_key_file2 (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • crl_file (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • dh_params (Optional[Sendmail::DHParam]) (defaults to: undef)
  • tls_srv_options (Optional[Enum['V','']]) (defaults to: undef)
  • cipher_list (Optional[String]) (defaults to: undef)
  • server_ssl_options (Optional[String]) (defaults to: undef)
  • client_ssl_options (Optional[String]) (defaults to: undef)
  • cf_version (Optional[String]) (defaults to: undef)
  • version_id (Optional[String]) (defaults to: undef)
  • msp_host (String) (defaults to: '[127.0.0.1]')
  • msp_port (Pattern[/^(MSA)|([0-9]+)$/]) (defaults to: 'MSA')
  • enable_msp_trusted_users (Boolean) (defaults to: false)
  • manage_sendmail_mc (Boolean) (defaults to: true)
  • manage_submit_mc (Boolean) (defaults to: true)
  • auxiliary_packages (Array[String]) (defaults to: $::sendmail::params::auxiliary_packages)
  • package_ensure (String) (defaults to: 'present')
  • package_manage (Boolean) (defaults to: $::sendmail::params::package_manage)
  • service_name (String) (defaults to: $::sendmail::params::service_name)
  • service_enable (Boolean) (defaults to: true)
  • service_manage (Boolean) (defaults to: true)
  • service_ensure (Stdlib::Ensure::Service) (defaults to: 'running')
  • service_hasstatus (Boolean) (defaults to: true) 


220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'manifests/init.pp', line 220

class sendmail (
  Optional[String]                        $smart_host               = undef,
  Optional[String]                        $domain_name              = undef,
  Optional[String]                        $max_message_size         = undef,
  Optional[Sendmail::Loglevel]            $log_level                = undef,
  Optional[Boolean]                       $dont_probe_interfaces    = undef,
  Boolean                                 $enable_ipv4_daemon       = true,
  Boolean                                 $enable_ipv6_daemon       = true,
  Hash[String,Data]                       $features                 = {},
  Array[String]                           $mailers                  = $::sendmail::params::mailers,
  Array[String]                           $local_host_names         = [ $::fqdn ],
  Array[String]                           $relay_domains            = [],
  Array[String]                           $trusted_users            = [],
  Optional[Variant[String,Array[String]]] $trust_auth_mech          = undef,
  Optional[Stdlib::Absolutepath]          $ca_cert_file             = undef,
  Optional[Stdlib::Absolutepath]          $ca_cert_path             = undef,
  Optional[Stdlib::Absolutepath]          $server_cert_file         = undef,
  Optional[Stdlib::Absolutepath]          $server_key_file          = undef,
  Optional[Stdlib::Absolutepath]          $client_cert_file         = undef,
  Optional[Stdlib::Absolutepath]          $client_key_file          = undef,
  Optional[Stdlib::Absolutepath]          $server_cert_file2        = undef,
  Optional[Stdlib::Absolutepath]          $server_key_file2         = undef,
  Optional[Stdlib::Absolutepath]          $client_cert_file2        = undef,
  Optional[Stdlib::Absolutepath]          $client_key_file2         = undef,
  Optional[Stdlib::Absolutepath]          $crl_file                 = undef,
  Optional[Sendmail::DHParam]             $dh_params                = undef,
  Optional[Enum['V','']]                  $tls_srv_options          = undef,
  Optional[String]                        $cipher_list              = undef,
  Optional[String]                        $server_ssl_options       = undef,
  Optional[String]                        $client_ssl_options       = undef,
  Optional[String]                        $cf_version               = undef,
  Optional[String]                        $version_id               = undef,
  String                                  $msp_host                 = '[127.0.0.1]',
  Pattern[/^(MSA)|([0-9]+)$/]             $msp_port                 = 'MSA',
  Boolean                                 $enable_msp_trusted_users = false,
  Boolean                                 $manage_sendmail_mc       = true,
  Boolean                                 $manage_submit_mc         = true,
  Array[String]                           $auxiliary_packages       = $::sendmail::params::auxiliary_packages,
  String                                  $package_ensure           = 'present',
  Boolean                                 $package_manage           = $::sendmail::params::package_manage,
  String                                  $service_name             = $::sendmail::params::service_name,
  Boolean                                 $service_enable           = true,
  Boolean                                 $service_manage           = true,
  Stdlib::Ensure::Service                 $service_ensure           = 'running',
  Boolean                                 $service_hasstatus        = true,
) inherits sendmail::params {

  anchor { 'sendmail::begin': }

  class { 'sendmail::package':
    auxiliary_packages => $auxiliary_packages,
    package_ensure     => $package_ensure,
    package_manage     => $package_manage,
    before             => Anchor['sendmail::config'],
    require            => Anchor['sendmail::begin'],
  }

  class { 'sendmail::local_host_names':
    local_host_names => $local_host_names,
    require          => Class['sendmail::package'],
  }

  class { 'sendmail::relay_domains':
    relay_domains => $relay_domains,
    require       => Class['sendmail::package'],
  }

  class { 'sendmail::trusted_users':
    trusted_users => $trusted_users,
    require       => Class['sendmail::package'],
  }

  if ($manage_sendmail_mc) {
    class { 'sendmail::mc':
      cf_version            => $cf_version,
      domain_name           => $domain_name,
      smart_host            => $smart_host,
      max_message_size      => $max_message_size,
      log_level             => $log_level,
      dont_probe_interfaces => $dont_probe_interfaces,
      enable_ipv4_daemon    => $enable_ipv4_daemon,
      enable_ipv6_daemon    => $enable_ipv6_daemon,
      mailers               => $mailers,
      trust_auth_mech       => $trust_auth_mech,
      version_id            => $version_id,
      before                => Anchor['sendmail::config'],
      require               => Class['sendmail::package'],
      notify                => Class['sendmail::service'],
    }

    # Include STARTTLS settings if any of the options is defined
    $tls_opts = [
      $ca_cert_file, $ca_cert_path, $server_cert_file, $server_key_file,
      $client_cert_file, $client_key_file, $crl_file, $tls_srv_options,
      $cipher_list, $server_ssl_options, $client_ssl_options, $dh_params,
    ]

    if (count($tls_opts) > 0) {
      class { 'sendmail::mc::starttls':
        ca_cert_file       => $ca_cert_file,
        ca_cert_path       => $ca_cert_path,
        server_cert_file   => $server_cert_file,
        server_key_file    => $server_key_file,
        client_cert_file   => $client_cert_file,
        client_key_file    => $client_key_file,
        server_cert_file2  => $server_cert_file2,
        server_key_file2   => $server_key_file2,
        client_cert_file2  => $client_cert_file2,
        client_key_file2   => $client_key_file2,
        crl_file           => $crl_file,
        dh_params          => $dh_params,
        tls_srv_options    => $tls_srv_options,
        cipher_list        => $cipher_list,
        server_ssl_options => $server_ssl_options,
        client_ssl_options => $client_ssl_options,
      }
    }
  }

  if ($manage_submit_mc) {
    class { 'sendmail::submit':
      msp_host                 => $msp_host,
      msp_port                 => $msp_port,
      enable_msp_trusted_users => $enable_msp_trusted_users,
      before                   => Anchor['sendmail::config'],
      require                  => Class['sendmail::package'],
      notify                   => Class['sendmail::service'],
    }
  }

  $features.each |$feature,$attributes| {
    sendmail::mc::feature { $feature:
      * => $attributes,
    }
  }

  anchor { 'sendmail::config': }

  class { 'sendmail::service':
    service_name      => $service_name,
    service_enable    => $service_enable,
    service_manage    => $service_manage,
    service_ensure    => $service_ensure,
    service_hasstatus => $service_hasstatus,
    require           => Anchor['sendmail::config'],
    before            => Anchor['sendmail::end'],
  }

  anchor { 'sendmail::end': }
}