mirror of
https://github.com/cemu-project/idapython.git
synced 2024-11-30 21:14:20 +01:00
1258fab948
- IDA Pro 6.2 support - added set_idc_func_ex(): it is now possible to add new IDC functions using Python - added visit_patched_bytes() (see ex_patch.py) - added support for the multiline text input control in the Form class - added support for the editable/readonly dropdown list control in the Form class - added execute_sync() to register a function call into the UI message queue - added execute_ui_requests() / check ex_uirequests.py - added add_hotkey() / del_hotkey() to bind Python methods to hotkeys - added register_timer()/unregister_timer(). Check ex_timer.py - added the IDC (Arrays) netnode manipulation layer into idc.py - added idautils.Structs() and StructMembers() generator functions - removed the "Run Python Statement" menu item. IDA now has a unified dialog. Use RunPlugin("python", 0) to invoke it manually. - better error messages for script plugins, loaders and processor modules - bugfix: Dbg_Hooks.dbg_run_to() was receiving wrong input - bugfix: A few Enum related functions were not properly working in idc.py - bugfix: GetIdaDirectory() and GetProcessName() were broken in idc.py - bugfix: idaapi.get_item_head() / idc.ItemHead() were not working
115 lines
2.9 KiB
Plaintext
115 lines
2.9 KiB
Plaintext
------------------------------------------------------
|
|
IDAPython - Python plugin for Interactive Disassembler
|
|
------------------------------------------------------
|
|
|
|
What is IDAPython?
|
|
------------------
|
|
|
|
IDAPython is an IDA plugin which makes it possible to write scripts
|
|
for IDA in the Python programming language. IDAPython provides full
|
|
access to both the IDA API and any installed Python module.
|
|
|
|
Check the scripts in the examples directory to get an quick glimpse.
|
|
|
|
|
|
Availability
|
|
------------
|
|
|
|
Latest stable versions of IDAPython are available from
|
|
http://code.google.com/p/idapython/downloads/list
|
|
|
|
Development builds are available from
|
|
http://code.google.com/p/idapython/
|
|
|
|
|
|
Resources
|
|
---------
|
|
|
|
The full function cross-reference is readable online at
|
|
http://www.hex-rays.com/idapro/idapython_docs/
|
|
|
|
Bugs and enhancement requests should be submitted to
|
|
http://code.google.com/p/idapython/issues/list
|
|
|
|
Mailing list for the project is hosted by Google Groups at
|
|
http://groups.google.com/group/idapython
|
|
|
|
|
|
Installation from binaries
|
|
--------------------------
|
|
|
|
1. Install 2.6 or 2.7 from http://www.python.org/
|
|
2. Copy the whole "python" directory to %IDADIR%
|
|
3. Copy the contents of the "plugins" directory to the %IDADIR%\plugins\
|
|
4. Copy "python.cfg" to %IDADIR%\cfg
|
|
|
|
Usage
|
|
-----
|
|
|
|
- Run script: File / Script file (Alt-F7)
|
|
- Execute Python statement(s) (Ctrl-F3)
|
|
- Run previously executed script again: View / Recent Scripts (Alt+F9)
|
|
|
|
|
|
* Batch mode execution:
|
|
|
|
Start IDA with the following command line options:
|
|
|
|
-A -OIDAPython:yourscript.py file_to_work_on
|
|
or
|
|
-Syourscript.py
|
|
or
|
|
-S"yourscript.py arg1 arg2 arg3"
|
|
|
|
(Please see http://www.hexblog.com/?p=128)
|
|
|
|
If you want fully unattended execution mode, make sure your script
|
|
exits with a qexit() call.
|
|
|
|
By default scripts run after the database is opened. Extended option
|
|
format is:
|
|
|
|
-OIDAPython:[N;]script.py
|
|
|
|
Where N can be:
|
|
0: run script after opening database (default)
|
|
1: run script when UI is ready
|
|
2: run script immediately on plugin load (shortly after IDA starts and before processor modules and loaders)
|
|
|
|
* User init file
|
|
|
|
You can place your custom settings to a file called 'idapythonrc.py'
|
|
that should be placed to
|
|
|
|
${HOME}/.idapro/
|
|
|
|
or
|
|
|
|
%AppData%\Hex-Rays\IDA Pro
|
|
|
|
The user init file is read and executed at the end of the init process.
|
|
|
|
Please note that IDAPython can be configured with "python.cfg" file.
|
|
|
|
* Invoking Python from IDC
|
|
|
|
The IDAPython plugin exposes a new IDC function "RunPythonStatement(string idc_code)" that allows execution
|
|
of Python code from IDC
|
|
|
|
* Invoking IDC from Python
|
|
|
|
It is possible to use the idc.Eval() to evaluate IDC expressions from Python
|
|
|
|
* Making Python the default language
|
|
|
|
By default, IDA will use IDC to evaluate expressions. It is possible to change the default language to use
|
|
Python instead of IDC.
|
|
|
|
In order to do that, please use the following IDC code:
|
|
|
|
RunPlugin("python", 3)
|
|
|
|
To disable Python language and revert back to IDC:
|
|
RunPlugin("python", 4)
|
|
|