mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-02-03 23:41:51 +00:00
137 lines
4.1 KiB
Python
137 lines
4.1 KiB
Python
# Copyright (c) 2018, Ansible Project
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
from __future__ import annotations
|
|
|
|
DOCUMENTATION = r"""
|
|
name: doas
|
|
short_description: Do As user
|
|
description:
|
|
- This become plugins allows your remote/login user to execute commands as another user using the C(doas) utility.
|
|
author: Ansible Core Team
|
|
options:
|
|
become_user:
|
|
description: User you 'become' to execute the task.
|
|
type: string
|
|
ini:
|
|
- section: privilege_escalation
|
|
key: become_user
|
|
- section: doas_become_plugin
|
|
key: user
|
|
vars:
|
|
- name: ansible_become_user
|
|
- name: ansible_doas_user
|
|
env:
|
|
- name: ANSIBLE_BECOME_USER
|
|
- name: ANSIBLE_DOAS_USER
|
|
become_exe:
|
|
description: C(doas) executable.
|
|
type: string
|
|
default: doas
|
|
ini:
|
|
- section: privilege_escalation
|
|
key: become_exe
|
|
- section: doas_become_plugin
|
|
key: executable
|
|
vars:
|
|
- name: ansible_become_exe
|
|
- name: ansible_doas_exe
|
|
env:
|
|
- name: ANSIBLE_BECOME_EXE
|
|
- name: ANSIBLE_DOAS_EXE
|
|
become_flags:
|
|
description: Options to pass to C(doas).
|
|
type: string
|
|
default: ''
|
|
ini:
|
|
- section: privilege_escalation
|
|
key: become_flags
|
|
- section: doas_become_plugin
|
|
key: flags
|
|
vars:
|
|
- name: ansible_become_flags
|
|
- name: ansible_doas_flags
|
|
env:
|
|
- name: ANSIBLE_BECOME_FLAGS
|
|
- name: ANSIBLE_DOAS_FLAGS
|
|
become_pass:
|
|
description: Password for C(doas) prompt.
|
|
type: string
|
|
required: false
|
|
vars:
|
|
- name: ansible_become_password
|
|
- name: ansible_become_pass
|
|
- name: ansible_doas_pass
|
|
env:
|
|
- name: ANSIBLE_BECOME_PASS
|
|
- name: ANSIBLE_DOAS_PASS
|
|
ini:
|
|
- section: doas_become_plugin
|
|
key: password
|
|
prompt_l10n:
|
|
description:
|
|
- List of localized strings to match for prompt detection.
|
|
- If empty the plugin uses the built-in one.
|
|
type: list
|
|
elements: string
|
|
default: []
|
|
ini:
|
|
- section: doas_become_plugin
|
|
key: localized_prompts
|
|
vars:
|
|
- name: ansible_doas_prompt_l10n
|
|
env:
|
|
- name: ANSIBLE_DOAS_PROMPT_L10N
|
|
notes:
|
|
- This become plugin does not work when connection pipelining is enabled. With ansible-core 2.19+, using it automatically
|
|
disables pipelining. On ansible-core 2.18 and before, pipelining must explicitly be disabled by the user.
|
|
"""
|
|
|
|
import re
|
|
|
|
from ansible.module_utils.common.text.converters import to_bytes
|
|
from ansible.plugins.become import BecomeBase
|
|
|
|
|
|
class BecomeModule(BecomeBase):
|
|
name = "community.general.doas"
|
|
|
|
# messages for detecting prompted password issues
|
|
fail = ("Permission denied",)
|
|
missing = ("Authorization required",)
|
|
|
|
# See https://github.com/ansible-collections/community.general/issues/9977,
|
|
# https://github.com/ansible/ansible/pull/78111
|
|
pipelining = False
|
|
|
|
def check_password_prompt(self, b_output):
|
|
"""checks if the expected password prompt exists in b_output"""
|
|
|
|
# FIXME: more accurate would be: 'doas (%s@' % remote_user
|
|
# however become plugins don't have that information currently
|
|
b_prompts = [to_bytes(p) for p in self.get_option("prompt_l10n")] or [rb"doas \(", rb"Password:"]
|
|
b_prompt = b"|".join(b_prompts)
|
|
|
|
return bool(re.match(b_prompt, b_output))
|
|
|
|
def build_become_command(self, cmd, shell):
|
|
super().build_become_command(cmd, shell)
|
|
|
|
if not cmd:
|
|
return cmd
|
|
|
|
self.prompt = True
|
|
|
|
become_exe = self.get_option("become_exe")
|
|
|
|
flags = self.get_option("become_flags")
|
|
if not self.get_option("become_pass") and "-n" not in flags:
|
|
flags += " -n"
|
|
|
|
become_user = self.get_option("become_user")
|
|
user = f"-u {become_user}" if become_user else ""
|
|
|
|
success_cmd = self._build_success_command(cmd, shell, noexe=True)
|
|
executable = getattr(shell, "executable", shell.SHELL_FAMILY)
|
|
|
|
return f"{become_exe} {flags} {user} {executable} -c {success_cmd}"
|