saint-graves/sica-fondt
1
0
Fork 0
mirror of https://github.com/SHOGGOTH-SECTOR/sica-fondt.git synced 2026-08-01 16:40:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
sica-fondt/knowledge/cyber-skills/skills/executing-phishing-simulation-campaign/references/api-reference.md
Claude 24f816b6a3
Consolidate 22 sibling repos into layered organism structure 
Place useful parts of the surrounding repos into sica-fondt by layer, per the
body model (Ada = membrane; brain/endocrine/capabilities/knowledge non-Ada):

- brain/        LLM reasoning + providers (dapr, hermes, MoMoA)
- capabilities/ REPRAG sidecars: hermes tools/skills, dapr tools, parallel
                dispatch, A51 channels, and the OSINT cluster
- knowledge/    LORAG corpus: 754 cyber-skills, agency personas, secure-coding,
                MITRE ATT&CK data
- reference/    defensive threat-reference (C3, shhbruh doc) + AdaYaml parser

License handling: AGPL sources (worldosint, advanced_evolution, mercury,
Reticulum) and GPL DeTTECT are SPEC-only clean-room/port descriptions — no
copyleft code copied. MIT/Apache/data parts copied as working trees.

Safety: shhbruh escape/persistence material and C3 covert-C2 kept as reference
only, not wired into the running organism. See CONSOLIDATION.md.

https://claude.ai/code/session_01UehUqEXXJJCsHoA4voCU5c
2026-06-10 06:53:01 +00:00

2.0 KiB
Raw Blame History

API Reference: Phishing Simulation Campaign Agent

Dependencies

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

CLI Usage

# 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