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