KernelLand/Modules/IPStack/ipv4.c

   1 /*
   2  * Acess2 IP Stack
   3  * - IPv4 Protcol Handling
   4  */
   5 #define DEBUG   0
   6 #include "ipstack.h"
   7 #include "link.h"
   8 #include "ipv4.h"
   9 #include "firewall.h"
  10
  11 // === CONSTANTS ===
  12 #define DEFAULT_TTL     32
  13 #define IPV4_TRACE      0       // set to 1 to enable packet tracing
  14
  15 // === IMPORTS ===
  16 extern tInterface       *gIP_Interfaces;
  17 extern void     ICMP_Initialise();
  18 extern  int     ICMP_Ping(tInterface *Interface, tIPv4 Addr);
  19 extern tMacAddr ARP_Resolve4(tInterface *Interface, tIPv4 Address);
  20 extern void     ARP_UpdateCache4(tIPv4 SWAddr, tMacAddr HWAddr);
  21
  22 // === PROTOTYPES ===
  23  int    IPv4_Initialise();
  24  int    IPv4_RegisterCallback(int ID, tIPCallback Callback);
  25 void    IPv4_int_GetPacket(tAdapter *Interface, tMacAddr From, int Length, void *Buffer);
  26 tInterface      *IPv4_GetInterface(tAdapter *Adapter, tIPv4 Address, int Broadcast);
  27 Uint32  IPv4_Netmask(int FixedBits);
  28 Uint16  IPv4_Checksum(const void *Buf, size_t Length);
  29  int    IPv4_Ping(tInterface *Iface, tIPv4 Addr);
  30
  31 // === GLOBALS ===
  32 tIPCallback     gaIPv4_Callbacks[256];
  33
  34 // === CODE ===
  35 /**
  36  * \brief Initialise the IPv4 Code
  37  */
  38 int IPv4_Initialise()
  39 {
  40         ICMP_Initialise();
  41         Link_RegisterType(IPV4_ETHERNET_ID, IPv4_int_GetPacket);
  42         return 1;
  43 }
  44
  45 /**
  46  * \brief Registers a callback
  47  * \param ID    8-bit packet type ID
  48  * \param Callback      Callback function
  49  */
  50 int IPv4_RegisterCallback(int ID, tIPCallback Callback)
  51 {
  52         if( ID < 0 || ID > 255 )        return 0;
  53         if( gaIPv4_Callbacks[ID] )      return 0;
  54         gaIPv4_Callbacks[ID] = Callback;
  55         return 1;
  56 }
  57
  58 /**
  59  * \brief Creates and sends an IPv4 Packet
  60  * \param Iface Interface
  61  * \param Address       Destination IP
  62  * \param Protocol      Protocol ID
  63  * \param ID    Some random ID number
  64  * \param Length        Data Length
  65  * \param Data  Packet Data
  66  * \return Boolean Success
  67  */
  68 int IPv4_SendPacket(tInterface *Iface, tIPv4 Address, int Protocol, int ID, tIPStackBuffer *Buffer)
  69 {
  70         tMacAddr        to;
  71         tIPv4Header     hdr;
  72          int    length;
  73
  74         length = IPStack_Buffer_GetLength(Buffer);
  75
  76         // --- Resolve destination MAC address
  77         to = ARP_Resolve4(Iface, Address);
  78         if( MAC_EQU(to, cMAC_ZERO) ) {
  79                 // No route to host
  80                 Log_Notice("IPv4", "No route to host %i.%i.%i.%i",
  81                         Address.B[0], Address.B[1], Address.B[2], Address.B[3]);
  82                 return 0;
  83         }
  84
  85         // --- Handle OUTPUT firewall rules
  86         // TODO: Update firewall rules for tIPStackBuffer
  87         #if 0
  88         int ret = IPTables_TestChain("OUTPUT",
  89                 4, (tIPv4*)Iface->Address, &Address,
  90                 Protocol, 0,
  91                 length, Data);
  92         if(ret > 0) {
  93                 // Just drop it (with an error)
  94                 Log_Notice("IPv4", "Firewall dropped packet");
  95                 return 0;
  96         }
  97         #endif
  98
  99         // --- Initialise header
 100         hdr.Version = 4;
 101         hdr.HeaderLength = sizeof(tIPv4Header)/4;
 102         hdr.DiffServices = 0;   // TODO: Check
 103
 104         hdr.Reserved = 0;
 105         hdr.DontFragment = 0;
 106         hdr.MoreFragments = 0;
 107         hdr.FragOffLow = 0;
 108         hdr.FragOffHi = 0;
 109
 110         hdr.TotalLength = htons( sizeof(tIPv4Header) + length );
 111         hdr.Identifcation = htons( ID );        // TODO: Check
 112         hdr.TTL = DEFAULT_TTL;
 113         hdr.Protocol = Protocol;
 114         hdr.HeaderChecksum = 0; // Will be set later
 115         hdr.Source = *(tIPv4*)Iface->Address;
 116         hdr.Destination = Address;
 117
 118         // Actually set checksum (zeroed above)
 119         hdr.HeaderChecksum = htons( IPv4_Checksum(&hdr, sizeof(tIPv4Header)) );
 120
 121         IPStack_Buffer_AppendSubBuffer(Buffer, sizeof(tIPv4Header), 0, &hdr, NULL, NULL);
 122
 123         #if IPV4_TRACE
 124         Log_Log("IPv4", "Sending packet to %i.%i.%i.%i",
 125                 Address.B[0], Address.B[1], Address.B[2], Address.B[3]);
 126         #endif
 127         Link_SendPacket(Iface->Adapter, IPV4_ETHERNET_ID, to, Buffer);
 128         return 1;
 129 }
 130
 131 /**
 132  * \fn void IPv4_int_GetPacket(tInterface *Adapter, tMacAddr From, int Length, void *Buffer)
 133  * \brief Process an IPv4 Packet
 134  */
 135 void IPv4_int_GetPacket(tAdapter *Adapter, tMacAddr From, int Length, void *Buffer)
 136 {
 137         tIPv4Header     *hdr = Buffer;
 138         tInterface      *iface;
 139         Uint8   *data;
 140          int    dataLength;
 141          int    ret;
 142
 143         if(Length < sizeof(tIPv4Header))        return;
 144
 145         #if 0
 146         //Log_Log("IPv4", "Version = %i", hdr->Version);
 147         //Log_Log("IPv4", "HeaderLength = %i", hdr->HeaderLength);
 148         //Log_Log("IPv4", "DiffServices = %i", hdr->DiffServices);
 149         Log_Debug("IPv4", "TotalLength = %i", ntohs(hdr->TotalLength) );
 150         //Log_Log("IPv4", "Identifcation = %i", ntohs(hdr->Identifcation) );
 151         //Log_Log("IPv4", "TTL = %i", hdr->TTL );
 152         Log_Debug("IPv4", "Protocol = %i", hdr->Protocol );
 153         //Log_Log("IPv4", "HeaderChecksum = 0x%x", ntohs(hdr->HeaderChecksum) );
 154         Log_Debug("IPv4", "Source = %i.%i.%i.%i",
 155                 hdr->Source.B[0], hdr->Source.B[1], hdr->Source.B[2], hdr->Source.B[3] );
 156         Log_Debug("IPv4", "Destination = %i.%i.%i.%i",
 157                 hdr->Destination.B[0], hdr->Destination.B[1],
 158                 hdr->Destination.B[2], hdr->Destination.B[3] );
 159         #endif
 160
 161         // Check that the version IS IPv4
 162         if(hdr->Version != 4) {
 163                 Log_Log("IPv4", "hdr->Version(%i) != 4", hdr->Version);
 164                 return;
 165         }
 166
 167         // Check Header checksum
 168         {
 169                 Uint16  hdrVal, compVal;
 170                 hdrVal = ntohs(hdr->HeaderChecksum);
 171                 hdr->HeaderChecksum = 0;
 172                 compVal = IPv4_Checksum(hdr, hdr->HeaderLength * 4);
 173                 if(hdrVal != compVal) {
 174                         Log_Log("IPv4", "Header checksum fails (%04x != %04x)", hdrVal, compVal);
 175                         return ;
 176                 }
 177                 hdr->HeaderChecksum = hdrVal;
 178         }
 179
 180         // Check Packet length
 181         if( ntohs(hdr->TotalLength) > Length) {
 182                 Log_Log("IPv4", "hdr->TotalLength(%i) > Length(%i)", ntohs(hdr->TotalLength), Length);
 183                 return;
 184         }
 185
 186         // TODO: Handle packet fragmentation
 187
 188         #if IPV4_TRACE
 189         Log_Debug("IPv4", " From %i.%i.%i.%i to %i.%i.%i.%i",
 190                 hdr->Source.B[0], hdr->Source.B[1], hdr->Source.B[2], hdr->Source.B[3],
 191                 hdr->Destination.B[0], hdr->Destination.B[1], hdr->Destination.B[2], hdr->Destination.B[3]
 192                 );
 193         #endif
 194
 195         // TODO: Should ARP sniffing be used?
 196         // - If we get a packet, cache the source MAC
 197         ARP_UpdateCache4(hdr->Source, From);
 198
 199         // Get Data and Data Length
 200         dataLength = ntohs(hdr->TotalLength) - sizeof(tIPv4Header);
 201         data = &hdr->Options[0];
 202
 203         // Get Interface (allowing broadcasts)
 204         iface = IPv4_GetInterface(Adapter, hdr->Destination, 1);
 205
 206         // Firewall rules
 207         if( iface ) {
 208                 // Incoming Packets
 209                 ret = IPTables_TestChain("INPUT",
 210                         4, &hdr->Source, &hdr->Destination,
 211                         hdr->Protocol, 0,
 212                         dataLength, data
 213                         );
 214         }
 215         else {
 216                 // Routed packets
 217                 ret = IPTables_TestChain("FORWARD",
 218                         4, &hdr->Source, &hdr->Destination,
 219                         hdr->Protocol, 0,
 220                         dataLength, data
 221                         );
 222         }
 223         switch(ret)
 224         {
 225         // 0 - Allow
 226         case 0: break;
 227         // 1 - Silent Drop
 228         case 1:
 229                 Log_Debug("IPv4", "Silently dropping packet");
 230                 return ;
 231         case -1:
 232                 // Bad rule
 233                 break ;
 234         // Unknown, silent drop
 235         default:
 236                 Log_Warning("IPv4", "Unknown firewall rule");
 237                 return ;
 238         }
 239
 240         // Routing
 241         if(!iface)
 242         {
 243                 #if 0
 244                 tMacAddr        to;
 245                 tRoute  *rt;
 246
 247
 248                 // TODO: Put this in another thread to avoid delays in the RX thread
 249                 Log_Debug("IPv4", "Route the packet");
 250                 // Drop the packet if the TTL is zero
 251                 if( hdr->TTL == 0 ) {
 252                         Log_Warning("IPv4", "TODO: Send ICMP-Timeout when TTL exceeded");
 253                         return ;
 254                 }
 255
 256                 hdr->TTL --;
 257
 258                 rt = IPStack_FindRoute(4, NULL, &hdr->Destination);     // Get the route (gets the interface)
 259                 if( !rt || !rt->Interface )
 260                         return ;
 261                 to = ARP_Resolve4(rt->Interface, hdr->Destination);     // Resolve address
 262                 if( MAC_EQU(to, cMAC_ZERO) )
 263                         return ;
 264
 265                 // Send packet
 266                 Log_Log("IPv4", "Forwarding packet to %i.%i.%i.%i (via %i.%i.%i.%i)",
 267                         hdr->Destination.B[0], hdr->Destination.B[1],
 268                         hdr->Destination.B[2], hdr->Destination.B[3],
 269                         ((tIPv4*)rt->NextHop)->B[0], ((tIPv4*)rt->NextHop)->B[1],
 270                         ((tIPv4*)rt->NextHop)->B[2], ((tIPv4*)rt->NextHop)->B[3]);
 271                 Log_Warning("IPv4", "TODO: Implement forwarding with tIPStackBuffer");
 272 //              Link_SendPacket(rt->Interface->Adapter, IPV4_ETHERNET_ID, to, Length, Buffer);
 273                 #endif
 274
 275                 return ;
 276         }
 277
 278         // Send it on
 279         if( !gaIPv4_Callbacks[hdr->Protocol] ) {
 280                 Log_Log("IPv4", "Unknown Protocol %i", hdr->Protocol);
 281                 return ;
 282         }
 283
 284         gaIPv4_Callbacks[hdr->Protocol]( iface, &hdr->Source, dataLength, data );
 285 }
 286
 287 /**
 288  * \fn tInterface *IPv4_GetInterface(tAdapter *Adapter, tIPv4 Address)
 289  * \brief Searches an adapter for a matching address
 290  * \param Adapter       Incoming Adapter
 291  * \param Address       Destination Address
 292  * \param Broadcast     Allow broadcast packets
 293  */
 294 tInterface *IPv4_GetInterface(tAdapter *Adapter, tIPv4 Address, int Broadcast)
 295 {
 296         tInterface      *iface = NULL, *zero_iface = NULL;
 297         Uint32  netmask;
 298         Uint32  addr, this;
 299
 300         ENTER("pAdapter xAddress bBroadcast", Adapter, Address, Broadcast);
 301
 302         addr = ntohl( Address.L );
 303         LOG("addr = 0x%x", addr);
 304
 305         for( iface = gIP_Interfaces; iface; iface = iface->Next)
 306         {
 307                 if( iface->Adapter != Adapter ) continue;
 308                 if( iface->Type != 4 )  continue;
 309                 if( IP4_EQU(Address, *(tIPv4*)iface->Address) ) {
 310                         LOG("Exact match");
 311                         LEAVE('p', iface);
 312                         return iface;
 313                 }
 314
 315                 LOG("iface->Address = 0x%x", *(Uint32*)iface->Address);
 316
 317                 if( *(Uint32*)iface->Address == 0 ) {
 318                         if( zero_iface ) {
 319                                 Log_Notice("IPv4", "Multiple 0.0.0.0 interfaces on the same adapter, ignoring");
 320                         }
 321                         else {
 322                                 zero_iface = iface;
 323                                 LOG("Zero IF %p", iface);
 324                         }
 325                         continue ;
 326                 }
 327
 328                 if( !Broadcast )        continue;
 329
 330                 // Check for broadcast
 331                 this = ntohl( ((tIPv4*)iface->Address)->L );
 332                 netmask = IPv4_Netmask(iface->SubnetBits);
 333                 LOG("iface addr = 0x%x, netmask = 0x%x (bits = %i)", this, netmask, iface->SubnetBits);
 334
 335                 if( (addr & netmask) == (this & netmask) && (addr & ~netmask) == (0xFFFFFFFF & ~netmask) )
 336                 {
 337                         LOG("Broadcast match");
 338                         LEAVE('p', iface);
 339                         return iface;
 340                 }
 341         }
 342
 343         // Special case for intefaces that are being DHCP configured
 344         // - If the interface address is 0.0.0.0, then if there is no match for the
 345         //   destination the packet is treated as if it was addressed to 0.0.0.0
 346         if( zero_iface && Broadcast )
 347         {
 348                 LOG("Using 0.0.0.0 interface with magic!");
 349                 LEAVE('p', zero_iface);
 350                 return zero_iface;
 351         }
 352
 353         LEAVE('n');
 354         return NULL;
 355 }
 356
 357 /**
 358  * \brief Convert a network prefix to a netmask
 359  * \param FixedBits     Netmask size (/n)
 360  *
 361  * For example /24 will become 255.255.255.0 (0xFFFFFF00)
 362  */
 363 Uint32 IPv4_Netmask(int FixedBits)
 364 {
 365         Uint32  ret = 0xFFFFFFFF;
 366         if( FixedBits == 0 )
 367                 return 0;
 368         if( FixedBits < 32 )
 369         {
 370                 ret >>= (32-FixedBits);
 371                 ret <<= (32-FixedBits);
 372         }
 373         // Returns a native endian netmask
 374         return ret;
 375 }
 376
 377 /**
 378  * \brief Calculate the IPv4 Checksum
 379  * \param Buf   Input buffer
 380  * \param Size  Size of input
 381  *
 382  * One's complement sum of all 16-bit words (bitwise inverted)
 383  */
 384 Uint16 IPv4_Checksum(const void *Buf, size_t Length)
 385 {
 386         const Uint16    *words = Buf;
 387         Uint32  sum = 0;
 388          int    i;
 389
 390         // Sum all whole words
 391         for(i = 0; i < Length/2; i++ )
 392         {
 393                 sum += ntohs(words[i]);
 394         }
 395         if( Length & 1 )
 396                 sum += ntohs( words[i] & 0xFF );
 397
 398         // Apply one's complement
 399         while (sum >> 16)
 400                 sum = (sum & 0xFFFF) + (sum >> 16);
 401
 402         return ~sum;
 403 }
 404
 405 /**
 406  * \brief Sends an ICMP Echo and waits for a reply
 407  * \param IFace Interface
 408  * \param Addr  Destination address
 409  */
 410 int IPv4_Ping(tInterface *IFace, tIPv4 Addr)
 411 {
 412         return ICMP_Ping(IFace, Addr);
 413 }