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