2019-08-05 03:06:28 +08:00
# Pykd - not only python extension for WinDBG
2018-07-10 19:50:01 +08:00
## Purpose
This project can help to automate debugging and crash dump analysis using Python. It allows one to take the best from both worlds: the expressiveness and convenience of Python with the power of WinDbg!
## Why do I need this?
If you want to automate the debugger but dislike the WinDbg built-in script machine syntax it's time to try again using the handy and powerful Python language. Even if you don't want to create your own script, maybe some existing scripts will be of interest to you?
2019-08-05 03:06:28 +08:00
## Getting started
2020-02-15 18:18:49 +08:00
* You should have installed python. Supported python: 2.7, 3.5, 3.6, 3.7 or 3.8
2019-08-05 03:06:28 +08:00
* Install pykd with command: 'pip install pykd'
2020-02-15 18:18:49 +08:00
* Use windbg extension (bootstrapper) to run pykd with windbg
2018-07-10 19:50:01 +08:00
2020-02-15 18:18:49 +08:00
## Windbg extension (bootstarpper)
2019-08-05 03:06:28 +08:00
Use it to run pykd within windbg.
[Home Page ](https://githomelab.ru/pykd/pykd-ext )
[Download ](https://githomelab.ru/pykd/pykd-ext/wikis/Downloads )
2018-07-10 19:50:01 +08:00
2020-02-15 18:18:49 +08:00
## Releases
Just run 'pip install pykd' to install or 'pip install pykd --upgrade' to upgrade to the last version
[PyPi ](https://pypi.org/project/pykd )
[All Releases ](/../wikis/All Releases )
2018-07-10 19:50:01 +08:00
## Documentation
2019-06-08 05:34:32 +08:00
[Wiki Home ](/../wikis/Home )
2018-07-10 19:50:01 +08:00
[User Manual ](/../wikis/User Manual rus )
2019-08-05 03:06:28 +08:00
[API Reference ](/../wikis/API Reference )
## Useful tools for pykd and WinDBG
[windbg-pack ](https://githomelab.ru/pykd/windbg-pack )
Set of python scripts for WinDBG
[pykdwin ](https://githomelab.ru/pykd/pykdwin )
A library with auxiliary modules for writing small pykd scripts and daily use.
[windbg-kernel ](https://githomelab.ru/pykd/windbg-kernel )
Set of pykd script for kernel debugging
2018-07-10 19:50:01 +08:00
## How to build ?
2018-07-10 20:04:16 +08:00
* install VS 2017
https://visualstudio.microsoft.com/downloads/
* install cmake
https://cmake.org/
* install git
https://git-scm.com/
2018-07-10 19:50:01 +08:00
* get sources:
2018-07-10 19:56:29 +08:00
```
git clone --recurse-submodules https://githomelab.ru/pykd/pykd.git local_dir
```
* open pykd.sln
2019-08-05 03:06:28 +08:00
* choose a python version and a target platform then build pykd projects
## Projects used pykd
[mona.py ](https://github.com/corelan/mona )
the exploit writer's swiss army knife
[flare-dbg ](https://github.com/fireeye/flare-dbg )
flare-dbg is a project meant to aid malware reverse engineers in rapidly developing debugger scripts.
[voltron ](https://github.com/snare/voltron )
Voltron is an extensible debugger UI toolkit written in Python
