Browse Source

Block localhost shell tasks in untrusted playbooks

Zuul was designed to block local code execution in untrusted
environments to not only rely on bwrap to contain a job. This got
broken since the creation of a command plugin that injects the
zuul_job_id which is required for log streaming. However this plugin
doesn't do a check if the task is a localhost task. Further it is
required in trusted and untrusted environments due to log
streaming. Thus we need to fork this plugin and restrict the variant
that is used in untrusted environments.

We do this by moving actiongeneral/command.py back to action/*. We
further introduce a new catecory actiontrusted which gets the
unrestricted version of this plugin.

Change-Id: If81cc46bcae466f4c071badf09a8a88469ae6779
Story: 2007935
Task: 40391
changes/29/742229/2
Tobias Henkel 2 weeks ago
parent
commit
bf4e9893d0
No known key found for this signature in database GPG Key ID: 3750DEC158E5FA2
36 changed files with 156 additions and 50 deletions
  1. +1
    -1
      playbooks/zuul-stream/templates/ansible.cfg.j2
  2. +12
    -0
      tests/fixtures/config/remote-action-modules/git/org_project/playbooks/shell-delegate.yaml
  3. +10
    -0
      tests/fixtures/config/remote-action-modules/git/org_project/playbooks/shell-localhost.yaml
  4. +7
    -0
      tests/fixtures/config/remote-zuul-stream/git/common-config/playbooks/command-localhost.yaml
  5. +4
    -0
      tests/fixtures/config/remote-zuul-stream/git/common-config/zuul.yaml
  6. +0
    -8
      tests/fixtures/config/remote-zuul-stream/git/org_project/playbooks/command.yaml
  7. +3
    -0
      tests/remote/test_remote_action_modules.py
  8. +58
    -32
      tests/remote/test_remote_zuul_stream.py
  9. +1
    -1
      tools/test-logs.sh
  10. +1
    -0
      zuul/ansible/2.7/action/command.py
  11. +1
    -0
      zuul/ansible/2.7/action/command.pyi
  12. +0
    -1
      zuul/ansible/2.7/actiongeneral/command.py
  13. +0
    -1
      zuul/ansible/2.7/actiongeneral/command.pyi
  14. +1
    -0
      zuul/ansible/2.7/actiontrusted/__init__.py
  15. +1
    -0
      zuul/ansible/2.7/actiontrusted/command.py
  16. +1
    -0
      zuul/ansible/2.7/actiontrusted/command.pyi
  17. +1
    -0
      zuul/ansible/2.8/action/command.py
  18. +1
    -0
      zuul/ansible/2.8/action/command.pyi
  19. +0
    -1
      zuul/ansible/2.8/actiongeneral/command.py
  20. +0
    -1
      zuul/ansible/2.8/actiongeneral/command.pyi
  21. +1
    -0
      zuul/ansible/2.8/actiontrusted/__init__.py
  22. +1
    -0
      zuul/ansible/2.8/actiontrusted/command.py
  23. +1
    -0
      zuul/ansible/2.8/actiontrusted/command.pyi
  24. +1
    -0
      zuul/ansible/2.9/action/command.py
  25. +1
    -0
      zuul/ansible/2.9/action/command.pyi
  26. +0
    -1
      zuul/ansible/2.9/actiongeneral/command.py
  27. +0
    -1
      zuul/ansible/2.9/actiongeneral/command.pyi
  28. +1
    -0
      zuul/ansible/2.9/actiontrusted/__init__.py
  29. +1
    -0
      zuul/ansible/2.9/actiontrusted/command.py
  30. +1
    -0
      zuul/ansible/2.9/actiontrusted/command.pyi
  31. +33
    -0
      zuul/ansible/base/action/command.py
  32. +0
    -0
      zuul/ansible/base/action/command.pyi
  33. +0
    -0
      zuul/ansible/base/actiontrusted/__init__.py
  34. +0
    -0
      zuul/ansible/base/actiontrusted/command.py
  35. +0
    -0
      zuul/ansible/base/actiontrusted/command.pyi
  36. +12
    -2
      zuul/executor/server.py

+ 1
- 1
playbooks/zuul-stream/templates/ansible.cfg.j2 View File

@@ -3,7 +3,7 @@ inventory = {{ ansible_user_dir }}/inventory.yaml
gathering = smart
gather_subset = !all
lookup_plugins = {{ ansible_user_dir }}/src/opendev.org/zuul/zuul/zuul/ansible/{{ zuul_ansible_version }}/lookup
action_plugins = {{ ansible_user_dir }}/src/opendev.org/zuul/zuul/zuul/ansible/{{ zuul_ansible_version }}/actiongeneral:{{ ansible_user_dir }}/src/opendev.org/zuul/zuul/zuul/ansible/action
action_plugins = {{ ansible_user_dir }}/src/opendev.org/zuul/zuul/zuul/ansible/{{ zuul_ansible_version }}/actiongeneral:{{ ansible_user_dir }}/src/opendev.org/zuul/zuul/zuul/ansible/{{ zuul_ansible_version }}/action
callback_plugins = {{ ansible_user_dir }}/src/opendev.org/zuul/zuul/zuul/ansible/{{ zuul_ansible_version }}/callback:/usr/lib/zuul/ansible/{{ zuul_ansible_version }}/lib/python3.5/site-packages/ara/plugins/callbacks
stdout_callback = zuul_stream
library = {{ ansible_user_dir }}/src/opendev.org/zuul/zuul/zuul/ansible/{{ zuul_ansible_version }}/library


+ 12
- 0
tests/fixtures/config/remote-action-modules/git/org_project/playbooks/shell-delegate.yaml View File

@@ -0,0 +1,12 @@
- hosts: all
tasks:
- name: Normal shell
delegate_to: localhost
shell: echo 123

- name: Shell with executable
delegate_to: localhost
shell: |
echo 123
args:
executable: /bin/bash

+ 10
- 0
tests/fixtures/config/remote-action-modules/git/org_project/playbooks/shell-localhost.yaml View File

@@ -0,0 +1,10 @@
- hosts: localhost
tasks:
- name: Normal shell
shell: echo 123

- name: Shell with executable
shell: |
echo 123
args:
executable: /bin/bash

+ 7
- 0
tests/fixtures/config/remote-zuul-stream/git/common-config/playbooks/command-localhost.yaml View File

@@ -0,0 +1,7 @@
- hosts: localhost
tasks:
- name: Local shell task with python exception
command: echo foo
args:
chdir: /local-shelltask/somewhere/that/does/not/exist
failed_when: false

+ 4
- 0
tests/fixtures/config/remote-zuul-stream/git/common-config/zuul.yaml View File

@@ -15,3 +15,7 @@
- job:
name: base
parent: null

- job:
name: command-localhost
run: playbooks/command-localhost.yaml

+ 0
- 8
tests/fixtures/config/remote-zuul-stream/git/org_project/playbooks/command.yaml View File

@@ -97,11 +97,3 @@
args:
chdir: /remote-shelltask/somewhere/that/does/not/exist
failed_when: false

- hosts: localhost
tasks:
- name: Local shell task with python exception
command: echo foo
args:
chdir: /local-shelltask/somewhere/that/does/not/exist
failed_when: false

+ 3
- 0
tests/remote/test_remote_action_modules.py View File

@@ -18,6 +18,7 @@ import textwrap
from tests.base import AnsibleZuulTestCase, FIXTURE_DIR

ERROR_ACCESS_OUTSIDE = "Accessing files from outside the working dir"
ERROR_LOCAL_CODE = "Executing local code is prohibited"
ERROR_SYNC_TO_OUTSIDE = "Syncing files to outside the working dir"
ERROR_SYNC_FROM_OUTSIDE = "Syncing files from outside the working dir"
ERROR_SYNC_RSH = "Using custom synchronize rsh is prohibited"
@@ -175,6 +176,8 @@ class FunctionalActionModulesMixIn:

def test_shell_module(self):
self._run_job('shell-good', 'SUCCESS')
self._run_job('shell-localhost', 'FAILURE', ERROR_LOCAL_CODE)
self._run_job('shell-delegate', 'FAILURE', ERROR_LOCAL_CODE)

def test_synchronize_module(self):
self._run_job('synchronize-good', 'SUCCESS')


+ 58
- 32
tests/remote/test_remote_zuul_stream.py View File

@@ -32,7 +32,7 @@ class FunctionalZuulStreamMixIn:
ansible_remote = os.environ.get('ZUUL_REMOTE_IPV4')
self.assertIsNotNone(ansible_remote)

def _run_job(self, job_name):
def _run_job(self, job_name, create=True):
# Keep the jobdir around so we can inspect contents if an
# assert fails. It will be cleaned up anyway as it is contained
# in a tmp dir which gets cleaned up after the test.
@@ -40,32 +40,40 @@ class FunctionalZuulStreamMixIn:

# Output extra ansible info so we might see errors.
self.executor_server.verbose = True
conf = textwrap.dedent(
"""
- job:
name: {job_name}
run: playbooks/{job_name}.yaml
ansible-version: {version}
vars:
test_console_port: {console_port}
roles:
- zuul: org/common-config
nodeset:
nodes:
- name: compute1
label: whatever
- name: controller
label: whatever

- project:
check:
jobs:
- {job_name}
""".format(
job_name=job_name,
version=self.ansible_version,
console_port=self.log_console_port))
if create:
conf = textwrap.dedent(
"""
- job:
name: {job_name}
run: playbooks/{job_name}.yaml
ansible-version: {version}
vars:
test_console_port: {console_port}
roles:
- zuul: org/common-config
nodeset:
nodes:
- name: compute1
label: whatever
- name: controller
label: whatever

- project:
check:
jobs:
- {job_name}
""".format(
job_name=job_name,
version=self.ansible_version,
console_port=self.log_console_port))
else:
conf = textwrap.dedent(
"""
- project:
check:
jobs:
- {job_name}
""".format(job_name=job_name))
file_dict = {'zuul.yaml': conf}
A = self.fake_gerrit.addFakeChange('org/project', 'master', 'A',
files=file_dict)
@@ -141,9 +149,6 @@ class FunctionalZuulStreamMixIn:
self.assertLogLine(r'compute1 \| failed_in_loop2', text)
self.assertLogLine(r'compute1 \| ok: Item: failed_in_loop2 '
r'Result: 1', text)
self.assertLogLine(r'localhost \| .*No such file or directory: .*'
r'\'/local-shelltask/somewhere/'
r'that/does/not/exist\'', text)
self.assertLogLine(r'compute1 \| .*No such file or directory: .*'
r'\'/remote-shelltask/somewhere/'
r'that/does/not/exist\'', text)
@@ -160,6 +165,18 @@ class FunctionalZuulStreamMixIn:
r'RUN END RESULT_NORMAL: \[untrusted : review.example.com/'
r'org/project/playbooks/command.yaml@master]', text)

# Run a pre-defined job that is defined in a trusted repo to test
# localhost tasks.
job = self._run_job('command-localhost', create=False)
with self.jobLog(job):
build = self.history[-1]
self.assertEqual(build.result, 'SUCCESS')

text = self._get_job_output(build)
self.assertLogLine(r'localhost \| .*No such file or directory: .*'
r'\'/local-shelltask/somewhere/'
r'that/does/not/exist\'', text)

def test_module_exception(self):
job = self._run_job('module_failure_exception')
with self.jobLog(job):
@@ -260,9 +277,6 @@ class TestZuulStream28(AnsibleZuulTestCase, FunctionalZuulStreamMixIn):
self.assertLogLine(r'compute1 \| failed_in_loop2', text)
self.assertLogLine(r'compute1 \| ok: Item: failed_in_loop2 '
r'Result: 1', text)
self.assertLogLine(r'localhost \| .*No such file or directory: .*'
r'\'/local-shelltask/somewhere/'
r'that/does/not/exist\'', text)
self.assertLogLine(r'compute1 \| .*No such file or directory: .*'
r'\'/remote-shelltask/somewhere/'
r'that/does/not/exist\'', text)
@@ -281,6 +295,18 @@ class TestZuulStream28(AnsibleZuulTestCase, FunctionalZuulStreamMixIn):
r'RUN END RESULT_NORMAL: \[untrusted : review.example.com/'
r'org/project/playbooks/command.yaml@master]', text)

# Run a pre-defined job that is defined in a trusted repo to test
# localhost tasks.
job = self._run_job('command-localhost', create=False)
with self.jobLog(job):
build = self.history[-1]
self.assertEqual(build.result, 'SUCCESS')

text = self._get_job_output(build)
self.assertLogLine(r'localhost \| .*No such file or directory: .*'
r'\'/local-shelltask/somewhere/'
r'that/does/not/exist\'', text)


class TestZuulStream29(TestZuulStream28):
ansible_version = '2.9'

+ 1
- 1
tools/test-logs.sh View File

@@ -68,7 +68,7 @@ fact_caching = jsonfile
fact_caching_connection = ~/.cache/facts
lookup_plugins = ${ZUUL_ANSIBLE}/zuul/ansible/lookup
callback_plugins = ${ZUUL_ANSIBLE}/zuul/ansible/callback:$ARA_DIR/plugins/callbacks
action_plugins = ${ZUUL_ANSIBLE}/zuul/ansible/actiongeneral
action_plugins = ${ZUUL_ANSIBLE}/zuul/ansible/actiongeneral:${ZUUL_ANSIBLE}/zuul/ansible/actiontrusted
module_utils = ${ZUUL_ANSIBLE}/zuul/ansible/module_utils
stdout_callback = zuul_stream
library = ${ZUUL_ANSIBLE}/zuul/ansible/library


+ 1
- 0
zuul/ansible/2.7/action/command.py View File

@@ -0,0 +1 @@
../../base/action/command.py

+ 1
- 0
zuul/ansible/2.7/action/command.pyi View File

@@ -0,0 +1 @@
../../base/action/command.pyi

+ 0
- 1
zuul/ansible/2.7/actiongeneral/command.py View File

@@ -1 +0,0 @@
../../base/actiongeneral/command.py

+ 0
- 1
zuul/ansible/2.7/actiongeneral/command.pyi View File

@@ -1 +0,0 @@
../../base/actiongeneral/command.pyi

+ 1
- 0
zuul/ansible/2.7/actiontrusted/__init__.py View File

@@ -0,0 +1 @@
../../base/actiontrusted/__init__.py

+ 1
- 0
zuul/ansible/2.7/actiontrusted/command.py View File

@@ -0,0 +1 @@
../../base/actiontrusted/command.py

+ 1
- 0
zuul/ansible/2.7/actiontrusted/command.pyi View File

@@ -0,0 +1 @@
../../base/actiontrusted/command.pyi

+ 1
- 0
zuul/ansible/2.8/action/command.py View File

@@ -0,0 +1 @@
../../base/action/command.py

+ 1
- 0
zuul/ansible/2.8/action/command.pyi View File

@@ -0,0 +1 @@
../../base/action/command.pyi

+ 0
- 1
zuul/ansible/2.8/actiongeneral/command.py View File

@@ -1 +0,0 @@
../../base/actiongeneral/command.py

+ 0
- 1
zuul/ansible/2.8/actiongeneral/command.pyi View File

@@ -1 +0,0 @@
../../base/actiongeneral/command.pyi

+ 1
- 0
zuul/ansible/2.8/actiontrusted/__init__.py View File

@@ -0,0 +1 @@
../../base/actiontrusted/__init__.py

+ 1
- 0
zuul/ansible/2.8/actiontrusted/command.py View File

@@ -0,0 +1 @@
../../base/actiontrusted/command.py

+ 1
- 0
zuul/ansible/2.8/actiontrusted/command.pyi View File

@@ -0,0 +1 @@
../../base/actiontrusted/command.pyi

+ 1
- 0
zuul/ansible/2.9/action/command.py View File

@@ -0,0 +1 @@
../../base/action/command.py

+ 1
- 0
zuul/ansible/2.9/action/command.pyi View File

@@ -0,0 +1 @@
../../base/action/command.pyi

+ 0
- 1
zuul/ansible/2.9/actiongeneral/command.py View File

@@ -1 +0,0 @@
../../base/actiongeneral/command.py

+ 0
- 1
zuul/ansible/2.9/actiongeneral/command.pyi View File

@@ -1 +0,0 @@
../../base/actiongeneral/command.pyi

+ 1
- 0
zuul/ansible/2.9/actiontrusted/__init__.py View File

@@ -0,0 +1 @@
../../base/actiontrusted/__init__.py

+ 1
- 0
zuul/ansible/2.9/actiontrusted/command.py View File

@@ -0,0 +1 @@
../../base/actiontrusted/command.py

+ 1
- 0
zuul/ansible/2.9/actiontrusted/command.pyi View File

@@ -0,0 +1 @@
../../base/actiontrusted/command.pyi

+ 33
- 0
zuul/ansible/base/action/command.py View File

@@ -0,0 +1,33 @@
# Copyright 2018 BMW Car IT GmbH
#
# This module is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This software is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this software. If not, see <http://www.gnu.org/licenses/>.


from zuul.ansible import paths
from ansible.errors import AnsibleError
command = paths._import_ansible_action_plugin("command")


class ActionModule(command.ActionModule):

def run(self, tmp=None, task_vars=None):
if paths._is_localhost_task(self):
raise AnsibleError("Executing local code is prohibited")

# we need the zuul_log_id on shell and command tasks
host = paths._sanitize_filename(task_vars.get('inventory_hostname'))
if self._task.action in ('command', 'shell'):
self._task.args['zuul_log_id'] = "%s-%s" % (self._task._uuid, host)

return super(ActionModule, self).run(tmp, task_vars)

zuul/ansible/base/actiongeneral/command.pyi → zuul/ansible/base/action/command.pyi View File


+ 0
- 0
zuul/ansible/base/actiontrusted/__init__.py View File


zuul/ansible/base/actiongeneral/command.py → zuul/ansible/base/actiontrusted/command.py View File


+ 0
- 0
zuul/ansible/base/actiontrusted/command.pyi View File


+ 12
- 2
zuul/executor/server.py View File

@@ -859,6 +859,7 @@ class AnsibleJob(object):
self.library_dir = os.path.join(plugin_dir, 'library')
self.action_dir = os.path.join(plugin_dir, 'action')
self.action_dir_general = os.path.join(plugin_dir, 'actiongeneral')
self.action_dir_trusted = os.path.join(plugin_dir, 'actiontrusted')
self.callback_dir = os.path.join(plugin_dir, 'callback')
self.lookup_dir = os.path.join(plugin_dir, 'lookup')
self.filter_dir = os.path.join(plugin_dir, 'filter')
@@ -2052,13 +2053,22 @@ class AnsibleJob(object):
# 10s to respond
config.write('timeout = 30\n')

# We need at least the general action dir as this overwrites the
# command action plugin for log streaming.
# We need the general action dir to make the zuul_return plugin
# available to every job.
action_dirs = [self.action_dir_general]
if not trusted:
# Untrusted jobs add the action dir which makes sure localhost
# modules are restricted where needed. Further the command
# plugin needs to be restricted and also inject zuul_log_id
# to make log streaming work.
action_dirs.append(self.action_dir)
config.write('lookup_plugins = %s\n'
% self.lookup_dir)
else:
# Trusted jobs add the actiontrusted dir which adds the
# unrestricted command plugin to inject zuul_log_id to make
# log streaming work.
action_dirs.append(self.action_dir_trusted)

config.write('action_plugins = %s\n'
% ':'.join(action_dirs))


Loading…
Cancel
Save