Merged PR 418: Update Pre-Commit to check for valid copyright

## Summary
Updates Pre-commit with the a check to ensure valid copyright headers

## Test process
*How have you tested this (if applicable)?*

## Checklist
- [X] PR is linked to a **work item**
- [ ] **acceptance criteria** of linked ticket are met
- [ ] performed **self-review** of the code
- [ ] written **tests** for any new functionality added with this PR
- [ ] updated the **documentation** if this PR changes or adds functionality
- [ ] written/updated **design docs** if this PR implements new functionality
- [ ] updated the **change log**
- [ ] ran **pre-commit** checks for code style
- [ ] attended to any **TO-DOs** left in the code

Related work items: #2646

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/nmap.py

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

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 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

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

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

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

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

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

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

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

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

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

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

src/primaite/simulator/system/processes/process.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 Dict

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

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

src/primaite/simulator/system/services/arp/__init__.py

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

src/primaite/simulator/system/services/arp/arp.py

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

src/primaite/simulator/system/services/database/__init__.py

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

src/primaite/simulator/system/services/database/database_service.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, Literal, Optional, Union
 from uuid import uuid4

src/primaite/simulator/system/services/dns/__init__.py

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

src/primaite/simulator/system/services/dns/dns_client.py

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

src/primaite/simulator/system/services/dns/dns_server.py

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

src/primaite/simulator/system/services/ftp/__init__.py

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

src/primaite/simulator/system/services/ftp/ftp_client.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/system/services/ftp/ftp_server.py

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

src/primaite/simulator/system/services/ftp/ftp_service.py

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

src/primaite/simulator/system/services/icmp/__init__.py

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

src/primaite/simulator/system/services/icmp/icmp.py

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

src/primaite/simulator/system/services/icmp/router_icmp.py

@@ -1,3 +1,4 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 # class RouterICMP(ICMP):
 #     """
 #     A class to represent a router's Internet Control Message Protocol (ICMP) handler.

src/primaite/simulator/system/services/ntp/__init__.py

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

src/primaite/simulator/system/services/ntp/ntp_client.py

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

src/primaite/simulator/system/services/ntp/ntp_server.py

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

src/primaite/simulator/system/services/service.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

src/primaite/simulator/system/services/web_server/__init__.py

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

src/primaite/simulator/system/services/web_server/web_server.py

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

src/primaite/simulator/system/software.py

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