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"))
75 update_whois
= subparsers
.add_parser("update-whois", help=_("Update WHOIS Information"))
76 update_whois
.set_defaults(func
=self
.handle_update_whois
)
78 # Update announcements
79 update_announcements
= subparsers
.add_parser("update-announcements",
80 help=_("Update BGP Annoucements"))
81 update_announcements
.set_defaults(func
=self
.handle_update_announcements
)
82 update_announcements
.add_argument("server", nargs
=1,
83 help=_("Route Server to connect to"), metavar
=_("SERVER"))
86 update_overrides
= subparsers
.add_parser("update-overrides",
87 help=_("Update overrides"),
89 update_overrides
.add_argument(
90 "files", nargs
="+", help=_("Files to import"),
92 update_overrides
.set_defaults(func
=self
.handle_update_overrides
)
94 args
= parser
.parse_args()
98 location
.logger
.set_level(logging
.DEBUG
)
100 location
.logger
.set_level(logging
.WARNING
)
102 # Print usage if no action was given
103 if not "func" in args
:
110 # Parse command line arguments
111 args
= self
.parse_cli()
113 # Initialise database
114 self
.db
= self
._setup
_database
(args
)
117 ret
= args
.func(args
)
119 # Return with exit code
123 # Otherwise just exit
126 def _setup_database(self
, ns
):
128 Initialise the database
130 # Connect to database
131 db
= location
.database
.Connection(
132 host
=ns
.database_host
, database
=ns
.database_name
,
133 user
=ns
.database_username
, password
=ns
.database_password
,
136 with db
.transaction():
139 CREATE TABLE IF NOT EXISTS announcements(network inet, autnum bigint,
140 first_seen_at timestamp without time zone DEFAULT CURRENT_TIMESTAMP,
141 last_seen_at timestamp without time zone DEFAULT CURRENT_TIMESTAMP);
142 CREATE UNIQUE INDEX IF NOT EXISTS announcements_networks ON announcements(network);
143 CREATE INDEX IF NOT EXISTS announcements_family ON announcements(family(network));
146 CREATE TABLE IF NOT EXISTS autnums(number bigint, name text NOT NULL);
147 CREATE UNIQUE INDEX IF NOT EXISTS autnums_number ON autnums(number);
150 CREATE TABLE IF NOT EXISTS networks(network inet, country text);
151 CREATE UNIQUE INDEX IF NOT EXISTS networks_network ON networks(network);
152 CREATE INDEX IF NOT EXISTS networks_search ON networks USING GIST(network inet_ops);
155 CREATE TABLE IF NOT EXISTS autnum_overrides(
156 number bigint NOT NULL,
158 is_anonymous_proxy boolean DEFAULT FALSE,
159 is_satellite_provider boolean DEFAULT FALSE,
160 is_anycast boolean DEFAULT FALSE
162 CREATE UNIQUE INDEX IF NOT EXISTS autnum_overrides_number
163 ON autnum_overrides(number);
165 CREATE TABLE IF NOT EXISTS network_overrides(
166 network inet NOT NULL,
168 is_anonymous_proxy boolean DEFAULT FALSE,
169 is_satellite_provider boolean DEFAULT FALSE,
170 is_anycast boolean DEFAULT FALSE
172 CREATE UNIQUE INDEX IF NOT EXISTS network_overrides_network
173 ON network_overrides(network);
178 def handle_write(self
, ns
):
180 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,
226 networks.country AS country,
228 -- Must be part of returned values for ORDER BY clause
229 masklen(networks.network) AS sort,
234 SELECT is_anonymous_proxy FROM network_overrides overrides
235 WHERE announcements.network <<= overrides.network
236 ORDER BY masklen(overrides.network) DESC
240 SELECT is_anonymous_proxy FROM autnum_overrides overrides
241 WHERE announcements.autnum = overrides.number
243 ) AS is_anonymous_proxy,
246 SELECT is_satellite_provider FROM network_overrides overrides
247 WHERE announcements.network <<= overrides.network
248 ORDER BY masklen(overrides.network) DESC
252 SELECT is_satellite_provider FROM autnum_overrides overrides
253 WHERE announcements.autnum = overrides.number
255 ) AS is_satellite_provider,
258 SELECT is_anycast FROM network_overrides overrides
259 WHERE announcements.network <<= overrides.network
260 ORDER BY masklen(overrides.network) DESC
264 SELECT is_anycast FROM autnum_overrides overrides
265 WHERE announcements.autnum = overrides.number
269 LEFT JOIN networks ON announcements.network <<= networks.network
270 ORDER BY announcements.network, sort DESC
274 network
= writer
.add_network(row
.network
)
277 network
.asn
, network
.country_code
= row
.autnum
, row
.country
280 if row
.is_anonymous_proxy
:
281 network
.set_flag(location
.NETWORK_FLAG_ANONYMOUS_PROXY
)
283 if row
.is_satellite_provider
:
284 network
.set_flag(location
.NETWORK_FLAG_SATELLITE_PROVIDER
)
287 network
.set_flag(location
.NETWORK_FLAG_ANYCAST
)
289 # Write everything to file
290 log
.info("Writing database to file...")
294 def handle_update_whois(self
, ns
):
295 downloader
= location
.importer
.Downloader()
297 # Download all sources
298 with self
.db
.transaction():
299 # Create some temporary tables to store parsed data
301 CREATE TEMPORARY TABLE _autnums(number integer, organization text)
303 CREATE UNIQUE INDEX _autnums_number ON _autnums(number);
305 CREATE TEMPORARY TABLE _organizations(handle text, name text)
307 CREATE UNIQUE INDEX _organizations_handle ON _organizations(handle);
310 for source
in location
.importer
.WHOIS_SOURCES
:
311 with downloader
.request(source
, return_blocks
=True) as f
:
313 self
._parse
_block
(block
)
316 INSERT INTO autnums(number, name)
317 SELECT _autnums.number, _organizations.name FROM _autnums
318 LEFT JOIN _organizations ON _autnums.organization = _organizations.handle
319 ON CONFLICT (number) DO UPDATE SET name = excluded.name;
322 # Download all extended sources
323 for source
in location
.importer
.EXTENDED_SOURCES
:
324 with self
.db
.transaction():
326 with downloader
.request(source
) as f
:
328 self
._parse
_line
(line
)
330 def _parse_block(self
, block
):
331 # Get first line to find out what type of block this is
335 if line
.startswith("aut-num:"):
336 return self
._parse
_autnum
_block
(block
)
339 elif line
.startswith("organisation:"):
340 return self
._parse
_org
_block
(block
)
342 def _parse_autnum_block(self
, block
):
346 key
, val
= split_line(line
)
349 m
= re
.match(r
"^(AS|as)(\d+)", val
)
351 autnum
["asn"] = m
.group(2)
360 # Insert into database
361 self
.db
.execute("INSERT INTO _autnums(number, organization) \
362 VALUES(%s, %s) ON CONFLICT (number) DO UPDATE SET \
363 organization = excluded.organization",
364 autnum
.get("asn"), autnum
.get("org"),
367 def _parse_org_block(self
, block
):
371 key
, val
= split_line(line
)
373 if key
in ("organisation", "org-name"):
380 self
.db
.execute("INSERT INTO _organizations(handle, name) \
381 VALUES(%s, %s) ON CONFLICT (handle) DO \
382 UPDATE SET name = excluded.name",
383 org
.get("organisation"), org
.get("org-name"),
386 def _parse_line(self
, line
):
388 if line
.startswith("2"):
392 if line
.startswith("#"):
396 registry
, country_code
, type, line
= line
.split("|", 3)
398 log
.warning("Could not parse line: %s" % line
)
401 # Skip any lines that are for stats only
402 if country_code
== "*":
405 if type in ("ipv6", "ipv4"):
406 return self
._parse
_ip
_line
(country_code
, type, line
)
408 def _parse_ip_line(self
, country
, type, line
):
410 address
, prefix
, date
, status
, organization
= line
.split("|")
414 # Try parsing the line without organization
416 address
, prefix
, date
, status
= line
.split("|")
418 log
.warning("Unhandled line format: %s" % line
)
421 # Skip anything that isn't properly assigned
422 if not status
in ("assigned", "allocated"):
425 # Cast prefix into an integer
429 log
.warning("Invalid prefix: %s" % prefix
)
432 # Fix prefix length for IPv4
434 prefix
= 32 - int(math
.log(prefix
, 2))
436 # Try to parse the address
438 network
= ipaddress
.ip_network("%s/%s" % (address
, prefix
), strict
=False)
440 log
.warning("Invalid IP address: %s" % address
)
443 self
.db
.execute("INSERT INTO networks(network, country) \
444 VALUES(%s, %s) ON CONFLICT (network) DO \
445 UPDATE SET country = excluded.country",
446 "%s" % network
, country
,
449 def handle_update_announcements(self
, ns
):
450 server
= ns
.server
[0]
452 # Pre-compile regular expression for routes
453 #route = re.compile(b"^\*>?\s[\si]?([^\s]+)[.\s]*?(\d+)\si$", re.MULTILINE)
454 route
= re
.compile(b
"^\*[\s\>]i([^\s]+).+?(\d+)\si\r\n", re
.MULTILINE|re
.DOTALL
)
456 with telnetlib
.Telnet(server
) as t
:
459 # t.set_debuglevel(10)
461 # Wait for console greeting
462 greeting
= t
.read_until(b
"> ")
463 log
.debug(greeting
.decode())
466 t
.write(b
"terminal length 0\n")
468 # Wait for the prompt to return
471 # Fetch the routing tables
472 with self
.db
.transaction():
473 for protocol
in ("ipv6", "ipv4"):
474 log
.info("Requesting %s routing table" % protocol
)
476 # Request the full unicast routing table
477 t
.write(b
"show bgp %s unicast\n" % protocol
.encode())
479 # Read entire header which ends with "Path"
480 t
.read_until(b
"Path\r\n")
483 # Try reading a full entry
484 # Those might be broken across multiple lines but ends with i
485 line
= t
.read_until(b
"i\r\n", timeout
=5)
489 # Show line for debugging
490 #log.debug(repr(line))
492 # Try finding a route in here
493 m
= route
.match(line
)
495 network
, autnum
= m
.groups()
497 # Convert network to string
498 network
= network
.decode()
500 # Append /24 for IPv4 addresses
501 if not "/" in network
and not ":" in network
:
502 network
= "%s/24" % network
504 # Convert AS number to integer
507 log
.info("Found announcement for %s by %s" % (network
, autnum
))
509 self
.db
.execute("INSERT INTO announcements(network, autnum) \
510 VALUES(%s, %s) ON CONFLICT (network) DO \
511 UPDATE SET autnum = excluded.autnum, last_seen_at = CURRENT_TIMESTAMP",
515 log
.info("Finished reading the %s routing table" % protocol
)
517 # Purge anything we never want here
519 -- Delete default routes
520 DELETE FROM announcements WHERE network = '::/0' OR network = '0.0.0.0/0';
522 -- Delete anything that is not global unicast address space
523 DELETE FROM announcements WHERE family(network) = 6 AND NOT network <<= '2000::/3';
525 -- DELETE "current network" address space
526 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '0.0.0.0/8';
528 -- DELETE local loopback address space
529 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '127.0.0.0/8';
531 -- DELETE RFC 1918 address space
532 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '10.0.0.0/8';
533 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '172.16.0.0/12';
534 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '192.168.0.0/16';
536 -- DELETE test, benchmark and documentation address space
537 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '192.0.0.0/24';
538 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '192.0.2.0/24';
539 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '198.18.0.0/15';
540 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '198.51.100.0/24';
541 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '203.0.113.0/24';
543 -- DELETE CGNAT address space (RFC 6598)
544 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '100.64.0.0/10';
546 -- DELETE link local address space
547 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '169.254.0.0/16';
549 -- DELETE IPv6 to IPv4 (6to4) address space
550 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '192.88.99.0/24';
552 -- DELETE multicast and reserved address space
553 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '224.0.0.0/4';
554 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '240.0.0.0/4';
556 -- Delete networks that are too small to be in the global routing table
557 DELETE FROM announcements WHERE family(network) = 6 AND masklen(network) > 48;
558 DELETE FROM announcements WHERE family(network) = 4 AND masklen(network) > 24;
560 -- Delete any non-public or reserved ASNs
561 DELETE FROM announcements WHERE NOT (
562 (autnum >= 1 AND autnum <= 23455)
564 (autnum >= 23457 AND autnum <= 64495)
566 (autnum >= 131072 AND autnum <= 4199999999)
569 -- Delete everything that we have not seen for 14 days
570 DELETE FROM announcements WHERE last_seen_at <= CURRENT_TIMESTAMP - INTERVAL '14 days';
573 def handle_update_overrides(self
, ns
):
574 with self
.db
.transaction():
575 # Drop all data that we have
577 TRUNCATE TABLE autnum_overrides;
578 TRUNCATE TABLE network_overrides;
581 for file in ns
.files
:
582 log
.info("Reading %s..." % file)
584 with
open(file, "rb") as f
:
585 for type, block
in location
.importer
.read_blocks(f
):
587 network
= block
.get("net")
588 # Try to parse and normalise the network
590 network
= ipaddress
.ip_network(network
, strict
=False)
591 except ValueError as e
:
592 log
.warning("Invalid IP network: %s: %s" % (network
, e
))
596 INSERT INTO network_overrides(
600 is_satellite_provider,
602 ) VALUES (%s, %s, %s, %s, %s)
603 ON CONFLICT (network) DO NOTHING""",
605 block
.get("country"),
606 block
.get("is-anonymous-proxy") == "yes",
607 block
.get("is-satellite-provider") == "yes",
608 block
.get("is-anycast") == "yes",
611 elif type == "autnum":
612 autnum
= block
.get("autnum")
614 # Check if AS number begins with "AS"
615 if not autnum
.startswith("AS"):
616 log
.warning("Invalid AS number: %s" % autnum
)
623 INSERT INTO autnum_overrides(
627 is_satellite_provider,
629 ) VALUES(%s, %s, %s, %s, %s)
630 ON CONFLICT DO NOTHING""",
631 autnum
, block
.get("name"),
632 block
.get("is-anonymous-proxy") == "yes",
633 block
.get("is-satellite-provider") == "yes",
634 block
.get("is-anycast") == "yes",
638 log
.warning("Unsupport type: %s" % type)
641 def split_line(line
):
642 key
, colon
, val
= line
.partition(":")
644 # Strip any excess space
651 # Run the command line interface