idapro 0.0.0__tar.gz → 0.0.3.dev1__tar.gz

idapro-0.0.3.dev1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Hex-Rays SA
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

idapro-0.0.3.dev1/PKG-INFO

@@ -0,0 +1,213 @@
+Metadata-Version: 2.4
+Name: idapro
+Version: 0.0.3.dev1
+Summary: IDA Library Python module
+Author: Hex-Rays SA
+Author-email: support@hex-rays.com
+License: MIT
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Disassemblers
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-python
+Dynamic: summary
+
+
+# IDA Library Python Module
+
+**⚠️ This is a dev pre-release version. APIs may change without notice and pre-release versions may be deleted at any time.**
+
+
+The IDA Library Python module enables running IDA Pro as an independent Python package outside the IDA UI environment, allowing for programmatic binary analysis and reverse engineering tasks.
+
+
+## Prerequisites
+
+### Environment Setup
+
+Set the `IDADIR` environment variable to point to your IDA installation directory:
+
+**Linux/macOS:**
+```bash
+export IDADIR="/path/to/your/ida/installation"
+```
+
+**Windows:**
+```cmd
+set IDADIR="C:\Program Files\IDA Pro 9.1"
+```
+
+**Example paths:**
+- **macOS:** `/Applications/IDA Professional 9.1.app/Contents/MacOS/`
+- **Windows:** `C:\Program Files\IDA Pro 9.1\`
+- **Linux:** `/opt/ida-9.1/`
+
+> **Note:** If you have already installed and configured the `idapro` Python package in the past using script provided with IDA installation package, setting `IDADIR` is not required.
+
+## Usage example:
+
+```python
+#!/usr/bin/env python3
+"""
+IDA Pro Python Library Usage Example
+This example demonstrates how to analyze a binary file using IDA Pro Python library.
+"""
+
+import argparse
+import importlib.metadata
+
+# You need to import first idapro module
+import idapro
+
+# After idapro module was loaded, you can simply import IDA Python modules
+import ida_entry
+import ida_nalt
+import idaapi
+import idc
+import idautils
+import ida_ida
+import ida_funcs
+import ida_name
+import ida_bytes
+import ida_typeinf
+
+# Read versions, configured IDA pro kernel and python package
+kern_major, kern_minor, kern_build = idapro.get_library_version()
+idapro_version = importlib.metadata.version('idapro')
+kernel_path = idapro.get_ida_install_dir()
+
+# Parse input arguments
+parser = argparse.ArgumentParser(description=f"IDA Library usage example, idapro version: {idapro_version}, "
+    f"kernel version: {kern_major}.{kern_minor}.{kern_build}, kernel libraries path: {kernel_path}")
+parser.add_argument(
+    "-f",
+    "--input-file",
+    help="Binary input file to be loaded",
+    type=str,
+    required=True,
+    default=None
+)
+args = parser.parse_args()
+
+# Print banner with components versions
+print(f"{parser.description}\n")
+
+# Open database
+if idapro.open_database(args.input_file, True) == 0:
+    # Extract minimum/maxim addresses
+    min_ea = ida_ida.inf_get_min_ea()
+    max_ea = ida_ida.inf_get_max_ea()
+    print(f"Addresses range: {hex(min_ea)} - {hex(max_ea)}")
+
+    # Print entry point
+    entry_point = ida_entry.get_entry_ordinal(0)
+    if entry_point != idaapi.BADADDR:
+        entry_addr = ida_entry.get_entry(entry_point)
+        print(f"Entry point: {hex(entry_addr)}")
+
+    # Print some metadata
+    print(f"Metadata:")
+    print(f" path: {idaapi.get_input_file_path()}")
+    print(f" module: {idaapi.get_root_filename()}")
+    print(f" base: {hex(idaapi.get_imagebase())}")
+    print(f" filesize: {hex(ida_nalt.retrieve_input_file_size())}")
+    print(f" md5: {ida_nalt.retrieve_input_file_md5()}")
+    print(f" sha256: {ida_nalt.retrieve_input_file_sha256()}")
+    print(f" crc32: {hex(ida_nalt.retrieve_input_file_crc32())}")
+
+    # Iterate functions
+    for func_ea in idautils.Functions():
+        f = ida_funcs.get_func(func_ea)
+        print(f"Function - name {f.name}, start ea {hex(f.start_ea)}, end ea {hex(f.end_ea)}")
+
+    for seg_ea in idautils.Segments():
+        name = idc.get_segm_name(seg_ea)
+        print(f"Segment - name {name}")
+
+    # Iterate types
+    til = ida_typeinf.get_idati()
+    if til:
+      max_ord = ida_typeinf.get_ordinal_limit(til)
+      current_index = -1
+      current_named_type = None
+
+      while current_index < max_ord - 1:
+          current_index += 1
+          tinfo = ida_typeinf.tinfo_t()
+          if tinfo.get_numbered_type(til, current_index):
+              print(f"Type - id {tinfo.get_tid()}")
+
+      while True:
+          if current_named_type is None:
+              current_named_type = ida_typeinf.first_named_type(til, ida_typeinf.NTF_TYPE)
+          else:
+              current_named_type = ida_typeinf.next_named_type(til, current_named_type, ida_typeinf.NTF_TYPE)
+
+          if not current_named_type:
+              break
+
+          tinfo = ida_typeinf.tinfo_t()
+          if tinfo.get_named_type(til, current_named_type):
+              print(f"Type - name {tinfo.get_type_name()}, id {tinfo.get_tid()}")
+
+    # Iterate comments
+    for ea in idautils.Heads(min_ea, max_ea):
+        cmt = idc.get_cmt(ea, 0)
+        if cmt:
+            print(f"Comment - value {cmt}")
+
+    # Iterate strings
+    for s in idautils.Strings():
+        print(f"String - value {s}")
+
+    for ea, name in idautils.Names():
+        print(f"Name - value {name}")
+
+    # Iterate basic blocks
+    for func_ea in idautils.Functions():
+        func = ida_funcs.get_func(func_ea)
+        if func:
+            fc = idaapi.FlowChart(func)
+            for b in fc:
+                print(f"Basic block - start ea {hex(b.start_ea)}, end ea {hex(b.end_ea)}")
+
+    # Iterate binary instructions
+    for ea in idautils.Heads(min_ea, max_ea):
+        if ida_bytes.is_code(ida_bytes.get_flags(ea)):
+            disasm = idc.generate_disasm_line(ea, 0)
+            print(f"Instruction - ea {hex(ea)}, asm {disasm}")
+
+    # Close database discarding the changes
+    idapro.close_database(False)
+```
+
+## Troubleshooting
+
+### Common Issues
+
+**ModuleNotFoundError: No module named 'idapro'**
+- Ensure `IDADIR` is set correctly
+- Verify IDA Pro is properly installed
+
+**License Issues**
+- Ensure you have a valid IDA Pro license
+- Check that IDA can run normally in GUI mode first
+
+## API Reference
+
+For detailed API documentation, refer to:
+- IDA Python documentation at https://python.docs.hex-rays.com/
+- Built-in help: `help(idapro)` after importing
+- IDA Pro SDK documentation https://docs.hex-rays.com/developer-guide/c++-sdk
+

idapro-0.0.3.dev1/README.md

@@ -0,0 +1,69 @@
+# IDA Library Python Module
+
+The IDA Library Python module enables running IDA Pro as an independent Python package outside the IDA UI environment, allowing for programmatic binary analysis and reverse engineering tasks.
+
+## Prerequisites
+
+### Environment Setup
+
+Set the `IDADIR` environment variable to point to your IDA installation directory:
+
+**Linux/macOS:**
+```bash
+export IDADIR="/path/to/your/ida/installation"
+```
+
+**Windows:**
+```cmd
+set IDADIR="C:\Program Files\IDA Pro 9.1"
+```
+
+**Example paths:**
+- **macOS:** `/Applications/IDA Professional 9.1.app/Contents/MacOS/`
+- **Windows:** `C:\Program Files\IDA Pro 9.1\`
+- **Linux:** `/opt/ida-9.1/`
+
+> **Note:** If you have already installed and configured the `idapro` Python package in the past using script provided with IDA installation package, setting `IDADIR` is not required.
+
+## Usage Example
+
+```python
+# You need to import first idapro module
+import idapro
+# After idapro module is loaded, you can import IDA Python modules
+import idautils
+import ida_funcs
+import ida_name
+
+# Open the database using idapro module
+if idapro.open_database("program.exe", True) == 0:
+    # Iterate functions and print basic information for each of them
+    for func_ea in idautils.Functions():
+        f = ida_funcs.get_func(func_ea)
+        func_name = ida_name.get_name(func_ea)
+        print(f"Function - name {func_name}, start ea {hex(f.start_ea)}, end ea {hex(f.end_ea)}")
+
+    # Close database discarding the changes
+    idapro.close_database(False)
+```
+
+**For a complete traversing database example, see:** [traverse.py](./examples/traverse.py)
+
+## Troubleshooting
+
+### Common Issues
+
+**ModuleNotFoundError: No module named 'idapro'**
+- Ensure `IDADIR` is set correctly
+- Verify IDA Pro is properly installed
+
+**License Issues**
+- Ensure you have a valid IDA Pro license
+- Check that IDA can run normally in GUI mode first
+
+## API Reference
+
+For detailed API documentation, refer to:
+- IDA Python documentation at [https://python.docs.hex-rays.com/](https://python.docs.hex-rays.com/)
+- Built-in help: `help(idapro)` after importing
+- IDA Pro SDK documentation at [https://docs.hex-rays.com/developer-guide/c++-sdk](https://docs.hex-rays.com/developer-guide/c++-sdk)

idapro-0.0.3.dev1/idapro/__init__.py

@@ -0,0 +1,118 @@
+from __future__ import annotations
+import sys
+import platform
+from pathlib import Path
+import ctypes
+import os
+from .config import get_ida_install_dir
+
+def find_file(name, path):
+    """Internal method used for recursively find a file in a folder"""
+    for root, dirs, files in os.walk(path):
+        if name in files:
+            return os.path.join(root, name)
+    return None
+
+# get the right filename based on platform
+platform_str = platform.system()
+
+if platform_str == "Windows":
+    name = "idalib.dll"
+elif platform_str == "Linux":
+    name = "libidalib.so"
+elif platform_str == "Darwin":
+    name = "libidalib.dylib"
+else:
+    raise ImportError(f"Unknown platform {platform_str}")
+
+# Get the ida-install-dir setting
+root_dir = get_ida_install_dir()
+
+if platform_str == "Windows":
+    # IDA kernel and modules may need dependencies in its root dir (e.g. clp64.dll)
+    # tell Windows loader where they can be found
+    # NB: for AddDllDirectory() be effective for indirectly loaded DLLs,
+    # SetDefaultDllDirectories(LOAD_LIBRARY_SEARCH_USER_DIRS) has to be called first
+    kernel32 = ctypes.WinDLL('kernel32', use_last_error=True)
+    SetDefaultDllDirectories = getattr(kernel32, "SetDefaultDllDirectories")
+    if SetDefaultDllDirectories:
+        from  ctypes.wintypes import DWORD, BOOL
+        SetDefaultDllDirectories.argtypes = [DWORD]
+        SetDefaultDllDirectories.restype = BOOL
+        LOAD_LIBRARY_SEARCH_DEFAULT_DIRS = 0x00001000
+        LOAD_LIBRARY_SEARCH_USER_DIRS = 0x00000400
+        flags = LOAD_LIBRARY_SEARCH_DEFAULT_DIRS | LOAD_LIBRARY_SEARCH_USER_DIRS
+        if SetDefaultDllDirectories(flags):
+            # finally, add IDA's directory for dependencies
+            os.add_dll_directory(root_dir)
+    else:
+        os.environ['PATH'] = root_dir + os.pathsep + os.environ.get('PATH', '')
+
+idalib_path = find_file(name=name, path=root_dir)
+if idalib_path is None:
+    raise ImportError(f"Could not find {name} in {root_dir}. Please make sure you have an IDA version 9.0 or newer and run py-activate-idalib.py utility shipped with it in order to activate this module.")
+
+if "IDA_IS_INTERACTIVE" in os.environ:
+    if os.environ["IDA_IS_INTERACTIVE"] == "1":
+        raise ImportError("The IDA library can only be run in a separate process and cannot be loaded within IDA itself.")
+
+# load the library and initialize the kernel
+try:
+    libida = ctypes.cdll.LoadLibrary(idalib_path)
+except Exception as e:
+    raise ImportError(f"Failed loading IDA library file {idalib_path}, exception {e}\n")
+
+try:
+    error_description = None
+    init_code = libida.init_library(0, None)
+    if init_code != 0:
+        error_description = f"init_library error code {init_code}"
+except Exception as e:
+    error_description = f"exception {e}"
+
+if error_description != None:
+    raise ImportError(f"Failed to initialize IDA library, {error_description}, check logging for additional information\n")
+
+sys.path.append(str(Path(idalib_path).parent / "python/lib-dynload"))
+sys.path.append(str(Path(idalib_path).parent / "python"))
+
+def open_database(file_name:str, run_auto_analysis: bool, args: str = None)->int:
+    """Opens the database specified by the file_name argument.
+    If run_auto_analysis is set to True, the auto-analysis will start and wait for its completion.
+    Optionally, additional arguments can be provided via args parameter, which follow the same format as IDA's command-line arguments.
+    NOTE: All library functions must be called from the same thread that initialized the library.
+    The library is single-threaded, and performing database operations from a different thread may result in undefined behavior."""
+    return libida.open_database(file_name.encode(), run_auto_analysis, args.encode() if args is not None else None)
+
+def close_database(save = True)->None:
+    """Close the current database"""
+    libida.close_database(save)
+
+def make_signatures(only_pat = False)->bool:
+    """Generate .sig and .pat files for the current database"""
+    return libida.make_signatures(only_pat)
+
+def enable_console_messages(enable:bool)->None:
+    """Enable console messages, they are disabled by default"""
+    libida.enable_console_messages(enable)
+
+def set_screen_ea(screen_ea: "ea_t")->None:
+    """Set screen ea, let the user specify the current screen ea
+    subsequent calls to get_screen_ea will return this value"""
+    libida.set_screen_ea.argtypes = [ctypes.c_uint64]
+    libida.set_screen_ea(screen_ea)
+
+def get_library_version()->tuple[int, int, int] | None:
+    """Get IDA library version, return minor, major build in case of success, None if fails"""
+    major = ctypes.c_int()
+    minor = ctypes.c_int()
+    build = ctypes.c_int()
+
+    libida.get_library_version.argtypes = [ctypes.POINTER(ctypes.c_int), ctypes.POINTER(ctypes.c_int), ctypes.POINTER(ctypes.c_int)]
+    libida.get_library_version.restype = ctypes.c_bool
+    success = libida.get_library_version(ctypes.byref(major), ctypes.byref(minor), ctypes.byref(build))
+
+    if success:
+        return major.value, minor.value, build.value
+    else:
+        return None

idapro-0.0.3.dev1/idapro/config.py

@@ -0,0 +1,82 @@
+import os
+import json
+from pathlib import Path
+import platform
+
+def get_user_config_path():
+    """Get the path to the user's config file based on platform following IDA's user directories."""
+    system = platform.system()
+
+    if system == "Windows":
+        # On Windows, use the %APPDATA%\Hex-Rays\IDA Pro directory
+        config_dir = Path(os.getenv('APPDATA')) / "Hex-Rays" / "IDA Pro"
+    else:
+        # On macOS and Linux, use ~/.idapro
+        config_dir = Path.home() / ".idapro"
+
+    # Return the full path to the config file (now in JSON format)
+    user_config_path = config_dir / "ida-config.json"
+    return user_config_path
+
+def create_default_config(user_config_path):
+    """Create a default config file in JSON format."""
+    # Create a default JSON config structure
+    default_config = {
+        "Paths": {
+            "ida-install-dir": ""
+        }
+    }
+
+    # Create the directory if it doesn't exist
+    user_config_path.parent.mkdir(parents=True, exist_ok=True)
+
+    # Write the default config to the user-specific config file
+    with user_config_path.open('w') as configfile:
+        json.dump(default_config, configfile, indent=4)
+
+    print(f"Default config file created at {user_config_path}")
+    return default_config
+
+def load_config():
+    """Load the user-specific config from JSON file."""
+    user_config_path = get_user_config_path()
+
+    if not user_config_path.exists():
+        # If the config file doesn't exist, create it with default values
+        config = create_default_config(user_config_path)
+    else:
+        # If the config file exists, load it
+        with user_config_path.open('r') as configfile:
+            config = json.load(configfile)
+
+    return config
+
+def set_ida_install_dir(new_path):
+    """Set the IDA installation directory in the user-specific JSON config file."""
+    # Get the user-specific config path
+    user_config_path = get_user_config_path()
+
+    # Load the existing config or create default if missing
+    config = load_config()
+
+    # Set the new IDA installation directory path
+    config['Paths']['ida-install-dir'] = new_path
+
+    # Write the changes back to the user-specific config file
+    with user_config_path.open('w') as configfile:
+        json.dump(config, configfile, indent=4)
+
+    print(f"IDA installation directory set to: {new_path}")
+
+def get_ida_install_dir():
+    """Retrieve the IDA installation directory."""
+
+    # Read the configuration JSON file
+    config = load_config()
+    install_dir = config['Paths'].get('ida-install-dir', None)
+
+    # Fallback to IDADIR env var if the JSON value is not set
+    if install_dir is None or len(install_dir) == 0:
+        install_dir = os.environ.get('IDADIR', '')
+
+    return install_dir

idapro-0.0.3.dev1/idapro.egg-info/PKG-INFO

@@ -0,0 +1,213 @@
+Metadata-Version: 2.4
+Name: idapro
+Version: 0.0.3.dev1
+Summary: IDA Library Python module
+Author: Hex-Rays SA
+Author-email: support@hex-rays.com
+License: MIT
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Disassemblers
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-python
+Dynamic: summary
+
+
+# IDA Library Python Module
+
+**⚠️ This is a dev pre-release version. APIs may change without notice and pre-release versions may be deleted at any time.**
+
+
+The IDA Library Python module enables running IDA Pro as an independent Python package outside the IDA UI environment, allowing for programmatic binary analysis and reverse engineering tasks.
+
+
+## Prerequisites
+
+### Environment Setup
+
+Set the `IDADIR` environment variable to point to your IDA installation directory:
+
+**Linux/macOS:**
+```bash
+export IDADIR="/path/to/your/ida/installation"
+```
+
+**Windows:**
+```cmd
+set IDADIR="C:\Program Files\IDA Pro 9.1"
+```
+
+**Example paths:**
+- **macOS:** `/Applications/IDA Professional 9.1.app/Contents/MacOS/`
+- **Windows:** `C:\Program Files\IDA Pro 9.1\`
+- **Linux:** `/opt/ida-9.1/`
+
+> **Note:** If you have already installed and configured the `idapro` Python package in the past using script provided with IDA installation package, setting `IDADIR` is not required.
+
+## Usage example:
+
+```python
+#!/usr/bin/env python3
+"""
+IDA Pro Python Library Usage Example
+This example demonstrates how to analyze a binary file using IDA Pro Python library.
+"""
+
+import argparse
+import importlib.metadata
+
+# You need to import first idapro module
+import idapro
+
+# After idapro module was loaded, you can simply import IDA Python modules
+import ida_entry
+import ida_nalt
+import idaapi
+import idc
+import idautils
+import ida_ida
+import ida_funcs
+import ida_name
+import ida_bytes
+import ida_typeinf
+
+# Read versions, configured IDA pro kernel and python package
+kern_major, kern_minor, kern_build = idapro.get_library_version()
+idapro_version = importlib.metadata.version('idapro')
+kernel_path = idapro.get_ida_install_dir()
+
+# Parse input arguments
+parser = argparse.ArgumentParser(description=f"IDA Library usage example, idapro version: {idapro_version}, "
+    f"kernel version: {kern_major}.{kern_minor}.{kern_build}, kernel libraries path: {kernel_path}")
+parser.add_argument(
+    "-f",
+    "--input-file",
+    help="Binary input file to be loaded",
+    type=str,
+    required=True,
+    default=None
+)
+args = parser.parse_args()
+
+# Print banner with components versions
+print(f"{parser.description}\n")
+
+# Open database
+if idapro.open_database(args.input_file, True) == 0:
+    # Extract minimum/maxim addresses
+    min_ea = ida_ida.inf_get_min_ea()
+    max_ea = ida_ida.inf_get_max_ea()
+    print(f"Addresses range: {hex(min_ea)} - {hex(max_ea)}")
+
+    # Print entry point
+    entry_point = ida_entry.get_entry_ordinal(0)
+    if entry_point != idaapi.BADADDR:
+        entry_addr = ida_entry.get_entry(entry_point)
+        print(f"Entry point: {hex(entry_addr)}")
+
+    # Print some metadata
+    print(f"Metadata:")
+    print(f" path: {idaapi.get_input_file_path()}")
+    print(f" module: {idaapi.get_root_filename()}")
+    print(f" base: {hex(idaapi.get_imagebase())}")
+    print(f" filesize: {hex(ida_nalt.retrieve_input_file_size())}")
+    print(f" md5: {ida_nalt.retrieve_input_file_md5()}")
+    print(f" sha256: {ida_nalt.retrieve_input_file_sha256()}")
+    print(f" crc32: {hex(ida_nalt.retrieve_input_file_crc32())}")
+
+    # Iterate functions
+    for func_ea in idautils.Functions():
+        f = ida_funcs.get_func(func_ea)
+        print(f"Function - name {f.name}, start ea {hex(f.start_ea)}, end ea {hex(f.end_ea)}")
+
+    for seg_ea in idautils.Segments():
+        name = idc.get_segm_name(seg_ea)
+        print(f"Segment - name {name}")
+
+    # Iterate types
+    til = ida_typeinf.get_idati()
+    if til:
+      max_ord = ida_typeinf.get_ordinal_limit(til)
+      current_index = -1
+      current_named_type = None
+
+      while current_index < max_ord - 1:
+          current_index += 1
+          tinfo = ida_typeinf.tinfo_t()
+          if tinfo.get_numbered_type(til, current_index):
+              print(f"Type - id {tinfo.get_tid()}")
+
+      while True:
+          if current_named_type is None:
+              current_named_type = ida_typeinf.first_named_type(til, ida_typeinf.NTF_TYPE)
+          else:
+              current_named_type = ida_typeinf.next_named_type(til, current_named_type, ida_typeinf.NTF_TYPE)
+
+          if not current_named_type:
+              break
+
+          tinfo = ida_typeinf.tinfo_t()
+          if tinfo.get_named_type(til, current_named_type):
+              print(f"Type - name {tinfo.get_type_name()}, id {tinfo.get_tid()}")
+
+    # Iterate comments
+    for ea in idautils.Heads(min_ea, max_ea):
+        cmt = idc.get_cmt(ea, 0)
+        if cmt:
+            print(f"Comment - value {cmt}")
+
+    # Iterate strings
+    for s in idautils.Strings():
+        print(f"String - value {s}")
+
+    for ea, name in idautils.Names():
+        print(f"Name - value {name}")
+
+    # Iterate basic blocks
+    for func_ea in idautils.Functions():
+        func = ida_funcs.get_func(func_ea)
+        if func:
+            fc = idaapi.FlowChart(func)
+            for b in fc:
+                print(f"Basic block - start ea {hex(b.start_ea)}, end ea {hex(b.end_ea)}")
+
+    # Iterate binary instructions
+    for ea in idautils.Heads(min_ea, max_ea):
+        if ida_bytes.is_code(ida_bytes.get_flags(ea)):
+            disasm = idc.generate_disasm_line(ea, 0)
+            print(f"Instruction - ea {hex(ea)}, asm {disasm}")
+
+    # Close database discarding the changes
+    idapro.close_database(False)
+```
+
+## Troubleshooting
+
+### Common Issues
+
+**ModuleNotFoundError: No module named 'idapro'**
+- Ensure `IDADIR` is set correctly
+- Verify IDA Pro is properly installed
+
+**License Issues**
+- Ensure you have a valid IDA Pro license
+- Check that IDA can run normally in GUI mode first
+
+## API Reference
+
+For detailed API documentation, refer to:
+- IDA Python documentation at https://python.docs.hex-rays.com/
+- Built-in help: `help(idapro)` after importing
+- IDA Pro SDK documentation https://docs.hex-rays.com/developer-guide/c++-sdk
+

{idapro-0.0.0 → idapro-0.0.3.dev1}/idapro.egg-info/SOURCES.txt

@@ -1,6 +1,10 @@
-pyproject.toml
+LICENSE
+README.md
+setup.py
 idapro/__init__.py
+idapro/config.py
 idapro.egg-info/PKG-INFO
 idapro.egg-info/SOURCES.txt
 idapro.egg-info/dependency_links.txt
+idapro.egg-info/not-zip-safe
 idapro.egg-info/top_level.txt

idapro-0.0.3.dev1/idapro.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

idapro-0.0.3.dev1/setup.py

@@ -0,0 +1,79 @@
+from setuptools import setup, find_packages
+example_code = "#!/usr/bin/env python3\n\"\"\"\nIDA Pro Python Library Usage Example\nThis example demonstrates how to analyze a binary file using IDA Pro Python library.\n\"\"\"\n\nimport argparse\nimport importlib.metadata\n\n# You need to import first idapro module\nimport idapro\n\n# After idapro module was loaded, you can simply import IDA Python modules\nimport ida_entry\nimport ida_nalt\nimport idaapi\nimport idc\nimport idautils\nimport ida_ida\nimport ida_funcs\nimport ida_name\nimport ida_bytes\nimport ida_typeinf\n\n# Read versions, configured IDA pro kernel and python package\nkern_major, kern_minor, kern_build = idapro.get_library_version()\nidapro_version = importlib.metadata.version('idapro')\nkernel_path = idapro.get_ida_install_dir()\n\n# Parse input arguments\nparser = argparse.ArgumentParser(description=f\"IDA Library usage example, idapro version: {idapro_version}, \"\n    f\"kernel version: {kern_major}.{kern_minor}.{kern_build}, kernel libraries path: {kernel_path}\")\nparser.add_argument(\n    \"-f\",\n    \"--input-file\",\n    help=\"Binary input file to be loaded\",\n    type=str,\n    required=True,\n    default=None\n)\nargs = parser.parse_args()\n\n# Print banner with components versions\nprint(f\"{parser.description}\\n\")\n\n# Open database\nif idapro.open_database(args.input_file, True) == 0:\n    # Extract minimum/maxim addresses\n    min_ea = ida_ida.inf_get_min_ea()\n    max_ea = ida_ida.inf_get_max_ea()\n    print(f\"Addresses range: {hex(min_ea)} - {hex(max_ea)}\")\n\n    # Print entry point\n    entry_point = ida_entry.get_entry_ordinal(0)\n    if entry_point != idaapi.BADADDR:\n        entry_addr = ida_entry.get_entry(entry_point)\n        print(f\"Entry point: {hex(entry_addr)}\")\n\n    # Print some metadata\n    print(f\"Metadata:\")\n    print(f\" path: {idaapi.get_input_file_path()}\")\n    print(f\" module: {idaapi.get_root_filename()}\")\n    print(f\" base: {hex(idaapi.get_imagebase())}\")\n    print(f\" filesize: {hex(ida_nalt.retrieve_input_file_size())}\")\n    print(f\" md5: {ida_nalt.retrieve_input_file_md5()}\")\n    print(f\" sha256: {ida_nalt.retrieve_input_file_sha256()}\")\n    print(f\" crc32: {hex(ida_nalt.retrieve_input_file_crc32())}\")\n\n    # Iterate functions\n    for func_ea in idautils.Functions():\n        f = ida_funcs.get_func(func_ea)\n        print(f\"Function - name {f.name}, start ea {hex(f.start_ea)}, end ea {hex(f.end_ea)}\")\n\n    for seg_ea in idautils.Segments():\n        name = idc.get_segm_name(seg_ea)\n        print(f\"Segment - name {name}\")\n\n    # Iterate types\n    til = ida_typeinf.get_idati()\n    if til:\n      max_ord = ida_typeinf.get_ordinal_limit(til)\n      current_index = -1\n      current_named_type = None\n\n      while current_index < max_ord - 1:\n          current_index += 1\n          tinfo = ida_typeinf.tinfo_t()\n          if tinfo.get_numbered_type(til, current_index):\n              print(f\"Type - id {tinfo.get_tid()}\")\n\n      while True:\n          if current_named_type is None:\n              current_named_type = ida_typeinf.first_named_type(til, ida_typeinf.NTF_TYPE)\n          else:\n              current_named_type = ida_typeinf.next_named_type(til, current_named_type, ida_typeinf.NTF_TYPE)\n\n          if not current_named_type:\n              break\n\n          tinfo = ida_typeinf.tinfo_t()\n          if tinfo.get_named_type(til, current_named_type):\n              print(f\"Type - name {tinfo.get_type_name()}, id {tinfo.get_tid()}\")\n\n    # Iterate comments\n    for ea in idautils.Heads(min_ea, max_ea):\n        cmt = idc.get_cmt(ea, 0)\n        if cmt:\n            print(f\"Comment - value {cmt}\")\n\n    # Iterate strings\n    for s in idautils.Strings():\n        print(f\"String - value {s}\")\n\n    for ea, name in idautils.Names():\n        print(f\"Name - value {name}\")\n\n    # Iterate basic blocks\n    for func_ea in idautils.Functions():\n        func = ida_funcs.get_func(func_ea)\n        if func:\n            fc = idaapi.FlowChart(func)\n            for b in fc:\n                print(f\"Basic block - start ea {hex(b.start_ea)}, end ea {hex(b.end_ea)}\")\n\n    # Iterate binary instructions\n    for ea in idautils.Heads(min_ea, max_ea):\n        if ida_bytes.is_code(ida_bytes.get_flags(ea)):\n            disasm = idc.generate_disasm_line(ea, 0)\n            print(f\"Instruction - ea {hex(ea)}, asm {disasm}\")\n\n    # Close database discarding the changes\n    idapro.close_database(False)"
+
+setup(
+    name="idapro",
+    version="0.0.3.dev1",
+    author="Hex-Rays SA",
+    author_email="support@hex-rays.com",
+    description="IDA Library Python module",
+    long_description=f"""
+# IDA Library Python Module
+\n**⚠️ This is a dev pre-release version. APIs may change without notice and pre-release versions may be deleted at any time.**
+
+
+The IDA Library Python module enables running IDA Pro as an independent Python package outside the IDA UI environment, allowing for programmatic binary analysis and reverse engineering tasks.
+
+
+## Prerequisites
+
+### Environment Setup
+
+Set the `IDADIR` environment variable to point to your IDA installation directory:
+
+**Linux/macOS:**
+```bash
+export IDADIR="/path/to/your/ida/installation"
+```
+
+**Windows:**
+```cmd
+set IDADIR="C:\Program Files\IDA Pro 9.1"
+```
+
+**Example paths:**
+- **macOS:** `/Applications/IDA Professional 9.1.app/Contents/MacOS/`
+- **Windows:** `C:\Program Files\IDA Pro 9.1\`
+- **Linux:** `/opt/ida-9.1/`
+
+> **Note:** If you have already installed and configured the `idapro` Python package in the past using script provided with IDA installation package, setting `IDADIR` is not required.
+
+## Usage example:
+
+```python
+{example_code}
+```
+
+## Troubleshooting
+
+### Common Issues
+
+**ModuleNotFoundError: No module named 'idapro'**
+- Ensure `IDADIR` is set correctly
+- Verify IDA Pro is properly installed
+
+**License Issues**
+- Ensure you have a valid IDA Pro license
+- Check that IDA can run normally in GUI mode first
+
+## API Reference
+
+For detailed API documentation, refer to:
+- IDA Python documentation at https://python.docs.hex-rays.com/
+- Built-in help: `help(idapro)` after importing
+- IDA Pro SDK documentation https://docs.hex-rays.com/developer-guide/c++-sdk
+
+""",
+    long_description_content_type="text/markdown",
+    license="MIT",
+    classifiers=[
+      "Development Status :: 2 - Pre-Alpha",
+      "License :: OSI Approved :: MIT License",
+      "Programming Language :: Python :: 3",
+      "Operating System :: OS Independent",
+      "Topic :: Software Development :: Disassemblers",
+    ],
+    python_requires=">=3.8",
+    packages=["idapro"],
+    zip_safe=False,
+)

idapro-0.0.0/PKG-INFO

@@ -1,5 +0,0 @@
-Metadata-Version: 2.1
-Name: idapro
-Version: 0.0.0
-Summary: Coming soon
-Author-email: Hex-Rays SA <support@hex-rays.com>

idapro-0.0.0/idapro.egg-info/PKG-INFO

@@ -1,5 +0,0 @@
-Metadata-Version: 2.1
-Name: idapro
-Version: 0.0.0
-Summary: Coming soon
-Author-email: Hex-Rays SA <support@hex-rays.com>

idapro-0.0.0/pyproject.toml

@@ -1,8 +0,0 @@
-[project]
-name = "idapro"
-version = "0.0.0"
-description = "Coming soon"
-
-[[project.authors]]
-name = "Hex-Rays SA"
-email = "support@hex-rays.com"