Getting Started
Learn how to explore LOLAPI and use it in your security work
Installation & Setup
Requirements: Python 3.8+, Git
1. Clone the Repository
cd LOLAPI
2. Validate Entries
All API entries are stored in YAML format and validated against a JSON schema.
3. Search & Analyze
Use the compare tool to generate reports and analyze APIs by category or risk.
python3 bin/compare.py --risk-heatmap
# Analyze by category
python3 bin/compare.py --by-category
# Find critical APIs
python3 bin/compare.py --all | grep -i "critical"
Understanding YAML Entries
Each API is documented in a structured YAML file. Here's what you'll find:
Key Concepts
Risk Scoring
Risk scores are calculated as:
Higher scores indicate higher threat. Use this to prioritize detection and mitigation efforts.
MITRE ATT&CK Mapping
All abuse scenarios are mapped to MITRE ATT&CK tactics and techniques. Use these mappings to integrate LOLAPI into your threat modeling and detection frameworks.
Abuse Scenarios
Real-world code examples showing how each API can be weaponized. These include detection difficulty assessments and notes on prevalence in actual attacks.
Detection Strategies
Practical strategies for detecting abuse, including behavioral signals, forensic indicators, and log-based detections specific to each API and platform.
Use Cases
Threat Hunting
Use LOLAPI abuse scenarios and detection strategies to hunt for attacks in your environment.
Detection Engineering
Build detections based on documented abuse scenarios and behavioral signals.
Security Awareness
Educate teams about weaponized APIs and the attack techniques they enable.
Red Teaming
Reference real abuse scenarios and understand detection evasion techniques.
Risk Assessment
Use risk scores to prioritize which APIs and techniques to focus detection/mitigation efforts on.
Next Steps
- Explore the API Browser to find relevant APIs for your platform
- Review detailed documentation for specific APIs
- Check out the detection rules (Sigma, Splunk, YARA)
- Join the community to discuss and contribute
- Read the detection and mitigation guides
Tip: Keep LOLAPI updated as new APIs are discovered and documented. Subscribe to GitHub releases for updates.