594df1a0526cc9d75994b05adbc451bbac4b53ff
[samba.git] / source4 / lib / socket / interface.c
1 /* 
2    Unix SMB/CIFS implementation.
3
4    multiple interface handling
5
6    Copyright (C) Andrew Tridgell 1992-2005
7    
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3 of the License, or
11    (at your option) any later version.
12    
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17    
18    You should have received a copy of the GNU General Public License
19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
20 */
21
22 #include "includes.h"
23 #include "system/network.h"
24 #include "param/param.h"
25 #include "lib/socket/netif.h"
26 #include "../lib/util/util_net.h"
27 #include "../lib/util/dlinklist.h"
28
29 /* used for network interfaces */
30 struct interface {
31         struct interface *next, *prev;
32         char *name;
33         int flags;
34         struct sockaddr_storage ip;
35         struct sockaddr_storage netmask;
36         struct sockaddr_storage bcast;
37         const char *ip_s;
38         const char *bcast_s;
39         const char *nmask_s;
40 };
41
42 #define ALLONES  ((uint32_t)0xFFFFFFFF)
43 /*
44   address construction based on a patch from fred@datalync.com
45 */
46 #define MKBCADDR(_IP, _NM) ((_IP & _NM) | (_NM ^ ALLONES))
47 #define MKNETADDR(_IP, _NM) (_IP & _NM)
48
49 /****************************************************************************
50 Try and find an interface that matches an ip. If we cannot, return NULL
51   **************************************************************************/
52 static struct interface *iface_list_find(struct interface *interfaces,
53                                          const struct sockaddr *ip,
54                                          bool check_mask)
55 {
56         struct interface *i;
57
58         if (is_address_any(ip)) {
59                 return interfaces;
60         }
61
62         for (i=interfaces;i;i=i->next) {
63                 if (check_mask) {
64                         if (same_net(ip, (struct sockaddr *)&i->ip, (struct sockaddr *)&i->netmask)) {
65                                 return i;
66                         }
67                 } else if (sockaddr_equal((struct sockaddr *)&i->ip, ip)) {
68                         return i;
69                 }
70         }
71
72         return NULL;
73 }
74
75 /****************************************************************************
76 add an interface to the linked list of interfaces
77 ****************************************************************************/
78 static void add_interface(TALLOC_CTX *mem_ctx, const struct iface_struct *ifs, struct interface **interfaces)
79 {
80         char addr[INET6_ADDRSTRLEN];
81         struct interface *iface;
82
83         if (iface_list_find(*interfaces, (const struct sockaddr *)&ifs->ip, false)) {
84                 DEBUG(3,("add_interface: not adding duplicate interface %s\n",
85                         print_sockaddr(addr, sizeof(addr), &ifs->ip) ));
86                 return;
87         }
88
89         if (ifs->ip.ss_family == AF_INET &&
90                 !(ifs->flags & (IFF_BROADCAST|IFF_LOOPBACK))) {
91                 DEBUG(3,("not adding non-broadcast interface %s\n",
92                                         ifs->name ));
93                 return;
94         }
95
96         iface = talloc(*interfaces == NULL ? mem_ctx : *interfaces, struct interface);
97         if (iface == NULL) 
98                 return;
99         
100         ZERO_STRUCTPN(iface);
101
102         iface->name = talloc_strdup(iface, ifs->name);
103         if (!iface->name) {
104                 SAFE_FREE(iface);
105                 return;
106         }
107         iface->flags = ifs->flags;
108         iface->ip = ifs->ip;
109         iface->netmask = ifs->netmask;
110         iface->bcast = ifs->bcast;
111
112         /* keep string versions too, to avoid people tripping over the implied
113            static in inet_ntoa() */
114         print_sockaddr(addr, sizeof(addr), &iface->ip);
115         DEBUG(4,("added interface %s ip=%s ",
116                  iface->name, addr));
117         iface->ip_s = talloc_strdup(iface, addr);
118
119         print_sockaddr(addr, sizeof(addr),
120                        &iface->bcast);
121         DEBUG(4,("bcast=%s ", addr));
122         iface->bcast_s = talloc_strdup(iface, addr);
123
124         print_sockaddr(addr, sizeof(addr),
125                        &iface->netmask);
126         DEBUG(4,("netmask=%s\n", addr));
127         iface->nmask_s = talloc_strdup(iface, addr);
128
129         /*
130            this needs to be a ADD_END, as some tests (such as the
131            spoolss notify test) depend on the interfaces ordering
132         */
133         DLIST_ADD_END(*interfaces, iface);
134 }
135
136 /**
137 interpret a single element from a interfaces= config line 
138
139 This handles the following different forms:
140
141 1) wildcard interface name
142 2) DNS name
143 3) IP/masklen
144 4) ip/mask
145 5) bcast/mask
146 **/
147 static void interpret_interface(TALLOC_CTX *mem_ctx, 
148                                 const char *token, 
149                                 struct iface_struct *probed_ifaces, 
150                                 int total_probed,
151                                 struct interface **local_interfaces)
152 {
153         struct sockaddr_storage ss;
154         struct sockaddr_storage ss_mask;
155         struct sockaddr_storage ss_net;
156         struct sockaddr_storage ss_bcast;
157         struct iface_struct ifs;
158         char *p;
159         int i;
160         bool added=false;
161         bool goodaddr = false;
162
163         /* first check if it is an interface name */
164         for (i=0;i<total_probed;i++) {
165                 if (gen_fnmatch(token, probed_ifaces[i].name) == 0) {
166                         add_interface(mem_ctx, &probed_ifaces[i],
167                                       local_interfaces);
168                         added = true;
169                 }
170         }
171         if (added) {
172                 return;
173         }
174
175         p = strchr_m(token, ';');
176         if (p != NULL) {
177                 /*
178                  * skip smbd-specific extra data:
179                  * link speed, capabilities, and interface index
180                  */
181                 *p = 0;
182         }
183
184         /* maybe it is a DNS name */
185         p = strchr_m(token,'/');
186         if (p == NULL) {
187                 if (!interpret_string_addr(&ss, token, 0)) {
188                         DEBUG(2, ("interpret_interface: Can't find address "
189                                   "for %s\n", token));
190                         return;
191                 }
192
193                 for (i=0;i<total_probed;i++) {
194                         if (sockaddr_equal((struct sockaddr *)&ss, (struct sockaddr *)&probed_ifaces[i].ip)) {
195                                 add_interface(mem_ctx, &probed_ifaces[i],
196                                               local_interfaces);
197                                 return;
198                         }
199                 }
200                 DEBUG(2,("interpret_interface: "
201                         "can't determine interface for %s\n",
202                         token));
203                 return;
204         }
205
206         /* parse it into an IP address/netmasklength pair */
207         *p = 0;
208         goodaddr = interpret_string_addr(&ss, token, 0);
209         *p++ = '/';
210
211         if (!goodaddr) {
212                 DEBUG(2,("interpret_interface: "
213                         "can't determine interface for %s\n",
214                         token));
215                 return;
216         }
217
218         if (strlen(p) > 2) {
219                 goodaddr = interpret_string_addr(&ss_mask, p, 0);
220                 if (!goodaddr) {
221                         DEBUG(2,("interpret_interface: "
222                                 "can't determine netmask from %s\n",
223                                 p));
224                         return;
225                 }
226         } else {
227                 char *endp = NULL;
228                 unsigned long val = strtoul(p, &endp, 0);
229                 if (p == endp || (endp && *endp != '\0')) {
230                         DEBUG(2,("interpret_interface: "
231                                 "can't determine netmask value from %s\n",
232                                 p));
233                         return;
234                 }
235                 if (!make_netmask(&ss_mask, &ss, val)) {
236                         DEBUG(2,("interpret_interface: "
237                                 "can't apply netmask value %lu from %s\n",
238                                 val,
239                                 p));
240                         return;
241                 }
242         }
243
244         make_bcast(&ss_bcast, &ss, &ss_mask);
245         make_net(&ss_net, &ss, &ss_mask);
246
247         /* Maybe the first component was a broadcast address. */
248         if (sockaddr_equal((struct sockaddr *)&ss_bcast, (struct sockaddr *)&ss) ||
249                 sockaddr_equal((struct sockaddr *)&ss_net, (struct sockaddr *)&ss)) {
250                 for (i=0;i<total_probed;i++) {
251                         if (same_net((struct sockaddr *)&ss,
252                                                  (struct sockaddr *)&probed_ifaces[i].ip,
253                                                  (struct sockaddr *)&ss_mask)) {
254                                 /* Temporarily replace netmask on
255                                  * the detected interface - user knows
256                                  * best.... */
257                                 struct sockaddr_storage saved_mask =
258                                         probed_ifaces[i].netmask;
259                                 probed_ifaces[i].netmask = ss_mask;
260                                 DEBUG(2,("interpret_interface: "
261                                         "using netmask value %s from "
262                                         "config file on interface %s\n",
263                                         p,
264                                         probed_ifaces[i].name));
265                                 add_interface(mem_ctx, &probed_ifaces[i],
266                                               local_interfaces);
267                                 probed_ifaces[i].netmask = saved_mask;
268                                 return;
269                         }
270                 }
271                 DEBUG(2,("interpret_interface: Can't determine ip for "
272                         "broadcast address %s\n",
273                         token));
274                 return;
275         }
276
277         /* Just fake up the interface definition. User knows best. */
278
279         DEBUG(2,("interpret_interface: Adding interface %s\n",
280                 token));
281
282         ZERO_STRUCT(ifs);
283         (void)strlcpy(ifs.name, token, sizeof(ifs.name));
284         ifs.flags = IFF_BROADCAST;
285         ifs.ip = ss;
286         ifs.netmask = ss_mask;
287         ifs.bcast = ss_bcast;
288         add_interface(mem_ctx, &ifs, local_interfaces);
289 }
290
291
292 /**
293 load the list of network interfaces
294 **/
295 void load_interface_list(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx, struct interface **local_interfaces)
296 {
297         const char **ptr = lpcfg_interfaces(lp_ctx);
298         int i;
299         struct iface_struct *ifaces = NULL;
300         int total_probed;
301
302         *local_interfaces = NULL;
303
304         /* probe the kernel for interfaces */
305         total_probed = get_interfaces(mem_ctx, &ifaces);
306
307         /* if we don't have a interfaces line then use all interfaces
308            except loopback */
309         if (!ptr || !*ptr || !**ptr) {
310                 if (total_probed <= 0) {
311                         DEBUG(0,("ERROR: Could not determine network interfaces, you must use a interfaces config line\n"));
312                 }
313                 for (i=0;i<total_probed;i++) {
314                         if (!is_loopback_addr((struct sockaddr *)&ifaces[i].ip)) {
315                                 add_interface(mem_ctx, &ifaces[i], local_interfaces);
316                         }
317                 }
318         }
319
320         while (ptr && *ptr) {
321                 interpret_interface(mem_ctx, *ptr, ifaces, total_probed, local_interfaces);
322                 ptr++;
323         }
324
325         if (!*local_interfaces) {
326                 DEBUG(0,("WARNING: no network interfaces found\n"));
327         }
328         talloc_free(ifaces);
329 }
330
331 /**
332   how many interfaces do we have
333   **/
334 int iface_list_count(struct interface *ifaces)
335 {
336         int ret = 0;
337         struct interface *i;
338
339         for (i=ifaces;i;i=i->next)
340                 ret++;
341         return ret;
342 }
343
344 /**
345   return IP of the Nth interface
346   **/
347 const char *iface_list_n_ip(struct interface *ifaces, int n)
348 {
349         struct interface *i;
350   
351         for (i=ifaces;i && n;i=i->next)
352                 n--;
353
354         if (i) {
355                 return i->ip_s;
356         }
357         return NULL;
358 }
359
360
361 /**
362   return the first IPv4 interface address we have registered
363   **/
364 const char *iface_list_first_v4(struct interface *ifaces)
365 {
366         struct interface *i;
367
368         for (i=ifaces; i; i=i->next) {
369                 if (i->ip.ss_family == AF_INET) {
370                         return i->ip_s;
371                 }
372         }
373         return NULL;
374 }
375
376 /**
377   return the first IPv6 interface address we have registered
378   **/
379 static const char *iface_list_first_v6(struct interface *ifaces)
380 {
381         struct interface *i;
382
383 #ifdef HAVE_IPV6
384         for (i=ifaces; i; i=i->next) {
385                 if (i->ip.ss_family == AF_INET6) {
386                         return i->ip_s;
387                 }
388         }
389 #endif
390         return NULL;
391 }
392
393 /**
394    check if an interface is IPv4
395   **/
396 bool iface_list_n_is_v4(struct interface *ifaces, int n)
397 {
398         struct interface *i;
399
400         for (i=ifaces;i && n;i=i->next)
401                 n--;
402
403         if (i) {
404                 return i->ip.ss_family == AF_INET;
405         }
406         return false;
407 }
408
409 /**
410   return bcast of the Nth interface
411   **/
412 const char *iface_list_n_bcast(struct interface *ifaces, int n)
413 {
414         struct interface *i;
415   
416         for (i=ifaces;i && n;i=i->next)
417                 n--;
418
419         if (i) {
420                 return i->bcast_s;
421         }
422         return NULL;
423 }
424
425 /**
426   return netmask of the Nth interface
427   **/
428 const char *iface_list_n_netmask(struct interface *ifaces, int n)
429 {
430         struct interface *i;
431   
432         for (i=ifaces;i && n;i=i->next)
433                 n--;
434
435         if (i) {
436                 return i->nmask_s;
437         }
438         return NULL;
439 }
440
441 /**
442   return the local IP address that best matches a destination IP, or
443   our first interface if none match
444 */
445 const char *iface_list_best_ip(struct interface *ifaces, const char *dest)
446 {
447         struct interface *iface;
448         struct sockaddr_storage ss;
449
450         if (!interpret_string_addr(&ss, dest, AI_NUMERICHOST)) {
451                 return iface_list_n_ip(ifaces, 0);
452         }
453         iface = iface_list_find(ifaces, (const struct sockaddr *)&ss, true);
454         if (iface) {
455                 return iface->ip_s;
456         }
457 #ifdef HAVE_IPV6
458         if (ss.ss_family == AF_INET6) {
459                 return iface_list_first_v6(ifaces);
460         }
461 #endif
462         return iface_list_first_v4(ifaces);
463 }
464
465 /**
466   return true if an IP is one one of our local networks
467 */
468 bool iface_list_is_local(struct interface *ifaces, const char *dest)
469 {
470         struct sockaddr_storage ss;
471
472         if (!interpret_string_addr(&ss, dest, AI_NUMERICHOST)) {
473                 return false;
474         }
475         if (iface_list_find(ifaces, (const struct sockaddr *)&ss, true)) {
476                 return true;
477         }
478         return false;
479 }
480
481 /**
482   return true if a IP matches a IP/netmask pair
483 */
484 bool iface_list_same_net(const char *ip1, const char *ip2, const char *netmask)
485 {
486         struct sockaddr_storage ip1_ss, ip2_ss, nm_ss;
487
488         if (!interpret_string_addr(&ip1_ss, ip1, AI_NUMERICHOST)) {
489                 return false;
490         }
491         if (!interpret_string_addr(&ip2_ss, ip2, AI_NUMERICHOST)) {
492                 return false;
493         }
494         if (!interpret_string_addr(&nm_ss, netmask, AI_NUMERICHOST)) {
495                 return false;
496         }
497
498         return same_net((struct sockaddr *)&ip1_ss,
499                         (struct sockaddr *)&ip2_ss,
500                         (struct sockaddr *)&nm_ss);
501 }
502
503 /**
504    return the list of wildcard interfaces
505    this will include the IPv4 0.0.0.0, and may include IPv6 ::
506 */
507 char **iface_list_wildcard(TALLOC_CTX *mem_ctx)
508 {
509         char **ret;
510 #ifdef HAVE_IPV6
511         ret = str_list_make(mem_ctx, "::,0.0.0.0", NULL);
512 #else
513         ret = str_list_make(mem_ctx, "0.0.0.0", NULL);
514 #endif
515         return ret;
516 }