fix(ping): refuse a destination or source that reads as an option
Quoting keeps a value one word, but ping still reads a word starting with "-" as one of its options: ping(destination="-f") sent a flood ping option instead of a host, and a source "-f" did the same after -I. No address or hostname starts with "-", so ping_command now refuses such a destination or source with ValueError before anything is sent. Closes #63
This commit is contained in:
1 parent
e4c65945b9
commit
a1e8ec78c3
4 files changed
+22
-3
No files matched your search
+3
-1
@@ -62,7 +62,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
- `ping()` passes `destination` and `source` to the host's shell as one quoted word
|
- `ping()` passes `destination` and `source` to the host's shell as one quoted word
|
||||||
each (#55). A destination such as `192.0.2.1; id` ran the command after the `;` as
|
each (#55). A destination such as `192.0.2.1; id` ran the command after the `;` as
|
||||||
the login user. `count`, `timeout`, `size` and `ttl` must be numbers; anything else
|
the login user. `count`, `timeout`, `size` and `ttl` must be numbers; anything else
|
||||||
raises `ValueError` before a command is sent.
|
raises `ValueError` before a command is sent. A destination or source that starts
|
||||||
|
with `-` is refused the same way (#63): `ping` would read `-f` as its flood option,
|
||||||
|
and no address or hostname starts with `-`.
|
||||||
- dnf and yum hosts read pending updates and security advisories from the cached
|
- dnf and yum hosts read pending updates and security advisories from the cached
|
||||||
metadata only (`--cacheonly`), as apt reads its local index (#59). With an expired
|
metadata only (`--cacheonly`), as apt reads its local index (#59). With an expired
|
||||||
cache `check-update` downloaded the repositories' metadata first, and on an Oracle
|
cache `check-update` downloaded the repositories' metadata first, and on an Oracle
|
||||||
|
|||||||
@@ -27,8 +27,13 @@ def ping_command(
|
|||||||
) -> str:
|
) -> str:
|
||||||
"""The shell line that pings *destination*: the names quoted, the numbers numbers (#55).
|
"""The shell line that pings *destination*: the names quoted, the numbers numbers (#55).
|
||||||
|
|
||||||
:raises ValueError: for a count, timeout, size or ttl that is no number.
|
:raises ValueError: for a count, timeout, size or ttl that is no number, and for a
|
||||||
|
destination or source that ping would read as an option (#63): no address or
|
||||||
|
hostname starts with ``-``.
|
||||||
"""
|
"""
|
||||||
|
for name in (destination, source):
|
||||||
|
if name.startswith("-"):
|
||||||
|
raise ValueError(f"{name!r} would be read as a ping option, not an address")
|
||||||
numbers = f"-c {int(count)} -W {int(timeout)} -s {int(size)} -t {int(ttl)}"
|
numbers = f"-c {int(count)} -W {int(timeout)} -s {int(size)} -t {int(ttl)}"
|
||||||
src_opt = f" -I {quote(source)}" if source else ""
|
src_opt = f" -I {quote(source)}" if source else ""
|
||||||
return f"ping {numbers}{src_opt} {quote(destination)} 2>&1"
|
return f"ping {numbers}{src_opt} {quote(destination)} 2>&1"
|
||||||
|
|||||||
@@ -1086,7 +1086,7 @@ class LinuxDriver(
|
|||||||
count: int = 5,
|
count: int = 5,
|
||||||
vrf: str = "",
|
vrf: str = "",
|
||||||
) -> dict[str, Any]:
|
) -> dict[str, Any]:
|
||||||
"""Ping from the remote host; ValueError for a count, timeout, size or ttl not a number."""
|
"""Ping from the remote host; ValueError for a bad number or a name starting with -."""
|
||||||
return parse_ping(self._send(ping_command(destination, source, ttl, timeout, size, count)))
|
return parse_ping(self._send(ping_command(destination, source, ttl, timeout, size, count)))
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
# ------------------------------------------------------------------
|
||||||
|
|||||||
@@ -540,6 +540,18 @@ class TestPingArguments:
|
|||||||
|
|
||||||
assert sent == "ping -c 3 -W 1 -s 56 -t 64 192.0.2.1 2>&1"
|
assert sent == "ping -c 3 -W 1 -s 56 -t 64 192.0.2.1 2>&1"
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("destination", "source"), [("-f", ""), ("192.0.2.1", "-f"), ("-p ff", "")]
|
||||||
|
)
|
||||||
|
def test_an_option_in_place_of_a_name_is_refused_before_anything_is_sent(
|
||||||
|
self, driver, destination, source
|
||||||
|
):
|
||||||
|
"""Quoting keeps a word one word, and ping still reads ``-f`` as its option (#63)."""
|
||||||
|
with patch.object(driver, "_send") as send, pytest.raises(ValueError, match="option"):
|
||||||
|
driver.ping(destination, source=source)
|
||||||
|
|
||||||
|
send.assert_not_called()
|
||||||
|
|
||||||
def test_a_number_that_is_not_one_is_refused_before_anything_is_sent(self, driver):
|
def test_a_number_that_is_not_one_is_refused_before_anything_is_sent(self, driver):
|
||||||
with patch.object(driver, "_send") as send, pytest.raises(ValueError):
|
with patch.object(driver, "_send") as send, pytest.raises(ValueError):
|
||||||
driver.ping("192.0.2.1", count="5; id")
|
driver.ping("192.0.2.1", count="5; id")
|
||||||
|
|||||||
Reference in new issue
Block a user