src/loc/format.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_FORMAT_H
  18 #define LIBLOC_FORMAT_H
  19
  20 #include <stdint.h>
  21
  22 #define LOC_DATABASE_MAGIC      "LOCDBXX"
  23
  24 #ifdef LIBLOC_PRIVATE
  25
  26 #define LOC_DATABASE_VERSION    0
  27
  28 #define STR(x) #x
  29 #define LOC_DATABASE_DOMAIN_LATEST(version) "_latest._v" STR(version) ".location.ipfire.org"
  30
  31 #define LOC_DATABASE_PAGE_SIZE  4096
  32
  33 #define LOC_SIGNATURE_MAX_LENGTH        4096
  34
  35 struct loc_database_magic {
  36         char magic[7];
  37
  38         // Database version information
  39         uint8_t version;
  40 };
  41
  42 struct loc_database_header_v0 {
  43         // UNIX timestamp when the database was created
  44         uint64_t created_at;
  45
  46         // Vendor who created the database
  47         uint32_t vendor;
  48
  49         // Description of the database
  50         uint32_t description;
  51
  52         // License of the database
  53         uint32_t license;
  54
  55         // Tells us where the ASes start
  56         uint32_t as_offset;
  57         uint32_t as_length;
  58
  59         // Tells us where the networks start
  60         uint32_t network_data_offset;
  61         uint32_t network_data_length;
  62
  63         // Tells us where the network nodes start
  64         uint32_t network_tree_offset;
  65         uint32_t network_tree_length;
  66
  67         // Tells us where the countries start
  68         uint32_t countries_offset;
  69         uint32_t countries_length;
  70
  71         // Tells us where the pool starts
  72         uint32_t pool_offset;
  73         uint32_t pool_length;
  74
  75         // Signature
  76         uint32_t signature_length;
  77         char signature[LOC_SIGNATURE_MAX_LENGTH];
  78
  79         // Add some padding for future extensions
  80         char padding[32];
  81 };
  82
  83 struct loc_database_network_node_v0 {
  84         uint32_t zero;
  85         uint32_t one;
  86
  87         uint32_t network;
  88 };
  89
  90 struct loc_database_network_v0 {
  91         // The start address and prefix will be encoded in the tree
  92
  93         // The country this network is located in
  94         char country_code[2];
  95
  96         // ASN
  97         uint32_t asn;
  98
  99         // Flags
 100         uint16_t flags;
 101
 102         // Reserved
 103         char padding[2];
 104 };
 105
 106 struct loc_database_as_v0 {
 107         // The AS number
 108         uint32_t number;
 109
 110         // Name
 111         uint32_t name;
 112 };
 113
 114 struct loc_database_country_v0 {
 115         char code[2];
 116         char continent_code[2];
 117
 118         // Name in the string pool
 119         uint32_t name;
 120 };
 121
 122 #endif
 123 #endif