Skip to content

README.md

Latest commit

 

History

History
72 lines (50 loc) · 2.47 KB

README.md

File metadata and controls

72 lines (50 loc) · 2.47 KB

Package manager for IDA Pro

WARNING: This project is still between alpha and beta state. Feel free to report bugs if this is not working!

How to install

Execute the script below in IDAPython console (minified installer.py.)

import urllib,zipfile,tempfile,sys,os,threading,shutil
def b():P=os.path;r='v0.1.3';n=tempfile.NamedTemporaryFile(delete=False,suffix='.zip');n.close();print 'Downloading idapkg...';urllib.urlretrieve('https://github.com/Jinmo/idapkg/archive/%s.zip'%r,n.name);f=open(n.name,'rb+');f.seek(0,2);f.truncate(f.tell()-0x28);f.close();z=zipfile.ZipFile(n.name);J=z.namelist()[0];sys.path+=[P.join(n.name,J)];from pkg.config import g;import pkg.main as main;S=g['path']['packages'];z.extractall(S);z.close();Y=P.join(S,'idapkg');P.isdir(Y)and shutil.rmtree(Y);os.rename(P.join(S,J),Y);main.update_pythonrc();main.init_environment(False);print 'Installation success! Please restart IDA to use idapkg.';os.unlink(n.name);
threading.Thread(target=b).start()

Then you can access related actions via command palette (Ctrl+Shift+P on windows/mac/linux, or Command+Shift+P on mac) after restarting IDA Pro.

What file is created

~(Your home directory)/idapkg, and some lines in idapythonrc.py will be created.

idapkg/
  packages/
  python/
  config.json

packages/

When a package is installed, packages/<name> is created and further added to IDAUSR variable. This enables following folders to be loaded by IDA Pro.

<name>
  plugins/
  procs/
  loaders/
  til/
  sig/
  ids/

python/ - virtualenv

To manage PIP packages easily, this creates a virtualenv and creates pip, easy_install and other virtalenv-related files and activates the environment.

TL;DR If you run pip install, they are installed into python/lib/* (Lib on windows, all same.)

config.json

In fact, all paths above are configurable!

{
    "path": {
        "virtualenv": "...\\idapkg\\python", 
        "packages": "...\\idapkg\\packages"
    }, 
    "repos": [
        "https://api.idapkg.com"
    ]
}

And you can use your private repo for fetching packages. The api server will be uploaded soon!

Writing a package

See Writing a package (link).

TODO

Currently finding way to reliably and generally update IDAUSR variable on all platforms. Currently only supporting Windows and Mac OS X.