mal-simulator 2.4.0__tar.gz → 2.5.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (78) hide show
  1. {mal_simulator-2.4.0/mal_simulator.egg-info → mal_simulator-2.5.0}/PKG-INFO +2 -2
  2. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/README.md +1 -1
  3. {mal_simulator-2.4.0 → mal_simulator-2.5.0/mal_simulator.egg-info}/PKG-INFO +2 -2
  4. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/__init__.py +2 -2
  5. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/mal_simulator/agent_state.py +3 -9
  6. mal_simulator-2.5.0/malsim/mal_simulator/attacker_state.py +85 -0
  7. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/mal_simulator/attacker_state_factories.py +58 -70
  8. mal_simulator-2.5.0/malsim/mal_simulator/defender_state.py +80 -0
  9. mal_simulator-2.5.0/malsim/mal_simulator/defender_state_factories.py +92 -0
  10. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/mal_simulator/simulator.py +10 -8
  11. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/pyproject.toml +1 -1
  12. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/tests/test_mal_simulator.py +15 -0
  13. mal_simulator-2.4.0/malsim/mal_simulator/attacker_state.py +0 -42
  14. mal_simulator-2.4.0/malsim/mal_simulator/defender_state.py +0 -38
  15. mal_simulator-2.4.0/malsim/mal_simulator/defender_state_factories.py +0 -107
  16. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/AUTHORS +0 -0
  17. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/LICENSE +0 -0
  18. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/mal_simulator.egg-info/SOURCES.txt +0 -0
  19. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/mal_simulator.egg-info/dependency_links.txt +0 -0
  20. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/mal_simulator.egg-info/entry_points.txt +0 -0
  21. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/mal_simulator.egg-info/requires.txt +0 -0
  22. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/mal_simulator.egg-info/top_level.txt +0 -0
  23. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/__main__.py +0 -0
  24. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/config/__init__.py +0 -0
  25. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/config/agent_settings.py +0 -0
  26. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/config/agent_settings_factories.py +0 -0
  27. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/config/node_property_rule.py +0 -0
  28. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/config/sim_settings.py +0 -0
  29. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/envs/__init__.py +0 -0
  30. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/envs/base_classes.py +0 -0
  31. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/envs/graph/__init__.py +0 -0
  32. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/envs/graph/graph_env.py +0 -0
  33. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/envs/graph/mal_spaces.py +0 -0
  34. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/envs/graph/serialization.py +0 -0
  35. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/envs/graph/utils.py +0 -0
  36. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/envs/graph/wrapper.py +0 -0
  37. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/envs/legacy/__init__.py +0 -0
  38. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/envs/legacy/gym_envs.py +0 -0
  39. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/envs/legacy/malsim_vectorized_obs_env.py +0 -0
  40. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/mal_simulator/__init__.py +0 -0
  41. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/mal_simulator/agent_states.py +0 -0
  42. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/mal_simulator/attack_surface.py +0 -0
  43. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/mal_simulator/attacker_step.py +0 -0
  44. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/mal_simulator/defender_step.py +0 -0
  45. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/mal_simulator/defense_surface.py +0 -0
  46. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/mal_simulator/false_alerts.py +0 -0
  47. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/mal_simulator/graph_processing.py +0 -0
  48. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/mal_simulator/graph_state.py +0 -0
  49. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/mal_simulator/graph_utils.py +0 -0
  50. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/mal_simulator/node_getters.py +0 -0
  51. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/mal_simulator/observability.py +0 -0
  52. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/mal_simulator/reset_agent.py +0 -0
  53. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/mal_simulator/rewards.py +0 -0
  54. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/mal_simulator/run_simulation.py +0 -0
  55. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/mal_simulator/simulator_state.py +0 -0
  56. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/mal_simulator/state_query.py +0 -0
  57. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/mal_simulator/ttc_utils.py +0 -0
  58. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/policies/__init__.py +0 -0
  59. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/policies/attackers/__init__.py +0 -0
  60. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/policies/attackers/searchers.py +0 -0
  61. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/policies/attackers/shortest_path.py +0 -0
  62. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/policies/attackers/ttc_soft_min.py +0 -0
  63. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/policies/decision_agent.py +0 -0
  64. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/policies/defenders/__init__.py +0 -0
  65. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/policies/defenders/heuristic_agent.py +0 -0
  66. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/policies/keyboard_input.py +0 -0
  67. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/policies/passive_agent.py +0 -0
  68. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/policies/random_agent.py +0 -0
  69. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/policies/utils/path_finding.py +0 -0
  70. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/scenario/__init__.py +0 -0
  71. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/scenario/scenario.py +0 -0
  72. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/types.py +0 -0
  73. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/malsim/visualization/malsim_gui_client.py +0 -0
  74. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/setup.cfg +0 -0
  75. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/tests/test_graph_processing.py +0 -0
  76. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/tests/test_main.py +0 -0
  77. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/tests/test_scenario.py +0 -0
  78. {mal_simulator-2.4.0 → mal_simulator-2.5.0}/tests/test_ttc_utils.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: mal-simulator
3
- Version: 2.4.0
3
+ Version: 2.5.0
4
4
  Summary: A MAL compliant simulator.
5
5
  Author-email: Andrei Buhaiu <buhaiu@kth.se>, Joakim Loxdal <loxdal@kth.se>, Jakob Nyberg <jaknyb@kth.se>, Nikolaos Kakouros <nkak@kth.se>, Sandor Berglund <sandorb@kth.se>
6
6
  License: Apache Software License
@@ -59,7 +59,7 @@ For in-depth documentation, refer to:
59
59
  - The CI pipeline runs `pytest`, `mypy` and `ruff format && ruff check` for linting and type checking. PRs will only be merged if pipeline succeeds.
60
60
 
61
61
  ## Making a release
62
- - Make a PR where you change to the new version number in `pyproject.toml` and `malsim/__init__.py`.
62
+ - Make a release PR (called `release-x.y.z`) with your changes. Update version number in `pyproject.toml` and `malsim/__init__.py`.
63
63
  - Merge the PR after the pipeline suceeds
64
64
  - Tag the latest commit with the new version number
65
65
  - Push the tag
@@ -20,7 +20,7 @@ For in-depth documentation, refer to:
20
20
  - The CI pipeline runs `pytest`, `mypy` and `ruff format && ruff check` for linting and type checking. PRs will only be merged if pipeline succeeds.
21
21
 
22
22
  ## Making a release
23
- - Make a PR where you change to the new version number in `pyproject.toml` and `malsim/__init__.py`.
23
+ - Make a release PR (called `release-x.y.z`) with your changes. Update version number in `pyproject.toml` and `malsim/__init__.py`.
24
24
  - Merge the PR after the pipeline suceeds
25
25
  - Tag the latest commit with the new version number
26
26
  - Push the tag
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: mal-simulator
3
- Version: 2.4.0
3
+ Version: 2.5.0
4
4
  Summary: A MAL compliant simulator.
5
5
  Author-email: Andrei Buhaiu <buhaiu@kth.se>, Joakim Loxdal <loxdal@kth.se>, Jakob Nyberg <jaknyb@kth.se>, Nikolaos Kakouros <nkak@kth.se>, Sandor Berglund <sandorb@kth.se>
6
6
  License: Apache Software License
@@ -59,7 +59,7 @@ For in-depth documentation, refer to:
59
59
  - The CI pipeline runs `pytest`, `mypy` and `ruff format && ruff check` for linting and type checking. PRs will only be merged if pipeline succeeds.
60
60
 
61
61
  ## Making a release
62
- - Make a PR where you change to the new version number in `pyproject.toml` and `malsim/__init__.py`.
62
+ - Make a release PR (called `release-x.y.z`) with your changes. Update version number in `pyproject.toml` and `malsim/__init__.py`.
63
63
  - Merge the PR after the pipeline suceeds
64
64
  - Tag the latest commit with the new version number
65
65
  - Push the tag
@@ -1,4 +1,4 @@
1
- # MAL Simulator v2.3.0
1
+ # MAL Simulator v2.5.0
2
2
  # Copyright 2025, Andrei Buhaiu.
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
@@ -26,7 +26,7 @@ from malsim.scenario import Scenario
26
26
  from malsim.config import AttackerSettings, DefenderSettings
27
27
 
28
28
  __title__ = 'malsim'
29
- __version__ = '2.3.0'
29
+ __version__ = '2.5.0'
30
30
  __authors__ = [
31
31
  'Andrei Buhaiu',
32
32
  'Joakim Loxdal',
@@ -2,7 +2,6 @@ from __future__ import annotations
2
2
  from collections.abc import Mapping, Set
3
3
  from dataclasses import dataclass
4
4
 
5
-
6
5
  from maltoolbox.attackgraph import AttackGraphNode
7
6
  from malsim.mal_simulator.simulator_state import MalSimulatorState
8
7
 
@@ -21,13 +20,8 @@ class AgentState:
21
20
  performed_nodes: Set[AttackGraphNode]
22
21
  # Contains the order of performed nodes
23
22
  performed_nodes_order: Mapping[int, Set[AttackGraphNode]]
24
- # Contains the nodes performed successfully in the last step
25
- step_performed_nodes: Set[AttackGraphNode]
26
- # Contains possible nodes that became available in the last step
27
- step_action_surface_additions: Set[AttackGraphNode]
28
- # Contains nodes that became unavailable in the last step
29
- step_action_surface_removals: Set[AttackGraphNode]
30
- # Contains nodes that became unviable in the last step by defender actions
31
- step_unviable_nodes: Set[AttackGraphNode]
23
+
24
+ unviable_nodes: Set[AttackGraphNode]
25
+
32
26
  # The iteration this state was created in
33
27
  iteration: int
@@ -0,0 +1,85 @@
1
+ from __future__ import annotations
2
+ from dataclasses import dataclass, field
3
+ from collections.abc import Mapping, Set
4
+ from typing import Any
5
+ from maltoolbox.attackgraph import AttackGraphNode
6
+ from malsim.config.agent_settings import AttackerSettings
7
+ from malsim.mal_simulator.agent_state import AgentState
8
+
9
+
10
+ @dataclass(frozen=True)
11
+ class AttackerState(AgentState):
12
+ """Stores the state of an attacker in the simulator"""
13
+
14
+ settings: AttackerSettings[AttackGraphNode]
15
+ # Number of attempts to compromise a step (used for ttc caculations)
16
+ num_attempts: Mapping[AttackGraphNode, int]
17
+ # Steps attempted but not succeeded (because of TTC value)
18
+ attempted_nodes: Set[AttackGraphNode]
19
+
20
+ ttc_values: Mapping[AttackGraphNode, float]
21
+
22
+ # Goals affect simulation termination but is optional
23
+ goals: Set[AttackGraphNode] = field(default_factory=frozenset)
24
+
25
+ # Only used if `ttc_overrides` is set
26
+ impossible_steps: Set[AttackGraphNode] = field(
27
+ default_factory=frozenset
28
+ ) # Steps that are impossible to perform
29
+
30
+ previous_state: AttackerState | None = None
31
+
32
+ # Picklable
33
+ def __getstate__(self) -> dict[str, Any]:
34
+ state = self.__dict__.copy()
35
+ state['num_attempts'] = dict(state['num_attempts'])
36
+ state['performed_nodes_order'] = dict(state['performed_nodes_order'])
37
+ return state
38
+
39
+ def __setstate__(self, state: dict[str, Any]) -> None:
40
+ object.__setattr__(self, 'num_attempts', state['num_attempts'])
41
+
42
+ object.__setattr__(
43
+ self,
44
+ 'performed_nodes_order',
45
+ state['performed_nodes_order'],
46
+ )
47
+ # set other frozen attributes
48
+ for key, value in state.items():
49
+ if key not in ('num_attempts', 'ttc_overrides', 'ttc_value_overrides'):
50
+ object.__setattr__(self, key, value)
51
+
52
+ @property
53
+ def step_attempted_nodes(self) -> Set[AttackGraphNode]:
54
+ previous_attempted_nodes = (
55
+ self.previous_state.attempted_nodes if self.previous_state else set()
56
+ )
57
+ return self.attempted_nodes - previous_attempted_nodes
58
+
59
+ @property
60
+ def step_performed_nodes(self) -> Set[AttackGraphNode]:
61
+ previous_performed_nodes = (
62
+ self.previous_state.performed_nodes if self.previous_state else set()
63
+ )
64
+ return self.performed_nodes - previous_performed_nodes
65
+
66
+ @property
67
+ def step_action_surface_additions(self) -> Set[AttackGraphNode]:
68
+ previous_action_surface = (
69
+ self.previous_state.action_surface if self.previous_state else set()
70
+ )
71
+ return self.action_surface - previous_action_surface
72
+
73
+ @property
74
+ def step_action_surface_removals(self) -> Set[AttackGraphNode]:
75
+ previous_action_surface = (
76
+ self.previous_state.action_surface if self.previous_state else set()
77
+ )
78
+ return previous_action_surface - self.action_surface
79
+
80
+ @property
81
+ def step_unviable_nodes(self) -> Set[AttackGraphNode]:
82
+ previous_unviable_nodes = (
83
+ self.previous_state.unviable_nodes if self.previous_state else set()
84
+ )
85
+ return self.unviable_nodes - previous_unviable_nodes
@@ -38,95 +38,83 @@ def create_attacker_state(
38
38
  attack_surface_settings: AttackSurfaceSettings,
39
39
  attacker_settings: AttackerSettings[AttackGraphNode],
40
40
  name: str,
41
- step_compromised_nodes: Set[AttackGraphNode],
41
+ new_performed_nodes: Set[AttackGraphNode],
42
42
  ttc_values: Mapping[AttackGraphNode, float],
43
43
  impossible_steps: Set[AttackGraphNode],
44
- step_attempted_nodes: Set[AttackGraphNode] = frozenset(),
45
- step_nodes_made_unviable: Set[AttackGraphNode] = frozenset(),
44
+ new_attempted_nodes: Set[AttackGraphNode] = frozenset(),
45
+ new_unviable_nodes: Set[AttackGraphNode] = frozenset(),
46
46
  previous_state: AttackerState | None = None,
47
47
  ) -> AttackerState:
48
48
  """
49
49
  Update a previous attacker state based on what the agent compromised
50
50
  and what nodes became unviable.
51
51
  """
52
- entry_points = attacker_settings.entry_points
53
- if previous_state is None:
54
- # Initial compromised nodes are just the step compromised nodes
55
- compromised_nodes = step_compromised_nodes
56
52
 
57
- # Create an initial attack surface
58
- new_action_surface = get_attack_surface(
53
+ previous_performed_nodes = (
54
+ previous_state.performed_nodes if previous_state else set()
55
+ )
56
+ previous_performed_nodes_order = (
57
+ previous_state.performed_nodes_order if previous_state else {}
58
+ )
59
+ previous_attempted_nodes = (
60
+ previous_state.attempted_nodes if previous_state else set()
61
+ )
62
+ previous_action_surface = previous_state.action_surface if previous_state else set()
63
+ previous_num_attempts = (
64
+ previous_state.num_attempts
65
+ if previous_state
66
+ else dict.fromkeys(sim_state.attack_graph.attack_steps, 0)
67
+ )
68
+ previous_unviable_nodes = previous_state.unviable_nodes if previous_state else set()
69
+
70
+ performed_nodes = previous_performed_nodes | new_performed_nodes
71
+ performed_nodes_order = dict(previous_performed_nodes_order)
72
+ unviable_nodes = previous_unviable_nodes | new_unviable_nodes
73
+ attempted_nodes = previous_attempted_nodes | new_attempted_nodes
74
+ num_attempts = dict(previous_num_attempts)
75
+ for node in new_attempted_nodes:
76
+ num_attempts[node] += 1
77
+
78
+ # Build on previous attack surface (for performance)
79
+ action_surface_additions = (
80
+ get_attack_surface(
59
81
  attack_surface_settings,
60
82
  sim_state,
61
83
  attacker_settings.actionable_steps,
62
- compromised_nodes,
63
- )
64
- action_surface_removals: Set[AttackGraphNode] = set()
65
- action_surface_additions = new_action_surface
66
- performed_nodes_order: dict[int, Set[AttackGraphNode]] = {}
67
-
68
- if sim_state.settings.compromise_entrypoints_at_start:
69
- performed_nodes_order[0] = frozenset(entry_points)
70
- else:
71
- # If entrypoints not compromised at start,
72
- # we need to put them in action surface
73
- new_action_surface |= entry_points
74
- action_surface_additions |= entry_points
75
-
76
- previous_num_attempts: Mapping[AttackGraphNode, int] = dict.fromkeys(
77
- sim_state.attack_graph.attack_steps, 0
84
+ previous_performed_nodes | new_performed_nodes,
85
+ from_nodes=new_performed_nodes,
78
86
  )
87
+ - previous_action_surface
88
+ )
79
89
 
80
- else:
81
- compromised_nodes = previous_state.performed_nodes | step_compromised_nodes
82
- performed_nodes_order = dict(previous_state.performed_nodes_order)
83
-
84
- if step_compromised_nodes:
85
- performed_nodes_order[previous_state.iteration] = frozenset(
86
- step_compromised_nodes
87
- )
88
-
89
- # Build on previous attack surface (for performance)
90
- action_surface_additions = (
91
- get_attack_surface(
92
- attack_surface_settings,
93
- sim_state,
94
- attacker_settings.actionable_steps,
95
- compromised_nodes | step_compromised_nodes,
96
- from_nodes=step_compromised_nodes,
97
- )
98
- - previous_state.action_surface
99
- )
100
- action_surface_removals = set(
101
- (step_nodes_made_unviable & previous_state.action_surface)
102
- | step_compromised_nodes
103
- )
104
- new_action_surface = frozenset(
105
- (previous_state.action_surface - action_surface_removals)
106
- | action_surface_additions
107
- )
108
- previous_num_attempts = previous_state.num_attempts
90
+ if not previous_state and not sim_state.settings.compromise_entrypoints_at_start:
91
+ action_surface_additions |= attacker_settings.entry_points
109
92
 
110
- new_num_attempts = dict(previous_num_attempts)
111
- for node in step_attempted_nodes:
112
- new_num_attempts[node] += 1
93
+ action_surface_removals = set(
94
+ (new_unviable_nodes & previous_action_surface) | new_performed_nodes
95
+ )
96
+ action_surface = frozenset(
97
+ (previous_action_surface - action_surface_removals) | action_surface_additions
98
+ )
99
+
100
+ iteration = previous_state.iteration if previous_state else 0
101
+ if new_performed_nodes:
102
+ performed_nodes_order[iteration] = frozenset(new_performed_nodes)
113
103
 
114
104
  return AttackerState(
115
105
  name,
116
106
  sim_state=sim_state,
117
- performed_nodes=frozenset(compromised_nodes | step_compromised_nodes),
118
- action_surface=new_action_surface,
119
- step_action_surface_additions=action_surface_additions,
120
- step_action_surface_removals=frozenset(action_surface_removals),
121
- step_performed_nodes=frozenset(step_compromised_nodes),
122
- step_unviable_nodes=frozenset(step_nodes_made_unviable),
123
- step_attempted_nodes=frozenset(step_attempted_nodes),
124
- num_attempts=new_num_attempts,
125
- iteration=(previous_state.iteration + 1) if previous_state else 1,
107
+ iteration=iteration + 1,
126
108
  performed_nodes_order=performed_nodes_order,
127
109
  settings=attacker_settings,
128
110
  ttc_values=ttc_values,
129
111
  impossible_steps=impossible_steps,
112
+ unviable_nodes=unviable_nodes,
113
+ performed_nodes=frozenset(performed_nodes),
114
+ attempted_nodes=frozenset(attempted_nodes),
115
+ action_surface=action_surface,
116
+ num_attempts=num_attempts,
117
+ previous_state=previous_state,
130
118
  )
131
119
 
132
120
 
@@ -171,19 +159,19 @@ def initial_attacker_state(
171
159
  sim_state.attack_graph, attacker_settings.entry_points
172
160
  )
173
161
  )
162
+ new_compromised_nodes: Set[AttackGraphNode] = set()
174
163
 
175
- step_compromised_nodes: Set[AttackGraphNode] = set()
176
164
  if sim_state.settings.compromise_entrypoints_at_start:
177
- step_compromised_nodes = get_entrypoint_compromises(sim_state, entry_points)
165
+ new_compromised_nodes = get_entrypoint_compromises(sim_state, entry_points)
178
166
 
179
167
  return create_attacker_state(
180
168
  sim_state=sim_state,
181
169
  attack_surface_settings=sim_settings.attack_surface,
182
- name=attacker_settings.name,
183
170
  attacker_settings=attacker_settings,
184
- step_compromised_nodes=step_compromised_nodes,
171
+ name=attacker_settings.name,
185
172
  ttc_values=ttc_values,
186
173
  impossible_steps=impossible_steps,
174
+ new_performed_nodes=new_compromised_nodes,
187
175
  )
188
176
 
189
177
 
@@ -0,0 +1,80 @@
1
+ from __future__ import annotations
2
+ from collections.abc import Set
3
+ from dataclasses import dataclass
4
+ from typing import Any
5
+ from maltoolbox.attackgraph import AttackGraphNode
6
+ from malsim.config.agent_settings import DefenderSettings
7
+ from malsim.mal_simulator.agent_state import AgentState
8
+
9
+
10
+ @dataclass(frozen=True)
11
+ class DefenderState(AgentState):
12
+ """Stores the state of a defender in the simulator"""
13
+
14
+ # Contains all steps performed by any attacker
15
+ compromised_nodes: Set[AttackGraphNode]
16
+
17
+ # Contains all observed steps by any attacker
18
+ # in regards to false positives/negatives and observability
19
+ observed_nodes: Set[AttackGraphNode]
20
+
21
+ settings: DefenderSettings
22
+ previous_state: DefenderState | None = None
23
+
24
+ # Pickling
25
+ def __getstate__(self) -> dict[str, Any]:
26
+ state = self.__dict__.copy()
27
+ state['performed_nodes_order'] = dict(state['performed_nodes_order'])
28
+ return state
29
+
30
+ def __setstate__(self, state: dict[str, Any]) -> None:
31
+ object.__setattr__(
32
+ self,
33
+ 'performed_nodes_order',
34
+ state['performed_nodes_order'],
35
+ )
36
+ for key, value in state.items():
37
+ if key not in ('performed_nodes_order'):
38
+ object.__setattr__(self, key, value)
39
+
40
+ @property
41
+ def step_observed_nodes(self) -> Set[AttackGraphNode]:
42
+ previous_observed_nodes = (
43
+ self.previous_state.observed_nodes if self.previous_state else set()
44
+ )
45
+ return self.observed_nodes - previous_observed_nodes
46
+
47
+ @property
48
+ def step_compromised_nodes(self) -> Set[AttackGraphNode]:
49
+ previous_compromised_nodes = (
50
+ self.previous_state.compromised_nodes if self.previous_state else set()
51
+ )
52
+ return self.compromised_nodes - previous_compromised_nodes
53
+
54
+ @property
55
+ def step_performed_nodes(self) -> Set[AttackGraphNode]:
56
+ previous_performed_nodes = (
57
+ self.previous_state.performed_nodes if self.previous_state else set()
58
+ )
59
+ return self.performed_nodes - previous_performed_nodes
60
+
61
+ @property
62
+ def step_action_surface_additions(self) -> Set[AttackGraphNode]:
63
+ previous_action_surface = (
64
+ self.previous_state.action_surface if self.previous_state else set()
65
+ )
66
+ return self.action_surface - previous_action_surface
67
+
68
+ @property
69
+ def step_action_surface_removals(self) -> Set[AttackGraphNode]:
70
+ previous_action_surface = (
71
+ self.previous_state.action_surface if self.previous_state else set()
72
+ )
73
+ return previous_action_surface - self.action_surface
74
+
75
+ @property
76
+ def step_unviable_nodes(self) -> Set[AttackGraphNode]:
77
+ previous_unviable_nodes = (
78
+ self.previous_state.unviable_nodes if self.previous_state else set()
79
+ )
80
+ return self.unviable_nodes - previous_unviable_nodes
@@ -0,0 +1,92 @@
1
+ """Creation/manipulation of defender state"""
2
+
3
+ from collections.abc import Set
4
+
5
+ import numpy as np
6
+ from maltoolbox.attackgraph import AttackGraphNode
7
+
8
+ from malsim.config.agent_settings import DefenderSettings
9
+ from malsim.mal_simulator.defender_state import DefenderState
10
+ from malsim.mal_simulator.defense_surface import get_defense_surface
11
+ from malsim.mal_simulator.observability import observed_nodes
12
+ from malsim.mal_simulator.simulator_state import MalSimulatorState
13
+
14
+
15
+ def create_defender_state(
16
+ sim_state: MalSimulatorState,
17
+ name: str,
18
+ rng: np.random.Generator,
19
+ defender_settings: DefenderSettings,
20
+ new_compromised_nodes: Set[AttackGraphNode] = frozenset(),
21
+ new_enabled_defenses: Set[AttackGraphNode] = frozenset(),
22
+ new_unviable_nodes: Set[AttackGraphNode] = frozenset(),
23
+ previous_state: DefenderState | None = None,
24
+ ) -> DefenderState:
25
+ """
26
+ Update a previous defender state based on what steps
27
+ were enabled/compromised during last step
28
+ """
29
+ previous_enabled_defenses = (
30
+ previous_state.performed_nodes if previous_state else set()
31
+ )
32
+ previous_compromised_nodes = (
33
+ previous_state.compromised_nodes if previous_state else set()
34
+ )
35
+ previous_performed_nodes = (
36
+ previous_state.performed_nodes if previous_state else set()
37
+ )
38
+ previous_observed_nodes = previous_state.observed_nodes if previous_state else set()
39
+ performed_nodes_order = (
40
+ dict(previous_state.performed_nodes_order) if previous_state else {}
41
+ )
42
+ previous_unviable_nodes = previous_state.unviable_nodes if previous_state else set()
43
+
44
+ action_surface = (
45
+ get_defense_surface(sim_state, defender_settings.actionable_steps)
46
+ - previous_performed_nodes
47
+ )
48
+
49
+ iteration = previous_state.iteration if previous_state else 0
50
+ if new_enabled_defenses:
51
+ performed_nodes_order[iteration] = frozenset(new_enabled_defenses)
52
+
53
+ new_observed_nodes = observed_nodes(
54
+ defender_settings.observable_steps,
55
+ defender_settings.false_positive_rates,
56
+ defender_settings.false_negative_rates,
57
+ sim_state,
58
+ rng,
59
+ new_compromised_nodes,
60
+ )
61
+
62
+ return DefenderState(
63
+ name,
64
+ sim_state=sim_state,
65
+ settings=defender_settings,
66
+ performed_nodes=frozenset(previous_enabled_defenses | new_enabled_defenses),
67
+ unviable_nodes=frozenset(previous_unviable_nodes | new_unviable_nodes),
68
+ compromised_nodes=frozenset(previous_compromised_nodes | new_compromised_nodes),
69
+ observed_nodes=frozenset(previous_observed_nodes | new_observed_nodes),
70
+ action_surface=frozenset(action_surface),
71
+ iteration=iteration + 1,
72
+ performed_nodes_order=performed_nodes_order,
73
+ previous_state=previous_state,
74
+ )
75
+
76
+
77
+ def initial_defender_state(
78
+ sim_state: MalSimulatorState,
79
+ defender_settings: DefenderSettings,
80
+ pre_compromised_nodes: Set[AttackGraphNode],
81
+ pre_enabled_defenses: Set[AttackGraphNode],
82
+ rng: np.random.Generator,
83
+ ) -> DefenderState:
84
+ """Create a defender state from defender settings"""
85
+ return create_defender_state(
86
+ sim_state=sim_state,
87
+ name=defender_settings.name,
88
+ new_compromised_nodes=pre_compromised_nodes,
89
+ new_enabled_defenses=pre_enabled_defenses,
90
+ rng=rng,
91
+ defender_settings=defender_settings,
92
+ )
@@ -210,6 +210,7 @@ class MalSimulator:
210
210
  cls,
211
211
  scenario: Scenario | str,
212
212
  send_to_api: bool = False,
213
+ sim_settings: MalSimulatorSettings | None = None,
213
214
  ) -> MalSimulator:
214
215
  """Create a MalSimulator object from a Scenario object or file
215
216
 
@@ -218,7 +219,7 @@ class MalSimulator:
218
219
  sim_settings - settings to use in the simulator
219
220
  send_to_api - whether to send data to GUI REST API or not
220
221
  """
221
- return create_simulator_from_scenario(scenario, send_to_api)
222
+ return create_simulator_from_scenario(scenario, send_to_api, sim_settings)
222
223
 
223
224
  def done(self) -> bool:
224
225
  return done(self.alive_agents)
@@ -386,6 +387,7 @@ class MalSimulator:
386
387
  def create_simulator_from_scenario(
387
388
  scenario: str | Scenario,
388
389
  send_to_api: bool = False,
390
+ sim_settings: MalSimulatorSettings | None = None,
389
391
  ) -> MalSimulator:
390
392
  if isinstance(scenario, str):
391
393
  # Load scenario if file was given
@@ -393,7 +395,7 @@ def create_simulator_from_scenario(
393
395
 
394
396
  return MalSimulator(
395
397
  scenario.attack_graph,
396
- sim_settings=scenario.sim_settings,
398
+ sim_settings=sim_settings or scenario.sim_settings,
397
399
  send_to_api=send_to_api,
398
400
  agents=scenario.agent_settings,
399
401
  )
@@ -526,9 +528,9 @@ def step(
526
528
  attack_surface_settings=sim_state.settings.attack_surface,
527
529
  attacker_settings=attacker_state.settings,
528
530
  name=attacker_state.name,
529
- step_compromised_nodes=frozenset(agent_compromised),
530
- step_attempted_nodes=frozenset(agent_attempted),
531
- step_nodes_made_unviable=step_nodes_made_unviable,
531
+ new_performed_nodes=frozenset(agent_compromised),
532
+ new_attempted_nodes=frozenset(agent_attempted),
533
+ new_unviable_nodes=step_nodes_made_unviable,
532
534
  previous_state=attacker_state,
533
535
  ttc_values=attacker_state.ttc_values,
534
536
  impossible_steps=attacker_state.impossible_steps,
@@ -541,10 +543,10 @@ def step(
541
543
  agent_states[defender_state.name] = create_defender_state(
542
544
  sim_state=sim_state,
543
545
  name=defender_state.name,
544
- step_compromised_nodes=set(step_compromised_nodes),
545
- step_enabled_defenses=set(step_enabled_defenses),
546
- step_nodes_made_unviable=step_nodes_made_unviable,
547
546
  defender_settings=defender_state.settings,
547
+ new_compromised_nodes=set(step_compromised_nodes),
548
+ new_enabled_defenses=set(step_enabled_defenses),
549
+ new_unviable_nodes=step_nodes_made_unviable,
548
550
  previous_state=defender_state,
549
551
  rng=rng,
550
552
  )
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "mal-simulator"
3
- version = "2.4.0"
3
+ version = "2.5.0"
4
4
  authors = [
5
5
  { name="Andrei Buhaiu", email="buhaiu@kth.se" },
6
6
  { name="Joakim Loxdal", email="loxdal@kth.se" },
@@ -1724,3 +1724,18 @@ def test_actions_effects() -> None:
1724
1724
 
1725
1725
  for effect_node in effect_nodes:
1726
1726
  assert effect_node.lg_attack_step in all_effect_children
1727
+
1728
+
1729
+ def test_simulator_sim_settings_from_scenario(
1730
+ corelang_lang_graph: LanguageGraph, model: Model
1731
+ ) -> None:
1732
+ """Test _initialize_agents"""
1733
+
1734
+ scenario = Scenario.load_from_file('tests/testdata/scenarios/simple_scenario.yml')
1735
+ sim = MalSimulator.from_scenario(
1736
+ scenario, sim_settings=MalSimulatorSettings(seed=100)
1737
+ )
1738
+ assert sim.sim_settings.seed == 100
1739
+
1740
+ sim = MalSimulator.from_scenario(scenario)
1741
+ assert sim.sim_settings.seed is None
@@ -1,42 +0,0 @@
1
- from dataclasses import dataclass, field
2
- from collections.abc import Mapping, Set
3
- from typing import Any
4
- from maltoolbox.attackgraph import AttackGraphNode
5
- from malsim.config.agent_settings import AttackerSettings
6
- from malsim.mal_simulator.agent_state import AgentState
7
-
8
-
9
- @dataclass(frozen=True)
10
- class AttackerState(AgentState):
11
- """Stores the state of an attacker in the simulator"""
12
-
13
- settings: AttackerSettings[AttackGraphNode]
14
- # Number of attempts to compromise a step (used for ttc caculations)
15
- num_attempts: Mapping[AttackGraphNode, int]
16
- # Steps attempted but not succeeded (because of TTC value)
17
- step_attempted_nodes: Set[AttackGraphNode]
18
- ttc_values: Mapping[AttackGraphNode, float]
19
- # Only used if `ttc_overrides` is set
20
- impossible_steps: Set[AttackGraphNode] = field(
21
- default_factory=frozenset
22
- ) # Steps that are impossible to perform
23
-
24
- # Picklable
25
- def __getstate__(self) -> dict[str, Any]:
26
- state = self.__dict__.copy()
27
- state['num_attempts'] = dict(state['num_attempts'])
28
- state['performed_nodes_order'] = dict(state['performed_nodes_order'])
29
- return state
30
-
31
- def __setstate__(self, state: dict[str, Any]) -> None:
32
- object.__setattr__(self, 'num_attempts', state['num_attempts'])
33
-
34
- object.__setattr__(
35
- self,
36
- 'performed_nodes_order',
37
- state['performed_nodes_order'],
38
- )
39
- # set other frozen attributes
40
- for key, value in state.items():
41
- if key not in ('num_attempts', 'ttc_overrides', 'ttc_value_overrides'):
42
- object.__setattr__(self, key, value)
@@ -1,38 +0,0 @@
1
- from collections.abc import Set
2
- from dataclasses import dataclass
3
- from typing import Any
4
- from maltoolbox.attackgraph import AttackGraphNode
5
- from malsim.config.agent_settings import DefenderSettings
6
- from malsim.mal_simulator.agent_state import AgentState
7
-
8
-
9
- @dataclass(frozen=True)
10
- class DefenderState(AgentState):
11
- """Stores the state of a defender in the simulator"""
12
-
13
- # Contains all steps performed by any attacker
14
- compromised_nodes: Set[AttackGraphNode]
15
- # Contains steps performed by any attacker in last step
16
- step_compromised_nodes: Set[AttackGraphNode]
17
- # Contains all observed steps by any attacker
18
- # in regards to false positives/negatives and observability
19
- observed_nodes: Set[AttackGraphNode]
20
- # Contains observed steps made by any attacker in last step
21
- step_observed_nodes: Set[AttackGraphNode]
22
- settings: DefenderSettings
23
-
24
- # Pickling
25
- def __getstate__(self) -> dict[str, Any]:
26
- state = self.__dict__.copy()
27
- state['performed_nodes_order'] = dict(state['performed_nodes_order'])
28
- return state
29
-
30
- def __setstate__(self, state: dict[str, Any]) -> None:
31
- object.__setattr__(
32
- self,
33
- 'performed_nodes_order',
34
- state['performed_nodes_order'],
35
- )
36
- for key, value in state.items():
37
- if key not in ('performed_nodes_order'):
38
- object.__setattr__(self, key, value)
@@ -1,107 +0,0 @@
1
- """Creation/manipulation of defender state"""
2
-
3
- from collections.abc import Set
4
-
5
- import numpy as np
6
- from maltoolbox.attackgraph import AttackGraphNode
7
-
8
- from malsim.config.agent_settings import DefenderSettings
9
- from malsim.mal_simulator.defender_state import DefenderState
10
- from malsim.mal_simulator.defense_surface import get_defense_surface
11
- from malsim.mal_simulator.observability import observed_nodes
12
- from malsim.mal_simulator.simulator_state import MalSimulatorState
13
-
14
-
15
- def create_defender_state(
16
- sim_state: MalSimulatorState,
17
- name: str,
18
- rng: np.random.Generator,
19
- defender_settings: DefenderSettings,
20
- step_compromised_nodes: Set[AttackGraphNode] = frozenset(),
21
- step_enabled_defenses: Set[AttackGraphNode] = frozenset(),
22
- step_nodes_made_unviable: Set[AttackGraphNode] = frozenset(),
23
- previous_state: DefenderState | None = None,
24
- ) -> DefenderState:
25
- """
26
- Update a previous defender state based on what steps
27
- were enabled/compromised during last step
28
- """
29
-
30
- if previous_state is None:
31
- # Initialize
32
- action_surface = get_defense_surface(
33
- sim_state, defender_settings.actionable_steps
34
- )
35
- previous_enabled_defenses: Set[AttackGraphNode] = frozenset()
36
- previous_compromised_nodes: Set[AttackGraphNode] = frozenset()
37
- previous_observed_nodes: Set[AttackGraphNode] = frozenset()
38
- action_surface_additions: Set[AttackGraphNode] = action_surface
39
- action_surface_removals: Set[AttackGraphNode] = frozenset()
40
- performed_nodes_order: dict[int, Set[AttackGraphNode]] = {}
41
-
42
- if step_enabled_defenses:
43
- # Pre enabled defenses go into iteration 0
44
- performed_nodes_order[0] = frozenset(step_enabled_defenses)
45
- else:
46
- # Initialize
47
- action_surface = (
48
- get_defense_surface(sim_state, defender_settings.actionable_steps)
49
- - previous_state.performed_nodes
50
- )
51
-
52
- previous_enabled_defenses = previous_state.performed_nodes
53
- previous_compromised_nodes = previous_state.compromised_nodes
54
- previous_observed_nodes = previous_state.observed_nodes
55
- action_surface_additions = frozenset()
56
- action_surface_removals = step_enabled_defenses
57
- performed_nodes_order = dict(previous_state.performed_nodes_order)
58
- if step_enabled_defenses:
59
- performed_nodes_order[previous_state.iteration] = frozenset(
60
- step_enabled_defenses
61
- )
62
-
63
- step_observed_nodes = observed_nodes(
64
- sim_state=sim_state,
65
- observable_steps_rule=defender_settings.observable_steps,
66
- false_positive_rates_rule=defender_settings.false_positive_rates,
67
- rng=rng,
68
- false_negative_rates_rule=defender_settings.false_negative_rates,
69
- compromised_nodes=step_compromised_nodes,
70
- )
71
- return DefenderState(
72
- name,
73
- sim_state=sim_state,
74
- performed_nodes=frozenset(previous_enabled_defenses | step_enabled_defenses),
75
- compromised_nodes=frozenset(
76
- previous_compromised_nodes | step_compromised_nodes
77
- ),
78
- step_compromised_nodes=frozenset(step_compromised_nodes),
79
- observed_nodes=frozenset(previous_observed_nodes | step_observed_nodes),
80
- step_observed_nodes=frozenset(step_observed_nodes),
81
- step_action_surface_additions=frozenset(action_surface_additions),
82
- step_action_surface_removals=frozenset(action_surface_removals),
83
- action_surface=frozenset(action_surface),
84
- step_performed_nodes=frozenset(step_enabled_defenses),
85
- step_unviable_nodes=frozenset(step_nodes_made_unviable),
86
- iteration=(previous_state.iteration + 1) if previous_state else 1,
87
- performed_nodes_order=performed_nodes_order,
88
- settings=defender_settings,
89
- )
90
-
91
-
92
- def initial_defender_state(
93
- sim_state: MalSimulatorState,
94
- defender_settings: DefenderSettings,
95
- pre_compromised_nodes: Set[AttackGraphNode],
96
- pre_enabled_defenses: Set[AttackGraphNode],
97
- rng: np.random.Generator,
98
- ) -> DefenderState:
99
- """Create a defender state from defender settings"""
100
- return create_defender_state(
101
- sim_state=sim_state,
102
- name=defender_settings.name,
103
- step_compromised_nodes=pre_compromised_nodes,
104
- step_enabled_defenses=pre_enabled_defenses,
105
- rng=rng,
106
- defender_settings=defender_settings,
107
- )
File without changes
File without changes
File without changes