Try SpotterAdd, remove or modify a rule in a pg_hba file
Authors: Sebastiaan Mannem (@sebasmannem), Felix Hamme (@betanummeric)
Install with ansible-galaxy collection install community.postgresql:==3.4.0
collections:
- name: community.postgresql
version: 3.4.0The fundamental function of the module is to create, or delete lines in pg_hba files.
The lines in the file should be in a typical pg_hba form and lines should be unique per key (type, databases, users, source). If they are not unique and the SID is 'the one to change', only one for I(state=present) or none for I(state=absent) of the SID's will remain.
- name: Grant users joe and simon access to databases sales and logistics from ipv6 localhost ::1/128 using peer authentication
community.postgresql.postgresql_pg_hba:
dest: /var/lib/postgres/data/pg_hba.conf
contype: host
users: joe,simon
source: ::1
databases: sales,logistics
method: peer
create: true
- name: Grant user replication from network 192.168.0.100/24 access for replication with client cert authentication
community.postgresql.postgresql_pg_hba:
dest: /var/lib/postgres/data/pg_hba.conf
contype: host
users: replication
source: 192.168.0.100/24
databases: replication
method: cert
- name: Revoke access from local user mary on database mydb
community.postgresql.postgresql_pg_hba:
dest: /var/lib/postgres/data/pg_hba.conf
contype: local
users: mary
databases: mydb
state: absent
- name: Grant some_user access to some_db, comment that and keep other rule-specific comments attached to their rules
community.postgresql.postgresql_pg_hba:
dest: /var/lib/postgres/data/pg_hba.conf
contype: host
users: some_user
databases: some_db
method: md5
source: ::/0
keep_comments_at_rules: true
comment: "this rule is an example"
- name: Replace everything with a new set of rules
community.postgresql.postgresql_pg_hba:
dest: /var/lib/postgres/data/pg_hba.conf
overwrite: true # remove preexisting rules
# custom defaults
rules_behavior: combine
contype: hostssl
address: 2001:db8::/64
comment: added in bulk
rules:
- users: user1
databases: db1
# contype, address and comment come from custom default
- users: user2
databases: db2
comment: added with love # overwrite custom default for this rule
# contype and address come from custom default
- users: user3
databases: db3
dest:
description:
- Path to C(pg_hba) file to modify.
required: true
type: path
mode:
description:
- The permissions the resulting filesystem object should have.
- For those used to I(/usr/bin/chmod) remember that modes are actually octal numbers.
You must give Ansible enough information to parse them correctly. For consistent
results, quote octal numbers (for example, V('644') or V('1777')) so Ansible receives
a string and can do its own conversion from string into number. Adding a leading
zero (for example, V(0755)) works sometimes, but can fail in loops and some other
circumstances.
- Giving Ansible a number without following either of these rules will end up with
a decimal number which will have unexpected results.
- As of Ansible 1.8, the mode may be specified as a symbolic mode (for example, V(u+rwx)
or V(u=rw,g=r,o=r)).
- If O(mode) is not specified and the destination filesystem object B(does not) exist,
the default C(umask) on the system will be used when setting the mode for the newly
created filesystem object.
- If O(mode) is not specified and the destination filesystem object B(does) exist,
the mode of the existing filesystem object will be used.
- Specifying O(mode) is the best way to ensure filesystem objects are created with
the correct permissions. See CVE-2020-1736 for further details.
type: raw
group:
description:
- Name of the group that should own the filesystem object, as would be fed to I(chown).
- When left unspecified, it uses the current group of the current user unless you
are root, in which case it can preserve the previous ownership.
type: str
owner:
description:
- Name of the user that should own the filesystem object, as would be fed to I(chown).
- When left unspecified, it uses the current user unless you are root, in which case
it can preserve the previous ownership.
- Specifying a numeric username will be assumed to be a user ID and not a username.
Avoid numeric usernames to avoid this confusion.
type: str
rules:
description:
- A list of objects, specifying rules for the pg_hba.conf. Use this to manage multiple
rules at once.
- 'Each object can have the following keys (the ''rule-specific arguments''), which
are treated the same as if they were arguments of this module:'
- C(address), C(comment), C(contype), C(databases), C(method), C(netmask), C(options),
C(state), C(users)
- See also C(rules_behavior).
elements: dict
type: list
state:
choices:
- absent
- present
default: present
description:
- The lines will be added/modified when C(state=present) and removed when C(state=absent).
type: str
users:
default: all
description:
- Users this line applies to.
type: str
backup:
default: false
description:
- If set, create a backup of the C(pg_hba) file before it is modified. The location
of the backup is returned in the (backup) variable by this module.
type: bool
create:
default: false
description:
- Create an C(pg_hba) file if none exists.
- When set to false, an error is raised when the C(pg_hba) file doesn't exist.
type: bool
method:
choices:
- cert
- gss
- ident
- krb5
- ldap
- md5
- pam
- password
- peer
- radius
- reject
- scram-sha-256
- sspi
- trust
default: md5
description:
- Authentication method to be used.
type: str
serole:
description:
- The role part of the SELinux filesystem object context.
- When set to V(_default), it will use the C(role) portion of the policy if available.
type: str
setype:
description:
- The type part of the SELinux filesystem object context.
- When set to V(_default), it will use the C(type) portion of the policy if available.
type: str
seuser:
description:
- The user part of the SELinux filesystem object context.
- By default it uses the V(system) policy, where applicable.
- When set to V(_default), it will use the C(user) portion of the policy if available.
type: str
address:
aliases:
- source
- src
default: samehost
description:
- The source address/net where the connections could come from.
- Will not be used for entries of I(type)=C(local).
- You can also use keywords C(all), C(samehost), and C(samenet).
type: str
comment:
description:
- A comment that will be placed in the same line behind the rule. See also the I(keep_comments_at_rules)
parameter.
type: str
version_added: 1.5.0
version_added_collection: community.postgresql
contype:
choices:
- local
- host
- hostnossl
- hostssl
- hostgssenc
- hostnogssenc
description:
- Type of the rule. If not set, C(postgresql_pg_hba) will only return contents.
type: str
netmask:
description:
- The netmask of the source address.
type: str
options:
description:
- Additional options for the authentication I(method).
type: str
selevel:
description:
- The level part of the SELinux filesystem object context.
- This is the MLS/MCS attribute, sometimes known as the C(range).
- When set to V(_default), it will use the C(level) portion of the policy if available.
type: str
databases:
default: all
description:
- Databases this line applies to.
type: str
overwrite:
default: false
description:
- Remove all existing rules before adding rules. (Like I(state=absent) for all pre-existing
rules.)
type: bool
attributes:
aliases:
- attr
description:
- The attributes the resulting filesystem object should have.
- To get supported flags look at the man page for I(chattr) on the target system.
- This string should contain the attributes in the same order as the one displayed
by I(lsattr).
- The C(=) operator is assumed as default, otherwise C(+) or C(-) operators need to
be included in the string.
type: str
version_added: '2.3'
version_added_collection: ansible.builtin
backup_file:
description:
- Write backup to a specific backupfile rather than a temp file.
type: str
unsafe_writes:
default: false
description:
- Influence when to use atomic operation to prevent data corruption or inconsistent
reads from the target filesystem object.
- By default this module uses atomic operations to prevent data corruption or inconsistent
reads from the target filesystem objects, but sometimes systems are configured or
just broken in ways that prevent this. One example is docker mounted filesystem
objects, which cannot be updated atomically from inside the container and can only
be written in an unsafe manner.
- This option allows Ansible to fall back to unsafe methods of updating filesystem
objects when atomic operations fail (however, it doesn't force Ansible to perform
unsafe writes).
- IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption.
type: bool
version_added: '2.2'
version_added_collection: ansible.builtin
rules_behavior:
choices:
- conflict
- combine
default: conflict
description:
- Configure how the I(rules) argument works together with the rule-specific arguments
outside the I(rules) argument.
- See I(rules) for the complete list of rule-specific arguments.
- When set to C(conflict), fail if I(rules) and, for example, I(address) are set.
- If C(combine), the normal rule-specific arguments are not defining a rule, but are
used as defaults for the arguments in the I(rules) argument.
- Is used only when I(rules) is specified, ignored otherwise.
type: str
keep_comments_at_rules:
default: false
description:
- If C(true), comments that stand together with a rule in one line are kept behind
that line.
- If C(false), such comments are moved to the beginning of the file, like all other
comments.
type: bool
version_added: 1.5.0
version_added_collection: community.postgresql
backup_file:
description: File that the original pg_hba file was backed up to.
returned: changed
sample: /tmp/pg_hba_jxobj_p
type: str
msgs:
description: List of textual messages what was done.
returned: success
sample:
msgs:
- Removing
- Changed
- Writing
type: list
pg_hba:
description: List of the pg_hba rules as they are configured in the specified hba
file.
returned: success
sample:
pg_hba:
- db: all
method: md5
src: samehost
type: host
usr: all
type: list