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 ###############################################################################
28 # Load our location module
30 import location
.database
31 import location
.importer
32 from location
.i18n
import _
35 log
= logging
.getLogger("location.importer")
40 parser
= argparse
.ArgumentParser(
41 description
=_("Location Importer Command Line Interface"),
43 subparsers
= parser
.add_subparsers()
45 # Global configuration flags
46 parser
.add_argument("--debug", action
="store_true",
47 help=_("Enable debug output"))
48 parser
.add_argument("--quiet", action
="store_true",
49 help=_("Enable quiet mode"))
52 parser
.add_argument("--version", action
="version",
53 version
="%(prog)s @VERSION@")
56 parser
.add_argument("--database-host", required
=True,
57 help=_("Database Hostname"), metavar
=_("HOST"))
58 parser
.add_argument("--database-name", required
=True,
59 help=_("Database Name"), metavar
=_("NAME"))
60 parser
.add_argument("--database-username", required
=True,
61 help=_("Database Username"), metavar
=_("USERNAME"))
62 parser
.add_argument("--database-password", required
=True,
63 help=_("Database Password"), metavar
=_("PASSWORD"))
66 write
= subparsers
.add_parser("write", help=_("Write database to file"))
67 write
.set_defaults(func
=self
.handle_write
)
68 write
.add_argument("file", nargs
=1, help=_("Database File"))
69 write
.add_argument("--signing-key", nargs
="?", type=open, help=_("Signing Key"))
70 write
.add_argument("--vendor", nargs
="?", help=_("Sets the vendor"))
71 write
.add_argument("--description", nargs
="?", help=_("Sets a description"))
72 write
.add_argument("--license", nargs
="?", help=_("Sets the license"))
73 write
.add_argument("--version", type=int, help=_("Database Format Version"))
76 update_whois
= subparsers
.add_parser("update-whois", help=_("Update WHOIS Information"))
77 update_whois
.set_defaults(func
=self
.handle_update_whois
)
79 # Update announcements
80 update_announcements
= subparsers
.add_parser("update-announcements",
81 help=_("Update BGP Annoucements"))
82 update_announcements
.set_defaults(func
=self
.handle_update_announcements
)
83 update_announcements
.add_argument("server", nargs
=1,
84 help=_("Route Server to connect to"), metavar
=_("SERVER"))
87 update_overrides
= subparsers
.add_parser("update-overrides",
88 help=_("Update overrides"),
90 update_overrides
.add_argument(
91 "files", nargs
="+", help=_("Files to import"),
93 update_overrides
.set_defaults(func
=self
.handle_update_overrides
)
95 args
= parser
.parse_args()
99 location
.logger
.set_level(logging
.DEBUG
)
101 location
.logger
.set_level(logging
.WARNING
)
103 # Print usage if no action was given
104 if not "func" in args
:
111 # Parse command line arguments
112 args
= self
.parse_cli()
114 # Initialise database
115 self
.db
= self
._setup
_database
(args
)
118 ret
= args
.func(args
)
120 # Return with exit code
124 # Otherwise just exit
127 def _setup_database(self
, ns
):
129 Initialise the database
131 # Connect to database
132 db
= location
.database
.Connection(
133 host
=ns
.database_host
, database
=ns
.database_name
,
134 user
=ns
.database_username
, password
=ns
.database_password
,
137 with db
.transaction():
140 CREATE TABLE IF NOT EXISTS announcements(network inet, autnum bigint,
141 first_seen_at timestamp without time zone DEFAULT CURRENT_TIMESTAMP,
142 last_seen_at timestamp without time zone DEFAULT CURRENT_TIMESTAMP);
143 CREATE UNIQUE INDEX IF NOT EXISTS announcements_networks ON announcements(network);
144 CREATE INDEX IF NOT EXISTS announcements_family ON announcements(family(network));
147 CREATE TABLE IF NOT EXISTS autnums(number bigint, name text NOT NULL);
148 CREATE UNIQUE INDEX IF NOT EXISTS autnums_number ON autnums(number);
151 CREATE TABLE IF NOT EXISTS networks(network inet, country text);
152 CREATE UNIQUE INDEX IF NOT EXISTS networks_network ON networks(network);
153 CREATE INDEX IF NOT EXISTS networks_search ON networks USING GIST(network inet_ops);
156 CREATE TABLE IF NOT EXISTS autnum_overrides(
157 number bigint NOT NULL,
160 is_anonymous_proxy boolean DEFAULT FALSE,
161 is_satellite_provider boolean DEFAULT FALSE,
162 is_anycast boolean DEFAULT FALSE
164 CREATE UNIQUE INDEX IF NOT EXISTS autnum_overrides_number
165 ON autnum_overrides(number);
167 CREATE TABLE IF NOT EXISTS network_overrides(
168 network inet NOT NULL,
170 is_anonymous_proxy boolean DEFAULT FALSE,
171 is_satellite_provider boolean DEFAULT FALSE,
172 is_anycast boolean DEFAULT FALSE
174 CREATE UNIQUE INDEX IF NOT EXISTS network_overrides_network
175 ON network_overrides(network);
180 def handle_write(self
, ns
):
182 Compiles a database in libloc format out of what is in the database
185 writer
= location
.Writer(ns
.signing_key
)
189 writer
.vendor
= ns
.vendor
192 writer
.description
= ns
.description
195 writer
.license
= ns
.license
197 # Add all Autonomous Systems
198 log
.info("Writing Autonomous Systems...")
200 # Select all ASes with a name
201 rows
= self
.db
.query("""
203 autnums.number AS number,
205 (SELECT overrides.name FROM autnum_overrides overrides
206 WHERE overrides.number = autnums.number),
210 WHERE name <> %s ORDER BY number
214 a
= writer
.add_as(row
.number
)
218 log
.info("Writing networks...")
220 # Select all known networks
221 rows
= self
.db
.query("""
223 DISTINCT ON (announcements.network)
224 announcements.network AS network,
225 announcements.autnum AS autnum,
230 SELECT country FROM network_overrides overrides
231 WHERE announcements.network <<= overrides.network
232 ORDER BY masklen(overrides.network) DESC
236 SELECT country FROM autnum_overrides overrides
237 WHERE announcements.autnum = overrides.number
242 -- Must be part of returned values for ORDER BY clause
243 masklen(networks.network) AS sort,
248 SELECT is_anonymous_proxy FROM network_overrides overrides
249 WHERE announcements.network <<= overrides.network
250 ORDER BY masklen(overrides.network) DESC
254 SELECT is_anonymous_proxy FROM autnum_overrides overrides
255 WHERE announcements.autnum = overrides.number
257 ) AS is_anonymous_proxy,
260 SELECT is_satellite_provider FROM network_overrides overrides
261 WHERE announcements.network <<= overrides.network
262 ORDER BY masklen(overrides.network) DESC
266 SELECT is_satellite_provider FROM autnum_overrides overrides
267 WHERE announcements.autnum = overrides.number
269 ) AS is_satellite_provider,
272 SELECT is_anycast FROM network_overrides overrides
273 WHERE announcements.network <<= overrides.network
274 ORDER BY masklen(overrides.network) DESC
278 SELECT is_anycast FROM autnum_overrides overrides
279 WHERE announcements.autnum = overrides.number
283 LEFT JOIN networks ON announcements.network <<= networks.network
284 ORDER BY announcements.network, sort DESC
288 network
= writer
.add_network(row
.network
)
291 network
.asn
, network
.country_code
= row
.autnum
, row
.country
294 if row
.is_anonymous_proxy
:
295 network
.set_flag(location
.NETWORK_FLAG_ANONYMOUS_PROXY
)
297 if row
.is_satellite_provider
:
298 network
.set_flag(location
.NETWORK_FLAG_SATELLITE_PROVIDER
)
301 network
.set_flag(location
.NETWORK_FLAG_ANYCAST
)
303 # Write everything to file
304 log
.info("Writing database to file...")
308 def handle_update_whois(self
, ns
):
309 downloader
= location
.importer
.Downloader()
311 # Download all sources
312 with self
.db
.transaction():
313 # Create some temporary tables to store parsed data
315 CREATE TEMPORARY TABLE _autnums(number integer, organization text)
317 CREATE UNIQUE INDEX _autnums_number ON _autnums(number);
319 CREATE TEMPORARY TABLE _organizations(handle text, name text)
321 CREATE UNIQUE INDEX _organizations_handle ON _organizations(handle);
324 for source
in location
.importer
.WHOIS_SOURCES
:
325 with downloader
.request(source
, return_blocks
=True) as f
:
327 self
._parse
_block
(block
)
330 INSERT INTO autnums(number, name)
331 SELECT _autnums.number, _organizations.name FROM _autnums
332 LEFT JOIN _organizations ON _autnums.organization = _organizations.handle
333 ON CONFLICT (number) DO UPDATE SET name = excluded.name;
336 # Download all extended sources
337 for source
in location
.importer
.EXTENDED_SOURCES
:
338 with self
.db
.transaction():
340 with downloader
.request(source
) as f
:
342 self
._parse
_line
(line
)
344 def _parse_block(self
, block
):
345 # Get first line to find out what type of block this is
349 if line
.startswith("aut-num:"):
350 return self
._parse
_autnum
_block
(block
)
353 elif line
.startswith("organisation:"):
354 return self
._parse
_org
_block
(block
)
356 def _parse_autnum_block(self
, block
):
360 key
, val
= split_line(line
)
363 m
= re
.match(r
"^(AS|as)(\d+)", val
)
365 autnum
["asn"] = m
.group(2)
374 # Insert into database
375 self
.db
.execute("INSERT INTO _autnums(number, organization) \
376 VALUES(%s, %s) ON CONFLICT (number) DO UPDATE SET \
377 organization = excluded.organization",
378 autnum
.get("asn"), autnum
.get("org"),
381 def _parse_org_block(self
, block
):
385 key
, val
= split_line(line
)
387 if key
in ("organisation", "org-name"):
394 self
.db
.execute("INSERT INTO _organizations(handle, name) \
395 VALUES(%s, %s) ON CONFLICT (handle) DO \
396 UPDATE SET name = excluded.name",
397 org
.get("organisation"), org
.get("org-name"),
400 def _parse_line(self
, line
):
402 if line
.startswith("2"):
406 if line
.startswith("#"):
410 registry
, country_code
, type, line
= line
.split("|", 3)
412 log
.warning("Could not parse line: %s" % line
)
415 # Skip any lines that are for stats only
416 if country_code
== "*":
419 if type in ("ipv6", "ipv4"):
420 return self
._parse
_ip
_line
(country_code
, type, line
)
422 def _parse_ip_line(self
, country
, type, line
):
424 address
, prefix
, date
, status
, organization
= line
.split("|")
428 # Try parsing the line without organization
430 address
, prefix
, date
, status
= line
.split("|")
432 log
.warning("Unhandled line format: %s" % line
)
435 # Skip anything that isn't properly assigned
436 if not status
in ("assigned", "allocated"):
439 # Cast prefix into an integer
443 log
.warning("Invalid prefix: %s" % prefix
)
446 # Fix prefix length for IPv4
448 prefix
= 32 - int(math
.log(prefix
, 2))
450 # Try to parse the address
452 network
= ipaddress
.ip_network("%s/%s" % (address
, prefix
), strict
=False)
454 log
.warning("Invalid IP address: %s" % address
)
457 self
.db
.execute("INSERT INTO networks(network, country) \
458 VALUES(%s, %s) ON CONFLICT (network) DO \
459 UPDATE SET country = excluded.country",
460 "%s" % network
, country
,
463 def handle_update_announcements(self
, ns
):
464 server
= ns
.server
[0]
466 # Pre-compile regular expression for routes
467 route
= re
.compile(b
"^\*[\s\>]i([^\s]+).+?(\d+)\si\r\n", re
.MULTILINE|re
.DOTALL
)
469 with telnetlib
.Telnet(server
) as t
:
472 # t.set_debuglevel(10)
474 # Wait for console greeting
475 greeting
= t
.read_until(b
"> ", timeout
=30)
477 log
.error("Could not get a console prompt")
481 t
.write(b
"terminal length 0\n")
483 # Wait for the prompt to return
486 # Fetch the routing tables
487 with self
.db
.transaction():
488 for protocol
in ("ipv6", "ipv4"):
489 log
.info("Requesting %s routing table" % protocol
)
491 # Request the full unicast routing table
492 t
.write(b
"show bgp %s unicast\n" % protocol
.encode())
494 # Read entire header which ends with "Path"
495 t
.read_until(b
"Path\r\n")
498 # Try reading a full entry
499 # Those might be broken across multiple lines but ends with i
500 line
= t
.read_until(b
"i\r\n", timeout
=5)
504 # Show line for debugging
505 #log.debug(repr(line))
507 # Try finding a route in here
508 m
= route
.match(line
)
510 network
, autnum
= m
.groups()
512 # Convert network to string
513 network
= network
.decode()
515 # Append /24 for IPv4 addresses
516 if not "/" in network
and not ":" in network
:
517 network
= "%s/24" % network
519 # Convert AS number to integer
522 log
.info("Found announcement for %s by %s" % (network
, autnum
))
524 self
.db
.execute("INSERT INTO announcements(network, autnum) \
525 VALUES(%s, %s) ON CONFLICT (network) DO \
526 UPDATE SET autnum = excluded.autnum, last_seen_at = CURRENT_TIMESTAMP",
530 log
.info("Finished reading the %s routing table" % protocol
)
532 # Purge anything we never want here
534 -- Delete default routes
535 DELETE FROM announcements WHERE network = '::/0' OR network = '0.0.0.0/0';
537 -- Delete anything that is not global unicast address space
538 DELETE FROM announcements WHERE family(network) = 6 AND NOT network <<= '2000::/3';
540 -- DELETE "current network" address space
541 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '0.0.0.0/8';
543 -- DELETE local loopback address space
544 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '127.0.0.0/8';
546 -- DELETE RFC 1918 address space
547 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '10.0.0.0/8';
548 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '172.16.0.0/12';
549 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '192.168.0.0/16';
551 -- DELETE test, benchmark and documentation address space
552 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '192.0.0.0/24';
553 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '192.0.2.0/24';
554 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '198.18.0.0/15';
555 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '198.51.100.0/24';
556 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '203.0.113.0/24';
558 -- DELETE CGNAT address space (RFC 6598)
559 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '100.64.0.0/10';
561 -- DELETE link local address space
562 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '169.254.0.0/16';
564 -- DELETE IPv6 to IPv4 (6to4) address space
565 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '192.88.99.0/24';
567 -- DELETE multicast and reserved address space
568 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '224.0.0.0/4';
569 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '240.0.0.0/4';
571 -- Delete networks that are too small to be in the global routing table
572 DELETE FROM announcements WHERE family(network) = 6 AND masklen(network) > 48;
573 DELETE FROM announcements WHERE family(network) = 4 AND masklen(network) > 24;
575 -- Delete any non-public or reserved ASNs
576 DELETE FROM announcements WHERE NOT (
577 (autnum >= 1 AND autnum <= 23455)
579 (autnum >= 23457 AND autnum <= 64495)
581 (autnum >= 131072 AND autnum <= 4199999999)
584 -- Delete everything that we have not seen for 14 days
585 DELETE FROM announcements WHERE last_seen_at <= CURRENT_TIMESTAMP - INTERVAL '14 days';
588 def handle_update_overrides(self
, ns
):
589 with self
.db
.transaction():
590 # Drop all data that we have
592 TRUNCATE TABLE autnum_overrides;
593 TRUNCATE TABLE network_overrides;
596 for file in ns
.files
:
597 log
.info("Reading %s..." % file)
599 with
open(file, "rb") as f
:
600 for type, block
in location
.importer
.read_blocks(f
):
602 network
= block
.get("net")
603 # Try to parse and normalise the network
605 network
= ipaddress
.ip_network(network
, strict
=False)
606 except ValueError as e
:
607 log
.warning("Invalid IP network: %s: %s" % (network
, e
))
610 # Prevent that we overwrite all networks
611 if network
.prefixlen
== 0:
612 log
.warning("Skipping %s: You cannot overwrite default" % network
)
616 INSERT INTO network_overrides(
620 is_satellite_provider,
622 ) VALUES (%s, %s, %s, %s, %s)
623 ON CONFLICT (network) DO NOTHING""",
625 block
.get("country"),
626 block
.get("is-anonymous-proxy") == "yes",
627 block
.get("is-satellite-provider") == "yes",
628 block
.get("is-anycast") == "yes",
631 elif type == "aut-num":
632 autnum
= block
.get("aut-num")
634 # Check if AS number begins with "AS"
635 if not autnum
.startswith("AS"):
636 log
.warning("Invalid AS number: %s" % autnum
)
643 INSERT INTO autnum_overrides(
648 is_satellite_provider,
650 ) VALUES(%s, %s, %s, %s, %s, %s)
651 ON CONFLICT DO NOTHING""",
654 block
.get("country"),
655 block
.get("is-anonymous-proxy") == "yes",
656 block
.get("is-satellite-provider") == "yes",
657 block
.get("is-anycast") == "yes",
661 log
.warning("Unsupport type: %s" % type)
664 def split_line(line
):
665 key
, colon
, val
= line
.partition(":")
667 # Strip any excess space
674 # Run the command line interface