Puppet Class: sudo

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

Overview

Class: sudo

This module manages sudo

Parameters:

[*ensure*]
  Ensure if present or absent.
  Default: present

[*package*]
  Name of the package.
  Only set this, if your platform is not supported or you know,
  what you're doing.
  Default: auto-set, platform specific

[*package_ensure*]
  Allows you to ensure a particular version of a package
  Default: present / lastest for RHEL < 5.5

[*package_source*]
  Where to find the package.  Only set this on AIX (required) and
  Solaris (required) or if your platform is not supported or you
  know, what you're doing.

  The default for aix is the perzl sudo package. For solaris 10 we
  use the official www.sudo.ws binary package.

  Default: AIX: perzl.org
           Solaris: www.sudo.ws

[*package_provider*]
  Allows you to set a package provider.
  Default: AIX: rpm

[*package_admin_file*]
  Where to find a Solaris 10 package admin file for
  an unattended installation. We do not supply a default file, so
  this has to be staged separately

  Only set this on Solaris 10 (required)
  Default: /var/sadm/install/admin/puppet

[*secure_path*]
  The secure_path variable in sudoers.
  Default: auto-set, platform specific

[*purge*]
  Whether or not to purge sudoers.d directory
  Default: true

[*purge_ignore*]
  Files to exclude from purging in sudoers.d directory
  Default: undef

[*suffix*]
  Adds a custom suffix to all files created in sudoers.d directory.

[*config_file*]
  Main configuration file.
  Only set this, if your platform is not supported or you know,
  what you're doing.
  Default: auto-set, platform specific

[*config_dir*]
  Main directory containing sudo snippets, imported via
  includedir stanza in sudoers file
  Default: auto-set, platform specific

[*extra_include_dirs*]
  Array of additional directories containing sudo snippets
  Default: undef

[*content*]
  Alternate content file location
  Only set this, if your platform is not supported or you know,
  what you're doing.
  Default: auto-set, platform specific

[*ldap_enable*]
  Enable ldap support on the package
  Default: false

[*delete_on_error*]
  True if you want that the configuration is deleted on an error
  during a complete visudo -c run. If false it will just return
  an error and will add a comment to the sudoers configuration so
  that the resource will be checked at the following run.
  Default: true

[*validate_single*]
  Do a validate on the "single" file in the sudoers.d directory.
  If the validate fail the file will not be saved or changed
  if a file already exist.
  Default: false

[*wheel_config*]
  How to configure the wheel group in /etc/sudoers
  Options are either not to configure it it, configure it prompting for password,
  or configuring it without password prompt.
  Default: 'absent' (don't configure it at all)

[*use_sudoreplay*]
  Boolean to enable the usage of sudoreplay.
  Default: false

[*sudoreplay_discard*]
  Array of additional command to discard in sudo log.
  Default: undef

[*configs*]
  A hash of sudo::conf's
  Default: {}

Actions:

Installs sudo package and checks the state of sudoers file and
sudoers.d directory.

Requires:

Nothing

Sample Usage:

class { 'sudo': }
Remember: No empty lines between comments and class definition

Parameters:

  • enable (Boolean) (defaults to: true)
  • package (Optional[String]) (defaults to: $sudo::params::package)
  • package_ldap (Optional[String]) (defaults to: $sudo::params::package_ldap)
  • package_ensure (String) (defaults to: $sudo::params::package_ensure)
  • package_source (Optional[String]) (defaults to: $sudo::params::package_source)
  • package_provider (Optional[String]) (defaults to: $sudo::params::package_provider)
  • package_admin_file (Optional[String]) (defaults to: $sudo::params::package_admin_file)
  • purge (Boolean) (defaults to: true)
  • purge_ignore (Optional[Variant[String, Array[String]]]) (defaults to: undef)
  • suffix (Optional[String]) (defaults to: undef)
  • config_file (String) (defaults to: $sudo::params::config_file)
  • config_file_replace (Boolean) (defaults to: true)
  • config_file_mode (String) (defaults to: $sudo::params::config_file_mode)
  • config_dir (String) (defaults to: $sudo::params::config_dir)
  • config_dir_mode (String) (defaults to: $sudo::params::config_dir_mode)
  • extra_include_dirs (Optional[Array[String]]) (defaults to: undef)
  • content (String) (defaults to: $sudo::params::content)
  • secure_path (Optional[String]) (defaults to: $sudo::params::secure_path)
  • ldap_enable (Boolean) (defaults to: false)
  • delete_on_error (Boolean) (defaults to: true)
  • validate_single (Boolean) (defaults to: false)
  • config_dir_keepme (Boolean) (defaults to: $sudo::params::config_dir_keepme)
  • use_sudoreplay (Boolean) (defaults to: false)
  • wheel_config (Enum['absent','password','nopassword']) (defaults to: 'absent')
  • sudoreplay_discard (Optional[Array[String]]) (defaults to: undef)
  • configs (Hash) (defaults to: {}) 


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
 
# File 'manifests/init.pp', line 125

class sudo (
  Boolean                                   $enable              = true,
  Optional[String]                          $package             = $sudo::params::package,
  Optional[String]                          $package_ldap        = $sudo::params::package_ldap,
  String                                    $package_ensure      = $sudo::params::package_ensure,
  Optional[String]                          $package_source      = $sudo::params::package_source,
  Optional[String]                          $package_provider    = $sudo::params::package_provider,
  Optional[String]                          $package_admin_file  = $sudo::params::package_admin_file,
  Boolean                                   $purge               = true,
  Optional[Variant[String, Array[String]]]  $purge_ignore        = undef,
  Optional[String]                          $suffix              = undef,
  String                                    $config_file         = $sudo::params::config_file,
  Boolean                                   $config_file_replace = true,
  String                                    $config_file_mode    = $sudo::params::config_file_mode,
  String                                    $config_dir          = $sudo::params::config_dir,
  String                                    $config_dir_mode     = $sudo::params::config_dir_mode,
  Optional[Array[String]]                   $extra_include_dirs  = undef,
  String                                    $content             = $sudo::params::content,
  Optional[String]                          $secure_path         = $sudo::params::secure_path,
  Boolean                                   $ldap_enable         = false,
  Boolean                                   $delete_on_error     = true,
  Boolean                                   $validate_single     = false,
  Boolean                                   $config_dir_keepme   = $sudo::params::config_dir_keepme,
  Boolean                                   $use_sudoreplay      = false,
  Enum['absent','password','nopassword']    $wheel_config        = 'absent',
  Optional[Array[String]]                   $sudoreplay_discard  = undef,
  Hash                                      $configs             = {},
) inherits sudo::params {
  case $enable {
    true: {
      $dir_ensure  = 'directory'
      $file_ensure = 'present'
    }
    false: {
      $dir_ensure  = 'absent'
      $file_ensure = 'absent'
    }
    default: { fail('no $enable is set') }
  }

  case $ldap_enable {
    true: {
      if $package_ldap == undef {
        fail('on your os ldap support for sudo is not yet supported')
      }
      $package_real = $package_ldap
    }
    false: {
      $package_real = $package
    }
    default: { fail('no $ldap_enable is set') }
  }
  if $package_real {
    class { 'sudo::package':
      package            => $package_real,
      package_ensure     => $package_ensure,
      package_source     => $package_source,
      package_provider   => $package_provider,
      package_admin_file => $package_admin_file,
      ldap_enable        => $ldap_enable,
      before             => [
        File[$config_file],
        File[$config_dir],
      ],
    }
  }

  file { $config_file:
    ensure  => $file_ensure,
    owner   => 'root',
    group   => $sudo::params::config_file_group,
    mode    => $config_file_mode,
    replace => $config_file_replace,
    content => template($content),
  }

  file { $config_dir:
    ensure  => $dir_ensure,
    owner   => 'root',
    group   => $sudo::params::config_file_group,
    mode    => $config_dir_mode,
    recurse => $purge,
    purge   => $purge,
    ignore  => $purge_ignore,
  }

  if $config_dir_keepme {
    file { "${config_dir}/.keep-me":
      ensure => file,
      owner  => 'root',
      group  => $sudo::params::config_file_group,
    }
  }

  $configs.each |$config_name, $config| {
    sudo::conf { $config_name:
      * => $config,
    }
  }
}