Assets Guardian

Audit identities, access rights, and security compliance across all solutions in your Information System from a single place, with all data consolidated into one unified format regardless of the source.

Guides

• 🛡️ Assets Guardian
  • 🔌 Available Plugins
  • 🚀 Quick Start
    • 1. Install the command
    • 2. Prepare an audit folder
    • 3. Run it
  • 📜 License
• 🚀 Getting started
  • 📦 Installation
    • 🔗 Clone the repository
    • 🐍 Standalone install
      • Installation
      • Upgrade
      • Uninstall
    • 🐍 Local dev
    • 🐳 Docker image (use)
    • 💻 Dev Container
    • 🐳 Docker image (develop)
  • ⚙️ Setup configurations
    • 📁 Configuration Files
    • 📑 File Details
      • 📄 The config.yml file
        • The env parameter
        • The author section
        • The notification_email section
        • The logging section
        • The paths section
        • Excel workbook integrity
        • Plugin sections
      • 🔑 Environment variables
        • Injecting environment variables into config.yml (recommended)
        • How get_config_value resolves configuration
      • 📄 The template.config.yml file
      • 📄 The rules_config.yml file
      • 📄 The employees.json file
      • 📄 The excel_config.json file
      • 📄 The pdf_config.json file
  • ▶️ Running
    • 🛡️ Assets Guardian commands
    • 🧪 Power-user scripts
    • ▶️ Running by mode
      • 🐍 Standalone (with assets-guardian)
      • 🐍 Local dev (with uv)
      • 🐳 Docker image (use)
      • 💻 Dev Container (VS Code)
      • 🐳 Docker image (develop)
• 🔐 Access Matrix Guide
  • 🧭 How matrices work
    • 🔄 Lifecycle
    • 🏷️ Sheet naming
    • 📐 Sheet layout
    • 🎯 Matching rules
    • ⚙️ Enabling the matrix rules
    • 🧩 Interpretation is plugin-specific
  • 🦊 GitLab matrix
    • 🗂️ Scope columns
    • 🔤 Accepted cell values
    • ⚖️ Evaluation semantics
    • 📝 Example
  • 💼 Dolibarr matrix
    • 🗂️ Scope columns
    • 🔤 Accepted cell values
    • ⚖️ Evaluation semantics
    • 📝 Example
  • ☁️ Microsoft 365 matrix
    • 🗂️ Scope columns
    • 🔤 Accepted cell values
    • ⚖️ Evaluation semantics
    • 📝 Example
  • ✅ Filling checklist
• 🏗️ Software Architecture Documentation
  • What is Assets Guardian?
  • System Overview
  • Startup Sequence - Plugin Discovery
  • Commands and Data Flows
    • sync - Update the Excel repository
    • audit - Compliance audit and PDF report
    • check - Configuration health check
    • script - Power-user custom scripts
  • Domain Models
  • Plugin System
    • What a plugin contains
    • Plugin interfaces
    • Registration via decorators
    • Multi-instance support
  • Design Patterns
    • Hexagonal Architecture (Ports and Adapters)
    • Registry and Factory
    • Template Method (Collector base class)
    • Strategy (Compliance rules)
    • Dependency Injection
    • Cache (JSON Lines)
  • Configuration Reference
    • config/config.yml - Main configuration
    • config/rules_config.yml - Compliance rules
    • config/employees.json - HR reference
  • Key Technical Decisions
• 🧩 Plugin Development Guide
  • Architecture Overview
    • Key Design Principles
  • Plugin Directory Structure
  • Core Interfaces (Required)
    • IClientProvider
    • IRepository
    • IMapper
    • Collector
  • Optional Interfaces
    • ISheetBuilder (Sync Mode)
    • IRule (Audit Mode)
    • IPDFBuilder (Audit Mode)
  • Registries & Registration
    • Naming rule IDs
  • JSON Excel Configuration (Generic Sheet Builder)
    • JSON Configuration Structure
    • Available Configuration Options
      • Sheet Level
      • Column Level
      • Columns required by the round-trip
    • Rules & Formatting Reference
      • List Validation (Dropdowns)
      • Conditional Formatting
  • Configuration Workflow
    • Auditing Rules Setup
  • Plugin Lifecycle & Data Flow
  • Complete Example (myplugin)
    • plugins/myplugin/constants.py
    • plugins/myplugin/client.py
    • plugins/myplugin/repository.py
    • plugins/myplugin/mapper.py
    • plugins/myplugin/collector.py
  • Troubleshooting & Common Pitfalls
    • Plugin is not registered or discovered
    • Health check fails or crashes the application
    • Columns disappear during Excel sync regeneration
  • Testing & Validation Checklist
• 🤝 Contributing
  • 🙋 What Can I Contribute?
    • 🐛 Reporting a Bug
    • 💡 Requesting a Feature
    • 🔧 Fixing Something
    • 📖 Improving the Documentation
    • 🧩 Adding a Plugin
    • 🏗️ Refactoring the Core
  • 💻 Contributing Code
    • 🌳 Branching Model
    • 🛠️ Set Up Your Environment
    • 🌿 Branch Naming
    • 📝 Commit Messages
    • ✅ Code Quality
      • 🐍 Pytest Details
    • ✍️ Code Documentation
  • 🔀 Opening a Pull Request
  • 📚 Contributing Documentation
  • 🚀 Release Process
    • 🏷️ Cutting a release
  • 🆘 Getting Help
• 📜 Code of Conduct
  • 🤝 Our Pledge
  • ✅ Our Standards
  • 🛡️ Enforcement Responsibilities
  • 🌐 Scope
  • 📢 Reporting & Enforcement
  • 📄 Attribution
• 🚨 Security Policy
  • 🏷️ Supported Versions
  • 📢 Reporting a Vulnerability

Code Reference

• CLI — Command Line Interface
  • assets-guardian
• Domain — Business Core
  • assets_guardian.core.domain.models
  • assets_guardian.core.domain.ports
  • assets_guardian.core.domain.engines
• Plugins — Integrations
  • assets_guardian.plugins.gitlab
  • assets_guardian.plugins.microsoft365
  • assets_guardian.plugins.dolibarr
  • assets_guardian.plugins.teleport
• Reporting — Excel, PDF
  • assets_guardian.core.reporting.excel
  • assets_guardian.core.reporting.pdf
• Clients — HTTP, MySQL
  • assets_guardian.core.clients
• Plumbing — Config, Logging, Cache
  • assets_guardian.core.config
  • assets_guardian.core.logging
  • assets_guardian.core.cache
• Utils — Dates, IP
  • assets_guardian.utils