Initial project commit

collections/ansible_collections/community/general/plugins/connection/chroot.py

@@ -0,0 +1,245 @@
+# -*- coding: utf-8 -*-
+# Based on local.py (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
+#
+# (c) 2013, Maykel Moya <mmoya@speedyrails.com>
+# (c) 2015, Toshio Kuratomi <tkuratomi@ansible.com>
+# Copyright (c) 2017 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 = '''
+    author: Maykel Moya (!UNKNOWN) <mmoya@speedyrails.com>
+    name: chroot
+    short_description: Interact with local chroot
+    description:
+        - Run commands or put/fetch files to an existing chroot on the Ansible controller.
+    options:
+      remote_addr:
+        description:
+            - The path of the chroot you want to access.
+        default: inventory_hostname
+        vars:
+            - name: inventory_hostname
+            - name: ansible_host
+      executable:
+        description:
+            - User specified executable shell
+        ini:
+          - section: defaults
+            key: executable
+        env:
+          - name: ANSIBLE_EXECUTABLE
+        vars:
+          - name: ansible_executable
+        default: /bin/sh
+      chroot_exe:
+        description:
+            - User specified chroot binary
+        ini:
+          - section: chroot_connection
+            key: exe
+        env:
+          - name: ANSIBLE_CHROOT_EXE
+        vars:
+          - name: ansible_chroot_exe
+        default: chroot
+      disable_root_check:
+        description:
+            - Do not check that the user is not root.
+        ini:
+          - section: chroot_connection
+            key: disable_root_check
+        env:
+          - name: ANSIBLE_CHROOT_DISABLE_ROOT_CHECK
+        vars:
+          - name: ansible_chroot_disable_root_check
+        default: false
+        type: bool
+        version_added: 7.3.0
+'''
+
+EXAMPLES = r"""
+# Plugin requires root privileges for chroot, -E preserves your env (and location of ~/.ansible):
+# sudo -E ansible-playbook ...
+#
+# Static inventory file
+# [chroots]
+# /path/to/debootstrap
+# /path/to/feboostrap
+# /path/to/lxc-image
+# /path/to/chroot
+
+# playbook
+---
+- hosts: chroots
+  connection: community.general.chroot
+  tasks:
+    - debug:
+        msg: "This is coming from chroot environment"
+
+"""
+
+import os
+import os.path
+import subprocess
+import traceback
+
+from ansible.errors import AnsibleError
+from ansible.module_utils.basic import is_executable
+from ansible.module_utils.common.process import get_bin_path
+from ansible.module_utils.six.moves import shlex_quote
+from ansible.module_utils.common.text.converters import to_bytes, to_native
+from ansible.plugins.connection import ConnectionBase, BUFSIZE
+from ansible.utils.display import Display
+
+display = Display()
+
+
+class Connection(ConnectionBase):
+    """ Local chroot based connections """
+
+    transport = 'community.general.chroot'
+    has_pipelining = True
+    # su currently has an undiagnosed issue with calculating the file
+    # checksums (so copy, for instance, doesn't work right)
+    # Have to look into that before re-enabling this
+    has_tty = False
+
+    default_user = 'root'
+
+    def __init__(self, play_context, new_stdin, *args, **kwargs):
+        super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
+
+        self.chroot = self._play_context.remote_addr
+
+        # do some trivial checks for ensuring 'host' is actually a chroot'able dir
+        if not os.path.isdir(self.chroot):
+            raise AnsibleError("%s is not a directory" % self.chroot)
+
+        chrootsh = os.path.join(self.chroot, 'bin/sh')
+        # Want to check for a usable bourne shell inside the chroot.
+        # is_executable() == True is sufficient.  For symlinks it
+        # gets really complicated really fast.  So we punt on finding that
+        # out.  As long as it's a symlink we assume that it will work
+        if not (is_executable(chrootsh) or (os.path.lexists(chrootsh) and os.path.islink(chrootsh))):
+            raise AnsibleError("%s does not look like a chrootable dir (/bin/sh missing)" % self.chroot)
+
+    def _connect(self):
+        """ connect to the chroot """
+        if not self.get_option('disable_root_check') and os.geteuid() != 0:
+            raise AnsibleError(
+                "chroot connection requires running as root. "
+                "You can override this check with the `disable_root_check` option.")
+
+        if os.path.isabs(self.get_option('chroot_exe')):
+            self.chroot_cmd = self.get_option('chroot_exe')
+        else:
+            try:
+                self.chroot_cmd = get_bin_path(self.get_option('chroot_exe'))
+            except ValueError as e:
+                raise AnsibleError(to_native(e))
+
+        super(Connection, self)._connect()
+        if not self._connected:
+            display.vvv("THIS IS A LOCAL CHROOT DIR", host=self.chroot)
+            self._connected = True
+
+    def _buffered_exec_command(self, cmd, stdin=subprocess.PIPE):
+        """ run a command on the chroot.  This is only needed for implementing
+        put_file() get_file() so that we don't have to read the whole file
+        into memory.
+
+        compared to exec_command() it looses some niceties like being able to
+        return the process's exit code immediately.
+        """
+        executable = self.get_option('executable')
+        local_cmd = [self.chroot_cmd, self.chroot, executable, '-c', cmd]
+
+        display.vvv("EXEC %s" % local_cmd, host=self.chroot)
+        local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
+        p = subprocess.Popen(local_cmd, shell=False, stdin=stdin,
+                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+
+        return p
+
+    def exec_command(self, cmd, in_data=None, sudoable=False):
+        """ run a command on the chroot """
+        super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
+
+        p = self._buffered_exec_command(cmd)
+
+        stdout, stderr = p.communicate(in_data)
+        return p.returncode, stdout, stderr
+
+    @staticmethod
+    def _prefix_login_path(remote_path):
+        """ Make sure that we put files into a standard path
+
+            If a path is relative, then we need to choose where to put it.
+            ssh chooses $HOME but we aren't guaranteed that a home dir will
+            exist in any given chroot.  So for now we're choosing "/" instead.
+            This also happens to be the former default.
+
+            Can revisit using $HOME instead if it's a problem
+        """
+        if not remote_path.startswith(os.path.sep):
+            remote_path = os.path.join(os.path.sep, remote_path)
+        return os.path.normpath(remote_path)
+
+    def put_file(self, in_path, out_path):
+        """ transfer a file from local to chroot """
+        super(Connection, self).put_file(in_path, out_path)
+        display.vvv("PUT %s TO %s" % (in_path, out_path), host=self.chroot)
+
+        out_path = shlex_quote(self._prefix_login_path(out_path))
+        try:
+            with open(to_bytes(in_path, errors='surrogate_or_strict'), 'rb') as in_file:
+                if not os.fstat(in_file.fileno()).st_size:
+                    count = ' count=0'
+                else:
+                    count = ''
+                try:
+                    p = self._buffered_exec_command('dd of=%s bs=%s%s' % (out_path, BUFSIZE, count), stdin=in_file)
+                except OSError:
+                    raise AnsibleError("chroot connection requires dd command in the chroot")
+                try:
+                    stdout, stderr = p.communicate()
+                except Exception:
+                    traceback.print_exc()
+                    raise AnsibleError("failed to transfer file %s to %s" % (in_path, out_path))
+                if p.returncode != 0:
+                    raise AnsibleError("failed to transfer file %s to %s:\n%s\n%s" % (in_path, out_path, stdout, stderr))
+        except IOError:
+            raise AnsibleError("file or module does not exist at: %s" % in_path)
+
+    def fetch_file(self, in_path, out_path):
+        """ fetch a file from chroot to local """
+        super(Connection, self).fetch_file(in_path, out_path)
+        display.vvv("FETCH %s TO %s" % (in_path, out_path), host=self.chroot)
+
+        in_path = shlex_quote(self._prefix_login_path(in_path))
+        try:
+            p = self._buffered_exec_command('dd if=%s bs=%s' % (in_path, BUFSIZE))
+        except OSError:
+            raise AnsibleError("chroot connection requires dd command in the chroot")
+
+        with open(to_bytes(out_path, errors='surrogate_or_strict'), 'wb+') as out_file:
+            try:
+                chunk = p.stdout.read(BUFSIZE)
+                while chunk:
+                    out_file.write(chunk)
+                    chunk = p.stdout.read(BUFSIZE)
+            except Exception:
+                traceback.print_exc()
+                raise AnsibleError("failed to transfer file %s to %s" % (in_path, out_path))
+            stdout, stderr = p.communicate()
+            if p.returncode != 0:
+                raise AnsibleError("failed to transfer file %s to %s:\n%s\n%s" % (in_path, out_path, stdout, stderr))
+
+    def close(self):
+        """ terminate the connection; nothing to do here """
+        super(Connection, self).close()
+        self._connected = False

collections/ansible_collections/community/general/plugins/connection/funcd.py

@@ -0,0 +1,107 @@
+# -*- coding: utf-8 -*-
+# Based on local.py (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
+# Based on chroot.py (c) 2013, Maykel Moya <mmoya@speedyrails.com>
+# Copyright (c) 2013, Michael Scherer <misc@zarb.org>
+# Copyright (c) 2017 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 = '''
+    author: Michael Scherer (@mscherer) <misc@zarb.org>
+    name: funcd
+    short_description: Use funcd to connect to target
+    description:
+        - This transport permits you to use Ansible over Func.
+        - For people who have already setup func and that wish to play with ansible,
+          this permit to move gradually to ansible without having to redo completely the setup of the network.
+    options:
+      remote_addr:
+        description:
+            - The path of the chroot you want to access.
+        default: inventory_hostname
+        vars:
+            - name: ansible_host
+            - name: ansible_func_host
+'''
+
+HAVE_FUNC = False
+try:
+    import func.overlord.client as fc
+    HAVE_FUNC = True
+except ImportError:
+    pass
+
+import os
+import tempfile
+import shutil
+
+from ansible.errors import AnsibleError
+from ansible.plugins.connection import ConnectionBase
+from ansible.utils.display import Display
+
+display = Display()
+
+
+class Connection(ConnectionBase):
+    """ Func-based connections """
+
+    has_pipelining = False
+
+    def __init__(self, runner, host, port, *args, **kwargs):
+        self.runner = runner
+        self.host = host
+        # port is unused, this go on func
+        self.port = port
+        self.client = None
+
+    def connect(self, port=None):
+        if not HAVE_FUNC:
+            raise AnsibleError("func is not installed")
+
+        self.client = fc.Client(self.host)
+        return self
+
+    def exec_command(self, cmd, in_data=None, sudoable=True):
+        """ run a command on the remote minion """
+
+        if in_data:
+            raise AnsibleError("Internal Error: this module does not support optimized module pipelining")
+
+        # totally ignores privilege escalation
+        display.vvv("EXEC %s" % cmd, host=self.host)
+        p = self.client.command.run(cmd)[self.host]
+        return p[0], p[1], p[2]
+
+    @staticmethod
+    def _normalize_path(path, prefix):
+        if not path.startswith(os.path.sep):
+            path = os.path.join(os.path.sep, path)
+        normpath = os.path.normpath(path)
+        return os.path.join(prefix, normpath[1:])
+
+    def put_file(self, in_path, out_path):
+        """ transfer a file from local to remote """
+
+        out_path = self._normalize_path(out_path, '/')
+        display.vvv("PUT %s TO %s" % (in_path, out_path), host=self.host)
+        self.client.local.copyfile.send(in_path, out_path)
+
+    def fetch_file(self, in_path, out_path):
+        """ fetch a file from remote to local """
+
+        in_path = self._normalize_path(in_path, '/')
+        display.vvv("FETCH %s TO %s" % (in_path, out_path), host=self.host)
+        # need to use a tmp dir due to difference of semantic for getfile
+        # ( who take a # directory as destination) and fetch_file, who
+        # take a file directly
+        tmpdir = tempfile.mkdtemp(prefix="func_ansible")
+        self.client.local.getfile.get(in_path, tmpdir)
+        shutil.move(os.path.join(tmpdir, self.host, os.path.basename(in_path)), out_path)
+        shutil.rmtree(tmpdir)
+
+    def close(self):
+        """ terminate the connection; nothing to do here """
+        pass

collections/ansible_collections/community/general/plugins/connection/incus.py

@@ -0,0 +1,169 @@
+# -*- coding: utf-8 -*-
+# Based on lxd.py (c) 2016, Matt Clay <matt@mystile.com>
+# (c) 2023, Stephane Graber <stgraber@stgraber.org>
+# Copyright (c) 2023 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 = """
+    author: Stéphane Graber (@stgraber)
+    name: incus
+    short_description: Run tasks in Incus instances via the Incus CLI.
+    description:
+        - Run commands or put/fetch files to an existing Incus instance using Incus CLI.
+    version_added: "8.2.0"
+    options:
+      remote_addr:
+        description:
+            - The instance identifier.
+        default: inventory_hostname
+        vars:
+            - name: inventory_hostname
+            - name: ansible_host
+            - name: ansible_incus_host
+      executable:
+        description:
+            - The shell to use for execution inside the instance.
+        default: /bin/sh
+        vars:
+            - name: ansible_executable
+            - name: ansible_incus_executable
+      remote:
+        description:
+            - The name of the Incus remote to use (per C(incus remote list)).
+            - Remotes are used to access multiple servers from a single client.
+        default: local
+        vars:
+            - name: ansible_incus_remote
+      project:
+        description:
+            - The name of the Incus project to use (per C(incus project list)).
+            - Projects are used to divide the instances running on a server.
+        default: default
+        vars:
+            - name: ansible_incus_project
+"""
+
+import os
+from subprocess import call, Popen, PIPE
+
+from ansible.errors import AnsibleError, AnsibleConnectionFailure, AnsibleFileNotFound
+from ansible.module_utils.common.process import get_bin_path
+from ansible.module_utils._text import to_bytes, to_text
+from ansible.plugins.connection import ConnectionBase
+
+
+class Connection(ConnectionBase):
+    """ Incus based connections """
+
+    transport = "incus"
+    has_pipelining = True
+    default_user = 'root'
+
+    def __init__(self, play_context, new_stdin, *args, **kwargs):
+        super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
+
+        self._incus_cmd = get_bin_path("incus")
+
+        if not self._incus_cmd:
+            raise AnsibleError("incus command not found in PATH")
+
+    def _connect(self):
+        """connect to Incus (nothing to do here) """
+        super(Connection, self)._connect()
+
+        if not self._connected:
+            self._display.vvv(u"ESTABLISH Incus CONNECTION FOR USER: root",
+                              host=self._instance())
+            self._connected = True
+
+    def _instance(self):
+        # Return only the leading part of the FQDN as the instance name
+        # as Incus instance names cannot be a FQDN.
+        return self.get_option('remote_addr').split(".")[0]
+
+    def exec_command(self, cmd, in_data=None, sudoable=True):
+        """ execute a command on the Incus host """
+        super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
+
+        self._display.vvv(u"EXEC {0}".format(cmd),
+                          host=self._instance())
+
+        local_cmd = [
+            self._incus_cmd,
+            "--project", self.get_option("project"),
+            "exec",
+            "%s:%s" % (self.get_option("remote"), self._instance()),
+            "--",
+            self._play_context.executable, "-c", cmd]
+
+        local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
+        in_data = to_bytes(in_data, errors='surrogate_or_strict', nonstring='passthru')
+
+        process = Popen(local_cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE)
+        stdout, stderr = process.communicate(in_data)
+
+        stdout = to_text(stdout)
+        stderr = to_text(stderr)
+
+        if stderr == "Error: Instance is not running.\n":
+            raise AnsibleConnectionFailure("instance not running: %s" %
+                                           self._instance())
+
+        if stderr == "Error: Instance not found\n":
+            raise AnsibleConnectionFailure("instance not found: %s" %
+                                           self._instance())
+
+        return process.returncode, stdout, stderr
+
+    def put_file(self, in_path, out_path):
+        """ put a file from local to Incus """
+        super(Connection, self).put_file(in_path, out_path)
+
+        self._display.vvv(u"PUT {0} TO {1}".format(in_path, out_path),
+                          host=self._instance())
+
+        if not os.path.isfile(to_bytes(in_path, errors='surrogate_or_strict')):
+            raise AnsibleFileNotFound("input path is not a file: %s" % in_path)
+
+        local_cmd = [
+            self._incus_cmd,
+            "--project", self.get_option("project"),
+            "file", "push", "--quiet",
+            in_path,
+            "%s:%s/%s" % (self.get_option("remote"),
+                          self._instance(),
+                          out_path)]
+
+        local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
+
+        call(local_cmd)
+
+    def fetch_file(self, in_path, out_path):
+        """ fetch a file from Incus to local """
+        super(Connection, self).fetch_file(in_path, out_path)
+
+        self._display.vvv(u"FETCH {0} TO {1}".format(in_path, out_path),
+                          host=self._instance())
+
+        local_cmd = [
+            self._incus_cmd,
+            "--project", self.get_option("project"),
+            "file", "pull", "--quiet",
+            "%s:%s/%s" % (self.get_option("remote"),
+                          self._instance(),
+                          in_path),
+            out_path]
+
+        local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
+
+        call(local_cmd)
+
+    def close(self):
+        """ close the connection (nothing to do here) """
+        super(Connection, self).close()
+
+        self._connected = False

collections/ansible_collections/community/general/plugins/connection/iocage.py

@@ -0,0 +1,84 @@
+# -*- coding: utf-8 -*-
+# Based on jail.py
+# (c) 2013, Michael Scherer <misc@zarb.org>
+# (c) 2015, Toshio Kuratomi <tkuratomi@ansible.com>
+# (c) 2016, Stephan Lohse <dev-github@ploek.org>
+# Copyright (c) 2017 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 = '''
+    author: Stephan Lohse (!UNKNOWN) <dev-github@ploek.org>
+    name: iocage
+    short_description: Run tasks in iocage jails
+    description:
+        - Run commands or put/fetch files to an existing iocage jail
+    options:
+      remote_addr:
+        description:
+            - Path to the jail
+        vars:
+            - name: ansible_host
+            - name: ansible_iocage_host
+      remote_user:
+        description:
+            - User to execute as inside the jail
+        vars:
+            - name: ansible_user
+            - name: ansible_iocage_user
+'''
+
+import subprocess
+
+from ansible_collections.community.general.plugins.connection.jail import Connection as Jail
+from ansible.module_utils.common.text.converters import to_native
+from ansible.errors import AnsibleError
+from ansible.utils.display import Display
+
+display = Display()
+
+
+class Connection(Jail):
+    """ Local iocage based connections """
+
+    transport = 'community.general.iocage'
+
+    def __init__(self, play_context, new_stdin, *args, **kwargs):
+        self.ioc_jail = play_context.remote_addr
+
+        self.iocage_cmd = Jail._search_executable('iocage')
+
+        jail_uuid = self.get_jail_uuid()
+
+        kwargs[Jail.modified_jailname_key] = 'ioc-{0}'.format(jail_uuid)
+
+        display.vvv(u"Jail {iocjail} has been translated to {rawjail}".format(
+            iocjail=self.ioc_jail, rawjail=kwargs[Jail.modified_jailname_key]),
+            host=kwargs[Jail.modified_jailname_key])
+
+        super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
+
+    def get_jail_uuid(self):
+        p = subprocess.Popen([self.iocage_cmd, 'get', 'host_hostuuid', self.ioc_jail],
+                             stdin=subprocess.PIPE,
+                             stdout=subprocess.PIPE,
+                             stderr=subprocess.STDOUT)
+
+        stdout, stderr = p.communicate()
+
+        if stdout is not None:
+            stdout = to_native(stdout)
+
+        if stderr is not None:
+            stderr = to_native(stderr)
+
+        # otherwise p.returncode would not be set
+        p.wait()
+
+        if p.returncode != 0:
+            raise AnsibleError(u"iocage returned an error: {0}".format(stdout))
+
+        return stdout.strip('\n')

collections/ansible_collections/community/general/plugins/connection/jail.py

@@ -0,0 +1,204 @@
+# -*- coding: utf-8 -*-
+# Based on local.py by Michael DeHaan <michael.dehaan@gmail.com>
+# and chroot.py by  Maykel Moya <mmoya@speedyrails.com>
+# Copyright (c) 2013, Michael Scherer <misc@zarb.org>
+# Copyright (c) 2015, Toshio Kuratomi <tkuratomi@ansible.com>
+# Copyright (c) 2017 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 = '''
+    author: Ansible Core Team
+    name: jail
+    short_description: Run tasks in jails
+    description:
+        - Run commands or put/fetch files to an existing jail
+    options:
+      remote_addr:
+        description:
+            - Path to the jail
+        default: inventory_hostname
+        vars:
+            - name: inventory_hostname
+            - name: ansible_host
+            - name: ansible_jail_host
+      remote_user:
+        description:
+            - User to execute as inside the jail
+        vars:
+            - name: ansible_user
+            - name: ansible_jail_user
+'''
+
+import os
+import os.path
+import subprocess
+import traceback
+
+from ansible.errors import AnsibleError
+from ansible.module_utils.six.moves import shlex_quote
+from ansible.module_utils.common.process import get_bin_path
+from ansible.module_utils.common.text.converters import to_bytes, to_native, to_text
+from ansible.plugins.connection import ConnectionBase, BUFSIZE
+from ansible.utils.display import Display
+
+display = Display()
+
+
+class Connection(ConnectionBase):
+    """ Local BSD Jail based connections """
+
+    modified_jailname_key = 'conn_jail_name'
+
+    transport = 'community.general.jail'
+    # Pipelining may work.  Someone needs to test by setting this to True and
+    # having pipelining=True in their ansible.cfg
+    has_pipelining = True
+    has_tty = False
+
+    def __init__(self, play_context, new_stdin, *args, **kwargs):
+        super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
+
+        self.jail = self._play_context.remote_addr
+        if self.modified_jailname_key in kwargs:
+            self.jail = kwargs[self.modified_jailname_key]
+
+        if os.geteuid() != 0:
+            raise AnsibleError("jail connection requires running as root")
+
+        self.jls_cmd = self._search_executable('jls')
+        self.jexec_cmd = self._search_executable('jexec')
+
+        if self.jail not in self.list_jails():
+            raise AnsibleError("incorrect jail name %s" % self.jail)
+
+    @staticmethod
+    def _search_executable(executable):
+        try:
+            return get_bin_path(executable)
+        except ValueError:
+            raise AnsibleError("%s command not found in PATH" % executable)
+
+    def list_jails(self):
+        p = subprocess.Popen([self.jls_cmd, '-q', 'name'],
+                             stdin=subprocess.PIPE,
+                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+
+        stdout, stderr = p.communicate()
+
+        return to_text(stdout, errors='surrogate_or_strict').split()
+
+    def _connect(self):
+        """ connect to the jail; nothing to do here """
+        super(Connection, self)._connect()
+        if not self._connected:
+            display.vvv(u"ESTABLISH JAIL CONNECTION FOR USER: {0}".format(self._play_context.remote_user), host=self.jail)
+            self._connected = True
+
+    def _buffered_exec_command(self, cmd, stdin=subprocess.PIPE):
+        """ run a command on the jail.  This is only needed for implementing
+        put_file() get_file() so that we don't have to read the whole file
+        into memory.
+
+        compared to exec_command() it looses some niceties like being able to
+        return the process's exit code immediately.
+        """
+
+        local_cmd = [self.jexec_cmd]
+        set_env = ''
+
+        if self._play_context.remote_user is not None:
+            local_cmd += ['-U', self._play_context.remote_user]
+            # update HOME since -U does not update the jail environment
+            set_env = 'HOME=~' + self._play_context.remote_user + ' '
+
+        local_cmd += [self.jail, self._play_context.executable, '-c', set_env + cmd]
+
+        display.vvv("EXEC %s" % (local_cmd,), host=self.jail)
+        local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
+        p = subprocess.Popen(local_cmd, shell=False, stdin=stdin,
+                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+
+        return p
+
+    def exec_command(self, cmd, in_data=None, sudoable=False):
+        """ run a command on the jail """
+        super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
+
+        p = self._buffered_exec_command(cmd)
+
+        stdout, stderr = p.communicate(in_data)
+        return p.returncode, stdout, stderr
+
+    @staticmethod
+    def _prefix_login_path(remote_path):
+        """ Make sure that we put files into a standard path
+
+            If a path is relative, then we need to choose where to put it.
+            ssh chooses $HOME but we aren't guaranteed that a home dir will
+            exist in any given chroot.  So for now we're choosing "/" instead.
+            This also happens to be the former default.
+
+            Can revisit using $HOME instead if it's a problem
+        """
+        if not remote_path.startswith(os.path.sep):
+            remote_path = os.path.join(os.path.sep, remote_path)
+        return os.path.normpath(remote_path)
+
+    def put_file(self, in_path, out_path):
+        """ transfer a file from local to jail """
+        super(Connection, self).put_file(in_path, out_path)
+        display.vvv("PUT %s TO %s" % (in_path, out_path), host=self.jail)
+
+        out_path = shlex_quote(self._prefix_login_path(out_path))
+        try:
+            with open(to_bytes(in_path, errors='surrogate_or_strict'), 'rb') as in_file:
+                if not os.fstat(in_file.fileno()).st_size:
+                    count = ' count=0'
+                else:
+                    count = ''
+                try:
+                    p = self._buffered_exec_command('dd of=%s bs=%s%s' % (out_path, BUFSIZE, count), stdin=in_file)
+                except OSError:
+                    raise AnsibleError("jail connection requires dd command in the jail")
+                try:
+                    stdout, stderr = p.communicate()
+                except Exception:
+                    traceback.print_exc()
+                    raise AnsibleError("failed to transfer file %s to %s" % (in_path, out_path))
+                if p.returncode != 0:
+                    raise AnsibleError("failed to transfer file %s to %s:\n%s\n%s" % (in_path, out_path, to_native(stdout), to_native(stderr)))
+        except IOError:
+            raise AnsibleError("file or module does not exist at: %s" % in_path)
+
+    def fetch_file(self, in_path, out_path):
+        """ fetch a file from jail to local """
+        super(Connection, self).fetch_file(in_path, out_path)
+        display.vvv("FETCH %s TO %s" % (in_path, out_path), host=self.jail)
+
+        in_path = shlex_quote(self._prefix_login_path(in_path))
+        try:
+            p = self._buffered_exec_command('dd if=%s bs=%s' % (in_path, BUFSIZE))
+        except OSError:
+            raise AnsibleError("jail connection requires dd command in the jail")
+
+        with open(to_bytes(out_path, errors='surrogate_or_strict'), 'wb+') as out_file:
+            try:
+                chunk = p.stdout.read(BUFSIZE)
+                while chunk:
+                    out_file.write(chunk)
+                    chunk = p.stdout.read(BUFSIZE)
+            except Exception:
+                traceback.print_exc()
+                raise AnsibleError("failed to transfer file %s to %s" % (in_path, out_path))
+            stdout, stderr = p.communicate()
+            if p.returncode != 0:
+                raise AnsibleError("failed to transfer file %s to %s:\n%s\n%s" % (in_path, out_path, to_native(stdout), to_native(stderr)))
+
+    def close(self):
+        """ terminate the connection; nothing to do here """
+        super(Connection, self).close()
+        self._connected = False

collections/ansible_collections/community/general/plugins/connection/lxc.py

@@ -0,0 +1,234 @@
+# -*- coding: utf-8 -*-
+# (c) 2015, Joerg Thalheim <joerg@higgsboson.tk>
+# Copyright (c) 2017 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 = '''
+    author: Joerg Thalheim (!UNKNOWN) <joerg@higgsboson.tk>
+    name: lxc
+    short_description: Run tasks in lxc containers via lxc python library
+    description:
+        - Run commands or put/fetch files to an existing lxc container using lxc python library
+    options:
+      remote_addr:
+        description:
+            - Container identifier
+        default: inventory_hostname
+        vars:
+            - name: inventory_hostname
+            - name: ansible_host
+            - name: ansible_lxc_host
+      executable:
+        default: /bin/sh
+        description:
+            - Shell executable
+        vars:
+            - name: ansible_executable
+            - name: ansible_lxc_executable
+'''
+
+import os
+import shutil
+import traceback
+import select
+import fcntl
+import errno
+
+HAS_LIBLXC = False
+try:
+    import lxc as _lxc
+    HAS_LIBLXC = True
+except ImportError:
+    pass
+
+from ansible import errors
+from ansible.module_utils.common.text.converters import to_bytes, to_native
+from ansible.plugins.connection import ConnectionBase
+
+
+class Connection(ConnectionBase):
+    """ Local lxc based connections """
+
+    transport = 'community.general.lxc'
+    has_pipelining = True
+    default_user = 'root'
+
+    def __init__(self, play_context, new_stdin, *args, **kwargs):
+        super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
+
+        self.container_name = None
+        self.container = None
+
+    def _connect(self):
+        """ connect to the lxc; nothing to do here """
+        super(Connection, self)._connect()
+
+        if not HAS_LIBLXC:
+            msg = "lxc python bindings are not installed"
+            raise errors.AnsibleError(msg)
+
+        container_name = self.get_option('remote_addr')
+        if self.container and self.container_name == container_name:
+            return
+
+        self.container_name = container_name
+
+        self._display.vvv("THIS IS A LOCAL LXC DIR", host=self.container_name)
+        self.container = _lxc.Container(self.container_name)
+        if self.container.state == "STOPPED":
+            raise errors.AnsibleError("%s is not running" % self.container_name)
+
+    @staticmethod
+    def _communicate(pid, in_data, stdin, stdout, stderr):
+        buf = {stdout: [], stderr: []}
+        read_fds = [stdout, stderr]
+        if in_data:
+            write_fds = [stdin]
+        else:
+            write_fds = []
+        while len(read_fds) > 0 or len(write_fds) > 0:
+            try:
+                ready_reads, ready_writes, dummy = select.select(read_fds, write_fds, [])
+            except select.error as e:
+                if e.args[0] == errno.EINTR:
+                    continue
+                raise
+            for fd in ready_writes:
+                in_data = in_data[os.write(fd, in_data):]
+                if len(in_data) == 0:
+                    write_fds.remove(fd)
+            for fd in ready_reads:
+                data = os.read(fd, 32768)
+                if not data:
+                    read_fds.remove(fd)
+                buf[fd].append(data)
+
+        (pid, returncode) = os.waitpid(pid, 0)
+
+        return returncode, b"".join(buf[stdout]), b"".join(buf[stderr])
+
+    def _set_nonblocking(self, fd):
+        flags = fcntl.fcntl(fd, fcntl.F_GETFL) | os.O_NONBLOCK
+        fcntl.fcntl(fd, fcntl.F_SETFL, flags)
+        return fd
+
+    def exec_command(self, cmd, in_data=None, sudoable=False):
+        """ run a command on the chroot """
+        super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
+
+        # python2-lxc needs bytes. python3-lxc needs text.
+        executable = to_native(self.get_option('executable'), errors='surrogate_or_strict')
+        local_cmd = [executable, '-c', to_native(cmd, errors='surrogate_or_strict')]
+
+        read_stdout, write_stdout = None, None
+        read_stderr, write_stderr = None, None
+        read_stdin, write_stdin = None, None
+
+        try:
+            read_stdout, write_stdout = os.pipe()
+            read_stderr, write_stderr = os.pipe()
+
+            kwargs = {
+                'stdout': self._set_nonblocking(write_stdout),
+                'stderr': self._set_nonblocking(write_stderr),
+                'env_policy': _lxc.LXC_ATTACH_CLEAR_ENV
+            }
+
+            if in_data:
+                read_stdin, write_stdin = os.pipe()
+                kwargs['stdin'] = self._set_nonblocking(read_stdin)
+
+            self._display.vvv("EXEC %s" % (local_cmd), host=self.container_name)
+            pid = self.container.attach(_lxc.attach_run_command, local_cmd, **kwargs)
+            if pid == -1:
+                msg = "failed to attach to container %s" % self.container_name
+                raise errors.AnsibleError(msg)
+
+            write_stdout = os.close(write_stdout)
+            write_stderr = os.close(write_stderr)
+            if read_stdin:
+                read_stdin = os.close(read_stdin)
+
+            return self._communicate(pid,
+                                     in_data,
+                                     write_stdin,
+                                     read_stdout,
+                                     read_stderr)
+        finally:
+            fds = [read_stdout,
+                   write_stdout,
+                   read_stderr,
+                   write_stderr,
+                   read_stdin,
+                   write_stdin]
+            for fd in fds:
+                if fd:
+                    os.close(fd)
+
+    def put_file(self, in_path, out_path):
+        ''' transfer a file from local to lxc '''
+        super(Connection, self).put_file(in_path, out_path)
+        self._display.vvv("PUT %s TO %s" % (in_path, out_path), host=self.container_name)
+        in_path = to_bytes(in_path, errors='surrogate_or_strict')
+        out_path = to_bytes(out_path, errors='surrogate_or_strict')
+
+        if not os.path.exists(in_path):
+            msg = "file or module does not exist: %s" % in_path
+            raise errors.AnsibleFileNotFound(msg)
+        try:
+            src_file = open(in_path, "rb")
+        except IOError:
+            traceback.print_exc()
+            raise errors.AnsibleError("failed to open input file to %s" % in_path)
+        try:
+            def write_file(args):
+                with open(out_path, 'wb+') as dst_file:
+                    shutil.copyfileobj(src_file, dst_file)
+            try:
+                self.container.attach_wait(write_file, None)
+            except IOError:
+                traceback.print_exc()
+                msg = "failed to transfer file to %s" % out_path
+                raise errors.AnsibleError(msg)
+        finally:
+            src_file.close()
+
+    def fetch_file(self, in_path, out_path):
+        ''' fetch a file from lxc to local '''
+        super(Connection, self).fetch_file(in_path, out_path)
+        self._display.vvv("FETCH %s TO %s" % (in_path, out_path), host=self.container_name)
+        in_path = to_bytes(in_path, errors='surrogate_or_strict')
+        out_path = to_bytes(out_path, errors='surrogate_or_strict')
+
+        try:
+            dst_file = open(out_path, "wb")
+        except IOError:
+            traceback.print_exc()
+            msg = "failed to open output file %s" % out_path
+            raise errors.AnsibleError(msg)
+        try:
+            def write_file(args):
+                try:
+                    with open(in_path, 'rb') as src_file:
+                        shutil.copyfileobj(src_file, dst_file)
+                finally:
+                    # this is needed in the lxc child process
+                    # to flush internal python buffers
+                    dst_file.close()
+            try:
+                self.container.attach_wait(write_file, None)
+            except IOError:
+                traceback.print_exc()
+                msg = "failed to transfer file from %s to %s" % (in_path, out_path)
+                raise errors.AnsibleError(msg)
+        finally:
+            dst_file.close()
+
+    def close(self):
+        ''' terminate the connection; nothing to do here '''
+        super(Connection, self).close()
+        self._connected = False

collections/ansible_collections/community/general/plugins/connection/lxd.py

@@ -0,0 +1,172 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2016 Matt Clay <matt@mystile.com>
+# Copyright (c) 2017 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 = '''
+    author: Matt Clay (@mattclay) <matt@mystile.com>
+    name: lxd
+    short_description: Run tasks in LXD instances via C(lxc) CLI
+    description:
+        - Run commands or put/fetch files to an existing instance using C(lxc) CLI.
+    options:
+      remote_addr:
+        description:
+            - Instance (container/VM) identifier.
+            - Since community.general 8.0.0, a FQDN can be provided; in that case, the first component (the part before C(.))
+              is used as the instance identifier.
+        default: inventory_hostname
+        vars:
+            - name: inventory_hostname
+            - name: ansible_host
+            - name: ansible_lxd_host
+      executable:
+        description:
+            - Shell to use for execution inside instance.
+        default: /bin/sh
+        vars:
+            - name: ansible_executable
+            - name: ansible_lxd_executable
+      remote:
+        description:
+            - Name of the LXD remote to use.
+        default: local
+        vars:
+            - name: ansible_lxd_remote
+        version_added: 2.0.0
+      project:
+        description:
+            - Name of the LXD project to use.
+        vars:
+            - name: ansible_lxd_project
+        version_added: 2.0.0
+'''
+
+import os
+from subprocess import Popen, PIPE
+
+from ansible.errors import AnsibleError, AnsibleConnectionFailure, AnsibleFileNotFound
+from ansible.module_utils.common.process import get_bin_path
+from ansible.module_utils.common.text.converters import to_bytes, to_text
+from ansible.plugins.connection import ConnectionBase
+
+
+class Connection(ConnectionBase):
+    """ lxd based connections """
+
+    transport = 'community.general.lxd'
+    has_pipelining = True
+    default_user = 'root'
+
+    def __init__(self, play_context, new_stdin, *args, **kwargs):
+        super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
+
+        try:
+            self._lxc_cmd = get_bin_path("lxc")
+        except ValueError:
+            raise AnsibleError("lxc command not found in PATH")
+
+        if self._play_context.remote_user is not None and self._play_context.remote_user != 'root':
+            self._display.warning('lxd does not support remote_user, using default: root')
+
+    def _host(self):
+        """ translate remote_addr to lxd (short) hostname """
+        return self.get_option("remote_addr").split(".", 1)[0]
+
+    def _connect(self):
+        """connect to lxd (nothing to do here) """
+        super(Connection, self)._connect()
+
+        if not self._connected:
+            self._display.vvv(u"ESTABLISH LXD CONNECTION FOR USER: root", host=self._host())
+            self._connected = True
+
+    def exec_command(self, cmd, in_data=None, sudoable=True):
+        """ execute a command on the lxd host """
+        super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
+
+        self._display.vvv(u"EXEC {0}".format(cmd), host=self._host())
+
+        local_cmd = [self._lxc_cmd]
+        if self.get_option("project"):
+            local_cmd.extend(["--project", self.get_option("project")])
+        local_cmd.extend([
+            "exec",
+            "%s:%s" % (self.get_option("remote"), self._host()),
+            "--",
+            self.get_option("executable"), "-c", cmd
+        ])
+
+        self._display.vvvvv(u"EXEC {0}".format(local_cmd), host=self._host())
+
+        local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
+        in_data = to_bytes(in_data, errors='surrogate_or_strict', nonstring='passthru')
+
+        process = Popen(local_cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE)
+        stdout, stderr = process.communicate(in_data)
+
+        stdout = to_text(stdout)
+        stderr = to_text(stderr)
+
+        self._display.vvvvv(u"EXEC lxc output: {0} {1}".format(stdout, stderr), host=self._host())
+
+        if "is not running" in stderr:
+            raise AnsibleConnectionFailure("instance not running: %s" % self._host())
+
+        if stderr.strip() == "Error: Instance not found" or stderr.strip() == "error: not found":
+            raise AnsibleConnectionFailure("instance not found: %s" % self._host())
+
+        return process.returncode, stdout, stderr
+
+    def put_file(self, in_path, out_path):
+        """ put a file from local to lxd """
+        super(Connection, self).put_file(in_path, out_path)
+
+        self._display.vvv(u"PUT {0} TO {1}".format(in_path, out_path), host=self._host())
+
+        if not os.path.isfile(to_bytes(in_path, errors='surrogate_or_strict')):
+            raise AnsibleFileNotFound("input path is not a file: %s" % in_path)
+
+        local_cmd = [self._lxc_cmd]
+        if self.get_option("project"):
+            local_cmd.extend(["--project", self.get_option("project")])
+        local_cmd.extend([
+            "file", "push",
+            in_path,
+            "%s:%s/%s" % (self.get_option("remote"), self._host(), out_path)
+        ])
+
+        local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
+
+        process = Popen(local_cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE)
+        process.communicate()
+
+    def fetch_file(self, in_path, out_path):
+        """ fetch a file from lxd to local """
+        super(Connection, self).fetch_file(in_path, out_path)
+
+        self._display.vvv(u"FETCH {0} TO {1}".format(in_path, out_path), host=self._host())
+
+        local_cmd = [self._lxc_cmd]
+        if self.get_option("project"):
+            local_cmd.extend(["--project", self.get_option("project")])
+        local_cmd.extend([
+            "file", "pull",
+            "%s:%s/%s" % (self.get_option("remote"), self._host(), in_path),
+            out_path
+        ])
+
+        local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
+
+        process = Popen(local_cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE)
+        process.communicate()
+
+    def close(self):
+        """ close the connection (nothing to do here) """
+        super(Connection, self).close()
+
+        self._connected = False

collections/ansible_collections/community/general/plugins/connection/qubes.py

@@ -0,0 +1,155 @@
+# -*- coding: utf-8 -*-
+# Based on the buildah connection plugin
+# Copyright (c) 2017 Ansible Project
+#               2018 Kushal Das
+# 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
+#
+#
+# Written by: Kushal Das (https://github.com/kushaldas)
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+
+DOCUMENTATION = '''
+    name: qubes
+    short_description: Interact with an existing QubesOS AppVM
+
+    description:
+        - Run commands or put/fetch files to an existing Qubes AppVM using qubes tools.
+
+    author: Kushal Das (@kushaldas)
+
+
+    options:
+      remote_addr:
+        description:
+            - vm name
+        default: inventory_hostname
+        vars:
+            - name: ansible_host
+      remote_user:
+        description:
+            - The user to execute as inside the vm.
+        default: The *user* account as default in Qubes OS.
+        vars:
+            - name: ansible_user
+#        keyword:
+#            - name: hosts
+'''
+
+import subprocess
+
+from ansible.module_utils.common.text.converters import to_bytes
+from ansible.plugins.connection import ConnectionBase, ensure_connect
+from ansible.errors import AnsibleConnectionFailure
+from ansible.utils.display import Display
+
+display = Display()
+
+
+# this _has to be_ named Connection
+class Connection(ConnectionBase):
+    """This is a connection plugin for qubes: it uses qubes-run-vm binary to interact with the containers."""
+
+    # String used to identify this Connection class from other classes
+    transport = 'community.general.qubes'
+    has_pipelining = True
+
+    def __init__(self, play_context, new_stdin, *args, **kwargs):
+        super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
+
+        self._remote_vmname = self._play_context.remote_addr
+        self._connected = False
+        # Default username in Qubes
+        self.user = "user"
+        if self._play_context.remote_user:
+            self.user = self._play_context.remote_user
+
+    def _qubes(self, cmd=None, in_data=None, shell="qubes.VMShell"):
+        """run qvm-run executable
+
+        :param cmd: cmd string for remote system
+        :param in_data: data passed to qvm-run-vm's stdin
+        :return: return code, stdout, stderr
+        """
+        display.vvvv("CMD: ", cmd)
+        if not cmd.endswith("\n"):
+            cmd = cmd + "\n"
+        local_cmd = []
+
+        # For dom0
+        local_cmd.extend(["qvm-run", "--pass-io", "--service"])
+        if self.user != "user":
+            # Means we have a remote_user value
+            local_cmd.extend(["-u", self.user])
+
+        local_cmd.append(self._remote_vmname)
+
+        local_cmd.append(shell)
+
+        local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
+
+        display.vvvv("Local cmd: ", local_cmd)
+
+        display.vvv("RUN %s" % (local_cmd,), host=self._remote_vmname)
+        p = subprocess.Popen(local_cmd, shell=False, stdin=subprocess.PIPE,
+                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+
+        # Here we are writing the actual command to the remote bash
+        p.stdin.write(to_bytes(cmd, errors='surrogate_or_strict'))
+        stdout, stderr = p.communicate(input=in_data)
+        return p.returncode, stdout, stderr
+
+    def _connect(self):
+        """No persistent connection is being maintained."""
+        super(Connection, self)._connect()
+        self._connected = True
+
+    @ensure_connect
+    def exec_command(self, cmd, in_data=None, sudoable=False):
+        """Run specified command in a running QubesVM """
+        super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
+
+        display.vvvv("CMD IS: %s" % cmd)
+
+        rc, stdout, stderr = self._qubes(cmd)
+
+        display.vvvvv("STDOUT %r STDERR %r" % (stderr, stderr))
+        return rc, stdout, stderr
+
+    def put_file(self, in_path, out_path):
+        """ Place a local file located in 'in_path' inside VM at 'out_path' """
+        super(Connection, self).put_file(in_path, out_path)
+        display.vvv("PUT %s TO %s" % (in_path, out_path), host=self._remote_vmname)
+
+        with open(in_path, "rb") as fobj:
+            source_data = fobj.read()
+
+        retcode, dummy, dummy = self._qubes('cat > "{0}"\n'.format(out_path), source_data, "qubes.VMRootShell")
+        # if qubes.VMRootShell service not supported, fallback to qubes.VMShell and
+        # hope it will have appropriate permissions
+        if retcode == 127:
+            retcode, dummy, dummy = self._qubes('cat > "{0}"\n'.format(out_path), source_data)
+
+        if retcode != 0:
+            raise AnsibleConnectionFailure('Failed to put_file to {0}'.format(out_path))
+
+    def fetch_file(self, in_path, out_path):
+        """Obtain file specified via 'in_path' from the container and place it at 'out_path' """
+        super(Connection, self).fetch_file(in_path, out_path)
+        display.vvv("FETCH %s TO %s" % (in_path, out_path), host=self._remote_vmname)
+
+        # We are running in dom0
+        cmd_args_list = ["qvm-run", "--pass-io", self._remote_vmname, "cat {0}".format(in_path)]
+        with open(out_path, "wb") as fobj:
+            p = subprocess.Popen(cmd_args_list, shell=False, stdout=fobj)
+            p.communicate()
+            if p.returncode != 0:
+                raise AnsibleConnectionFailure('Failed to fetch file to {0}'.format(out_path))
+
+    def close(self):
+        """ Closing the connection """
+        super(Connection, self).close()
+        self._connected = False

collections/ansible_collections/community/general/plugins/connection/saltstack.py

@@ -0,0 +1,102 @@
+# -*- coding: utf-8 -*-
+# Based on local.py (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
+# Based on chroot.py (c) 2013, Maykel Moya <mmoya@speedyrails.com>
+# Based on func.py
+# Copyright (c) 2014, Michael Scherer <misc@zarb.org>
+# Copyright (c) 2017 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 = '''
+    author: Michael Scherer (@mscherer) <misc@zarb.org>
+    name: saltstack
+    short_description: Allow ansible to piggyback on salt minions
+    description:
+        - This allows you to use existing Saltstack infrastructure to connect to targets.
+'''
+
+import os
+import base64
+
+from ansible import errors
+from ansible.plugins.connection import ConnectionBase
+
+HAVE_SALTSTACK = False
+try:
+    import salt.client as sc
+    HAVE_SALTSTACK = True
+except ImportError:
+    pass
+
+
+class Connection(ConnectionBase):
+    """ Salt-based connections """
+
+    has_pipelining = False
+    # while the name of the product is salt, naming that module salt cause
+    # trouble with module import
+    transport = 'community.general.saltstack'
+
+    def __init__(self, play_context, new_stdin, *args, **kwargs):
+        super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
+        self.host = self._play_context.remote_addr
+
+    def _connect(self):
+        if not HAVE_SALTSTACK:
+            raise errors.AnsibleError("saltstack is not installed")
+
+        self.client = sc.LocalClient()
+        self._connected = True
+        return self
+
+    def exec_command(self, cmd, in_data=None, sudoable=False):
+        """ run a command on the remote minion """
+        super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
+
+        if in_data:
+            raise errors.AnsibleError("Internal Error: this module does not support optimized module pipelining")
+
+        self._display.vvv("EXEC %s" % cmd, host=self.host)
+        # need to add 'true;' to work around https://github.com/saltstack/salt/issues/28077
+        res = self.client.cmd(self.host, 'cmd.exec_code_all', ['bash', 'true;' + cmd])
+        if self.host not in res:
+            raise errors.AnsibleError("Minion %s didn't answer, check if salt-minion is running and the name is correct" % self.host)
+
+        p = res[self.host]
+        return p['retcode'], p['stdout'], p['stderr']
+
+    @staticmethod
+    def _normalize_path(path, prefix):
+        if not path.startswith(os.path.sep):
+            path = os.path.join(os.path.sep, path)
+        normpath = os.path.normpath(path)
+        return os.path.join(prefix, normpath[1:])
+
+    def put_file(self, in_path, out_path):
+        """ transfer a file from local to remote """
+
+        super(Connection, self).put_file(in_path, out_path)
+
+        out_path = self._normalize_path(out_path, '/')
+        self._display.vvv("PUT %s TO %s" % (in_path, out_path), host=self.host)
+        with open(in_path, 'rb') as in_fh:
+            content = in_fh.read()
+        self.client.cmd(self.host, 'hashutil.base64_decodefile', [base64.b64encode(content), out_path])
+
+    # TODO test it
+    def fetch_file(self, in_path, out_path):
+        """ fetch a file from remote to local """
+
+        super(Connection, self).fetch_file(in_path, out_path)
+
+        in_path = self._normalize_path(in_path, '/')
+        self._display.vvv("FETCH %s TO %s" % (in_path, out_path), host=self.host)
+        content = self.client.cmd(self.host, 'cp.get_file_str', [in_path])[self.host]
+        open(out_path, 'wb').write(content)
+
+    def close(self):
+        """ terminate the connection; nothing to do here """
+        pass

collections/ansible_collections/community/general/plugins/connection/zone.py

@@ -0,0 +1,201 @@
+# -*- coding: utf-8 -*-
+# Based on local.py (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
+# and chroot.py     (c) 2013, Maykel Moya <mmoya@speedyrails.com>
+# and jail.py       (c) 2013, Michael Scherer <misc@zarb.org>
+# (c) 2015, Dagobert Michelsen <dam@baltic-online.de>
+# (c) 2015, Toshio Kuratomi <tkuratomi@ansible.com>
+# Copyright (c) 2017 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 = '''
+    author: Ansible Core Team
+    name: zone
+    short_description: Run tasks in a zone instance
+    description:
+        - Run commands or put/fetch files to an existing zone
+    options:
+      remote_addr:
+        description:
+            - Zone identifier
+        default: inventory_hostname
+        vars:
+            - name: ansible_host
+            - name: ansible_zone_host
+'''
+
+import os
+import os.path
+import subprocess
+import traceback
+
+from ansible.errors import AnsibleError
+from ansible.module_utils.six.moves import shlex_quote
+from ansible.module_utils.common.process import get_bin_path
+from ansible.module_utils.common.text.converters import to_bytes
+from ansible.plugins.connection import ConnectionBase, BUFSIZE
+from ansible.utils.display import Display
+
+display = Display()
+
+
+class Connection(ConnectionBase):
+    """ Local zone based connections """
+
+    transport = 'community.general.zone'
+    has_pipelining = True
+    has_tty = False
+
+    def __init__(self, play_context, new_stdin, *args, **kwargs):
+        super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
+
+        self.zone = self._play_context.remote_addr
+
+        if os.geteuid() != 0:
+            raise AnsibleError("zone connection requires running as root")
+
+        self.zoneadm_cmd = to_bytes(self._search_executable('zoneadm'))
+        self.zlogin_cmd = to_bytes(self._search_executable('zlogin'))
+
+        if self.zone not in self.list_zones():
+            raise AnsibleError("incorrect zone name %s" % self.zone)
+
+    @staticmethod
+    def _search_executable(executable):
+        try:
+            return get_bin_path(executable)
+        except ValueError:
+            raise AnsibleError("%s command not found in PATH" % executable)
+
+    def list_zones(self):
+        process = subprocess.Popen([self.zoneadm_cmd, 'list', '-ip'],
+                                   stdin=subprocess.PIPE,
+                                   stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+
+        zones = []
+        for line in process.stdout.readlines():
+            # 1:work:running:/zones/work:3126dc59-9a07-4829-cde9-a816e4c5040e:native:shared
+            s = line.split(':')
+            if s[1] != 'global':
+                zones.append(s[1])
+
+        return zones
+
+    def get_zone_path(self):
+        # solaris10vm# zoneadm -z cswbuild list -p
+        # -:cswbuild:installed:/zones/cswbuild:479f3c4b-d0c6-e97b-cd04-fd58f2c0238e:native:shared
+        process = subprocess.Popen([self.zoneadm_cmd, '-z', to_bytes(self.zone), 'list', '-p'],
+                                   stdin=subprocess.PIPE,
+                                   stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+
+        # stdout, stderr = p.communicate()
+        path = process.stdout.readlines()[0].split(':')[3]
+        return path + '/root'
+
+    def _connect(self):
+        """ connect to the zone; nothing to do here """
+        super(Connection, self)._connect()
+        if not self._connected:
+            display.vvv("THIS IS A LOCAL ZONE DIR", host=self.zone)
+            self._connected = True
+
+    def _buffered_exec_command(self, cmd, stdin=subprocess.PIPE):
+        """ run a command on the zone.  This is only needed for implementing
+        put_file() get_file() so that we don't have to read the whole file
+        into memory.
+
+        compared to exec_command() it looses some niceties like being able to
+        return the process's exit code immediately.
+        """
+        # NOTE: zlogin invokes a shell (just like ssh does) so we do not pass
+        # this through /bin/sh -c here.  Instead it goes through the shell
+        # that zlogin selects.
+        local_cmd = [self.zlogin_cmd, self.zone, cmd]
+        local_cmd = map(to_bytes, local_cmd)
+
+        display.vvv("EXEC %s" % (local_cmd), host=self.zone)
+        p = subprocess.Popen(local_cmd, shell=False, stdin=stdin,
+                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+
+        return p
+
+    def exec_command(self, cmd, in_data=None, sudoable=False):
+        """ run a command on the zone """
+        super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
+
+        p = self._buffered_exec_command(cmd)
+
+        stdout, stderr = p.communicate(in_data)
+        return p.returncode, stdout, stderr
+
+    def _prefix_login_path(self, remote_path):
+        """ Make sure that we put files into a standard path
+
+            If a path is relative, then we need to choose where to put it.
+            ssh chooses $HOME but we aren't guaranteed that a home dir will
+            exist in any given chroot.  So for now we're choosing "/" instead.
+            This also happens to be the former default.
+
+            Can revisit using $HOME instead if it's a problem
+        """
+        if not remote_path.startswith(os.path.sep):
+            remote_path = os.path.join(os.path.sep, remote_path)
+        return os.path.normpath(remote_path)
+
+    def put_file(self, in_path, out_path):
+        """ transfer a file from local to zone """
+        super(Connection, self).put_file(in_path, out_path)
+        display.vvv("PUT %s TO %s" % (in_path, out_path), host=self.zone)
+
+        out_path = shlex_quote(self._prefix_login_path(out_path))
+        try:
+            with open(in_path, 'rb') as in_file:
+                if not os.fstat(in_file.fileno()).st_size:
+                    count = ' count=0'
+                else:
+                    count = ''
+                try:
+                    p = self._buffered_exec_command('dd of=%s bs=%s%s' % (out_path, BUFSIZE, count), stdin=in_file)
+                except OSError:
+                    raise AnsibleError("jail connection requires dd command in the jail")
+                try:
+                    stdout, stderr = p.communicate()
+                except Exception:
+                    traceback.print_exc()
+                    raise AnsibleError("failed to transfer file %s to %s" % (in_path, out_path))
+                if p.returncode != 0:
+                    raise AnsibleError("failed to transfer file %s to %s:\n%s\n%s" % (in_path, out_path, stdout, stderr))
+        except IOError:
+            raise AnsibleError("file or module does not exist at: %s" % in_path)
+
+    def fetch_file(self, in_path, out_path):
+        """ fetch a file from zone to local """
+        super(Connection, self).fetch_file(in_path, out_path)
+        display.vvv("FETCH %s TO %s" % (in_path, out_path), host=self.zone)
+
+        in_path = shlex_quote(self._prefix_login_path(in_path))
+        try:
+            p = self._buffered_exec_command('dd if=%s bs=%s' % (in_path, BUFSIZE))
+        except OSError:
+            raise AnsibleError("zone connection requires dd command in the zone")
+
+        with open(out_path, 'wb+') as out_file:
+            try:
+                chunk = p.stdout.read(BUFSIZE)
+                while chunk:
+                    out_file.write(chunk)
+                    chunk = p.stdout.read(BUFSIZE)
+            except Exception:
+                traceback.print_exc()
+                raise AnsibleError("failed to transfer file %s to %s" % (in_path, out_path))
+            stdout, stderr = p.communicate()
+            if p.returncode != 0:
+                raise AnsibleError("failed to transfer file %s to %s:\n%s\n%s" % (in_path, out_path, stdout, stderr))
+
+    def close(self):
+        """ terminate the connection; nothing to do here """
+        super(Connection, self).close()
+        self._connected = False