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,
159 is_anonymous_proxy boolean DEFAULT FALSE,
160 is_satellite_provider boolean DEFAULT FALSE,
161 is_anycast boolean DEFAULT FALSE
163 CREATE UNIQUE INDEX IF NOT EXISTS autnum_overrides_number
164 ON autnum_overrides(number);
166 CREATE TABLE IF NOT EXISTS network_overrides(
167 network inet NOT NULL,
169 is_anonymous_proxy boolean DEFAULT FALSE,
170 is_satellite_provider boolean DEFAULT FALSE,
171 is_anycast boolean DEFAULT FALSE
173 CREATE UNIQUE INDEX IF NOT EXISTS network_overrides_network
174 ON network_overrides(network);
179 def handle_write(self
, ns
):
181 Compiles a database in libloc format out of what is in the database
184 writer
= location
.Writer(ns
.signing_key
)
188 writer
.vendor
= ns
.vendor
191 writer
.description
= ns
.description
194 writer
.license
= ns
.license
196 # Add all Autonomous Systems
197 log
.info("Writing Autonomous Systems...")
199 # Select all ASes with a name
200 rows
= self
.db
.query("""
202 autnums.number AS number,
204 (SELECT overrides.name FROM autnum_overrides overrides
205 WHERE overrides.number = autnums.number),
209 WHERE name <> %s ORDER BY number
213 a
= writer
.add_as(row
.number
)
217 log
.info("Writing networks...")
219 # Select all known networks
220 rows
= self
.db
.query("""
222 DISTINCT ON (announcements.network)
223 announcements.network AS network,
224 announcements.autnum AS autnum,
229 SELECT country FROM network_overrides overrides
230 WHERE announcements.network <<= overrides.network
231 ORDER BY masklen(overrides.network) DESC
235 SELECT country FROM autnum_overrides overrides
236 WHERE announcements.autnum = overrides.number
241 -- Must be part of returned values for ORDER BY clause
242 masklen(networks.network) AS sort,
247 SELECT is_anonymous_proxy FROM network_overrides overrides
248 WHERE announcements.network <<= overrides.network
249 ORDER BY masklen(overrides.network) DESC
253 SELECT is_anonymous_proxy FROM autnum_overrides overrides
254 WHERE announcements.autnum = overrides.number
256 ) AS is_anonymous_proxy,
259 SELECT is_satellite_provider FROM network_overrides overrides
260 WHERE announcements.network <<= overrides.network
261 ORDER BY masklen(overrides.network) DESC
265 SELECT is_satellite_provider FROM autnum_overrides overrides
266 WHERE announcements.autnum = overrides.number
268 ) AS is_satellite_provider,
271 SELECT is_anycast FROM network_overrides overrides
272 WHERE announcements.network <<= overrides.network
273 ORDER BY masklen(overrides.network) DESC
277 SELECT is_anycast FROM autnum_overrides overrides
278 WHERE announcements.autnum = overrides.number
282 LEFT JOIN networks ON announcements.network <<= networks.network
283 ORDER BY announcements.network, sort DESC
287 network
= writer
.add_network(row
.network
)
290 network
.asn
, network
.country_code
= row
.autnum
, row
.country
293 if row
.is_anonymous_proxy
:
294 network
.set_flag(location
.NETWORK_FLAG_ANONYMOUS_PROXY
)
296 if row
.is_satellite_provider
:
297 network
.set_flag(location
.NETWORK_FLAG_SATELLITE_PROVIDER
)
300 network
.set_flag(location
.NETWORK_FLAG_ANYCAST
)
302 # Write everything to file
303 log
.info("Writing database to file...")
307 def handle_update_whois(self
, ns
):
308 downloader
= location
.importer
.Downloader()
310 # Download all sources
311 with self
.db
.transaction():
312 # Create some temporary tables to store parsed data
314 CREATE TEMPORARY TABLE _autnums(number integer, organization text)
316 CREATE UNIQUE INDEX _autnums_number ON _autnums(number);
318 CREATE TEMPORARY TABLE _organizations(handle text, name text)
320 CREATE UNIQUE INDEX _organizations_handle ON _organizations(handle);
323 for source
in location
.importer
.WHOIS_SOURCES
:
324 with downloader
.request(source
, return_blocks
=True) as f
:
326 self
._parse
_block
(block
)
329 INSERT INTO autnums(number, name)
330 SELECT _autnums.number, _organizations.name FROM _autnums
331 LEFT JOIN _organizations ON _autnums.organization = _organizations.handle
332 ON CONFLICT (number) DO UPDATE SET name = excluded.name;
335 # Download all extended sources
336 for source
in location
.importer
.EXTENDED_SOURCES
:
337 with self
.db
.transaction():
339 with downloader
.request(source
) as f
:
341 self
._parse
_line
(line
)
343 def _parse_block(self
, block
):
344 # Get first line to find out what type of block this is
348 if line
.startswith("aut-num:"):
349 return self
._parse
_autnum
_block
(block
)
352 elif line
.startswith("organisation:"):
353 return self
._parse
_org
_block
(block
)
355 def _parse_autnum_block(self
, block
):
359 key
, val
= split_line(line
)
362 m
= re
.match(r
"^(AS|as)(\d+)", val
)
364 autnum
["asn"] = m
.group(2)
373 # Insert into database
374 self
.db
.execute("INSERT INTO _autnums(number, organization) \
375 VALUES(%s, %s) ON CONFLICT (number) DO UPDATE SET \
376 organization = excluded.organization",
377 autnum
.get("asn"), autnum
.get("org"),
380 def _parse_org_block(self
, block
):
384 key
, val
= split_line(line
)
386 if key
in ("organisation", "org-name"):
393 self
.db
.execute("INSERT INTO _organizations(handle, name) \
394 VALUES(%s, %s) ON CONFLICT (handle) DO \
395 UPDATE SET name = excluded.name",
396 org
.get("organisation"), org
.get("org-name"),
399 def _parse_line(self
, line
):
401 if line
.startswith("2"):
405 if line
.startswith("#"):
409 registry
, country_code
, type, line
= line
.split("|", 3)
411 log
.warning("Could not parse line: %s" % line
)
414 # Skip any lines that are for stats only
415 if country_code
== "*":
418 if type in ("ipv6", "ipv4"):
419 return self
._parse
_ip
_line
(country_code
, type, line
)
421 def _parse_ip_line(self
, country
, type, line
):
423 address
, prefix
, date
, status
, organization
= line
.split("|")
427 # Try parsing the line without organization
429 address
, prefix
, date
, status
= line
.split("|")
431 log
.warning("Unhandled line format: %s" % line
)
434 # Skip anything that isn't properly assigned
435 if not status
in ("assigned", "allocated"):
438 # Cast prefix into an integer
442 log
.warning("Invalid prefix: %s" % prefix
)
445 # Fix prefix length for IPv4
447 prefix
= 32 - int(math
.log(prefix
, 2))
449 # Try to parse the address
451 network
= ipaddress
.ip_network("%s/%s" % (address
, prefix
), strict
=False)
453 log
.warning("Invalid IP address: %s" % address
)
456 self
.db
.execute("INSERT INTO networks(network, country) \
457 VALUES(%s, %s) ON CONFLICT (network) DO \
458 UPDATE SET country = excluded.country",
459 "%s" % network
, country
,
462 def handle_update_announcements(self
, ns
):
463 server
= ns
.server
[0]
465 # Pre-compile regular expression for routes
466 #route = re.compile(b"^\*>?\s[\si]?([^\s]+)[.\s]*?(\d+)\si$", re.MULTILINE)
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
"> ")
476 log
.debug(greeting
.decode())
479 t
.write(b
"terminal length 0\n")
481 # Wait for the prompt to return
484 # Fetch the routing tables
485 with self
.db
.transaction():
486 for protocol
in ("ipv6", "ipv4"):
487 log
.info("Requesting %s routing table" % protocol
)
489 # Request the full unicast routing table
490 t
.write(b
"show bgp %s unicast\n" % protocol
.encode())
492 # Read entire header which ends with "Path"
493 t
.read_until(b
"Path\r\n")
496 # Try reading a full entry
497 # Those might be broken across multiple lines but ends with i
498 line
= t
.read_until(b
"i\r\n", timeout
=5)
502 # Show line for debugging
503 #log.debug(repr(line))
505 # Try finding a route in here
506 m
= route
.match(line
)
508 network
, autnum
= m
.groups()
510 # Convert network to string
511 network
= network
.decode()
513 # Append /24 for IPv4 addresses
514 if not "/" in network
and not ":" in network
:
515 network
= "%s/24" % network
517 # Convert AS number to integer
520 log
.info("Found announcement for %s by %s" % (network
, autnum
))
522 self
.db
.execute("INSERT INTO announcements(network, autnum) \
523 VALUES(%s, %s) ON CONFLICT (network) DO \
524 UPDATE SET autnum = excluded.autnum, last_seen_at = CURRENT_TIMESTAMP",
528 log
.info("Finished reading the %s routing table" % protocol
)
530 # Purge anything we never want here
532 -- Delete default routes
533 DELETE FROM announcements WHERE network = '::/0' OR network = '0.0.0.0/0';
535 -- Delete anything that is not global unicast address space
536 DELETE FROM announcements WHERE family(network) = 6 AND NOT network <<= '2000::/3';
538 -- DELETE "current network" address space
539 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '0.0.0.0/8';
541 -- DELETE local loopback address space
542 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '127.0.0.0/8';
544 -- DELETE RFC 1918 address space
545 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '10.0.0.0/8';
546 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '172.16.0.0/12';
547 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '192.168.0.0/16';
549 -- DELETE test, benchmark and documentation address space
550 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '192.0.0.0/24';
551 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '192.0.2.0/24';
552 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '198.18.0.0/15';
553 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '198.51.100.0/24';
554 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '203.0.113.0/24';
556 -- DELETE CGNAT address space (RFC 6598)
557 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '100.64.0.0/10';
559 -- DELETE link local address space
560 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '169.254.0.0/16';
562 -- DELETE IPv6 to IPv4 (6to4) address space
563 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '192.88.99.0/24';
565 -- DELETE multicast and reserved address space
566 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '224.0.0.0/4';
567 DELETE FROM announcements WHERE family(network) = 4 AND network <<= '240.0.0.0/4';
569 -- Delete networks that are too small to be in the global routing table
570 DELETE FROM announcements WHERE family(network) = 6 AND masklen(network) > 48;
571 DELETE FROM announcements WHERE family(network) = 4 AND masklen(network) > 24;
573 -- Delete any non-public or reserved ASNs
574 DELETE FROM announcements WHERE NOT (
575 (autnum >= 1 AND autnum <= 23455)
577 (autnum >= 23457 AND autnum <= 64495)
579 (autnum >= 131072 AND autnum <= 4199999999)
582 -- Delete everything that we have not seen for 14 days
583 DELETE FROM announcements WHERE last_seen_at <= CURRENT_TIMESTAMP - INTERVAL '14 days';
586 def handle_update_overrides(self
, ns
):
587 with self
.db
.transaction():
588 # Drop all data that we have
590 TRUNCATE TABLE autnum_overrides;
591 TRUNCATE TABLE network_overrides;
594 for file in ns
.files
:
595 log
.info("Reading %s..." % file)
597 with
open(file, "rb") as f
:
598 for type, block
in location
.importer
.read_blocks(f
):
600 network
= block
.get("net")
601 # Try to parse and normalise the network
603 network
= ipaddress
.ip_network(network
, strict
=False)
604 except ValueError as e
:
605 log
.warning("Invalid IP network: %s: %s" % (network
, e
))
608 # Prevent that we overwrite all networks
609 if network
.prefixlen
== 0:
610 log
.warning("Skipping %s: You cannot overwrite default" % network
)
614 INSERT INTO network_overrides(
618 is_satellite_provider,
620 ) VALUES (%s, %s, %s, %s, %s)
621 ON CONFLICT (network) DO NOTHING""",
623 block
.get("country"),
624 block
.get("is-anonymous-proxy") == "yes",
625 block
.get("is-satellite-provider") == "yes",
626 block
.get("is-anycast") == "yes",
629 elif type == "aut-num":
630 autnum
= block
.get("aut-num")
632 # Check if AS number begins with "AS"
633 if not autnum
.startswith("AS"):
634 log
.warning("Invalid AS number: %s" % autnum
)
641 INSERT INTO autnum_overrides(
646 is_satellite_provider,
648 ) VALUES(%s, %s, %s, %s, %s, %s)
649 ON CONFLICT DO NOTHING""",
652 block
.get("country"),
653 block
.get("is-anonymous-proxy") == "yes",
654 block
.get("is-satellite-provider") == "yes",
655 block
.get("is-anycast") == "yes",
659 log
.warning("Unsupport type: %s" % type)
662 def split_line(line
):
663 key
, colon
, val
= line
.partition(":")
665 # Strip any excess space
672 # Run the command line interface