osintcase 0.2.0__py3-none-any.whl

osintcase/__init__.py

@@ -0,0 +1,3 @@
+"""OSINT Case — investigation case workspace (profiling, notes, link analysis, reports)."""
+
+__version__ = "0.2.0"

osintcase/__main__.py

@@ -0,0 +1,3 @@
+from .cli import main
+
+raise SystemExit(main())

osintcase/_window.py

@@ -0,0 +1,22 @@
+"""Runs the native window. Started as a child process by cli.py so a missing system
+library (for example libxcb-cursor0 for Qt) cannot take the whole program down."""
+
+from __future__ import annotations
+
+import sys
+
+
+def run(url: str, storage: str, icon: str) -> int:
+    import webview  # pywebview
+
+    try:
+        webview.settings["ALLOW_DOWNLOADS"] = True
+    except Exception:
+        pass
+    webview.create_window("OSINT Case", url, width=1440, height=900, min_size=(1000, 640))
+    webview.start(private_mode=False, storage_path=storage, icon=icon)
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(run(sys.argv[1], sys.argv[2], sys.argv[3]))

osintcase/cli.py

@@ -0,0 +1,93 @@
+from __future__ import annotations
+
+import argparse
+import subprocess
+import sys
+import time
+import webbrowser
+from pathlib import Path
+
+from . import __version__, server, shortcut
+
+ICON = Path(__file__).resolve().parent / "assets" / "icon.png"
+
+
+def _parser() -> argparse.ArgumentParser:
+    p = argparse.ArgumentParser(
+        prog="osintcase",
+        description="OSINT Case — investigation case workspace. Opens in its own window by default.",
+    )
+    p.add_argument("--web", action="store_true", help="open in your web browser instead of a window")
+    p.add_argument("--port", type=int, default=None, help=f"local port (default {server.DEFAULT_PORT})")
+    p.add_argument("--no-open", action="store_true", help="with --web: start the server but do not open a browser")
+    p.add_argument("--install-shortcut", action="store_true", help="add OSINT Case (with logo) to the application menu")
+    p.add_argument("--uninstall-shortcut", action="store_true", help="remove the application menu entry")
+    p.add_argument("--version", action="version", version=f"osintcase {__version__}")
+    return p
+
+
+def _serve_forever(url: str, open_browser: bool) -> int:
+    print(f"OSINT Case {__version__} running at {url}  (Ctrl+C to stop)")
+    if open_browser:
+        webbrowser.open(url)
+    try:
+        while True:
+            time.sleep(3600)
+    except KeyboardInterrupt:
+        print()
+    return 0
+
+
+def _gui(url: str) -> bool:
+    """Open the native window in a child process. False means no window could be shown."""
+    storage = shortcut.DATA_DIR / "webview"
+    storage.mkdir(parents=True, exist_ok=True)
+    started = time.monotonic()
+    try:
+        rc = subprocess.run(
+            [sys.executable, "-m", "osintcase._window", url, str(storage), str(ICON)]
+        ).returncode
+    except OSError as exc:
+        print(f"Could not start the window ({exc}).", file=sys.stderr)
+        return False
+    if rc == 0:
+        return True
+    if time.monotonic() - started > 20:  # it ran for a while and then died: do not reopen in a browser
+        return True
+    if sys.platform.startswith("linux"):
+        print(
+            "The window could not start. On Debian/Ubuntu this is usually fixed with:\n"
+            "  sudo apt install libxcb-cursor0 libxkbcommon-x11-0 libxcb-icccm4 libxcb-keysyms1 libxcb-shape0",
+            file=sys.stderr,
+        )
+    return False
+
+
+def main(argv: list[str] | None = None) -> int:
+    args = _parser().parse_args(argv)
+
+    if args.install_shortcut:
+        for item in shortcut.install():
+            print("created:", item)
+        return 0
+    if args.uninstall_shortcut:
+        for item in shortcut.remove():
+            print("removed:", item)
+        return 0
+
+    try:
+        _httpd, url, changed = server.start(args.port)
+    except RuntimeError as exc:
+        print(exc, file=sys.stderr)
+        return 1
+    if changed:
+        print("Note: default port is busy; using a different one. Saved browser data is per port.", file=sys.stderr)
+
+    if args.web:
+        return _serve_forever(url, not args.no_open)
+
+    shortcut.ensure_once()
+    if _gui(url):
+        return 0
+    print("Falling back to the browser (install a GUI toolkit or use --web explicitly).", file=sys.stderr)
+    return _serve_forever(url, True)

osintcase/server.py

@@ -0,0 +1,91 @@
+"""Tiny local static server for the bundled OSINT Case web app (127.0.0.1 only)."""
+
+from __future__ import annotations
+
+import mimetypes
+import posixpath
+import socket
+import threading
+from http.server import SimpleHTTPRequestHandler, ThreadingHTTPServer
+from pathlib import Path
+from urllib.parse import unquote, urlsplit
+
+STATIC_DIR = Path(__file__).resolve().parent / "static"
+DEFAULT_PORT = 47321  # fixed so the browser keeps the same origin (and saved data) between runs
+
+mimetypes.add_type("application/javascript", ".js")
+mimetypes.add_type("application/javascript", ".mjs")
+mimetypes.add_type("image/webp", ".webp")
+mimetypes.add_type("font/woff2", ".woff2")
+
+
+class _Handler(SimpleHTTPRequestHandler):
+    server_version = "OsintCase"
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, directory=str(STATIC_DIR), **kwargs)
+
+    # Block DNS-rebinding style requests: only accept local Host headers.
+    def _host_ok(self) -> bool:
+        host = (self.headers.get("Host") or "").rsplit(":", 1)[0].strip("[]").lower()
+        return host in {"127.0.0.1", "localhost", "::1"}
+
+    def do_GET(self):  # noqa: N802
+        if not self._host_ok():
+            self.send_error(403, "Forbidden")
+            return
+        super().do_GET()
+
+    def do_HEAD(self):  # noqa: N802
+        if not self._host_ok():
+            self.send_error(403, "Forbidden")
+            return
+        super().do_HEAD()
+
+    def translate_path(self, path: str) -> str:
+        path = posixpath.normpath(unquote(urlsplit(path).path))
+        if path in ("", ".", "/"):
+            path = "/index.html"
+        target = (STATIC_DIR / path.lstrip("/")).resolve()
+        if STATIC_DIR not in target.parents and target != STATIC_DIR:
+            return str(STATIC_DIR / "index.html")
+        return str(target)
+
+    def end_headers(self):
+        self.send_header("Cache-Control", "no-cache")
+        self.send_header("X-Content-Type-Options", "nosniff")
+        self.send_header("Referrer-Policy", "no-referrer")
+        super().end_headers()
+
+    def log_message(self, fmt, *args):  # quiet by default
+        pass
+
+
+def _port_free(host: str, port: int) -> bool:
+    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
+        s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+        try:
+            s.bind((host, port))
+        except OSError:
+            return False
+    return True
+
+
+def start(port: int | None = None, host: str = "127.0.0.1") -> tuple[ThreadingHTTPServer, str, bool]:
+    """Start the server in a daemon thread.
+
+    Returns (server, url, port_changed). If the preferred port is busy a random free
+    port is used (saved browser data is per-origin, so the caller may want to warn).
+    """
+    if not (STATIC_DIR / "index.html").is_file():
+        raise RuntimeError(
+            "Bundled web app not found. Reinstall the package, or run tools/build_pypi.sh in the source tree."
+        )
+    wanted = port if port else DEFAULT_PORT
+    changed = False
+    if not _port_free(host, wanted):
+        wanted, changed = 0, True
+    httpd = ThreadingHTTPServer((host, wanted), _Handler)
+    httpd.daemon_threads = True
+    threading.Thread(target=httpd.serve_forever, name="osintcase-http", daemon=True).start()
+    return httpd, f"http://{host}:{httpd.server_address[1]}/", changed

osintcase/shortcut.py

@@ -0,0 +1,192 @@
+"""Create / remove the application-menu entry (with the logo icon).
+
+Linux:   ~/.local/share/applications/osintcase.desktop + hicolor icons
+Windows: Start Menu shortcut (OSINT Case.lnk) using icon.ico
+macOS:   ~/Applications/OSINT Case.app (small launcher bundle)
+"""
+
+from __future__ import annotations
+
+import os
+import shutil
+import subprocess
+import sys
+from pathlib import Path
+
+ASSETS = Path(__file__).resolve().parent / "assets"
+NAME = "OSINT Case"
+DATA_DIR = Path(os.environ.get("OSINTCASE_HOME", Path.home() / ".osintcase"))
+MARKER = DATA_DIR / ".shortcut-v1"
+
+
+def _command() -> list[str]:
+    """Absolute command that launches the GUI (works for pip, pipx and venvs)."""
+    exe = shutil.which("osintcase")
+    if exe and Path(exe).resolve().parent in {Path(sys.executable).resolve().parent, Path(sys.prefix).resolve() / "bin"}:
+        return [exe]
+    return [sys.executable, "-m", "osintcase"]
+
+
+def _quote(parts: list[str]) -> str:
+    return " ".join('"%s"' % p if (" " in p or "\\" in p) else p for p in parts)
+
+
+# ---------------------------------------------------------------- Linux
+def _linux_install() -> list[str]:
+    base = Path(os.environ.get("XDG_DATA_HOME", Path.home() / ".local" / "share"))
+    made = []
+    for size, src in ((256, "icon-256.png"), (512, "icon.png")):
+        dst = base / "icons" / "hicolor" / f"{size}x{size}" / "apps" / "osintcase.png"
+        dst.parent.mkdir(parents=True, exist_ok=True)
+        shutil.copyfile(ASSETS / src, dst)
+        made.append(str(dst))
+    desktop = base / "applications" / "osintcase.desktop"
+    desktop.parent.mkdir(parents=True, exist_ok=True)
+    desktop.write_text(
+        "[Desktop Entry]\n"
+        "Type=Application\n"
+        f"Name={NAME}\n"
+        "GenericName=Investigation case workspace\n"
+        "Comment=Profiling, notes, link analysis and reports for OSINT investigations\n"
+        f"Exec={_quote(_command())}\n"
+        "Icon=osintcase\n"
+        "Terminal=false\n"
+        "Categories=Utility;Security;Network;\n"
+        "StartupWMClass=osintcase\n"
+        "Keywords=OSINT;investigation;case;intelligence;\n",
+        encoding="utf-8",
+    )
+    desktop.chmod(0o755)
+    made.append(str(desktop))
+    for tool, args in (
+        ("update-desktop-database", [str(desktop.parent)]),
+        ("gtk-update-icon-cache", ["-f", "-t", str(base / "icons" / "hicolor")]),
+    ):
+        if shutil.which(tool):
+            subprocess.run([tool, *args], check=False, capture_output=True)
+    return made
+
+
+def _linux_remove() -> list[str]:
+    base = Path(os.environ.get("XDG_DATA_HOME", Path.home() / ".local" / "share"))
+    gone = []
+    for p in (
+        base / "applications" / "osintcase.desktop",
+        base / "icons" / "hicolor" / "256x256" / "apps" / "osintcase.png",
+        base / "icons" / "hicolor" / "512x512" / "apps" / "osintcase.png",
+    ):
+        if p.exists():
+            p.unlink()
+            gone.append(str(p))
+    return gone
+
+
+# -------------------------------------------------------------- Windows
+def _win_lnk() -> Path:
+    appdata = Path(os.environ.get("APPDATA", Path.home() / "AppData" / "Roaming"))
+    return appdata / "Microsoft" / "Windows" / "Start Menu" / "Programs" / f"{NAME}.lnk"
+
+
+def _win_install() -> list[str]:
+    ico = DATA_DIR / "osintcase.ico"
+    DATA_DIR.mkdir(parents=True, exist_ok=True)
+    shutil.copyfile(ASSETS / "icon.ico", ico)
+    py = Path(sys.executable)
+    pyw = py.with_name("pythonw.exe")
+    target = str(pyw if pyw.exists() else py)
+    lnk = _win_lnk()
+    lnk.parent.mkdir(parents=True, exist_ok=True)
+    ps = (
+        "$s=(New-Object -ComObject WScript.Shell).CreateShortcut('%s');"
+        "$s.TargetPath='%s';$s.Arguments='-m osintcase';$s.IconLocation='%s';"
+        "$s.Description='%s';$s.WorkingDirectory='%s';$s.Save()"
+    ) % (lnk, target, ico, NAME, Path.home())
+    subprocess.run(["powershell", "-NoProfile", "-Command", ps], check=True, capture_output=True)
+    return [str(lnk)]
+
+
+def _win_remove() -> list[str]:
+    lnk = _win_lnk()
+    if lnk.exists():
+        lnk.unlink()
+        return [str(lnk)]
+    return []
+
+
+# ---------------------------------------------------------------- macOS
+def _mac_app() -> Path:
+    return Path.home() / "Applications" / f"{NAME}.app"
+
+
+def _mac_install() -> list[str]:
+    app = _mac_app()
+    (app / "Contents" / "MacOS").mkdir(parents=True, exist_ok=True)
+    (app / "Contents" / "Resources").mkdir(parents=True, exist_ok=True)
+    shutil.copyfile(ASSETS / "icon.icns", app / "Contents" / "Resources" / "icon.icns")
+    (app / "Contents" / "Info.plist").write_text(
+        '<?xml version="1.0" encoding="UTF-8"?>\n'
+        '<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">\n'
+        '<plist version="1.0"><dict>'
+        f"<key>CFBundleName</key><string>{NAME}</string>"
+        f"<key>CFBundleDisplayName</key><string>{NAME}</string>"
+        "<key>CFBundleIdentifier</key><string>com.osintcase.app</string>"
+        "<key>CFBundleExecutable</key><string>osintcase</string>"
+        "<key>CFBundleIconFile</key><string>icon</string>"
+        "<key>CFBundlePackageType</key><string>APPL</string>"
+        "<key>LSMinimumSystemVersion</key><string>10.13</string>"
+        "</dict></plist>\n",
+        encoding="utf-8",
+    )
+    launcher = app / "Contents" / "MacOS" / "osintcase"
+    launcher.write_text("#!/bin/sh\nexec %s\n" % _quote(_command()), encoding="utf-8")
+    launcher.chmod(0o755)
+    return [str(app)]
+
+
+def _mac_remove() -> list[str]:
+    app = _mac_app()
+    if app.exists():
+        shutil.rmtree(app)
+        return [str(app)]
+    return []
+
+
+# --------------------------------------------------------------- public
+def install() -> list[str]:
+    if sys.platform.startswith("linux"):
+        made = _linux_install()
+    elif sys.platform == "win32":
+        made = _win_install()
+    elif sys.platform == "darwin":
+        made = _mac_install()
+    else:
+        raise RuntimeError(f"Shortcuts are not supported on {sys.platform}")
+    DATA_DIR.mkdir(parents=True, exist_ok=True)
+    MARKER.write_text("1", encoding="utf-8")
+    return made
+
+
+def remove() -> list[str]:
+    if sys.platform.startswith("linux"):
+        gone = _linux_remove()
+    elif sys.platform == "win32":
+        gone = _win_remove()
+    elif sys.platform == "darwin":
+        gone = _mac_remove()
+    else:
+        gone = []
+    MARKER.unlink(missing_ok=True)
+    # remember that the user removed it: do not recreate automatically
+    DATA_DIR.mkdir(parents=True, exist_ok=True)
+    (DATA_DIR / ".shortcut-declined").write_text("1", encoding="utf-8")
+    return gone
+
+
+def ensure_once() -> None:
+    """First GUI start: create the menu entry silently (never raises)."""
+    if os.environ.get("OSINTCASE_NO_SHORTCUT") or MARKER.exists() or (DATA_DIR / ".shortcut-declined").exists():
+        return
+    try:
+        install()
+    except Exception:
+        pass

osintcase/static/app.config.example.json

@@ -0,0 +1,8 @@
+{
+  "_comment": "Copy this file to app.config.json (without the .example) and fill in your keys. app.config.json is gitignored so your keys never get committed.",
+  "googleMaps": {
+    "apiKey": "",
+    "_mapIdHint": "Optional: paste a Map ID from Google Cloud Console → Map Management → Map Styles. If left blank, the app uses a default that works but logs an InvalidKeyMapError in the console.",
+    "mapId": ""
+  }
+}