Class: Posgra::Driver

Inherits:
Object
  • Object
show all
Includes:
Logger::Helper, Utils::Helper
Defined in:
lib/posgra/driver.rb

Constant Summary collapse

DEFAULT_ACL_PRIVS = 
ENV['POSGRA_DEFAULT_ACL_PRIVS'] || 'arwdDxt'
DEFAULT_ACL = 
"{%s=#{DEFAULT_ACL_PRIVS}/%s}"
DEFAULT_DATABASE_ACL = 
"{%s=CTc/%s}"
DEFAULT_ACL_BY_KIND = 
{
  'S' => '{%s=rwU/%s}'
}
PRIVILEGE_TYPES = 
{
  'a' => 'INSERT',
  'r' => 'SELECT',
  'w' => 'UPDATE',
  'd' => 'DELETE',
  'D' => 'TRUNCATE',
  'x' => 'REFERENCES',
  't' => 'TRIGGER',
  'U' => 'USAGE',
  'R' => 'RULE',
  'X' => 'EXECUTE',
  'C' => 'CREATE',
  'c' => 'CONNECT',
  'T' => 'TEMPORARY',
}

Instance Method Summary collapse

Methods included from Utils::Helper

#matched?

Methods included from Logger::Helper

#log

Constructor Details

#initialize(client, options = {}) ⇒ Driver

Returns a new instance of Driver.



30
31
32
33
34
35
36
37
38
 
# File 'lib/posgra/driver.rb', line 30

def initialize(client, options = {})
  unless client.type_map_for_results.is_a?(PG::TypeMapAllStrings)
    raise 'PG::Connection#type_map_for_results must be PG::TypeMapAllStrings'
  end

  @client = client
  @options = options
  @identifier = options.fetch(:identifier)
end

Instance Method Details

#add_user_to_group(user, group) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/posgra/driver.rb', line 83

def add_user_to_group(user, group)
  updated = false

  sql = "ALTER GROUP #{@client.escape_identifier(group)} ADD USER #{@client.escape_identifier(user)}"
  log(:info, sql, :color => :green)

  unless @options[:dry_run]
    exec(sql)
    updated = true
  end

  updated
end

#create_group(group) ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/posgra/driver.rb', line 69

def create_group(group)
  updated = false

  sql = "CREATE GROUP #{@client.escape_identifier(group)}"
  log(:info, sql, :color => :cyan)

  unless @options[:dry_run]
    exec(sql)
    updated = true
  end

  updated
end

#create_user(user) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/posgra/driver.rb', line 40

def create_user(user)
  updated = false

  password =  @identifier.identify(user)
  sql = "CREATE USER #{@client.escape_identifier(user)} PASSWORD #{@client.escape_literal(password)}"
  log(:info, sql, :color => :cyan)

  unless @options[:dry_run]
    exec(sql)
    updated = true
  end

  updated
end

#database_grant(role, priv, options, database) ⇒ Object 



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/posgra/driver.rb', line 234

def database_grant(role, priv, options, database)
  updated = false

  sql = "GRANT #{priv} ON DATABASE #{@client.escape_identifier(database)} TO #{@client.escape_identifier(role)}"

  if options['is_grantable']
    sql << ' WITH GRANT OPTION'
  end

  log(:info, sql, :color => :green)

  unless @options[:dry_run]
    exec(sql)
    updated = true
  end

  updated
end

#database_revoke(role, priv, database) ⇒ Object 



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/posgra/driver.rb', line 293

def database_revoke(role, priv, database)
  updated = false

  sql = "REVOKE #{priv} ON DATABASE #{@client.escape_identifier(database)} FROM #{@client.escape_identifier(role)}"
  log(:info, sql, :color => :green)

  unless @options[:dry_run]
    exec(sql)
    updated = true
  end

  updated
end

#describe_databases ⇒ Object 



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
 
# File 'lib/posgra/driver.rb', line 409

def describe_databases
  rs = exec <<-SQL
    SELECT
      pg_database.datname,
      pg_database.datacl,
      pg_user.usename
    FROM
      pg_database
      INNER JOIN pg_user ON pg_database.datdba = pg_user.usesysid
  SQL

  database_grants_by_role = {}

  rs.each do |row|
    datname = row.fetch('datname')
    datacl = row.fetch('datacl')
    usename = row.fetch('usename')

    next unless matched?(datname, @options[:include_database], @options[:exclude_database])

    parse_database_aclitems(datacl, usename).each do |aclitem|
      role = aclitem.fetch('grantee')
      privs = aclitem.fetch('privileges')
      next unless matched?(role, @options[:include_role], @options[:exclude_role])
      database_grants_by_role[role] ||= {}
      database_grants_by_role[role][datname] = privs
    end
  end

  database_grants_by_role
end

#describe_grants ⇒ Object 



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
 
# File 'lib/posgra/driver.rb', line 368

def describe_grants
  rs = exec <<-SQL
    SELECT
      pg_class.relname,
      pg_namespace.nspname,
      pg_class.relacl,
      pg_user.usename,
      pg_class.relkind
    FROM
      pg_class
      INNER JOIN pg_namespace ON pg_class.relnamespace = pg_namespace.oid
      INNER JOIN pg_user ON pg_class.relowner = pg_user.usesysid
    WHERE
      pg_class.relkind NOT IN ('i')
  SQL

  grants_by_role = {}

  rs.each do |row|
    relname = row.fetch('relname')
    nspname = row.fetch('nspname')
    relacl = row.fetch('relacl')
    usename = row.fetch('usename')
    relkind = row.fetch('relkind')

    next unless matched?(relname, @options[:include_object], @options[:exclude_object])
    next unless matched?(nspname, @options[:include_schema], @options[:exclude_schema])

    parse_aclitems(relacl, usename, relkind).each do |aclitem|
      role = aclitem.fetch('grantee')
      privs = aclitem.fetch('privileges')
      next unless matched?(role, @options[:include_role], @options[:exclude_role])
      grants_by_role[role] ||= {}
      grants_by_role[role][nspname] ||= {}
      grants_by_role[role][nspname][relname] = privs
    end
  end

  grants_by_role
end

#describe_groups ⇒ Object 



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/posgra/driver.rb', line 345

def describe_groups
  rs = exec <<-SQL
    SELECT
      pg_group.groname,
      pg_user.usename
    FROM
      pg_group
      LEFT JOIN pg_user ON pg_user.usesysid = ANY(pg_group.grolist)
  SQL

  users_by_group = {}

  rs.each do |row|
    group = row.fetch('groname')
    user = row.fetch('usename')
    next unless [group, user].any? {|i| not i.nil? and matched?(i, @options[:include_role], @options[:exclude_role]) }
    users_by_group[group] ||= []
    users_by_group[group] << user if user
  end

  users_by_group
end

#describe_objects(schema) ⇒ Object 



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/posgra/driver.rb', line 307

def describe_objects(schema)
  rs = exec <<-SQL
    SELECT
      pg_class.relname,
      pg_namespace.nspname
    FROM
      pg_class
      INNER JOIN pg_namespace ON pg_class.relnamespace = pg_namespace.oid
    WHERE
      pg_namespace.nspname = #{@client.escape_literal(schema)}
      AND pg_class.relkind NOT IN ('i')
  SQL

  objects = []

  rs.each do |row|
    relname = row.fetch('relname')
    next unless matched?(relname, @options[:include_object], @options[:exclude_object])
    objects << relname
  end

  objects
end

#describe_users ⇒ Object 



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/posgra/driver.rb', line 331

def describe_users
  rs = exec('SELECT * FROM pg_user')

  options_by_user = {}

  rs.each do |row|
    user = row.fetch('usename')
    next unless matched?(user, @options[:include_role], @options[:exclude_role])
    options_by_user[user] = row.select {|_, v| v == 't' }.keys
  end

  options_by_user
end

#drop_group(group) ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/posgra/driver.rb', line 111

def drop_group(group)
  updated = false

  sql = "DROP GROUP #{@client.escape_identifier(group)}"
  log(:info, sql, :color => :red)

  unless @options[:dry_run]
    exec(sql)
    updated = true
  end

  updated
end

#drop_user(user) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/posgra/driver.rb', line 55

def drop_user(user)
  updated = false

  sql = "DROP USER #{@client.escape_identifier(user)}"
  log(:info, sql, :color => :red)

  unless @options[:dry_run]
    exec(sql)
    updated = true
  end

  updated
end

#drop_user_from_group(user, group) ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/posgra/driver.rb', line 97

def drop_user_from_group(user, group)
  updated = false

  sql = "ALTER GROUP #{@client.escape_identifier(group)} DROP USER #{@client.escape_identifier(user)}"
  log(:info, sql, :color => :cyan)

  unless @options[:dry_run]
    exec(sql)
    updated = true
  end

  updated
end

#grant(role, priv, options, schema, object) ⇒ Object 



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/posgra/driver.rb', line 161

def grant(role, priv, options, schema, object)
  updated = false

  sql = "GRANT #{priv} ON #{@client.escape_identifier(schema)}.#{@client.escape_identifier(object)} TO #{@client.escape_identifier(role)}"

  if options['is_grantable']
    sql << ' WITH GRANT OPTION'
  end

  log(:info, sql, :color => :green)

  unless @options[:dry_run]
    exec(sql)
    updated = true
  end

  updated
end

#grant_database_grant_option(role, priv, database) ⇒ Object 



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/posgra/driver.rb', line 265

def grant_database_grant_option(role, priv, database)
  updated = false

  sql = "GRANT #{priv} ON DATABASE #{@client.escape_identifier(database)} TO #{@client.escape_identifier(role)} WITH GRANT OPTION"
  log(:info, sql, :color => :green)

  unless @options[:dry_run]
    exec(sql)
    updated = true
  end

  updated
end

#grant_grant_option(role, priv, schema, object) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/posgra/driver.rb', line 192

def grant_grant_option(role, priv, schema, object)
  updated = false

  sql = "GRANT #{priv} ON #{@client.escape_identifier(schema)}.#{@client.escape_identifier(object)} TO #{@client.escape_identifier(role)} WITH GRANT OPTION"
  log(:info, sql, :color => :green)

  unless @options[:dry_run]
    exec(sql)
    updated = true
  end

  updated
end

#revoke(role, priv, schema, object) ⇒ Object 



220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/posgra/driver.rb', line 220

def revoke(role, priv, schema, object)
  updated = false

  sql = "REVOKE #{priv} ON #{@client.escape_identifier(schema)}.#{@client.escape_identifier(object)} FROM #{@client.escape_identifier(role)}"
  log(:info, sql, :color => :green)

  unless @options[:dry_run]
    exec(sql)
    updated = true
  end

  updated
end

#revoke_all_on_database(role, database) ⇒ Object 



149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/posgra/driver.rb', line 149

def revoke_all_on_database(role, database)
  sql = "REVOKE ALL ON DATABASE #{@client.escape_identifier(database)} FROM #{@client.escape_identifier(role)}"
  log(:info, sql, :color => :green)

  unless @options[:dry_run]
    exec(sql)
    updated = true
  end

  updated
end

#revoke_all_on_object(role, schema, object) ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/posgra/driver.rb', line 135

def revoke_all_on_object(role, schema, object)
  updated = false

  sql = "REVOKE ALL ON #{@client.escape_identifier(schema)}.#{@client.escape_identifier(object)} FROM #{@client.escape_identifier(role)}"
  log(:info, sql, :color => :green)

  unless @options[:dry_run]
    exec(sql)
    updated = true
  end

  updated
end

#revoke_all_on_schema(role, schema) ⇒ Object 



125
126
127
128
129
130
131
132
133
 
# File 'lib/posgra/driver.rb', line 125

def revoke_all_on_schema(role, schema)
  updated = false

  describe_objects(schema).each do |object|
    updated = revoke_all_on_object(role, schema, object) || updated
  end

  updated
end

#roveke_database_grant_option(role, priv, database) ⇒ Object 



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/posgra/driver.rb', line 279

def roveke_database_grant_option(role, priv, database)
  updated = false

  sql = "REVOKE GRANT OPTION FOR #{priv} ON DATABASE #{@client.escape_identifier(database)} FROM #{@client.escape_identifier(role)}"
  log(:info, sql, :color => :green)

  unless @options[:dry_run]
    exec(sql)
    updated = true
  end

  updated
end

#roveke_grant_option(role, priv, schema, object) ⇒ Object 



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/posgra/driver.rb', line 206

def roveke_grant_option(role, priv, schema, object)
  updated = false

  sql = "REVOKE GRANT OPTION FOR #{priv} ON #{@client.escape_identifier(schema)}.#{@client.escape_identifier(object)} FROM #{@client.escape_identifier(role)}"
  log(:info, sql, :color => :green)

  unless @options[:dry_run]
    exec(sql)
    updated = true
  end

  updated
end

#update_database_grant_options(role, priv, options, database) ⇒ Object 



253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/posgra/driver.rb', line 253

def update_database_grant_options(role, priv, options, database)
  updated = false

  if options.fetch('is_grantable')
    updated = grant_database_grant_option(role, priv, database)
  else
    updated = roveke_database_grant_option(role, priv, database)
  end

  updated
end

#update_grant_options(role, priv, options, schema, object) ⇒ Object 



180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/posgra/driver.rb', line 180

def update_grant_options(role, priv, options, schema, object)
  updated = false

  if options.fetch('is_grantable')
    updated = grant_grant_option(role, priv, schema, object)
  else
    updated = roveke_grant_option(role, priv, schema, object)
  end

  updated
end