]>
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 in %s: %u\n", loc_address_str(address
), prefix
);
61 struct loc_network
* n
= calloc(1, sizeof(*n
));
65 n
->ctx
= loc_ref(ctx
);
69 if (IN6_IS_ADDR_V4MAPPED(address
))
70 n
->prefix
= prefix
+ 96;
74 // Convert the prefix into a bitmask
75 struct in6_addr bitmask
= loc_prefix_to_bitmask(n
->prefix
);
77 // Store the first and last address in the network
78 n
->first_address
= loc_address_and(address
, &bitmask
);
79 n
->last_address
= loc_address_or(&n
->first_address
, &bitmask
);
82 n
->family
= loc_address_family(&n
->first_address
);
84 DEBUG(n
->ctx
, "Network allocated at %p\n", n
);
89 LOC_EXPORT
int loc_network_new_from_string(struct loc_ctx
* ctx
,
90 struct loc_network
** network
, const char* string
) {
91 struct in6_addr address
;
95 int r
= loc_address_parse(&address
, &prefix
, string
);
97 ERROR(ctx
, "Could not parse network %s: %m\n", string
);
101 // Create a new network
102 return loc_network_new(ctx
, network
, &address
, prefix
);
105 LOC_EXPORT
struct loc_network
* loc_network_ref(struct loc_network
* network
) {
111 static void loc_network_free(struct loc_network
* network
) {
112 DEBUG(network
->ctx
, "Releasing network at %p\n", network
);
114 loc_unref(network
->ctx
);
118 LOC_EXPORT
struct loc_network
* loc_network_unref(struct loc_network
* network
) {
119 if (--network
->refcount
> 0)
122 loc_network_free(network
);
126 LOC_EXPORT
const char* loc_network_str(struct loc_network
* network
) {
127 if (!*network
->string
) {
128 // Format the address
129 const char* address
= loc_address_str(&network
->first_address
);
134 unsigned int prefix
= loc_network_prefix(network
);
137 int r
= snprintf(network
->string
, sizeof(network
->string
) - 1,
138 "%s/%u", address
, prefix
);
140 ERROR(network
->ctx
, "Could not format network string: %m\n");
141 *network
->string
= '\0';
146 return network
->string
;
149 LOC_EXPORT
int loc_network_address_family(struct loc_network
* network
) {
150 return network
->family
;
153 LOC_EXPORT
unsigned int loc_network_prefix(struct loc_network
* network
) {
154 switch (network
->family
) {
156 return network
->prefix
;
159 return network
->prefix
- 96;
165 LOC_EXPORT
const struct in6_addr
* loc_network_get_first_address(struct loc_network
* network
) {
166 return &network
->first_address
;
169 LOC_EXPORT
const char* loc_network_format_first_address(struct loc_network
* network
) {
170 return loc_address_str(&network
->first_address
);
173 LOC_EXPORT
const struct in6_addr
* loc_network_get_last_address(struct loc_network
* network
) {
174 return &network
->last_address
;
177 LOC_EXPORT
const char* loc_network_format_last_address(struct loc_network
* network
) {
178 return loc_address_str(&network
->last_address
);
181 LOC_EXPORT
int loc_network_matches_address(struct loc_network
* network
, const struct in6_addr
* address
) {
182 // Address must be larger than the start address
183 if (loc_address_cmp(&network
->first_address
, address
) > 0)
186 // Address must be smaller than the last address
187 if (loc_address_cmp(&network
->last_address
, address
) < 0)
190 // The address is inside this network
194 LOC_EXPORT
const char* loc_network_get_country_code(struct loc_network
* network
) {
195 return network
->country_code
;
198 LOC_EXPORT
int loc_network_set_country_code(struct loc_network
* network
, const char* country_code
) {
199 // Set empty country code
200 if (!country_code
|| !*country_code
) {
201 *network
->country_code
= '\0';
205 // Check country code
206 if (!loc_country_code_is_valid(country_code
))
209 loc_country_code_copy(network
->country_code
, country_code
);
214 LOC_EXPORT
int loc_network_matches_country_code(struct loc_network
* network
, const char* country_code
) {
215 // Search for any special flags
216 const int flag
= loc_country_special_code_to_flag(country_code
);
218 // If we found a flag, we will return whether it is set or not
220 return loc_network_has_flag(network
, flag
);
222 // Check country code
223 if (!loc_country_code_is_valid(country_code
))
226 // Check for an exact match
227 return (network
->country_code
[0] == country_code
[0])
228 && (network
->country_code
[1] == country_code
[1]);
231 LOC_EXPORT
uint32_t loc_network_get_asn(struct loc_network
* network
) {
235 LOC_EXPORT
int loc_network_set_asn(struct loc_network
* network
, uint32_t asn
) {
241 LOC_EXPORT
int loc_network_has_flag(struct loc_network
* network
, uint32_t flag
) {
242 return network
->flags
& flag
;
245 LOC_EXPORT
int loc_network_set_flag(struct loc_network
* network
, uint32_t flag
) {
246 network
->flags
|= flag
;
251 LOC_EXPORT
int loc_network_cmp(struct loc_network
* self
, struct loc_network
* other
) {
253 int r
= loc_address_cmp(&self
->first_address
, &other
->first_address
);
258 if (self
->prefix
> other
->prefix
)
260 else if (self
->prefix
< other
->prefix
)
263 // Both networks are equal
267 LOC_EXPORT
int loc_network_overlaps(struct loc_network
* self
, struct loc_network
* other
) {
268 // Either of the start addresses must be in the other subnet
269 if (loc_network_matches_address(self
, &other
->first_address
))
272 if (loc_network_matches_address(other
, &self
->first_address
))
275 // Or either of the end addresses is in the other subnet
276 if (loc_network_matches_address(self
, &other
->last_address
))
279 if (loc_network_matches_address(other
, &self
->last_address
))
285 LOC_EXPORT
int loc_network_is_subnet(struct loc_network
* self
, struct loc_network
* other
) {
286 // The prefix must be smaller (this avoids the more complex comparisons later)
287 if (self
->prefix
> other
->prefix
)
290 // If the start address of the other network is smaller than this network,
291 // it cannot be a subnet.
292 if (loc_address_cmp(&self
->first_address
, &other
->first_address
) > 0)
295 // If the end address of the other network is greater than this network,
296 // it cannot be a subnet.
297 if (loc_address_cmp(&self
->last_address
, &other
->last_address
) < 0)
303 LOC_EXPORT
int loc_network_subnets(struct loc_network
* network
,
304 struct loc_network
** subnet1
, struct loc_network
** subnet2
) {
310 unsigned int prefix
= loc_network_prefix(network
) + 1;
312 // Check if the new prefix is valid
313 if (!loc_address_valid_prefix(&network
->first_address
, prefix
)) {
314 ERROR(network
->ctx
, "Invalid prefix: %d\n", prefix
);
319 // Create the first half of the network
320 r
= loc_network_new(network
->ctx
, subnet1
, &network
->first_address
, prefix
);
324 // The next subnet starts after the first one
325 struct in6_addr first_address
= (*subnet1
)->last_address
;
326 loc_address_increment(&first_address
);
328 // Create the second half of the network
329 r
= loc_network_new(network
->ctx
, subnet2
, &first_address
, prefix
);
334 const char* country_code
= loc_network_get_country_code(network
);
336 loc_network_set_country_code(*subnet1
, country_code
);
337 loc_network_set_country_code(*subnet2
, country_code
);
341 uint32_t asn
= loc_network_get_asn(network
);
343 loc_network_set_asn(*subnet1
, asn
);
344 loc_network_set_asn(*subnet2
, asn
);
348 loc_network_set_flag(*subnet1
, network
->flags
);
349 loc_network_set_flag(*subnet2
, network
->flags
);
354 static int __loc_network_exclude(struct loc_network
* network
,
355 struct loc_network
* other
, struct loc_network_list
* list
) {
356 struct loc_network
* subnet1
= NULL
;
357 struct loc_network
* subnet2
= NULL
;
359 int r
= loc_network_subnets(network
, &subnet1
, &subnet2
);
363 if (loc_network_cmp(other
, subnet1
) == 0) {
364 r
= loc_network_list_push(list
, subnet2
);
368 } else if (loc_network_cmp(other
, subnet2
) == 0) {
369 r
= loc_network_list_push(list
, subnet1
);
373 } else if (loc_network_is_subnet(subnet1
, other
)) {
374 r
= loc_network_list_push(list
, subnet2
);
378 r
= __loc_network_exclude(subnet1
, other
, list
);
382 } else if (loc_network_is_subnet(subnet2
, other
)) {
383 r
= loc_network_list_push(list
, subnet1
);
387 r
= __loc_network_exclude(subnet2
, other
, list
);
392 ERROR(network
->ctx
, "We should never get here\n");
399 loc_network_unref(subnet1
);
402 loc_network_unref(subnet2
);
405 DEBUG(network
->ctx
, "%s has failed with %d\n", __FUNCTION__
, r
);
410 static int __loc_network_exclude_to_list(struct loc_network
* self
,
411 struct loc_network
* other
, struct loc_network_list
* list
) {
412 // Other must be a subnet of self
413 if (!loc_network_is_subnet(self
, other
)) {
414 DEBUG(self
->ctx
, "Network %p is not contained in network %p\n", other
, self
);
420 // We cannot perform this operation if both networks equal
421 if (loc_network_cmp(self
, other
) == 0) {
422 DEBUG(self
->ctx
, "Networks %p and %p are equal\n", self
, other
);
428 return __loc_network_exclude(self
, other
, list
);
431 LOC_EXPORT
struct loc_network_list
* loc_network_exclude(
432 struct loc_network
* self
, struct loc_network
* other
) {
433 struct loc_network_list
* list
;
435 DEBUG(self
->ctx
, "Returning %s excluding %s...\n",
436 loc_network_str(self
), loc_network_str(other
));
438 // Create a new list with the result
439 int r
= loc_network_list_new(self
->ctx
, &list
);
441 ERROR(self
->ctx
, "Could not create network list: %d\n", r
);
446 r
= __loc_network_exclude_to_list(self
, other
, list
);
448 loc_network_list_unref(list
);
457 LOC_EXPORT
struct loc_network_list
* loc_network_exclude_list(
458 struct loc_network
* network
, struct loc_network_list
* list
) {
459 struct loc_network_list
* to_check
;
461 // Create a new list with all networks to look at
462 int r
= loc_network_list_new(network
->ctx
, &to_check
);
466 struct loc_network
* subnet
= NULL
;
467 struct loc_network_list
* subnets
= NULL
;
469 for (unsigned int i
= 0; i
< loc_network_list_size(list
); i
++) {
470 subnet
= loc_network_list_get(list
, i
);
472 // Find all excluded networks
473 if (!loc_network_list_contains(to_check
, subnet
)) {
474 r
= __loc_network_exclude_to_list(network
, subnet
, to_check
);
476 loc_network_list_unref(to_check
);
477 loc_network_unref(subnet
);
484 loc_network_unref(subnet
);
487 r
= loc_network_list_new(network
->ctx
, &subnets
);
489 loc_network_list_unref(to_check
);
493 off_t smallest_subnet
= 0;
495 while (!loc_network_list_empty(to_check
)) {
496 struct loc_network
* subnet_to_check
= loc_network_list_pop_first(to_check
);
498 // Check whether the subnet to check is part of the input list
499 if (loc_network_list_contains(list
, subnet_to_check
)) {
500 loc_network_unref(subnet_to_check
);
504 // Marks whether this subnet passed all checks
507 for (unsigned int i
= smallest_subnet
; i
< loc_network_list_size(list
); i
++) {
508 subnet
= loc_network_list_get(list
, i
);
510 // Drop this subnet if is a subnet of another subnet
511 if (loc_network_is_subnet(subnet
, subnet_to_check
)) {
513 loc_network_unref(subnet
);
517 // Break it down if it overlaps
518 if (loc_network_overlaps(subnet
, subnet_to_check
)) {
521 __loc_network_exclude_to_list(subnet_to_check
, subnet
, to_check
);
523 loc_network_unref(subnet
);
527 // If the subnet is strictly greater, we do not need to continue the search
528 r
= loc_network_cmp(subnet
, subnet_to_check
);
530 loc_network_unref(subnet
);
533 // If it is strictly smaller, we can continue the search from here next
534 // time because all networks that are to be checked can only be larger
540 loc_network_unref(subnet
);
544 r
= loc_network_list_push(subnets
, subnet_to_check
);
547 loc_network_unref(subnet_to_check
);
550 loc_network_list_unref(to_check
);
555 int loc_network_to_database_v1(struct loc_network
* network
, struct loc_database_network_v1
* dbobj
) {
557 loc_country_code_copy(dbobj
->country_code
, network
->country_code
);
560 dbobj
->asn
= htobe32(network
->asn
);
563 dbobj
->flags
= htobe16(network
->flags
);
568 int loc_network_new_from_database_v1(struct loc_ctx
* ctx
, struct loc_network
** network
,
569 struct in6_addr
* address
, unsigned int prefix
, const struct loc_database_network_v1
* dbobj
) {
570 char country_code
[3] = "\0\0";
572 // Adjust prefix for IPv4
573 if (IN6_IS_ADDR_V4MAPPED(address
))
576 int r
= loc_network_new(ctx
, network
, address
, prefix
);
578 ERROR(ctx
, "Could not allocate a new network: %m\n");
582 // Import country code
583 loc_country_code_copy(country_code
, dbobj
->country_code
);
585 r
= loc_network_set_country_code(*network
, country_code
);
587 ERROR(ctx
, "Could not set country code: %s\n", country_code
);
592 uint32_t asn
= be32toh(dbobj
->asn
);
593 r
= loc_network_set_asn(*network
, asn
);
595 ERROR(ctx
, "Could not set ASN: %d\n", asn
);
600 int flags
= be16toh(dbobj
->flags
);
601 r
= loc_network_set_flag(*network
, flags
);
603 ERROR(ctx
, "Could not set flags: %d\n", flags
);
610 struct loc_network_tree
{
614 struct loc_network_tree_node
* root
;
617 struct loc_network_tree_node
{
621 struct loc_network_tree_node
* zero
;
622 struct loc_network_tree_node
* one
;
624 struct loc_network
* network
;
627 int loc_network_tree_new(struct loc_ctx
* ctx
, struct loc_network_tree
** tree
) {
628 struct loc_network_tree
* t
= calloc(1, sizeof(*t
));
632 t
->ctx
= loc_ref(ctx
);
635 // Create the root node
636 int r
= loc_network_tree_node_new(ctx
, &t
->root
);
638 loc_network_tree_unref(t
);
642 DEBUG(t
->ctx
, "Network tree allocated at %p\n", t
);
647 struct loc_network_tree_node
* loc_network_tree_get_root(struct loc_network_tree
* tree
) {
648 return loc_network_tree_node_ref(tree
->root
);
651 static struct loc_network_tree_node
* loc_network_tree_get_node(struct loc_network_tree_node
* node
, int path
) {
652 struct loc_network_tree_node
** n
;
659 // If the desired node doesn't exist, yet, we will create it
661 int r
= loc_network_tree_node_new(node
->ctx
, n
);
669 static struct loc_network_tree_node
* loc_network_tree_get_path(struct loc_network_tree
* tree
, const struct in6_addr
* address
, unsigned int prefix
) {
670 struct loc_network_tree_node
* node
= tree
->root
;
672 for (unsigned int i
= 0; i
< prefix
; i
++) {
673 // Check if the ith bit is one or zero
674 node
= loc_network_tree_get_node(node
, loc_address_get_bit(address
, i
));
680 static int __loc_network_tree_walk(struct loc_ctx
* ctx
, struct loc_network_tree_node
* node
,
681 int(*filter_callback
)(struct loc_network
* network
, void* data
),
682 int(*callback
)(struct loc_network
* network
, void* data
), void* data
) {
685 // Finding a network ends the walk here
687 if (filter_callback
) {
688 int f
= filter_callback(node
->network
, data
);
692 // Skip network if filter function returns value greater than zero
697 r
= callback(node
->network
, data
);
702 // Walk down on the left side of the tree first
704 r
= __loc_network_tree_walk(ctx
, node
->zero
, filter_callback
, callback
, data
);
709 // Then walk on the other side
711 r
= __loc_network_tree_walk(ctx
, node
->one
, filter_callback
, callback
, data
);
719 int loc_network_tree_walk(struct loc_network_tree
* tree
,
720 int(*filter_callback
)(struct loc_network
* network
, void* data
),
721 int(*callback
)(struct loc_network
* network
, void* data
), void* data
) {
722 return __loc_network_tree_walk(tree
->ctx
, tree
->root
, filter_callback
, callback
, data
);
725 static void loc_network_tree_free(struct loc_network_tree
* tree
) {
726 DEBUG(tree
->ctx
, "Releasing network tree at %p\n", tree
);
728 loc_network_tree_node_unref(tree
->root
);
730 loc_unref(tree
->ctx
);
734 struct loc_network_tree
* loc_network_tree_unref(struct loc_network_tree
* tree
) {
735 if (--tree
->refcount
> 0)
738 loc_network_tree_free(tree
);
742 static int __loc_network_tree_dump(struct loc_network
* network
, void* data
) {
743 DEBUG(network
->ctx
, "Dumping network at %p\n", network
);
745 const char* s
= loc_network_str(network
);
749 INFO(network
->ctx
, "%s\n", s
);
754 int loc_network_tree_dump(struct loc_network_tree
* tree
) {
755 DEBUG(tree
->ctx
, "Dumping network tree at %p\n", tree
);
757 return loc_network_tree_walk(tree
, NULL
, __loc_network_tree_dump
, NULL
);
760 int loc_network_tree_add_network(struct loc_network_tree
* tree
, struct loc_network
* network
) {
761 DEBUG(tree
->ctx
, "Adding network %p to tree %p\n", network
, tree
);
763 struct loc_network_tree_node
* node
= loc_network_tree_get_path(tree
,
764 &network
->first_address
, network
->prefix
);
766 ERROR(tree
->ctx
, "Could not find a node\n");
770 // Check if node has not been set before
772 DEBUG(tree
->ctx
, "There is already a network at this path\n");
776 // Point node to the network
777 node
->network
= loc_network_ref(network
);
782 static size_t __loc_network_tree_count_nodes(struct loc_network_tree_node
* node
) {
786 counter
+= __loc_network_tree_count_nodes(node
->zero
);
789 counter
+= __loc_network_tree_count_nodes(node
->one
);
794 size_t loc_network_tree_count_nodes(struct loc_network_tree
* tree
) {
795 return __loc_network_tree_count_nodes(tree
->root
);
798 int loc_network_tree_node_new(struct loc_ctx
* ctx
, struct loc_network_tree_node
** node
) {
799 struct loc_network_tree_node
* n
= calloc(1, sizeof(*n
));
803 n
->ctx
= loc_ref(ctx
);
806 n
->zero
= n
->one
= NULL
;
808 DEBUG(n
->ctx
, "Network node allocated at %p\n", n
);
813 struct loc_network_tree_node
* loc_network_tree_node_ref(struct loc_network_tree_node
* node
) {
820 static void loc_network_tree_node_free(struct loc_network_tree_node
* node
) {
821 DEBUG(node
->ctx
, "Releasing network node at %p\n", node
);
824 loc_network_unref(node
->network
);
827 loc_network_tree_node_unref(node
->zero
);
830 loc_network_tree_node_unref(node
->one
);
832 loc_unref(node
->ctx
);
836 struct loc_network_tree_node
* loc_network_tree_node_unref(struct loc_network_tree_node
* node
) {
837 if (--node
->refcount
> 0)
840 loc_network_tree_node_free(node
);
844 struct loc_network_tree_node
* loc_network_tree_node_get(struct loc_network_tree_node
* node
, unsigned int index
) {
853 return loc_network_tree_node_ref(node
);
856 int loc_network_tree_node_is_leaf(struct loc_network_tree_node
* node
) {
857 return (!!node
->network
);
860 struct loc_network
* loc_network_tree_node_get_network(struct loc_network_tree_node
* node
) {
861 return loc_network_ref(node
->network
);