Skip to content

Add/agent control scan config defaults #1303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ozgen wants to merge 2 commits into
base: main
Choose a base branch
from
+649 −288
Open

Add/agent control scan config defaults #1303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
92a585c
change: align modify_agent_control_scan_config with new XML shape
ozgen Mar 6, 2026
f700154
add: add sync_agents command
ozgen Mar 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion gvm/protocols/gmp/_gmpnext.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ def modify_agent_control_scan_config(
return self._send_request_and_transform_response(
Agents.modify_agent_control_scan_config(
agent_control_id=agent_control_id,
config=config,
config_defaults=config,
)
)

Expand Down Expand Up @@ -303,6 +303,10 @@ def clone_agent_group(
AgentGroups.clone_agent_group(agent_group_id)
)

def sync_agents(self) -> T:
"""Trigger agents synchronization from all agent controllers."""
return self._send_request_and_transform_response(Agents.sync_agents())

def create_credential_store_credential(
self,
name: str,
Expand Down
184 changes: 145 additions & 39 deletions gvm/protocols/gmp/requests/next/_agents.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,14 @@

from typing import Any, Mapping, Optional, Sequence

from gvm.errors import RequiredArgument
from gvm.errors import InvalidArgumentType, RequiredArgument
from gvm.protocols.core import Request
from gvm.protocols.gmp.requests._entity_id import EntityID
from gvm.utils import to_bool
from gvm.xml import XmlCommand


class Agents:

@staticmethod
def _add_element(element, name: str, value: Any) -> None:
"""
Expand All @@ -24,8 +23,14 @@ def _add_element(element, name: str, value: Any) -> None:
value: Value to set as the text of the sub-element. If None, the
element will not be created.
"""
if value is not None:
element.add_element(name, str(value))
if value is None:
return
if isinstance(value, bool):
value = "1" if value else "0"
else:
value = str(value)

element.add_element(name, value)

@classmethod
def _validate_agent_config(
Expand Down Expand Up @@ -67,7 +72,11 @@ def valid_value(d: Mapping[str, Any], key: str, path: str) -> Any:
valid_value(se, "indexer_dir_depth", "agent_script_executor.")

sched = se.get("scheduler_cron_time")
if isinstance(sched, Sequence) and not isinstance(sched, (str, bytes)):
if isinstance(sched, str):
items = [sched]
elif isinstance(sched, Sequence) and not isinstance(
sched, (str, bytes)
):
items = [str(x) for x in sched]
else:
items = []
Expand All @@ -83,7 +92,58 @@ def valid_value(d: Mapping[str, Any], key: str, path: str) -> Any:
valid_value(hb, "miss_until_inactive", "heartbeat.")

@classmethod
def _append_agent_config(cls, parent, config: Mapping[str, Any]) -> None:
def _validate_config_defaults(
cls, config_defaults: Mapping[str, Any], *, caller: str
) -> None:
"""Ensure agent config defaults structure is valid."""

def valid_map(d: Any, key: str, path: str) -> Mapping[str, Any]:
if not isinstance(d, Mapping):
raise RequiredArgument(
function=caller,
argument=path.rstrip("."),
)
v = d.get(key)
if not isinstance(v, Mapping):
raise RequiredArgument(
function=caller,
argument=f"{path}{key}",
)
return v

def valid_bool(d: Mapping[str, Any], key: str, path: str) -> bool:
v = d.get(key)
if not isinstance(v, bool):
raise InvalidArgumentType(
function=caller,
argument=f"{path}{key}",
arg_type="bool",
)
return v

agent_defaults = valid_map(
config_defaults, "agent_defaults", "config_defaults."
)
cls._validate_agent_config(agent_defaults, caller=caller)

agent_control_defaults = valid_map(
config_defaults,
"agent_control_defaults",
"config_defaults.",
)
valid_bool(
agent_control_defaults,
"update_to_latest",
"config_defaults.agent_control_defaults.",
)

@classmethod
def _append_agent_config(
cls,
parent,
config: Mapping[str, Any],
wrapper_tag: Optional[str] = "config",
) -> None:
"""
Append an agent configuration block to the given XML parent element.
Expand All @@ -110,12 +170,18 @@ def _append_agent_config(cls, parent, config: Mapping[str, Any]) -> None:
}
Args:
parent: The XML parent element to which the `<config>` element
parent: The XML parent element to which the wrapper element
should be appended.
config: Mapping containing the agent configuration fields to
serialize.
wrapper_tag: Optional wrapper element name. If None, fields are
appended directly to parent.
"""
xml_config = parent.add_element("config")
xml_config = (
parent.add_element(wrapper_tag)
if wrapper_tag is not None
else parent
)

# agent_control.retry
ac = config["agent_control"]
Expand Down Expand Up @@ -145,9 +211,18 @@ def _append_agent_config(cls, parent, config: Mapping[str, Any]) -> None:
xml_se, "indexer_dir_depth", se.get("indexer_dir_depth")
)
sched = se.get("scheduler_cron_time")
xml_sched = xml_se.add_element("scheduler_cron_time")
for item in sched:
xml_sched.add_element("item", str(item))
if isinstance(sched, str):
sched_items = [sched]
else:
sched_items = list(sched or [])

if sched_items:
xml_sched = xml_se.add_element(
"scheduler_cron_time",
attrs={"is_list": "1"},
)
for item in sched_items:
xml_sched.add_element("item", str(item))

# heartbeat
hb = config["heartbeat"]
Expand All @@ -159,6 +234,29 @@ def _append_agent_config(cls, parent, config: Mapping[str, Any]) -> None:
xml_hb, "miss_until_inactive", hb.get("miss_until_inactive")
)

@classmethod
def _append_config_defaults(
cls, parent, config_defaults: Mapping[str, Any]
) -> None:
xml_defaults = parent.add_element("config_defaults")

cls._append_agent_config(
xml_defaults,
config_defaults["agent_defaults"],
wrapper_tag="agent_defaults",
)

control_defaults = config_defaults.get("agent_control_defaults")
if control_defaults:
xml_control_defaults = xml_defaults.add_element(
"agent_control_defaults"
)
cls._add_element(
xml_control_defaults,
"update_to_latest",
control_defaults.get("update_to_latest"),
)

@classmethod
def get_agents(
cls,
Expand Down Expand Up @@ -273,54 +371,62 @@ def delete_agents(cls, agent_ids: list[EntityID]) -> Request:
def modify_agent_control_scan_config(
cls,
agent_control_id: EntityID,
config: Mapping[str, Any],
config_defaults: Mapping[str, Any],
) -> Request:
"""
Modify agent control scan config.
Args:
agent_control_id: The agent control UUID.
config: Nested config, e.g.:
config_defaults: Nested config, e.g.:
{
"agent_control": {
"retry": {
"attempts": 6,
"delay_in_seconds": 60,
"max_jitter_in_seconds": 10,
}
},
"agent_script_executor": {
"bulk_size": 2,
"bulk_throttle_time_in_ms": 300,
"indexer_dir_depth": 100,
"scheduler_cron_time": ["0 */12 * * *"], # str or list[str]
},
"heartbeat": {
"interval_in_seconds": 300,
"miss_until_inactive": 1,
},
"agent_defaults": {
"agent_control": {
"retry": {
"attempts": 6,
"delay_in_seconds": 60,
"max_jitter_in_seconds": 10,
}
},
"agent_script_executor": {
"bulk_size": 2,
"bulk_throttle_time_in_ms": 300,
"indexer_dir_depth": 100,
"scheduler_cron_time": ["0 */12 * * *"],
},
"heartbeat": {
"interval_in_seconds": 300,
"miss_until_inactive": 1,
},
},
"agent_control_defaults": {
"update_to_latest": False,
},
}
"""
if not agent_control_id:
raise RequiredArgument(
function=cls.modify_agent_control_scan_config.__name__,
argument="agent_control_id",
)
if not config:
if not config_defaults:
raise RequiredArgument(
function=cls.modify_agent_control_scan_config.__name__,
argument="config",
argument="config_defaults",
)

cls._validate_agent_config(
config, caller=cls.modify_agent_control_scan_config.__name__
cls._validate_config_defaults(
config_defaults,
caller=cls.modify_agent_control_scan_config.__name__,
)

cmd = XmlCommand(
"modify_agent_control_scan_config",
)
cmd = XmlCommand("modify_agent_control_scan_config")
cmd.set_attribute("agent_control_id", str(agent_control_id))

cls._append_agent_config(cmd, config)
cls._append_config_defaults(cmd, config_defaults)

return cmd

@classmethod
def sync_agents(cls) -> Request:
"""Trigger agents synchronization from all agent controllers."""
return XmlCommand("sync_agents")
Loading