Defined Type: postgresql::server::role

Defined in:
manifests/server/role.pp

Summary

Define for creating a database role.

Overview

Parameters:

  • update_password (Any) (defaults to: true)

    If set to true, updates the password on changes. Set this to false to not modify the role’s password after creation.

  • password_hash (Variant[Boolean, String, Sensitive[String]]) (defaults to: false)

    Sets the hash to use during password creation.

  • createdb (Any) (defaults to: false)

    Specifies whether to grant the ability to create new databases with this role.

  • createrole (Any) (defaults to: false)

    Specifies whether to grant the ability to create new roles with this role.

  • db (Any) (defaults to: $postgresql::server::default_database)

    Database used to connect to.

  • port (Any) (defaults to: undef)

    Port to use when connecting.

  • login (Any) (defaults to: true)

    Specifies whether to grant login capability for the new role.

  • inherit (Any) (defaults to: true)

    Specifies whether to grant inherit capability for the new role.

  • superuser (Any) (defaults to: false)

    Specifies whether to grant super user capability for the new role.

  • replication (Any) (defaults to: false)

    Provides provides replication capabilities for this role if set to true.

  • connection_limit (Any) (defaults to: '-1')

    Specifies how many concurrent connections the role can make. Default value: ‘-1’, meaning no limit.

  • username (Any) (defaults to: $title)

    Defines the username of the role to create.

  • connect_settings (Any) (defaults to: $postgresql::server::default_connect_settings)

    Specifies a hash of environment variables used when connecting to a remote server.

  • ensure (Enum['present', 'absent']) (defaults to: 'present')

    Specify whether to create or drop the role. Specifying ‘present’ creates the role. Specifying ‘absent’ drops the role.

  • psql_user (Any) (defaults to: $postgresql::server::user)

    Sets the OS user to run psql

  • psql_group (Any) (defaults to: $postgresql::server::group)

    Sets the OS group to run psql

  • psql_path (Any) (defaults to: $postgresql::server::psql_path)

    Sets path to psql command

  • module_workdir (Any) (defaults to: $postgresql::server::module_workdir)

    Specifies working directory under which the psql command should be executed. May need to specify if ‘/tmp’ is on volume mounted with noexec option.

  • hash (Enum['md5', 'scram-sha-256']) (defaults to: 'md5')

    Specify the hash method for pg password

  • salt (Optional[Variant[String[1], Integer]]) (defaults to: undef)

    Specify the salt use for the scram-sha-256 encoding password (default username)



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
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
# File 'manifests/server/role.pp', line 23

define postgresql::server::role (
  $update_password = true,
  Variant[Boolean, String, Sensitive[String]] $password_hash  = false,
  $createdb         = false,
  $createrole       = false,
  $db               = $postgresql::server::default_database,
  $port             = undef,
  $login            = true,
  $inherit          = true,
  $superuser        = false,
  $replication      = false,
  $connection_limit = '-1',
  $username         = $title,
  $connect_settings = $postgresql::server::default_connect_settings,
  $psql_user        = $postgresql::server::user,
  $psql_group       = $postgresql::server::group,
  $psql_path        = $postgresql::server::psql_path,
  $module_workdir   = $postgresql::server::module_workdir,
  Enum['present', 'absent'] $ensure = 'present',
  Enum['md5', 'scram-sha-256'] $hash = 'md5',
  Optional[Variant[String[1], Integer]] $salt = undef,
) {
  $password_hash_unsensitive = if $password_hash =~ Sensitive[String] {
    $password_hash.unwrap
  } else {
    $password_hash
  }
  #
  # Port, order of precedence: $port parameter, $connect_settings[PGPORT], $postgresql::server::port
  #
  if $port != undef {
    $port_override = $port
  } elsif $connect_settings != undef and has_key( $connect_settings, 'PGPORT') {
    $port_override = undef
  } else {
    $port_override = $postgresql::server::port
  }

  # If possible use the version of the remote database, otherwise
  # fallback to our local DB version
  if $connect_settings != undef and has_key( $connect_settings, 'DBVERSION') {
    $version = $connect_settings['DBVERSION']
  } else {
    $version = $postgresql::server::_version
  }

  Postgresql_psql {
    db         => $db,
    port       => $port_override,
    psql_user  => $psql_user,
    psql_group => $psql_group,
    psql_path  => $psql_path,
    connect_settings => $connect_settings,
    cwd        => $module_workdir,
    require    => Postgresql_psql["CREATE ROLE ${username} ENCRYPTED PASSWORD ****"],
  }

  if $ensure == 'present' {
    $login_sql       = $login       ? { true => 'LOGIN',       default => 'NOLOGIN' }
    $inherit_sql     = $inherit     ? { true => 'INHERIT',     default => 'NOINHERIT' }
    $createrole_sql  = $createrole  ? { true => 'CREATEROLE',  default => 'NOCREATEROLE' }
    $createdb_sql    = $createdb    ? { true => 'CREATEDB',    default => 'NOCREATEDB' }
    $superuser_sql   = $superuser   ? { true => 'SUPERUSER',   default => 'NOSUPERUSER' }
    $replication_sql = $replication ? { true => 'REPLICATION', default => '' }
    if ($password_hash_unsensitive != false) {
      $password_sql = "ENCRYPTED PASSWORD '${password_hash_unsensitive}'"
    } else {
      $password_sql = ''
    }

    postgresql_psql { "CREATE ROLE ${username} ENCRYPTED PASSWORD ****":
      command   => Sensitive("CREATE ROLE \"${username}\" ${password_sql} ${login_sql} ${createrole_sql} ${createdb_sql} ${superuser_sql} ${replication_sql} CONNECTION LIMIT ${connection_limit}"),
      unless    => "SELECT 1 FROM pg_roles WHERE rolname = '${username}'",
      require   => undef,
      sensitive => true,
    }

    postgresql_psql { "ALTER ROLE \"${username}\" ${superuser_sql}":
      unless => "SELECT 1 FROM pg_roles WHERE rolname = '${username}' AND rolsuper = ${superuser}",
    }

    postgresql_psql { "ALTER ROLE \"${username}\" ${createdb_sql}":
      unless => "SELECT 1 FROM pg_roles WHERE rolname = '${username}' AND rolcreatedb = ${createdb}",
    }

    postgresql_psql { "ALTER ROLE \"${username}\" ${createrole_sql}":
      unless => "SELECT 1 FROM pg_roles WHERE rolname = '${username}' AND rolcreaterole = ${createrole}",
    }

    postgresql_psql { "ALTER ROLE \"${username}\" ${login_sql}":
      unless => "SELECT 1 FROM pg_roles WHERE rolname = '${username}' AND rolcanlogin = ${login}",
    }

    postgresql_psql { "ALTER ROLE \"${username}\" ${inherit_sql}":
      unless => "SELECT 1 FROM pg_roles WHERE rolname = '${username}' AND rolinherit = ${inherit}",
    }

    if(versioncmp($version, '9.1') >= 0) {
      if $replication_sql == '' {
        postgresql_psql { "ALTER ROLE \"${username}\" NOREPLICATION":
          unless => "SELECT 1 FROM pg_roles WHERE rolname = '${username}' AND rolreplication = ${replication}",
        }
      } else {
        postgresql_psql { "ALTER ROLE \"${username}\" ${replication_sql}":
          unless => "SELECT 1 FROM pg_roles WHERE rolname = '${username}' AND rolreplication = ${replication}",
        }
      }
    }

    postgresql_psql { "ALTER ROLE \"${username}\" CONNECTION LIMIT ${connection_limit}":
      unless => "SELECT 1 FROM pg_roles WHERE rolname = '${username}' AND rolconnlimit = ${connection_limit}",
    }

    if $password_hash_unsensitive and $update_password {
      if($password_hash_unsensitive =~ /^(md5|SCRAM-SHA-256).+/) {
        $pwd_hash_sql = $password_hash_unsensitive
      } else {
        $pwd_hash_sql = postgresql::postgresql_password(
          $username,
          $password_hash,
          $password_hash =~ Sensitive[String],
          $hash,
          $salt,
        )
      }
      postgresql_psql { "ALTER ROLE ${username} ENCRYPTED PASSWORD ****":
        command   => Sensitive("ALTER ROLE \"${username}\" ENCRYPTED PASSWORD '${pwd_hash_sql}'"),
        unless    => Sensitive("SELECT 1 FROM pg_shadow WHERE usename = '${username}' AND passwd = '${pwd_hash_sql}'"),
        sensitive => true,
      }
    }
  } else {
    # ensure == absent
    postgresql_psql { "DROP ROLE \"${username}\"":
      onlyif  => "SELECT 1 FROM pg_roles WHERE rolname = '${username}'",
      require => undef,
    }
  }
}