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
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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
|
# File 'manifests/server/grant.pp', line 21
define postgresql::server::grant (
String $role,
String $db,
String $privilege = '', # lint:ignore:params_empty_string_assignment
Pattern[#/(?i:^COLUMN$)/,
/(?i:^ALL SEQUENCES IN SCHEMA$)/,
/(?i:^ALL TABLES IN SCHEMA$)/,
/(?i:^DATABASE$)/,
#/(?i:^FOREIGN DATA WRAPPER$)/,
#/(?i:^FOREIGN SERVER$)/,
/(?i:^FUNCTION$)/,
/(?i:^LANGUAGE$)/,
#/(?i:^PROCEDURAL LANGUAGE$)/,
/(?i:^TABLE$)/,
#/(?i:^TABLESPACE$)/,
/(?i:^SCHEMA$)/,
/(?i:^SEQUENCE$)/
#/(?i:^VIEW$)/
] $object_type = 'database',
Optional[Variant[Array[String,2,2],String[1]]] $object_name = undef,
Array[String[1],0] $object_arguments = [],
String $psql_db = $postgresql::server::default_database,
String $psql_user = $postgresql::server::user,
Variant[String[1], Stdlib::Port] $port = $postgresql::server::port,
Boolean $onlyif_exists = false,
Hash $connect_settings = $postgresql::server::default_connect_settings,
Enum['present', 'absent'] $ensure = 'present',
String $group = $postgresql::server::group,
Variant[String[1], Stdlib::Absolutepath] $psql_path = $postgresql::server::psql_path,
) {
if $port =~ String {
deprecation('postgres_port', 'Passing a string to the port parameter is deprecated. Stdlib::Port will be the enforced datatype in the next major release')
}
case $ensure {
default: {
# default is 'present'
$sql_command = 'GRANT %s ON %s "%s%s" TO %s'
$sql_command_unquoted = 'GRANT %s ON %s %s%s TO %s'
$unless_is = true
}
'absent': {
$sql_command = 'REVOKE %s ON %s "%s%s" FROM %s'
$sql_command_unquoted = 'REVOKE %s ON %s %s%s FROM %s'
$unless_is = false
}
}
# Quote the role if not PUBLIC
$_query_role = $role ? {
'PUBLIC' => 'PUBLIC',
default => "\"${role}\""
}
if ! $object_name {
$_object_name = $db
} else {
$_object_name = $object_name
}
#
# Port, order of precedence: $port parameter, $connect_settings[PGPORT], $postgresql::server::port
#
if $port != undef {
$port_override = $port
} elsif $connect_settings != undef and 'PGPORT' in $connect_settings {
$port_override = undef
} else {
$port_override = $postgresql::server::port
}
## Munge the input values
$_object_type = upcase($object_type)
$_privilege = upcase($privilege)
# You can use ALL TABLES IN SCHEMA by passing schema_name to object_name
# You can use ALL SEQUENCES IN SCHEMA by passing schema_name to object_name
## Validate that the object type's privilege is acceptable
# TODO: this is a terrible hack; if they pass "ALL" as the desired privilege,
# we need a way to test for it--and has_database_privilege does not
# recognize 'ALL' as a valid privilege name. So we probably need to
# hard-code a mapping between 'ALL' and the list of actual privileges that
# it entails, and loop over them to check them. That sort of thing will
# probably need to wait until we port this over to ruby, so, for now, we're
# just going to assume that if they have "CREATE" privileges on a database,
# then they have "ALL". (I told you that it was terrible!)
case $_object_type {
'DATABASE': {
$unless_privilege = $_privilege ? {
'ALL' => 'CREATE',
'ALL PRIVILEGES' => 'CREATE',
Pattern[
/^$/,
/^CONNECT$/,
/^CREATE$/,
/^TEMP$/,
/^TEMPORARY$/,
] => $_privilege,
default => fail('Illegal value for $privilege parameter'),
}
$unless_function = 'has_database_privilege'
$on_db = $psql_db
$onlyif_function = $ensure ? {
default => undef,
'absent' => 'role_exists',
}
$arguments = ''
$_enquote_object = true
}
'SCHEMA': {
$unless_privilege = $_privilege ? {
'ALL' => 'CREATE',
'ALL PRIVILEGES' => 'CREATE',
Pattern[
/^$/,
/^CREATE$/,
/^USAGE$/,
] => $_privilege,
default => fail('Illegal value for $privilege parameter'),
}
$unless_function = 'has_schema_privilege'
$on_db = $db
$onlyif_function = undef
$arguments = ''
$_enquote_object = true
}
'SEQUENCE': {
$unless_privilege = $_privilege ? {
'ALL' => 'USAGE',
Pattern[
/^$/,
/^ALL PRIVILEGES$/,
/^SELECT$/,
/^UPDATE$/,
/^USAGE$/,
] => $_privilege,
default => fail('Illegal value for $privilege parameter'),
}
$unless_function = 'has_sequence_privilege'
$on_db = $db
$onlyif_function = undef
$arguments = ''
$_enquote_object = true
}
'ALL SEQUENCES IN SCHEMA': {
case $_privilege {
Pattern[
/^$/,
/^ALL$/,
/^ALL PRIVILEGES$/,
/^SELECT$/,
/^UPDATE$/,
/^USAGE$/,
]: {}
default: { fail('Illegal value for $privilege parameter') }
}
$unless_function = 'custom'
$on_db = $db
$onlyif_function = undef
$arguments = ''
$_enquote_object = true
$schema = $object_name
$custom_privilege = $_privilege ? {
'ALL' => 'USAGE',
'ALL PRIVILEGES' => 'USAGE',
default => $_privilege,
}
# This checks if there is a difference between the sequences in the
# specified schema and the sequences for which the role has the specified
# privilege. It uses the EXCEPT clause which computes the set of rows
# that are in the result of the first SELECT statement but not in the
# result of the second one. It then counts the number of rows from this
# operation. If this number is zero then the role has the specified
# privilege for all sequences in the schema and the whole query returns a
# single row, which satisfies the `unless` parameter of Postgresql_psql.
# If this number is not zero then there is at least one sequence for which
# the role does not have the specified privilege, making it necessary to
# execute the GRANT statement.
if $ensure == 'present' {
$custom_unless = "SELECT 1 WHERE NOT EXISTS (
SELECT sequence_name
FROM information_schema.sequences
WHERE sequence_schema='${schema}'
EXCEPT DISTINCT
SELECT object_name as sequence_name
FROM (
SELECT object_schema,
object_name,
grantee,
CASE privs_split
WHEN 'r' THEN 'SELECT'
WHEN 'w' THEN 'UPDATE'
WHEN 'U' THEN 'USAGE'
END AS privilege_type
FROM (
SELECT DISTINCT
object_schema,
object_name,
regexp_replace((regexp_split_to_array(regexp_replace(privs,E'/.*',''),'='))[1],'\"','','g') AS grantee,
regexp_split_to_table((regexp_split_to_array(regexp_replace(privs,E'/.*',''),'='))[2],E'\\s*') AS privs_split
FROM (
SELECT n.nspname as object_schema,
c.relname as object_name,
regexp_split_to_table(array_to_string(c.relacl,','),',') AS privs
FROM pg_catalog.pg_class c
LEFT JOIN pg_catalog.pg_namespace n ON c.relnamespace = n.oid
WHERE c.relkind = 'S'
AND n.nspname NOT IN ( 'pg_catalog', 'information_schema' )
) P1
) P2
) P3
WHERE grantee='${role}'
AND object_schema='${schema}'
AND privilege_type='${custom_privilege}'
)"
} else {
# ensure == absent
$custom_unless = "SELECT 1 WHERE NOT EXISTS (
SELECT object_name as sequence_name
FROM (
SELECT object_schema,
object_name,
grantee,
CASE privs_split
WHEN 'r' THEN 'SELECT'
WHEN 'w' THEN 'UPDATE'
WHEN 'U' THEN 'USAGE'
END AS privilege_type
FROM (
SELECT DISTINCT
object_schema,
object_name,
regexp_replace((regexp_split_to_array(regexp_replace(privs,E'/.*',''),'='))[1],'\"','','g') AS grantee,
regexp_split_to_table((regexp_split_to_array(regexp_replace(privs,E'/.*',''),'='))[2],E'\\s*') AS privs_split
FROM (
SELECT n.nspname as object_schema,
c.relname as object_name,
regexp_split_to_table(array_to_string(c.relacl,','),',') AS privs
FROM pg_catalog.pg_class c
LEFT JOIN pg_catalog.pg_namespace n ON c.relnamespace = n.oid
WHERE c.relkind = 'S'
AND n.nspname NOT IN ( 'pg_catalog', 'information_schema' )
) P1
) P2
) P3
WHERE grantee='${role}'
AND object_schema='${schema}'
AND privilege_type='${custom_privilege}'
)"
}
}
'TABLE': {
$unless_privilege = $_privilege ? {
'ALL' => 'INSERT',
Pattern[
/^$/,
/^ALL$/,
/^ALL PRIVILEGES$/,
/^DELETE$/,
/^INSERT$/,
/^REFERENCES$/,
/^SELECT$/,
/^TRIGGER$/,
/^TRUNCATE$/,
/^UPDATE$/,
] => $_privilege,
default => fail('Illegal value for $privilege parameter'),
}
$unless_function = 'has_table_privilege'
$on_db = $db
$onlyif_function = $onlyif_exists ? {
true => 'table_exists',
default => undef,
}
$arguments = ''
$_enquote_object = true
}
'ALL TABLES IN SCHEMA': {
case $_privilege {
Pattern[
/^$/,
/^ALL$/,
/^ALL PRIVILEGES$/,
/^DELETE$/,
/^INSERT$/,
/^REFERENCES$/,
/^SELECT$/,
/^TRIGGER$/,
/^TRUNCATE$/,
/^UPDATE$/,
]: {}
default: { fail('Illegal value for $privilege parameter') }
}
$unless_function = 'custom'
$on_db = $db
$onlyif_function = undef
$arguments = ''
$_enquote_object = true
$schema = $object_name
# Again there seems to be no easy way in plain SQL to check if ALL
# PRIVILEGES are granted on a table.
# There are currently 7 possible priviliges:
# ('SELECT','UPDATE','INSERT','DELETE','TRIGGER','REFERENCES','TRUNCATE')
# This list is consistant from Postgresql 8.0
#
# There are 4 cases to cover, each with it's own distinct unless clause:
# grant ALL
# grant SELECT (or INSERT or DELETE ...)
# revoke ALL
# revoke SELECT (or INSERT or DELETE ...)
if $ensure == 'present' {
if $_privilege == 'ALL' or $_privilege == 'ALL PRIVILEGES' {
# GRANT ALL
# lint:ignore:140chars
$custom_unless = "SELECT 1 WHERE NOT EXISTS
( SELECT 1 FROM
( SELECT t.tablename,count(privilege_type) AS priv_count FROM pg_catalog.pg_tables AS t
LEFT JOIN information_schema.role_table_grants AS g ON t.tablename = g.table_name AND g.grantee = '${role}' AND g.table_schema = '${schema}'
WHERE t.schemaname = '${schema}' AND
( g.grantee = '${role}' AND privilege_type IN ('SELECT','UPDATE','INSERT','DELETE','TRIGGER','REFERENCES','TRUNCATE') OR privilege_type IS NULL )
GROUP BY t.tablename
) AS j WHERE j.priv_count < 7
)"
# lint:endignore:140chars
} else {
# GRANT $_privilege
# lint:ignore:140chars
$custom_unless = "SELECT 1 WHERE NOT EXISTS
( SELECT 1 FROM pg_catalog.pg_tables AS t
LEFT JOIN information_schema.role_table_grants AS g ON t.tablename = g.table_name AND g.grantee = '${role}' AND g.table_schema = '${schema}' AND g.privilege_type = '${_privilege}'
WHERE t.schemaname = '${schema}' AND g.table_name IS NULL
)"
# lint:endignore:140chars
}
} else {
if $_privilege == 'ALL' or $_privilege == 'ALL PRIVILEGES' {
# REVOKE ALL
$custom_unless = "SELECT 1 WHERE NOT EXISTS
( SELECT table_name FROM information_schema.role_table_grants
WHERE grantee = '${role}' AND table_schema ='${schema}'
)"
} else {
# REVOKE $_privilege
$custom_unless = "SELECT 1 WHERE NOT EXISTS
( SELECT table_name FROM information_schema.role_table_grants
WHERE grantee = '${role}' AND table_schema ='${schema}'
AND privilege_type = '${_privilege}'
)"
}
}
}
'LANGUAGE': {
$unless_privilege = $_privilege ? {
'ALL' => 'USAGE',
'ALL PRIVILEGES' => 'USAGE',
Pattern[
/^$/,
/^CREATE$/,
/^USAGE$/,
] => $_privilege,
default => fail('Illegal value for $privilege parameter'),
}
$unless_function = 'has_language_privilege'
$on_db = $db
$onlyif_function = $onlyif_exists ? {
true => 'language_exists',
default => undef,
}
$arguments = ''
$_enquote_object = false
}
'FUNCTION': {
$unless_privilege = $_privilege ? {
'ALL' => 'EXECUTE',
'ALL PRIVILEGES' => 'EXECUTE',
Pattern[
/^$/,
/^EXECUTE$/,
] => $_privilege,
default => fail('Illegal value for $privilege parameter'),
}
$unless_function = 'has_function_privilege'
$on_db = $db
$onlyif_function = $onlyif_exists ? {
true => 'function_exists',
default => undef,
}
$_joined_args = join($object_arguments, ',')
$arguments = "(${_joined_args})"
$_enquote_object = false
}
default: {
fail("Missing privilege validation for object type ${_object_type}")
}
}
# This is used to give grant to "schemaname"."tablename"
# If you need such grant, use:
# postgresql::grant { 'table:foo':
# role => 'joe',
# ...
# object_type => 'TABLE',
# object_name => [$schema, $table],
# }
case $_object_name {
Array: {
$_togrant_object = $_enquote_object ? {
false => join($_object_name, '.'),
default => join($_object_name, '"."'),
}
# Never put double quotes into has_*_privilege function
$_granted_object = join($_object_name, '.')
# pg_* views does not contain schema name as part of the object name
$_togrant_object_only = $_object_name[1]
}
default: {
$_granted_object = $_object_name
$_togrant_object = $_object_name
# if $_togrant_object_only not set, set it to a default value $_togrant_object
# allows an Array or String to be passed as $_object_name i.e. [$schema, $table] or $table
$_togrant_object_only = $_togrant_object
}
}
# Function like has_database_privilege() refer the PUBLIC pseudo role as 'public'
# So we need to replace 'PUBLIC' by 'public'.
$_unless = $unless_function ? {
false => undef,
'custom' => $custom_unless,
default => $role ? {
'PUBLIC' => "SELECT 1 WHERE ${unless_function}('public', '${_granted_object}${arguments}', '${unless_privilege}') = ${unless_is}",
default => "SELECT 1 WHERE ${unless_function}('${role}', '${_granted_object}${arguments}', '${unless_privilege}') = ${unless_is}",
}
}
$_onlyif = $onlyif_function ? {
'table_exists' => "SELECT true FROM pg_tables WHERE tablename = '${_togrant_object_only}'",
'language_exists' => "SELECT true from pg_language WHERE lanname = '${_togrant_object_only}'",
'role_exists' => "SELECT 1 FROM pg_roles WHERE rolname = '${role}' or '${role}' = 'PUBLIC'",
'function_exists' => "SELECT true FROM pg_proc WHERE (oid::regprocedure)::text = '${_togrant_object_only}${arguments}'",
default => undef,
}
$grant_cmd = $_enquote_object ? {
false => sprintf($sql_command_unquoted, $_privilege, $_object_type, $_togrant_object, $arguments, $_query_role),
default => sprintf($sql_command, $_privilege, $_object_type, $_togrant_object, $arguments, $_query_role),
}
postgresql_psql { "grant:${name}":
command => $grant_cmd,
db => $on_db,
port => $port_override,
connect_settings => $connect_settings,
psql_user => $psql_user,
psql_group => $group,
psql_path => $psql_path,
unless => $_unless,
onlyif => $_onlyif,
}
if($role != undef and defined(Postgresql::Server::Role[$role])) {
Postgresql::Server::Role[$role] -> Postgresql_psql["grant:${name}"]
}
if($db != undef and defined(Postgresql::Server::Database[$db])) {
Postgresql::Server::Database[$db] -> Postgresql_psql["grant:${name}"]
}
}
|