src/python/location-query.in

   1 #!/usr/bin/python3
   2 ###############################################################################
   3 #                                                                             #
   4 # libloc - A library to determine the location of someone on the Internet     #
   5 #                                                                             #
   6 # Copyright (C) 2017 IPFire Development Team <info@ipfire.org>                #
   7 #                                                                             #
   8 # This library is free software; you can redistribute it and/or               #
   9 # modify it under the terms of the GNU Lesser General Public                  #
  10 # License as published by the Free Software Foundation; either                #
  11 # version 2.1 of the License, or (at your option) any later version.          #
  12 #                                                                             #
  13 # This library is distributed in the hope that it will be useful,             #
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of              #
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU           #
  16 # Lesser General Public License for more details.                             #
  17 #                                                                             #
  18 ###############################################################################
  19
  20 import argparse
  21 import ipaddress
  22 import os
  23 import socket
  24 import sys
  25 import time
  26
  27 # Load our location module
  28 import location
  29 from location.i18n import _
  30
  31 # Output formatters
  32
  33 class OutputFormatter(object):
  34         def __init__(self, ns):
  35                 self.ns = ns
  36
  37         def __enter__(self):
  38                 # Open the output
  39                 self.open()
  40
  41                 return self
  42
  43         def __exit__(self, type, value, tb):
  44                 if tb is None:
  45                         self.close()
  46
  47         @property
  48         def name(self):
  49                 if "country_code" in self.ns:
  50                         return "networks_country_%s" % self.ns.country_code[0]
  51
  52                 elif "asn" in self.ns:
  53                         return "networks_AS%s" % self.ns.asn[0]
  54
  55         def open(self):
  56                 pass
  57
  58         def close(self):
  59                 pass
  60
  61         def network(self, network):
  62                 print(network)
  63
  64
  65 class IpsetOutputFormatter(OutputFormatter):
  66         """
  67                 For nftables
  68         """
  69         def open(self):
  70                 print("create %s hash:net family inet hashsize 1024 maxelem 65536" % self.name)
  71
  72         def network(self, network):
  73                 print("add %s %s" % (self.name, network))
  74
  75
  76 class NftablesOutputFormatter(OutputFormatter):
  77         """
  78                 For nftables
  79         """
  80         def open(self):
  81                 print("define %s = {" % self.name)
  82
  83         def close(self):
  84                 print("}")
  85
  86         def network(self, network):
  87                 print(" %s," % network)
  88
  89
  90 class XTGeoIPOutputFormatter(OutputFormatter):
  91         """
  92                 Formats the output in that way, that it can be loaded by
  93                 the xt_geoip kernel module from xtables-addons.
  94         """
  95         def network(self, network):
  96                 n = ipaddress.ip_network("%s" % network)
  97
  98                 for address in (n.network_address, n.broadcast_address):
  99                         bytes = socket.inet_pton(
 100                                 socket.AF_INET6 if address.version == 6 else socket.AF_INET,
 101                                 "%s" % address,
 102                         )
 103
 104                         os.write(1, bytes)
 105
 106
 107 class CLI(object):
 108         output_formats = {
 109                 "ipset"    : IpsetOutputFormatter,
 110                 "list"     : OutputFormatter,
 111                 "nftables" : NftablesOutputFormatter,
 112                 "xt_geoip" : XTGeoIPOutputFormatter,
 113         }
 114
 115         def parse_cli(self):
 116                 parser = argparse.ArgumentParser(
 117                         description=_("Location Database Command Line Interface"),
 118                 )
 119                 subparsers = parser.add_subparsers()
 120
 121                 # Global configuration flags
 122                 parser.add_argument("--debug", action="store_true",
 123                         help=_("Enable debug output"))
 124
 125                 # version
 126                 parser.add_argument("--version", action="version",
 127                         version="%(prog)s @VERSION@")
 128
 129                 # database
 130                 parser.add_argument("--database", "-d",
 131                         default="@databasedir@/database.db", help=_("Path to database"),
 132                 )
 133
 134                 # public key
 135                 parser.add_argument("--public-key", "-k",
 136                         default="@databasedir@/signing-key.pem", help=_("Public Signing Key"),
 137                 )
 138
 139                 # lookup an IP address
 140                 lookup = subparsers.add_parser("lookup",
 141                         help=_("Lookup one or multiple IP addresses"),
 142                 )
 143                 lookup.add_argument("address", nargs="+")
 144                 lookup.set_defaults(func=self.handle_lookup)
 145
 146                 # Dump the whole database
 147                 dump = subparsers.add_parser("dump",
 148                         help=_("Dump the entire database"),
 149                 )
 150                 dump.add_argument("output", nargs="?", type=argparse.FileType("w"))
 151                 dump.set_defaults(func=self.handle_dump)
 152
 153                 # Get AS
 154                 get_as = subparsers.add_parser("get-as",
 155                         help=_("Get information about one or multiple Autonomous Systems"),
 156                 )
 157                 get_as.add_argument("asn", nargs="+")
 158                 get_as.set_defaults(func=self.handle_get_as)
 159
 160                 # Search for AS
 161                 search_as = subparsers.add_parser("search-as",
 162                         help=_("Search for Autonomous Systems that match the string"),
 163                 )
 164                 search_as.add_argument("query", nargs=1)
 165                 search_as.set_defaults(func=self.handle_search_as)
 166
 167                 # List all networks in an AS
 168                 list_networks_by_as = subparsers.add_parser("list-networks-by-as",
 169                         help=_("Lists all networks in an AS"),
 170                 )
 171                 list_networks_by_as.add_argument("asn", nargs=1, type=int)
 172                 list_networks_by_as.add_argument("--family", choices=("ipv6", "ipv4"))
 173                 list_networks_by_as.add_argument("--output-format",
 174                         choices=self.output_formats.keys(), default="list")
 175                 list_networks_by_as.set_defaults(func=self.handle_list_networks_by_as)
 176
 177                 # List all networks in a country
 178                 list_networks_by_cc = subparsers.add_parser("list-networks-by-cc",
 179                         help=_("Lists all networks in a country"),
 180                 )
 181                 list_networks_by_cc.add_argument("country_code", nargs=1)
 182                 list_networks_by_cc.add_argument("--family", choices=("ipv6", "ipv4"))
 183                 list_networks_by_cc.add_argument("--output-format",
 184                         choices=self.output_formats.keys(), default="list")
 185                 list_networks_by_cc.set_defaults(func=self.handle_list_networks_by_cc)
 186
 187                 # List all networks with flags
 188                 list_networks_by_flags = subparsers.add_parser("list-networks-by-flags",
 189                         help=_("Lists all networks with flags"),
 190                 )
 191                 list_networks_by_flags.add_argument("--anonymous-proxy",
 192                         action="store_true", help=_("Anonymous Proxies"),
 193                 )
 194                 list_networks_by_flags.add_argument("--satellite-provider",
 195                         action="store_true", help=_("Satellite Providers"),
 196                 )
 197                 list_networks_by_flags.add_argument("--anycast",
 198                         action="store_true", help=_("Anycasts"),
 199                 )
 200                 list_networks_by_flags.add_argument("--family", choices=("ipv6", "ipv4"))
 201                 list_networks_by_flags.add_argument("--output-format",
 202                         choices=self.output_formats.keys(), default="list")
 203                 list_networks_by_flags.set_defaults(func=self.handle_list_networks_by_flags)
 204
 205                 args = parser.parse_args()
 206
 207                 # Enable debug logging
 208                 if args.debug:
 209                         location.logger.set_level(logging.DEBUG)
 210
 211                 # Print usage if no action was given
 212                 if not "func" in args:
 213                         parser.print_usage()
 214                         sys.exit(2)
 215
 216                 return args
 217
 218         def run(self):
 219                 # Parse command line arguments
 220                 args = self.parse_cli()
 221
 222                 # Open database
 223                 try:
 224                         db = location.Database(args.database)
 225                 except FileNotFoundError as e:
 226                         sys.stderr.write("location-query: Could not open database %s: %s\n" \
 227                                 % (args.database, e))
 228                         sys.exit(1)
 229
 230                 # Translate family (if present)
 231                 if "family" in args:
 232                         if args.family == "ipv6":
 233                                 args.family = socket.AF_INET6
 234                         elif args.family == "ipv4":
 235                                 args.family = socket.AF_INET
 236                         else:
 237                                 args.family = 0
 238
 239                 # Call function
 240                 ret = args.func(db, args)
 241
 242                 # Return with exit code
 243                 if ret:
 244                         sys.exit(ret)
 245
 246                 # Otherwise just exit
 247                 sys.exit(0)
 248
 249         def handle_lookup(self, db, ns):
 250                 ret = 0
 251
 252                 format = "  %-24s: %s"
 253
 254                 for address in ns.address:
 255                         try:
 256                                 network = db.lookup(address)
 257                         except ValueError:
 258                                 print(_("Invalid IP address: %s") % address, file=sys.stderr)
 259
 260                         args = {
 261                                 "address" : address,
 262                                 "network" : network,
 263                         }
 264
 265                         # Nothing found?
 266                         if not network:
 267                                 print(_("Nothing found for %(address)s") % args, file=sys.stderr)
 268                                 ret = 1
 269                                 continue
 270
 271                         print("%s:" % address)
 272                         print(format % (_("Network"), network))
 273
 274                         # Print country
 275                         if network.country_code:
 276                                 print(format % (_("Country"), network.country_code))
 277
 278                         # Print AS information
 279                         if network.asn:
 280                                 autonomous_system = db.get_as(network.asn)
 281
 282                                 print(format % (
 283                                         _("Autonomous System"),
 284                                         autonomous_system or "AS%s" % network.asn),
 285                                 )
 286
 287                 return ret
 288
 289         def handle_dump(self, db, ns):
 290                 # Use output file or write to stdout
 291                 f = ns.output or sys.stdout
 292
 293                 # Write metadata
 294                 f.write("#\n# Location Database Export\n#\n")
 295
 296                 f.write("# Generated: %s\n" % time.strftime(
 297                         "%a, %d %b %Y %H:%M:%S GMT", time.gmtime(db.created_at),
 298                 ))
 299
 300                 if db.vendor:
 301                         f.write("# Vendor:    %s\n" % db.vendor)
 302
 303                 if db.license:
 304                         f.write("# License:   %s\n" % db.license)
 305
 306                 f.write("#\n")
 307
 308                 if db.description:
 309                         for line in db.description.splitlines():
 310                                 f.write("# %s\n" % line)
 311
 312                         f.write("#\n")
 313
 314                 # Iterate over all ASes
 315                 for a in db.ases:
 316                         f.write("\n")
 317                         f.write("aut-num:        AS%s\n" % a.number)
 318                         f.write("name:           %s\n" % a.name)
 319
 320                 # Iterate over all networks
 321                 for n in db.networks:
 322                         f.write("\n")
 323                         f.write("net:            %s\n" % n)
 324
 325                         if n.country_code:
 326                                 f.write("country:        %s\n" % n.country_code)
 327
 328                         if n.asn:
 329                                 f.write("autnum:         %s\n" % n.asn)
 330
 331         def handle_get_as(self, db, ns):
 332                 """
 333                         Gets information about Autonomous Systems
 334                 """
 335                 ret = 0
 336
 337                 for asn in ns.asn:
 338                         try:
 339                                 asn = int(asn)
 340                         except ValueError:
 341                                 print(_("Invalid ASN: %s") % asn, file=sys.stderr)
 342                                 ret = 1
 343                                 continue
 344
 345                         # Fetch AS from database
 346                         a = db.get_as(asn)
 347
 348                         # Nothing found
 349                         if not a:
 350                                 print(_("Could not find AS%s") % asn, file=sys.stderr)
 351                                 ret = 1
 352                                 continue
 353
 354                         print(_("AS%(asn)s belongs to %(name)s") % { "asn" : a.number, "name" : a.name })
 355
 356                 return ret
 357
 358         def handle_search_as(self, db, ns):
 359                 for query in ns.query:
 360                         # Print all matches ASes
 361                         for a in db.search_as(query):
 362                                 print(a)
 363
 364         def __get_output_formatter(self, ns):
 365                 try:
 366                         cls = self.output_formats[ns.output_format]
 367                 except KeyError:
 368                         cls = OutputFormatter
 369
 370                 return cls(ns)
 371
 372         def handle_list_networks_by_as(self, db, ns):
 373                 with self.__get_output_formatter(ns) as f:
 374                         for asn in ns.asn:
 375                                 # Print all matching networks
 376                                 for n in db.search_networks(asn=asn, family=ns.family):
 377                                         f.network(n)
 378
 379         def handle_list_networks_by_cc(self, db, ns):
 380                 with self.__get_output_formatter(ns) as f:
 381                         for country_code in ns.country_code:
 382                                 # Print all matching networks
 383                                 for n in db.search_networks(country_code=country_code, family=ns.family):
 384                                         f.network(n)
 385
 386         def handle_list_networks_by_flags(self, db, ns):
 387                 flags = 0
 388
 389                 if ns.anonymous_proxy:
 390                         flags |= location.NETWORK_FLAG_ANONYMOUS_PROXY
 391
 392                 if ns.satellite_provider:
 393                         flags |= location.NETWORK_FLAG_SATELLITE_PROVIDER
 394
 395                 if ns.anycast:
 396                         flags |= location.NETWORK_FLAG_ANYCAST
 397
 398                 with self.__get_output_formatter(ns) as f:
 399                         for n in db.search_networks(flags=flags, family=ns.family):
 400                                 f.network(n)
 401
 402
 403 def main():
 404         # Run the command line interface
 405         c = CLI()
 406         c.run()
 407
 408 main()