]>
git.ipfire.org Git - people/ms/libloc.git/blob - src/network.c
2 libloc - A library to determine the location of someone on the Internet
4 Copyright (C) 2017 IPFire Development Team <info@ipfire.org>
6 This library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Lesser General Public
8 License as published by the Free Software Foundation; either
9 version 2.1 of the License, or (at your option) any later version.
11 This library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
17 #include <arpa/inet.h>
28 #include <libloc/libloc.h>
29 #include <libloc/compat.h>
30 #include <libloc/country.h>
31 #include <libloc/network.h>
32 #include <libloc/network-list.h>
33 #include <libloc/private.h>
40 struct in6_addr first_address
;
41 struct in6_addr last_address
;
46 enum loc_network_flags flags
;
49 static int valid_prefix(struct in6_addr
* address
, unsigned int prefix
) {
50 // The prefix cannot be larger than 128 bits
54 // And the prefix cannot be zero
58 // For IPv4-mapped addresses the prefix has to be 96 or lager
59 if (IN6_IS_ADDR_V4MAPPED(address
) && prefix
<= 96)
65 LOC_EXPORT
int loc_network_new(struct loc_ctx
* ctx
, struct loc_network
** network
,
66 struct in6_addr
* address
, unsigned int prefix
) {
67 // Address cannot be unspecified
68 if (IN6_IS_ADDR_UNSPECIFIED(address
)) {
69 DEBUG(ctx
, "Start address is unspecified\n");
73 // Address cannot be loopback
74 if (IN6_IS_ADDR_LOOPBACK(address
)) {
75 DEBUG(ctx
, "Start address is loopback address\n");
79 // Address cannot be link-local
80 if (IN6_IS_ADDR_LINKLOCAL(address
)) {
81 DEBUG(ctx
, "Start address cannot be link-local\n");
85 // Address cannot be site-local
86 if (IN6_IS_ADDR_SITELOCAL(address
)) {
87 DEBUG(ctx
, "Start address cannot be site-local\n");
91 // Validate the prefix
92 if (valid_prefix(address
, prefix
) != 0) {
93 DEBUG(ctx
, "Invalid prefix: %u\n", prefix
);
97 struct loc_network
* n
= calloc(1, sizeof(*n
));
101 n
->ctx
= loc_ref(ctx
);
107 // Convert the prefix into a bitmask
108 struct in6_addr bitmask
= loc_prefix_to_bitmask(n
->prefix
);
110 // Store the first and last address in the network
111 n
->first_address
= loc_address_and(address
, &bitmask
);
112 n
->last_address
= loc_address_or(&n
->first_address
, &bitmask
);
115 n
->family
= loc_address_family(&n
->first_address
);
117 DEBUG(n
->ctx
, "Network allocated at %p\n", n
);
122 LOC_EXPORT
int loc_network_new_from_string(struct loc_ctx
* ctx
, struct loc_network
** network
,
123 const char* address_string
) {
124 struct in6_addr first_address
;
126 unsigned int prefix
= 128;
129 DEBUG(ctx
, "Attempting to parse network %s\n", address_string
);
131 // Make a copy of the string to work on it
132 char* buffer
= strdup(address_string
);
133 address_string
= prefix_string
= buffer
;
135 // Split address and prefix
136 address_string
= strsep(&prefix_string
, "/");
138 DEBUG(ctx
, " Split into address = %s, prefix = %s\n", address_string
, prefix_string
);
141 r
= loc_parse_address(ctx
, address_string
, &first_address
);
143 DEBUG(ctx
, "The address could not be parsed\n");
147 // If a prefix was given, we will try to parse it
149 // Convert prefix to integer
150 prefix
= strtol(prefix_string
, NULL
, 10);
153 DEBUG(ctx
, "The prefix was not parsable: %s\n", prefix_string
);
157 // Map the prefix to IPv6 if needed
158 if (IN6_IS_ADDR_V4MAPPED(&first_address
))
163 // Free temporary buffer
166 // Exit if the parsing was unsuccessful
170 // Create a new network
171 return loc_network_new(ctx
, network
, &first_address
, prefix
);
174 LOC_EXPORT
struct loc_network
* loc_network_ref(struct loc_network
* network
) {
180 static void loc_network_free(struct loc_network
* network
) {
181 DEBUG(network
->ctx
, "Releasing network at %p\n", network
);
183 loc_unref(network
->ctx
);
187 LOC_EXPORT
struct loc_network
* loc_network_unref(struct loc_network
* network
) {
191 if (--network
->refcount
> 0)
194 loc_network_free(network
);
198 static int format_ipv6_address(const struct in6_addr
* address
, char* string
, size_t length
) {
199 const char* ret
= inet_ntop(AF_INET6
, address
, string
, length
);
206 static int format_ipv4_address(const struct in6_addr
* address
, char* string
, size_t length
) {
207 struct in_addr ipv4_address
;
208 ipv4_address
.s_addr
= address
->s6_addr32
[3];
210 const char* ret
= inet_ntop(AF_INET
, &ipv4_address
, string
, length
);
217 LOC_EXPORT
char* loc_network_str(struct loc_network
* network
) {
219 const size_t length
= INET6_ADDRSTRLEN
+ 4;
221 char* string
= malloc(length
);
225 unsigned int prefix
= network
->prefix
;
227 switch (network
->family
) {
229 r
= format_ipv6_address(&network
->first_address
, string
, length
);
233 r
= format_ipv4_address(&network
->first_address
, string
, length
);
243 ERROR(network
->ctx
, "Could not convert network to string: %s\n", strerror(errno
));
250 sprintf(string
+ strlen(string
), "/%u", prefix
);
255 LOC_EXPORT
int loc_network_address_family(struct loc_network
* network
) {
256 return network
->family
;
259 LOC_EXPORT
unsigned int loc_network_prefix(struct loc_network
* network
) {
260 switch (network
->family
) {
262 return network
->prefix
;
265 return network
->prefix
- 96;
271 static char* loc_network_format_address(struct loc_network
* network
, const struct in6_addr
* address
) {
272 const size_t length
= INET6_ADDRSTRLEN
;
274 char* string
= malloc(length
);
280 switch (network
->family
) {
282 r
= format_ipv6_address(address
, string
, length
);
286 r
= format_ipv4_address(address
, string
, length
);
295 ERROR(network
->ctx
, "Could not format IP address to string: %s\n", strerror(errno
));
304 LOC_EXPORT
const struct in6_addr
* loc_network_get_first_address(struct loc_network
* network
) {
305 return &network
->first_address
;
308 LOC_EXPORT
char* loc_network_format_first_address(struct loc_network
* network
) {
309 return loc_network_format_address(network
, &network
->first_address
);
312 LOC_EXPORT
const struct in6_addr
* loc_network_get_last_address(struct loc_network
* network
) {
313 return &network
->last_address
;
316 LOC_EXPORT
char* loc_network_format_last_address(struct loc_network
* network
) {
317 return loc_network_format_address(network
, &network
->last_address
);
320 LOC_EXPORT
int loc_network_matches_address(struct loc_network
* network
, const struct in6_addr
* address
) {
321 // Address must be larger than the start address
322 if (in6_addr_cmp(&network
->first_address
, address
) > 0)
325 // Address must be smaller than the last address
326 if (in6_addr_cmp(&network
->last_address
, address
) < 0)
329 // The address is inside this network
333 LOC_EXPORT
const char* loc_network_get_country_code(struct loc_network
* network
) {
334 return network
->country_code
;
337 LOC_EXPORT
int loc_network_set_country_code(struct loc_network
* network
, const char* country_code
) {
338 // Set empty country code
339 if (!country_code
|| !*country_code
) {
340 *network
->country_code
= '\0';
344 // Check country code
345 if (!loc_country_code_is_valid(country_code
))
348 loc_country_code_copy(network
->country_code
, country_code
);
353 LOC_EXPORT
int loc_network_matches_country_code(struct loc_network
* network
, const char* country_code
) {
354 // Search for any special flags
355 const int flag
= loc_country_special_code_to_flag(country_code
);
357 // If we found a flag, we will return whether it is set or not
359 return loc_network_has_flag(network
, flag
);
361 // Check country code
362 if (!loc_country_code_is_valid(country_code
))
365 // Check for an exact match
366 return (network
->country_code
[0] == country_code
[0])
367 && (network
->country_code
[1] == country_code
[1]);
370 LOC_EXPORT
uint32_t loc_network_get_asn(struct loc_network
* network
) {
374 LOC_EXPORT
int loc_network_set_asn(struct loc_network
* network
, uint32_t asn
) {
380 LOC_EXPORT
int loc_network_has_flag(struct loc_network
* network
, uint32_t flag
) {
381 return network
->flags
& flag
;
384 LOC_EXPORT
int loc_network_set_flag(struct loc_network
* network
, uint32_t flag
) {
385 network
->flags
|= flag
;
390 LOC_EXPORT
int loc_network_cmp(struct loc_network
* self
, struct loc_network
* other
) {
392 int r
= in6_addr_cmp(&self
->first_address
, &other
->first_address
);
397 if (self
->prefix
> other
->prefix
)
399 else if (self
->prefix
< other
->prefix
)
402 // Both networks are equal
406 LOC_EXPORT
int loc_network_overlaps(struct loc_network
* self
, struct loc_network
* other
) {
407 // Either of the start addresses must be in the other subnet
408 if (loc_network_matches_address(self
, &other
->first_address
))
411 if (loc_network_matches_address(other
, &self
->first_address
))
414 // Or either of the end addresses is in the other subnet
415 if (loc_network_matches_address(self
, &other
->last_address
))
418 if (loc_network_matches_address(other
, &self
->last_address
))
424 LOC_EXPORT
int loc_network_is_subnet(struct loc_network
* self
, struct loc_network
* other
) {
425 // The prefix must be smaller (this avoids the more complex comparisons later)
426 if (self
->prefix
> other
->prefix
)
429 // If the start address of the other network is smaller than this network,
430 // it cannot be a subnet.
431 if (in6_addr_cmp(&self
->first_address
, &other
->first_address
) > 0)
434 // If the end address of the other network is greater than this network,
435 // it cannot be a subnet.
436 if (in6_addr_cmp(&self
->last_address
, &other
->last_address
) < 0)
442 LOC_EXPORT
int loc_network_subnets(struct loc_network
* network
,
443 struct loc_network
** subnet1
, struct loc_network
** subnet2
) {
449 unsigned int prefix
= network
->prefix
+ 1;
451 // Check if the new prefix is valid
452 if (valid_prefix(&network
->first_address
, prefix
))
455 // Create the first half of the network
456 r
= loc_network_new(network
->ctx
, subnet1
, &network
->first_address
, prefix
);
460 // The next subnet starts after the first one
461 struct in6_addr first_address
= address_increment(&(*subnet1
)->last_address
);
463 // Create the second half of the network
464 r
= loc_network_new(network
->ctx
, subnet2
, &first_address
, prefix
);
469 const char* country_code
= loc_network_get_country_code(network
);
471 loc_network_set_country_code(*subnet1
, country_code
);
472 loc_network_set_country_code(*subnet2
, country_code
);
476 uint32_t asn
= loc_network_get_asn(network
);
478 loc_network_set_asn(*subnet1
, asn
);
479 loc_network_set_asn(*subnet2
, asn
);
483 loc_network_set_flag(*subnet1
, network
->flags
);
484 loc_network_set_flag(*subnet2
, network
->flags
);
489 static int __loc_network_exclude(struct loc_network
* network
,
490 struct loc_network
* other
, struct loc_network_list
* list
) {
491 struct loc_network
* subnet1
= NULL
;
492 struct loc_network
* subnet2
= NULL
;
494 int r
= loc_network_subnets(network
, &subnet1
, &subnet2
);
498 if (loc_network_cmp(other
, subnet1
) == 0) {
499 r
= loc_network_list_push(list
, subnet2
);
503 } else if (loc_network_cmp(other
, subnet2
) == 0) {
504 r
= loc_network_list_push(list
, subnet1
);
508 } else if (loc_network_is_subnet(subnet1
, other
)) {
509 r
= loc_network_list_push(list
, subnet2
);
513 r
= __loc_network_exclude(subnet1
, other
, list
);
517 } else if (loc_network_is_subnet(subnet2
, other
)) {
518 r
= loc_network_list_push(list
, subnet1
);
522 r
= __loc_network_exclude(subnet2
, other
, list
);
527 ERROR(network
->ctx
, "We should never get here\n");
534 loc_network_unref(subnet1
);
537 loc_network_unref(subnet2
);
542 static int __loc_network_exclude_to_list(struct loc_network
* self
,
543 struct loc_network
* other
, struct loc_network_list
* list
) {
544 // Other must be a subnet of self
545 if (!loc_network_is_subnet(self
, other
)) {
546 DEBUG(self
->ctx
, "Network %p is not contained in network %p\n", other
, self
);
552 // We cannot perform this operation if both networks equal
553 if (loc_network_cmp(self
, other
) == 0) {
554 DEBUG(self
->ctx
, "Networks %p and %p are equal\n", self
, other
);
560 return __loc_network_exclude(self
, other
, list
);
563 LOC_EXPORT
struct loc_network_list
* loc_network_exclude(
564 struct loc_network
* self
, struct loc_network
* other
) {
565 struct loc_network_list
* list
;
568 char* n1
= loc_network_str(self
);
569 char* n2
= loc_network_str(other
);
571 DEBUG(self
->ctx
, "Returning %s excluding %s...\n", n1
, n2
);
577 // Create a new list with the result
578 int r
= loc_network_list_new(self
->ctx
, &list
);
580 ERROR(self
->ctx
, "Could not create network list: %d\n", r
);
585 r
= __loc_network_exclude_to_list(self
, other
, list
);
587 loc_network_list_unref(list
);
596 LOC_EXPORT
struct loc_network_list
* loc_network_exclude_list(
597 struct loc_network
* network
, struct loc_network_list
* list
) {
598 struct loc_network_list
* to_check
;
600 // Create a new list with all networks to look at
601 int r
= loc_network_list_new(network
->ctx
, &to_check
);
605 struct loc_network
* subnet
= NULL
;
606 struct loc_network_list
* subnets
= NULL
;
608 for (unsigned int i
= 0; i
< loc_network_list_size(list
); i
++) {
609 subnet
= loc_network_list_get(list
, i
);
611 // Find all excluded networks
612 if (!loc_network_list_contains(to_check
, subnet
)) {
613 r
= __loc_network_exclude_to_list(network
, subnet
, to_check
);
615 loc_network_list_unref(to_check
);
616 loc_network_unref(subnet
);
623 loc_network_unref(subnet
);
626 r
= loc_network_list_new(network
->ctx
, &subnets
);
628 loc_network_list_unref(to_check
);
632 off_t smallest_subnet
= 0;
634 while (!loc_network_list_empty(to_check
)) {
635 struct loc_network
* subnet_to_check
= loc_network_list_pop_first(to_check
);
637 // Check whether the subnet to check is part of the input list
638 if (loc_network_list_contains(list
, subnet_to_check
)) {
639 loc_network_unref(subnet_to_check
);
643 // Marks whether this subnet passed all checks
646 for (unsigned int i
= smallest_subnet
; i
< loc_network_list_size(list
); i
++) {
647 subnet
= loc_network_list_get(list
, i
);
649 // Drop this subnet if is a subnet of another subnet
650 if (loc_network_is_subnet(subnet
, subnet_to_check
)) {
652 loc_network_unref(subnet
);
656 // Break it down if it overlaps
657 if (loc_network_overlaps(subnet
, subnet_to_check
)) {
660 __loc_network_exclude_to_list(subnet_to_check
, subnet
, to_check
);
662 loc_network_unref(subnet
);
666 // If the subnet is strictly greater, we do not need to continue the search
667 r
= loc_network_cmp(subnet
, subnet_to_check
);
669 loc_network_unref(subnet
);
672 // If it is strictly smaller, we can continue the search from here next
673 // time because all networks that are to be checked can only be larger
679 loc_network_unref(subnet
);
683 r
= loc_network_list_push(subnets
, subnet_to_check
);
686 loc_network_unref(subnet_to_check
);
689 loc_network_list_unref(to_check
);
694 int loc_network_to_database_v1(struct loc_network
* network
, struct loc_database_network_v1
* dbobj
) {
696 loc_country_code_copy(dbobj
->country_code
, network
->country_code
);
699 dbobj
->asn
= htobe32(network
->asn
);
702 dbobj
->flags
= htobe16(network
->flags
);
707 int loc_network_new_from_database_v1(struct loc_ctx
* ctx
, struct loc_network
** network
,
708 struct in6_addr
* address
, unsigned int prefix
, const struct loc_database_network_v1
* dbobj
) {
709 char country_code
[3] = "\0\0";
711 int r
= loc_network_new(ctx
, network
, address
, prefix
);
713 ERROR(ctx
, "Could not allocate a new network: %s", strerror(-r
));
717 // Import country code
718 loc_country_code_copy(country_code
, dbobj
->country_code
);
720 r
= loc_network_set_country_code(*network
, country_code
);
722 ERROR(ctx
, "Could not set country code: %s\n", country_code
);
727 uint32_t asn
= be32toh(dbobj
->asn
);
728 r
= loc_network_set_asn(*network
, asn
);
730 ERROR(ctx
, "Could not set ASN: %d\n", asn
);
735 int flags
= be16toh(dbobj
->flags
);
736 r
= loc_network_set_flag(*network
, flags
);
738 ERROR(ctx
, "Could not set flags: %d\n", flags
);
745 struct loc_network_tree
{
749 struct loc_network_tree_node
* root
;
752 struct loc_network_tree_node
{
756 struct loc_network_tree_node
* zero
;
757 struct loc_network_tree_node
* one
;
759 struct loc_network
* network
;
762 int loc_network_tree_new(struct loc_ctx
* ctx
, struct loc_network_tree
** tree
) {
763 struct loc_network_tree
* t
= calloc(1, sizeof(*t
));
767 t
->ctx
= loc_ref(ctx
);
770 // Create the root node
771 int r
= loc_network_tree_node_new(ctx
, &t
->root
);
773 loc_network_tree_unref(t
);
777 DEBUG(t
->ctx
, "Network tree allocated at %p\n", t
);
782 struct loc_network_tree_node
* loc_network_tree_get_root(struct loc_network_tree
* tree
) {
783 return loc_network_tree_node_ref(tree
->root
);
786 static struct loc_network_tree_node
* loc_network_tree_get_node(struct loc_network_tree_node
* node
, int path
) {
787 struct loc_network_tree_node
** n
;
794 // If the desired node doesn't exist, yet, we will create it
796 int r
= loc_network_tree_node_new(node
->ctx
, n
);
804 static struct loc_network_tree_node
* loc_network_tree_get_path(struct loc_network_tree
* tree
, const struct in6_addr
* address
, unsigned int prefix
) {
805 struct loc_network_tree_node
* node
= tree
->root
;
807 for (unsigned int i
= 0; i
< prefix
; i
++) {
808 // Check if the ith bit is one or zero
809 node
= loc_network_tree_get_node(node
, in6_addr_get_bit(address
, i
));
815 static int __loc_network_tree_walk(struct loc_ctx
* ctx
, struct loc_network_tree_node
* node
,
816 int(*filter_callback
)(struct loc_network
* network
, void* data
),
817 int(*callback
)(struct loc_network
* network
, void* data
), void* data
) {
820 // Finding a network ends the walk here
822 if (filter_callback
) {
823 int f
= filter_callback(node
->network
, data
);
827 // Skip network if filter function returns value greater than zero
832 r
= callback(node
->network
, data
);
837 // Walk down on the left side of the tree first
839 r
= __loc_network_tree_walk(ctx
, node
->zero
, filter_callback
, callback
, data
);
844 // Then walk on the other side
846 r
= __loc_network_tree_walk(ctx
, node
->one
, filter_callback
, callback
, data
);
854 int loc_network_tree_walk(struct loc_network_tree
* tree
,
855 int(*filter_callback
)(struct loc_network
* network
, void* data
),
856 int(*callback
)(struct loc_network
* network
, void* data
), void* data
) {
857 return __loc_network_tree_walk(tree
->ctx
, tree
->root
, filter_callback
, callback
, data
);
860 static void loc_network_tree_free(struct loc_network_tree
* tree
) {
861 DEBUG(tree
->ctx
, "Releasing network tree at %p\n", tree
);
863 loc_network_tree_node_unref(tree
->root
);
865 loc_unref(tree
->ctx
);
869 struct loc_network_tree
* loc_network_tree_unref(struct loc_network_tree
* tree
) {
870 if (--tree
->refcount
> 0)
873 loc_network_tree_free(tree
);
877 static int __loc_network_tree_dump(struct loc_network
* network
, void* data
) {
878 DEBUG(network
->ctx
, "Dumping network at %p\n", network
);
880 char* s
= loc_network_str(network
);
884 INFO(network
->ctx
, "%s\n", s
);
890 int loc_network_tree_dump(struct loc_network_tree
* tree
) {
891 DEBUG(tree
->ctx
, "Dumping network tree at %p\n", tree
);
893 return loc_network_tree_walk(tree
, NULL
, __loc_network_tree_dump
, NULL
);
896 int loc_network_tree_add_network(struct loc_network_tree
* tree
, struct loc_network
* network
) {
897 DEBUG(tree
->ctx
, "Adding network %p to tree %p\n", network
, tree
);
899 struct loc_network_tree_node
* node
= loc_network_tree_get_path(tree
,
900 &network
->first_address
, network
->prefix
);
902 ERROR(tree
->ctx
, "Could not find a node\n");
906 // Check if node has not been set before
908 DEBUG(tree
->ctx
, "There is already a network at this path\n");
912 // Point node to the network
913 node
->network
= loc_network_ref(network
);
918 static int __loc_network_tree_count(struct loc_network
* network
, void* data
) {
919 size_t* counter
= (size_t*)data
;
921 // Increase the counter for each network
927 size_t loc_network_tree_count_networks(struct loc_network_tree
* tree
) {
930 int r
= loc_network_tree_walk(tree
, NULL
, __loc_network_tree_count
, &counter
);
937 static size_t __loc_network_tree_count_nodes(struct loc_network_tree_node
* node
) {
941 counter
+= __loc_network_tree_count_nodes(node
->zero
);
944 counter
+= __loc_network_tree_count_nodes(node
->one
);
949 size_t loc_network_tree_count_nodes(struct loc_network_tree
* tree
) {
950 return __loc_network_tree_count_nodes(tree
->root
);
953 int loc_network_tree_node_new(struct loc_ctx
* ctx
, struct loc_network_tree_node
** node
) {
954 struct loc_network_tree_node
* n
= calloc(1, sizeof(*n
));
958 n
->ctx
= loc_ref(ctx
);
961 n
->zero
= n
->one
= NULL
;
963 DEBUG(n
->ctx
, "Network node allocated at %p\n", n
);
968 struct loc_network_tree_node
* loc_network_tree_node_ref(struct loc_network_tree_node
* node
) {
975 static void loc_network_tree_node_free(struct loc_network_tree_node
* node
) {
976 DEBUG(node
->ctx
, "Releasing network node at %p\n", node
);
979 loc_network_unref(node
->network
);
982 loc_network_tree_node_unref(node
->zero
);
985 loc_network_tree_node_unref(node
->one
);
987 loc_unref(node
->ctx
);
991 struct loc_network_tree_node
* loc_network_tree_node_unref(struct loc_network_tree_node
* node
) {
995 if (--node
->refcount
> 0)
998 loc_network_tree_node_free(node
);
1002 struct loc_network_tree_node
* loc_network_tree_node_get(struct loc_network_tree_node
* node
, unsigned int index
) {
1011 return loc_network_tree_node_ref(node
);
1014 int loc_network_tree_node_is_leaf(struct loc_network_tree_node
* node
) {
1015 return (!!node
->network
);
1018 struct loc_network
* loc_network_tree_node_get_network(struct loc_network_tree_node
* node
) {
1019 return loc_network_ref(node
->network
);