index.adoc

Kaitai Struct: documentation

Want to use Kaitai Struct?

• User guide

• Serialization guide

• KSY style guide — best practices in creation of robust KSY specs

• KSY syntax diagram

• FAQ — frequently asked questions

• awesome-kaitai — A list of Kaitai Struct tools and resources

Tutorials, writeups

• Reverse engineering visual novels 101 by Masumi Nakamura

• Reverse engineering visual novels 101, part 2 by Masumi Nakamura

• Experimentation with Reverse Engineering - Trails in the Sky (FC / SC) Extracting Sprite Data w/ Unix Tools & Kaitai Struct by Vaughan Hilts

• Reverse Engineering with Kaitai Struct by Andrei Cheremskoy

• Parsing Binaries With Kaitai Struct with example on parsing ESP8266 firmware image

• Understanding industrial network traffic, dissectors and Lua and Kaitai

• Google CTF 2018 Better Zip writeup by russtone

• Database Reverse Engineering by Sergey Zelenyuk

  • Database Reverse Engineering, Part 1: Introduction

  • Database Reverse Engineering, Part 2: Main Approaches

  • Database Reverse Engineering, Part 3: Code Reuse, Conclusion

• Kaitai Struct and Scientific Data by Matthew Turk

Language-specific notes

• C++/STL

• Java

• JavaScript

• PHP

• Python

Want to contribute to KS development?

• CI (Continuous Integration) dashboard

• Developers memo — basic information on how to build, test and release KS

• Developers intro — gentle introduction to KS reference compiler architecture

• Adding support for new target language

• KST — a way to write specs for testing in cross-language manner

• Kaitai Stream API

• Kaitai Stream Java API — autogenerated with Javadoc

• Kaitai Stream Ruby API — autogenerated with yard

• Continuous Integration (CI) infrastructure