Welcome to the documentation for ShieldChecker, an open-source security testing platform designed to validate Microsoft Defender XDR detections through real-world test execution.
New to ShieldChecker? Start here:
- Deployment Guide - Complete setup and installation instructions
- First Run Wizard - Initial configuration walkthrough
- Test Management - Create your first security test
- Run Tests - Execute and monitor test results
- README - Project overview and quick introduction
- Deployment Guide - Comprehensive deployment instructions
- Prerequisites and environment setup
- Step-by-step deployment process
- First Run Wizard configuration
- Troubleshooting and maintenance
- Test Creation and Management - Complete test lifecycle management
- Creating new security tests
- Test configuration options
- MITRE ATT&CK mapping
- Version history and restoration
- Best practices for test development
- Run and Schedule Tests - Test execution and automation
- Single test execution
- Automated scheduling configuration
- Job monitoring and management
- Review Mode for troubleshooting
- Performance optimization
- Reporting Guide - Comprehensive reporting capabilities
- Dashboard overview and insights
- Detection coverage analysis
- Cost monitoring and optimization
- Advanced reporting with Power BI
- Custom report creation
- Manage Tests - Note: Replaced by CreateTests.md
- Manage Jobs - Note: Content integrated into RunAndScheduleTests.md
| Component | Purpose | Documentation |
|---|---|---|
| Function App | Serverless test execution engine | Deployment Guide |
| Web Application | Management interface and reporting | Reporting Guide |
| Executor | Core test validation engine | Test Execution |
| Bicep Templates | Infrastructure as Code deployment | Deployment Guide |
| VM DSC | Virtual machine configuration | Deployment Guide |
| Scheduler | Automated test orchestration | Scheduling Guide |
- Release Notes: See CHANGELOG.md for version history
- Project Homepage - Latest news, updates, and community information
- MITRE ATT&CK Framework - Reference for attack technique mapping
- Atomic Red Team - Open-source testing framework integration
- Microsoft Defender XDR - Official Microsoft documentation
- GitHub Issues - Report bugs and request features
- Project Homepage - Latest news and updates
Note: ShieldChecker is a community-driven project maintained as a hobby. While we strive to help, there are no guaranteed response times or support SLAs.
Ready to get started? Begin with the Deployment Guide to set up your ShieldChecker environment.