src/loc/network.h

   1 /*
   2         libloc - A library to determine the location of someone on the Internet
   3
   4         Copyright (C) 2017 IPFire Development Team <info@ipfire.org>
   5
   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.
  10
  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.
  15 */
  16
  17 #ifndef LIBLOC_NETWORK_H
  18 #define LIBLOC_NETWORK_H
  19
  20 #include <netinet/in.h>
  21
  22 #include <loc/libloc.h>
  23 #include <loc/format.h>
  24
  25 enum loc_network_flags {
  26         LOC_NETWORK_FLAG_ANONYMOUS_PROXY    = (1 << 0), // A1
  27         LOC_NETWORK_FLAG_SATELLITE_PROVIDER = (1 << 1), // A2
  28         LOC_NETWORK_FLAG_ANYCAST            = (1 << 2), // A3
  29 };
  30
  31 struct loc_network;
  32 int loc_network_new(struct loc_ctx* ctx, struct loc_network** network,
  33                 struct in6_addr* first_address, unsigned int prefix);
  34 int loc_network_new_from_string(struct loc_ctx* ctx, struct loc_network** network,
  35                 const char* address_string);
  36 struct loc_network* loc_network_ref(struct loc_network* network);
  37 struct loc_network* loc_network_unref(struct loc_network* network);
  38 char* loc_network_str(struct loc_network* network);
  39 int loc_network_address_family(struct loc_network* network);
  40
  41 char* loc_network_format_first_address(struct loc_network* network);
  42 char* loc_network_format_last_address(struct loc_network* network);
  43 int loc_network_match_address(struct loc_network* network, const struct in6_addr* address);
  44
  45 const char* loc_network_get_country_code(struct loc_network* network);
  46 int loc_network_set_country_code(struct loc_network* network, const char* country_code);
  47 int loc_network_match_country_code(struct loc_network* network, const char* country_code);
  48
  49 uint32_t loc_network_get_asn(struct loc_network* network);
  50 int loc_network_set_asn(struct loc_network* network, uint32_t asn);
  51 int loc_network_match_asn(struct loc_network* network, uint32_t asn);
  52
  53 int loc_network_has_flag(struct loc_network* network, uint32_t flag);
  54 int loc_network_set_flag(struct loc_network* network, uint32_t flag);
  55 int loc_network_match_flag(struct loc_network* network, uint32_t flag);
  56
  57 int loc_network_eq(struct loc_network* self, struct loc_network* other);
  58 int loc_network_overlaps(struct loc_network* self, struct loc_network* other);
  59 int loc_network_is_subnet(struct loc_network* self, struct loc_network* other);
  60 int loc_network_is_subnet_of(struct loc_network* self, struct loc_network* other);
  61 struct loc_network_list* loc_network_subnets(struct loc_network* network);
  62 struct loc_network_list* loc_network_exclude(
  63                 struct loc_network* self, struct loc_network* other);
  64 struct loc_network_list* loc_network_exclude_list(
  65                 struct loc_network* network, struct loc_network_list* list);
  66
  67 // List
  68 struct loc_network_list;
  69 int loc_network_list_new(struct loc_ctx* ctx, struct loc_network_list** list);
  70 struct loc_network_list* loc_network_list_ref(struct loc_network_list* list);
  71 struct loc_network_list* loc_network_list_unref(struct loc_network_list* list);
  72 size_t loc_network_list_size(struct loc_network_list* list);
  73 int loc_network_list_empty(struct loc_network_list* list);
  74 void loc_network_list_clear(struct loc_network_list* list);
  75 void loc_network_list_dump(struct loc_network_list* list);
  76 struct loc_network* loc_network_list_get(struct loc_network_list* list, size_t index);
  77 int loc_network_list_push(struct loc_network_list* list, struct loc_network* network);
  78 struct loc_network* loc_network_list_pop(struct loc_network_list* list);
  79 struct loc_network* loc_network_list_pop_first(struct loc_network_list* list);
  80 int loc_network_list_contains(struct loc_network_list* list, struct loc_network* network);
  81 void loc_network_list_sort(struct loc_network_list* list);
  82 void loc_network_list_reverse(struct loc_network_list* list);
  83 int loc_network_list_merge(struct loc_network_list* self, struct loc_network_list* other);
  84
  85 #ifdef LIBLOC_PRIVATE
  86
  87 int loc_network_to_database_v1(struct loc_network* network, struct loc_database_network_v1* dbobj);
  88 int loc_network_new_from_database_v1(struct loc_ctx* ctx, struct loc_network** network,
  89                 struct in6_addr* address, unsigned int prefix, const struct loc_database_network_v1* dbobj);
  90
  91 struct loc_network_tree;
  92 int loc_network_tree_new(struct loc_ctx* ctx, struct loc_network_tree** tree);
  93 struct loc_network_tree* loc_network_tree_unref(struct loc_network_tree* tree);
  94 struct loc_network_tree_node* loc_network_tree_get_root(struct loc_network_tree* tree);
  95 int loc_network_tree_walk(struct loc_network_tree* tree,
  96                 int(*filter_callback)(struct loc_network* network, void* data),
  97                 int(*callback)(struct loc_network* network, void* data), void* data);
  98 int loc_network_tree_dump(struct loc_network_tree* tree);
  99 int loc_network_tree_add_network(struct loc_network_tree* tree, struct loc_network* network);
 100 size_t loc_network_tree_count_networks(struct loc_network_tree* tree);
 101 size_t loc_network_tree_count_nodes(struct loc_network_tree* tree);
 102
 103 struct loc_network_tree_node;
 104 int loc_network_tree_node_new(struct loc_ctx* ctx, struct loc_network_tree_node** node);
 105 struct loc_network_tree_node* loc_network_tree_node_ref(struct loc_network_tree_node* node);
 106 struct loc_network_tree_node* loc_network_tree_node_unref(struct loc_network_tree_node* node);
 107 struct loc_network_tree_node* loc_network_tree_node_get(struct loc_network_tree_node* node, unsigned int index);
 108
 109 int loc_network_tree_node_is_leaf(struct loc_network_tree_node* node);
 110 struct loc_network* loc_network_tree_node_get_network(struct loc_network_tree_node* node);
 111
 112 #endif
 113 #endif