diff --git a/docs/vyos.vyos.vyos_file_module.rst b/docs/vyos.vyos.vyos_file_module.rst index 026aa30d..b9b244a1 100644 --- a/docs/vyos.vyos.vyos_file_module.rst +++ b/docs/vyos.vyos.vyos_file_module.rst @@ -1,249 +1,249 @@ .. _vyos.vyos.vyos_file_module: ******************* vyos.vyos.vyos_file ******************* **Manage files, directories, and their ownership on VyOS devices** -Version added: 1.0.0 +Version added: 5.4.0 .. contents:: :local: :depth: 1 Synopsis -------- - Creates, updates, or removes a file or directory on a VyOS device, optionally pushing content from a local file (*src*) or inline text (*content*), and setting owner/group/mode via sudo chown/chmod. - This module does not touch the configuration tree (config.boot). It manages arbitrary filesystem paths such as certificates or auth files under /config/auth/, which are not tracked by commit/save/rollback. - All logic runs inside this module's main(), using the standard get_connection()/run_commands() pattern shared with vyos_command — there is no dedicated action plugin; this module uses the shared generic vyos action plugin like every other module in the collection. Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
become
boolean
    Choices:
  • no
  • yes ←
Whether to prefix remote commands with sudo.
content
string
Inline text content to write to dest. Marked no_log, since this module is commonly used to push credential material. Mutually exclusive with src.
dest
path / required
Absolute path to the remote file or directory to manage.
group
string
Name of the group that should own dest.
mode
string
Permission bits for dest, as a string (e.g. '0600'). Compared against stat output after normalizing to 4 digits; '600' and '0600' are treated as equivalent.
owner
string
Name of the user that should own dest.
src
path
Path to a local file (on the Ansible controller) whose content should be pushed to dest. Read locally and pushed as base64 via a single CLI command, since network_cli has no SFTP/SCP channel available to this module. Mutually exclusive with content.
state
string
    Choices:
  • present ←
  • absent
Whether the path should exist (present) or be removed (absent).

Notes ----- .. note:: - This module works with connection ``ansible.netcommon.network_cli``. - File state managed by this module is independent of VyOS's config revision system. A rollback to a previous config revision will not revert changes made by this module. - Paths under */config/auth* are deliberately setgid ``vyattacfg`` by VyOS's own config-management convention (see vyos.dev T2713). If *mode* is given with a leading digit of ``0`` (e.g. ``'0750'``), this module compares only the rwx bits and will not report a diff for VyOS's own setgid bit. To manage the setgid/setuid/sticky bit explicitly, pass a non-zero leading digit (e.g. ``'2750'``). Examples -------- .. code-block:: yaml - name: ensure the auth directory exists with correct ownership vyos.vyos.vyos_file: dest: /config/auth/office-vpn owner: openvpn group: openvpn mode: '0750' - name: push a client certificate with correct ownership vyos.vyos.vyos_file: dest: /config/auth/office-vpn/client.pem src: files/office-vpn-client.pem owner: openvpn group: openvpn mode: '0600' - name: remove a stale cert vyos.vyos.vyos_file: dest: /config/auth/old-vpn/client.pem state: absent Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html
Key Returned Description
diff_fields
list / elements=string
always
Fields that differed between requested and actual state and were converged.

Sample:
['owner', 'mode', 'content']


Status ------ Authors ~~~~~~~ -- Evgeny Molotkov (@omnom62) +- VyOS maintainers and contributors diff --git a/plugins/modules/vyos_file.py b/plugins/modules/vyos_file.py index cf47196d..4b2b92a2 100644 --- a/plugins/modules/vyos_file.py +++ b/plugins/modules/vyos_file.py @@ -1,284 +1,323 @@ #!/usr/bin/python # -*- coding: utf-8 -*- # Copyright: (c) 2026, VyOS maintainers and contributors # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = """ module: vyos_file short_description: Manage files, directories, and their ownership on VyOS devices description: - Creates, updates, or removes a file or directory on a VyOS device, optionally pushing content from a local file (I(src)) or inline text (I(content)), and setting owner/group/mode via sudo chown/chmod. - This module does not touch the configuration tree (config.boot). It manages arbitrary filesystem paths such as certificates or auth files under /config/auth/, which are not tracked by commit/save/rollback. - All logic runs inside this module's main(), using the standard get_connection()/run_commands() pattern shared with vyos_command — there is no dedicated action plugin; this module uses the shared generic vyos action plugin like every other module in the collection. -version_added: "1.0.0" +version_added: "5.4.0" author: - - Evgeny Molotkov (@omnom62) + - VyOS maintainers and contributors options: dest: description: Absolute path to the remote file or directory to manage. type: path required: true state: description: Whether the path should exist (present) or be removed (absent). type: str choices: [present, absent] default: present src: description: - Path to a local file (on the Ansible controller) whose content should be pushed to I(dest). Read locally and pushed as base64 via a single CLI command, since network_cli has no SFTP/SCP channel available to this module. Mutually exclusive with I(content). type: path content: description: - Inline text content to write to I(dest). Marked no_log, since this module is commonly used to push credential material. Mutually exclusive with I(src). type: str + no_log: true owner: description: Name of the user that should own I(dest). type: str group: description: Name of the group that should own I(dest). type: str mode: description: - Permission bits for I(dest), as a string (e.g. '0600'). Compared against stat output after normalizing to 4 digits; '600' and '0600' are treated as equivalent. type: str become: description: Whether to prefix remote commands with sudo. type: bool default: true notes: - This module works with connection C(ansible.netcommon.network_cli). - File state managed by this module is independent of VyOS's config revision system. A rollback to a previous config revision will not revert changes made by this module. - Paths under I(/config/auth) are deliberately setgid C(vyattacfg) by VyOS's own config-management convention (see vyos.dev T2713). If I(mode) is given with a leading digit of C(0) (e.g. C('0750')), this module compares only the rwx bits and will not report a diff for VyOS's own setgid bit. To manage the setgid/setuid/sticky bit explicitly, pass a non-zero leading digit (e.g. C('2750')). """ EXAMPLES = """ - name: ensure the auth directory exists with correct ownership vyos.vyos.vyos_file: dest: /config/auth/office-vpn owner: openvpn group: openvpn mode: '0750' - name: push a client certificate with correct ownership vyos.vyos.vyos_file: dest: /config/auth/office-vpn/client.pem src: files/office-vpn-client.pem owner: openvpn group: openvpn mode: '0600' - name: remove a stale cert vyos.vyos.vyos_file: dest: /config/auth/old-vpn/client.pem state: absent """ RETURN = """ diff_fields: description: Fields that differed between requested and actual state and were converged. returned: always type: list elements: str sample: ["owner", "mode", "content"] """ import base64 import hashlib +import shlex from ansible.module_utils.basic import AnsibleModule from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.vyos import ( run_commands, ) from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.vyos_file import ( build_want, diff_want_have, parse_stat, ) ARGUMENT_SPEC = dict( dest=dict(type="path", required=True), state=dict(type="str", choices=["present", "absent"], default="present"), src=dict(type="path"), content=dict(type="str", no_log=True), owner=dict(type="str"), group=dict(type="str"), mode=dict(type="str"), become=dict(type="bool", default=True), ) def get_have(module, become, dest, need_content_hash=False): - + quoted_dest = shlex.quote(dest) + # check_rc=False is required here: a missing path is a normal, expected + # outcome on first-run creation, not a failure. With the default + # check_rc=True, run_commands() would call module.fail_json() on every + # "file doesn't exist yet" case, which is exactly the case we need to + # handle gracefully to build `have`. responses = run_commands( module, - ["{0}stat --format='%a %U %G %s' {1}".format(become, dest)], + ["{0}stat --format='%a %U %G %s' {1}".format(become, quoted_dest)], check_rc=False, ) out = responses[0] if responses else "" - if not out or "No such file" in out or ("stat:" in out and "cannot stat" in out): + + # Only treat the specific "doesn't exist" message as absent. Any other + # stat failure (permission denied, I/O error, etc.) is a real problem + # that should fail loudly rather than be silently reinterpreted as + # "create it" — a permission-denied stat masked as "missing" could lead + # this module to attempt mkdir/chown/chmod against a path it actually + # has no visibility into, with confusing results. + if not out: return None + if "No such file" in out: + return None + if "stat:" in out and "cannot stat" in out: + module.fail_json( + msg="vyos_file: stat failed for {0}: {1}".format(dest, out.strip()), + ) + have = parse_stat(out) if need_content_hash and have is not None: - + # Only hash when content comparison actually matters (src/content + # given) — no need to pay this cost for plain directory/ownership + # management. Without this, `have["content_hash"]` would always be + # None, so `content` would show as "different" forever, even right + # after a successful write. hash_responses = run_commands( module, - ["{0}sha256sum {1}".format(become, dest)], + ["{0}sha256sum {1}".format(become, quoted_dest)], check_rc=False, ) hash_out = hash_responses[0] if hash_responses else "" # sha256sum output format: " " parts = hash_out.strip().split() if parts: have["content_hash"] = parts[0] return have def local_content_hash(params): if params.get("src"): h = hashlib.sha256() with open(params["src"], "rb") as f: for chunk in iter(lambda: f.read(65536), b""): h.update(chunk) return h.hexdigest() if params.get("content") is not None: return hashlib.sha256(params["content"].encode()).hexdigest() return None def read_local_bytes(params): if params.get("src"): with open(params["src"], "rb") as f: return f.read() if params.get("content") is not None: return params["content"].encode() return None def converge(module, become, dest, want, diff, params): cmds = [] + quoted_dest = shlex.quote(dest) if want["state"] == "absent": - cmds.append("{0}rm -rf {1}".format(become, dest)) + cmds.append("{0}rm -rf {1}".format(become, quoted_dest)) run_commands(module, cmds) post_have = get_have(module, become, dest) if post_have is not None: module.fail_json( msg="vyos_file: removal of {0} did not take effect".format(dest), ) return if "content" in diff: data = read_local_bytes(params) b64 = base64.b64encode(data).decode() + # base64's alphabet (A-Za-z0-9+/=) contains no shell metacharacters, + # so it's safe unquoted on its own — but dest still needs quoting. cmds.append( - '{0}sh -c "echo {1} | base64 -d > {2}"'.format(become, b64, dest), + '{0}sh -c "echo {1} | base64 -d > {2}"'.format(become, b64, quoted_dest), ) elif "state" in diff and have_is_missing(diff): - cmds.append("{0}mkdir -p {1}".format(become, dest)) + cmds.append("{0}mkdir -p {1}".format(become, quoted_dest)) if "owner" in diff and "group" in diff: cmds.append( - "{0}chown {1}:{2} {3}".format(become, want["owner"], want["group"], dest), + "{0}chown {1}:{2} {3}".format( + become, + shlex.quote(want["owner"]), + shlex.quote(want["group"]), + quoted_dest, + ), ) elif "owner" in diff: - cmds.append("{0}chown {1} {2}".format(become, want["owner"], dest)) + cmds.append( + "{0}chown {1} {2}".format(become, shlex.quote(want["owner"]), quoted_dest), + ) elif "group" in diff: - cmds.append("{0}chgrp {1} {2}".format(become, want["group"], dest)) + cmds.append( + "{0}chgrp {1} {2}".format(become, shlex.quote(want["group"]), quoted_dest), + ) if "mode" in diff: - cmds.append("{0}chmod {1} {2}".format(become, want["mode"], dest)) + cmds.append( + "{0}chmod {1} {2}".format(become, shlex.quote(want["mode"]), quoted_dest), + ) if cmds: run_commands(module, cmds) # run_commands() only confirms the CLI accepted each command line # syntactically — it does NOT confirm the underlying binary succeeded. # A chown against a nonexistent group, for example, prints an error to # stdout but the CLI wrapper still reports the line as "executed"; we # would otherwise report changed=true for a write that silently did # nothing. Re-stat and compare against `want` to catch this class of # failure before returning success. post_have = get_have( module, become, dest, need_content_hash=want.get("content_hash") is not None, ) post_diff = diff_want_have(want, post_have) if post_diff: module.fail_json( msg=( "vyos_file converged but post-check found remaining " "differences — one or more commands likely failed silently " "at the OS level (e.g. chown to a nonexistent user/group): " "{0}".format(post_diff) ), ) def have_is_missing(diff): return diff.get("state") == (None, "present") def main(): module = AnsibleModule( argument_spec=ARGUMENT_SPEC, mutually_exclusive=[["src", "content"]], supports_check_mode=True, ) become = "sudo " if module.params.get("become", True) else "" dest = module.params["dest"] if not dest.startswith("/") or dest == "/": module.fail_json(msg="vyos_file: dest must be an absolute path and must not be '/'") want = build_want(module.params, local_content_hash(module.params)) have = get_have( module, become, dest, need_content_hash=want.get("content_hash") is not None, ) diff = diff_want_have(want, have) result = {"changed": bool(diff), "diff_fields": list(diff.keys())} if module.check_mode or not diff: module.exit_json(**result) converge(module, become, dest, want, diff, module.params) module.exit_json(**result) if __name__ == "__main__": main() diff --git a/tests/unit/modules/network/vyos/test_vyos_file.py b/tests/unit/modules/network/vyos/test_vyos_file.py index 3d545eab..bf856a63 100644 --- a/tests/unit/modules/network/vyos/test_vyos_file.py +++ b/tests/unit/modules/network/vyos/test_vyos_file.py @@ -1,216 +1,220 @@ # tests/unit/modules/network/vyos/test_vyos_file.py # # Mocks run_commands() directly — the real call path this module uses via # get_connection()/run_commands() in module_utils/network/vyos/vyos.py. # This replaces an earlier draft that mocked a bespoke ActionModule; that # design was abandoned once it turned out every module in this collection # (vyos_command, vyos_config, etc.) shares one generic action plugin and # puts real logic inside main() instead. from __future__ import absolute_import, division, print_function __metaclass__ = type import json from unittest.mock import patch from ansible_collections.vyos.vyos.plugins.modules import vyos_file +from ansible_collections.vyos.vyos.tests.unit.modules.network.vyos.vyos_module import ( + TestVyosModule, +) from ansible_collections.vyos.vyos.tests.unit.modules.utils import ( AnsibleExitJson, AnsibleFailJson, - ModuleTestCase, set_module_args, ) -class TestVyosFileModule(ModuleTestCase): +class TestVyosFileModule(TestVyosModule): + + module = vyos_file def setUp(self): super(TestVyosFileModule, self).setUp() self.mock_run_commands = patch( "ansible_collections.vyos.vyos.plugins.modules.vyos_file.run_commands", ) self.run_commands = self.mock_run_commands.start() def tearDown(self): super(TestVyosFileModule, self).tearDown() self.mock_run_commands.stop() # ---- helpers ----------------------------------------------------- def _queue(self, *responses): """Queue successive return values, one per run_commands() call.""" self.run_commands.side_effect = list(responses) def _run(self, args, expect_fail=False): set_module_args(args) exc = AnsibleFailJson if expect_fail else AnsibleExitJson with self.assertRaises(exc) as ctx: vyos_file.main() return ctx.exception.args[0] # ---- idempotency core --------------------------------------------- def test_creates_when_absent(self): # get_have() issues ONE stat call; converge() batches mkdir+chown+ # chmod into a SINGLE run_commands() call (not one call per # command); the post-check issues one more stat call. Three total # run_commands() invocations, matching the module's actual batching. self._queue( ["stat: cannot statx '/config/auth/x': No such file or directory"], ["", "", ""], # mkdir, chown, chmod — one batched call ["750 vyos vyattacfg 4096"], # post-check stat ) result = self._run( {"dest": "/config/auth/x", "owner": "vyos", "group": "vyattacfg", "mode": "0750"}, ) self.assertTrue(result["changed"]) self.assertIn("state", result["diff_fields"]) self.assertIn("owner", result["diff_fields"]) def test_noop_when_converged(self): self._queue(["750 vyos vyattacfg 4096"]) result = self._run( {"dest": "/config/auth/x", "owner": "vyos", "group": "vyattacfg", "mode": "0750"}, ) self.assertFalse(result["changed"]) self.assertEqual(result["diff_fields"], []) def test_setgid_ignored_when_mode_leading_digit_is_zero(self): # /config/auth is deliberately setgid vyattacfg (vyos.dev T2713). # Requesting mode '0750' (leading digit 0) must NOT be reported as # different from an actual mode of 2750. self._queue(["2750 vyos vyattacfg 4096"]) result = self._run({"dest": "/config/auth/x", "mode": "0750"}) self.assertFalse(result["changed"], result.get("diff_fields")) def test_setgid_respected_when_explicitly_requested(self): # Explicit non-zero leading digit means the caller does care about # the special bits — since 2750 is requested and 2750 is already # there, this should be a no-op (only the initial stat call fires). self._queue(["2750 vyos vyattacfg 4096"]) result = self._run({"dest": "/config/auth/x", "mode": "2750"}) self.assertFalse(result["changed"]) def test_mode_change_detected(self): # Only mode differs, so converge() batches a single chmod command # (one run_commands() call), then the post-check stat is a second. self._queue( ["600 vyos vyattacfg 10"], [""], # chmod — the only mutating command needed ["640 vyos vyattacfg 10"], ) result = self._run({"dest": "/config/auth/x/hello.txt", "mode": "0640"}) self.assertTrue(result["changed"]) self.assertEqual(result["diff_fields"], ["mode"]) def test_mode_string_normalization(self): for requested in ("640", "0640", "00640"): with self.subTest(requested=requested): self._queue(["640 vyos vyattacfg 10"]) result = self._run({"dest": "/config/auth/x/hello.txt", "mode": requested}) self.assertFalse( result["changed"], "mode {0!r} incorrectly compared unequal to stat's '640'".format(requested), ) # ---- content --------------------------------------------------------- def test_content_push_detected_and_verified(self): # need_content_hash is True (content was given), but get_have() # only actually hashes when the path already exists — on the # initial (absent) lookup it's skipped, so that first call is a # single stat. converge() batches base64-write + chown into one # call. The post-check, now that the file exists, issues stat AND # sha256sum as two separate calls. The queued hash must be the # REAL sha256("hi\n") hex digest, or the module's own post-check # will (correctly) call fail_json on a genuine mismatch. real_hash = "98ea6e4f216f2fb4b69fff9b3a44842c38686ca685f3f55dc48c5d3fb1107be4" self._queue( ["stat: cannot statx '/config/auth/x/hello.txt': No such file or directory"], ["", "", ""], # base64 write, chown, chmod — batched (mode was also requested) ["600 vyos vyattacfg 10"], # post-check stat ["{0} /config/auth/x/hello.txt".format(real_hash)], # post-check sha256sum ) result = self._run( { "dest": "/config/auth/x/hello.txt", "content": "hi\n", "owner": "vyos", "mode": "0600", }, ) self.assertTrue(result["changed"]) self.assertIn("content", result["diff_fields"]) def test_content_hash_looked_up_only_when_relevant(self): # plain ownership/mode management on an existing path should never # trigger a sha256sum call — that's the whole point of the # need_content_hash gate. self._queue(["750 vyos vyattacfg 4096"]) self._run({"dest": "/config/auth/x", "mode": "0750"}) called_commands = [c.args[1] for c in self.run_commands.call_args_list] joined = " ".join(str(c) for c in called_commands) self.assertNotIn("sha256sum", joined) # ---- absent state ---------------------------------------------------- def test_absent_on_existing_removes(self): self._queue( ["600 vyos vyattacfg 10"], [""], # rm -rf ["stat: cannot statx '/config/auth/x/hello.txt': No such file or directory"], ) result = self._run({"dest": "/config/auth/x/hello.txt", "state": "absent"}) self.assertTrue(result["changed"]) self.assertEqual(result["diff_fields"], ["state"]) def test_absent_noop_when_already_gone(self): self._queue(["stat: cannot statx '/x': No such file or directory"]) result = self._run({"dest": "/x", "state": "absent"}) self.assertFalse(result["changed"]) # ---- silent-failure detection (the real bug this caught on hardware) -- def test_post_check_fails_module_when_chown_silently_no_ops(self): # Reproduces the real failure found on hardware: chown to a # nonexistent group prints an error but the CLI still reports the # line as "executed" with rc 0 — have must be re-verified. # converge() batches mkdir+chown into one call (mode wasn't # requested, so no chmod); the second queued item represents that # single batched call's two responses. self._queue( ["stat: cannot statx '/x': No such file or directory"], ["", "chown: invalid group: 'x:bogus'"], # mkdir ok, chown failed ["root nogroup 4096"], # post-check: neither owner nor group took ) result = self._run({"dest": "/x", "owner": "vyos", "group": "bogus"}, expect_fail=True) self.assertIn("post-check", result["msg"]) # ---- check_mode -------------------------------------------------------- def test_check_mode_reports_diff_without_converging(self): self._queue(["600 vyos vyattacfg 10"]) set_module_args({"dest": "/x", "mode": "0640", "_ansible_check_mode": True}) with self.assertRaises(AnsibleExitJson) as ctx: vyos_file.main() result = ctx.exception.args[0] self.assertTrue(result["changed"]) self.assertEqual(result["diff_fields"], ["mode"]) # only the initial stat call should have happened — no chmod self.assertEqual(self.run_commands.call_count, 1) # ---- secrets discipline ------------------------------------------------ def test_content_not_echoed_in_result(self): real_hash = "03767fbe485736bb40cc5d85e4c9bb10b12a415674b46faf005aa22188a39a10" self._queue( ["stat: cannot statx '/x': No such file or directory"], [""], # single batched command: base64 write only (no owner/mode given) ["600 root root 4"], # post-check stat ["{0} /x".format(real_hash)], # post-check sha256sum ) result = self._run({"dest": "/x", "content": "super-secret-value"}) self.assertNotIn("super-secret-value", json.dumps(result))