Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pfsense_user] Fix setting multiple groups for a user (#130) #155

Merged
merged 1 commit into from
Jan 26, 2025
Merged

[pfsense_user] Fix setting multiple groups for a user (#130) #155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions changelogs/fragments/user_groups.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
bugfixes:
- pfsense_user - fixed setting multiple groups for a user (https://github.com/pfsensible/core/issues/130)
18 changes: 12 additions & 6 deletions plugins/modules/pfsense_user.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ def __init__(self, module, pfsense=None):
self.root_elt = self.pfsense.get_element('system')
self.users = self.root_elt.findall('user')
self.groups = self.root_elt.findall('group')
self.user_groups = None
self.mod_groups = []

##############################
Expand All @@ -170,10 +171,14 @@ def _params_to_obj(self):

obj['name'] = params['name']
if params['state'] == 'present':
for option in ['authorizedkeys', 'descr', 'scope', 'uid', 'bcrypt-hash', 'groups', 'priv']:
for option in ['authorizedkeys', 'descr', 'scope', 'uid', 'bcrypt-hash', 'priv']:
if option in params and params[option] is not None:
obj[option] = params[option]

# Groups are not stored in the user object
if 'groups' in params and params['groups'] is not None:
self.user_groups = params['groups']

# Allow authorizedkeys to be clear or base64 encoded
if 'authorizedkeys' in obj and 'ssh-' in obj['authorizedkeys']:
obj['authorizedkeys'] = base64.b64encode(obj['authorizedkeys'].encode()).decode()
Expand Down Expand Up @@ -263,14 +268,15 @@ def _update_groups(self):
user = self.obj
changed = False

# Handle group member element - need uid set or retrieved above
if 'groups' in user:
# Only modify group membership is groups was specified
if self.user_groups is not None:
# Handle group member element - need uid set or retrieved above
uid = self.target_elt.find('uid').text
# Get current group membership
self.diff['before']['groups'] = self._find_groups_for_uid(uid)

# Add user to groups if needed
for group in self.obj['groups']:
for group in self.user_groups:
group_elt = self._find_group(group)
if group_elt is None:
self.module.fail_json(msg='Group (%s) does not exist' % group)
Expand All @@ -281,7 +287,7 @@ def _update_groups(self):

# Remove user from groups if needed
for group in self.diff['before']['groups']:
if group not in self.obj['groups']:
if group not in self.user_groups:
group_elt = self._find_group(group)
if group_elt is None:
self.module.fail_json(msg='Group (%s) does not exist' % group)
Expand All @@ -293,7 +299,7 @@ def _update_groups(self):
break

# Groups are not stored in the user element
self.diff['after']['groups'] = user.pop('groups')
self.diff['after']['groups'] = self.user_groups

# Decode keys for diff
for k in self.diff:
Expand Down