#2646 - Added a custom pre-commit hook that ensure the copyright clause is added to .py and .rst files.

src/primaite/__init__.py

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

src/primaite/cli.py

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

src/primaite/config/__init__.py

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

src/primaite/config/load.py

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

src/primaite/exceptions.py

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

src/primaite/game/__init__.py

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

src/primaite/game/agent/__init__.py

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

src/primaite/game/agent/actions.py

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

src/primaite/game/agent/interface.py

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

src/primaite/game/agent/observations/__init__.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 # flake8: noqa
 # 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

src/primaite/game/agent/observations/acl_observation.py

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

src/primaite/game/agent/observations/file_system_observations.py

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

src/primaite/game/agent/observations/firewall_observation.py

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

src/primaite/game/agent/observations/host_observations.py

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

src/primaite/game/agent/observations/link_observation.py

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

src/primaite/game/agent/observations/nic_observations.py

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

src/primaite/game/agent/observations/node_observations.py

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

src/primaite/game/agent/observations/observation_manager.py

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

src/primaite/game/agent/observations/observations.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 """Manages the observation space for the agent."""
 from abc import ABC, abstractmethod
 from typing import Any, Dict, Iterable, Optional, Type, Union

src/primaite/game/agent/observations/router_observation.py

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

src/primaite/game/agent/observations/software_observation.py

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

src/primaite/game/agent/rewards.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 """
 Manages the reward function for the agent.
 

src/primaite/game/agent/scripted_agents/__init__.py

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

src/primaite/game/agent/scripted_agents/data_manipulation_bot.py

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

src/primaite/game/agent/scripted_agents/probabilistic_agent.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 """Agents with predefined behaviours."""
 from typing import Dict, Optional, Tuple
 

src/primaite/game/agent/scripted_agents/random_agent.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import random
 from typing import Dict, Optional, Tuple
 

src/primaite/game/agent/scripted_agents/tap001.py

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

src/primaite/game/agent/utils.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from typing import Any, Dict, Hashable, Optional, Sequence
 
 NOT_PRESENT_IN_STATE = object()

src/primaite/game/game.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 """PrimAITE game - Encapsulates the simulation and agents."""
 from ipaddress import IPv4Address
 from typing import Dict, List, Optional

src/primaite/game/science.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from random import random
 from typing import Any, Iterable, Mapping
 

src/primaite/interface/__init__.py

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

src/primaite/interface/request.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from typing import Dict, ForwardRef, List, Literal, Union
 
 from pydantic import BaseModel, ConfigDict, StrictBool, validate_call

src/primaite/session/__init__.py

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

src/primaite/session/environment.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import json
 from os import PathLike
 from typing import Any, Dict, Optional, SupportsFloat, Tuple, Union

src/primaite/session/episode_schedule.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import copy
 from abc import ABC, abstractmethod
 from itertools import chain

src/primaite/session/io.py

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

src/primaite/session/ray_envs.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import json
 from typing import Dict, SupportsFloat, Tuple
 

src/primaite/setup/__init__.py

@@ -1,2 +1,2 @@
-# © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 """Utilities to prepare the user's data folders."""

src/primaite/setup/reset_demo_notebooks.py

@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import filecmp
 import shutil
 from logging import Logger

src/primaite/setup/reset_example_configs.py

@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import filecmp
 import os
 import shutil

src/primaite/simulator/__init__.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 """Warning: SIM_OUTPUT is a mutable global variable for the simulation output directory."""
 from datetime import datetime
 from enum import IntEnum

src/primaite/simulator/core.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 # flake8: noqa
 """Core of the PrimAITE Simulator."""
 import warnings

src/primaite/simulator/domain/__init__.py

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

src/primaite/simulator/domain/account.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 """User account simulation."""
 from enum import Enum
 from typing import Dict

src/primaite/simulator/domain/controller.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from enum import Enum
 from typing import Dict, Final, List, Literal, Tuple
 

src/primaite/simulator/file_system/__init__.py

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

src/primaite/simulator/file_system/file.py

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

src/primaite/simulator/file_system/file_system.py

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

src/primaite/simulator/file_system/file_system_item_abc.py

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

src/primaite/simulator/file_system/file_type.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from __future__ import annotations
 
 from enum import Enum

src/primaite/simulator/file_system/folder.py

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

src/primaite/simulator/network/__init__.py

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

src/primaite/simulator/network/airspace.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from __future__ import annotations
 
 from abc import ABC, abstractmethod

src/primaite/simulator/network/container.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from ipaddress import IPv4Address
 from typing import Any, Dict, List, Optional
 

src/primaite/simulator/network/creation.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from ipaddress import IPv4Address
 from typing import Optional
 

src/primaite/simulator/network/hardware/__init__.py

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

src/primaite/simulator/network/hardware/base.py

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

src/primaite/simulator/network/hardware/network_interface/__init__.py

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

src/primaite/simulator/network/hardware/network_interface/wireless/__init__.py

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

src/primaite/simulator/network/hardware/network_interface/wireless/wireless_access_point.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from typing import Dict
 
 from primaite.simulator.network.hardware.base import (

src/primaite/simulator/network/hardware/network_interface/wireless/wireless_nic.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from typing import Dict
 
 from primaite.simulator.network.hardware.base import (

src/primaite/simulator/network/hardware/node_operating_state.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from enum import Enum
 
 

src/primaite/simulator/network/hardware/nodes/__init__.py

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

src/primaite/simulator/network/hardware/nodes/host/__init__.py

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

src/primaite/simulator/network/hardware/nodes/host/computer.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from typing import ClassVar, Dict
 
 from primaite.simulator.network.hardware.nodes.host.host_node import HostNode

src/primaite/simulator/network/hardware/nodes/host/host_node.py

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

src/primaite/simulator/network/hardware/nodes/host/server.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from primaite.simulator.network.hardware.nodes.host.host_node import HostNode
 
 

src/primaite/simulator/network/hardware/nodes/network/__init__.py

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

src/primaite/simulator/network/hardware/nodes/network/firewall.py

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

src/primaite/simulator/network/hardware/nodes/network/network_node.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from abc import abstractmethod
 from typing import Optional
 

src/primaite/simulator/network/hardware/nodes/network/router.py

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

src/primaite/simulator/network/hardware/nodes/network/switch.py

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

src/primaite/simulator/network/hardware/nodes/network/wireless_router.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from ipaddress import IPv4Address
 from typing import Any, Dict, Union
 

src/primaite/simulator/network/networks.py

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

src/primaite/simulator/network/nmne.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from typing import Dict, Final, List
 
 CAPTURE_NMNE: bool = True

src/primaite/simulator/network/protocols/__init__.py

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

src/primaite/simulator/network/protocols/arp.py

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

src/primaite/simulator/network/protocols/dns.py

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

src/primaite/simulator/network/protocols/ftp.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from enum import Enum
 from typing import Any, Optional, Union
 

src/primaite/simulator/network/protocols/http.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from enum import Enum, IntEnum
 
 from primaite.simulator.network.protocols.packet import DataPacket

src/primaite/simulator/network/protocols/icmp.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import secrets
 from enum import Enum
 from typing import Union

src/primaite/simulator/network/protocols/ntp.py

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

src/primaite/simulator/network/protocols/packet.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from typing import Any
 
 from pydantic import BaseModel

src/primaite/simulator/network/transmission/__init__.py

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

src/primaite/simulator/network/transmission/data_link_layer.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from datetime import datetime
 from typing import Any, Optional
 

src/primaite/simulator/network/transmission/network_layer.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from enum import Enum
 
 from pydantic import BaseModel

src/primaite/simulator/network/transmission/primaite_layer.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from enum import Enum
 
 from pydantic import BaseModel

src/primaite/simulator/network/transmission/transport_layer.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from enum import Enum
 from typing import List, Union
 

src/primaite/simulator/network/utils.py

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

src/primaite/simulator/sim_container.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from typing import Dict
 
 from primaite.interface.request import RequestResponse

src/primaite/simulator/system/__init__.py

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

src/primaite/simulator/system/applications/__init__.py

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

src/primaite/simulator/system/applications/application.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from abc import abstractmethod
 from enum import Enum
 from typing import Any, Dict, Optional, Set

src/primaite/simulator/system/applications/database_client.py

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

src/primaite/simulator/system/applications/red_applications/__init__.py

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

src/primaite/simulator/system/applications/red_applications/data_manipulation_bot.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from enum import IntEnum
 from ipaddress import IPv4Address
 from typing import Dict, Optional

src/primaite/simulator/system/applications/red_applications/dos_bot.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from enum import IntEnum
 from ipaddress import IPv4Address
 from typing import Optional

src/primaite/simulator/system/applications/red_applications/ransomware_script.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from enum import IntEnum
 from ipaddress import IPv4Address
 from typing import Dict, Optional

src/primaite/simulator/system/applications/web_browser.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from enum import Enum
 from ipaddress import IPv4Address
 from typing import Dict, List, Optional

src/primaite/simulator/system/core/__init__.py

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