2 ###############################################################################
4 # libloc - A library to determine the location of someone on the Internet #
6 # Copyright (C) 2020 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 ###############################################################################
29 # Load our location module
31 import location
.database
32 import location
.importer
33 from location
.i18n
import _
36 log
= logging
.getLogger("location.importer")
41 parser
= argparse
.ArgumentParser(
42 description
=_("Location Importer Command Line Interface"),
44 subparsers
= parser
.add_subparsers()
46 # Global configuration flags
47 parser
.add_argument("--debug", action
="store_true",
48 help=_("Enable debug output"))
49 parser
.add_argument("--quiet", action
="store_true",
50 help=_("Enable quiet mode"))
53 parser
.add_argument("--version", action
="version",
54 version
="%(prog)s @VERSION@")
57 parser
.add_argument("--database-host", required
=True,
58 help=_("Database Hostname"), metavar
=_("HOST"))
59 parser
.add_argument("--database-name", required
=True,
60 help=_("Database Name"), metavar
=_("NAME"))
61 parser
.add_argument("--database-username", required
=True,
62 help=_("Database Username"), metavar
=_("USERNAME"))
63 parser
.add_argument("--database-password", required
=True,
64 help=_("Database Password"), metavar
=_("PASSWORD"))
67 write
= subparsers
.add_parser("write", help=_("Write database to file"))
68 write
.set_defaults(func
=self
.handle_write
)
69 write
.add_argument("file", nargs
=1, help=_("Database File"))
70 write
.add_argument("--signing-key", nargs
="?", type=open, help=_("Signing Key"))
71 write
.add_argument("--backup-signing-key", nargs
="?", type=open, help=_("Backup Signing Key"))
72 write
.add_argument("--vendor", nargs
="?", help=_("Sets the vendor"))
73 write
.add_argument("--description", nargs
="?", help=_("Sets a description"))
74 write
.add_argument("--license", nargs
="?", help=_("Sets the license"))
75 write
.add_argument("--version", type=int, help=_("Database Format Version"))
78 update_whois
= subparsers
.add_parser("update-whois", help=_("Update WHOIS Information"))
79 update_whois
.set_defaults(func
=self
.handle_update_whois
)
81 # Update announcements
82 update_announcements
= subparsers
.add_parser("update-announcements",
83 help=_("Update BGP Annoucements"))
84 update_announcements
.set_defaults(func
=self
.handle_update_announcements
)
85 update_announcements
.add_argument("server", nargs
=1,
86 help=_("Route Server to connect to"), metavar
=_("SERVER"))
89 update_overrides
= subparsers
.add_parser("update-overrides",
90 help=_("Update overrides"),
92 update_overrides
.add_argument(
93 "files", nargs
="+", help=_("Files to import"),
95 update_overrides
.set_defaults(func
=self
.handle_update_overrides
)
98 import_countries
= subparsers
.add_parser("import-countries",
99 help=_("Import countries"),
101 import_countries
.add_argument("file", nargs
=1, type=argparse
.FileType("r"),
102 help=_("File to import"))
103 import_countries
.set_defaults(func
=self
.handle_import_countries
)
105 args
= parser
.parse_args()
109 location
.logger
.set_level(logging
.DEBUG
)
111 location
.logger
.set_level(logging
.WARNING
)
113 # Print usage if no action was given
114 if not "func" in args
:
121 # Parse command line arguments
122 args
= self
.parse_cli()
124 # Initialise database
125 self
.db
= self
._setup
_database
(args
)
128 ret
= args
.func(args
)
130 # Return with exit code
134 # Otherwise just exit
137 def _setup_database(self
, ns
):
139 Initialise the database
141 # Connect to database
142 db
= location
.database
.Connection(
143 host
=ns
.database_host
, database
=ns
.database_name
,
144 user
=ns
.database_username
, password
=ns
.database_password
,
147 with db
.transaction():
150 CREATE TABLE IF NOT EXISTS announcements(network inet, autnum bigint,
151 first_seen_at timestamp without time zone DEFAULT CURRENT_TIMESTAMP,
152 last_seen_at timestamp without time zone DEFAULT CURRENT_TIMESTAMP);
153 CREATE UNIQUE INDEX IF NOT EXISTS announcements_networks ON announcements(network);
154 CREATE INDEX IF NOT EXISTS announcements_family ON announcements(family(network));
157 CREATE TABLE IF NOT EXISTS autnums(number bigint, name text NOT NULL);
158 CREATE UNIQUE INDEX IF NOT EXISTS autnums_number ON autnums(number);
161 CREATE TABLE IF NOT EXISTS countries(
162 country_code text NOT NULL, name text NOT NULL, continent_code text NOT NULL);
163 CREATE UNIQUE INDEX IF NOT EXISTS countries_country_code ON countries(country_code);
166 CREATE TABLE IF NOT EXISTS networks(network inet, country text);
167 CREATE UNIQUE INDEX IF NOT EXISTS networks_network ON networks(network);
168 CREATE INDEX IF NOT EXISTS networks_search ON networks USING GIST(network inet_ops);
171 CREATE TABLE IF NOT EXISTS autnum_overrides(
172 number bigint NOT NULL,
175 is_anonymous_proxy boolean,
176 is_satellite_provider boolean,
179 CREATE UNIQUE INDEX IF NOT EXISTS autnum_overrides_number
180 ON autnum_overrides(number);
182 CREATE TABLE IF NOT EXISTS network_overrides(
183 network inet NOT NULL,
185 is_anonymous_proxy boolean,
186 is_satellite_provider boolean,
189 CREATE UNIQUE INDEX IF NOT EXISTS network_overrides_network
190 ON network_overrides(network);
195 def handle_write(self
, ns
):
197 Compiles a database in libloc format out of what is in the database
200 writer
= location
.Writer(ns
.signing_key
, ns
.backup_signing_key
)
204 writer
.vendor
= ns
.vendor
207 writer
.description
= ns
.description
210 writer
.license
= ns
.license
212 # Add all Autonomous Systems
213 log
.info("Writing Autonomous Systems...")
215 # Select all ASes with a name
216 rows
= self
.db
.query("""
218 autnums.number AS number,
220 (SELECT overrides.name FROM autnum_overrides overrides
221 WHERE overrides.number = autnums.number),
225 WHERE name <> %s ORDER BY number
229 a
= writer
.add_as(row
.number
)
233 log
.info("Writing networks...")
235 # Select all known networks
236 rows
= self
.db
.query("""
237 -- Get a (sorted) list of all known networks
238 WITH known_networks AS (
239 SELECT network FROM announcements
241 SELECT network FROM networks
245 -- Return a list of those networks enriched with all
246 -- other information that we store in the database
248 DISTINCT ON (known_networks.network)
249 known_networks.network AS network,
250 announcements.autnum AS autnum,
255 SELECT country FROM network_overrides overrides
256 WHERE announcements.network <<= overrides.network
257 ORDER BY masklen(overrides.network) DESC
261 SELECT country FROM autnum_overrides overrides
262 WHERE announcements.autnum = overrides.number
270 SELECT is_anonymous_proxy FROM network_overrides overrides
271 WHERE announcements.network <<= overrides.network
272 ORDER BY masklen(overrides.network) DESC
276 SELECT is_anonymous_proxy FROM autnum_overrides overrides
277 WHERE announcements.autnum = overrides.number
280 ) AS is_anonymous_proxy,
283 SELECT is_satellite_provider FROM network_overrides overrides
284 WHERE announcements.network <<= overrides.network
285 ORDER BY masklen(overrides.network) DESC
289 SELECT is_satellite_provider FROM autnum_overrides overrides
290 WHERE announcements.autnum = overrides.number
293 ) AS is_satellite_provider,
296 SELECT is_anycast FROM network_overrides overrides
297 WHERE announcements.network <<= overrides.network
298 ORDER BY masklen(overrides.network) DESC
302 SELECT is_anycast FROM autnum_overrides overrides
303 WHERE announcements.autnum = overrides.number
308 -- Must be part of returned values for ORDER BY clause
309 masklen(announcements.network) AS sort_a,
310 masklen(networks.network) AS sort_b
312 LEFT JOIN announcements ON known_networks.network <<= announcements.network
313 LEFT JOIN networks ON known_networks.network <<= networks.network
314 ORDER BY known_networks.network, sort_a DESC, sort_b DESC
318 network
= writer
.add_network(row
.network
)
322 network
.country_code
= row
.country
326 network
.asn
= row
.autnum
329 if row
.is_anonymous_proxy
:
330 network
.set_flag(location
.NETWORK_FLAG_ANONYMOUS_PROXY
)
332 if row
.is_satellite_provider
:
333 network
.set_flag(location
.NETWORK_FLAG_SATELLITE_PROVIDER
)
336 network
.set_flag(location
.NETWORK_FLAG_ANYCAST
)
339 log
.info("Writing countries...")
340 rows
= self
.db
.query("SELECT * FROM countries ORDER BY country_code")
343 c
= writer
.add_country(row
.country_code
)
344 c
.continent_code
= row
.continent_code
347 # Write everything to file
348 log
.info("Writing database to file...")
352 def handle_update_whois(self
, ns
):
353 downloader
= location
.importer
.Downloader()
355 # Download all sources
356 with self
.db
.transaction():
357 # Create some temporary tables to store parsed data
359 CREATE TEMPORARY TABLE _autnums(number integer, organization text)
361 CREATE UNIQUE INDEX _autnums_number ON _autnums(number);
363 CREATE TEMPORARY TABLE _organizations(handle text, name text)
365 CREATE UNIQUE INDEX _organizations_handle ON _organizations(handle);
368 for source
in location
.importer
.WHOIS_SOURCES
:
369 with downloader
.request(source
, return_blocks
=True) as f
:
371 self
._parse
_block
(block
)
374 INSERT INTO autnums(number, name)
375 SELECT _autnums.number, _organizations.name FROM _autnums
376 LEFT JOIN _organizations ON _autnums.organization = _organizations.handle
377 ON CONFLICT (number) DO UPDATE SET name = excluded.name;
380 # Download all extended sources
381 for source
in location
.importer
.EXTENDED_SOURCES
:
382 with self
.db
.transaction():
384 with downloader
.request(source
) as f
:
386 self
._parse
_line
(line
)
388 def _parse_block(self
, block
):
389 # Get first line to find out what type of block this is
393 if line
.startswith("aut-num:"):
394 return self
._parse
_autnum
_block
(block
)
397 elif line
.startswith("organisation:"):
398 return self
._parse
_org
_block
(block
)
400 def _parse_autnum_block(self
, block
):
404 key
, val
= split_line(line
)
407 m
= re
.match(r
"^(AS|as)(\d+)", val
)
409 autnum
["asn"] = m
.group(2)
418 # Insert into database
419 self
.db
.execute("INSERT INTO _autnums(number, organization) \
420 VALUES(%s, %s) ON CONFLICT (number) DO UPDATE SET \
421 organization = excluded.organization",
422 autnum
.get("asn"), autnum
.get("org"),
425 def _parse_org_block(self
, block
):
429 key
, val
= split_line(line
)
431 if key
in ("organisation", "org-name"):
438 self
.db
.execute("INSERT INTO _organizations(handle, name) \
439 VALUES(%s, %s) ON CONFLICT (handle) DO \
440 UPDATE SET name = excluded.name",
441 org
.get("organisation"), org
.get("org-name"),
444 def _parse_line(self
, line
):
446 if line
.startswith("2"):
450 if line
.startswith("#"):
454 registry
, country_code
, type, line
= line
.split("|", 3)
456 log
.warning("Could not parse line: %s" % line
)
459 # Skip any lines that are for stats only
460 if country_code
== "*":
463 if type in ("ipv6", "ipv4"):
464 return self
._parse
_ip
_line
(country_code
, type, line
)
466 def _parse_ip_line(self
, country
, type, line
):
468 address
, prefix
, date
, status
, organization
= line
.split("|")
472 # Try parsing the line without organization
474 address
, prefix
, date
, status
= line
.split("|")
476 log
.warning("Unhandled line format: %s" % line
)
479 # Skip anything that isn't properly assigned
480 if not status
in ("assigned", "allocated"):
483 # Cast prefix into an integer
487 log
.warning("Invalid prefix: %s" % prefix
)
490 # Fix prefix length for IPv4
492 prefix
= 32 - int(math
.log(prefix
, 2))
494 # Try to parse the address
496 network
= ipaddress
.ip_network("%s/%s" % (address
, prefix
), strict
=False)
498 log
.warning("Invalid IP address: %s" % address
)
501 self
.db
.execute("INSERT INTO networks(network, country) \
502 VALUES(%s, %s) ON CONFLICT (network) DO \
503 UPDATE SET country = excluded.country",
504 "%s" % network
, country
,
507 def handle_update_announcements(self
, ns
):
508 server
= ns
.server
[0]
510 with self
.db
.transaction():
511 if server
.startswith("/"):
512 self
._handle
_update
_announcements
_from
_bird
(server
)
514 self
._handle
_update
_announcements
_from
_telnet
(server
)
516 # Purge anything we never want here
518 -- Delete default routes
519 DELETE FROM announcements WHERE network = '::/0' OR network = '0.0.0.0/0';
521 -- Delete anything that is not global unicast address space
522 DELETE FROM announcements WHERE family(network) = 6 AND NOT network <<= '2000::/3';
524 -- DELETE "current network" address space
525 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '0.0.0.0/8';
527 -- DELETE local loopback address space
528 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '127.0.0.0/8';
530 -- DELETE RFC 1918 address space
531 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '10.0.0.0/8';
532 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '172.16.0.0/12';
533 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '192.168.0.0/16';
535 -- DELETE test, benchmark and documentation address space
536 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '192.0.0.0/24';
537 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '192.0.2.0/24';
538 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '198.18.0.0/15';
539 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '198.51.100.0/24';
540 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '203.0.113.0/24';
542 -- DELETE CGNAT address space (RFC 6598)
543 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '100.64.0.0/10';
545 -- DELETE link local address space
546 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '169.254.0.0/16';
548 -- DELETE IPv6 to IPv4 (6to4) address space
549 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '192.88.99.0/24';
551 -- DELETE multicast and reserved address space
552 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '224.0.0.0/4';
553 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '240.0.0.0/4';
555 -- Delete networks that are too small to be in the global routing table
556 DELETE FROM announcements WHERE family(network) = 6 AND masklen(network) > 48;
557 DELETE FROM announcements WHERE family(network) = 4 AND masklen(network) > 24;
559 -- Delete any non-public or reserved ASNs
560 DELETE FROM announcements WHERE NOT (
561 (autnum >= 1 AND autnum <= 23455)
563 (autnum >= 23457 AND autnum <= 64495)
565 (autnum >= 131072 AND autnum <= 4199999999)
568 -- Delete everything that we have not seen for 14 days
569 DELETE FROM announcements WHERE last_seen_at <= CURRENT_TIMESTAMP - INTERVAL '14 days';
572 def _handle_update_announcements_from_bird(self
, server
):
573 # Pre-compile the regular expression for faster searching
574 route
= re
.compile(b
"^\s(.+?)\s+.+?\[AS(.*?).\]$")
576 log
.info("Requesting routing table from Bird (%s)" % server
)
578 # Send command to list all routes
579 for line
in self
._bird
_cmd
(server
, "show route"):
580 m
= route
.match(line
)
582 log
.debug("Could not parse line: %s" % line
.decode())
585 # Fetch the extracted network and ASN
586 network
, autnum
= m
.groups()
588 # Insert it into the database
589 self
.db
.execute("INSERT INTO announcements(network, autnum) \
590 VALUES(%s, %s) ON CONFLICT (network) DO \
591 UPDATE SET autnum = excluded.autnum, last_seen_at = CURRENT_TIMESTAMP",
592 network
.decode(), autnum
.decode(),
595 def _handle_update_announcements_from_telnet(self
, server
):
596 # Pre-compile regular expression for routes
597 route
= re
.compile(b
"^\*[\s\>]i([^\s]+).+?(\d+)\si\r\n", re
.MULTILINE|re
.DOTALL
)
599 with telnetlib
.Telnet(server
) as t
:
602 # t.set_debuglevel(10)
604 # Wait for console greeting
605 greeting
= t
.read_until(b
"> ", timeout
=30)
607 log
.error("Could not get a console prompt")
611 t
.write(b
"terminal length 0\n")
613 # Wait for the prompt to return
616 # Fetch the routing tables
617 for protocol
in ("ipv6", "ipv4"):
618 log
.info("Requesting %s routing table" % protocol
)
620 # Request the full unicast routing table
621 t
.write(b
"show bgp %s unicast\n" % protocol
.encode())
623 # Read entire header which ends with "Path"
624 t
.read_until(b
"Path\r\n")
627 # Try reading a full entry
628 # Those might be broken across multiple lines but ends with i
629 line
= t
.read_until(b
"i\r\n", timeout
=5)
633 # Show line for debugging
634 #log.debug(repr(line))
636 # Try finding a route in here
637 m
= route
.match(line
)
639 network
, autnum
= m
.groups()
641 # Convert network to string
642 network
= network
.decode()
644 # Append /24 for IPv4 addresses
645 if not "/" in network
and not ":" in network
:
646 network
= "%s/24" % network
648 # Convert AS number to integer
651 log
.info("Found announcement for %s by %s" % (network
, autnum
))
653 self
.db
.execute("INSERT INTO announcements(network, autnum) \
654 VALUES(%s, %s) ON CONFLICT (network) DO \
655 UPDATE SET autnum = excluded.autnum, last_seen_at = CURRENT_TIMESTAMP",
659 log
.info("Finished reading the %s routing table" % protocol
)
661 def _bird_cmd(self
, socket_path
, command
):
662 # Connect to the socket
663 s
= socket
.socket(socket
.AF_UNIX
, socket
.SOCK_STREAM
)
664 s
.connect(socket_path
)
666 # Allocate some buffer
670 s
.send(b
"%s\n" % command
.encode())
674 buffer += s
.recv(4096)
677 # Search for the next newline
678 pos
= buffer.find(b
"\n")
680 # If we cannot find one, we go back and read more data
684 # Cut after the newline character
687 # Split the line we want and keep the rest in buffer
688 line
, buffer = buffer[:pos
], buffer[pos
:]
690 # Look for the end-of-output indicator
691 if line
== b
"0000 \n":
694 # Otherwise return the line
697 def handle_update_overrides(self
, ns
):
698 with self
.db
.transaction():
699 # Drop all data that we have
701 TRUNCATE TABLE autnum_overrides;
702 TRUNCATE TABLE network_overrides;
705 for file in ns
.files
:
706 log
.info("Reading %s..." % file)
708 with
open(file, "rb") as f
:
709 for type, block
in location
.importer
.read_blocks(f
):
711 network
= block
.get("net")
712 # Try to parse and normalise the network
714 network
= ipaddress
.ip_network(network
, strict
=False)
715 except ValueError as e
:
716 log
.warning("Invalid IP network: %s: %s" % (network
, e
))
719 # Prevent that we overwrite all networks
720 if network
.prefixlen
== 0:
721 log
.warning("Skipping %s: You cannot overwrite default" % network
)
725 INSERT INTO network_overrides(
729 is_satellite_provider,
731 ) VALUES (%s, %s, %s, %s, %s)
732 ON CONFLICT (network) DO NOTHING""",
734 block
.get("country"),
735 self
._parse
_bool
(block
, "is-anonymous-proxy"),
736 self
._parse
_bool
(block
, "is-satellite-provider"),
737 self
._parse
_bool
(block
, "is-anycast"),
740 elif type == "aut-num":
741 autnum
= block
.get("aut-num")
743 # Check if AS number begins with "AS"
744 if not autnum
.startswith("AS"):
745 log
.warning("Invalid AS number: %s" % autnum
)
752 INSERT INTO autnum_overrides(
757 is_satellite_provider,
759 ) VALUES(%s, %s, %s, %s, %s, %s)
760 ON CONFLICT DO NOTHING""",
763 block
.get("country"),
764 self
._parse
_bool
(block
, "is-anonymous-proxy"),
765 self
._parse
_bool
(block
, "is-satellite-provider"),
766 self
._parse
_bool
(block
, "is-anycast"),
770 log
.warning("Unsupport type: %s" % type)
773 def _parse_bool(block
, key
):
776 # There is no point to proceed when we got None
780 # Convert to lowercase
784 if val
in ("yes", "1"):
788 if val
in ("no", "0"):
794 def handle_import_countries(self
, ns
):
795 with self
.db
.transaction():
796 # Drop all data that we have
797 self
.db
.execute("TRUNCATE TABLE countries")
803 # Ignore any comments
804 if line
.startswith("#"):
808 country_code
, continent_code
, name
= line
.split(maxsplit
=2)
810 log
.warning("Could not parse line: %s" % line
)
813 self
.db
.execute("INSERT INTO countries(country_code, name, continent_code) \
814 VALUES(%s, %s, %s) ON CONFLICT DO NOTHING", country_code
, name
, continent_code
)
817 def split_line(line
):
818 key
, colon
, val
= line
.partition(":")
820 # Strip any excess space
827 # Run the command line interface