Puppet Class: adduser

Defined in:
modules/adduser/manifests/init.pp

Overview

SPDX-License-Identifier: Apache-2.0

Parameters:

  • default_shell (Stdlib::Unixpath) (defaults to: '/bin/bash')
  • default_home (Stdlib::Unixpath) (defaults to: '/home')
  • use_group_homes (Boolean) (defaults to: false)
  • use_letter_homes (Boolean) (defaults to: false)
  • skel_dir (Stdlib::Unixpath) (defaults to: '/etc/skel')
  • first_system_uid (Integer[1]) (defaults to: 100)
  • last_system_uid (Integer[1]) (defaults to: 499)
  • first_system_gid (Integer[1]) (defaults to: 100)
  • last_system_gid (Integer[1]) (defaults to: 499)
  • first_uid (Integer[1]) (defaults to: 1000)
  • last_uid (Integer[1]) (defaults to: 59999)
  • first_gid (Integer[1]) (defaults to: 1000)
  • last_gid (Integer[1]) (defaults to: 59999)
  • use_usergroups (Boolean) (defaults to: true)
  • users_gid (Integer[1]) (defaults to: 100)
  • dir_mode (Stdlib::Filemode) (defaults to: '0755')
  • home_setgid (Boolean) (defaults to: false)
  • quota_user (String) (defaults to: '')
  • skel_ignore_regex (String) (defaults to: 'dpkg-(old|new|dist|save)')
  • extra_groups (Optional[Array[String[1]]]) (defaults to: [])
  • name_regex (Optional[String[1]]) (defaults to: undef) 


2
3
4
5
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
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
65
66
67
68
69
 
# File 'modules/adduser/manifests/init.pp', line 2

class adduser (
    Stdlib::Unixpath           $default_shell     = '/bin/bash',
    Stdlib::Unixpath           $default_home      = '/home',
    Boolean                    $use_group_homes   = false,
    Boolean                    $use_letter_homes  = false,
    Stdlib::Unixpath           $skel_dir          = '/etc/skel',
    Integer[1]                 $first_system_uid  = 100,
    Integer[1]                 $last_system_uid   = 499,
    Integer[1]                 $first_system_gid  = 100,
    Integer[1]                 $last_system_gid   = 499,
    Integer[1]                 $first_uid         = 1000,
    Integer[1]                 $last_uid          = 59999,
    Integer[1]                 $first_gid         = 1000,
    Integer[1]                 $last_gid          = 59999,
    Boolean                    $use_usergroups    = true,
    Integer[1]                 $users_gid         = 100,
    Stdlib::Filemode           $dir_mode          = '0755',
    Boolean                    $home_setgid       = false,
    String                     $quota_user        = '',
    String                     $skel_ignore_regex = 'dpkg-(old|new|dist|save)',
    Optional[Array[String[1]]] $extra_groups      = [],
    Optional[String[1]]        $name_regex        = undef,
) {
    if $first_system_uid > $last_system_uid {
        fail("\$first_system_uid (${first_system_uid}) must be smaller then \$last_system_uid (${last_system_uid})")
    }
    if $first_system_gid > $last_system_gid {
        fail("\$first_system_gid (${first_system_gid}) must be smaller then \$last_system_gid (${last_system_gid})")
    }
    if $first_uid > $last_uid {
        fail("\$first_uid (${first_uid}) must be smaller then \$last_uid (${last_uid})")
    }
    if $first_gid > $last_gid {
        fail("\$first_gid (${first_gid}) must be smaller then \$last_gid (${last_gid})")
    }
    if $first_uid < $last_system_uid {
        fail("\$last_system_uid (${last_system_uid}) must be smaller then \$first_uid (${first_uid})")
    }
    if $first_gid < $last_system_gid {
        fail("\$last_system_gid (${last_system_gid}) must be smaller then \$first_gid (${first_gid})")
    }
    file {'/etc/adduser.conf':
        ensure  => file,
        mode    => '0644',
        content => template('adduser/etc/adduser.conf.erb'),
    }

    systemd::sysuser { 'sysusers-base-config':
        usertype => 'range',
        username => '-',
        id       => "${first_system_uid}-${last_system_uid}",
    }

    # For historical reasons, users in modules/admin/data/data.yaml
    # (for production) and in LDAP (for Labs) start at uid/gid 500, so
    # we need to guard against system users being created in that
    # range.
    file_line { 'login.defs-SYS_UID_MAX':
        path  => '/etc/login.defs',
        match => '#?SYS_UID_MAX\b',
        line  => "SYS_UID_MAX               ${last_system_uid}",
    }
    file_line { 'login.defs-SYS_GID_MAX':
        path  => '/etc/login.defs',
        match => '#?SYS_GID_MAX\b',
        line  => "SYS_GID_MAX               ${last_system_gid}",
    }
}