Welcome to snr’s documentation!

Starting out, you can read Installing Snr to install snr and then dive into Getting Started with Snr to get started!

Also you might want to read the FAQ for commonly asked questions. After that you might want to get a more deeper knowledge of snr with reading Deeper Introduction and Shell Commands.

For details on how to protect your devices from snr (and similar physical-based attacks), you can read Protection.

If you are interesting in developing your own payloads do not forget to read our dedicated payload development guide (Develop Your Own Payload)!

User Guide

• Installing Snr
  • Stable Installation
  • Installation (Beta)
  • Installation (From Source Code)
• Getting Started with Snr
  • Initialize Snr
  • Snr Basics
• Deeper Introduction
  • Verbosity
  • Message Symbols
  • Reality of Payloads
  • Advanced Variable Management
  • Payload Unloading
  • Variables
• Payload Categories
  • access
  • extraction
  • infection
  • tampering
  • misc
• Shell Commands
  • Filesystem Commands
  • Variable Commands
  • Payload Commands
  • Miscellaneous Commands
• Configuration
  • Configuration Priority
  • Configuration Keys
• Protection
  • Firmware
  • Bootloader
  • Operating System
• FAQ
  • Can I run snr on windows?
  • How much of my internet connection does snr use?
  • Can I run snr as root?
  • I configured something wrong, can I revert it?
  • Can I hack my ex/classmate/this guy I don’t like with it?
  • DBus error when attempting to install the project

Payload Development Guide

• Develop Your Own Payload
• Terminology
• Payload Development Basics
  • About the Generation Process
  • Safety Pin
  • Rootfs
  • /data Directory
  • LVM Support
  • LUKS and BitLocker Support
  • Payload Entry Point
• Payload Class
  • Payload Class Important Members
  • Payload Class Informational Members
  • Payload Class Optional Methods
  • Example
• Payload Types
  • Standalone Payloads
  • Framework Payloads
• Working Example
• Variable Validation
  • Validation Flags
• Partition Types
  • Partition Detection Criteria
  • Examples
  • Details
  • How to Use the Flags
• Rootfs Versions
  • Legacy
  • Non-legacy versions
• Contributing a Payload

Command Development Guide

• Develop Your Own Command
  • Basics of Commands
  • Add an Argument
  • Add an Optional Argument
  • Add an Integer Argument
  • Add a Path Argument
• Shell Highlighting
  • Command Accepts No Arguments
  • Command Accepts One or More Optional Arguments
  • Command Accepts One Keyword Argument
  • Command Accepts One Keyword Argument and One or More Optional Arguments

Snr Changelog

• Changelog
  • Quick Access
  • Legacy Versions
  • v1.0.X
  • v1.1.x
  • v1.2.X
  • v1.3.X
  • v1.4.X
  • v1.5.X (Stable)
  • v1.6.X

API Reference

• snr package
  • Subpackages
    • snr.cli package
    • snr.core package
  • Submodules
    • snr.version module
• GNU Free Documentation License
  • 0. PREAMBLE
  • 1. APPLICABILITY AND DEFINITIONS
  • 2. VERBATIM COPYING
  • 3. COPYING IN QUANTITY
  • 4. MODIFICATIONS
  • 5. COMBINING DOCUMENTS
  • 6. COLLECTIONS OF DOCUMENTS
  • 7. AGGREGATION WITH INDEPENDENT WORKS
  • 8. TRANSLATION
  • 9. TERMINATION
  • 10. FUTURE REVISIONS OF THIS LICENSE
  • 11. RELICENSING

Indices and tables

• Index

• Module Index

• Search Page

License

GNU Free Documentation License

Copyright (C) 2024 GlobularOne. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled “GNU Free Documentation License”.