github-ioc-scanner 1.0.6

Scan GitHub repositories for Indicators of Compromise (IOCs) in package dependencies across multiple languages

GitHub IOC Scanner

A powerful command-line tool for scanning GitHub repositories to detect Indicators of Compromise (IOCs) in package dependencies across multiple programming languages and package managers.

🚀 Features

• Multi-Language Support: JavaScript/Node.js, Python, Ruby, PHP, Go, Rust
• Flexible Scanning: Organization-wide, team-specific, or individual repository scanning
• High Performance: Parallel processing with intelligent batching and caching
• Real-time Progress: Live progress tracking with ETA calculations
• Supply Chain Security: Detect compromised packages and typosquatting attacks
• Comprehensive IOCs: Pre-loaded with 900+ known malicious packages including recent attacks

📦 Supported Package Managers

Language	Package Managers	Files Scanned
JavaScript/Node.js	npm, yarn, pnpm, bun	package.json, package-lock.json, yarn.lock, pnpm-lock.yaml, bun.lockb
Python	pip, pipenv, poetry	requirements.txt, Pipfile.lock, poetry.lock, pyproject.toml
Ruby	bundler	Gemfile.lock
PHP	composer	composer.lock
Go	go modules	go.mod, go.sum
Rust	cargo	Cargo.lock

🛠️ Installation

From PyPI (Recommended)

pip install github-ioc-scanner

From Source

git clone https://github.com/your-org/github-ioc-scanner.git
cd github-ioc-scanner
pip install -e .

Development Installation

git clone https://github.com/your-org/github-ioc-scanner.git
cd github-ioc-scanner
pip install -e ".[dev]"

⚡ Quick Start

1. Set up GitHub Token

export GITHUB_TOKEN="your_github_token_here"

2. Basic Usage

# Scan all repositories in an organization
github-ioc-scan --org your-org

# Scan a specific repository
github-ioc-scan --org your-org --repo your-repo

# Fast scan (root-level files only)
github-ioc-scan --org your-org --fast

📋 Usage Examples

Organization Scanning

Scan all repositories in an organization:

github-ioc-scan --org your-org

Team-based Scanning

Scan repositories belonging to a specific team:

github-ioc-scan --org your-org --team security-team

Repository-specific Scanning

Scan a specific repository:

github-ioc-scan --org your-org --repo your-repo

Fast Mode

For quick assessments, use fast mode to scan only root-level files:

github-ioc-scan --org your-org --fast

Include Archived Repositories

By default, archived repositories are skipped. Include them with:

github-ioc-scan --org your-org --include-archived

Batch Processing

For large organizations, use batch processing for optimal performance:

# Aggressive batching strategy
github-ioc-scan --org your-org --batch-strategy aggressive

# Custom concurrency limits
github-ioc-scan --org your-org --max-concurrent 10

# Enable cross-repository batching
github-ioc-scan --org your-org --enable-cross-repo-batching

Verbose Output

Get detailed information during scanning:

github-ioc-scan --org your-org --verbose

🔍 Current IOC Coverage

The scanner includes comprehensive IOC definitions for:

Recent Supply Chain Attacks

• S1ngularity/NX Attack (September 2024): 150+ compromised packages with worm payload
• CrowdStrike Typosquatting Campaign: 400+ malicious packages impersonating CrowdStrike
• Historical Attacks: Various documented supply chain compromises

Attack Types Detected

• Typosquatting: Packages with names similar to popular libraries
• Dependency Confusion: Malicious packages targeting internal dependencies
• Compromised Packages: Legitimate packages that were later compromised
• Backdoored Libraries: Libraries with hidden malicious functionality

Total Coverage

• 900+ IOC Definitions: Comprehensive coverage of known malicious packages
• Regular Updates: IOC definitions are continuously updated with new threats
• Multi-language: Coverage across all supported package managers

📊 Output Formats

Standard Output

🔍 Scanning organization: your-org
📁 Found 45 repositories to scan
[████████████████████████████████] 100% | 45/45 repositories | ETA: 0s

⚠️  THREATS DETECTED:

Repository: your-org/frontend-app
├── package.json
│   └── 🚨 CRITICAL: malicious-package@1.0.0
│       └── IOC Source: s1ngularity_nx_attack_2024.py
│       └── Description: Compromised package from S1ngularity NX attack

📈 Scan Summary:
├── Repositories scanned: 45
├── Files analyzed: 127
├── Threats found: 1
└── Scan duration: 23.4s

JSON Output

github-ioc-scan --org your-org --output json

⚙️ Configuration

Environment Variables

Variable	Description	Default
GITHUB_TOKEN	GitHub personal access token	Required
GITHUB_IOC_CACHE_DIR	Cache directory location	~/.cache/github-ioc-scanner
GITHUB_IOC_LOG_LEVEL	Logging level	INFO

Configuration File

Create a config.yaml file:

github:
  token: "your_token_here"
  
scanning:
  fast_mode: false
  include_archived: false
  max_concurrent: 5
  
batch:
  strategy: "adaptive"
  enable_cross_repo_batching: true
  
cache:
  enabled: true
  ttl_hours: 24

🚀 Performance Features

Intelligent Caching

• File-level caching: Avoid re-scanning unchanged files
• ETag support: Efficient GitHub API usage
• Smart invalidation: Automatic cache updates

Parallel Processing

• Concurrent requests: Multiple repositories processed simultaneously
• Batch optimization: Intelligent request batching
• Rate limit management: Automatic rate limit handling

Progress Tracking

• Real-time updates: Live progress bars with ETA
• Detailed metrics: Success rates, processing speeds
• Performance monitoring: Automatic performance optimization

🛡️ Security Features

Supply Chain Protection

• Comprehensive IOC database: 900+ known malicious packages
• Typosquatting detection: Advanced pattern matching
• Dependency analysis: Deep dependency tree scanning

Privacy & Security

• Local processing: All analysis done locally
• Secure API usage: Proper token handling
• No data collection: No telemetry or data sharing

📚 Documentation

Comprehensive documentation is available in the docs/ directory:

• Batch Processing Guide - Advanced batch processing features
• Performance Optimization - Performance tuning and optimization
• Package Manager Support - Detailed package manager information
• IOC Definitions - Current IOC coverage and sources
• API Reference - Complete API documentation

🧪 Testing

Run the test suite:

# Run all tests
pytest

# Run with coverage
pytest --cov=src/github_ioc_scanner

# Run specific test categories
pytest tests/test_parsers.py  # Parser tests
pytest tests/test_batch_*.py  # Batch processing tests

🤝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

Development Setup

1. Fork the repository
2. Create a virtual environment: python -m venv venv
3. Activate it: source venv/bin/activate (Linux/Mac) or venv\Scripts\activate (Windows)
4. Install development dependencies: pip install -e ".[dev]"
5. Run tests: pytest

Adding New IOCs

To add new IOC definitions:

1. Create or update files in the issues/ directory
2. Follow the existing format: IOC_PACKAGES = {"package-name": ["version1", "version2"]}
3. Add documentation about the source and nature of the IOCs
4. Submit a pull request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🔗 Links

• GitHub Repository
• PyPI Package
• Documentation
• Issue Tracker

⚠️ Disclaimer

This tool is provided for security research and defensive purposes only. The IOC definitions are based on publicly available threat intelligence and research. Always verify findings independently and follow responsible disclosure practices.

🙏 Acknowledgments

• Security researchers and organizations who share threat intelligence
• The open-source community for package manager tools and libraries
• GitHub for providing comprehensive APIs for repository analysis

---

Made with ❤️ for the security community