ipilot 0.0.0__py3-none-any.whl

ipilot/args.py

@@ -0,0 +1,40 @@
+#!/usr/local/env python3
+
+"""MODULE: Provides CLI arguments to the application."""
+
+import argparse
+
+from ipilot.query_normalisation import get_public_ip
+
+
+def parse_args() -> argparse.Namespace:  # pragma: no cover
+    """Get arguments from user via the command line.
+    
+    Args:
+        None
+    
+    Returns:
+        argparse.Namespace: parsed arguments
+    """
+    parser = argparse.ArgumentParser(
+        description="Query information about an IP address or domain name."
+    )
+    parser.add_argument(
+        "-q",
+        "--query",
+        help="IP/domain name to query (default: current public IP)",
+        default=get_public_ip(),
+    )
+    parser.add_argument(
+        "-p",
+        "--prefixes",
+        help="show advertised prefixes",
+        action="store_true",
+    )
+    parser.add_argument(
+        "-n",
+        "--noheader",
+        help="do not print header",
+        action="store_true",
+    )
+    return parser.parse_args()

ipilot/ip_info.py

@@ -0,0 +1,61 @@
+#!/usr/bin/env python3
+
+"""MODULE: Provides functions to call various APIs to retrieve IP/prefix information."""
+
+import ipaddress
+
+import requests
+
+from typing import Optional
+
+
+def get_ip_information(ipv4_address: ipaddress.IPv4Address) -> Optional[dict]:
+    """Retrieves information about a given IPv4 address from IP-API.com.
+    
+    Args:
+        ipv4_address (ipaddress.IPv4Address): IPv4 address to query
+    
+    Returns:
+        Optional[dict]: API response
+    """
+    api_endpoint: str = f"http://ip-api.com/json/{ipv4_address}"
+    try:
+        resp: requests.Response = requests.get(api_endpoint, timeout=10)
+        resp.raise_for_status()
+        ret: dict | None = resp.json() if resp.json().get("status") == "success" else None
+    except (requests.exceptions.JSONDecodeError, requests.exceptions.HTTPError):
+        ret = None
+    return ret
+
+
+def get_autonomous_system_number(as_info: str) -> str:
+    """Parses AS number from provided AS information.
+    
+    Args:
+        as_info (str): AS information
+    
+    Returns:
+        str: AS number
+    """
+    as_number: str = as_info.split(" ")[0]
+    return as_number
+
+
+def get_prefix_information(autonomous_system: str) -> Optional[list]:
+    """Retrieves prefix information about a given autonomous system.
+    
+    Args:
+        autonomous_system (str): autonomous system to query, e.g. AS123
+    
+    Returns:
+        Optional[list]: API response
+    """
+    api_endpoint: str = f"https://api.hackertarget.com/aslookup/?q={str(autonomous_system)}"
+    try:
+        resp: requests.Response = requests.get(api_endpoint, timeout=10)
+        resp.raise_for_status()
+    except requests.exceptions.HTTPError:
+        return None
+    prefixes: list[str] = resp.text.split("\n")
+    prefixes.pop(0)
+    return prefixes

ipilot/main.py

@@ -0,0 +1,76 @@
+#!/usr/local/bin/python3
+
+"""MODULE: Main application module."""
+
+import sys
+
+from ipilot.args import parse_args
+from ipilot.ip_info import (
+    get_autonomous_system_number,
+    get_ip_information,
+    get_prefix_information,
+)
+from ipilot.print_table import generate_prefix_string, print_table
+from ipilot.query_normalisation import is_ip_address, resolve_domain_name
+
+HEADER = """-----------------------------------------------
+| IP Address Information Lookup Tool (iPilot) |
+|       By Luke Tainton (@luketainton)        |
+-----------------------------------------------\n"""
+
+
+def main() -> None:
+    """Main function.
+    
+    Args:
+        None
+    
+    Returns:
+        None
+    """
+    args = parse_args()
+    if not args.noheader:
+        print(HEADER)
+
+    # Set IP to passed IP address, or resolve passed domain name to IPv4
+    ip_address = resolve_domain_name(args.query) if not is_ip_address(args.query) else args.query
+
+    # If not given an IPv4, and can't resolve to IPv4, then throw error and exit
+    if not ip_address:
+        print("ERROR: could not resolve query to IPv4 address.")
+        sys.exit(1)
+
+    # Get information from API
+    ip_info: dict | None = get_ip_information(ip_address)
+    if not ip_info:
+        print("ERROR: could not retrieve IP information from API.")
+        sys.exit(1)
+    as_number: str = get_autonomous_system_number(ip_info["as"])
+
+    # Assemble list for table generation
+    country: str = ip_info["country"]
+    region: str = ip_info["regionName"]
+    city: str = ip_info["city"]
+    table_data: list = [
+        ["IP Address", ip_info["query"]],
+        ["Organization", ip_info["org"]],
+        ["Location", f"{country}/{region}/{city}"],
+        ["Timezone", ip_info["timezone"]],
+        ["Internet Service Provider", ip_info["isp"]],
+        ["Autonomous System", as_number],
+    ]
+
+    # If wanted, get prefix information
+    if args.prefixes:
+        prefix_info = get_prefix_information(as_number)
+        if not prefix_info:
+            print("ERROR: could not retrieve prefix information from API.")
+            sys.exit(1)
+        else:
+            table_data.append(["Prefixes", generate_prefix_string(prefix_info)])
+
+    print_table(table_data)
+
+
+if __name__ == "__main__":
+    main()

ipilot/print_table.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python3
+
+"""MODULE: Provides functions for preparing, then printing, retrieved data."""
+
+from tabulate import tabulate
+
+
+def generate_prefix_string(prefixes: list) -> str | None:
+    """Generate a string that spilts prefixes into rows of 4."""
+    num_per_row = 4
+    try:
+        ret: str = ""
+        for i in range(0, len(prefixes), num_per_row):
+            ret += ", ".join(prefixes[i : i + num_per_row]) + "\n"
+        return ret
+    except AttributeError:
+        return None
+
+
+def print_table(table_data) -> None:  # pragma: no cover
+    """Print table generated by tabulate."""
+    print(tabulate(table_data))

ipilot/query_normalisation.py

@@ -0,0 +1,34 @@
+#!/usr/bin/env python3
+
+"""MODULE: Provides functions that ensure an IP address is
+available to query the APIs for."""
+
+import ipaddress
+import socket
+
+import requests
+
+
+def is_ip_address(query: str) -> bool:
+    """Verifies if a given query is a valid IPv4 address."""
+    try:
+        ipaddress.ip_address(query)
+        return True
+    except ValueError:
+        return False
+
+
+def resolve_domain_name(domain_name: str) -> ipaddress.IPv4Address | None:
+    """Resolve a domain name via DNS or return None."""
+    try:
+        result: str = socket.gethostbyname(domain_name)
+        ip_address: ipaddress.IPv4Address = ipaddress.IPv4Address(result)
+        return ip_address
+    except (socket.gaierror, ipaddress.AddressValueError):
+        return None
+
+
+def get_public_ip() -> ipaddress.IPv4Address:
+    """Get the user's current public IPv4 address."""
+    ip_address: str = requests.get("https://api.ipify.org", timeout=10).text
+    return ipaddress.IPv4Address(ip_address)

ipilot-0.0.0.dist-info/METADATA

@@ -0,0 +1,52 @@
+Metadata-Version: 2.1
+Name: ipilot
+Version: 0.0.0
+Summary: IP Information Lookup Tool
+Author: Luke Tainton
+Author-email: luke@tainton.uk
+Requires-Python: >=3.8,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: astroid (==3.2.4)
+Requires-Dist: attrs (==24.3.0)
+Requires-Dist: certifi (==2024.12.14)
+Requires-Dist: charset-normalizer (==3.4.1)
+Requires-Dist: click (==8.1.8)
+Requires-Dist: dill (==0.3.9)
+Requires-Dist: exceptiongroup (==1.2.2)
+Requires-Dist: idna (==3.10)
+Requires-Dist: iniconfig (==2.0.0)
+Requires-Dist: lazy-object-proxy (==1.10.0)
+Requires-Dist: mccabe (==0.7.0)
+Requires-Dist: mypy-extensions (==1.0.0)
+Requires-Dist: packaging (==24.2)
+Requires-Dist: pathspec (==0.12.1)
+Requires-Dist: platformdirs (==4.3.6)
+Requires-Dist: pluggy (==1.5.0)
+Requires-Dist: py (==1.11.0)
+Requires-Dist: pyparsing (==3.1.4)
+Requires-Dist: requests (==2.32.3)
+Requires-Dist: six (==1.17.0)
+Requires-Dist: tabulate (==0.9.0)
+Requires-Dist: tomli (==2.2.1)
+Requires-Dist: tomlkit (==0.13.2)
+Requires-Dist: urllib3 (==2.2.3)
+Requires-Dist: wrapt (==1.17.0)
+Description-Content-Type: text/markdown
+
+# iPilot [![CI](https://github.com/luketainton/pypilot/actions/workflows/ci.yml/badge.svg)](https://github.com/luketainton/pypilot/actions/workflows/ci.yml) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=luketainton_pypilot&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=luketainton_pypilot)
+
+## Description
+IP Information Lookup Tool
+
+## How to install
+`pip install ipilot`
+
+## How to use
+`ipilot --help`
+

ipilot-0.0.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+ipilot/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ipilot/args.py,sha256=xtjr6B1XH9wUswMDK5cpTDWRrNA7Ld3RWmvNrW0F104,954
+ipilot/ip_info.py,sha256=NAy3Wdo92YhlKP1PCjXOsO7a4IwAPKyQP-9KyVb4l2E,1787
+ipilot/main.py,sha256=tiY9ZGNyN9cFamREDZPgImCs3wi4G_j-Io1ZQ1XI4zQ,2259
+ipilot/print_table.py,sha256=3QP3mdN5_0n4JVZ_S3r1Rn4FgmoHkWcZhmaM3MCp-WU,634
+ipilot/query_normalisation.py,sha256=9nOYhVwvr8eOfWfmE8_CptHpRSwCKXH9YDyKzUqUWe8,980
+ipilot-0.0.0.dist-info/METADATA,sha256=NvYyjD7Stv4_sg3-754mno4BTHhbB-hxoyj38ykWvS4,1877
+ipilot-0.0.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+ipilot-0.0.0.dist-info/entry_points.txt,sha256=2Ve389A36UooJzr-7C1hdB99TlYR0aoBkrL4TDrgRqg,40
+ipilot-0.0.0.dist-info/RECORD,,

ipilot-0.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.1
+Root-Is-Purelib: true
+Tag: py3-none-any

ipilot-0.0.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+app=ipilot.main:main
+