ida-hcli 0.8.3.dev2__tar.gz → 0.8.3.dev4__tar.gz

{ida_hcli-0.8.3.dev2 → ida_hcli-0.8.3.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ida-hcli
-Version: 0.8.3.dev2
+Version: 0.8.3.dev4
 Summary: HCLI - Hex-Rays CLI Utility
 Author-email: Hex-Rays SA <support@hex-rays.com>
 License-Expression: MIT

{ida_hcli-0.8.3.dev2 → ida_hcli-0.8.3.dev4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ida-hcli"
-version = "0.8.3-dev.2"
+version = "0.8.3-dev.4"
 description = "HCLI - Hex-Rays CLI Utility"
 requires-python = ">=3.10"
 license = "MIT"

ida_hcli-0.8.3.dev4/src/hcli/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.8.3-dev.4"

{ida_hcli-0.8.3.dev2 → ida_hcli-0.8.3.dev4}/src/hcli/commands/__init__.py

@@ -10,14 +10,12 @@ def register_commands(cli: click.Group) -> None:
     from .login import login
     from .logout import logout
     from .open import open_url
-    from .setup import setup
     from .update import update
     from .whoami import whoami
     # placeholder for more commands
 
     cli.add_command(login)
     cli.add_command(logout)
-    cli.add_command(setup)
     cli.add_command(whoami)
     cli.add_command(update)
     cli.add_command(download)
@@ -28,6 +26,7 @@ def register_commands(cli: click.Group) -> None:
     from .auth import auth
     from .extension import extension
     from .ida import ida
+    from .ke import ke
     from .license import license
     from .share import share
 
@@ -36,3 +35,4 @@ def register_commands(cli: click.Group) -> None:
     cli.add_command(share)
     cli.add_command(license)
     cli.add_command(extension)
+    cli.add_command(ke)

ida_hcli-0.8.3.dev4/src/hcli/commands/ke/__init__.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+import rich_click as click
+
+
+@click.group()
+def ke() -> None:
+    """Knowledge Engine commands."""
+    pass
+
+
+from .setup import setup  # noqa: E402
+from .source import source  # noqa: E402
+
+ke.add_command(source)
+ke.add_command(setup)

ida_hcli-0.8.3.dev4/src/hcli/commands/ke/setup.py

@@ -0,0 +1,221 @@
+from __future__ import annotations
+
+import os
+import platform
+import shutil
+import subprocess
+import tempfile
+from pathlib import Path
+
+import rich_click as click
+
+from hcli.lib.commands import async_command
+from hcli.lib.console import console
+from hcli.lib.util.io import get_hcli_executable_path
+
+
+def setup_macos_protocol_handler() -> None:
+    """Set up protocol handler for macOS using AppleScript and plist modification."""
+    try:
+        hcli_path = get_hcli_executable_path()
+
+        print(hcli_path)
+
+        # Create AppleScript application
+        applescript_content = f'''
+on open location this_URL
+    do shell script "{hcli_path} open " & quoted form of this_URL
+end open location
+
+on run
+    -- This handler is called when the app is launched directly
+end run
+'''
+
+        # Create temporary directory for the AppleScript
+        with tempfile.TemporaryDirectory() as temp_dir:
+            script_path = Path(temp_dir) / "HCLIHandler.applescript"
+            app_path = Path.home() / "Applications" / "HCLIHandler.app"
+
+            # Write AppleScript
+            script_path.write_text(applescript_content)
+
+            # Compile AppleScript to application
+            subprocess.run(["osacompile", "-o", str(app_path), str(script_path)], check=True)
+
+            # Create Info.plist for the app to register URL scheme
+            info_plist_path = app_path / "Contents" / "Info.plist"
+
+            # Read existing plist
+            result = subprocess.run(
+                ["plutil", "-convert", "xml1", "-o", "-", str(info_plist_path)],
+                capture_output=True,
+                text=True,
+                check=True,
+            )
+
+            plist_content = result.stdout
+
+            # Add URL scheme handler to plist
+            url_scheme_xml = """
+        <key>CFBundleURLTypes</key>
+        <array>
+            <dict>
+                <key>CFBundleURLName</key>
+                <string>IDA URL Handler</string>
+                <key>CFBundleURLSchemes</key>
+                <array>
+                    <string>ida</string>
+                </array>
+            </dict>
+        </array>"""
+
+            # Insert before closing </dict></plist>
+            if "<key>CFBundleURLTypes</key>" not in plist_content:
+                plist_content = plist_content.replace("</dict>\n</plist>", f"{url_scheme_xml}\n</dict>\n</plist>")
+
+                # Write back the modified plist
+                with tempfile.NamedTemporaryFile(mode="w", suffix=".plist", delete=False) as temp_plist:
+                    temp_plist.write(plist_content)
+                    temp_plist_path = temp_plist.name
+
+                # Convert back to binary and replace original
+                subprocess.run(["plutil", "-convert", "binary1", temp_plist_path], check=True)
+
+                shutil.copy2(temp_plist_path, info_plist_path)
+                os.unlink(temp_plist_path)
+
+            # Register the app with Launch Services
+            subprocess.run(
+                [
+                    "/System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/LaunchServices.framework/Versions/A/Support/lsregister",
+                    "-f",
+                    str(app_path),
+                ],
+                check=True,
+            )
+
+            console.print(f"[green]✓[/green] macOS protocol handler installed at {app_path}")
+
+    except subprocess.CalledProcessError as e:
+        console.print(f"[red]Failed to set up macOS protocol handler: {e}[/red]")
+        raise
+    except Exception as e:
+        console.print(f"[red]Error setting up macOS protocol handler: {e}[/red]")
+        raise
+
+
+def setup_windows_protocol_handler() -> None:
+    """Set up protocol handler for Windows using registry entries."""
+    try:
+        import winreg  # type: ignore[import-untyped]
+        from winreg import HKEY_CURRENT_USER, REG_SZ  # type: ignore[import-untyped,attr-defined]
+
+        hcli_path = get_hcli_executable_path()
+        command = f'"{hcli_path}" open "%1"'
+
+        # Create registry entries for ida:// protocol
+        with winreg.CreateKey(HKEY_CURRENT_USER, r"SOFTWARE\Classes\ida") as key:  # type: ignore[attr-defined]
+            winreg.SetValueEx(key, "", 0, REG_SZ, "URL:IDA Protocol")  # type: ignore[attr-defined]
+            winreg.SetValueEx(key, "URL Protocol", 0, REG_SZ, "")  # type: ignore[attr-defined]
+
+        with winreg.CreateKey(HKEY_CURRENT_USER, r"SOFTWARE\Classes\ida\DefaultIcon") as key:  # type: ignore[attr-defined]
+            winreg.SetValueEx(key, "", 0, REG_SZ, f"{hcli_path},1")  # type: ignore[attr-defined]
+
+        with winreg.CreateKey(HKEY_CURRENT_USER, r"SOFTWARE\Classes\ida\shell") as key:  # type: ignore[attr-defined]
+            pass
+
+        with winreg.CreateKey(HKEY_CURRENT_USER, r"SOFTWARE\Classes\ida\shell\open") as key:  # type: ignore[attr-defined]
+            pass
+
+        with winreg.CreateKey(HKEY_CURRENT_USER, r"SOFTWARE\Classes\ida\shell\open\command") as key:  # type: ignore[attr-defined]
+            winreg.SetValueEx(key, "", 0, REG_SZ, command)  # type: ignore[attr-defined]
+
+        console.print("[green]✓[/green] Windows protocol handler registered in registry")
+
+    except ImportError:
+        console.print("[red]winreg module not available (not on Windows?)[/red]")
+        raise
+    except Exception as e:
+        console.print(f"[red]Error setting up Windows protocol handler: {e}[/red]")
+        raise
+
+
+def setup_linux_protocol_handler() -> None:
+    """Set up protocol handler for Linux using desktop entry and xdg-mime."""
+    try:
+        hcli_path = get_hcli_executable_path()
+
+        # Create desktop entry
+        desktop_entry_content = f"""[Desktop Entry]
+Name=HCLI URL Handler
+Exec={hcli_path} open %u
+Type=Application
+NoDisplay=true
+MimeType=x-scheme-handler/ida;
+"""
+
+        # Write to applications directory
+        applications_dir = Path.home() / ".local" / "share" / "applications"
+        applications_dir.mkdir(parents=True, exist_ok=True)
+
+        desktop_file_path = applications_dir / "hcli-url-handler.desktop"
+        desktop_file_path.write_text(desktop_entry_content)
+
+        # Make executable
+        desktop_file_path.chmod(0o755)
+
+        # Register with xdg-mime
+        subprocess.run(["xdg-mime", "default", "hcli-url-handler.desktop", "x-scheme-handler/ida"], check=True)
+
+        # Update desktop database
+        subprocess.run(
+            ["update-desktop-database", str(applications_dir)], check=False
+        )  # May fail on some systems but not critical
+
+        console.print(f"[green]✓[/green] Linux protocol handler installed at {desktop_file_path}")
+
+    except subprocess.CalledProcessError as e:
+        console.print(f"[red]Failed to set up Linux protocol handler: {e}[/red]")
+        raise
+    except Exception as e:
+        console.print(f"[red]Error setting up Linux protocol handler: {e}[/red]")
+        raise
+
+
+@click.command(name="setup")
+@click.option("--force", is_flag=True, help="Force reinstall even if already configured")
+@async_command
+async def setup(force: bool = False) -> None:
+    """Set up hcli protocol handlers for ida:// URLs.
+
+    This command registers hcli as the handler for ida:// URLs on your system,
+    allowing web browsers and other applications to automatically open IDA-related
+    URLs with hcli.
+
+    The setup process varies by platform:
+    - macOS: Creates an AppleScript application and registers it with Launch Services
+    - Windows: Adds registry entries for the ida:// protocol
+    - Linux: Creates a desktop entry and registers with xdg-mime
+    """
+    current_platform = platform.system().lower()
+
+    console.print(f"[blue]Setting up hcli protocol handlers for {current_platform}...[/blue]")
+
+    try:
+        if current_platform == "darwin":
+            setup_macos_protocol_handler()
+        elif current_platform == "windows":
+            setup_windows_protocol_handler()
+        elif current_platform == "linux":
+            setup_linux_protocol_handler()
+        else:
+            console.print(f"[red]Unsupported platform: {current_platform}[/red]")
+            raise RuntimeError(f"Platform {current_platform} is not supported")
+
+        console.print("[green]✓ Protocol handler setup complete![/green]")
+        console.print("[yellow]You can now click ida:// links and they will open with hcli.[/yellow]")
+
+    except Exception as e:
+        console.print(f"[red]Setup failed: {e}[/red]")
+        raise

ida_hcli-0.8.3.dev4/src/hcli/commands/ke/source/__init__.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+import rich_click as click
+
+
+@click.group()
+def source() -> None:
+    """Manage knowledge sources."""
+    pass
+
+
+from .add import add  # noqa: E402
+from .list import list_sources  # noqa: E402
+from .remove import remove  # noqa: E402
+
+source.add_command(add)
+source.add_command(remove)
+source.add_command(list_sources, name="list")

ida_hcli-0.8.3.dev4/src/hcli/commands/ke/source/add.py

@@ -0,0 +1,35 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+import rich_click as click
+from rich.console import Console
+
+from hcli.lib.config import config_store
+
+console = Console()
+
+
+@click.command()
+@click.argument("name", type=str)
+@click.argument("path", type=click.Path(exists=True, path_type=Path))
+def add(name: str, path: Path) -> None:
+    """Add a knowledge source.
+
+    NAME: Logical name for the source
+    PATH: Filesystem path to the source
+    """
+    # Get existing sources or initialize empty dict
+    sources: dict[str, str] = config_store.get_object("ke.sources", {}) or {}
+
+    if name in sources:
+        console.print(f"[yellow]Source '{name}' already exists. Use remove first to replace it.[/yellow]")
+        raise click.Abort()
+
+    # Store the absolute path as string
+    sources[name] = str(path.absolute())
+
+    # Save back to config
+    config_store.set_object("ke.sources", sources)
+
+    console.print(f"[green]Added source '{name}' pointing to '{path.absolute()}'[/green]")

ida_hcli-0.8.3.dev4/src/hcli/commands/ke/source/list.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+import rich_click as click
+from rich.console import Console
+from rich.table import Table
+
+from hcli.lib.config import config_store
+
+console = Console()
+
+
+@click.command()
+def list_sources() -> None:
+    """List all knowledge sources."""
+    # Get existing sources
+    sources: dict[str, str] = config_store.get_object("ke.sources", {}) or {}
+
+    if not sources:
+        console.print("[yellow]No knowledge sources configured.[/yellow]")
+        return
+
+    # Create table
+    table = Table(show_header=True, header_style="bold magenta")
+    table.add_column("Name", style="cyan", width=20)
+    table.add_column("Path", style="white")
+
+    # Add rows
+    for name, path in sources.items():
+        table.add_row(name, path)
+
+    console.print(table)

ida_hcli-0.8.3.dev4/src/hcli/commands/ke/source/remove.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+import rich_click as click
+from rich.console import Console
+
+from hcli.lib.config import config_store
+
+console = Console()
+
+
+@click.command()
+@click.argument("name", type=str)
+def remove(name: str) -> None:
+    """Remove a knowledge source.
+
+    NAME: Name of the source to remove
+    """
+    # Get existing sources
+    sources: dict[str, str] = config_store.get_object("ke.sources", {}) or {}
+
+    if name not in sources:
+        console.print(f"[red]Source '{name}' not found[/red]")
+        raise click.Abort()
+
+    # Remove the source
+    del sources[name]
+
+    # Save back to config
+    config_store.set_object("ke.sources", sources)
+
+    console.print(f"[green]Removed source '{name}'[/green]")

ida_hcli-0.8.3.dev4/src/hcli/commands/open.py

@@ -0,0 +1,86 @@
+from __future__ import annotations
+
+import subprocess
+from datetime import datetime
+from pathlib import Path
+from urllib.parse import urlparse
+
+import rich_click as click
+from rich.console import Console
+
+from hcli.lib.commands import async_command
+from hcli.lib.config import config_store
+from hcli.lib.ida import IdaVersion, get_default_ida_install_directory, get_ida_binary_path
+
+console = Console()
+
+
+@click.command(name="open", hidden=True)
+@click.argument("url", required=True)
+@async_command
+async def open_url(url: str | None) -> None:
+    """HCLI protocol handler for ida://"""
+
+    if not url:
+        console.print("[red]No URL provided[/red]")
+        raise click.Abort()
+
+    # Parse the URL
+    parsed_url = urlparse(url)
+
+    if parsed_url.scheme != "ida":
+        console.print(f"[red]Unsupported URL scheme: {parsed_url.scheme}[/red]")
+        raise click.Abort()
+
+    # Extract source name (hostname) and file path
+    source_name = parsed_url.netloc
+    file_path = parsed_url.path.lstrip("/")  # Remove leading slash
+
+    if not source_name:
+        console.print("[red]No source name provided in URL[/red]")
+        raise click.Abort()
+
+    if not file_path:
+        console.print("[red]No file path provided in URL[/red]")
+        raise click.Abort()
+
+    # Get ke sources from config
+    sources: dict[str, str] = config_store.get_object("ke.sources", {}) or {}
+
+    if source_name not in sources:
+        console.print(f"[red]Source '{source_name}' not found. Available sources:[/red]")
+        if sources:
+            for name in sources.keys():
+                console.print(f"  - {name}")
+        else:
+            console.print("  No sources configured. Use 'hcli ke source add' to add sources.")
+        raise click.Abort()
+
+    # Resolve full path
+    source_path = Path(sources[source_name])
+    full_path = source_path / file_path
+
+    if not full_path.exists():
+        console.print(f"[red]File not found: {full_path}[/red]")
+        raise click.Abort()
+
+    # Get IDA binary
+    try:
+        ida_dir = get_default_ida_install_directory(IdaVersion("IDA Professional", 9, 2))
+        ida_bin = get_ida_binary_path(ida_dir)
+    except Exception as e:
+        console.print(f"[red]IDA Pro not found: {e}[/red]")
+        console.print(f"[yellow]URL resolution successful: {url} -> {full_path}[/yellow]")
+        raise click.Abort()
+
+    # Log the URL to a temp file
+    log_file = "/tmp/hcli_urls.log"
+    timestamp = datetime.now().isoformat()
+
+    with open(str(log_file), "a", encoding="utf-8") as f:
+        f.write(f"{timestamp}: {url} -> {full_path} : {ida_bin}\n")
+
+    console.print(f"[green]Opening {full_path} with IDA Pro[/green]")
+
+    # Launch IDA with the resolved file path
+    subprocess.Popen([ida_bin, str(full_path)])

{ida_hcli-0.8.3.dev2 → ida_hcli-0.8.3.dev4}/src/ida_hcli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ida-hcli
-Version: 0.8.3.dev2
+Version: 0.8.3.dev4
 Summary: HCLI - Hex-Rays CLI Utility
 Author-email: Hex-Rays SA <support@hex-rays.com>
 License-Expression: MIT

{ida_hcli-0.8.3.dev2 → ida_hcli-0.8.3.dev4}/src/ida_hcli.egg-info/SOURCES.txt

@@ -27,6 +27,12 @@ src/hcli/commands/extension/create.py
 src/hcli/commands/extension/list.py
 src/hcli/commands/ida/__init__.py
 src/hcli/commands/ida/install.py
+src/hcli/commands/ke/__init__.py
+src/hcli/commands/ke/setup.py
+src/hcli/commands/ke/source/__init__.py
+src/hcli/commands/ke/source/add.py
+src/hcli/commands/ke/source/list.py
+src/hcli/commands/ke/source/remove.py
 src/hcli/commands/license/__init__.py
 src/hcli/commands/license/common.py
 src/hcli/commands/license/get.py

ida_hcli-0.8.3.dev2/src/hcli/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.8.3-dev.2"

ida_hcli-0.8.3.dev2/src/hcli/commands/open.py

@@ -1,28 +0,0 @@
-from __future__ import annotations
-
-import subprocess
-from datetime import datetime
-
-import rich_click as click
-
-from hcli.lib.commands import async_command
-from hcli.lib.ida import IdaVersion, get_default_ida_install_directory, get_ida_binary_path
-
-
-@click.command(name="open", hidden=True)
-@click.argument("url", required=True)
-@async_command
-async def open_url(url: str | None) -> None:
-    """HCLI protocol handler for ida://"""
-
-    ida_dir = get_default_ida_install_directory(IdaVersion("IDA Professional", 9, 2))
-    ida_bin = get_ida_binary_path(ida_dir)
-
-    # Log the URL to a temp file
-    log_file = "/tmp/hcli_urls.log"
-    timestamp = datetime.now().isoformat()
-
-    with open(str(log_file), "a", encoding="utf-8") as f:
-        f.write(f"{timestamp}: {url} : {ida_bin}\n")
-
-    subprocess.Popen(["open", "-a", ida_bin])