summaryrefslogtreecommitdiffstats
path: root/ansible_collections/community/docker/plugins/connection
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 16:03:42 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 16:03:42 +0000
commit66cec45960ce1d9c794e9399de15c138acb18aed (patch)
tree59cd19d69e9d56b7989b080da7c20ef1a3fe2a5a /ansible_collections/community/docker/plugins/connection
parentInitial commit. (diff)
downloadansible-upstream.tar.xz
ansible-upstream.zip
Adding upstream version 7.3.0+dfsg.upstream/7.3.0+dfsgupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ansible_collections/community/docker/plugins/connection')
-rw-r--r--ansible_collections/community/docker/plugins/connection/docker.py452
-rw-r--r--ansible_collections/community/docker/plugins/connection/docker_api.py338
-rw-r--r--ansible_collections/community/docker/plugins/connection/nsenter.py239
3 files changed, 1029 insertions, 0 deletions
diff --git a/ansible_collections/community/docker/plugins/connection/docker.py b/ansible_collections/community/docker/plugins/connection/docker.py
new file mode 100644
index 00000000..ba224929
--- /dev/null
+++ b/ansible_collections/community/docker/plugins/connection/docker.py
@@ -0,0 +1,452 @@
+# Based on the chroot connection plugin by Maykel Moya
+#
+# (c) 2014, Lorin Hochstein
+# (c) 2015, Leendert Brouwer (https://github.com/objectified)
+# (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:
+ - Lorin Hochestein (!UNKNOWN)
+ - Leendert Brouwer (!UNKNOWN)
+name: docker
+short_description: Run tasks in docker containers
+description:
+ - Run commands or put/fetch files to an existing docker container.
+ - Uses the Docker CLI to execute commands in the container. If you prefer
+ to directly connect to the Docker daemon, use the
+ R(community.docker.docker_api,ansible_collections.community.docker.docker_api_connection)
+ connection plugin.
+options:
+ remote_addr:
+ description:
+ - The name of the container you want to access.
+ default: inventory_hostname
+ vars:
+ - name: inventory_hostname
+ - name: ansible_host
+ - name: ansible_docker_host
+ remote_user:
+ description:
+ - The user to execute as inside the container.
+ - If Docker is too old to allow this (< 1.7), the one set by Docker itself will be used.
+ vars:
+ - name: ansible_user
+ - name: ansible_docker_user
+ ini:
+ - section: defaults
+ key: remote_user
+ env:
+ - name: ANSIBLE_REMOTE_USER
+ cli:
+ - name: user
+ keyword:
+ - name: remote_user
+ docker_extra_args:
+ description:
+ - Extra arguments to pass to the docker command line.
+ default: ''
+ vars:
+ - name: ansible_docker_extra_args
+ ini:
+ - section: docker_connection
+ key: extra_cli_args
+ container_timeout:
+ default: 10
+ description:
+ - Controls how long we can wait to access reading output from the container once execution started.
+ env:
+ - name: ANSIBLE_TIMEOUT
+ - name: ANSIBLE_DOCKER_TIMEOUT
+ version_added: 2.2.0
+ ini:
+ - key: timeout
+ section: defaults
+ - key: timeout
+ section: docker_connection
+ version_added: 2.2.0
+ vars:
+ - name: ansible_docker_timeout
+ version_added: 2.2.0
+ cli:
+ - name: timeout
+ type: integer
+'''
+
+import fcntl
+import os
+import os.path
+import subprocess
+import re
+
+from ansible.compat import selectors
+from ansible.errors import AnsibleError, AnsibleFileNotFound
+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
+
+from ansible_collections.community.docker.plugins.module_utils.version import LooseVersion
+
+display = Display()
+
+
+class Connection(ConnectionBase):
+ ''' Local docker based connections '''
+
+ transport = 'community.docker.docker'
+ has_pipelining = True
+
+ def __init__(self, play_context, new_stdin, *args, **kwargs):
+ super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
+
+ # Note: docker supports running as non-root in some configurations.
+ # (For instance, setting the UNIX socket file to be readable and
+ # writable by a specific UNIX group and then putting users into that
+ # group). Therefore we don't check that the user is root when using
+ # this connection. But if the user is getting a permission denied
+ # error it probably means that docker on their system is only
+ # configured to be connected to by root and they are not running as
+ # root.
+
+ self._docker_args = []
+ self._container_user_cache = {}
+ self._version = None
+
+ # Windows uses Powershell modules
+ if getattr(self._shell, "_IS_WINDOWS", False):
+ self.module_implementation_preferences = ('.ps1', '.exe', '')
+
+ if 'docker_command' in kwargs:
+ self.docker_cmd = kwargs['docker_command']
+ else:
+ try:
+ self.docker_cmd = get_bin_path('docker')
+ except ValueError:
+ raise AnsibleError("docker command not found in PATH")
+
+ @staticmethod
+ def _sanitize_version(version):
+ version = re.sub(u'[^0-9a-zA-Z.]', u'', version)
+ version = re.sub(u'^v', u'', version)
+ return version
+
+ def _old_docker_version(self):
+ cmd_args = self._docker_args
+
+ old_version_subcommand = ['version']
+
+ old_docker_cmd = [self.docker_cmd] + cmd_args + old_version_subcommand
+ p = subprocess.Popen(old_docker_cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+ cmd_output, err = p.communicate()
+
+ return old_docker_cmd, to_native(cmd_output), err, p.returncode
+
+ def _new_docker_version(self):
+ # no result yet, must be newer Docker version
+ cmd_args = self._docker_args
+
+ new_version_subcommand = ['version', '--format', "'{{.Server.Version}}'"]
+
+ new_docker_cmd = [self.docker_cmd] + cmd_args + new_version_subcommand
+ p = subprocess.Popen(new_docker_cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+ cmd_output, err = p.communicate()
+ return new_docker_cmd, to_native(cmd_output), err, p.returncode
+
+ def _get_docker_version(self):
+
+ cmd, cmd_output, err, returncode = self._old_docker_version()
+ if returncode == 0:
+ for line in to_text(cmd_output, errors='surrogate_or_strict').split(u'\n'):
+ if line.startswith(u'Server version:'): # old docker versions
+ return self._sanitize_version(line.split()[2])
+
+ cmd, cmd_output, err, returncode = self._new_docker_version()
+ if returncode:
+ raise AnsibleError('Docker version check (%s) failed: %s' % (to_native(cmd), to_native(err)))
+
+ return self._sanitize_version(to_text(cmd_output, errors='surrogate_or_strict'))
+
+ def _get_docker_remote_user(self):
+ """ Get the default user configured in the docker container """
+ container = self.get_option('remote_addr')
+ if container in self._container_user_cache:
+ return self._container_user_cache[container]
+ p = subprocess.Popen([self.docker_cmd, 'inspect', '--format', '{{.Config.User}}', container],
+ stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+
+ out, err = p.communicate()
+ out = to_text(out, errors='surrogate_or_strict')
+
+ if p.returncode != 0:
+ display.warning(u'unable to retrieve default user from docker container: %s %s' % (out, to_text(err)))
+ self._container_user_cache[container] = None
+ return None
+
+ # The default exec user is root, unless it was changed in the Dockerfile with USER
+ user = out.strip() or u'root'
+ self._container_user_cache[container] = user
+ return user
+
+ def _build_exec_cmd(self, cmd):
+ """ Build the local docker exec command to run cmd on remote_host
+
+ If remote_user is available and is supported by the docker
+ version we are using, it will be provided to docker exec.
+ """
+
+ local_cmd = [self.docker_cmd]
+
+ if self._docker_args:
+ local_cmd += self._docker_args
+
+ local_cmd += [b'exec']
+
+ if self.remote_user is not None:
+ local_cmd += [b'-u', self.remote_user]
+
+ # -i is needed to keep stdin open which allows pipelining to work
+ local_cmd += [b'-i', self.get_option('remote_addr')] + cmd
+
+ return local_cmd
+
+ def _set_docker_args(self):
+ # TODO: this is mostly for backwards compatibility, play_context is used as fallback for older versions
+ # docker arguments
+ del self._docker_args[:]
+ extra_args = self.get_option('docker_extra_args') or getattr(self._play_context, 'docker_extra_args', '')
+ if extra_args:
+ self._docker_args += extra_args.split(' ')
+
+ def _set_conn_data(self):
+
+ ''' initialize for the connection, cannot do only in init since all data is not ready at that point '''
+
+ self._set_docker_args()
+
+ self.remote_user = self.get_option('remote_user')
+ if self.remote_user is None and self._play_context.remote_user is not None:
+ self.remote_user = self._play_context.remote_user
+
+ # timeout, use unless default and pc is different, backwards compat
+ self.timeout = self.get_option('container_timeout')
+ if self.timeout == 10 and self.timeout != self._play_context.timeout:
+ self.timeout = self._play_context.timeout
+
+ @property
+ def docker_version(self):
+
+ if not self._version:
+ self._set_docker_args()
+
+ self._version = self._get_docker_version()
+ if self._version == u'dev':
+ display.warning(u'Docker version number is "dev". Will assume latest version.')
+ if self._version != u'dev' and LooseVersion(self._version) < LooseVersion(u'1.3'):
+ raise AnsibleError('docker connection type requires docker 1.3 or higher')
+ return self._version
+
+ def _get_actual_user(self):
+ if self.remote_user is not None:
+ # An explicit user is provided
+ if self.docker_version == u'dev' or LooseVersion(self.docker_version) >= LooseVersion(u'1.7'):
+ # Support for specifying the exec user was added in docker 1.7
+ return self.remote_user
+ else:
+ self.remote_user = None
+ actual_user = self._get_docker_remote_user()
+ if actual_user != self.get_option('remote_user'):
+ display.warning(u'docker {0} does not support remote_user, using container default: {1}'
+ .format(self.docker_version, self.actual_user or u'?'))
+ return actual_user
+ elif self._display.verbosity > 2:
+ # Since we're not setting the actual_user, look it up so we have it for logging later
+ # Only do this if display verbosity is high enough that we'll need the value
+ # This saves overhead from calling into docker when we don't need to.
+ return self._get_docker_remote_user()
+ else:
+ return None
+
+ def _connect(self, port=None):
+ """ Connect to the container. Nothing to do """
+ super(Connection, self)._connect()
+ if not self._connected:
+ self._set_conn_data()
+ actual_user = self._get_actual_user()
+ display.vvv(u"ESTABLISH DOCKER CONNECTION FOR USER: {0}".format(
+ actual_user or u'?'), host=self.get_option('remote_addr')
+ )
+ self._connected = True
+
+ def exec_command(self, cmd, in_data=None, sudoable=False):
+ """ Run a command on the docker host """
+
+ self._set_conn_data()
+
+ super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
+
+ local_cmd = self._build_exec_cmd([self._play_context.executable, '-c', cmd])
+
+ display.vvv(u"EXEC {0}".format(to_text(local_cmd)), host=self.get_option('remote_addr'))
+ display.debug("opening command with Popen()")
+
+ local_cmd = [to_bytes(i, errors='surrogate_or_strict') for i in local_cmd]
+
+ p = subprocess.Popen(
+ local_cmd,
+ stdin=subprocess.PIPE,
+ stdout=subprocess.PIPE,
+ stderr=subprocess.PIPE,
+ )
+ display.debug("done running command with Popen()")
+
+ if self.become and self.become.expect_prompt() and sudoable:
+ fcntl.fcntl(p.stdout, fcntl.F_SETFL, fcntl.fcntl(p.stdout, fcntl.F_GETFL) | os.O_NONBLOCK)
+ fcntl.fcntl(p.stderr, fcntl.F_SETFL, fcntl.fcntl(p.stderr, fcntl.F_GETFL) | os.O_NONBLOCK)
+ selector = selectors.DefaultSelector()
+ selector.register(p.stdout, selectors.EVENT_READ)
+ selector.register(p.stderr, selectors.EVENT_READ)
+
+ become_output = b''
+ try:
+ while not self.become.check_success(become_output) and not self.become.check_password_prompt(become_output):
+ events = selector.select(self.timeout)
+ if not events:
+ stdout, stderr = p.communicate()
+ raise AnsibleError('timeout waiting for privilege escalation password prompt:\n' + to_native(become_output))
+
+ for key, event in events:
+ if key.fileobj == p.stdout:
+ chunk = p.stdout.read()
+ elif key.fileobj == p.stderr:
+ chunk = p.stderr.read()
+
+ if not chunk:
+ stdout, stderr = p.communicate()
+ raise AnsibleError('privilege output closed while waiting for password prompt:\n' + to_native(become_output))
+ become_output += chunk
+ finally:
+ selector.close()
+
+ if not self.become.check_success(become_output):
+ become_pass = self.become.get_option('become_pass', playcontext=self._play_context)
+ p.stdin.write(to_bytes(become_pass, errors='surrogate_or_strict') + b'\n')
+ fcntl.fcntl(p.stdout, fcntl.F_SETFL, fcntl.fcntl(p.stdout, fcntl.F_GETFL) & ~os.O_NONBLOCK)
+ fcntl.fcntl(p.stderr, fcntl.F_SETFL, fcntl.fcntl(p.stderr, fcntl.F_GETFL) & ~os.O_NONBLOCK)
+
+ display.debug("getting output with communicate()")
+ stdout, stderr = p.communicate(in_data)
+ display.debug("done communicating")
+
+ display.debug("done with docker.exec_command()")
+ 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 getattr(self._shell, "_IS_WINDOWS", False):
+ import ntpath
+ return ntpath.normpath(remote_path)
+ else:
+ 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 docker container """
+ self._set_conn_data()
+ super(Connection, self).put_file(in_path, out_path)
+ display.vvv("PUT %s TO %s" % (in_path, out_path), host=self.get_option('remote_addr'))
+
+ out_path = self._prefix_login_path(out_path)
+ if not os.path.exists(to_bytes(in_path, errors='surrogate_or_strict')):
+ raise AnsibleFileNotFound(
+ "file or module does not exist: %s" % to_native(in_path))
+
+ out_path = shlex_quote(out_path)
+ # Older docker doesn't have native support for copying files into
+ # running containers, so we use docker exec to implement this
+ # Although docker version 1.8 and later provide support, the
+ # owner and group of the files are always set to root
+ 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 = ''
+ args = self._build_exec_cmd([self._play_context.executable, "-c", "dd of=%s bs=%s%s" % (out_path, BUFSIZE, count)])
+ args = [to_bytes(i, errors='surrogate_or_strict') for i in args]
+ try:
+ p = subprocess.Popen(args, stdin=in_file, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+ except OSError:
+ raise AnsibleError("docker connection requires dd command in the container to put files")
+ stdout, stderr = p.communicate()
+
+ if p.returncode != 0:
+ raise AnsibleError("failed to transfer file %s to %s:\n%s\n%s" %
+ (to_native(in_path), to_native(out_path), to_native(stdout), to_native(stderr)))
+
+ def fetch_file(self, in_path, out_path):
+ """ Fetch a file from container to local. """
+ self._set_conn_data()
+ super(Connection, self).fetch_file(in_path, out_path)
+ display.vvv("FETCH %s TO %s" % (in_path, out_path), host=self.get_option('remote_addr'))
+
+ in_path = self._prefix_login_path(in_path)
+ # out_path is the final file path, but docker takes a directory, not a
+ # file path
+ out_dir = os.path.dirname(out_path)
+
+ args = [self.docker_cmd, "cp", "%s:%s" % (self.get_option('remote_addr'), in_path), out_dir]
+ args = [to_bytes(i, errors='surrogate_or_strict') for i in args]
+
+ p = subprocess.Popen(args, stdin=subprocess.PIPE,
+ stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+ p.communicate()
+
+ if getattr(self._shell, "_IS_WINDOWS", False):
+ import ntpath
+ actual_out_path = ntpath.join(out_dir, ntpath.basename(in_path))
+ else:
+ actual_out_path = os.path.join(out_dir, os.path.basename(in_path))
+
+ if p.returncode != 0:
+ # Older docker doesn't have native support for fetching files command `cp`
+ # If `cp` fails, try to use `dd` instead
+ args = self._build_exec_cmd([self._play_context.executable, "-c", "dd if=%s bs=%s" % (in_path, BUFSIZE)])
+ args = [to_bytes(i, errors='surrogate_or_strict') for i in args]
+ with open(to_bytes(actual_out_path, errors='surrogate_or_strict'), 'wb') as out_file:
+ try:
+ p = subprocess.Popen(args, stdin=subprocess.PIPE,
+ stdout=out_file, stderr=subprocess.PIPE)
+ except OSError:
+ raise AnsibleError("docker connection requires dd command in the container to put files")
+ stdout, stderr = p.communicate()
+
+ if p.returncode != 0:
+ raise AnsibleError("failed to fetch file %s to %s:\n%s\n%s" % (in_path, out_path, stdout, stderr))
+
+ # Rename if needed
+ if actual_out_path != out_path:
+ os.rename(to_bytes(actual_out_path, errors='strict'), to_bytes(out_path, errors='strict'))
+
+ def close(self):
+ """ Terminate the connection. Nothing to do for Docker"""
+ super(Connection, self).close()
+ self._connected = False
+
+ def reset(self):
+ # Clear container user cache
+ self._container_user_cache = {}
diff --git a/ansible_collections/community/docker/plugins/connection/docker_api.py b/ansible_collections/community/docker/plugins/connection/docker_api.py
new file mode 100644
index 00000000..bbc13989
--- /dev/null
+++ b/ansible_collections/community/docker/plugins/connection/docker_api.py
@@ -0,0 +1,338 @@
+# Copyright (c) 2019-2020, Felix Fontein <felix@fontein.de>
+# 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:
+ - Felix Fontein (@felixfontein)
+name: docker_api
+short_description: Run tasks in docker containers
+version_added: 1.1.0
+description:
+ - Run commands or put/fetch files to an existing docker container.
+ - Uses the L(requests library,https://pypi.org/project/requests/) to interact
+ directly with the Docker daemon instead of using the Docker CLI. Use the
+ R(community.docker.docker,ansible_collections.community.docker.docker_connection)
+ connection plugin if you want to use the Docker CLI.
+extends_documentation_fragment:
+ - community.docker.docker.api_documentation
+ - community.docker.docker.var_names
+options:
+ remote_user:
+ type: str
+ description:
+ - The user to execute as inside the container.
+ vars:
+ - name: ansible_user
+ - name: ansible_docker_user
+ ini:
+ - section: defaults
+ key: remote_user
+ env:
+ - name: ANSIBLE_REMOTE_USER
+ cli:
+ - name: user
+ keyword:
+ - name: remote_user
+ remote_addr:
+ type: str
+ description:
+ - The name of the container you want to access.
+ default: inventory_hostname
+ vars:
+ - name: inventory_hostname
+ - name: ansible_host
+ - name: ansible_docker_host
+ container_timeout:
+ default: 10
+ description:
+ - Controls how long we can wait to access reading output from the container once execution started.
+ env:
+ - name: ANSIBLE_TIMEOUT
+ - name: ANSIBLE_DOCKER_TIMEOUT
+ version_added: 2.2.0
+ ini:
+ - key: timeout
+ section: defaults
+ - key: timeout
+ section: docker_connection
+ version_added: 2.2.0
+ vars:
+ - name: ansible_docker_timeout
+ version_added: 2.2.0
+ cli:
+ - name: timeout
+ type: integer
+'''
+
+import os
+import os.path
+
+from ansible.errors import AnsibleFileNotFound, AnsibleConnectionFailure
+from ansible.module_utils.common.text.converters import to_bytes, to_native, to_text
+from ansible.plugins.connection import ConnectionBase
+from ansible.utils.display import Display
+
+from ansible_collections.community.docker.plugins.module_utils.common_api import (
+ RequestException,
+)
+from ansible_collections.community.docker.plugins.module_utils.copy import (
+ DockerFileCopyError,
+ DockerFileNotFound,
+ fetch_file,
+ put_file,
+)
+
+from ansible_collections.community.docker.plugins.plugin_utils.socket_handler import (
+ DockerSocketHandler,
+)
+from ansible_collections.community.docker.plugins.plugin_utils.common_api import (
+ AnsibleDockerClient,
+)
+
+from ansible_collections.community.docker.plugins.module_utils._api.errors import APIError, DockerException, NotFound
+
+MIN_DOCKER_API = None
+
+
+display = Display()
+
+
+class Connection(ConnectionBase):
+ ''' Local docker based connections '''
+
+ transport = 'community.docker.docker_api'
+ has_pipelining = True
+
+ def _call_client(self, callable, not_found_can_be_resource=False):
+ try:
+ return callable()
+ except NotFound as e:
+ if not_found_can_be_resource:
+ raise AnsibleConnectionFailure('Could not find container "{1}" or resource in it ({0})'.format(e, self.get_option('remote_addr')))
+ else:
+ raise AnsibleConnectionFailure('Could not find container "{1}" ({0})'.format(e, self.get_option('remote_addr')))
+ except APIError as e:
+ if e.response is not None and e.response.status_code == 409:
+ raise AnsibleConnectionFailure('The container "{1}" has been paused ({0})'.format(e, self.get_option('remote_addr')))
+ self.client.fail(
+ 'An unexpected Docker error occurred for container "{1}": {0}'.format(e, self.get_option('remote_addr'))
+ )
+ except DockerException as e:
+ self.client.fail(
+ 'An unexpected Docker error occurred for container "{1}": {0}'.format(e, self.get_option('remote_addr'))
+ )
+ except RequestException as e:
+ self.client.fail(
+ 'An unexpected requests error occurred for container "{1}" when trying to talk to the Docker daemon: {0}'
+ .format(e, self.get_option('remote_addr'))
+ )
+
+ def __init__(self, play_context, new_stdin, *args, **kwargs):
+ super(Connection, self).__init__(play_context, new_stdin, *args, **kwargs)
+
+ self.client = None
+ self.ids = dict()
+
+ # Windows uses Powershell modules
+ if getattr(self._shell, "_IS_WINDOWS", False):
+ self.module_implementation_preferences = ('.ps1', '.exe', '')
+
+ self.actual_user = None
+
+ def _connect(self, port=None):
+ """ Connect to the container. Nothing to do """
+ super(Connection, self)._connect()
+ if not self._connected:
+ self.actual_user = self.get_option('remote_user')
+ display.vvv(u"ESTABLISH DOCKER CONNECTION FOR USER: {0}".format(
+ self.actual_user or u'?'), host=self.get_option('remote_addr')
+ )
+ if self.client is None:
+ self.client = AnsibleDockerClient(self, min_docker_api_version=MIN_DOCKER_API)
+ self._connected = True
+
+ if self.actual_user is None and display.verbosity > 2:
+ # Since we're not setting the actual_user, look it up so we have it for logging later
+ # Only do this if display verbosity is high enough that we'll need the value
+ # This saves overhead from calling into docker when we don't need to
+ display.vvv(u"Trying to determine actual user")
+ result = self._call_client(lambda: self.client.get_json('/containers/{0}/json', self.get_option('remote_addr')))
+ if result.get('Config'):
+ self.actual_user = result['Config'].get('User')
+ if self.actual_user is not None:
+ display.vvv(u"Actual user is '{0}'".format(self.actual_user))
+
+ def exec_command(self, cmd, in_data=None, sudoable=False):
+ """ Run a command on the docker host """
+
+ super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
+
+ command = [self._play_context.executable, '-c', to_text(cmd)]
+
+ do_become = self.become and self.become.expect_prompt() and sudoable
+
+ display.vvv(
+ u"EXEC {0}{1}{2}".format(
+ to_text(command),
+ ', with stdin ({0} bytes)'.format(len(in_data)) if in_data is not None else '',
+ ', with become prompt' if do_become else '',
+ ),
+ host=self.get_option('remote_addr')
+ )
+
+ need_stdin = True if (in_data is not None) or do_become else False
+
+ data = {
+ 'Container': self.get_option('remote_addr'),
+ 'User': self.get_option('remote_user') or '',
+ 'Privileged': False,
+ 'Tty': False,
+ 'AttachStdin': need_stdin,
+ 'AttachStdout': True,
+ 'AttachStderr': True,
+ 'Cmd': command,
+ }
+
+ if 'detachKeys' in self.client._general_configs:
+ data['detachKeys'] = self.client._general_configs['detachKeys']
+
+ exec_data = self._call_client(lambda: self.client.post_json_to_json('/containers/{0}/exec', self.get_option('remote_addr'), data=data))
+ exec_id = exec_data['Id']
+
+ data = {
+ 'Tty': False,
+ 'Detach': False
+ }
+ if need_stdin:
+ exec_socket = self._call_client(lambda: self.client.post_json_to_stream_socket('/exec/{0}/start', exec_id, data=data))
+ try:
+ with DockerSocketHandler(display, exec_socket, container=self.get_option('remote_addr')) as exec_socket_handler:
+ if do_become:
+ become_output = [b'']
+
+ def append_become_output(stream_id, data):
+ become_output[0] += data
+
+ exec_socket_handler.set_block_done_callback(append_become_output)
+
+ while not self.become.check_success(become_output[0]) and not self.become.check_password_prompt(become_output[0]):
+ if not exec_socket_handler.select(self.get_option('container_timeout')):
+ stdout, stderr = exec_socket_handler.consume()
+ raise AnsibleConnectionFailure('timeout waiting for privilege escalation password prompt:\n' + to_native(become_output[0]))
+
+ if exec_socket_handler.is_eof():
+ raise AnsibleConnectionFailure('privilege output closed while waiting for password prompt:\n' + to_native(become_output[0]))
+
+ if not self.become.check_success(become_output[0]):
+ become_pass = self.become.get_option('become_pass', playcontext=self._play_context)
+ exec_socket_handler.write(to_bytes(become_pass, errors='surrogate_or_strict') + b'\n')
+
+ if in_data is not None:
+ exec_socket_handler.write(in_data)
+
+ stdout, stderr = exec_socket_handler.consume()
+ finally:
+ exec_socket.close()
+ else:
+ stdout, stderr = self._call_client(lambda: self.client.post_json_to_stream(
+ '/exec/{0}/start', exec_id, stream=False, demux=True, tty=False, data=data))
+
+ result = self._call_client(lambda: self.client.get_json('/exec/{0}/json', exec_id))
+
+ return result.get('ExitCode') or 0, stdout or b'', stderr or b''
+
+ 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 getattr(self._shell, "_IS_WINDOWS", False):
+ import ntpath
+ return ntpath.normpath(remote_path)
+ else:
+ 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 docker container """
+ super(Connection, self).put_file(in_path, out_path)
+ display.vvv("PUT %s TO %s" % (in_path, out_path), host=self.get_option('remote_addr'))
+
+ out_path = self._prefix_login_path(out_path)
+
+ if self.actual_user not in self.ids:
+ dummy, ids, dummy = self.exec_command(b'id -u && id -g')
+ try:
+ user_id, group_id = ids.splitlines()
+ self.ids[self.actual_user] = int(user_id), int(group_id)
+ display.vvvv(
+ 'PUT: Determined uid={0} and gid={1} for user "{2}"'.format(user_id, group_id, self.actual_user),
+ host=self.get_option('remote_addr')
+ )
+ except Exception as e:
+ raise AnsibleConnectionFailure(
+ 'Error while determining user and group ID of current user in container "{1}": {0}\nGot value: {2!r}'
+ .format(e, self.get_option('remote_addr'), ids)
+ )
+
+ user_id, group_id = self.ids[self.actual_user]
+ try:
+ self._call_client(
+ lambda: put_file(
+ self.client,
+ container=self.get_option('remote_addr'),
+ in_path=in_path,
+ out_path=out_path,
+ user_id=user_id,
+ group_id=group_id,
+ user_name=self.actual_user,
+ follow_links=True,
+ ),
+ not_found_can_be_resource=True,
+ )
+ except DockerFileNotFound as exc:
+ raise AnsibleFileNotFound(to_native(exc))
+ except DockerFileCopyError as exc:
+ raise AnsibleConnectionFailure(to_native(exc))
+
+ def fetch_file(self, in_path, out_path):
+ """ Fetch a file from container to local. """
+ super(Connection, self).fetch_file(in_path, out_path)
+ display.vvv("FETCH %s TO %s" % (in_path, out_path), host=self.get_option('remote_addr'))
+
+ in_path = self._prefix_login_path(in_path)
+
+ try:
+ self._call_client(
+ lambda: fetch_file(
+ self.client,
+ container=self.get_option('remote_addr'),
+ in_path=in_path,
+ out_path=out_path,
+ follow_links=True,
+ log=lambda msg: display.vvvv(msg, host=self.get_option('remote_addr')),
+ ),
+ not_found_can_be_resource=True,
+ )
+ except DockerFileNotFound as exc:
+ raise AnsibleFileNotFound(to_native(exc))
+ except DockerFileCopyError as exc:
+ raise AnsibleConnectionFailure(to_native(exc))
+
+ def close(self):
+ """ Terminate the connection. Nothing to do for Docker"""
+ super(Connection, self).close()
+ self._connected = False
+
+ def reset(self):
+ self.ids.clear()
diff --git a/ansible_collections/community/docker/plugins/connection/nsenter.py b/ansible_collections/community/docker/plugins/connection/nsenter.py
new file mode 100644
index 00000000..fff36afb
--- /dev/null
+++ b/ansible_collections/community/docker/plugins/connection/nsenter.py
@@ -0,0 +1,239 @@
+# Copyright (c) 2021 Jeff Goldschrafe <jeff@holyhandgrenade.org>
+# Based on Ansible local connection plugin by:
+# Copyright (c) 2012 Michael DeHaan <michael.dehaan@gmail.com>
+# Copyright (c) 2015, 2017 Toshio Kuratomi <tkuratomi@ansible.com>
+# 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: nsenter
+short_description: execute on host running controller container
+version_added: 1.9.0
+description:
+ - This connection plugin allows Ansible, running in a privileged container, to execute tasks on the container
+ host instead of in the container itself.
+ - This is useful for running Ansible in a pull model, while still keeping the Ansible control node
+ containerized.
+ - It relies on having privileged access to run C(nsenter) in the host's PID namespace, allowing it to enter the
+ namespaces of the provided PID (default PID 1, or init/systemd).
+author: Jeff Goldschrafe (@jgoldschrafe)
+options:
+ nsenter_pid:
+ description:
+ - PID to attach with using nsenter.
+ - The default should be fine unless you are attaching as a non-root user.
+ type: int
+ default: 1
+ vars:
+ - name: ansible_nsenter_pid
+ env:
+ - name: ANSIBLE_NSENTER_PID
+ ini:
+ - section: nsenter_connection
+ key: nsenter_pid
+notes:
+ - The remote user is ignored; this plugin always runs as root.
+ - >-
+ This plugin requires the Ansible controller container to be launched in the following way:
+ (1) The container image contains the C(nsenter) program;
+ (2) The container is launched in privileged mode;
+ (3) The container is launched in the host's PID namespace (C(--pid host)).
+'''
+
+import os
+import pty
+import subprocess
+import fcntl
+
+import ansible.constants as C
+from ansible.errors import AnsibleError
+from ansible.module_utils.compat import selectors
+from ansible.module_utils.six import binary_type, text_type
+from ansible.module_utils.common.text.converters import to_bytes, to_native, to_text
+from ansible.plugins.connection import ConnectionBase
+from ansible.utils.display import Display
+from ansible.utils.path import unfrackpath
+
+display = Display()
+
+
+class Connection(ConnectionBase):
+ '''Connections to a container host using nsenter
+ '''
+
+ transport = 'community.docker.nsenter'
+ has_pipelining = False
+
+ def __init__(self, *args, **kwargs):
+ super(Connection, self).__init__(*args, **kwargs)
+ self.cwd = None
+
+ def _connect(self):
+ self._nsenter_pid = self.get_option("nsenter_pid")
+
+ # Because nsenter requires very high privileges, our remote user
+ # is always assumed to be root.
+ self._play_context.remote_user = "root"
+
+ if not self._connected:
+ display.vvv(
+ u"ESTABLISH NSENTER CONNECTION FOR USER: {0}".format(
+ self._play_context.remote_user
+ ),
+ host=self._play_context.remote_addr,
+ )
+ self._connected = True
+ return self
+
+ def exec_command(self, cmd, in_data=None, sudoable=True):
+ super(Connection, self).exec_command(cmd, in_data=in_data, sudoable=sudoable)
+
+ display.debug("in nsenter.exec_command()")
+
+ executable = C.DEFAULT_EXECUTABLE.split()[0] if C.DEFAULT_EXECUTABLE else None
+
+ if not os.path.exists(to_bytes(executable, errors='surrogate_or_strict')):
+ raise AnsibleError("failed to find the executable specified %s."
+ " Please verify if the executable exists and re-try." % executable)
+
+ # Rewrite the provided command to prefix it with nsenter
+ nsenter_cmd_parts = [
+ "nsenter",
+ "--ipc",
+ "--mount",
+ "--net",
+ "--pid",
+ "--uts",
+ "--preserve-credentials",
+ "--target={0}".format(self._nsenter_pid),
+ "--",
+ ]
+
+ if isinstance(cmd, (text_type, binary_type)):
+ cmd_parts = nsenter_cmd_parts + [cmd]
+ cmd = to_bytes(" ".join(cmd_parts))
+ else:
+ cmd_parts = nsenter_cmd_parts + cmd
+ cmd = [to_bytes(arg) for arg in cmd_parts]
+
+ display.vvv(u"EXEC {0}".format(to_text(cmd)), host=self._play_context.remote_addr)
+ display.debug("opening command with Popen()")
+
+ master = None
+ stdin = subprocess.PIPE
+
+ # This plugin does not support pipelining. This diverges from the behavior of
+ # the core "local" connection plugin that this one derives from.
+ if sudoable and self.become and self.become.expect_prompt():
+ # Create a pty if sudoable for privlege escalation that needs it.
+ # Falls back to using a standard pipe if this fails, which may
+ # cause the command to fail in certain situations where we are escalating
+ # privileges or the command otherwise needs a pty.
+ try:
+ master, stdin = pty.openpty()
+ except (IOError, OSError) as e:
+ display.debug("Unable to open pty: %s" % to_native(e))
+
+ p = subprocess.Popen(
+ cmd,
+ shell=isinstance(cmd, (text_type, binary_type)),
+ executable=executable if isinstance(cmd, (text_type, binary_type)) else None,
+ cwd=self.cwd,
+ stdin=stdin,
+ stdout=subprocess.PIPE,
+ stderr=subprocess.PIPE,
+ )
+
+ # if we created a master, we can close the other half of the pty now, otherwise master is stdin
+ if master is not None:
+ os.close(stdin)
+
+ display.debug("done running command with Popen()")
+
+ if self.become and self.become.expect_prompt() and sudoable:
+ fcntl.fcntl(p.stdout, fcntl.F_SETFL, fcntl.fcntl(p.stdout, fcntl.F_GETFL) | os.O_NONBLOCK)
+ fcntl.fcntl(p.stderr, fcntl.F_SETFL, fcntl.fcntl(p.stderr, fcntl.F_GETFL) | os.O_NONBLOCK)
+ selector = selectors.DefaultSelector()
+ selector.register(p.stdout, selectors.EVENT_READ)
+ selector.register(p.stderr, selectors.EVENT_READ)
+
+ become_output = b''
+ try:
+ while not self.become.check_success(become_output) and not self.become.check_password_prompt(become_output):
+ events = selector.select(self._play_context.timeout)
+ if not events:
+ stdout, stderr = p.communicate()
+ raise AnsibleError('timeout waiting for privilege escalation password prompt:\n' + to_native(become_output))
+
+ for key, event in events:
+ if key.fileobj == p.stdout:
+ chunk = p.stdout.read()
+ elif key.fileobj == p.stderr:
+ chunk = p.stderr.read()
+
+ if not chunk:
+ stdout, stderr = p.communicate()
+ raise AnsibleError('privilege output closed while waiting for password prompt:\n' + to_native(become_output))
+ become_output += chunk
+ finally:
+ selector.close()
+
+ if not self.become.check_success(become_output):
+ become_pass = self.become.get_option('become_pass', playcontext=self._play_context)
+ if master is None:
+ p.stdin.write(to_bytes(become_pass, errors='surrogate_or_strict') + b'\n')
+ else:
+ os.write(master, to_bytes(become_pass, errors='surrogate_or_strict') + b'\n')
+
+ fcntl.fcntl(p.stdout, fcntl.F_SETFL, fcntl.fcntl(p.stdout, fcntl.F_GETFL) & ~os.O_NONBLOCK)
+ fcntl.fcntl(p.stderr, fcntl.F_SETFL, fcntl.fcntl(p.stderr, fcntl.F_GETFL) & ~os.O_NONBLOCK)
+
+ display.debug("getting output with communicate()")
+ stdout, stderr = p.communicate(in_data)
+ display.debug("done communicating")
+
+ # finally, close the other half of the pty, if it was created
+ if master:
+ os.close(master)
+
+ display.debug("done with nsenter.exec_command()")
+ return (p.returncode, stdout, stderr)
+
+ def put_file(self, in_path, out_path):
+ super(Connection, self).put_file(in_path, out_path)
+
+ in_path = unfrackpath(in_path, basedir=self.cwd)
+ out_path = unfrackpath(out_path, basedir=self.cwd)
+
+ display.vvv(u"PUT {0} to {1}".format(in_path, out_path), host=self._play_context.remote_addr)
+ try:
+ with open(to_bytes(in_path, errors="surrogate_or_strict"), "rb") as in_file:
+ in_data = in_file.read()
+ rc, out, err = self.exec_command(cmd=["tee", out_path], in_data=in_data)
+ if rc != 0:
+ raise AnsibleError("failed to transfer file to {0}: {1}".format(out_path, err))
+ except IOError as e:
+ raise AnsibleError("failed to transfer file to {0}: {1}".format(out_path, to_native(e)))
+
+ def fetch_file(self, in_path, out_path):
+ super(Connection, self).fetch_file(in_path, out_path)
+
+ in_path = unfrackpath(in_path, basedir=self.cwd)
+ out_path = unfrackpath(out_path, basedir=self.cwd)
+
+ try:
+ rc, out, err = self.exec_command(cmd=["cat", in_path])
+ display.vvv(u"FETCH {0} TO {1}".format(in_path, out_path), host=self._play_context.remote_addr)
+ if rc != 0:
+ raise AnsibleError("failed to transfer file to {0}: {1}".format(in_path, err))
+ with open(to_bytes(out_path, errors='surrogate_or_strict'), 'wb') as out_file:
+ out_file.write(out)
+ except IOError as e:
+ raise AnsibleError("failed to transfer file to {0}: {1}".format(to_native(out_path), to_native(e)))
+
+ def close(self):
+ ''' terminate the connection; nothing to do here '''
+ self._connected = False