community.general/plugins/become/pbrun.py

# -*- coding: utf-8 -*-
# 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 (absolute_import, division, print_function)
__metaclass__ = type

DOCUMENTATION = '''
    name: pbrun
    short_description: PowerBroker run
    description:
        - This become plugins allows your remote/login user to execute commands as another user via the pbrun utility.
    author: Ansible Core Team
    options:
        become_user:
            description: User you 'become' to execute the task.
            type: string
            default: ''
            ini:
              - section: privilege_escalation
                key: become_user
              - section: pbrun_become_plugin
                key: user
            vars:
              - name: ansible_become_user
              - name: ansible_pbrun_user
            env:
              - name: ANSIBLE_BECOME_USER
              - name: ANSIBLE_PBRUN_USER
        become_exe:
            description: Sudo executable.
            type: string
            default: pbrun
            ini:
              - section: privilege_escalation
                key: become_exe
              - section: pbrun_become_plugin
                key: executable
            vars:
              - name: ansible_become_exe
              - name: ansible_pbrun_exe
            env:
              - name: ANSIBLE_BECOME_EXE
              - name: ANSIBLE_PBRUN_EXE
        become_flags:
            description: Options to pass to pbrun.
            type: string
            default: ''
            ini:
              - section: privilege_escalation
                key: become_flags
              - section: pbrun_become_plugin
                key: flags
            vars:
              - name: ansible_become_flags
              - name: ansible_pbrun_flags
            env:
              - name: ANSIBLE_BECOME_FLAGS
              - name: ANSIBLE_PBRUN_FLAGS
        become_pass:
            description: Password for pbrun.
            type: string
            required: false
            vars:
              - name: ansible_become_password
              - name: ansible_become_pass
              - name: ansible_pbrun_pass
            env:
              - name: ANSIBLE_BECOME_PASS
              - name: ANSIBLE_PBRUN_PASS
            ini:
              - section: pbrun_become_plugin
                key: password
        wrap_exe:
            description: Toggle to wrap the command pbrun calls in C(shell -c) or not.
            default: false
            type: bool
            ini:
              - section: pbrun_become_plugin
                key: wrap_execution
            vars:
              - name: ansible_pbrun_wrap_execution
            env:
              - name: ANSIBLE_PBRUN_WRAP_EXECUTION
'''

from ansible.plugins.become import BecomeBase


class BecomeModule(BecomeBase):

    name = 'community.general.pbrun'

    prompt = 'Password:'

    def build_become_command(self, cmd, shell):
        super(BecomeModule, self).build_become_command(cmd, shell)

        if not cmd:
            return cmd

        become_exe = self.get_option('become_exe')

        flags = self.get_option('become_flags')
        become_user = self.get_option('become_user')
        user = '-u %s' % (become_user) if become_user else ''
        noexe = not self.get_option('wrap_exe')

        return ' '.join([become_exe, flags, user, self._build_success_command(cmd, shell, noexe=noexe)])