Change copyright to 2025

This commit is contained in:
Marek Wolan
2025-01-02 15:05:06 +00:00
parent 6844bd692a
commit bf32271ddd
400 changed files with 400 additions and 4190 deletions

View File

@@ -1,4 +1,4 @@
# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
from typing import Any, Dict, Optional, Tuple from typing import Any, Dict, Optional, Tuple
from gymnasium.core import ObsType from gymnasium.core import ObsType

View File

@@ -1,4 +1,4 @@
# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
import json import json
import shutil import shutil
from datetime import datetime from datetime import datetime

View File

@@ -1,4 +1,4 @@
# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
import json import json
import sys import sys
from datetime import datetime from datetime import datetime

View File

@@ -1,4 +1,4 @@
# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
import platform import platform
from typing import Dict from typing import Dict

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. ..
Credit to https://github.com/JamesALeedham/Sphinx-Autosummary-Recursion for the custom templates. Credit to https://github.com/JamesALeedham/Sphinx-Autosummary-Recursion for the custom templates.

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. ..
Credit to https://github.com/JamesALeedham/Sphinx-Autosummary-Recursion for the custom templates. Credit to https://github.com/JamesALeedham/Sphinx-Autosummary-Recursion for the custom templates.

View File

@@ -2,7 +2,7 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. ..
DO NOT DELETE THIS FILE! It contains the all-important `.. autosummary::` directive with `:recursive:` option, without DO NOT DELETE THIS FILE! It contains the all-important `.. autosummary::` directive with `:recursive:` option, without

View File

@@ -1,4 +1,4 @@
# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
# Configuration file for the Sphinx documentation builder. # Configuration file for the Sphinx documentation builder.
# #
# For the full list of built-in configuration values, see the documentation: # For the full list of built-in configuration values, see the documentation:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
Welcome to PrimAITE's documentation Welcome to PrimAITE's documentation
==================================== ====================================

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
Action Masking Action Masking
************** **************

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
PrimAITE |VERSION| Configuration PrimAITE |VERSION| Configuration
******************************** ********************************

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
``agents`` ``agents``

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
``game`` ``game``

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
``io_settings`` ``io_settings``

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
``simulation`` ``simulation``

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _Node Attributes: .. _Node Attributes:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _common_host_node_attributes: .. _common_host_node_attributes:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _common_network_node_attributes: .. _common_network_node_attributes:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _common_node_attributes: .. _common_node_attributes:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
``type`` ``type``
-------- --------

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _computer_configuration: .. _computer_configuration:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _firewall_configuration: .. _firewall_configuration:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _network_examples: .. _network_examples:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _router_configuration: .. _router_configuration:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _server_configuration: .. _server_configuration:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _switch_configuration: .. _switch_configuration:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
``applications`` ``applications``
---------------- ----------------

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
``services`` ``services``
------------ ------------

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
Customising Agents Customising Agents
****************** ******************

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. role:: raw-html(raw) .. role:: raw-html(raw)
:format: html :format: html

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _Developer Tools: .. _Developer Tools:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
RL Environments RL Environments
*************** ***************

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _example jupyter notebooks: .. _example jupyter notebooks:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
PrimAITE Game layer PrimAITE Game layer
******************* *******************

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _getting-started: .. _getting-started:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
Glossary Glossary
============= =============

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _network_node_adder: .. _network_node_adder:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _Executed Notebooks: .. _Executed Notebooks:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
+-------------------+---------+------------------------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ +-------------------+---------+------------------------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+
| Name | Version | License | Description | URL | | Name | Version | License | Description | URL |

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
Request System Request System
************** **************

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
Rewards Rewards
####### #######

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
Simulation Simulation

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _airspace: .. _airspace:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
############# #############
Base Hardware Base Hardware

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _network: .. _network:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
################################# #################################
Network Interface Hierarchy Model Network Interface Hierarchy Model

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
######## ########
Firewall Firewall

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
######### #########

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
############ ############
Network Node Network Node

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
###### ######
Router Router

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
###### ######
Switch Switch

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
###### ######
Wireless Router Wireless Router

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
Transport Layer to Data Link Layer Transport Layer to Data Link Layer
================================== ==================================

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _C2_Suite: .. _C2_Suite:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _DataManipulationBot: .. _DataManipulationBot:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _DatabaseClient: .. _DatabaseClient:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _DoSBot: .. _DoSBot:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _NMAP: .. _NMAP:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _RansomwareScript: .. _RansomwareScript:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _WebBrowser: .. _WebBrowser:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _Common Configuration: .. _Common Configuration:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _Database Payload List: .. _Database Payload List:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _internal_frame_processing: .. _internal_frame_processing:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
``system applications`` ``system applications``
""""""""""""""""""""""" """""""""""""""""""""""

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
``system services`` ``system services``
""""""""""""""""""" """""""""""""""""""

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
PCAP PCAP
==== ====

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _DatabaseService: .. _DatabaseService:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _DNSClient: .. _DNSClient:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _DNSServer: .. _DNSServer:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _FTPClient: .. _FTPClient:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _FTPServer: .. _FTPServer:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _NTPClient: .. _NTPClient:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _NTPServer: .. _NTPServer:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _Terminal: .. _Terminal:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _WebServer: .. _WebServer:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
Session and Software Manager Session and Software Manager
============================ ============================

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
.. _software: .. _software:

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
SysLog SysLog
====== ======

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
Simulation Structure Simulation Structure

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
Simulation State Simulation State
================ ================

View File

@@ -1,6 +1,6 @@
.. only:: comment .. only:: comment
© Crown-owned copyright 2024, Defence Science and Technology Laboratory UK © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
Defining variations in the config files Defining variations in the config files
======================================= =======================================

View File

@@ -1,4 +1,4 @@
# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
import datetime as datetime import datetime as datetime
import logging import logging
import logging.config import logging.config

View File

@@ -1,4 +1,4 @@
# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
"""Provides a CLI using Typer as an entry point.""" """Provides a CLI using Typer as an entry point."""
import logging import logging
import os import os

View File

@@ -1,2 +1,2 @@
# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
"""Configuration parameters for running experiments.""" """Configuration parameters for running experiments."""

View File

@@ -1,4 +1,4 @@
# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
from pathlib import Path from pathlib import Path
from typing import Dict, Final, Union from typing import Dict, Final, Union

View File

@@ -1,4 +1,4 @@
# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
class PrimaiteError(Exception): class PrimaiteError(Exception):
"""The root PrimAITE Error.""" """The root PrimAITE Error."""

View File

@@ -1,2 +1,2 @@
# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
"""PrimAITE Game Layer.""" """PrimAITE Game Layer."""

View File

@@ -1 +1 @@
# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK

View File

@@ -1,4 +1,4 @@
# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
""" """
This module contains the ActionManager class which belongs to the Agent class. This module contains the ActionManager class which belongs to the Agent class.

View File

@@ -1,4 +1,4 @@
# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
import logging import logging
from pathlib import Path from pathlib import Path

View File

@@ -1,4 +1,4 @@
# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
"""Interface for agents.""" """Interface for agents."""
from abc import ABC, abstractmethod from abc import ABC, abstractmethod
from typing import Any, Dict, List, Optional, Tuple, TYPE_CHECKING from typing import Any, Dict, List, Optional, Tuple, TYPE_CHECKING

View File

@@ -1,4 +1,4 @@
# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
# flake8: noqa # flake8: noqa
# Pre-import all the observations when we load up the observations module so that they can be resolved by the parser. # Pre-import all the observations when we load up the observations module so that they can be resolved by the parser.
from primaite.game.agent.observations.acl_observation import ACLObservation from primaite.game.agent.observations.acl_observation import ACLObservation

View File

@@ -1,4 +1,4 @@
# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
from __future__ import annotations from __future__ import annotations
from ipaddress import IPv4Address from ipaddress import IPv4Address

View File

@@ -1,259 +1 @@
# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
from __future__ import annotations
from typing import Dict, Iterable, List, Optional
from gymnasium import spaces
from gymnasium.core import ObsType
from primaite import getLogger
from primaite.game.agent.observations.observations import AbstractObservation, WhereType
from primaite.game.agent.utils import access_from_nested_dict, NOT_PRESENT_IN_STATE
_LOGGER = getLogger(__name__)
class FileObservation(AbstractObservation, identifier="FILE"):
"""File observation, provides status information about a file within the simulation environment."""
class ConfigSchema(AbstractObservation.ConfigSchema):
"""Configuration schema for FileObservation."""
file_name: str
"""Name of the file, used for querying simulation state dictionary."""
include_num_access: Optional[bool] = None
"""Whether to include the number of accesses to the file in the observation."""
file_system_requires_scan: Optional[bool] = None
"""If True, the file must be scanned to update the health state. Tf False, the true state is always shown."""
def __init__(self, where: WhereType, include_num_access: bool, file_system_requires_scan: bool) -> None:
"""
Initialise a file observation instance.
:param where: Where in the simulation state dictionary to find the relevant information for this file.
A typical location for a file might be
['network', 'nodes', <node_hostname>, 'file_system', 'folder', <folder_name>, 'files', <file_name>].
:type where: WhereType
:param include_num_access: Whether to include the number of accesses to the file in the observation.
:type include_num_access: bool
:param file_system_requires_scan: If True, the file must be scanned to update the health state. Tf False,
the true state is always shown.
:type file_system_requires_scan: bool
"""
self.where: WhereType = where
self.include_num_access: bool = include_num_access
self.file_system_requires_scan: bool = file_system_requires_scan
self.default_observation: ObsType = {"health_status": 0}
if self.include_num_access:
self.default_observation["num_access"] = 0
# TODO: allow these to be configured in yaml
self.high_threshold = 10
self.med_threshold = 5
self.low_threshold = 0
def _categorise_num_access(self, num_access: int) -> int:
"""
Represent number of file accesses as a categorical variable.
:param num_access: Number of file accesses.
:return: Bin number corresponding to the number of accesses.
"""
if num_access > self.high_threshold:
return 3
elif num_access > self.med_threshold:
return 2
elif num_access > self.low_threshold:
return 1
return 0
def observe(self, state: Dict) -> ObsType:
"""
Generate observation based on the current state of the simulation.
:param state: Simulation state dictionary.
:type state: Dict
:return: Observation containing the health status of the file and optionally the number of accesses.
:rtype: ObsType
"""
file_state = access_from_nested_dict(state, self.where)
if file_state is NOT_PRESENT_IN_STATE:
return self.default_observation
if self.file_system_requires_scan:
health_status = file_state["visible_status"]
else:
health_status = file_state["health_status"]
obs = {"health_status": health_status}
if self.include_num_access:
obs["num_access"] = self._categorise_num_access(file_state["num_access"])
return obs
@property
def space(self) -> spaces.Space:
"""
Gymnasium space object describing the observation space shape.
:return: Gymnasium space representing the observation space for file status.
:rtype: spaces.Space
"""
space = {"health_status": spaces.Discrete(6)}
if self.include_num_access:
space["num_access"] = spaces.Discrete(4)
return spaces.Dict(space)
@classmethod
def from_config(cls, config: ConfigSchema, parent_where: WhereType = []) -> FileObservation:
"""
Create a file observation from a configuration schema.
:param config: Configuration schema containing the necessary information for the file observation.
:type config: ConfigSchema
:param parent_where: Where in the simulation state dictionary to find the information about this file's
parent node. A typical location for a node might be ['network', 'nodes', <node_hostname>].
:type parent_where: WhereType, optional
:return: Constructed file observation instance.
:rtype: FileObservation
:param file_system_requires_scan: If True, the folder must be scanned to update the health state. Tf False,
the true state is always shown.
:type file_system_requires_scan: bool
"""
return cls(
where=parent_where + ["files", config.file_name],
include_num_access=config.include_num_access,
file_system_requires_scan=config.file_system_requires_scan,
)
class FolderObservation(AbstractObservation, identifier="FOLDER"):
"""Folder observation, provides status information about a folder within the simulation environment."""
class ConfigSchema(AbstractObservation.ConfigSchema):
"""Configuration schema for FolderObservation."""
folder_name: str
"""Name of the folder, used for querying simulation state dictionary."""
files: List[FileObservation.ConfigSchema] = []
"""List of file configurations within the folder."""
num_files: Optional[int] = None
"""Number of spaces for file observations in this folder."""
include_num_access: Optional[bool] = None
"""Whether files in this folder should include the number of accesses in their observation."""
file_system_requires_scan: Optional[bool] = None
"""If True, the folder must be scanned to update the health state. Tf False, the true state is always shown."""
def __init__(
self,
where: WhereType,
files: Iterable[FileObservation],
num_files: int,
include_num_access: bool,
file_system_requires_scan: bool,
) -> None:
"""
Initialise a folder observation instance.
:param where: Where in the simulation state dictionary to find the relevant information for this folder.
A typical location for a folder might be ['network', 'nodes', <node_hostname>, 'folders', <folder_name>].
:type where: WhereType
:param files: List of file observation instances within the folder.
:type files: Iterable[FileObservation]
:param num_files: Number of files expected in the folder.
:type num_files: int
:param include_num_access: Whether to include the number of accesses to files in the observation.
:type include_num_access: bool
:param file_system_requires_scan: If True, the folder must be scanned to update the health state. Tf False,
the true state is always shown.
:type file_system_requires_scan: bool
"""
self.where: WhereType = where
self.file_system_requires_scan: bool = file_system_requires_scan
self.files: List[FileObservation] = files
while len(self.files) < num_files:
self.files.append(
FileObservation(
where=None,
include_num_access=include_num_access,
file_system_requires_scan=self.file_system_requires_scan,
)
)
while len(self.files) > num_files:
truncated_file = self.files.pop()
msg = f"Too many files in folder observation. Truncating file {truncated_file}"
_LOGGER.warning(msg)
self.default_observation = {
"health_status": 0,
}
if self.files:
self.default_observation["FILES"] = {i + 1: f.default_observation for i, f in enumerate(self.files)}
def observe(self, state: Dict) -> ObsType:
"""
Generate observation based on the current state of the simulation.
:param state: Simulation state dictionary.
:type state: Dict
:return: Observation containing the health status of the folder and status of files within the folder.
:rtype: ObsType
"""
folder_state = access_from_nested_dict(state, self.where)
if folder_state is NOT_PRESENT_IN_STATE:
return self.default_observation
if self.file_system_requires_scan:
health_status = folder_state["visible_status"]
else:
health_status = folder_state["health_status"]
obs = {}
obs["health_status"] = health_status
if self.files:
obs["FILES"] = {i + 1: file.observe(state) for i, file in enumerate(self.files)}
return obs
@property
def space(self) -> spaces.Space:
"""
Gymnasium space object describing the observation space shape.
:return: Gymnasium space representing the observation space for folder status.
:rtype: spaces.Space
"""
shape = {"health_status": spaces.Discrete(6)}
if self.files:
shape["FILES"] = spaces.Dict({i + 1: f.space for i, f in enumerate(self.files)})
return spaces.Dict(shape)
@classmethod
def from_config(cls, config: ConfigSchema, parent_where: WhereType = []) -> FolderObservation:
"""
Create a folder observation from a configuration schema.
:param config: Configuration schema containing the necessary information for the folder observation.
:type config: ConfigSchema
:param parent_where: Where in the simulation state dictionary to find the information about this folder's
parent node. A typical location for a node might be ['network', 'nodes', <node_hostname>].
:type parent_where: WhereType, optional
:return: Constructed folder observation instance.
:rtype: FolderObservation
"""
where = parent_where + ["file_system", "folders", config.folder_name]
# pass down shared/common config items
for file_config in config.files:
file_config.include_num_access = config.include_num_access
file_config.file_system_requires_scan = config.file_system_requires_scan
files = [FileObservation.from_config(config=f, parent_where=where) for f in config.files]
return cls(
where=where,
files=files,
num_files=config.num_files,
include_num_access=config.include_num_access,
file_system_requires_scan=config.file_system_requires_scan,
)

View File

@@ -1,4 +1,4 @@
# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
from __future__ import annotations from __future__ import annotations
from typing import Dict, List, Optional from typing import Dict, List, Optional

View File

@@ -1,4 +1,4 @@
# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
from __future__ import annotations from __future__ import annotations
from typing import Dict, List, Optional from typing import Dict, List, Optional

View File

@@ -1,153 +1 @@
# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
from __future__ import annotations
from typing import Any, Dict, List
from gymnasium import spaces
from gymnasium.core import ObsType
from primaite import getLogger
from primaite.game.agent.observations.observations import AbstractObservation, WhereType
from primaite.game.agent.utils import access_from_nested_dict, NOT_PRESENT_IN_STATE
_LOGGER = getLogger(__name__)
class LinkObservation(AbstractObservation, identifier="LINK"):
"""Link observation, providing information about a specific link within the simulation environment."""
class ConfigSchema(AbstractObservation.ConfigSchema):
"""Configuration schema for LinkObservation."""
link_reference: str
"""Reference identifier for the link."""
def __init__(self, where: WhereType) -> None:
"""
Initialise a link observation instance.
:param where: Where in the simulation state dictionary to find the relevant information for this link.
A typical location for a link might be ['network', 'links', <link_reference>].
:type where: WhereType
"""
self.where = where
self.default_observation: ObsType = {"PROTOCOLS": {"ALL": 0}}
def observe(self, state: Dict) -> Any:
"""
Generate observation based on the current state of the simulation.
:param state: Simulation state dictionary.
:type state: Dict
:return: Observation containing information about the link.
:rtype: Any
"""
link_state = access_from_nested_dict(state, self.where)
if link_state is NOT_PRESENT_IN_STATE:
self.where[-1] = "<->".join(self.where[-1].split("<->")[::-1]) # try swapping endpoint A and B
link_state = access_from_nested_dict(state, self.where)
if link_state is NOT_PRESENT_IN_STATE:
return self.default_observation
bandwidth = link_state["bandwidth"]
load = link_state["current_load"]
if load == 0:
utilisation_category = 0
else:
utilisation_fraction = load / bandwidth
utilisation_category = int(utilisation_fraction * 9) + 1
return {"PROTOCOLS": {"ALL": min(utilisation_category, 10)}}
@property
def space(self) -> spaces.Space:
"""
Gymnasium space object describing the observation space shape.
:return: Gymnasium space representing the observation space for link status.
:rtype: spaces.Space
"""
return spaces.Dict({"PROTOCOLS": spaces.Dict({"ALL": spaces.Discrete(11)})})
@classmethod
def from_config(cls, config: ConfigSchema, parent_where: WhereType = []) -> LinkObservation:
"""
Create a link observation from a configuration schema.
:param config: Configuration schema containing the necessary information for the link observation.
:type config: ConfigSchema
:param parent_where: Where in the simulation state dictionary to find the information about this link.
A typical location might be ['network', 'links', <link_reference>].
:type parent_where: WhereType, optional
:return: Constructed link observation instance.
:rtype: LinkObservation
"""
link_reference = config.link_reference
if parent_where == []:
where = ["network", "links", link_reference]
else:
where = parent_where + ["links", link_reference]
return cls(where=where)
class LinksObservation(AbstractObservation, identifier="LINKS"):
"""Collection of link observations representing multiple links within the simulation environment."""
class ConfigSchema(AbstractObservation.ConfigSchema):
"""Configuration schema for LinksObservation."""
link_references: List[str]
"""List of reference identifiers for the links."""
def __init__(self, where: WhereType, links: List[LinkObservation]) -> None:
"""
Initialise a links observation instance.
:param where: Where in the simulation state dictionary to find the relevant information for these links.
A typical location for links might be ['network', 'links'].
:type where: WhereType
:param links: List of link observations.
:type links: List[LinkObservation]
"""
self.where: WhereType = where
self.links: List[LinkObservation] = links
self.default_observation: ObsType = {i + 1: l.default_observation for i, l in enumerate(self.links)}
def observe(self, state: Dict) -> ObsType:
"""
Generate observation based on the current state of the simulation.
:param state: Simulation state dictionary.
:type state: Dict
:return: Observation containing information about multiple links.
:rtype: ObsType
"""
return {i + 1: l.observe(state) for i, l in enumerate(self.links)}
@property
def space(self) -> spaces.Space:
"""
Gymnasium space object describing the observation space shape.
:return: Gymnasium space representing the observation space for multiple links.
:rtype: spaces.Space
"""
return spaces.Dict({i + 1: l.space for i, l in enumerate(self.links)})
@classmethod
def from_config(cls, config: ConfigSchema, parent_where: WhereType = []) -> LinksObservation:
"""
Create a links observation from a configuration schema.
:param config: Configuration schema containing the necessary information for the links observation.
:type config: ConfigSchema
:param parent_where: Where in the simulation state dictionary to find the information about these links.
A typical location might be ['network'].
:type parent_where: WhereType, optional
:return: Constructed links observation instance.
:rtype: LinksObservation
"""
where = parent_where + ["network"]
link_cfgs = [LinkObservation.ConfigSchema(link_reference=ref) for ref in config.link_references]
links = [LinkObservation.from_config(c, parent_where=where) for c in link_cfgs]
return cls(where=where, links=links)

View File

@@ -1,4 +1,4 @@
# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK # © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
from __future__ import annotations from __future__ import annotations
from typing import Dict, List, Optional from typing import Dict, List, Optional

Some files were not shown because too many files have changed in this diff Show More