]>
git.ipfire.org Git - location/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/address.h>
30 #include <libloc/compat.h>
31 #include <libloc/country.h>
32 #include <libloc/network.h>
33 #include <libloc/network-list.h>
34 #include <libloc/private.h>
41 struct in6_addr first_address
;
42 struct in6_addr last_address
;
47 enum loc_network_flags flags
;
49 char string
[INET6_ADDRSTRLEN
+ 4];
52 LOC_EXPORT
int loc_network_new(struct loc_ctx
* ctx
, struct loc_network
** network
,
53 struct in6_addr
* address
, unsigned int prefix
) {
54 // Validate the prefix
55 if (!loc_address_valid_prefix(address
, prefix
)) {
56 ERROR(ctx
, "Invalid prefix: %u\n", prefix
);
61 struct loc_network
* n
= calloc(1, sizeof(*n
));
67 n
->ctx
= loc_ref(ctx
);
71 if (IN6_IS_ADDR_V4MAPPED(address
))
72 n
->prefix
= prefix
+ 96;
76 // Convert the prefix into a bitmask
77 struct in6_addr bitmask
= loc_prefix_to_bitmask(n
->prefix
);
79 // Store the first and last address in the network
80 n
->first_address
= loc_address_and(address
, &bitmask
);
81 n
->last_address
= loc_address_or(&n
->first_address
, &bitmask
);
84 n
->family
= loc_address_family(&n
->first_address
);
86 DEBUG(n
->ctx
, "Network allocated at %p\n", n
);
91 LOC_EXPORT
int loc_network_new_from_string(struct loc_ctx
* ctx
, struct loc_network
** network
,
92 const char* address_string
) {
93 struct in6_addr first_address
;
95 unsigned int prefix
= 128;
98 DEBUG(ctx
, "Attempting to parse network %s\n", address_string
);
100 // Make a copy of the string to work on it
101 char* buffer
= strdup(address_string
);
102 address_string
= prefix_string
= buffer
;
104 // Split address and prefix
105 address_string
= strsep(&prefix_string
, "/");
107 DEBUG(ctx
, " Split into address = %s, prefix = %s\n", address_string
, prefix_string
);
110 r
= loc_parse_address(ctx
, address_string
, &first_address
);
112 DEBUG(ctx
, "The address could not be parsed\n");
116 // If a prefix was given, we will try to parse it
118 // Convert prefix to integer
119 prefix
= strtol(prefix_string
, NULL
, 10);
122 DEBUG(ctx
, "The prefix was not parsable: %s\n", prefix_string
);
128 // Free temporary buffer
131 // Exit if the parsing was unsuccessful
135 // Create a new network
136 return loc_network_new(ctx
, network
, &first_address
, prefix
);
139 LOC_EXPORT
struct loc_network
* loc_network_ref(struct loc_network
* network
) {
145 static void loc_network_free(struct loc_network
* network
) {
146 DEBUG(network
->ctx
, "Releasing network at %p\n", network
);
148 loc_unref(network
->ctx
);
152 LOC_EXPORT
struct loc_network
* loc_network_unref(struct loc_network
* network
) {
156 if (--network
->refcount
> 0)
159 loc_network_free(network
);
163 LOC_EXPORT
const char* loc_network_str(struct loc_network
* network
) {
164 if (!*network
->string
) {
165 // Format the address
166 const char* address
= loc_address_str(&network
->first_address
);
171 unsigned int prefix
= loc_network_prefix(network
);
174 int r
= snprintf(network
->string
, sizeof(network
->string
) - 1,
175 "%s/%u", address
, prefix
);
177 ERROR(network
->ctx
, "Could not format network string: %m\n");
178 *network
->string
= '\0';
183 return network
->string
;
186 LOC_EXPORT
int loc_network_address_family(struct loc_network
* network
) {
187 return network
->family
;
190 LOC_EXPORT
unsigned int loc_network_prefix(struct loc_network
* network
) {
191 switch (network
->family
) {
193 return network
->prefix
;
196 return network
->prefix
- 96;
202 LOC_EXPORT
const struct in6_addr
* loc_network_get_first_address(struct loc_network
* network
) {
203 return &network
->first_address
;
206 LOC_EXPORT
const char* loc_network_format_first_address(struct loc_network
* network
) {
207 return loc_address_str(&network
->first_address
);
210 LOC_EXPORT
const struct in6_addr
* loc_network_get_last_address(struct loc_network
* network
) {
211 return &network
->last_address
;
214 LOC_EXPORT
const char* loc_network_format_last_address(struct loc_network
* network
) {
215 return loc_address_str(&network
->last_address
);
218 LOC_EXPORT
int loc_network_matches_address(struct loc_network
* network
, const struct in6_addr
* address
) {
219 // Address must be larger than the start address
220 if (loc_address_cmp(&network
->first_address
, address
) > 0)
223 // Address must be smaller than the last address
224 if (loc_address_cmp(&network
->last_address
, address
) < 0)
227 // The address is inside this network
231 LOC_EXPORT
const char* loc_network_get_country_code(struct loc_network
* network
) {
232 return network
->country_code
;
235 LOC_EXPORT
int loc_network_set_country_code(struct loc_network
* network
, const char* country_code
) {
236 // Set empty country code
237 if (!country_code
|| !*country_code
) {
238 *network
->country_code
= '\0';
242 // Check country code
243 if (!loc_country_code_is_valid(country_code
))
246 loc_country_code_copy(network
->country_code
, country_code
);
251 LOC_EXPORT
int loc_network_matches_country_code(struct loc_network
* network
, const char* country_code
) {
252 // Search for any special flags
253 const int flag
= loc_country_special_code_to_flag(country_code
);
255 // If we found a flag, we will return whether it is set or not
257 return loc_network_has_flag(network
, flag
);
259 // Check country code
260 if (!loc_country_code_is_valid(country_code
))
263 // Check for an exact match
264 return (network
->country_code
[0] == country_code
[0])
265 && (network
->country_code
[1] == country_code
[1]);
268 LOC_EXPORT
uint32_t loc_network_get_asn(struct loc_network
* network
) {
272 LOC_EXPORT
int loc_network_set_asn(struct loc_network
* network
, uint32_t asn
) {
278 LOC_EXPORT
int loc_network_has_flag(struct loc_network
* network
, uint32_t flag
) {
279 return network
->flags
& flag
;
282 LOC_EXPORT
int loc_network_set_flag(struct loc_network
* network
, uint32_t flag
) {
283 network
->flags
|= flag
;
288 LOC_EXPORT
int loc_network_cmp(struct loc_network
* self
, struct loc_network
* other
) {
290 int r
= loc_address_cmp(&self
->first_address
, &other
->first_address
);
295 if (self
->prefix
> other
->prefix
)
297 else if (self
->prefix
< other
->prefix
)
300 // Both networks are equal
304 LOC_EXPORT
int loc_network_overlaps(struct loc_network
* self
, struct loc_network
* other
) {
305 // Either of the start addresses must be in the other subnet
306 if (loc_network_matches_address(self
, &other
->first_address
))
309 if (loc_network_matches_address(other
, &self
->first_address
))
312 // Or either of the end addresses is in the other subnet
313 if (loc_network_matches_address(self
, &other
->last_address
))
316 if (loc_network_matches_address(other
, &self
->last_address
))
322 LOC_EXPORT
int loc_network_is_subnet(struct loc_network
* self
, struct loc_network
* other
) {
323 // The prefix must be smaller (this avoids the more complex comparisons later)
324 if (self
->prefix
> other
->prefix
)
327 // If the start address of the other network is smaller than this network,
328 // it cannot be a subnet.
329 if (loc_address_cmp(&self
->first_address
, &other
->first_address
) > 0)
332 // If the end address of the other network is greater than this network,
333 // it cannot be a subnet.
334 if (loc_address_cmp(&self
->last_address
, &other
->last_address
) < 0)
340 LOC_EXPORT
int loc_network_subnets(struct loc_network
* network
,
341 struct loc_network
** subnet1
, struct loc_network
** subnet2
) {
347 unsigned int prefix
= network
->prefix
+ 1;
349 // Check if the new prefix is valid
350 if (!loc_address_valid_prefix(&network
->first_address
, prefix
))
353 // Create the first half of the network
354 r
= loc_network_new(network
->ctx
, subnet1
, &network
->first_address
, prefix
);
358 // The next subnet starts after the first one
359 struct in6_addr first_address
= (*subnet1
)->last_address
;
360 loc_address_increment(&first_address
);
362 // Create the second half of the network
363 r
= loc_network_new(network
->ctx
, subnet2
, &first_address
, prefix
);
368 const char* country_code
= loc_network_get_country_code(network
);
370 loc_network_set_country_code(*subnet1
, country_code
);
371 loc_network_set_country_code(*subnet2
, country_code
);
375 uint32_t asn
= loc_network_get_asn(network
);
377 loc_network_set_asn(*subnet1
, asn
);
378 loc_network_set_asn(*subnet2
, asn
);
382 loc_network_set_flag(*subnet1
, network
->flags
);
383 loc_network_set_flag(*subnet2
, network
->flags
);
388 static int __loc_network_exclude(struct loc_network
* network
,
389 struct loc_network
* other
, struct loc_network_list
* list
) {
390 struct loc_network
* subnet1
= NULL
;
391 struct loc_network
* subnet2
= NULL
;
393 int r
= loc_network_subnets(network
, &subnet1
, &subnet2
);
397 if (loc_network_cmp(other
, subnet1
) == 0) {
398 r
= loc_network_list_push(list
, subnet2
);
402 } else if (loc_network_cmp(other
, subnet2
) == 0) {
403 r
= loc_network_list_push(list
, subnet1
);
407 } else if (loc_network_is_subnet(subnet1
, other
)) {
408 r
= loc_network_list_push(list
, subnet2
);
412 r
= __loc_network_exclude(subnet1
, other
, list
);
416 } else if (loc_network_is_subnet(subnet2
, other
)) {
417 r
= loc_network_list_push(list
, subnet1
);
421 r
= __loc_network_exclude(subnet2
, other
, list
);
426 ERROR(network
->ctx
, "We should never get here\n");
433 loc_network_unref(subnet1
);
436 loc_network_unref(subnet2
);
441 static int __loc_network_exclude_to_list(struct loc_network
* self
,
442 struct loc_network
* other
, struct loc_network_list
* list
) {
443 // Other must be a subnet of self
444 if (!loc_network_is_subnet(self
, other
)) {
445 DEBUG(self
->ctx
, "Network %p is not contained in network %p\n", other
, self
);
451 // We cannot perform this operation if both networks equal
452 if (loc_network_cmp(self
, other
) == 0) {
453 DEBUG(self
->ctx
, "Networks %p and %p are equal\n", self
, other
);
459 return __loc_network_exclude(self
, other
, list
);
462 LOC_EXPORT
struct loc_network_list
* loc_network_exclude(
463 struct loc_network
* self
, struct loc_network
* other
) {
464 struct loc_network_list
* list
;
466 DEBUG(self
->ctx
, "Returning %s excluding %s...\n",
467 loc_network_str(self
), loc_network_str(other
));
469 // Create a new list with the result
470 int r
= loc_network_list_new(self
->ctx
, &list
);
472 ERROR(self
->ctx
, "Could not create network list: %d\n", r
);
477 r
= __loc_network_exclude_to_list(self
, other
, list
);
479 loc_network_list_unref(list
);
488 LOC_EXPORT
struct loc_network_list
* loc_network_exclude_list(
489 struct loc_network
* network
, struct loc_network_list
* list
) {
490 struct loc_network_list
* to_check
;
492 // Create a new list with all networks to look at
493 int r
= loc_network_list_new(network
->ctx
, &to_check
);
497 struct loc_network
* subnet
= NULL
;
498 struct loc_network_list
* subnets
= NULL
;
500 for (unsigned int i
= 0; i
< loc_network_list_size(list
); i
++) {
501 subnet
= loc_network_list_get(list
, i
);
503 // Find all excluded networks
504 if (!loc_network_list_contains(to_check
, subnet
)) {
505 r
= __loc_network_exclude_to_list(network
, subnet
, to_check
);
507 loc_network_list_unref(to_check
);
508 loc_network_unref(subnet
);
515 loc_network_unref(subnet
);
518 r
= loc_network_list_new(network
->ctx
, &subnets
);
520 loc_network_list_unref(to_check
);
524 off_t smallest_subnet
= 0;
526 while (!loc_network_list_empty(to_check
)) {
527 struct loc_network
* subnet_to_check
= loc_network_list_pop_first(to_check
);
529 // Check whether the subnet to check is part of the input list
530 if (loc_network_list_contains(list
, subnet_to_check
)) {
531 loc_network_unref(subnet_to_check
);
535 // Marks whether this subnet passed all checks
538 for (unsigned int i
= smallest_subnet
; i
< loc_network_list_size(list
); i
++) {
539 subnet
= loc_network_list_get(list
, i
);
541 // Drop this subnet if is a subnet of another subnet
542 if (loc_network_is_subnet(subnet
, subnet_to_check
)) {
544 loc_network_unref(subnet
);
548 // Break it down if it overlaps
549 if (loc_network_overlaps(subnet
, subnet_to_check
)) {
552 __loc_network_exclude_to_list(subnet_to_check
, subnet
, to_check
);
554 loc_network_unref(subnet
);
558 // If the subnet is strictly greater, we do not need to continue the search
559 r
= loc_network_cmp(subnet
, subnet_to_check
);
561 loc_network_unref(subnet
);
564 // If it is strictly smaller, we can continue the search from here next
565 // time because all networks that are to be checked can only be larger
571 loc_network_unref(subnet
);
575 r
= loc_network_list_push(subnets
, subnet_to_check
);
578 loc_network_unref(subnet_to_check
);
581 loc_network_list_unref(to_check
);
586 int loc_network_to_database_v1(struct loc_network
* network
, struct loc_database_network_v1
* dbobj
) {
588 loc_country_code_copy(dbobj
->country_code
, network
->country_code
);
591 dbobj
->asn
= htobe32(network
->asn
);
594 dbobj
->flags
= htobe16(network
->flags
);
599 int loc_network_new_from_database_v1(struct loc_ctx
* ctx
, struct loc_network
** network
,
600 struct in6_addr
* address
, unsigned int prefix
, const struct loc_database_network_v1
* dbobj
) {
601 char country_code
[3] = "\0\0";
603 // Adjust prefix for IPv4
604 if (IN6_IS_ADDR_V4MAPPED(address
))
607 int r
= loc_network_new(ctx
, network
, address
, prefix
);
609 ERROR(ctx
, "Could not allocate a new network: %s", strerror(-r
));
613 // Import country code
614 loc_country_code_copy(country_code
, dbobj
->country_code
);
616 r
= loc_network_set_country_code(*network
, country_code
);
618 ERROR(ctx
, "Could not set country code: %s\n", country_code
);
623 uint32_t asn
= be32toh(dbobj
->asn
);
624 r
= loc_network_set_asn(*network
, asn
);
626 ERROR(ctx
, "Could not set ASN: %d\n", asn
);
631 int flags
= be16toh(dbobj
->flags
);
632 r
= loc_network_set_flag(*network
, flags
);
634 ERROR(ctx
, "Could not set flags: %d\n", flags
);
641 struct loc_network_tree
{
645 struct loc_network_tree_node
* root
;
648 struct loc_network_tree_node
{
652 struct loc_network_tree_node
* zero
;
653 struct loc_network_tree_node
* one
;
655 struct loc_network
* network
;
658 int loc_network_tree_new(struct loc_ctx
* ctx
, struct loc_network_tree
** tree
) {
659 struct loc_network_tree
* t
= calloc(1, sizeof(*t
));
663 t
->ctx
= loc_ref(ctx
);
666 // Create the root node
667 int r
= loc_network_tree_node_new(ctx
, &t
->root
);
669 loc_network_tree_unref(t
);
673 DEBUG(t
->ctx
, "Network tree allocated at %p\n", t
);
678 struct loc_network_tree_node
* loc_network_tree_get_root(struct loc_network_tree
* tree
) {
679 return loc_network_tree_node_ref(tree
->root
);
682 static struct loc_network_tree_node
* loc_network_tree_get_node(struct loc_network_tree_node
* node
, int path
) {
683 struct loc_network_tree_node
** n
;
690 // If the desired node doesn't exist, yet, we will create it
692 int r
= loc_network_tree_node_new(node
->ctx
, n
);
700 static struct loc_network_tree_node
* loc_network_tree_get_path(struct loc_network_tree
* tree
, const struct in6_addr
* address
, unsigned int prefix
) {
701 struct loc_network_tree_node
* node
= tree
->root
;
703 for (unsigned int i
= 0; i
< prefix
; i
++) {
704 // Check if the ith bit is one or zero
705 node
= loc_network_tree_get_node(node
, loc_address_get_bit(address
, i
));
711 static int __loc_network_tree_walk(struct loc_ctx
* ctx
, struct loc_network_tree_node
* node
,
712 int(*filter_callback
)(struct loc_network
* network
, void* data
),
713 int(*callback
)(struct loc_network
* network
, void* data
), void* data
) {
716 // Finding a network ends the walk here
718 if (filter_callback
) {
719 int f
= filter_callback(node
->network
, data
);
723 // Skip network if filter function returns value greater than zero
728 r
= callback(node
->network
, data
);
733 // Walk down on the left side of the tree first
735 r
= __loc_network_tree_walk(ctx
, node
->zero
, filter_callback
, callback
, data
);
740 // Then walk on the other side
742 r
= __loc_network_tree_walk(ctx
, node
->one
, filter_callback
, callback
, data
);
750 int loc_network_tree_walk(struct loc_network_tree
* tree
,
751 int(*filter_callback
)(struct loc_network
* network
, void* data
),
752 int(*callback
)(struct loc_network
* network
, void* data
), void* data
) {
753 return __loc_network_tree_walk(tree
->ctx
, tree
->root
, filter_callback
, callback
, data
);
756 static void loc_network_tree_free(struct loc_network_tree
* tree
) {
757 DEBUG(tree
->ctx
, "Releasing network tree at %p\n", tree
);
759 loc_network_tree_node_unref(tree
->root
);
761 loc_unref(tree
->ctx
);
765 struct loc_network_tree
* loc_network_tree_unref(struct loc_network_tree
* tree
) {
766 if (--tree
->refcount
> 0)
769 loc_network_tree_free(tree
);
773 static int __loc_network_tree_dump(struct loc_network
* network
, void* data
) {
774 DEBUG(network
->ctx
, "Dumping network at %p\n", network
);
776 const char* s
= loc_network_str(network
);
780 INFO(network
->ctx
, "%s\n", s
);
785 int loc_network_tree_dump(struct loc_network_tree
* tree
) {
786 DEBUG(tree
->ctx
, "Dumping network tree at %p\n", tree
);
788 return loc_network_tree_walk(tree
, NULL
, __loc_network_tree_dump
, NULL
);
791 int loc_network_tree_add_network(struct loc_network_tree
* tree
, struct loc_network
* network
) {
792 DEBUG(tree
->ctx
, "Adding network %p to tree %p\n", network
, tree
);
794 struct loc_network_tree_node
* node
= loc_network_tree_get_path(tree
,
795 &network
->first_address
, network
->prefix
);
797 ERROR(tree
->ctx
, "Could not find a node\n");
801 // Check if node has not been set before
803 DEBUG(tree
->ctx
, "There is already a network at this path\n");
807 // Point node to the network
808 node
->network
= loc_network_ref(network
);
813 static int __loc_network_tree_count(struct loc_network
* network
, void* data
) {
814 size_t* counter
= (size_t*)data
;
816 // Increase the counter for each network
822 size_t loc_network_tree_count_networks(struct loc_network_tree
* tree
) {
825 int r
= loc_network_tree_walk(tree
, NULL
, __loc_network_tree_count
, &counter
);
832 static size_t __loc_network_tree_count_nodes(struct loc_network_tree_node
* node
) {
836 counter
+= __loc_network_tree_count_nodes(node
->zero
);
839 counter
+= __loc_network_tree_count_nodes(node
->one
);
844 size_t loc_network_tree_count_nodes(struct loc_network_tree
* tree
) {
845 return __loc_network_tree_count_nodes(tree
->root
);
848 int loc_network_tree_node_new(struct loc_ctx
* ctx
, struct loc_network_tree_node
** node
) {
849 struct loc_network_tree_node
* n
= calloc(1, sizeof(*n
));
853 n
->ctx
= loc_ref(ctx
);
856 n
->zero
= n
->one
= NULL
;
858 DEBUG(n
->ctx
, "Network node allocated at %p\n", n
);
863 struct loc_network_tree_node
* loc_network_tree_node_ref(struct loc_network_tree_node
* node
) {
870 static void loc_network_tree_node_free(struct loc_network_tree_node
* node
) {
871 DEBUG(node
->ctx
, "Releasing network node at %p\n", node
);
874 loc_network_unref(node
->network
);
877 loc_network_tree_node_unref(node
->zero
);
880 loc_network_tree_node_unref(node
->one
);
882 loc_unref(node
->ctx
);
886 struct loc_network_tree_node
* loc_network_tree_node_unref(struct loc_network_tree_node
* node
) {
890 if (--node
->refcount
> 0)
893 loc_network_tree_node_free(node
);
897 struct loc_network_tree_node
* loc_network_tree_node_get(struct loc_network_tree_node
* node
, unsigned int index
) {
906 return loc_network_tree_node_ref(node
);
909 int loc_network_tree_node_is_leaf(struct loc_network_tree_node
* node
) {
910 return (!!node
->network
);
913 struct loc_network
* loc_network_tree_node_get_network(struct loc_network_tree_node
* node
) {
914 return loc_network_ref(node
->network
);