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.

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

Add support for host restriction in sudoers module #5703

Merged
merged 6 commits into from
Dec 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/5703-sudoers-host-support.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
minor_changes:
- sudoers - adds ``host`` parameter for setting hostname restrictions in sudoers rules (https://github.com/ansible-collections/community.general/issues/5702).
22 changes: 20 additions & 2 deletions plugins/modules/sudoers.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,12 @@
- Whether a password will be required to run the sudo'd command.
default: true
type: bool
host:
description:
- Specify the host the rule is for.
default: ALL
type: str
version_added: 6.2.0
runas:
description:
- Specify the target user the command(s) will run as.
Expand Down Expand Up @@ -95,10 +101,11 @@

- name: >-
Allow the monitoring group to run sudo /usr/local/bin/gather-app-metrics
without requiring a password
without requiring a password on the host called webserver
community.general.sudoers:
name: monitor-app
group: monitoring
host: webserver
commands: /usr/local/bin/gather-app-metrics

- name: >-
Expand Down Expand Up @@ -136,6 +143,7 @@ def __init__(self, module):
self.group = module.params['group']
self.state = module.params['state']
self.nopassword = module.params['nopassword']
self.host = module.params['host']
self.runas = module.params['runas']
self.sudoers_path = module.params['sudoers_path']
self.file = os.path.join(self.sudoers_path, self.name)
Expand Down Expand Up @@ -178,7 +186,13 @@ def content(self):
commands_str = ', '.join(self.commands)
nopasswd_str = 'NOPASSWD:' if self.nopassword else ''
runas_str = '({runas})'.format(runas=self.runas) if self.runas is not None else ''
return "{owner} ALL={runas}{nopasswd} {commands}\n".format(owner=owner, runas=runas_str, nopasswd=nopasswd_str, commands=commands_str)
return "{owner} {host}={runas}{nopasswd} {commands}\n".format(
owner=owner,
host=self.host,
runas=runas_str,
nopasswd=nopasswd_str,
commands=commands_str
)

def validate(self):
if self.validation == 'absent':
Expand Down Expand Up @@ -225,6 +239,10 @@ def main():
'type': 'bool',
'default': True,
},
'host': {
'type': 'str',
'default': 'ALL',
},
'runas': {
'type': 'str',
'default': None,
Expand Down
14 changes: 14 additions & 0 deletions tests/integration/targets/sudoers/tasks/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,19 @@
src: "{{ sudoers_path }}/my-sudo-rule-6"
register: rule_6_contents

- name: Create rule to allow user to sudo just on host-1
community.general.sudoers:
name: my-sudo-rule-7
state: present
user: alice
host: host-1
commands: /usr/local/bin/command
register: rule_7

- name: Grab contents of my-sudo-rule-7
ansible.builtin.slurp:
src: "{{ sudoers_path }}/my-sudo-rule-7"
register: rule_7_contents

- name: Revoke rule 1
community.general.sudoers:
Expand Down Expand Up @@ -229,6 +242,7 @@
- "rule_4_contents['content'] | b64decode == '%students ALL=NOPASSWD: /usr/local/bin/command\n'"
- "rule_5_contents['content'] | b64decode == 'alice ALL=NOPASSWD: /usr/local/bin/command\n'"
- "rule_6_contents['content'] | b64decode == 'alice ALL=(bob)NOPASSWD: /usr/local/bin/command\n'"
- "rule_7_contents['content'] | b64decode == 'alice host-1=NOPASSWD: /usr/local/bin/command\n'"

- name: Check revocation stat
ansible.builtin.assert:
Expand Down