Welcome to SWAT’s documentation!

Contents:

Documentation

• SWAT (Simple Workspace ATT&CK Tool)
  • Description
  • Features
  • Installation
  • Documentation
  • Inspirations
  • Contribution
  • Support
  • Stay Updated
  • Disclaimer
  • License
• Prerequisites
  • Organization
  • Credentials
  • Enabled APIs and Domain-Wide Delegation
  • Google Cloud Platform (GCP) Requirements
  • Local Python Environment
  • Conclusion
• Getting Started
  • Authentication with GCP
  • Starting Steps
• Authentication & Authorization with Google Workspace
  • Google Workspace Authentication Mechanisms
  • The Credential Store (from base.py)
  • Dataclasses for Credentials
  • Command Execution with auth.py
  • Google Workspace Scopes
  • Emulation Access to Credential Store
  • Persistence of Credentials
  • Recommendations
  • Conclusion
• Commands
  • Prerequisites
  • Understanding the BaseCommand Class
  • Understanding Commands
  • BaseCommand Inheritance
  • Command Structure
  • Dynamic Loading
  • Error Handling and Logging
  • Adding a New Command
• Emulations
  • Prerequisites
  • Understanding the BaseEmulation Class
  • Emulation Structure
  • BaseEmulation Inheritance
  • Dynamic Loading
  • Error Handling and Logging
  • Adding a New Emulation
  • Conclusion
• Logging
  • Logging module
  • Setup and Configuration
  • Usage in Commands and Emulations
  • Colors and Humor
  • Logging Philosophy
  • Conclusion
• How-To Guides
  • Add Dependencies
  • Create Application Credentials
  • Authenticate
  • Commands
  • Emulations
  • Audit Log Data
  • Explore ATT&CK Coverage
• Contributing
  • Reporting Bugs
  • Suggesting Enhancements
  • Recognition
  • Questions?
• Developer’s Guide for SWAT
  • Development Environment Setup
  • Debugging
  • SWAT’s Modular Architecture
  • SWAT Design Principles
  • Modules & Components
  • Emulation Workflow
  • Command Workflow
  • Extending SWAT
  • Contribution Guidelines
  • Feedback & Questions
  • Contribution Process
  • Tips and Tricks
• Changelog
  • Current (Unreleased)
  • [0.0.1] - 2023-08-12

Indices and tables

• Index

• Module Index

• Search Page