Puppet Class: vsftpd::config

Defined in:
manifests/config.pp

Overview

This class provides a method for setting up the main body of /etc/vsftpd/vsftpd.conf.

  • The rest of the parameters can be found on the vsftpd.conf man page *

Parameters:

  • pki
    • If ‘simp’, include SIMP’s pki module and use pki::copy to manage application certs in /etc/pki/simp_apps/vsftpd/x509

    • If true, do not include SIMP’s pki module, but still use pki::copy to manage certs in /etc/pki/simp_apps/vsftpd/x509

    • If false, do not include SIMP’s pki module and do not use pki::copy to manage certs. You will need to appropriately assign a subset of:

      • app_pki_dir

      • app_pki_key

      • app_pki_cert

      • app_pki_ca

      • app_pki_ca_dir

  • app_pki_external_source (String) (defaults to: simplib::lookup('simp_options::pki::source', { 'default_value' => '/etc/pki/simp/x509' }))
    • If pki = ‘simp’ or true, this is the directory from which certs will be copied, via pki::copy. Defaults to /etc/pki/simp/x509.

    • If pki = false, this variable has no effect.

  • app_pki_dir (Stdlib::Absolutepath) (defaults to: '/etc/pki/simp_apps/vsftpd/x509')

    This variable controls the basepath of $app_pki_key, $app_pki_cert, $app_pki_ca, $app_pki_ca_dir, and $app_pki_crl. It defaults to /etc/pki/simp_apps/vsftpd/pki.

  • app_pki_key (Stdlib::Absolutepath) (defaults to: "${app_pki_dir}/private/${::fqdn}.pem")

    Path and name of the private SSL key file

  • app_pki_cert (Stdlib::Absolutepath) (defaults to: "${app_pki_dir}/public/${::fqdn}.pub")

    Path and name of the public SSL certificate

  • app_pki_ca (Stdlib::Absolutepath) (defaults to: "${app_pki_dir}/cacerts/cacerts.pem")

    Path and name of the CA.

  • allow_anon_ssl (Optional[Boolean]) (defaults to: undef)
  • anon_mkdir_write_enable (Optional[Boolean]) (defaults to: undef)
  • anon_other_write_enable (Optional[Boolean]) (defaults to: undef)
  • anon_upload_enable (Boolean) (defaults to: true)
  • anon_world_readable_only (Optional[Boolean]) (defaults to: undef)
  • anonymous_enable (Boolean) (defaults to: true)
  • ascii_download_enable (Optional[Boolean]) (defaults to: undef)
  • ascii_upload_enable (Optional[Boolean]) (defaults to: undef)
  • async_abor_enable (Optional[Boolean]) (defaults to: undef)
  • background (Optional[Boolean]) (defaults to: undef)
  • check_shell (Optional[Boolean]) (defaults to: undef)
  • chmod_enable (Optional[Boolean]) (defaults to: undef)
  • chown_uploads (Optional[Boolean]) (defaults to: undef)
  • chroot_list_enable (Optional[Boolean]) (defaults to: undef)
  • chroot_local_user (Optional[Boolean]) (defaults to: undef)
  • connect_from_port_20 (Boolean) (defaults to: true)
  • deny_email_enable (Optional[Boolean]) (defaults to: undef)
  • dirlist_enable (Optional[Boolean]) (defaults to: undef)
  • dirmessage_enable (Boolean) (defaults to: true)
  • download_enable (Optional[Boolean]) (defaults to: undef)
  • dual_log_enable (Optional[Boolean]) (defaults to: undef)
  • force_dot_files (Optional[Boolean]) (defaults to: undef)
  • force_anon_data_ssl (Optional[Boolean]) (defaults to: undef)
  • force_anon_logins_ssl (Optional[Boolean]) (defaults to: undef)
  • force_local_data_ssl (Boolean) (defaults to: true)
  • force_local_logins_ssl (Boolean) (defaults to: true)
  • guest_enable (Optional[Boolean]) (defaults to: undef)
  • hide_ids (Optional[Boolean]) (defaults to: undef)
  • listen_ipv6 (Optional[Boolean]) (defaults to: undef)
  • lock_upload_files (Optional[Boolean]) (defaults to: undef)
  • log_ftp_protocol (Optional[Boolean]) (defaults to: undef)
  • ls_recurse_enable (Optional[Boolean]) (defaults to: undef)
  • mdtm_write (Optional[Boolean]) (defaults to: undef)
  • no_anon_password (Optional[Boolean]) (defaults to: undef)
  • no_log_lock (Optional[Boolean]) (defaults to: undef)
  • one_process_model (Optional[Boolean]) (defaults to: undef)
  • passwd_chroot_enable (Optional[Boolean]) (defaults to: undef)
  • pasv_addr_resolve (Optional[Boolean]) (defaults to: undef)
  • pasv_promiscuous (Optional[Boolean]) (defaults to: undef)
  • port_enable (Optional[Boolean]) (defaults to: undef)
  • port_promiscuous (Optional[Boolean]) (defaults to: undef)
  • reverse_lookup_enable (Optional[Boolean]) (defaults to: undef)
  • run_as_launching_user (Optional[Boolean]) (defaults to: undef)
  • secure_email_list_enable (Optional[Boolean]) (defaults to: undef)
  • session_support (Optional[Boolean]) (defaults to: undef)
  • setproctitle_enable (Optional[Boolean]) (defaults to: undef)
  • ssl_sslv2 (Boolean) (defaults to: false)
  • ssl_sslv3 (Boolean) (defaults to: false)
  • ssl_tlsv1 (Boolean) (defaults to: false)
  • ssl_tlsv1_1 (Boolean) (defaults to: false)
  • ssl_tlsv1_2 (Boolean) (defaults to: true)
  • syslog_enable (Boolean) (defaults to: true)
  • text_userdb_names (Optional[Boolean]) (defaults to: undef)
  • tilde_user_enable (Optional[Boolean]) (defaults to: undef)
  • use_localtime (Optional[Boolean]) (defaults to: undef)
  • use_sendfile (Optional[Boolean]) (defaults to: undef)
  • userlist_file (Stdlib::Absolutepath) (defaults to: '/etc/vsftpd/user_list')
  • userlist_log (Boolean) (defaults to: true)
  • virtual_use_local_privs (Optional[Boolean]) (defaults to: undef)
  • write_enable (Boolean) (defaults to: true)
  • xferlog_enable (Boolean) (defaults to: true)
  • xferlog_std_format (Boolean) (defaults to: true)
  • accept_timeout (Optional[Integer]) (defaults to: undef)
  • anon_max_rate (Optional[Integer]) (defaults to: undef)
  • anon_umask (Optional[Simplib::Umask]) (defaults to: undef)
  • connect_timeout (Optional[Integer]) (defaults to: undef)
  • data_connection_timeout (Optional[Integer]) (defaults to: undef)
  • delay_failed_login (Optional[Integer]) (defaults to: undef)
  • delay_successful_login (Optional[Integer]) (defaults to: undef)
  • file_open_mode (Optional[Simplib::Umask]) (defaults to: undef)
  • idle_session_timeout (Optional[Integer]) (defaults to: undef)
  • local_max_rate (Optional[Integer]) (defaults to: undef)
  • local_umask (Simplib::Umask) (defaults to: '022')
  • max_clients (Optional[Integer]) (defaults to: undef)
  • max_login_fails (Optional[Integer]) (defaults to: undef)
  • max_per_ip (Optional[Integer]) (defaults to: undef)
  • trans_chunk_size (Optional[Integer]) (defaults to: undef)
  • anon_root (Optional[String]) (defaults to: undef)
  • banned_email_file (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • banner_file (Stdlib::Absolutepath) (defaults to: '/etc/issue.net')
  • chown_username (Optional[String]) (defaults to: undef)
  • chroot_list_file (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • cmds_allowed (Optional[Array[String]]) (defaults to: undef)
  • deny_file (Optional[String]) (defaults to: undef)
  • dsa_cert_file (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • dsa_private_key_file (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • email_password_file (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • hide_file (Optional[String]) (defaults to: undef)
  • listen_address6 (Optional[Simplib::IP::V6]) (defaults to: undef)
  • local_root (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • message_file (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • nopriv_user (Optional[String]) (defaults to: undef)
  • pasv_address (Optional[Simplib::Host]) (defaults to: undef)
  • validate_cert (Boolean) (defaults to: $::vsftpd::validate_cert)
  • secure_chroot_dir (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • user_config_dir (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • user_sub_token (Optional[String]) (defaults to: undef)
  • vsftpd_log_file (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • xferlog_file (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • min_uid (String) (defaults to: '500')

Author:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
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
# File 'manifests/config.pp', line 41

class vsftpd::config (
  Optional[Boolean]              $allow_anon_ssl           = undef,
  Optional[Boolean]              $anon_mkdir_write_enable  = undef,
  Optional[Boolean]              $anon_other_write_enable  = undef,
  Boolean                        $anon_upload_enable       = true,
  Optional[Boolean]              $anon_world_readable_only = undef,
  Boolean                        $anonymous_enable         = true,
  Optional[Boolean]              $ascii_download_enable    = undef,
  Optional[Boolean]              $ascii_upload_enable      = undef,
  Optional[Boolean]              $async_abor_enable        = undef,
  Optional[Boolean]              $background               = undef,
  Optional[Boolean]              $check_shell              = undef,
  Optional[Boolean]              $chmod_enable             = undef,
  Optional[Boolean]              $chown_uploads            = undef,
  Optional[Boolean]              $chroot_list_enable       = undef,
  Optional[Boolean]              $chroot_local_user        = undef,
  Boolean                        $connect_from_port_20     = true,
  Optional[Boolean]              $deny_email_enable        = undef,
  Optional[Boolean]              $dirlist_enable           = undef,
  Boolean                        $dirmessage_enable        = true,
  Optional[Boolean]              $download_enable          = undef,
  Optional[Boolean]              $dual_log_enable          = undef,
  Optional[Boolean]              $force_dot_files          = undef,
  Optional[Boolean]              $force_anon_data_ssl      = undef,
  Optional[Boolean]              $force_anon_logins_ssl    = undef,
  Boolean                        $force_local_data_ssl     = true,
  Boolean                        $force_local_logins_ssl   = true,
  Optional[Boolean]              $guest_enable             = undef,
  Optional[Boolean]              $hide_ids                 = undef,
  Optional[Boolean]              $listen_ipv6              = undef,
  Optional[Boolean]              $lock_upload_files        = undef,
  Optional[Boolean]              $log_ftp_protocol         = undef,
  Optional[Boolean]              $ls_recurse_enable        = undef,
  Optional[Boolean]              $mdtm_write               = undef,
  Optional[Boolean]              $no_anon_password         = undef,
  Optional[Boolean]              $no_log_lock              = undef,
  Optional[Boolean]              $one_process_model        = undef,
  Optional[Boolean]              $passwd_chroot_enable     = undef,
  Optional[Boolean]              $pasv_addr_resolve        = undef,
  Optional[Boolean]              $pasv_promiscuous         = undef,
  Optional[Boolean]              $port_enable              = undef,
  Optional[Boolean]              $port_promiscuous         = undef,
  Optional[Boolean]              $reverse_lookup_enable    = undef,
  Optional[Boolean]              $run_as_launching_user    = undef,
  Optional[Boolean]              $secure_email_list_enable = undef,
  Optional[Boolean]              $session_support          = undef,
  Optional[Boolean]              $setproctitle_enable      = undef,
  Boolean                        $ssl_sslv2                = false,
  Boolean                        $ssl_sslv3                = false,
  Boolean                        $ssl_tlsv1                = false,
  Boolean                        $ssl_tlsv1_1              = false,
  Boolean                        $ssl_tlsv1_2              = true,
  Boolean                        $syslog_enable            = true,
  Optional[Boolean]              $text_userdb_names        = undef,
  Optional[Boolean]              $tilde_user_enable        = undef,
  Optional[Boolean]              $use_localtime            = undef,
  Optional[Boolean]              $use_sendfile             = undef,
  Stdlib::Absolutepath           $userlist_file            = '/etc/vsftpd/user_list',
  Boolean                        $userlist_log             = true,
  Optional[Boolean]              $virtual_use_local_privs  = undef,
  Boolean                        $write_enable             = true,
  Boolean                        $xferlog_enable           = true,
  Boolean                        $xferlog_std_format       = true,
  Optional[Integer]              $accept_timeout           = undef,
  Optional[Integer]              $anon_max_rate            = undef,
  Optional[Simplib::Umask]       $anon_umask               = undef,
  Optional[Integer]              $connect_timeout          = undef,
  Optional[Integer]              $data_connection_timeout  = undef,
  Optional[Integer]              $delay_failed_login       = undef,
  Optional[Integer]              $delay_successful_login   = undef,
  Optional[Simplib::Umask]       $file_open_mode           = undef,
  Optional[Integer]              $idle_session_timeout     = undef,
  Optional[Integer]              $local_max_rate           = undef,
  Simplib::Umask                 $local_umask              = '022',
  Optional[Integer]              $max_clients              = undef,
  Optional[Integer]              $max_login_fails          = undef,
  Optional[Integer]              $max_per_ip               = undef,
  Optional[Integer]              $trans_chunk_size         = undef,
  Optional[String]               $anon_root                = undef,
  Optional[Stdlib::Absolutepath] $banned_email_file        = undef,
  Stdlib::Absolutepath           $banner_file              = '/etc/issue.net',
  Optional[String]               $chown_username           = undef,
  Optional[Stdlib::Absolutepath] $chroot_list_file         = undef,
  Optional[Array[String]]        $cmds_allowed             = undef,
  Optional[String]               $deny_file                = undef, # can contain regex
  Optional[Stdlib::Absolutepath] $dsa_cert_file            = undef,
  Optional[Stdlib::Absolutepath] $dsa_private_key_file     = undef,
  Optional[Stdlib::Absolutepath] $email_password_file      = undef,
  Optional[String]               $hide_file                = undef, # can contain regex
  Optional[Simplib::IP::V6]      $listen_address6          = undef,
  Optional[Stdlib::Absolutepath] $local_root               = undef,
  Optional[Stdlib::Absolutepath] $message_file             = undef,
  Optional[String]               $nopriv_user              = undef,
  Optional[Simplib::Host]        $pasv_address             = undef,
  String                         $app_pki_external_source  = simplib::lookup('simp_options::pki::source', { 'default_value' => '/etc/pki/simp/x509' }),
  Stdlib::Absolutepath           $app_pki_dir              = '/etc/pki/simp_apps/vsftpd/x509',
  Stdlib::Absolutepath           $app_pki_cert             = "${app_pki_dir}/public/${::fqdn}.pub",
  Stdlib::Absolutepath           $app_pki_key              = "${app_pki_dir}/private/${::fqdn}.pem",
  Stdlib::Absolutepath           $app_pki_ca               = "${app_pki_dir}/cacerts/cacerts.pem",
  Boolean                        $validate_cert            = $::vsftpd::validate_cert,
  Optional[Stdlib::Absolutepath] $secure_chroot_dir        = undef,
  Optional[Stdlib::Absolutepath] $user_config_dir          = undef,
  Optional[String]               $user_sub_token           = undef,
  Optional[Stdlib::Absolutepath] $vsftpd_log_file          = undef,
  Optional[Stdlib::Absolutepath] $xferlog_file             = undef,
  String                         $min_uid                  = '500'
) {
  assert_private()

  if ($::vsftpd::listen_ipv4 and $listen_ipv6) {
    fail('$::vsftpd::listen_ipv4 and $::vsftpd::config::listen_ipv6 are mutually exculsive')
  }

  $_tcp_wrappers       = $vsftpd::tcpwrappers
  $_listen_port        = $vsftpd::listen_port
  $_listen_address     = $vsftpd::listen_address
  $_ftp_data_port      = $vsftpd::ftp_data_port
  $_pasv_enable        = $vsftpd::pasv_enable
  $_listen_ipv4        = $vsftpd::listen_ipv4
  $_ipv6_enabled       = $facts['ipv6_enabled']
  $_vsftpd_group       = $vsftpd::vsftpd_group
  $_ftp_username       = $vsftpd::vsftpd_user
  $_user_list          = $vsftpd::user_list
  $_guest_username     = $vsftpd::vsftpd_user
  $_userlist_deny      = $vsftpd::userlist_deny
  $_userlist_enable    = $vsftpd::userlist_enable
  $_pasv_max_port      = $vsftpd::pasv_max_port
  $_pasv_min_port      = $vsftpd::pasv_min_port
  $_local_enable       = $vsftpd::local_enable
  $_pam_service_name   = $vsftpd::pam_service_name
  $_ssl_enable         = $vsftpd::ssl_enable
  $_require_ssl_reuse  = $vsftpd::require_ssl_reuse
  $_ssl_ciphers        = $vsftpd::cipher_suite

  if $::vsftpd::pki {
    simplib::assert_optional_dependency($module_name, 'simp/pki')

    pki::copy { 'vsftpd':
      source => $app_pki_external_source,
      pki    => $vsftpd::pki,
      group  => $_vsftpd_group,
      notify => Service['vsftpd']
    }
  }

  file { '/etc/vsftpd':
    ensure   => 'directory',
    owner    => 'root',
    group    => $_vsftpd_group,
    mode     => '0640',
    recurse  => true,
    checksum => undef,
    purge    => true,
    require  => Package['vsftpd']
  }

  file { '/etc/vsftpd/ftpusers':
    owner   => 'root',
    group   => $_vsftpd_group,
    mode    => '0640',
    source  => 'puppet:///modules/vsftpd/ftpusers',
    notify  => Service['vsftpd'],
    require => Package['vsftpd']
  }

  file { $userlist_file:
    owner   => 'root',
    group   => $_vsftpd_group,
    mode    => '0640',
    content => template('vsftpd/user_list.erb'),
    notify  => Service['vsftpd'],
    require => Package['vsftpd']
  }

  file { '/etc/pam.d/vsftpd':
    owner   => 'root',
    group   => 'root',
    mode    => '0640',
    source  => 'puppet:///modules/vsftpd/vsftpd.pam',
    require => Package['vsftpd']
  }

  file { '/etc/vsftpd/vsftpd.conf':
    owner   => 'root',
    group   => $_vsftpd_group,
    mode    => '0640',
    content => template('vsftpd/vsftpd.conf.erb'),
    notify  => Service['vsftpd']
  }

  if !empty($min_uid) {
    file { '/etc/ftpusers':
      ensure => 'file',
      force  => true,
      owner  => 'root',
      group  => 'root',
      mode   => '0600',
    }
    ftpusers { '/etc/ftpusers':
      min_id  => $min_uid,
      require => File['/etc/ftpusers']
    }
  }
}