Skip to main content

IDA Pro plugin manager.

Project description

# idaenv - IDAPython Plugin Management

idaenv is a plugin manager for the IDA Pro disassembler. It bridges the gap
between IDA Pro and the greater Python ecosystem of setuptools/virtualenv.

Most Python packages are distributed using setuptools (or perhaps distutils) and
the PyPi package repository. However IDA Pro expects extensions to be standalone
files placed in a specific directory. Using idaenv, you can install Python
packages into a virtual environment using setuptools (or pip), run a single
"update" command, and immediately use plugins, processor modules, or loaders
contained in the package.

## Usage

Initialize a virtual environment to use with IDA Pro:

$ mkvirtualenv -p python2 ida

Install idaenv:

$ cd idaenv
$ python setup.py install

Update the IDAUSR environment variable to include the idaenv plugin directory:

$ export IDAUSR=$HOME/.idapro:$( idaenv prefix )

Install some idaenv compatible extensions using setup.py or pip. Then use the
idaenv "update" command:

$ pip install ...
$ idaenv update
... TODO include output ...

To see what plugins are installed, use the "status" command.

... TODO include output ...

## Mechanism

idaenv takes inspiration from the established `console_scripts` mechanism in
Python. It generates and manages small wrapper scripts that import from an
installed package and then export the interface expected by IDA Pro. For
example, plugin wrappers use the following template:

```python
import pkg_resources

def PLUGIN_ENTRY():
ep = pkg_resources.load_entry_point(%(dist)r, %(group)r, %(name)r)
return ep()
```

## Packaging

In order for idaenv to know where plugins are located inside of a package, they
have to be called out in `setup.py` using "entry points". For example, the
declaration for keypatch might look like:

```python
from setuptools import setup, find_packages


setup(name='keypatch',
version="0.0",
packages=find_packages(exclude=['ez_setup']),
install_requires=[
"keystone-engine"
],
zip_safe=False,
entry_points={
"idapython_plugins": [
"keypatch=keypatch:Keypatch_Plugin_t",
]
})
```

Three different entry point groups are supported:

- `idapython_plugins`
- `idapython_procs`
- `idapython_loaders`

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

idaenv-0.2.0.tar.gz (5.3 kB view details)

Uploaded Source

File details

Details for the file idaenv-0.2.0.tar.gz.

File metadata

  • Download URL: idaenv-0.2.0.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for idaenv-0.2.0.tar.gz
Algorithm Hash digest
SHA256 5820ec9dfca0f118537d80c8c149a5110d70dbc6f302c1b7f3333f43a885ebc0
MD5 79c070a73c818c78b13b504715e1260b
BLAKE2b-256 22668b1635311f9e8722030cf24bc1451d348b5f101a7e841e543804129d0f33

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page