@ -78,6 +78,11 @@ options:
- Host running PostgreSQL .
- Host running PostgreSQL .
required : false
required : false
default : localhost
default : localhost
login_unix_socket :
description :
- Path to a Unix domain socket for local connections
required : false
default : null
priv :
priv :
description :
description :
- " PostgreSQL privileges string in the format: C(table:priv1,priv2) "
- " PostgreSQL privileges string in the format: C(table:priv1,priv2) "
@ -145,6 +150,7 @@ INSERT,UPDATE/table:SELECT/anothertable:ALL
''' '''
import re import re
import itertools
try : try :
import psycopg2
import psycopg2
@ -153,6 +159,19 @@ except ImportError:
else : else :
postgresqldb_found = True
postgresqldb_found = True
_flags = ( ' SUPERUSER ' , ' CREATEROLE ' , ' CREATEUSER ' , ' CREATEDB ' , ' INHERIT ' , ' LOGIN ' , ' REPLICATION ' )
VALID_FLAGS = frozenset ( itertools . chain ( _flags , ( ' NO %s ' % f for f in _flags ) ) )
VALID_PRIVS = dict ( table = frozenset ( ( ' SELECT ' , ' INSERT ' , ' UPDATE ' , ' DELETE ' , ' TRUNCATE ' , ' REFERENCES ' , ' TRIGGER ' , ' ALL ' , ' USAGE ' ) ) ,
database = frozenset ( ( ' CREATE ' , ' CONNECT ' , ' TEMPORARY ' , ' TEMP ' , ' ALL ' , ' USAGE ' ) ) ,
)
class InvalidFlagsError ( Exception ) :
pass
class InvalidPrivsError ( Exception ) :
pass
# =========================================== # ===========================================
# PostgreSQL module specific support methods. # PostgreSQL module specific support methods.
# #
@ -167,17 +186,18 @@ def user_exists(cursor, user):
return cursor . rowcount > 0
return cursor . rowcount > 0
def user_add ( cursor , user , password , role_attr_flags , encrypted , expires ) : def user_add ( cursor , user , password , role_attr_flags , encrypted , expires ) :
""" Create a new database user (role). """
""" Create a new database user (role). """
query_password_data = dict ( )
# Note: role_attr_flags escaped by parse_role_attrs and encrypted is a literal
query = ' CREATE USER " %(user)s " ' % { " user " : user }
query_password_data = dict ( password = password , expires = expires )
query = [ ' CREATE USER %(user)s ' % { " user " : pg_quote_identifier ( user , ' role ' ) } ]
if password is not None :
if password is not None :
query = query + " WITH %(crypt)s " % { " crypt " : encrypted }
query . append ( " WITH %(crypt)s " % { " crypt " : encrypted } )
query = query + " PASSWORD %(password)s "
query . append ( " PASSWORD %(password)s " )
query_password_data . update ( password = password )
if expires is not None :
if expires is not None :
query = query + " VALID UNTIL ' %(expires)s ' " % { " expires " : expires }
query . append ( " VALID UNTIL %(expires)s " )
query = query + " " + role_attr_flags
query . append ( role_attr_flags )
query = ' ' . join ( query )
cursor . execute ( query , query_password_data )
cursor . execute ( query , query_password_data )
return True
return True
@ -185,6 +205,7 @@ def user_alter(cursor, module, user, password, role_attr_flags, encrypted, expir
""" Change user password and/or attributes. Return True if changed, False otherwise. """
""" Change user password and/or attributes. Return True if changed, False otherwise. """
changed = False
changed = False
# Note: role_attr_flags escaped by parse_role_attrs and encrypted is a literal
if user == ' PUBLIC ' :
if user == ' PUBLIC ' :
if password is not None :
if password is not None :
module . fail_json ( msg = " cannot change the password for PUBLIC user " )
module . fail_json ( msg = " cannot change the password for PUBLIC user " )
@ -196,25 +217,24 @@ def user_alter(cursor, module, user, password, role_attr_flags, encrypted, expir
# Handle passwords.
# Handle passwords.
if password is not None or role_attr_flags is not None :
if password is not None or role_attr_flags is not None :
# Select password and all flag-like columns in order to verify changes.
# Select password and all flag-like columns in order to verify changes.
query_password_data = dict ( )
query_password_data = dict ( password = password , expires = expires )
select = " SELECT * FROM pg_authid where rolname= %(user)s "
select = " SELECT * FROM pg_authid where rolname= %(user)s "
cursor . execute ( select , { " user " : user } )
cursor . execute ( select , { " user " : user } )
# Grab current role attributes.
# Grab current role attributes.
current_role_attrs = cursor . fetchone ( )
current_role_attrs = cursor . fetchone ( )
alter = ' ALTER USER " %(user)s " ' % { " user " :
alter = [ ' ALTER USER %(user)s % { " user " : pg_quote_identifier( user, ' role ' ) }]
if password is not None :
if password is not None :
query_password_data . update ( password = password )
alter . append ( " WITH %(crypt)s " % { " crypt " : encrypted } )
alter = alter + " WITH %(crypt)s " % { " crypt " : encrypted }
alter . append ( " PASSWORD %(password)s " )
alter = alter + " PASSWORD %(password)s "
alter . append ( role_attr_flags )
alter = alter + " %(flags)s " % { ' flags ' : role_attr_flags }
elif role_attr_flags :
elif role_attr_flags :
alter = alter + ' WITH ' + role_attr_flags
alter . append ( ' WITH %s ' % role_attr_flags )
if expires is not None :
if expires is not None :
alter = alter + " VALID UNTIL ' %(expires)s ' " % { " exipres " : expires }
alter . append ( " VALID UNTIL %(expires)s " )
try :
try :
cursor . execute ( alter , query_password_data )
cursor . execute ( ' ' . join ( alter ) , query_password_data )
except psycopg2 . InternalError , e :
except psycopg2 . InternalError , e :
if e . pgcode == ' 25006 ' :
if e . pgcode == ' 25006 ' :
# Handle errors due to read-only transactions indicated by pgcode 25006
# Handle errors due to read-only transactions indicated by pgcode 25006
@ -240,7 +260,7 @@ def user_delete(cursor, user):
""" Try to remove a user. Returns True if successful otherwise False """
""" Try to remove a user. Returns True if successful otherwise False """
cursor . execute ( " SAVEPOINT ansible_pgsql_user_delete " )
cursor . execute ( " SAVEPOINT ansible_pgsql_user_delete " )
try :
try :
cursor . execute ( " DROP USER \" %s \" " % )
cursor . execute ( " DROP USER %s " % pg_quote_identifier( user, ' role ' ) )
except :
except :
cursor . execute ( " ROLLBACK TO SAVEPOINT ansible_pgsql_user_delete " )
cursor . execute ( " ROLLBACK TO SAVEPOINT ansible_pgsql_user_delete " )
cursor . execute ( " RELEASE SAVEPOINT ansible_pgsql_user_delete " )
cursor . execute ( " RELEASE SAVEPOINT ansible_pgsql_user_delete " )
@ -264,36 +284,20 @@ def get_table_privileges(cursor, user, table):
cursor . execute ( query , ( user , table , schema ) )
cursor . execute ( query , ( user , table , schema ) )
return set ( [ x [ 0 ] for x in cursor . fetchall ( ) ] )
return set ( [ x [ 0 ] for x in cursor . fetchall ( ) ] )
def quote_pg_identifier ( identifier ) :
"""
quote postgresql identifiers involving zero or more namespaces
"""
if ' " ' in identifier :
# the user has supplied their own quoting. we have to hope they're
# doing it right. Maybe they have an unfortunately named table
# containing a period in the name, such as: "public"."users.2013"
return identifier
tokens = identifier . strip ( ) . split ( " . " )
quoted_tokens = [ ]
for token in tokens :
quoted_tokens . append ( ' " %s " ' % ( token , ) )
return " . " . join ( quoted_tokens )
def grant_table_privilege ( cursor , user , table , priv ) : def grant_table_privilege ( cursor , user , table , priv ) :
# Note: priv escaped by parse_privs
prev_priv = get_table_privileges ( cursor , user , table )
prev_priv = get_table_privileges ( cursor , user , table )
query = ' GRANT %s ON TABLE %s TO %s ' % (
query = ' GRANT %s ON TABLE %s TO %s ' % (
priv , quote_pg_identifier( table ) , quote_pg_identifier ( user ) , )
priv , pg_quote_identifier ( table , ' table ' ) , pg_quote_identifier ( user , ' role ' ) )
cursor . execute ( query )
cursor . execute ( query )
curr_priv = get_table_privileges ( cursor , user , table )
curr_priv = get_table_privileges ( cursor , user , table )
return len ( curr_priv ) > len ( prev_priv )
return len ( curr_priv ) > len ( prev_priv )
def revoke_table_privilege ( cursor , user , table , priv ) : def revoke_table_privilege ( cursor , user , table , priv ) :
# Note: priv escaped by parse_privs
prev_priv = get_table_privileges ( cursor , user , table )
prev_priv = get_table_privileges ( cursor , user , table )
query = ' REVOKE %s ON TABLE %s FROM %s ' % (
query = ' REVOKE %s ON TABLE %s FROM %s ' % (
priv , quote_pg_identifier( table ) , quote_pg_identifier ( user ) , )
priv , pg_quote_identifier ( table , ' table ' ) , pg_quote_identifier ( user , ' role ' ) )
cursor . execute ( query )
cursor . execute ( query )
curr_priv = get_table_privileges ( cursor , user , table )
curr_priv = get_table_privileges ( cursor , user , table )
return len ( curr_priv ) < len ( prev_priv )
return len ( curr_priv ) < len ( prev_priv )
@ -324,21 +328,29 @@ def has_database_privilege(cursor, user, db, priv):
return cursor . fetchone ( ) [ 0 ]
return cursor . fetchone ( ) [ 0 ]
def grant_database_privilege ( cursor , user , db , priv ) : def grant_database_privilege ( cursor , user , db , priv ) :
# Note: priv escaped by parse_privs
prev_priv = get_database_privileges ( cursor , user , db )
prev_priv = get_database_privileges ( cursor , user , db )
if user == " PUBLIC " :
if user == " PUBLIC " :
query = ' GRANT %s ON DATABASE \" %s \" TO PUBLIC ' % ( priv , db )
query = ' GRANT %s ON DATABASE %s TO PUBLIC ' % (
priv , pg_quote_identifier ( db , ' database ' ) )
else :
else :
query = ' GRANT %s ON DATABASE \" %s \" TO \" %s \" ' % ( priv , db , user )
query = ' GRANT %s ON DATABASE %s TO %s ' % (
priv , pg_quote_identifier ( db , ' database ' ) ,
pg_quote_identifier ( user , ' role ' ) )
cursor . execute ( query )
cursor . execute ( query )
curr_priv = get_database_privileges ( cursor , user , db )
curr_priv = get_database_privileges ( cursor , user , db )
return len ( curr_priv ) > len ( prev_priv )
return len ( curr_priv ) > len ( prev_priv )
def revoke_database_privilege ( cursor , user , db , priv ) : def revoke_database_privilege ( cursor , user , db , priv ) :
# Note: priv escaped by parse_privs
prev_priv = get_database_privileges ( cursor , user , db )
prev_priv = get_database_privileges ( cursor , user , db )
if user == " PUBLIC " :
if user == " PUBLIC " :
query = ' REVOKE %s ON DATABASE \" %s \" FROM PUBLIC ' % ( priv , db )
query = ' REVOKE %s ON DATABASE %s FROM PUBLIC ' % (
priv , pg_quote_identifier ( db , ' database ' ) )
else :
else :
query = ' REVOKE %s ON DATABASE \" %s \" FROM \" %s \" ' % ( priv , db , user )
query = ' REVOKE %s ON DATABASE %s FROM %s ' % (
priv , pg_quote_identifier ( db , ' database ' ) ,
pg_quote_identifier ( user , ' role ' ) )
cursor . execute ( query )
cursor . execute ( query )
curr_priv = get_database_privileges ( cursor , user , db )
curr_priv = get_database_privileges ( cursor , user , db )
return len ( curr_priv ) < len ( prev_priv )
return len ( curr_priv ) < len ( prev_priv )
@ -387,11 +399,20 @@ def parse_role_attrs(role_attr_flags):
Where :
Where :
attributes := CREATEDB , CREATEROLE , NOSUPERUSER , . . .
attributes := CREATEDB , CREATEROLE , NOSUPERUSER , . . .
[ " [NO]SUPERUSER " , " [NO]CREATEROLE " , " [NO]CREATEUSER " , " [NO]CREATEDB " ,
" [NO]INHERIT " , " [NO]LOGIN " , " [NO]REPLICATION " ]
"""
"""
if ' , ' not in role_attr_flags :
if ' , ' in role_attr_flags :
return role_attr_flags
flag_set = frozenset ( r . upper ( ) for r in role_attr_flags . split ( " , " ) )
flag_set = role_attr_flags . split ( " , " )
elif role_attr_flags :
o_flags = " " . join ( flag_set )
flag_set = frozenset ( ( role_attr_flags . upper ( ) , ) )
else :
flag_set = frozenset ( )
if not flag_set . issubset ( VALID_FLAGS ) :
raise InvalidFlagsError ( ' Invalid role_attr_flags specified: %s ' %
' ' . join ( flag_set . difference ( VALID_FLAGS ) ) )
o_flags = ' ' . join ( flag_set )
return o_flags
return o_flags
def parse_privs ( privs , db ) : def parse_privs ( privs , db ) :
@ -417,12 +438,15 @@ def parse_privs(privs, db):
if ' : ' not in token :
if ' : ' not in token :
type_ = ' database '
type_ = ' database '
name = db
name = db
priv_set = ( x . strip ( ) for x in token . split ( ' , ' ) )
priv_set = frozen set( x . strip ( ) . upper ( ) for x in token . split ( ' , ' ) if x . strip ( ) )
else :
else :
type_ = ' table '
type_ = ' table '
name , privileges = token . split ( ' : ' , 1 )
name , privileges = token . split ( ' : ' , 1 )
priv_set = ( x . strip ( ) for x in privileges . split ( ' , ' ) )
priv_set = frozen set( x . strip ( ) . upper ( ) for x in privileges . split ( ' , ' ) if x . strip ( ) )
if not priv_set . issubset ( VALID_PRIVS [ type_ ] ) :
raise InvalidPrivsError ( ' Invalid privs specified for %s : %s ' %
( type_ , ' ' . join ( priv_set . difference ( VALID_PRIVS [ type_ ] ) ) ) )
o_privs [ type_ ] [ name ] = priv_set
o_privs [ type_ ] [ name ] = priv_set
return o_privs
return o_privs
@ -437,6 +461,7 @@ def main():
login_user = dict ( default = " postgres " ) ,
login_user = dict ( default = " postgres " ) ,
login_password = dict ( default = " " ) ,
login_password = dict ( default = " " ) ,
login_host = dict ( default = " " ) ,
login_host = dict ( default = " " ) ,
login_unix_socket = dict ( default = " " ) ,
user = dict ( required = True , aliases = [ ' name ' ] ) ,
user = dict ( required = True , aliases = [ ' name ' ] ) ,
password = dict ( default = None ) ,
password = dict ( default = None ) ,
state = dict ( default = " present " , choices = [ " absent " , " present " ] ) ,
state = dict ( default = " present " , choices = [ " absent " , " present " ] ) ,
@ -460,7 +485,10 @@ def main():
module . fail_json ( msg = " privileges require a database to be specified " )
module . fail_json ( msg = " privileges require a database to be specified " )
privs = parse_privs ( module . params [ " priv " ] , db )
privs = parse_privs ( module . params [ " priv " ] , db )
port = module . params [ " port " ]
port = module . params [ " port " ]
role_attr_flags = parse_role_attrs ( module . params [ " role_attr_flags " ] )
try :
role_attr_flags = parse_role_attrs ( module . params [ " role_attr_flags " ] )
except InvalidFlagsError , e :
module . fail_json ( msg = str ( e ) )
if module . params [ " encrypted " ] :
if module . params [ " encrypted " ] :
encrypted = " ENCRYPTED "
encrypted = " ENCRYPTED "
else :
else :
@ -482,6 +510,12 @@ def main():
}
}
kw = dict ( ( params_map [ k ] , v ) for ( k , v ) in module . params . iteritems ( )
kw = dict ( ( params_map [ k ] , v ) for ( k , v ) in module . params . iteritems ( )
if k in params_map and v != " " )
if k in params_map and v != " " )
# If a login_unix_socket is specified, incorporate it here.
is_localhost = " host " not in kw or kw [ " host " ] == " " or kw [ " host " ] == " localhost "
if is_localhost and module . params [ " login_unix_socket " ] != " " :
kw [ " host " ] = module . params [ " login_unix_socket " ]
try :
try :
db_connection = psycopg2 . connect ( * * kw )
db_connection = psycopg2 . connect ( * * kw )
cursor = db_connection . cursor ( )
cursor = db_connection . cursor ( )
@ -494,18 +528,30 @@ def main():
if state == " present " :
if state == " present " :
if user_exists ( cursor , user ) :
if user_exists ( cursor , user ) :
changed = user_alter ( cursor , module , user , password , role_attr_flags , encrypted , expires )
try :
changed = user_alter ( cursor , module , user , password , role_attr_flags , encrypted , expires )
except SQLParseError , e :
module . fail_json ( msg = str ( e ) )
else :
else :
changed = user_add ( cursor , user , password , role_attr_flags , encrypted , expires )
try :
changed = grant_privileges ( cursor , user , privs ) or changed
changed = user_add ( cursor , user , password , role_attr_flags , encrypted , expires )
except SQLParseError , e :
module . fail_json ( msg = str ( e ) )
try :
changed = grant_privileges ( cursor , user , privs ) or changed
except SQLParseError , e :
module . fail_json ( msg = str ( e ) )
else :
else :
if user_exists ( cursor , user ) :
if user_exists ( cursor , user ) :
if module . check_mode :
if module . check_mode :
changed = True
changed = True
kw [ ' user_removed ' ] = True
kw [ ' user_removed ' ] = True
else :
else :
changed = revoke_privileges ( cursor , user , privs )
try :
user_removed = user_delete ( cursor , user )
changed = revoke_privileges ( cursor , user , privs )
user_removed = user_delete ( cursor , user )
except SQLParseError , e :
module . fail_json ( msg = str ( e ) )
changed = changed or user_removed
changed = changed or user_removed
if fail_on_user and not user_removed :
if fail_on_user and not user_removed :
msg = " unable to remove user "
msg = " unable to remove user "
@ -523,4 +569,5 @@ def main():
# import module snippets # import module snippets
from ansible . module_utils . basic import * from ansible . module_utils . basic import *
from ansible . module_utils . database import *
main ( ) main ( )
Jonathan Armani
10 years ago