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