ADD: Open version, with important changes kept out.

Signed-off-by: Amlal <amlal.elmahrouss@icloud.com>

6 files changed, 349 insertions, 0 deletions

diff --git a/dev/Kernel/NetworkKit/IP.h b/dev/Kernel/NetworkKit/IP.h
new file mode 100644
index 00000000..f04a6bca
--- /dev/null
+++ b/dev/Kernel/NetworkKit/IP.h
@@ -0,0 +1,83 @@
+/* -------------------------------------------
+
+	Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.
+
+------------------------------------------- */
+
+#pragma once
+
+#include <KernelKit/DebugOutput.h>
+#include <NewKit/Defines.h>
+#include <NewKit/Ref.h>
+#include <NewKit/KString.h>
+
+namespace Kernel
+{
+	class RawIPAddress6;
+	class RawIPAddress;
+	class IPFactory;
+
+	class RawIPAddress final
+	{
+	private:
+		explicit RawIPAddress(char bytes[4]);
+		~RawIPAddress() = default;
+
+		RawIPAddress& operator=(const RawIPAddress&) = delete;
+		RawIPAddress(const RawIPAddress&)			 = default;
+
+	public:
+		char* Address();
+
+		char& operator[](const Size& index);
+
+		bool operator==(const RawIPAddress& ipv6);
+		bool operator!=(const RawIPAddress& ipv6);
+
+	private:
+		char fAddr[4];
+
+		friend IPFactory; // it is the one creating these addresses, thus this
+						  // is why the constructors are private.
+	};
+
+	/**
+	 * @brief IPv6 address.
+	 */
+	class RawIPAddress6 final
+	{
+	private:
+		explicit RawIPAddress6(char Bytes[8]);
+		~RawIPAddress6() = default;
+
+		RawIPAddress6& operator=(const RawIPAddress6&) = delete;
+		RawIPAddress6(const RawIPAddress6&)			   = default;
+
+	public:
+		char* Address()
+		{
+			return fAddr;
+		}
+
+		char& operator[](const Size& index);
+
+		bool operator==(const RawIPAddress6& ipv6);
+		bool operator!=(const RawIPAddress6& ipv6);
+
+	private:
+		char fAddr[8];
+
+		friend IPFactory;
+	};
+
+	/**
+	 * @brief IP Creation helpers
+	 */
+	class IPFactory final
+	{
+	public:
+		static ErrorOr<KString> ToKString(Ref<RawIPAddress6>& ipv6);
+		static ErrorOr<KString> ToKString(Ref<RawIPAddress>& ipv4);
+		static bool				IpCheckVersion4(const Char* ip);
+	};
+} // namespace Kernel
diff --git a/dev/Kernel/NetworkKit/IPC.h b/dev/Kernel/NetworkKit/IPC.h
new file mode 100644
index 00000000..a615adc9
--- /dev/null
+++ b/dev/Kernel/NetworkKit/IPC.h
@@ -0,0 +1,106 @@
+/* -------------------------------------------
+
+	Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved..
+
+	File: IPC.h.
+	Purpose: IPC protocol.
+
+------------------------------------------- */
+
+#ifndef INC_IPC_H
+#define INC_IPC_H
+
+#include <NewKit/Defines.h>
+#include <NewKit/KString.h>
+#include <Hints/CompilerHint.h>
+
+/// @file IPC.h
+/// @brief IPC comm. protocol.
+
+/// IA separator.
+#define kIPCRemoteSeparator ":"
+
+/// Interchange address, consists of PID:TEAM.
+#define kIPCRemoteInvalid "00:00"
+
+#define kIPCHeaderMagic (0x4950434)
+
+namespace Kernel
+{
+	struct IPC_ADDR;
+	struct IPC_MSG;
+
+	/// @brief 128-bit IPC address.
+	struct PACKED IPC_ADDR final
+	{
+		UInt64 UserProcessID;
+		UInt64 UserProcessTeam;
+
+		////////////////////////////////////
+		// some operators.
+		////////////////////////////////////
+
+		bool operator==(const IPC_ADDR& addr) noexcept
+		{
+			return addr.UserProcessID == this->UserProcessID && addr.UserProcessTeam == this->UserProcessTeam;
+		}
+
+		bool operator==(IPC_ADDR& addr) noexcept
+		{
+			return addr.UserProcessID == this->UserProcessID && addr.UserProcessTeam == this->UserProcessTeam;
+		}
+	};
+
+	typedef struct IPC_ADDR IPC_ADDR;
+
+	enum
+	{
+		kIPCLittleEndian = 0,
+		kIPCBigEndian	 = 1,
+		kIPCMixedEndian	 = 2,
+	};
+
+	constexpr inline auto kIPCMsgSize = 6094U;
+
+	/// @brief IPC connection header, message cannot be greater than 6K.
+	typedef struct IPC_MSG final
+	{
+		UInt32	 IpcHeaderMagic; // cRemoteHeaderMagic
+		UInt8	 IpcEndianess;	 // 0 : LE, 1 : BE
+		SizeT	 IpcPacketSize;
+		IPC_ADDR IpcFrom;
+		IPC_ADDR IpcTo;
+		UInt32	 IpcCRC32;
+		UInt32	 IpcMsg;
+		UInt32	 IpcMsgSz;
+		UInt8	 IpcData[kIPCMsgSize];
+
+		/// @brief Passes the message to target, could be anything, HTTP packet, JSON or whatever.
+		Bool Pass(IPC_MSG* target) noexcept
+		{
+			if (target && target->IpcFrom == this->IpcTo)
+			{
+				if (this->IpcMsgSz > target->IpcMsgSz)
+					return No;
+
+				rt_copy_memory(this->IpcData, target->IpcData, this->IpcMsgSz);
+
+				return Yes;
+			}
+
+			return No;
+		}
+	} PACKED IPC_MSG;
+
+	/// @brief Sanitize packet function
+	/// @retval true packet is correct.
+	/// @retval false packet is incorrect and process has crashed.
+	Bool ipc_sanitize_packet(_Input IPC_MSG* pckt_in);
+
+	/// @brief Construct packet function
+	/// @retval true packet is correct.
+	/// @retval false packet is incorrect and process has crashed.
+	Bool ipc_construct_packet(_Output _Input IPC_MSG** pckt_in);
+} // namespace Kernel
+
+#endif // INC_IPC_H
diff --git a/dev/Kernel/NetworkKit/LTE.h b/dev/Kernel/NetworkKit/LTE.h
new file mode 100644
index 00000000..7aa99ec6
--- /dev/null
+++ b/dev/Kernel/NetworkKit/LTE.h
@@ -0,0 +1,16 @@
+/* -------------------------------------------
+
+	Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved..
+
+	File: LTE.h.
+	Purpose: LTE protocol classes.
+
+------------------------------------------- */
+
+#ifndef _INC_NETWORK_LTE_H_
+#define _INC_NETWORK_LTE_H_
+
+#include <NewKit/Defines.h>
+#include <NewKit/KString.h>
+
+#endif // ifndef _INC_NETWORK_LTE_H_
diff --git a/dev/Kernel/NetworkKit/MAC.h b/dev/Kernel/NetworkKit/MAC.h
new file mode 100644
index 00000000..916e3348
--- /dev/null
+++ b/dev/Kernel/NetworkKit/MAC.h
@@ -0,0 +1,29 @@
+/* -------------------------------------------
+
+	Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.
+
+------------------------------------------- */
+
+#pragma once
+
+#include <NewKit/Array.h>
+#include <NewKit/Defines.h>
+#include <NewKit/KString.h>
+
+namespace Kernel
+{
+	class MacAddressGetter;
+
+	/// \brief This retrieves the MAC address of the device.
+	/// \note Listens for the current NIC.
+	class MacAddressGetter final
+	{
+	public:
+		explicit MacAddressGetter() = default;
+
+	public:
+		KString&			 AsString();
+		Array<WideChar, 12>& AsBytes();
+	};
+
+} // namespace Kernel
diff --git a/dev/Kernel/NetworkKit/NetworkDevice.h b/dev/Kernel/NetworkKit/NetworkDevice.h
new file mode 100644
index 00000000..c55c2f37
--- /dev/null
+++ b/dev/Kernel/NetworkKit/NetworkDevice.h
@@ -0,0 +1,83 @@
+/* -------------------------------------------
+
+	Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.
+
+------------------------------------------- */
+
+#ifndef __INC_NETWORK_DEVICE_H__
+#define __INC_NETWORK_DEVICE_H__
+
+#include <KernelKit/DeviceMgr.h>
+#include <NetworkKit/IP.h>
+
+/// @note Can either work with: Ethernet, GPRS, WiFi
+
+namespace Kernel
+{
+	struct NetworkDeviceCommand;
+	class NetworkDevice;
+
+	/**
+	 * \brief Network device interface, establishes a connection to the NIC.
+	 */
+	class NetworkDevice final : public IDeviceObject<NetworkDeviceCommand>
+	{
+	public:
+		NetworkDevice(void (*out)(NetworkDeviceCommand),
+					  void (*in)(NetworkDeviceCommand),
+					  void (*onCleanup)(void) = nullptr);
+
+		~NetworkDevice() override;
+
+	public:
+		NetworkDevice& operator=(const NetworkDevice&) = default;
+		NetworkDevice(const NetworkDevice&)			   = default;
+
+	public:
+		const Char* Name() const override;
+		Boolean		Name(const Char* newStr);
+
+	private:
+		static constexpr auto cNetworkNameLen = 512;
+
+		Void (*fCleanup)(void);
+		Char fNetworkName[cNetworkNameLen];
+	};
+
+	struct NetworkDeviceCommand final
+	{
+		UInt32	CommandName;
+		UInt32	CommandType;
+		UInt32	CommandFlags;
+		VoidPtr CommandBuffer;
+		SizeT	CommandSizeBuffer;
+	};
+
+	/// @brief TCP device.
+	using TCPNetworkDevice = NetworkDevice;
+
+	/// @brief UDP device.
+	using UDPNetworkDevice = NetworkDevice;
+
+	/// @brief PPP device.
+	using PPPNetworkDevice = NetworkDevice;
+
+	/// @brief IPC device.
+	using IPCNetworkDevice = NetworkDevice;
+
+	/// @brief GRPS device.
+	using GPRSNetworkDevice = NetworkDevice;
+
+	/// @brief GSM device.
+	using GSMNetworkDevice = NetworkDevice;
+
+	/// @brief Bluetooth device.
+	using BTNetworkDevice = NetworkDevice;
+
+	/// @brief LTE device.
+	using LTENetworkDevice = NetworkDevice;
+} // namespace Kernel
+
+#include <NetworkKit/NetworkDevice.inl>
+
+#endif // !__INC_NETWORK_DEVICE_H__
diff --git a/dev/Kernel/NetworkKit/NetworkDevice.inl b/dev/Kernel/NetworkKit/NetworkDevice.inl
new file mode 100644
index 00000000..8d6bf6cb
--- /dev/null
+++ b/dev/Kernel/NetworkKit/NetworkDevice.inl
@@ -0,0 +1,32 @@
+/* -------------------------------------------
+
+	Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.
+
+------------------------------------------- */
+
+/***
+	Dtor and ctors.
+*/
+
+namespace Kernel
+{
+	NetworkDevice::NetworkDevice(void (*out)(NetworkDeviceCommand),
+								 void (*in)(NetworkDeviceCommand),
+								 void (*on_cleanup)(void))
+		: IDeviceObject<NetworkDeviceCommand>(out, in), fCleanup(on_cleanup)
+	{
+		kcout << "NetworkDevice initialized.\r";
+
+		MUST_PASS(out && in && on_cleanup);
+	}
+
+	NetworkDevice::~NetworkDevice()
+	{
+		MUST_PASS(fCleanup);
+
+		kcout << "NetworkDevice cleanup.\r";
+
+		if (fCleanup)
+			fCleanup();
+	}
+} // namespace Kernel