Puppet Class: sendmail::mc::starttls

Defined in:
manifests/mc/starttls.pp

Summary

Manage `STARTTLS` parameters in the 'sendmail.mc' file.

Overview

This class is included by the main ‘sendmail` class and should not be used directly.

Examples:

class { sendmail::mc::starttls':
  ca_cert_file     => '/etc/mail/tls/my-ca-cert.pem',
  server_cert_file => '/etc/mail/tls/server.pem',
  server_key_file  => '/etc/mail/tls/server.key',
  client_cert_file => '/etc/mail/tls/server.pem',
  client_key_file  => '/etc/mail/tls/server.key',
  cipher_list      => 'HIGH:!MD5:!eNULL'
}

Parameters:

  • ca_cert_file (Optional[Stdlib::Absolutepath]) (defaults to: undef) —

    The filename of the SSL CA certificate.

  • ca_cert_path (Optional[Stdlib::Absolutepath]) (defaults to: undef) —

    The directory where SSL CA certificates are kept.

  • server_cert_file (Optional[Stdlib::Absolutepath]) (defaults to: undef) —

    The filename of the SSL server certificate for inbound connections.

  • server_key_file (Optional[Stdlib::Absolutepath]) (defaults to: undef) —

    The filename of the SSL server key for inbound connections.

  • client_cert_file (Optional[Stdlib::Absolutepath]) (defaults to: undef) —

    The filename of the SSL client certificate for outbound connections.

  • client_key_file (Optional[Stdlib::Absolutepath]) (defaults to: undef) —

    The filename of the SSL client key for outbound connections.

  • server_cert_file2 (Optional[Stdlib::Absolutepath]) (defaults to: undef) —

    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 (Optional[Stdlib::Absolutepath]) (defaults to: undef) —

    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 (Optional[Stdlib::Absolutepath]) (defaults to: undef) —

    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 (Optional[Stdlib::Absolutepath]) (defaults to: undef) —

    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 (Optional[Stdlib::Absolutepath]) (defaults to: undef) —

    The filename with a list of revoked certificates.

  • dh_params (Optional[Sendmail::DHParam]) (defaults to: undef) —

    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 (Optional[Enum['V','']]) (defaults to: undef) —

    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 (Optional[String]) (defaults to: undef) —

    Set the available ciphers for encrypted connections.

  • server_ssl_options (Optional[String]) (defaults to: undef) —

    Configure the SSL connection flags for inbound connections.

  • client_ssl_options (Optional[String]) (defaults to: undef) —

    Configure the SSL connection flags for outbound connections.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'manifests/mc/starttls.pp', line 69

class sendmail::mc::starttls (
  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,
) {
  $multi = ('sendmail_version' in $facts) and
  (versioncmp($facts['sendmail_version'], '8.15.1') >= 0)

  $_server_cert_file = ($multi and $server_cert_file and $server_cert_file2) ? {
    true    => "${server_cert_file},${server_cert_file2}",
    default => $server_cert_file,
  }

  $_server_key_file = ($multi and $server_key_file and $server_key_file2) ? {
    true    => "${server_key_file},${server_key_file2}",
    default => $server_key_file,
  }

  $_client_cert_file = ($multi and $client_cert_file and $client_cert_file2) ? {
    true    => "${client_cert_file},${client_cert_file2}",
    default => $client_cert_file,
  }

  $_client_key_file = ($multi and $client_key_file and $client_key_file2) ? {
    true    => "${client_key_file},${client_key_file2}",
    default => $client_key_file,
  }

  $params = {
    'include_starttls_m4' => $facts['os']['family'] in ['Debian'],
    '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,
    'dh_params'           => $dh_params,
    'crl_file'            => $crl_file,
    'tls_srv_options'     => $tls_srv_options,
  }

  concat::fragment { 'sendmail_mc-starttls':
    target  => 'sendmail.mc',
    order   => '47',
    content => epp('sendmail/starttls.m4', $params),
  }

  if $facts['sendmail_version'] != undef {
    if versioncmp($facts['sendmail_version'], '8.15.1') < 0 {
      if $cipher_list {
        sendmail::mc::local_config { 'CipherList':
          content => "O CipherList=${cipher_list}\n",
        }
      }
      if $server_ssl_options {
        sendmail::mc::local_config { 'ServerSSLOptions':
          content => "O ServerSSLOptions=${server_ssl_options}\n",
        }
      }
      if $client_ssl_options {
        sendmail::mc::local_config { 'ClientSSLOptions':
          content => "O ClientSSLOptions=${client_ssl_options}\n",
        }
      }
    }
    else {
      if $cipher_list {
        sendmail::mc::define { 'confCIPHER_LIST':
          expansion => $cipher_list,
        }
      }
      if $server_ssl_options {
        sendmail::mc::define { 'confSERVER_SSL_OPTIONS':
          expansion => $server_ssl_options,
        }
      }
      if $client_ssl_options {
        sendmail::mc::define { 'confCLIENT_SSL_OPTIONS':
          expansion => $client_ssl_options,
        }
      }
    }
  }
}