The Beginner's Guide to IDAPython
Minimum price
Suggested price

The Beginner's Guide to IDAPython

About the Book


This is a book about IDAPython.

I originally wrote it as a reference for myself - I wanted a place to go to where I could find examples of functions that I commonly use (and forget) in IDAPython. Since I started this bookI have used it many times as a quick reference to understand syntax or see an example of some code - if you follow my blog you may notice a few familiar faces – lots of scripts that I cover here are result of sophomoric experiments that I documented online.

Over the years I have received numerous emails asking what is the best guide for learning IDAPython. Usually I will point them to to Ero Carrera's Introduction to IDAPython or the example scripts in the IDAPython's public repo. They are excellent sources for learning but they don't cover some common issues that I have come across. I wanted to create a book that covers these issues.I feel this book will be of value for anyone learning IDAPython or wanting a quick reference for examples and snippets. Being an e-book it will not be a static document and I plan on updating it in the future on regular basis.

The above snippet is from the Introduction of the The Beginner's Guide to IDAPython. I wrote this book in my spare time. It has been rewritten to cover changes made with the release of IDA 7. The price of the ebook is free (move the slider to left) but has a suggested price of $24.99.


Version 1.0

  • Published

Version 2.0

  • Table of Contents and closing added

Version 3.0

  • Grammar fixes provided by Russell V. and added an example of renaming operands.

Version 4.0

  • Support for IDAPython 7.0

Version 4.1

  • Bug fixes provided by Minh-Triet Pham Tran @MinhTrietPT

Version 5.0 

  • Converted format from Markdown to Microsoft Word.
  • Yara chapter added
  • Coloring chapter added
  • Structure chapter added
  • Enumerated Types chapter added
  • What’s next chapter added
  • Fixed bug found by @qmemcpy
  • Added MakeFunction as requested by Minh-Triet Pham Tran

Version 6.0

  • Support for IDAPython 7.4 and Python 3.
  • Extracting Function Arguments chapter added
  • Basic Blocks chapter added
  • PyQt chapter added
  • Unicorn Engine chapter added

About the Author

Alexander Hanel
Alexander Hanel

I work as a reverse engineer and malware analyst. I enjoy coding, reverse engineering, data analysis and a bunch of outdoor activities. I live in Boulder, Colorado. For more information about my work you can check out my blog or my code repository.

Table of Contents

Table of Contents

Introduction 2

Updates 2

Intended Audience & Disclaimer 3

Conventions 3

IDAPython Background 4

Old vs New 4

Python-x86_64 Issues 5

The Basics 6

Segments 7

Functions 8

Extracting Function Arguments 14

Instructions 15

Operands 18

Basic Blocks 21

Structures 24

Enumerated Types 28

Xrefs 30

Searching 35

Selecting Data 41

Comments & Renaming 42

Coloring 49

Accessing Raw Data 50

Patching 51

Input and Output 53

PyQt 56

Batch File Generation` 58

Executing Scripts 60

Yara 61

Unicorn Engine 66

Debugging 77

What’s Next? 77

Closing 78

Appendix 78

Unchanged IDC API Names 78

PeFile 79

The Leanpub 45-day 100% Happiness Guarantee

Within 45 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.

See full terms

Do Well. Do Good.

Authors have earned$10,878,918writing, publishing and selling on Leanpub, earning 80% royalties while saving up to 25 million pounds of CO2 and up to 46,000 trees.

Learn more about writing on Leanpub

Free Updates. DRM Free.

If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).

Most Leanpub books are available in PDF (for computers), EPUB (for phones and tablets) and MOBI (for Kindle). The formats that a book includes are shown at the top right corner of this page.

Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.

Learn more about Leanpub's ebook formats and where to read them

Write and Publish on Leanpub

You can use Leanpub to easily write, publish and sell in-progress and completed ebooks and online courses!

Leanpub is a powerful platform for serious authors, combining a simple, elegant writing and publishing workflow with a store focused on selling in-progress ebooks.

Leanpub is a magical typewriter for authors: just write in plain text, and to publish your ebook, just click a button. (Or, if you are producing your ebook your own way, you can even upload your own PDF, EPUB and/or MOBI files and then publish with one click!) It really is that easy.

Learn more about writing on Leanpub