Skip to content

SSZcreate/Pentab_server / .agents/skills/cybersecurity/skills/executing-phishing-simulation-campaign

executing-phishing-simulation-campaign

Verified

Executes authorized phishing simulation campaigns to assess an organization's susceptibility to email-based social engineering attacks. The tester designs realistic phishing scenarios, builds credential harvesting infrastructure, sends targeted phishing emails, and tracks open rates, click-through rates, and credential submission rates to measure human security awareness. Activates for requests involving phishing simulation, social engineering assessment, email security testing, or security awareness measurement.

FileKindSize
LICENSEother11.0 KB
SKILL.mdskill md12.5 KB
references/api-reference.mdmarkdown2.0 KB
scripts/agent.pyscript6.8 KB

references/api-reference.md

View on GitHub
# API Reference: Phishing Simulation Campaign Agent

## Dependencies

| Library | Version | Purpose |
|---------|---------|---------|
| requests | >=2.28 | HTTP client for GoPhish REST API |

## CLI Usage

```bash
# List campaigns
python scripts/agent.py --gophish-url https://gophish.lab:3333 --api-key KEY --action list

# Get campaign results
python scripts/agent.py --gophish-url https://gophish.lab:3333 --api-key KEY \
  --action results --campaign-id 1 --output report.json
```

## GoPhishClient Class

### `__init__(base_url, api_key, verify_ssl=False)`
Initializes the session with Bearer token auth for the GoPhish API.

### `create_sending_profile(name, smtp_from, host, username, password) -> dict`
Creates an SMTP sending profile. GoPhish API: `POST /api/smtp/`.

### `create_email_template(name, subject, html_body, text_body) -> dict`
Creates a phishing email template with credential capture enabled. API: `POST /api/templates/`.

### `create_landing_page(name, html, capture_creds, redirect_url) -> dict`
Creates a credential harvesting page. API: `POST /api/pages/`.

### `import_targets(group_name, targets) -> dict`
Imports a target list as a GoPhish group. Each target: `{email, first_name, last_name, position}`.

### `launch_campaign(name, template_id, page_id, smtp_id, group_ids, url) -> dict`
Launches a phishing campaign. API: `POST /api/campaigns/`.

### `get_campaign_results(campaign_id) -> dict`
Fetches campaign timeline and per-target results. API: `GET /api/campaigns/{id}/results`.

## `compute_metrics(results) -> dict`
Calculates click rate, submission rate, and report rate from campaign timeline events.

## GoPhish API Endpoints

| Endpoint | Method | Purpose |
|----------|--------|---------|
| `/api/campaigns/` | GET/POST | List or create campaigns |
| `/api/campaigns/{id}/results` | GET | Campaign results with timeline |
| `/api/templates/` | POST | Create email templates |
| `/api/pages/` | POST | Create landing pages |
| `/api/smtp/` | POST | Create SMTP profiles |
| `/api/groups/` | POST | Create target groups |
rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit.Stars: 465kUpdated Claude CodeCodexVerifiedInstall
rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure.Stars: 465kUpdated Claude CodeCodexVerifiedInstall
rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics.Stars: 465kUpdated Claude CodeCodexVerifiedInstall
ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first.Stars: 192kUpdated Claude CodeCodexVerifiedInstall