2 ###############################################################################
4 # libloc - A library to determine the location of someone on the Internet #
6 # Copyright (C) 2017 IPFire Development Team <info@ipfire.org> #
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. #
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. #
18 ###############################################################################
31 # Load our location module
33 import location
.downloader
34 import location
.export
36 from location
.i18n
import _
39 log
= logging
.getLogger("location")
45 parser
= argparse
.ArgumentParser(
46 description
=_("Location Database Command Line Interface"),
48 subparsers
= parser
.add_subparsers()
50 # Global configuration flags
51 parser
.add_argument("--debug", action
="store_true",
52 help=_("Enable debug output"))
53 parser
.add_argument("--quiet", action
="store_true",
54 help=_("Enable quiet mode"))
57 parser
.add_argument("--version", action
="version",
58 version
="%(prog)s @VERSION@")
61 parser
.add_argument("--database", "-d",
62 default
="@databasedir@/database.db", help=_("Path to database"),
66 parser
.add_argument("--public-key", "-k",
67 default
="@databasedir@/signing-key.pem", help=_("Public Signing Key"),
70 # Show the database version
71 version
= subparsers
.add_parser("version",
72 help=_("Show database version"))
73 version
.set_defaults(func
=self
.handle_version
)
75 # lookup an IP address
76 lookup
= subparsers
.add_parser("lookup",
77 help=_("Lookup one or multiple IP addresses"),
79 lookup
.add_argument("address", nargs
="+")
80 lookup
.set_defaults(func
=self
.handle_lookup
)
82 # Dump the whole database
83 dump
= subparsers
.add_parser("dump",
84 help=_("Dump the entire database"),
86 dump
.add_argument("output", nargs
="?", type=argparse
.FileType("w"))
87 dump
.set_defaults(func
=self
.handle_dump
)
90 update
= subparsers
.add_parser("update", help=_("Update database"))
91 update
.set_defaults(func
=self
.handle_update
)
94 verify
= subparsers
.add_parser("verify",
95 help=_("Verify the downloaded database"))
96 verify
.set_defaults(func
=self
.handle_verify
)
99 get_as
= subparsers
.add_parser("get-as",
100 help=_("Get information about one or multiple Autonomous Systems"),
102 get_as
.add_argument("asn", nargs
="+")
103 get_as
.set_defaults(func
=self
.handle_get_as
)
106 search_as
= subparsers
.add_parser("search-as",
107 help=_("Search for Autonomous Systems that match the string"),
109 search_as
.add_argument("query", nargs
=1)
110 search_as
.set_defaults(func
=self
.handle_search_as
)
112 # List all networks in an AS
113 list_networks_by_as
= subparsers
.add_parser("list-networks-by-as",
114 help=_("Lists all networks in an AS"),
116 list_networks_by_as
.add_argument("asn", nargs
=1, type=int)
117 list_networks_by_as
.add_argument("--family", choices
=("ipv6", "ipv4"))
118 list_networks_by_as
.add_argument("--format",
119 choices
=location
.export
.formats
.keys(), default
="list")
120 list_networks_by_as
.set_defaults(func
=self
.handle_list_networks_by_as
)
122 # List all networks in a country
123 list_networks_by_cc
= subparsers
.add_parser("list-networks-by-cc",
124 help=_("Lists all networks in a country"),
126 list_networks_by_cc
.add_argument("country_code", nargs
=1)
127 list_networks_by_cc
.add_argument("--family", choices
=("ipv6", "ipv4"))
128 list_networks_by_cc
.add_argument("--format",
129 choices
=location
.export
.formats
.keys(), default
="list")
130 list_networks_by_cc
.set_defaults(func
=self
.handle_list_networks_by_cc
)
132 # List all networks with flags
133 list_networks_by_flags
= subparsers
.add_parser("list-networks-by-flags",
134 help=_("Lists all networks with flags"),
136 list_networks_by_flags
.add_argument("--anonymous-proxy",
137 action
="store_true", help=_("Anonymous Proxies"),
139 list_networks_by_flags
.add_argument("--satellite-provider",
140 action
="store_true", help=_("Satellite Providers"),
142 list_networks_by_flags
.add_argument("--anycast",
143 action
="store_true", help=_("Anycasts"),
145 list_networks_by_flags
.add_argument("--family", choices
=("ipv6", "ipv4"))
146 list_networks_by_flags
.add_argument("--format",
147 choices
=location
.export
.formats
.keys(), default
="list")
148 list_networks_by_flags
.set_defaults(func
=self
.handle_list_networks_by_flags
)
151 export
= subparsers
.add_parser("export",
152 help=_("Exports data in many formats to load it into packet filters"),
154 export
.add_argument("--format", help=_("Output format"),
155 choices
=location
.export
.formats
.keys(), default
="list")
156 export
.add_argument("--directory", help=_("Output directory"), required
=True)
157 export
.add_argument("--family",
158 help=_("Specify address family"), choices
=("ipv6", "ipv4"),
160 export
.add_argument("objects", nargs
="+", help=_("List country codes or ASNs to export"))
161 export
.set_defaults(func
=self
.handle_export
)
163 args
= parser
.parse_args()
167 location
.logger
.set_level(logging
.DEBUG
)
169 location
.logger
.set_level(logging
.WARNING
)
171 # Print usage if no action was given
172 if not "func" in args
:
179 # Parse command line arguments
180 args
= self
.parse_cli()
184 db
= location
.Database(args
.database
)
185 except FileNotFoundError
as e
:
186 sys
.stderr
.write("location: Could not open database %s: %s\n" \
187 % (args
.database
, e
))
190 # Translate family (if present)
192 if args
.family
== "ipv6":
193 args
.family
= socket
.AF_INET6
194 elif args
.family
== "ipv4":
195 args
.family
= socket
.AF_INET
201 ret
= args
.func(db
, args
)
203 # Catch invalid inputs
204 except ValueError as e
:
205 sys
.stderr
.write("%s\n" % e
)
208 # Return with exit code
212 # Otherwise just exit
215 def handle_version(self
, db
, ns
):
217 Print the version of the database
220 "%a, %d %b %Y %H:%M:%S GMT", time
.gmtime(db
.created_at
),
225 def handle_lookup(self
, db
, ns
):
228 format
= " %-24s: %s"
230 for address
in ns
.address
:
232 network
= db
.lookup(address
)
234 print(_("Invalid IP address: %s") % address
, file=sys
.stderr
)
243 print(_("Nothing found for %(address)s") % args
, file=sys
.stderr
)
247 print("%s:" % address
)
248 print(format
% (_("Network"), network
))
251 if network
.country_code
:
252 country
= db
.get_country(network
.country_code
)
256 country
.name
if country
else network
.country_code
),
259 # Print AS information
261 autonomous_system
= db
.get_as(network
.asn
)
264 _("Autonomous System"),
265 autonomous_system
or "AS%s" % network
.asn
),
269 if network
.has_flag(location
.NETWORK_FLAG_ANONYMOUS_PROXY
):
271 _("Anonymous Proxy"), _("yes"),
275 if network
.has_flag(location
.NETWORK_FLAG_SATELLITE_PROVIDER
):
277 _("Satellite Provider"), _("yes"),
281 if network
.has_flag(location
.NETWORK_FLAG_ANYCAST
):
283 _("Anycast"), _("yes"),
288 def handle_dump(self
, db
, ns
):
289 # Use output file or write to stdout
290 f
= ns
.output
or sys
.stdout
292 # Format everything like this
293 format
= "%-24s %s\n"
296 f
.write("#\n# Location Database Export\n#\n")
298 f
.write("# Generated: %s\n" % time
.strftime(
299 "%a, %d %b %Y %H:%M:%S GMT", time
.gmtime(db
.created_at
),
303 f
.write("# Vendor: %s\n" % db
.vendor
)
306 f
.write("# License: %s\n" % db
.license
)
311 for line
in db
.description
.splitlines():
312 f
.write("# %s\n" % line
)
316 # Iterate over all ASes
319 f
.write(format
% ("aut-num:", "AS%s" % a
.number
))
320 f
.write(format
% ("name:", a
.name
))
323 location
.NETWORK_FLAG_ANONYMOUS_PROXY
: "is-anonymous-proxy:",
324 location
.NETWORK_FLAG_SATELLITE_PROVIDER
: "is-satellite-provider:",
325 location
.NETWORK_FLAG_ANYCAST
: "is-anycast:",
328 # Iterate over all networks
329 for n
in db
.networks
:
331 f
.write(format
% ("net:", n
))
334 f
.write(format
% ("country:", n
.country_code
))
337 f
.write(format
% ("aut-num:", n
.asn
))
342 f
.write(format
% (flags
[flag
], "yes"))
344 def handle_get_as(self
, db
, ns
):
346 Gets information about Autonomous Systems
354 print(_("Invalid ASN: %s") % asn
, file=sys
.stderr
)
358 # Fetch AS from database
363 print(_("Could not find AS%s") % asn
, file=sys
.stderr
)
367 print(_("AS%(asn)s belongs to %(name)s") % { "asn" : a
.number
, "name" : a
.name
})
371 def handle_search_as(self
, db
, ns
):
372 for query
in ns
.query
:
373 # Print all matches ASes
374 for a
in db
.search_as(query
):
377 def handle_update(self
, db
, ns
):
378 # Fetch the timestamp we need from DNS
379 t
= location
.discover_latest_version()
381 # Parse timestamp into datetime format
382 timestamp
= datetime
.datetime
.fromtimestamp(t
) if t
else None
384 # Check the version of the local database
385 if db
and timestamp
and db
.created_at
>= timestamp
.timestamp():
386 log
.info("Already on the latest version")
389 # Download the database into the correct directory
390 tmpdir
= os
.path
.dirname(ns
.database
)
392 # Create a downloader
393 d
= location
.downloader
.Downloader()
395 # Try downloading a new database
397 t
= d
.download(public_key
=ns
.public_key
, timestamp
=timestamp
, tmpdir
=tmpdir
)
399 # If no file could be downloaded, log a message
400 except FileNotFoundError
as e
:
401 log
.error("Could not download a new database")
404 # If we have not received a new file, there is nothing to do
408 # Move temporary file to destination
409 shutil
.move(t
.name
, ns
.database
)
413 def handle_verify(self
, ns
):
415 db
= location
.Database(ns
.database
)
416 except FileNotFoundError
as e
:
417 log
.error("%s: %s" % (ns
.database
, e
))
420 # Verify the database
421 with
open(ns
.public_key
, "r") as f
:
423 log
.error("Could not verify database")
427 log
.debug("Database successfully verified")
430 def __get_output_formatter(self
, ns
):
432 cls
= location
.export
.formats
[ns
.format
]
434 cls
= location
.export
.OutputFormatter
438 def handle_list_networks_by_as(self
, db
, ns
):
439 writer
= self
.__get
_output
_formatter
(ns
)
442 f
= writer(sys
.stdout
, prefix
="AS%s" % asn
)
444 # Print all matching networks
445 for n
in db
.search_networks(asn
=asn
, family
=ns
.family
):
450 def handle_list_networks_by_cc(self
, db
, ns
):
451 writer
= self
.__get
_output
_formatter
(ns
)
453 for country_code
in ns
.country_code
:
454 # Open standard output
455 f
= writer(sys
.stdout
, prefix
=country_code
)
457 # Print all matching networks
458 for n
in db
.search_networks(country_code
=country_code
, family
=ns
.family
):
463 def handle_list_networks_by_flags(self
, db
, ns
):
466 if ns
.anonymous_proxy
:
467 flags |
= location
.NETWORK_FLAG_ANONYMOUS_PROXY
469 if ns
.satellite_provider
:
470 flags |
= location
.NETWORK_FLAG_SATELLITE_PROVIDER
473 flags |
= location
.NETWORK_FLAG_ANYCAST
476 raise ValueError(_("You must at least pass one flag"))
478 writer
= self
.__get
_output
_formatter
(ns
)
479 f
= writer(sys
.stdout
, prefix
="custom")
481 for n
in db
.search_networks(flags
=flags
, family
=ns
.family
):
486 def handle_export(self
, db
, ns
):
487 countries
, asns
= [], []
490 if ns
.family
== "ipv6":
491 families
= [ socket
.AF_INET6
]
492 elif ns
.family
== "ipv4":
493 families
= [ socket
.AF_INET
]
495 families
= [ socket
.AF_INET6
, socket
.AF_INET
]
497 for object in ns
.objects
:
498 m
= re
.match("^AS(\d+)$", object)
500 object = int(m
.group(1))
504 elif location
.country_code_is_valid(object) \
505 or object in ("A1", "A2", "A3"):
506 countries
.append(object)
509 log
.warning("Invalid argument: %s" % object)
512 if not countries
and not asns
:
513 log
.error("Nothing to export")
516 # Select the output format
517 writer
= self
.__get
_output
_formatter
(ns
)
519 e
= location
.export
.Exporter(db
, writer
)
520 e
.export(ns
.directory
, countries
=countries
, asns
=asns
, families
=families
)
524 # Run the command line interface