How cydefops/project-killchain works
Project type and purpose
• This is an open-source, content-centric “knowledge base” and IOC (Indicators of Compromise) repository rather than a classic client-server application.
• Its primary roles are:
• Aggregating Red-Team/Blue-Team tools and techniques, IOCs, research papers, scripts, reporting templates, threat-hunting procedures, and community contributions.
• Serving as a documentation/learning portal via static files (Markdown, docs, scripts) stored in Git.
• Allowing community contributions through standard Git/GitHub workflows.
File structure
• Top-level directories correspond to major content modules:
• IOCs/ – IPs, domains, hashes, split by malware type (stealers, loaders, network indicators, phishing)
• Scripts/ – categorized by Azure, Investigations, Offensive, Phishing, Web-Security, Windows, Reverse-Engineering
• Research/ – papers, PyPi package analyses
• General Resources/ – analyst tools, SIEM guidance, reporting formats
• Community Contributions/ – articles, labs
• Reporting Formats/, Threat Hunts/, Wallpapers/
• Root README.md serves as the landing page, outlines features and navigation.
• There are no runtime “services” in the repo itself—just static assets. Likely a static-site build (e.g., Jekyll, Docusaurus) or rendered directly by GitHub.
README for additional insights
• Emphasizes community contributions, continuous updates of IOCs, knowledge-sharing mission.
• No custom server code or database—everything is file-based.
• Mentions “Open Source,” “GitHub,” and website hosting.
a. Main components
• GitHub Repo (Content Store)
• CI/CD Pipeline (GitHub Actions or equivalent)
• Static Site Generator (Jekyll, Docusaurus, Hugo, etc.)
• Web Host / CDN (GitHub Pages, Cloudflare, S3+CloudFront)
• Search Index (e.g., Algolia, Lunr)
• Consumers: End-users (security practitioners), Contributors
• External Services: PyPI (for research metadata), Azure/AWS (if scripts integrate), Issue Tracker (GitHub Issues)
b. Relationships & data flows
1. Developer/Contributor clones repo → edits Markdown/scripts → submits Pull Request
2. CI/CD triggers on PR → lints/validates build → merges → triggers build pipeline
3. Static Site Generator builds HTML/CSS/JS from Markdown and assets
4. Artifacts deployed to Web Host/CDN
5. End-User Browser requests content → CDN serves cached pages
6. Search Index crawler or build step indexes new content for on-site search
7. User feedback & issues flow back into GitHub Issues/Discussions
c. Architectural patterns & principles
• Content-as-Code: treat documentation and IOCs as versioned source
• Modular directory design: clearly separate categories for maintainability
• Pull-Request-Driven Development: community contributions gated by review
• Immutable deployments: every merge yields a new, versioned site build
d. Key technologies & frameworks
• Version Control: Git + GitHub
• CI/CD: GitHub Actions, YAML pipelines
• Static Site Generator: (e.g.) Jekyll, Docusaurus, Hugo
• Hosting/CDN: GitHub Pages or S3 + CloudFront / Cloudflare Pages
• Search: Algolia DocSearch / Lunr.js
• File formats: Markdown (.md), CSV/JSON for IOCs, PowerShell/.py scripts
Detail orientation
• Break the site into logical modules (IOCs, Scripts, Research, Resources, Contributions).
• Module as a sub-component within the static-site generator or content tree layer.
• Call out the pull-request review step and rubric enforcement if desired.
• Versioning: each merge tags a new site version.