* replaced the bmf plugin with the most recent 1.3 from sf.net with the
[olsrd.git] / lib / bmf / src / Address.c
1 /*
2  * OLSR Basic Multicast Forwarding (BMF) plugin.
3  * Copyright (c) 2005, 2006, Thales Communications, Huizen, The Netherlands.
4  * Written by Erik Tromp.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without 
8  * modification, are permitted provided that the following conditions 
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright 
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright 
14  *   notice, this list of conditions and the following disclaimer in 
15  *   the documentation and/or other materials provided with the 
16  *   distribution.
17  * * Neither the name of Thales, BMF nor the names of its 
18  *   contributors may be used to endorse or promote products derived 
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
23  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
24  * IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
25  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 
28  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
29  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
30  * OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32  
33 /* -------------------------------------------------------------------------
34  * File       : Address.c
35  * Description: IP packet characterization functions
36  * Created    : 29 Jun 2006
37  *
38  * $Id: Address.c,v 1.2 2007/02/10 17:05:55 bernd67 Exp $ 
39  * ------------------------------------------------------------------------- */
40  
41 #include "Address.h"
42
43 /* System includes */
44 #include <assert.h> /* assert() */
45 #include <netinet/ip.h> /* struct ip */
46 #include <netinet/udp.h> /* struct udphdr */
47
48 /* OLSRD includes */
49 #include "defs.h" /* COMP_IP */
50
51 /* Plugin includes */
52 #include "Bmf.h" /* BMF_ENCAP_PORT */
53 #include "NetworkInterfaces.h" /* TBmfInterface */
54
55 /* Whether or not to flood local broadcast packets (e.g. packets with IP
56  * destination 192.168.1.255). May be overruled by setting the plugin
57  * parameter "DoLocalBroadcast" to "no" */
58 int EnableLocalBroadcast = 1;
59
60 /* -------------------------------------------------------------------------
61  * Function   : DoLocalBroadcast
62  * Description: Overrule the default setting, enabling or disabling the
63  *              flooding of local broadcast packets
64  * Input      : enable - either "yes" or "no"
65  * Output     : none
66  * Return     : fail (0) or success (1)
67  * Data Used  : none
68  * ------------------------------------------------------------------------- */
69 int DoLocalBroadcast(const char* enable)
70 {
71   if (strcmp(enable, "yes") == 0)
72   {
73     EnableLocalBroadcast = 1;
74     return 1;
75   }
76   else if (strcmp(enable, "no") == 0)
77   {
78     EnableLocalBroadcast = 0;
79     return 1;
80   }
81
82   /* Value not recognized */
83   return 0;
84 }
85
86 /* -------------------------------------------------------------------------
87  * Function   : IsMulticast
88  * Description: Check if an IP address is a multicast address
89  * Input      : ipAddress
90  * Output     : none
91  * Return     : true (1) or false (0)
92  * Data Used  : none
93  * ------------------------------------------------------------------------- */
94 int IsMulticast(union olsr_ip_addr* ipAddress)
95 {
96   assert(ipAddress != NULL);
97
98   return (ntohl(ipAddress->v4) & 0xF0000000) == 0xE0000000;
99 }
100
101 /* -------------------------------------------------------------------------
102  * Function   : IsLocalBroadcast
103  * Description: Check if an IP address is a local broadcast address for a
104  *              given network interface
105  * Input      : destIp, broadAddr
106  * Output     : none
107  * Return     : true (1) or false (0)
108  * Data Used  : none
109  * ------------------------------------------------------------------------- */
110 int IsLocalBroadcast(union olsr_ip_addr* destIp, struct sockaddr* broadAddr)
111 {
112   struct sockaddr_in* sin;
113   
114   assert(destIp != NULL && broadAddr != NULL);
115
116   /* Cast down to correct sockaddr subtype */
117   sin = (struct sockaddr_in*)broadAddr;
118
119   return COMP_IP(&(sin->sin_addr.s_addr), destIp);
120 }
121
122 /* -------------------------------------------------------------------------
123  * Function   : IsOlsrOrBmfPacket
124  * Description: Check if an ethernet packet is an OLSR packet or a BMF packet
125  * Input      : intf, ethPkt, len
126  * Output     : none
127  * Return     : true (1) or false (0)
128  * Data Used  : none
129  * Assumption : len >= IP_HDR_OFFSET + GetIpHeaderLength(ethPkt)
130  * ------------------------------------------------------------------------- */
131 int IsOlsrOrBmfPacket(struct TBmfInterface* intf, unsigned char* ethPkt, size_t len)
132 {
133   struct ip* ipData;
134   unsigned int ipHeaderLen;
135   struct udphdr* udpData;
136   u_int16_t destPort;
137
138   assert(ethPkt != NULL);
139
140   /* Consider OLSR and BMF packets not to be local broadcast
141    * OLSR packets are UDP - port 698
142    * OLSR-BMF packets are UDP - port 50698
143    * OLSR-Autodetect probe packets are UDP - port 51698
144    * Fragments of the above packets are also not local broadcast */
145
146   ipData = (struct ip*) (ethPkt + IP_HDR_OFFSET);
147   if (ipData->ip_p != SOL_UDP)
148   {
149     return 0;
150   }
151
152   /* Check if the packet is an IP-fragment */
153   if ((ntohs(ipData->ip_off) & IP_OFFMASK) != 0)
154   {
155 #if 0
156     int i;
157     for (i = 0; i < FRAGMENT_HISTORY_SIZE; i++)
158     {
159       /* Quick-access pointer */
160       struct TFragmentHistory* entry = &intf->fragmentHistory[i];
161
162       /* Match */
163       if (entry->ipId == ntohs(ipData->ip_id) &&
164           entry->ipProto == ipData->ip_p &&
165           entry->ipSrc.s_addr == ntohl(ipData->ip_src.s_addr) &&
166           entry->ipDst.s_addr == ntohl(ipData->ip_dst.s_addr))
167       {
168         /* Found matching history entry, so packet is assumed to be a fragment
169          * of an earlier OLSR/OLSR-BMF/OLSR-Autodetect packet */
170
171         /* More fragments? If not, invalidate entry */
172         if (((ntohs(ipData->ip_off) & IP_MF) == 0))
173         {
174           memset(entry, 0, sizeof(struct TFragmentHistory));
175         }
176
177         return 1;
178       }
179     }
180
181     /* Matching history entry not found, so packet is not assumed to be a fragment
182      * of an earlier OLSR/OLSR-BMF/OLSR-Autodetect packet */
183 #endif
184     /* OOPS! IP-fragments may come in earlier than their main packet. In that case,
185      * their relation with the main packet is not detected by the above code, resulting
186      * in stray fragments being forwarded all ove the network. Solution for now is to
187      * not forward any IP-fragments at all. */
188     /*return 0;*/
189     return 1;
190   }
191
192   /* The packet is the first (or only) IP-fragment */
193
194   /* Check length first */
195   ipHeaderLen = ipData->ip_hl << 2;
196   if (len < IP_HDR_OFFSET + ipHeaderLen + sizeof(struct udphdr))
197   {
198     return 0;
199   }
200
201   /* Go into the UDP header and check port number */
202   udpData = (struct udphdr*) (ethPkt + IP_HDR_OFFSET + ipHeaderLen);
203   destPort = ntohs(udpData->dest);
204
205   if (destPort == OLSRPORT || destPort == BMF_ENCAP_PORT || destPort == 51698)
206       /* TODO: #define for 51698 */
207   {
208 #if 0
209     /* If more fragments are expected, keep a record in the fragment history */
210     if ((ntohs(ipData->ip_off) & IP_MF) != 0)
211     {
212       /* Quick-access pointer */
213       struct TFragmentHistory* entry = &intf->fragmentHistory[intf->nextFragmentHistoryEntry];
214
215       /* Store in fragment history */
216       entry->ipId = ntohs(ipData->ip_id);
217       entry->ipProto = ipData->ip_p;
218       entry->ipSrc.s_addr = ntohl(ipData->ip_src.s_addr);
219       entry->ipDst.s_addr = ntohl(ipData->ip_dst.s_addr);
220
221       /* Advance to next entry */
222       intf->nextFragmentHistoryEntry++;
223       intf->nextFragmentHistoryEntry %= FRAGMENT_HISTORY_SIZE;
224     }
225 #endif
226     return 1;
227   }
228
229   return 0;
230 }