#1916: FTP client STOR request to FTP server

src/primaite/simulator/network/networks.py

@@ -12,6 +12,8 @@ from primaite.simulator.system.applications.database_client import DatabaseClien
 from primaite.simulator.system.services.database.database_service import DatabaseService
 from primaite.simulator.system.services.dns.dns_client import DNSClient
 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) VALUES ('Jane Smith', 'janesmith@example.com', 27, 'Los Angeles', 'Designer');",  # noqa
-        "INSERT INTO user (name, email, age, city, occupation) VALUES ('Bob Johnson', 'bobjohnson@example.com', 45, 'Chicago', 'Manager');",  # 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) 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
+        "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) "
+        "VALUES ('Jane Smith', 'janesmith@example.com', 27, 'Los Angeles', 'Designer');",
+        # noqa
+        "INSERT INTO user (name, email, age, city, occupation) "
+        "VALUES ('Bob Johnson', 'bobjohnson@example.com', 45, 'Chicago', 'Manager');",
+        # 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) "
+        "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
+
+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: Any
+    """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