Repository files navigation

Status: 🚧 Active Development |Version: 0.1.0 → 1.0.0 (in progress)

FortiPath is a comprehensive executive protection toolkit designed to enhance the safety, efficiency, and effectiveness of protection details. By leveraging state-of-the-art technologies and methodologies—including AI-powered threat analysis, OSINT web crawling, and advanced route planning—FortiPath aims to revolutionize the executive protection industry.

Note: FortiPath follows theSpec-Kit specification-driven development framework. All features and development are guided by documented specifications in the.specify/ directory.

Development Status: FortiPath is currently undergoing a comprehensive modernization effort. See theImplementation Plan for details on features being developed.

To provide executive protection professionals with a modern, integrated toolkit that combines threat intelligence, operational planning, and real-time communication capabilities—all while maintaining the highest standards of security and privacy.

Visit the FortiPath project site:https://cywf.github.io/FortiPath/

The live site features:

• 📊Real-time Statistics - Repository metrics, language breakdown, and commit activity
• 💬Discussions Browser - Searchable list of community discussions
• 📋Development Board - Interactive Kanban view of project progress
• 📚Documentation Hub - Easy access to all project documentation
• 🎨Project Visualizer - Interactive Mermaid diagrams of architecture and workflows
• ✏️Issue Creation - Guided interface for creating GitHub issues
• 🎨Theme Selection - Choose from 7 dark/neon theme variants

The site is built withAstro + React + TailwindCSS + daisyUI and automatically deployed via GitHub Actions on every push to main.

• OSINT Web Crawler (Rust) - High-performance web crawling for threat intelligence gathering
• Risk Assessment - Dietz Scale implementation for threat evaluation and management
• Location Assessment - Comprehensive site surveys and security assessments
• Physical Reconnaissance - Detailed physical security evaluations

• AI-Powered Report Writing - Automated generation of professional security reports including:
  • Advance Surveys
  • Threat Assessments & Analysis
  • After Action Reviews
  • Incident Reports
  • Travel Security Read-Aheads
  • Vulnerability Assessments
  • Threat Management Plans
  • Estate Security Plans
  • Protective Intelligence Analysis Summaries
  • Professional Emails

• Route Planning - Advanced surveillance detection route (SDR) planning with real-time updates
• Emergency Planning - Comprehensive emergency response planning tools
• Disaster Planning - Natural disaster and crisis management preparation
• Training & Drills - Structured training programs and exercise planning

• TAK Server Integration - Seamless communication between agents and command center
• ZeroTier Network Security - Secure, encrypted, private network creation
• Digital Countermeasures - Active cyber defense and digital security tools
• Network Scanning - Security vulnerability scanning and assessment

• Law Enforcement Collaboration - Intelligence sharing and joint operations support
• Scheduling & Coordination - Team scheduling and resource management
• Information Warfare - Counter-intelligence and information security

• Terraform Infrastructure - Infrastructure as Code for cloud deployments
• Custom Terraform Provider - FortiPath-specific infrastructure automation
• Docker Containerization - Portable and scalable deployment options

Legend: ✅ Complete | 🔨 In Development | 📋 Planned | ⏸️ On Hold

• Python 3.8+ - Core application runtime
• Rust (2021 edition) - For OSINT crawler module
• Go 1.19+ - For Terraform provider development
• Terraform 1.0+ - Infrastructure deployment
• Docker - Container-based deployments (optional)

# 1. Clone the repositorygit clone https://github.com/cywf/FortiPath.gitcd FortiPath# 2. Set up Python environmentpython3 -m venv venvsource venv/bin/activate# On Windows: venv\Scripts\activate# 3. Install Python dependenciespip install -r requirements.txt# 4. Explore available scriptsls scripts/# 5. Try a sample script (e.g., route planning)python scripts/route-planning/route_planning_script.py --help

For detailed setup instructions, see theDevelopment Environment Setup Guide.

FortiPath follows theSpec-Kit framework for transparent, organized development:

• Transparency: All development is documented and traceable
• Organization: Clear structure for planning and execution
• Collaboration: Easy for contributors to understand project direction
• Quality: Ensures features meet documented requirements
• AI-Friendly: Enables AI agents to work within defined specifications

Read theConstitution to understand FortiPath's development principles.

The FortiPath project site (site/) is built with Astro and automatically deployed to GitHub Pages.

# Navigate to site directorycd site# Install dependenciesnpm install# Start development servernpm run dev# Build for productionnpm run build# Preview production buildnpm run preview

The dev server runs athttp://localhost:4321/FortiPath/

Add a Mermaid Diagram:

1. Create a.mmd file in the/mermaid/ directory
2. The diagram will automatically appear in the Visualizer page

Add Documentation:

1. Add markdown files to the/docs/ directory
2. They will automatically appear in the Docs page

Update Data:The site displays live data from the repository (stars, forks, discussions, project board). This data is fetched during the CI build process using these scripts:

• site/scripts/fetch_repo_data.ts - Repository statistics and commit history
• site/scripts/fetch_discussions.ts - Latest discussions
• site/scripts/fetch_projects.ts - Project board items

The data is exported tosite/public/data/*.json during build and consumed by the site pages.

The.github/workflows/pages.yml workflow:

1. Fetches latest data using the GitHub API
2. Builds the Astro site
3. Deploys to GitHub Pages

The site is automatically redeployed on every push tomain.

Auto-generated on each push:repo-map.html (via GitHub Pages and CI artifact).

An interactive mind map visualization of the entire FortiPath codebase is automatically generated on every push to the main branch. This provides:

• Visual navigation of the repository structure
• Language breakdown showing the distribution of code across different languages
• Interactive exploration with expandable/collapsible sections

The map is available at:https://cywf.github.io/FortiPath/repo-map.html (once GitHub Pages is enabled)

You can also download the latest version from theActions artifacts tab.

Core Application:

• Python 3.8+ - Main application logic, scripts, and integrations
• Rust (2021) - High-performance OSINT web crawler
• Go 1.19+ - Custom Terraform provider

Infrastructure:

• Terraform - Infrastructure as Code (IaC)
• Docker - Containerization and deployment
• ZeroTier - Secure network overlay

Integrations:

• OpenAI API - AI-powered report generation
• Google Maps / OpenStreetMap - Route planning and mapping
• TAK Server - Team Awareness Kit for tactical communications

FortiPath/├── .specify/             # Spec-Kit specification framework│   ├── constitution.md   # Project principles and governance│   ├── spec.md          # Technical specifications│   ├── plan.md          # Implementation roadmap│   └── tasks/           # Individual task specifications├── .github/workflows/    # CI/CD automation│   ├── spec-kit.yml     # Spec-Kit validation workflow│   └── ...├── scripts/              # Python scripts for core functionality│   ├── report-writing/   # AI-powered report generation│   ├── route-planning/   # Route and SDR planning│   ├── location-assessment/  # Site surveys and assessments│   ├── comms/            # Communication tools│   ├── collaboration_with_law_enforcement/│   ├── threat_neutralization/│   ├── digital_countermeasures/│   └── ...├── infra/                # Infrastructure code│   ├── terraform/        # Terraform modules and configurations│   └── terraform-provider-fortipath/  # Custom provider├── docs/                 # Documentation├── assets/               # Static assets (images, CSS, JS)└── requirements.txt      # Python dependencies

FortiPath thrives on community collaboration. We welcome contributions from security professionals, developers, and enthusiasts.

• 💻Code Contributions - Submit pull requests for new features or bug fixes
• 📖Documentation - Help improve our guides and documentation
• 🐛Bug Reports - Report issues on ourissue tracker
• 💡Feature Requests - Suggest new features indiscussions
• 🔍Security Reviews - Help identify security vulnerabilities (seeSECURITY.md)

• Wiki - Comprehensive guides and explanations
• Discussions - Community Q&A and collaboration
• Project Boards - Track progress and tasks
• Issues - Bug reports and feature requests

Please review theContributing Guide andCode of Conduct before contributing.

• ✅ Development environment setup
• ✅ Comprehensive planning and documentation
• 🔨 OSINT Web Crawler implementation
• 🔨 Route planning and SDR tools
• 📋 AI-powered report generation

• v0.5.0 (Q1 2026) - Core features operational
• v0.8.0 (Q2 2026) - Infrastructure automation complete
• v1.0.0 (Q2 2026) - Production-ready release

For detailed roadmap information, seeUPGRADE_PLAN.md androadmap.md.

Active Development Areas:

• OSINT crawler Rust implementation
• Route planning algorithms
• AI report generation templates
• Infrastructure automation
• Documentation updates

Planned Features:

• Dietz Scale risk assessment module
• TAK Server integration
• Real-time threat monitoring
• Mobile application companion
• Advanced analytics dashboard

Security is paramount in executive protection. FortiPath follows security best practices:

• 🔐 Secure credential management
• 🛡️ Regular security audits
• 🔄 Dependency vulnerability scanning
• 📝 Responsible disclosure policy

To report security vulnerabilities, please see ourSecurity Policy.

FortiPath is dual-licensed:

• Open Source License - For community and non-commercial use
• Commercial License - For enterprise and commercial applications

For more details, seeLICENSE andCommercial License.

Project Lead:Kylo Parisher

FortiPath is maintained by security professionals with extensive experience in executive protection, cybersecurity, and software development.

• LinkedIn:Kylo Parisher
• GitHub Discussions:Community Forum
• Email: See profile for contact information

FortiPath builds upon the expertise of the executive protection community and leverages open-source technologies. We're grateful to all contributors and the broader security community.

⚠️ Disclaimer: FortiPath is designed as a professional tool for legitimate executive protection operations. Users are responsible for compliance with all applicable laws and regulations.