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
.add_argument("--cron",
92 help=_("Update the library only once per interval"),
93 choices
=("daily", "weekly", "monthly"),
95 update
.set_defaults(func
=self
.handle_update
)
98 verify
= subparsers
.add_parser("verify",
99 help=_("Verify the downloaded database"))
100 verify
.set_defaults(func
=self
.handle_verify
)
103 get_as
= subparsers
.add_parser("get-as",
104 help=_("Get information about one or multiple Autonomous Systems"),
106 get_as
.add_argument("asn", nargs
="+")
107 get_as
.set_defaults(func
=self
.handle_get_as
)
110 search_as
= subparsers
.add_parser("search-as",
111 help=_("Search for Autonomous Systems that match the string"),
113 search_as
.add_argument("query", nargs
=1)
114 search_as
.set_defaults(func
=self
.handle_search_as
)
116 # List all networks in an AS
117 list_networks_by_as
= subparsers
.add_parser("list-networks-by-as",
118 help=_("Lists all networks in an AS"),
120 list_networks_by_as
.add_argument("asn", nargs
=1, type=int)
121 list_networks_by_as
.add_argument("--family", choices
=("ipv6", "ipv4"))
122 list_networks_by_as
.add_argument("--format",
123 choices
=location
.export
.formats
.keys(), default
="list")
124 list_networks_by_as
.set_defaults(func
=self
.handle_list_networks_by_as
)
126 # List all networks in a country
127 list_networks_by_cc
= subparsers
.add_parser("list-networks-by-cc",
128 help=_("Lists all networks in a country"),
130 list_networks_by_cc
.add_argument("country_code", nargs
=1)
131 list_networks_by_cc
.add_argument("--family", choices
=("ipv6", "ipv4"))
132 list_networks_by_cc
.add_argument("--format",
133 choices
=location
.export
.formats
.keys(), default
="list")
134 list_networks_by_cc
.set_defaults(func
=self
.handle_list_networks_by_cc
)
136 # List all networks with flags
137 list_networks_by_flags
= subparsers
.add_parser("list-networks-by-flags",
138 help=_("Lists all networks with flags"),
140 list_networks_by_flags
.add_argument("--anonymous-proxy",
141 action
="store_true", help=_("Anonymous Proxies"),
143 list_networks_by_flags
.add_argument("--satellite-provider",
144 action
="store_true", help=_("Satellite Providers"),
146 list_networks_by_flags
.add_argument("--anycast",
147 action
="store_true", help=_("Anycasts"),
149 list_networks_by_flags
.add_argument("--family", choices
=("ipv6", "ipv4"))
150 list_networks_by_flags
.add_argument("--format",
151 choices
=location
.export
.formats
.keys(), default
="list")
152 list_networks_by_flags
.set_defaults(func
=self
.handle_list_networks_by_flags
)
155 list_countries
= subparsers
.add_parser("list-countries",
156 help=_("Lists all countries"),
158 list_countries
.add_argument("--show-name",
159 action
="store_true", help=_("Show the name of the country"),
161 list_countries
.add_argument("--show-continent",
162 action
="store_true", help=_("Show the continent"),
164 list_countries
.set_defaults(func
=self
.handle_list_countries
)
167 export
= subparsers
.add_parser("export",
168 help=_("Exports data in many formats to load it into packet filters"),
170 export
.add_argument("--format", help=_("Output format"),
171 choices
=location
.export
.formats
.keys(), default
="list")
172 export
.add_argument("--directory", help=_("Output directory"), required
=True)
173 export
.add_argument("--family",
174 help=_("Specify address family"), choices
=("ipv6", "ipv4"),
176 export
.add_argument("objects", nargs
="*", help=_("List country codes or ASNs to export"))
177 export
.set_defaults(func
=self
.handle_export
)
179 args
= parser
.parse_args()
183 location
.logger
.set_level(logging
.DEBUG
)
185 location
.logger
.set_level(logging
.WARNING
)
187 # Print usage if no action was given
188 if not "func" in args
:
195 # Parse command line arguments
196 args
= self
.parse_cli()
200 db
= location
.Database(args
.database
)
201 except FileNotFoundError
as e
:
202 # Allow continuing without a database
203 if args
.func
== self
.handle_update
:
207 sys
.stderr
.write("location: Could not open database %s: %s\n" \
208 % (args
.database
, e
))
211 # Translate family (if present)
213 if args
.family
== "ipv6":
214 args
.family
= socket
.AF_INET6
215 elif args
.family
== "ipv4":
216 args
.family
= socket
.AF_INET
222 ret
= args
.func(db
, args
)
224 # Catch invalid inputs
225 except ValueError as e
:
226 sys
.stderr
.write("%s\n" % e
)
229 # Return with exit code
233 # Otherwise just exit
236 def handle_version(self
, db
, ns
):
238 Print the version of the database
241 "%a, %d %b %Y %H:%M:%S GMT", time
.gmtime(db
.created_at
),
246 def handle_lookup(self
, db
, ns
):
249 format
= " %-24s: %s"
251 for address
in ns
.address
:
253 network
= db
.lookup(address
)
255 print(_("Invalid IP address: %s") % address
, file=sys
.stderr
)
264 print(_("Nothing found for %(address)s") % args
, file=sys
.stderr
)
268 print("%s:" % address
)
269 print(format
% (_("Network"), network
))
272 if network
.country_code
:
273 country
= db
.get_country(network
.country_code
)
277 country
.name
if country
else network
.country_code
),
280 # Print AS information
282 autonomous_system
= db
.get_as(network
.asn
)
285 _("Autonomous System"),
286 autonomous_system
or "AS%s" % network
.asn
),
290 if network
.has_flag(location
.NETWORK_FLAG_ANONYMOUS_PROXY
):
292 _("Anonymous Proxy"), _("yes"),
296 if network
.has_flag(location
.NETWORK_FLAG_SATELLITE_PROVIDER
):
298 _("Satellite Provider"), _("yes"),
302 if network
.has_flag(location
.NETWORK_FLAG_ANYCAST
):
304 _("Anycast"), _("yes"),
309 def handle_dump(self
, db
, ns
):
310 # Use output file or write to stdout
311 f
= ns
.output
or sys
.stdout
313 # Format everything like this
314 format
= "%-24s %s\n"
317 f
.write("#\n# Location Database Export\n#\n")
319 f
.write("# Generated: %s\n" % time
.strftime(
320 "%a, %d %b %Y %H:%M:%S GMT", time
.gmtime(db
.created_at
),
324 f
.write("# Vendor: %s\n" % db
.vendor
)
327 f
.write("# License: %s\n" % db
.license
)
332 for line
in db
.description
.splitlines():
334 f
.write("%s\n" % line
.rstrip())
338 # Iterate over all ASes
341 f
.write(format
% ("aut-num:", "AS%s" % a
.number
))
342 f
.write(format
% ("name:", a
.name
))
345 location
.NETWORK_FLAG_ANONYMOUS_PROXY
: "is-anonymous-proxy:",
346 location
.NETWORK_FLAG_SATELLITE_PROVIDER
: "is-satellite-provider:",
347 location
.NETWORK_FLAG_ANYCAST
: "is-anycast:",
350 # Iterate over all networks
351 for n
in db
.networks
:
353 f
.write(format
% ("net:", n
))
356 f
.write(format
% ("country:", n
.country_code
))
359 f
.write(format
% ("aut-num:", n
.asn
))
364 f
.write(format
% (flags
[flag
], "yes"))
366 def handle_get_as(self
, db
, ns
):
368 Gets information about Autonomous Systems
376 print(_("Invalid ASN: %s") % asn
, file=sys
.stderr
)
380 # Fetch AS from database
385 print(_("Could not find AS%s") % asn
, file=sys
.stderr
)
389 print(_("AS%(asn)s belongs to %(name)s") % { "asn" : a
.number
, "name" : a
.name
})
393 def handle_search_as(self
, db
, ns
):
394 for query
in ns
.query
:
395 # Print all matches ASes
396 for a
in db
.search_as(query
):
399 def handle_update(self
, db
, ns
):
401 now
= datetime
.datetime
.utcnow()
403 # Parse the database timestamp
404 t
= datetime
.datetime
.utcfromtimestamp(db
.created_at
)
406 if ns
.cron
== "daily":
407 delta
= datetime
.timedelta(days
=1)
408 elif ns
.cron
== "weekly":
409 delta
= datetime
.timedelta(days
=7)
410 elif ns
.cron
== "monthly":
411 delta
= datetime
.timedelta(days
=30)
413 # Check if the database has recently been updated
414 if t
>= (now
- delta
):
416 _("The database has been updated recently (%s)") % \
417 format_timedelta(now
- t
),
421 # Fetch the timestamp we need from DNS
422 t
= location
.discover_latest_version()
424 # Check the version of the local database
425 if db
and t
and db
.created_at
>= t
:
426 log
.info("Already on the latest version")
429 # Download the database into the correct directory
430 tmpdir
= os
.path
.dirname(ns
.database
)
432 # Create a downloader
433 d
= location
.downloader
.Downloader()
435 # Try downloading a new database
437 t
= d
.download(public_key
=ns
.public_key
, timestamp
=timestamp
, tmpdir
=tmpdir
)
439 # If no file could be downloaded, log a message
440 except FileNotFoundError
as e
:
441 log
.error("Could not download a new database")
444 # If we have not received a new file, there is nothing to do
448 # Move temporary file to destination
449 shutil
.move(t
.name
, ns
.database
)
453 def handle_verify(self
, db
, ns
):
454 # Verify the database
455 with
open(ns
.public_key
, "r") as f
:
457 log
.error("Could not verify database")
461 log
.debug("Database successfully verified")
464 def __get_output_formatter(self
, ns
):
466 cls
= location
.export
.formats
[ns
.format
]
468 cls
= location
.export
.OutputFormatter
472 def handle_list_countries(self
, db
, ns
):
473 for country
in db
.countries
:
478 if ns
.show_continent
:
479 line
.append(country
.continent_code
)
482 line
.append(country
.name
)
485 line
= " ".join(line
)
490 def handle_list_networks_by_as(self
, db
, ns
):
491 writer
= self
.__get
_output
_formatter
(ns
)
494 f
= writer(sys
.stdout
, prefix
="AS%s" % asn
)
496 # Print all matching networks
497 for n
in db
.search_networks(asn
=asn
, family
=ns
.family
):
502 def handle_list_networks_by_cc(self
, db
, ns
):
503 writer
= self
.__get
_output
_formatter
(ns
)
505 for country_code
in ns
.country_code
:
506 # Open standard output
507 f
= writer(sys
.stdout
, prefix
=country_code
)
509 # Print all matching networks
510 for n
in db
.search_networks(country_code
=country_code
, family
=ns
.family
):
515 def handle_list_networks_by_flags(self
, db
, ns
):
518 if ns
.anonymous_proxy
:
519 flags |
= location
.NETWORK_FLAG_ANONYMOUS_PROXY
521 if ns
.satellite_provider
:
522 flags |
= location
.NETWORK_FLAG_SATELLITE_PROVIDER
525 flags |
= location
.NETWORK_FLAG_ANYCAST
528 raise ValueError(_("You must at least pass one flag"))
530 writer
= self
.__get
_output
_formatter
(ns
)
531 f
= writer(sys
.stdout
, prefix
="custom")
533 for n
in db
.search_networks(flags
=flags
, family
=ns
.family
):
538 def handle_export(self
, db
, ns
):
539 countries
, asns
= [], []
543 families
= [ ns
.family
]
545 families
= [ socket
.AF_INET6
, socket
.AF_INET
]
547 for object in ns
.objects
:
548 m
= re
.match("^AS(\d+)$", object)
550 object = int(m
.group(1))
554 elif location
.country_code_is_valid(object) \
555 or object in ("A1", "A2", "A3"):
556 countries
.append(object)
559 log
.warning("Invalid argument: %s" % object)
562 # Default to exporting all countries
563 if not countries
and not asns
:
564 countries
= ["A1", "A2", "A3"] + [country
.code
for country
in db
.countries
]
566 # Select the output format
567 writer
= self
.__get
_output
_formatter
(ns
)
569 e
= location
.export
.Exporter(db
, writer
)
570 e
.export(ns
.directory
, countries
=countries
, asns
=asns
, families
=families
)
573 def format_timedelta(t
):
578 _("One Day", "%(days)s Days", t
.days
) % { "days" : t
.days
, }
581 hours
= t
.seconds
// 3600
584 _("One Hour", "%(hours)s Hours", hours
) % { "hours" : hours
, }
587 minutes
= (t
.seconds
% 3600) // 60
590 _("One Minute", "%(minutes)s Minutes", minutes
) % { "minutes" : minutes
, }
593 seconds
= t
.seconds
% 60
596 _("One Second", "%(seconds)s Seconds", seconds
) % { "seconds" : seconds
, }
602 return _("%s ago") % ", ".join(s
)
605 # Run the command line interface