Merged PR 185: FTP - client/server

## Summary
Initial implementation of an FTP Client/Server service used to emulate a transfer of files across nodes

## Test process
Added an integration and unit test

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

Related work items: #1752, #1816, #1916

CHANGELOG.md

@@ -29,7 +29,8 @@ SessionManager.
   1. Creating a simulation - this notebook explains how to build up a simulation using the Python package. (WIP)
 - Red Agent Services:
   - Data Manipulator Bot - A red agent service which sends a payload to a target machine. (By default this payload is a SQL query that breaks a database)
-- DNS Services: DNS Client and DNS Server
+- DNS Services: `DNSClient` and `DNSServer`
+- FTP Services: `FTPClient` and `FTPServer`
 
 ## [2.0.0] - 2023-07-26
 

docs/source/simulation_components/system/ftp_client_server.rst

@@ -0,0 +1,126 @@
+.. only:: comment
+
+    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+
+FTP Client Server
+=================
+
+FTP Server
+----------
+Provides a FTP Client-Server simulation by extending the base Service class.
+
+Key capabilities
+^^^^^^^^^^^^^^^^
+
+- Simulates FTP requests and FTPPacket transfer across a network
+- Allows the emulation of FTP commands between an FTP client and server:
+    - STOR: stores a file from client to server
+    - RETR: retrieves a file from the FTP server
+- Leverages the Service base class for install/uninstall, status tracking, etc.
+
+Usage
+^^^^^
+- Install on a Node via the ``SoftwareManager`` to start the FTP server service.
+- Service runs on FTP (command) port 21 by default. (TODO: look at in depth implementation of FTP PORT command)
+
+Implementation
+^^^^^^^^^^^^^^
+
+- FTP request and responses use a ``FTPPacket`` object
+- Extends Service class for integration with ``SoftwareManager``.
+
+FTP Client
+----------
+
+The ``FTPClient`` provides a client interface for connecting to the ``FTPServer``.
+
+Key features
+^^^^^^^^^^^^
+
+- Connects to the ``FTPServer`` via the ``SoftwareManager``.
+- Simulates FTP requests and FTPPacket transfer across a network
+- Allows the emulation of FTP commands between an FTP client and server:
+    - PORT: specifies the port that server should connect to on the client (currently only uses ``Port.FTP``)
+    - STOR: stores a file from client to server
+    - RETR: retrieves a file from the FTP server
+    - QUIT: disconnect from server
+- Leverages the Service base class for install/uninstall, status tracking, etc.
+
+Usage
+^^^^^
+
+- Install on a Node via the ``SoftwareManager`` to start the FTP client service.
+- Service runs on FTP (command) port 21 by default. (TODO: look at in depth implementation of FTP PORT command)
+- Execute sending a file to the FTP server with ``send_file``
+- Execute retrieving a file from the FTP server with ``request_file``
+
+Implementation
+^^^^^^^^^^^^^^
+
+- Leverages ``SoftwareManager`` for sending payloads over the network.
+- Provides easy interface for Nodes to transfer files between each other.
+- Extends base Service class.
+
+
+Example Usage
+----------
+
+Dependencies
+^^^^^^^^^^^^
+
+.. code-block:: python
+
+    from ipaddress import IPv4Address
+
+    from primaite.simulator.network.container import Network
+    from primaite.simulator.network.hardware.nodes.computer import Computer
+    from primaite.simulator.network.hardware.nodes.server import Server
+    from primaite.simulator.system.services.ftp.ftp_server import FTPServer
+    from primaite.simulator.system.services.ftp.ftp_client import FTPClient
+
+Example peer to peer network
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    net = Network()
+
+    pc1 = Computer(hostname="pc1", ip_address="120.10.10.10", subnet_mask="255.255.255.0")
+    srv = Server(hostname="srv", ip_address="120.10.10.20", subnet_mask="255.255.255.0")
+    pc1.power_on()
+    srv.power_on()
+    net.connect(pc1.ethernet_port[1], srv.ethernet_port[1])
+
+Install the FTP Server
+^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    srv.software_manager.install(FTPServer)
+    pc1.software_manager.install(FTPClient)
+    client: FTPClient = pc1.software_manager.software['FTPClient']
+    ftpserv: FTPServer = srv.software_manager.software['FTPServer']
+
+Setting up the FTP Server
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Set up the FTP Server with a file that the client will need to retrieve
+
+.. code-block:: python
+
+    srv.file_system.create_file('my_file.png')
+
+Check that file was retrieved
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    client.request_file(
+        src_folder_name='root',
+        src_file_name='my_file.png',
+        dest_folder_name='root',
+        dest_file_name='test.png',
+        dest_ip_address=IPv4Address("120.10.10.20")
+    )
+
+    print(client.get_file(folder_name="root", file_name="test.png"))

docs/source/simulation_components/system/software.rst

@@ -18,3 +18,4 @@ Contents
    database_client_server
    data_manipulation_bot
    dns_client_server
+   ftp_client_server

src/primaite/simulator/file_system/file_system.py

@@ -226,7 +226,7 @@ class FileSystem(SimComponent):
         folder = self.get_folder(folder_name)
         if folder:
             return folder.get_file(file_name)
-        self.fs.sys_log.info(f"file not found /{folder_name}/{file_name}")
+        self.sys_log.info(f"file not found /{folder_name}/{file_name}")
 
     def delete_file(self, folder_name: str, file_name: str):
         """

src/primaite/simulator/network/networks.py

@@ -9,9 +9,11 @@ from primaite.simulator.network.hardware.nodes.switch import Switch
 from primaite.simulator.network.transmission.network_layer import IPProtocol
 from primaite.simulator.network.transmission.transport_layer import Port
 from primaite.simulator.system.applications.database_client import DatabaseClient
-from primaite.simulator.system.services.database_service import DatabaseService
+from primaite.simulator.system.services.database.database_service import DatabaseService
-from primaite.simulator.system.services.dns_client import DNSClient
+from primaite.simulator.system.services.dns.dns_client import DNSClient
-from primaite.simulator.system.services.dns_server import DNSServer
+from primaite.simulator.system.services.dns.dns_server import DNSServer
+from primaite.simulator.system.services.ftp.ftp_client import FTPClient
+from primaite.simulator.system.services.ftp.ftp_server import FTPServer
 from primaite.simulator.system.services.red_services.data_manipulation_bot import DataManipulationBot
 
 
@@ -136,13 +138,13 @@ def arcd_uc2_network() -> Network:
     )
     client_1.power_on()
     client_1.software_manager.install(DNSClient)
-    client_1_dns_client_service: DNSServer = client_1.software_manager.software["DNSClient"]  # noqa
-    client_1_dns_client_service.start()
     network.connect(endpoint_b=client_1.ethernet_port[1], endpoint_a=switch_2.switch_ports[1])
     client_1.software_manager.install(DataManipulationBot)
     db_manipulation_bot: DataManipulationBot = client_1.software_manager.software["DataManipulationBot"]
     db_manipulation_bot.configure(server_ip_address=IPv4Address("192.168.1.14"), payload="DROP TABLE IF EXISTS user;")
 
+    client_1.software_manager.install(FTPClient)
+
     # Client 2
     client_2 = Computer(
         hostname="client_2",
@@ -153,10 +155,10 @@ def arcd_uc2_network() -> Network:
     )
     client_2.power_on()
     client_2.software_manager.install(DNSClient)
-    client_2_dns_client_service: DNSServer = client_2.software_manager.software["DNSClient"]  # noqa
-    client_2_dns_client_service.start()
     network.connect(endpoint_b=client_2.ethernet_port[1], endpoint_a=switch_2.switch_ports[2])
 
+    client_2.software_manager.install(FTPClient)
+
     # Domain Controller
     domain_controller = Server(
         hostname="domain_controller",
@@ -191,20 +193,48 @@ def arcd_uc2_network() -> Network:
     );"""
 
     user_insert_statements = [
-        "INSERT INTO user (name, email, age, city, occupation) VALUES ('John Doe', 'johndoe@example.com', 32, 'New York', 'Engineer');",  # noqa
+        "INSERT INTO user (name, email, age, city, occupation) "
-        "INSERT INTO user (name, email, age, city, occupation) VALUES ('Jane Smith', 'janesmith@example.com', 27, 'Los Angeles', 'Designer');",  # noqa
+        "VALUES ('John Doe', 'johndoe@example.com', 32, 'New York', 'Engineer');",
-        "INSERT INTO user (name, email, age, city, occupation) VALUES ('Bob Johnson', 'bobjohnson@example.com', 45, 'Chicago', 'Manager');",  # noqa
+        # noqa
-        "INSERT INTO user (name, email, age, city, occupation) VALUES ('Alice Lee', 'alicelee@example.com', 22, 'San Francisco', 'Student');",  # noqa
+        "INSERT INTO user (name, email, age, city, occupation) "
-        "INSERT INTO user (name, email, age, city, occupation) VALUES ('David Kim', 'davidkim@example.com', 38, 'Houston', 'Consultant');",  # noqa
+        "VALUES ('Jane Smith', 'janesmith@example.com', 27, 'Los Angeles', 'Designer');",
-        "INSERT INTO user (name, email, age, city, occupation) VALUES ('Emily Chen', 'emilychen@example.com', 29, 'Seattle', 'Software Developer');",  # noqa
+        # noqa
-        "INSERT INTO user (name, email, age, city, occupation) VALUES ('Frank Wang', 'frankwang@example.com', 55, 'New York', 'Entrepreneur');",  # noqa
+        "INSERT INTO user (name, email, age, city, occupation) "
-        "INSERT INTO user (name, email, age, city, occupation) VALUES ('Grace Park', 'gracepark@example.com', 31, 'Los Angeles', 'Marketing Specialist');",  # noqa
+        "VALUES ('Bob Johnson', 'bobjohnson@example.com', 45, 'Chicago', 'Manager');",
-        "INSERT INTO user (name, email, age, city, occupation) VALUES ('Henry Wu', 'henrywu@example.com', 40, 'Chicago', 'Accountant');",  # noqa
+        # noqa
-        "INSERT INTO user (name, email, age, city, occupation) VALUES ('Isabella Kim', 'isabellakim@example.com', 26, 'San Francisco', 'Graphic Designer');",  # noqa
+        "INSERT INTO user (name, email, age, city, occupation) "
-        "INSERT INTO user (name, email, age, city, occupation) VALUES ('Jake Lee', 'jakelee@example.com', 33, 'Houston', 'Sales Manager');",  # noqa
+        "VALUES ('Alice Lee', 'alicelee@example.com', 22, 'San Francisco', 'Student');",
-        "INSERT INTO user (name, email, age, city, occupation) VALUES ('Kelly Chen', 'kellychen@example.com', 28, 'Seattle', 'Web Developer');",  # noqa
+        # noqa
-        "INSERT INTO user (name, email, age, city, occupation) VALUES ('Lucas Liu', 'lucasliu@example.com', 42, 'New York', 'Lawyer');",  # noqa
+        "INSERT INTO user (name, email, age, city, occupation) "
-        "INSERT INTO user (name, email, age, city, occupation) VALUES ('Maggie Wang', 'maggiewang@example.com', 30, 'Los Angeles', 'Data Analyst');",  # noqa
+        "VALUES ('David Kim', 'davidkim@example.com', 38, 'Houston', 'Consultant');",
+        # noqa
+        "INSERT INTO user (name, email, age, city, occupation) "
+        "VALUES ('Emily Chen', 'emilychen@example.com', 29, 'Seattle', 'Software Developer');",
+        # noqa
+        "INSERT INTO user (name, email, age, city, occupation) "
+        "VALUES ('Frank Wang', 'frankwang@example.com', 55, 'New York', 'Entrepreneur');",
+        # noqa
+        "INSERT INTO user (name, email, age, city, occupation) "
+        "VALUES ('Grace Park', 'gracepark@example.com', 31, 'Los Angeles', 'Marketing Specialist');",
+        # noqa
+        "INSERT INTO user (name, email, age, city, occupation) "
+        "VALUES ('Henry Wu', 'henrywu@example.com', 40, 'Chicago', 'Accountant');",
+        # noqa
+        "INSERT INTO user (name, email, age, city, occupation) "
+        "VALUES ('Isabella Kim', 'isabellakim@example.com', 26, 'San Francisco', 'Graphic Designer');",
+        # noqa
+        "INSERT INTO user (name, email, age, city, occupation) "
+        "VALUES ('Jake Lee', 'jakelee@example.com', 33, 'Houston', 'Sales Manager');",
+        # noqa
+        "INSERT INTO user (name, email, age, city, occupation) "
+        "VALUES ('Kelly Chen', 'kellychen@example.com', 28, 'Seattle', 'Web Developer');",
+        # noqa
+        "INSERT INTO user (name, email, age, city, occupation) "
+        "VALUES ('Lucas Liu', 'lucasliu@example.com', 42, 'New York', 'Lawyer');",
+        # noqa
+        "INSERT INTO user (name, email, age, city, occupation) "
+        "VALUES ('Maggie Wang', 'maggiewang@example.com', 30, 'Los Angeles', 'Data Analyst');",
+        # noqa
     ]
     database_server.software_manager.install(DatabaseService)
     database_service: DatabaseService = database_server.software_manager.software["DatabaseService"]  # noqa
@@ -232,7 +262,6 @@ def arcd_uc2_network() -> Network:
 
     # register the web_server to a domain
     dns_server_service: DNSServer = domain_controller.software_manager.software["DNSServer"]  # noqa
-    dns_server_service.start()
     dns_server_service.dns_register("arcd.com", web_server.ip_address)
 
     # Backup Server
@@ -246,6 +275,8 @@ def arcd_uc2_network() -> Network:
     backup_server.power_on()
     network.connect(endpoint_b=backup_server.ethernet_port[1], endpoint_a=switch_1.switch_ports[4])
 
+    backup_server.software_manager.install(FTPServer)
+
     # Security Suite
     security_suite = Server(
         hostname="security_suite",
@@ -271,4 +302,7 @@ def arcd_uc2_network() -> Network:
     # Allow DNS requests
     router_1.acl.add_rule(action=ACLAction.PERMIT, src_port=Port.DNS, dst_port=Port.DNS, position=1)
 
+    # Allow FTP requests
+    router_1.acl.add_rule(action=ACLAction.PERMIT, src_port=Port.FTP, dst_port=Port.FTP, position=2)
+
     return network

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

@@ -5,6 +5,8 @@ from typing import Optional
 
 from pydantic import BaseModel
 
+from primaite.simulator.network.protocols.packet import DataPacket
+
 
 class ARPEntry(BaseModel):
     """
@@ -18,7 +20,7 @@ class ARPEntry(BaseModel):
     nic_uuid: str
 
 
-class ARPPacket(BaseModel):
+class ARPPacket(DataPacket):
     """
     Represents the ARP layer of a network frame.
 

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

@@ -5,6 +5,8 @@ from typing import Optional
 
 from pydantic import BaseModel
 
+from primaite.simulator.network.protocols.packet import DataPacket
+
 
 class DNSRequest(BaseModel):
     """Represents a DNS Request packet of a network frame.
@@ -26,7 +28,7 @@ class DNSReply(BaseModel):
     "IP Address of the Domain Name requested."
 
 
-class DNSPacket(BaseModel):
+class DNSPacket(DataPacket):
     """
     Represents the DNS layer of a network frame.
 

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

@@ -0,0 +1,55 @@
+from enum import Enum
+from typing import Any, Optional
+
+from primaite.simulator.network.protocols.packet import DataPacket
+
+
+class FTPCommand(Enum):
+    """FTP Commands that are allowed."""
+
+    PORT = "PORT"
+    """Set a port to be used for the FTP transfer."""
+
+    STOR = "STOR"
+    """Copy or put data to the FTP server."""
+
+    RETR = "RETR"
+    """Retrieve data from the FTP server."""
+
+    DELE = "DELE"
+    """Delete the file in the specified path."""
+
+    RMD = "RMD"
+    """Remove the directory in the specified path."""
+
+    MKD = "MKD"
+    """Make a directory in the specified path."""
+
+    LIST = "LIST"
+    """Return a list of files in the specified path."""
+
+    QUIT = "QUIT"
+    """Ends connection between client and server."""
+
+
+class FTPStatusCode(Enum):
+    """Status code of the current FTP request."""
+
+    OK = 200
+    """Command successful."""
+
+    ERROR = 500
+    """General error code."""
+
+
+class FTPPacket(DataPacket):
+    """Represents an FTP Packet."""
+
+    ftp_command: FTPCommand
+    """Command type of the packet."""
+
+    ftp_command_args: Optional[Any] = None
+    """Arguments for command."""
+
+    status_code: FTPStatusCode = None
+    """Status of the response."""

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

@@ -0,0 +1,12 @@
+from pydantic import BaseModel
+
+
+class DataPacket(BaseModel):
+    """Data packet abstract class."""
+
+    packet_payload_size: float = 0
+    """Size of the packet."""
+
+    def get_packet_size(self) -> float:
+        """Returns the size of the packet header and payload."""
+        return self.packet_payload_size + float(len(self.model_dump_json().encode("utf-8")))

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

@@ -5,6 +5,7 @@ from pydantic import BaseModel
 
 from primaite import getLogger
 from primaite.simulator.network.protocols.arp import ARPPacket
+from primaite.simulator.network.protocols.packet import DataPacket
 from primaite.simulator.network.transmission.network_layer import ICMPPacket, IPPacket, IPProtocol
 from primaite.simulator.network.transmission.primaite_layer import PrimaiteHeader
 from primaite.simulator.network.transmission.transport_layer import TCPHeader, UDPHeader
@@ -132,6 +133,10 @@ class Frame(BaseModel):
     @property
     def size(self) -> float:  # noqa - Keep it as MBits as this is how they're expressed
         """The size of the Frame in Bytes."""
+        # get the payload size if it is a data packet
+        if isinstance(self.payload, DataPacket):
+            return self.payload.get_packet_size()
+
         return float(len(self.model_dump_json().encode("utf-8")))
 
     @property

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

@@ -27,6 +27,7 @@ class DNSClient(Service):
         # TCP for now
         kwargs["protocol"] = IPProtocol.TCP
         super().__init__(**kwargs)
+        self.start()
 
     def describe_state(self) -> Dict:
         """

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

@@ -26,6 +26,7 @@ class DNSServer(Service):
         # TCP for now
         kwargs["protocol"] = IPProtocol.TCP
         super().__init__(**kwargs)
+        self.start()
 
     def describe_state(self) -> Dict:
         """

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

@@ -0,0 +1,256 @@
+from ipaddress import IPv4Address
+from typing import Optional
+
+from primaite.simulator.file_system.file_system import File
+from primaite.simulator.network.protocols.ftp import FTPCommand, FTPPacket, FTPStatusCode
+from primaite.simulator.network.transmission.network_layer import IPProtocol
+from primaite.simulator.network.transmission.transport_layer import Port
+from primaite.simulator.system.core.software_manager import SoftwareManager
+from primaite.simulator.system.services.ftp.ftp_service import FTPServiceABC
+from primaite.simulator.system.services.service import ServiceOperatingState
+
+
+class FTPClient(FTPServiceABC):
+    """
+    A class for simulating an FTP client service.
+
+    This class inherits from the `Service` class and provides methods to emulate FTP
+    RFC 959: https://datatracker.ietf.org/doc/html/rfc959
+    """
+
+    connected: bool = False
+    """Keeps track of whether or not the FTP client is connected to an FTP server."""
+
+    def __init__(self, **kwargs):
+        kwargs["name"] = "FTPClient"
+        kwargs["port"] = Port.FTP
+        kwargs["protocol"] = IPProtocol.TCP
+        super().__init__(**kwargs)
+        self.start()
+
+    def _process_ftp_command(self, payload: FTPPacket, session_id: Optional[str] = None, **kwargs) -> FTPPacket:
+        """
+        Process the command in the FTP Packet.
+
+        :param: payload: The FTP Packet to process
+        :type: payload: FTPPacket
+        :param: session_id: session ID linked to the FTP Packet. Optional.
+        :type: session_id: Optional[str]
+        """
+        # if client service is down, return error
+        if self.operating_state != ServiceOperatingState.RUNNING:
+            payload.status_code = FTPStatusCode.ERROR
+            return payload
+
+        # process client specific commands, otherwise call super
+        return super()._process_ftp_command(payload=payload, session_id=session_id, **kwargs)
+
+    def _connect_to_server(
+        self,
+        dest_ip_address: Optional[IPv4Address] = None,
+        dest_port: Optional[Port] = Port.FTP,
+        is_reattempt: Optional[bool] = False,
+    ) -> bool:
+        """
+        Connects the client to a given FTP server.
+
+        :param: dest_ip_address: IP address of the FTP server the client needs to connect to. Optional.
+        :type: dest_ip_address: Optional[IPv4Address]
+        :param: dest_port: Port of the FTP server the client needs to connect to. Optional.
+        :type: dest_port: Optional[Port]
+        :param: is_reattempt: Set to True if attempt to connect to FTP Server has been attempted. Default False.
+        :type: is_reattempt: Optional[bool]
+        """
+        # make sure the service is running before attempting
+        if self.operating_state != ServiceOperatingState.RUNNING:
+            self.sys_log.error(f"FTPClient not running for {self.sys_log.hostname}")
+            return False
+
+        # normally FTP will choose a random port for the transfer, but using the FTP command port will do for now
+        # create FTP packet
+        payload: FTPPacket = FTPPacket(
+            ftp_command=FTPCommand.PORT,
+            ftp_command_args=Port.FTP,
+        )
+        software_manager: SoftwareManager = self.software_manager
+        software_manager.send_payload_to_session_manager(
+            payload=payload, dest_ip_address=dest_ip_address, dest_port=dest_port
+        )
+
+        if payload.status_code == FTPStatusCode.OK:
+            return True
+        else:
+            if is_reattempt:
+                # reattempt failed
+                return False
+            else:
+                # try again
+                self._connect_to_server(dest_ip_address=dest_ip_address, dest_port=dest_port, is_reattempt=True)
+
+    def _disconnect_from_server(
+        self, dest_ip_address: Optional[IPv4Address] = None, dest_port: Optional[Port] = Port.FTP
+    ) -> bool:
+        """
+        Connects the client from a given FTP server.
+
+        :param: dest_ip_address: IP address of the FTP server the client needs to disconnect from. Optional.
+        :type: dest_ip_address: Optional[IPv4Address]
+        :param: dest_port: Port of the FTP server the client needs to disconnect from. Optional.
+        :type: dest_port: Optional[Port]
+        :param: is_reattempt: Set to True if attempt to disconnect from FTP Server has been attempted. Default False.
+        :type: is_reattempt: Optional[bool]
+        """
+        # send a disconnect request payload to FTP server
+        payload: FTPPacket = FTPPacket(ftp_command=FTPCommand.QUIT)
+        software_manager: SoftwareManager = self.software_manager
+        software_manager.send_payload_to_session_manager(
+            payload=payload, dest_ip_address=dest_ip_address, dest_port=dest_port
+        )
+        if payload.status_code == FTPStatusCode.OK:
+            self.connected = False
+            return True
+        return False
+
+    def send_file(
+        self,
+        dest_ip_address: IPv4Address,
+        src_folder_name: str,
+        src_file_name: str,
+        dest_folder_name: str,
+        dest_file_name: str,
+        dest_port: Optional[Port] = Port.FTP,
+    ) -> bool:
+        """
+        Send a file to a target IP address.
+
+        The function checks if the file exists in the FTP Client host.
+        The STOR command is then sent to the FTP Server.
+
+        :param: dest_ip_address: The IP address of the machine that hosts the FTP Server.
+        :type: dest_ip_address: IPv4Address
+
+        :param: src_folder_name: The name of the folder that contains the file to send to the FTP Server.
+        :type: src_folder_name: str
+
+        :param: src_file_name: The name of the file to send to the FTP Server.
+        :type: src_file_name: str
+
+        :param: dest_folder_name: The name of the folder where the file will be stored in the FTP Server.
+        :type: dest_folder_name: str
+
+        :param: dest_file_name: The name of the file to be saved on the FTP Server.
+        :type: dest_file_name: str
+
+        :param: dest_port: The open port of the machine that hosts the FTP Server. Default is Port.FTP.
+        :type: dest_port: Optional[Port]
+        """
+        # check if the file to transfer exists on the client
+        file_to_transfer: File = self.file_system.get_file(folder_name=src_folder_name, file_name=src_file_name)
+        if not file_to_transfer:
+            self.sys_log.error(f"Unable to send file that does not exist: {src_folder_name}/{src_file_name}")
+            return False
+
+        # check if FTP is currently connected to IP
+        self.connected = self._connect_to_server(
+            dest_ip_address=dest_ip_address,
+            dest_port=dest_port,
+        )
+
+        if not self.connected:
+            return False
+        else:
+            # send STOR request
+            self._send_data(
+                file=file_to_transfer,
+                dest_folder_name=dest_folder_name,
+                dest_file_name=dest_file_name,
+                dest_ip_address=dest_ip_address,
+                dest_port=dest_port,
+            )
+
+            # send disconnect
+            return self._disconnect_from_server(dest_ip_address=dest_ip_address, dest_port=dest_port)
+
+    def request_file(
+        self,
+        dest_ip_address: IPv4Address,
+        src_folder_name: str,
+        src_file_name: str,
+        dest_folder_name: str,
+        dest_file_name: str,
+        dest_port: Optional[Port] = Port.FTP,
+    ) -> bool:
+        """
+        Request a file from a target IP address.
+
+        Sends a RETR command to the FTP Server.
+
+        :param: dest_ip_address: The IP address of the machine that hosts the FTP Server.
+        :type: dest_ip_address: IPv4Address
+
+        :param: src_folder_name: The name of the folder that contains the file to send to the FTP Server.
+        :type: src_folder_name: str
+
+        :param: src_file_name: The name of the file to send to the FTP Server.
+        :type: src_file_name: str
+
+        :param: dest_folder_name: The name of the folder where the file will be stored in the FTP Server.
+        :type: dest_folder_name: str
+
+        :param: dest_file_name: The name of the file to be saved on the FTP Server.
+        :type: dest_file_name: str
+
+        :param: dest_port: The open port of the machine that hosts the FTP Server. Default is Port.FTP.
+        :type: dest_port: Optional[Port]
+        """
+        # check if FTP is currently connected to IP
+        self.connected = self._connect_to_server(
+            dest_ip_address=dest_ip_address,
+            dest_port=dest_port,
+        )
+
+        if not self.connected:
+            return False
+        else:
+            # send retrieve request
+            payload: FTPPacket = FTPPacket(
+                ftp_command=FTPCommand.RETR,
+                ftp_command_args={
+                    "src_folder_name": src_folder_name,
+                    "src_file_name": src_file_name,
+                    "dest_file_name": dest_file_name,
+                    "dest_folder_name": dest_folder_name,
+                },
+            )
+            software_manager: SoftwareManager = self.software_manager
+            software_manager.send_payload_to_session_manager(
+                payload=payload, dest_ip_address=dest_ip_address, dest_port=dest_port
+            )
+
+            # send disconnect
+            self._disconnect_from_server(dest_ip_address=dest_ip_address, dest_port=dest_port)
+
+            # the payload should have ok status code
+            if payload.status_code == FTPStatusCode.OK:
+                self.sys_log.info(f"File {src_folder_name}/{src_file_name} found in FTP server.")
+                return True
+            else:
+                self.sys_log.error(f"File {src_folder_name}/{src_file_name} does not exist in FTP server")
+                return False
+
+    def receive(self, payload: FTPPacket, session_id: Optional[str] = None, **kwargs) -> bool:
+        """
+        Receives a payload from the SessionManager.
+
+        :param: payload: FTPPacket payload.
+        :type: payload: FTPPacket
+
+        :param: session_id: ID of the session. Optional.
+        :type: session_id: Optional[str]
+        """
+        if not isinstance(payload, FTPPacket):
+            self.sys_log.error(f"{payload} is not an FTP packet")
+            return False
+
+        self._process_ftp_command(payload=payload, session_id=session_id)
+        return True

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

@@ -0,0 +1,80 @@
+from ipaddress import IPv4Address
+from typing import Any, Dict, Optional
+
+from primaite.simulator.network.protocols.ftp import FTPCommand, FTPPacket, FTPStatusCode
+from primaite.simulator.network.transmission.network_layer import IPProtocol
+from primaite.simulator.network.transmission.transport_layer import Port
+from primaite.simulator.system.core.session_manager import Session
+from primaite.simulator.system.services.ftp.ftp_service import FTPServiceABC
+from primaite.simulator.system.services.service import ServiceOperatingState
+
+
+class FTPServer(FTPServiceABC):
+    """
+    A class for simulating an FTP server service.
+
+    This class inherits from the `Service` class and provides methods to emulate FTP
+    RFC 959: https://datatracker.ietf.org/doc/html/rfc959
+    """
+
+    server_password: Optional[str] = None
+    """Password needed to connect to FTP server. Default is None."""
+
+    connections: Dict[str, IPv4Address] = {}
+    """Current active connections to the FTP server."""
+
+    def __init__(self, **kwargs):
+        kwargs["name"] = "FTPServer"
+        kwargs["port"] = Port.FTP
+        kwargs["protocol"] = IPProtocol.TCP
+        super().__init__(**kwargs)
+        self.start()
+
+    def _get_session_details(self, session_id: str) -> Session:
+        """
+        Returns the Session object from the given session id.
+
+        :param: session_id: ID of the session that needs details retrieved
+        """
+        return self.software_manager.session_manager.sessions_by_uuid[session_id]
+
+    def _process_ftp_command(self, payload: FTPPacket, session_id: Optional[str] = None, **kwargs) -> FTPPacket:
+        """
+        Process the command in the FTP Packet.
+
+        :param: payload: The FTP Packet to process
+        :type: payload: FTPPacket
+        :param: session_id: session ID linked to the FTP Packet. Optional.
+        :type: session_id: Optional[str]
+        """
+        # if server service is down, return error
+        if self.operating_state != ServiceOperatingState.RUNNING:
+            payload.status_code = FTPStatusCode.ERROR
+            return payload
+
+        if session_id:
+            session_details = self._get_session_details(session_id)
+
+        # process server specific commands, otherwise call super
+        if payload.ftp_command == FTPCommand.PORT:
+            # check that the port is valid
+            if isinstance(payload.ftp_command_args, Port) and payload.ftp_command_args.value in range(0, 65535):
+                # return successful connection
+                self.connections[session_id] = session_details.with_ip_address
+                payload.status_code = FTPStatusCode.OK
+                return payload
+
+        if payload.ftp_command == FTPCommand.QUIT:
+            self.connections.pop(session_id)
+            payload.status_code = FTPStatusCode.OK
+
+        return super()._process_ftp_command(payload=payload, session_id=session_id, **kwargs)
+
+    def receive(self, payload: Any, session_id: Optional[str] = None, **kwargs) -> bool:
+        """Receives a payload from the SessionManager."""
+        if not isinstance(payload, FTPPacket):
+            self.sys_log.error(f"{payload} is not an FTP packet")
+            return False
+
+        self.send(self._process_ftp_command(payload=payload, session_id=session_id), session_id)
+        return True

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

@@ -0,0 +1,148 @@
+from abc import ABC
+from ipaddress import IPv4Address
+from typing import Optional
+
+from primaite.simulator.file_system.file_system import File
+from primaite.simulator.network.protocols.ftp import FTPCommand, FTPPacket, FTPStatusCode
+from primaite.simulator.network.transmission.transport_layer import Port
+from primaite.simulator.system.core.software_manager import SoftwareManager
+from primaite.simulator.system.services.service import Service
+
+
+class FTPServiceABC(Service, ABC):
+    """
+    Abstract Base Class for FTP Client and Service.
+
+    Contains shared methods between both classes.
+    """
+
+    def _process_ftp_command(self, payload: FTPPacket, session_id: Optional[str] = None, **kwargs) -> FTPPacket:
+        """
+        Process the command in the FTP Packet.
+
+        :param: payload: The FTP Packet to process
+        :type: payload: FTPPacket
+        :param: session_id: session ID linked to the FTP Packet. Optional.
+        :type: session_id: Optional[str]
+        """
+        # handle STOR request
+        if payload.ftp_command == FTPCommand.STOR:
+            # check that the file is created in the computed hosting the FTP server
+            if self._store_data(payload=payload):
+                payload.status_code = FTPStatusCode.OK
+
+        if payload.ftp_command == FTPCommand.RETR:
+            if self._retrieve_data(payload=payload, session_id=session_id):
+                payload.status_code = FTPStatusCode.OK
+
+        return payload
+
+    def _store_data(self, payload: FTPPacket) -> bool:
+        """
+        Stores the data in the FTP Service's host machine.
+
+        :param: payload: The FTP Packet that contains the file data
+        :type: FTPPacket
+        """
+        try:
+            file_name = payload.ftp_command_args["dest_file_name"]
+            folder_name = payload.ftp_command_args["dest_folder_name"]
+            file_size = payload.ftp_command_args["file_size"]
+            self.file_system.create_file(
+                file_name=file_name,
+                folder_name=folder_name,
+                size=file_size,
+            )
+            self.sys_log.info(
+                f"Created item in {self.sys_log.hostname}: {payload.ftp_command_args['dest_folder_name']}/"
+                f"{payload.ftp_command_args['dest_file_name']}"
+            )
+            # file should exist
+            return self.file_system.get_file(file_name=file_name, folder_name=folder_name) is not None
+        except Exception as e:
+            self.sys_log.error(f"Unable to create file in {self.sys_log.hostname}: {e}")
+            return False
+
+    def _send_data(
+        self,
+        file: File,
+        dest_folder_name: str,
+        dest_file_name: str,
+        dest_ip_address: Optional[IPv4Address] = None,
+        dest_port: Optional[Port] = None,
+        session_id: Optional[str] = None,
+    ) -> bool:
+        """
+        Sends data from the host FTP Service's machine to another FTP Service's host machine.
+
+        :param: file: File to send to the target FTP Service.
+        :type: file: File
+
+        :param: dest_folder_name: The name of the folder where the file will be stored in the FTP Server.
+        :type: dest_folder_name: str
+
+        :param: dest_file_name: The name of the file to be saved on the FTP Server.
+        :type: dest_file_name: str
+
+        :param: dest_ip_address: The IP address of the machine that hosts the FTP Server.
+        :type: dest_ip_address: Optional[IPv4Address]
+
+        :param: dest_port: The open port of the machine that hosts the FTP Server. Default is Port.FTP.
+        :type: dest_port: Optional[Port]
+
+        :param: session_id: session ID linked to the FTP Packet. Optional.
+        :type: session_id: Optional[str]
+        """
+        # send STOR request
+        payload: FTPPacket = FTPPacket(
+            ftp_command=FTPCommand.STOR,
+            ftp_command_args={
+                "dest_folder_name": dest_folder_name,
+                "dest_file_name": dest_file_name,
+                "file_size": file.sim_size,
+            },
+            packet_payload_size=file.sim_size,
+        )
+        software_manager: SoftwareManager = self.software_manager
+        software_manager.send_payload_to_session_manager(
+            payload=payload, dest_ip_address=dest_ip_address, dest_port=dest_port, session_id=session_id
+        )
+
+        if payload.status_code == FTPStatusCode.OK:
+            return True
+
+        return False
+
+    def _retrieve_data(self, payload: FTPPacket, session_id: Optional[str] = None) -> bool:
+        """
+        Handle the transfer of data from Server to Client.
+
+        :param: payload: The FTP Packet that contains the file data
+        :type: FTPPacket
+        """
+        try:
+            # find the file
+            file_name = payload.ftp_command_args["src_file_name"]
+            folder_name = payload.ftp_command_args["src_folder_name"]
+            dest_folder_name = payload.ftp_command_args["dest_folder_name"]
+            dest_file_name = payload.ftp_command_args["dest_file_name"]
+            retrieved_file: File = self.file_system.get_file(folder_name=folder_name, file_name=file_name)
+
+            # if file does not exist, return an error
+            if not retrieved_file:
+                self.sys_log.error(
+                    f"File  {payload.ftp_command_args['dest_folder_name']}/"
+                    f"{payload.ftp_command_args['dest_file_name']} does not exist in {self.sys_log.hostname}"
+                )
+                return False
+            else:
+                # send requested data
+                return self._send_data(
+                    file=retrieved_file,
+                    dest_file_name=dest_file_name,
+                    dest_folder_name=dest_folder_name,
+                    session_id=session_id,
+                )
+        except Exception as e:
+            self.sys_log.error(f"Unable to retrieve file from {self.sys_log.hostname}: {e}")
+            return False

tests/e2e_integration_tests/test_uc2_data_manipulation_scenario.py

@@ -1,7 +1,7 @@
 from primaite.simulator.network.hardware.nodes.computer import Computer
 from primaite.simulator.network.hardware.nodes.server import Server
 from primaite.simulator.system.applications.database_client import DatabaseClient
-from primaite.simulator.system.services.database_service import DatabaseService
+from primaite.simulator.system.services.database.database_service import DatabaseService
 from primaite.simulator.system.services.red_services.data_manipulation_bot import DataManipulationBot
 
 

tests/integration_tests/system/test_database_on_node.py

@@ -2,7 +2,7 @@ from ipaddress import IPv4Address
 
 from primaite.simulator.network.hardware.nodes.server import Server
 from primaite.simulator.system.applications.database_client import DatabaseClient
-from primaite.simulator.system.services.database_service import DatabaseService
+from primaite.simulator.system.services.database.database_service import DatabaseService
 
 
 def test_database_client_server_connection(uc2_network):

tests/integration_tests/system/test_dns_client_server.py

@@ -1,9 +1,7 @@
-from ipaddress import IPv4Address
-
 from primaite.simulator.network.hardware.nodes.computer import Computer
 from primaite.simulator.network.hardware.nodes.server import Server
-from primaite.simulator.system.services.dns_client import DNSClient
+from primaite.simulator.system.services.dns.dns_client import DNSClient
-from primaite.simulator.system.services.dns_server import DNSServer
+from primaite.simulator.system.services.dns.dns_server import DNSServer
 from primaite.simulator.system.services.service import ServiceOperatingState
 
 

tests/integration_tests/system/test_ftp_client_server.py

@@ -0,0 +1,62 @@
+from ipaddress import IPv4Address
+
+from primaite.simulator.network.hardware.nodes.computer import Computer
+from primaite.simulator.network.hardware.nodes.server import Server
+from primaite.simulator.system.services.ftp.ftp_client import FTPClient
+from primaite.simulator.system.services.ftp.ftp_server import FTPServer
+from primaite.simulator.system.services.service import ServiceOperatingState
+
+
+def test_ftp_client_store_file_in_server(uc2_network):
+    """
+    Test checks to see if the client is able to store files in the backup server.
+    """
+    client_1: Computer = uc2_network.get_node_by_hostname("client_1")
+    backup_server: Server = uc2_network.get_node_by_hostname("backup_server")
+
+    ftp_client: FTPClient = client_1.software_manager.software["FTPClient"]
+    ftp_server: FTPServer = backup_server.software_manager.software["FTPServer"]
+
+    assert ftp_client.operating_state == ServiceOperatingState.RUNNING
+    assert ftp_server.operating_state == ServiceOperatingState.RUNNING
+
+    # create file on ftp client
+    ftp_client.file_system.create_file(file_name="test_file.txt")
+
+    ftp_client.send_file(
+        src_folder_name="root",
+        src_file_name="test_file.txt",
+        dest_folder_name="client_1_backup",
+        dest_file_name="test_file.txt",
+        dest_ip_address=backup_server.nics.get(next(iter(backup_server.nics))).ip_address,
+    )
+
+    assert ftp_server.file_system.get_file(folder_name="client_1_backup", file_name="test_file.txt")
+
+
+def test_ftp_client_retrieve_file_from_server(uc2_network):
+    """
+    Test checks to see if the client is able to retrieve files from the backup server.
+    """
+    client_1: Computer = uc2_network.get_node_by_hostname("client_1")
+    backup_server: Server = uc2_network.get_node_by_hostname("backup_server")
+
+    ftp_client: FTPClient = client_1.software_manager.software["FTPClient"]
+    ftp_server: FTPServer = backup_server.software_manager.software["FTPServer"]
+
+    assert ftp_client.operating_state == ServiceOperatingState.RUNNING
+    assert ftp_server.operating_state == ServiceOperatingState.RUNNING
+
+    # create file on ftp server
+    ftp_server.file_system.create_file(file_name="test_file.txt", folder_name="file_share")
+
+    ftp_client.request_file(
+        src_folder_name="file_share",
+        src_file_name="test_file.txt",
+        dest_folder_name="downloads",
+        dest_file_name="test_file.txt",
+        dest_ip_address=backup_server.nics.get(next(iter(backup_server.nics))).ip_address,
+    )
+
+    # client should have retrieved the file
+    assert ftp_client.file_system.get_file(folder_name="downloads", file_name="test_file.txt")

tests/unit_tests/_primaite/_simulator/_system/_services/test_database.py

@@ -1,9 +1,7 @@
-import json
-
 import pytest
 
 from primaite.simulator.network.hardware.base import Node
-from primaite.simulator.system.services.database_service import DatabaseService
+from primaite.simulator.system.services.database.database_service import DatabaseService
 
 
 @pytest.fixture(scope="function")

tests/unit_tests/_primaite/_simulator/_system/_services/test_dns.py

@@ -6,8 +6,8 @@ from primaite.simulator.network.hardware.base import Node
 from primaite.simulator.network.protocols.dns import DNSPacket, DNSReply, DNSRequest
 from primaite.simulator.network.transmission.network_layer import IPProtocol
 from primaite.simulator.network.transmission.transport_layer import Port
-from primaite.simulator.system.services.dns_client import DNSClient
+from primaite.simulator.system.services.dns.dns_client import DNSClient
-from primaite.simulator.system.services.dns_server import DNSServer
+from primaite.simulator.system.services.dns.dns_server import DNSServer
 
 
 @pytest.fixture(scope="function")

tests/unit_tests/_primaite/_simulator/_system/_services/test_ftp.py

@@ -0,0 +1,82 @@
+from ipaddress import IPv4Address
+
+import pytest
+
+from primaite.simulator.network.hardware.base import Node
+from primaite.simulator.network.protocols.ftp import FTPCommand, FTPPacket
+from primaite.simulator.network.transmission.network_layer import IPProtocol
+from primaite.simulator.network.transmission.transport_layer import Port
+from primaite.simulator.system.services.ftp.ftp_client import FTPClient
+from primaite.simulator.system.services.ftp.ftp_server import FTPServer
+
+
+@pytest.fixture(scope="function")
+def ftp_server() -> Node:
+    node = Node(hostname="ftp_server")
+    node.software_manager.install(software_class=FTPServer)
+    node.software_manager.software["FTPServer"].start()
+    return node
+
+
+@pytest.fixture(scope="function")
+def ftp_client() -> Node:
+    node = Node(hostname="ftp_client")
+    node.software_manager.install(software_class=FTPClient)
+    node.software_manager.software["FTPClient"].start()
+    return node
+
+
+def test_create_ftp_server(ftp_server):
+    assert ftp_server is not None
+    ftp_server_service: FTPServer = ftp_server.software_manager.software["FTPServer"]
+    assert ftp_server_service.name is "FTPServer"
+    assert ftp_server_service.port is Port.FTP
+    assert ftp_server_service.protocol is IPProtocol.TCP
+
+
+def test_create_ftp_client(ftp_client):
+    assert ftp_client is not None
+    ftp_client_service: FTPClient = ftp_client.software_manager.software["FTPClient"]
+    assert ftp_client_service.name is "FTPClient"
+    assert ftp_client_service.port is Port.FTP
+    assert ftp_client_service.protocol is IPProtocol.TCP
+
+
+def test_ftp_server_store_file(ftp_server):
+    """Test to make sure the FTP Server knows how to deal with request responses."""
+    assert ftp_server.file_system.get_file(folder_name="downloads", file_name="file.txt") is None
+
+    response: FTPPacket = FTPPacket(
+        ftp_command=FTPCommand.STOR,
+        ftp_command_args={
+            "dest_folder_name": "downloads",
+            "dest_file_name": "file.txt",
+            "file_size": 24,
+        },
+        packet_payload_size=24,
+    )
+
+    ftp_server_service: FTPServer = ftp_server.software_manager.software["FTPServer"]
+    ftp_server_service.receive(response)
+
+    assert ftp_server.file_system.get_file(folder_name="downloads", file_name="file.txt")
+
+
+def test_ftp_client_store_file(ftp_client):
+    """Test to make sure the FTP Client knows how to deal with request responses."""
+    assert ftp_client.file_system.get_file(folder_name="downloads", file_name="file.txt") is None
+
+    response: FTPPacket = FTPPacket(
+        ftp_command=FTPCommand.STOR,
+        ftp_command_args={
+            "dest_folder_name": "downloads",
+            "dest_file_name": "file.txt",
+            "file_size": 24,
+        },
+        packet_payload_size=24,
+    )
+
+    ftp_client_service: FTPClient = ftp_client.software_manager.software["FTPClient"]
+    ftp_client_service.receive(response)
+
+    assert ftp_client.file_system.get_file(folder_name="downloads", file_name="file.txt")