mirror of
https://github.com/mukul975/Anthropic-Cybersecurity-Skills.git
synced 2026-06-15 23:44:56 +03:00
mukul975
c21af3347e
- Add scripts/agent.py and references/api-reference.md to all remaining skills - Update all 648 LICENSE files: copyright now reads 'Mahipal' - Add implementing-security-monitoring-with-datadog (new skill with full anatomy) - All 649 skills now have: SKILL.md, LICENSE, scripts/agent.py, references/api-reference.md
47 lines
1.6 KiB
Markdown
47 lines
1.6 KiB
Markdown
# API Reference — Performing Phishing Simulation with GoPhish
|
|
|
|
## Libraries Used
|
|
- **requests**: HTTP client for GoPhish REST API
|
|
|
|
## CLI Interface
|
|
```
|
|
python agent.py --url https://gophish.local:3333 --api-key <key> campaigns
|
|
python agent.py --url <url> --api-key <key> metrics --id 1
|
|
python agent.py --url <url> --api-key <key> resources
|
|
python agent.py --url <url> --api-key <key> report --id 1
|
|
python agent.py --url <url> --api-key <key> launch --name "Q1 Test" --template-id 1 --page-id 1 --smtp-id 1 --group-ids 1 2 --phish-url https://phish.local
|
|
```
|
|
|
|
## GoPhishClient API Endpoints
|
|
|
|
### `GET /api/campaigns/` — List all campaigns
|
|
### `GET /api/campaigns/{id}` — Campaign details with results
|
|
### `POST /api/campaigns/` — Create and launch campaign
|
|
### `GET /api/groups/` — List target groups
|
|
### `GET /api/templates/` — List email templates
|
|
### `GET /api/smtp/` — List sending profiles
|
|
|
|
## Core Functions
|
|
|
|
### `get_campaign_metrics(...)` — Campaign performance analysis
|
|
Tracks: sent, opened, clicked, submitted, reported. Calculates percentage rates.
|
|
|
|
### `generate_report(...)` — Risk assessment with recommendations
|
|
Risk levels: CRITICAL (>10% credential submission), HIGH (>20% click rate), MEDIUM.
|
|
|
|
### `list_resources(...)` — Enumerate available GoPhish configurations
|
|
|
|
## Campaign Status Tracking
|
|
| Status | Description |
|
|
|--------|-------------|
|
|
| Email Sent | Email delivered to target |
|
|
| Email Opened | Tracking pixel loaded |
|
|
| Clicked Link | Target clicked phishing URL |
|
|
| Submitted Data | Target entered credentials |
|
|
| Reported | Target reported phishing email |
|
|
|
|
## Dependencies
|
|
```
|
|
pip install requests
|
|
```
|