Skip to content

Revizor Documentation

Everything you need to know about using, understanding, and contributing to Revizor.

First Steps

Are you new to Revizor? Start here:

  • Revizor at a Glance: Understand what Revizor is, what problems it solves, and see a quick example of violation detection.
  • Installation Guide: Get Revizor installed on your system and verify your setup.
  • Your First Fuzzing Campaign: Follow a hands-on tutorial that walks you through running your first test, detecting a violation, and understanding the results.
  • Core Concepts: Learn about contracts, traces, speculation, and other fundamental concepts needed to use Revizor effectively.
  • Glossary: A quick reference for key terms used throughout the documentation.

Getting Help

Stuck? Need clarification? Here's where to get help.

How the Documentation is Organized

Revizor's documentation is organized into five distinct categories based on your needs:

Learning-Oriented: Tutorials

Tutorials take you by the hand through a series of steps to complete a project. They are designed for newcomers who want to get started with Revizor. Start here if you're learning.

  • Main Tutorial Series: Follow a series of hands-on tutorials that walk you through running your first tests, detecting violations, and rump up all the way to root-cause analysis and design of custom campaigns.
  • How TSA-SQ Was Detected: A practical case study showing how Revizor was used to discover the TSA-SQ vulnerability. For those interested in how Revizor is used in the real world.

Task-Oriented: How-To Guides

How-to guides are recipes that guide you through steps to solve specific problems. They assume you have basic knowledge and want to accomplish something particular.

Understanding-Oriented: Topic Guides

Topic guides provide background and explanation to help you understand how Revizor works. They don't contain step-by-step instructions but explain key concepts in depth.

Information-Oriented: Reference

Reference guides contain technical descriptions of Revizor's components. They're like a dictionary—useful when you know what you're looking for.

Contributor-Oriented: Development Guides

Development guides help contributors understand the codebase, architecture, and development practices.

Research and Background

Revizor is built on peer-reviewed research in hardware security and formal methods. All papers related to Revizor are listed in the Research Papers section.

Documentation Feedback

If you find errors, confusing explanations, or missing information in the documentation, please let us know:

  • Open an issue with the "documentation" label
  • Suggest improvements via pull request
  • Discuss on GitHub Discussions