mirror of
https://github.com/SHOGGOTH-SECTOR/sica-fondt.git
synced 2026-08-01 08:30:20 +00:00
24f816b6a3
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
75 lines
2.6 KiB
Markdown
75 lines
2.6 KiB
Markdown
# API Reference: Implementing SOAR Automation with Phantom
|
|
|
|
## Libraries
|
|
|
|
### requests (HTTP Client for SOAR REST API)
|
|
- **Install**: `pip install requests`
|
|
- Authentication: `ph-auth-token` header with API token
|
|
|
|
## Splunk SOAR REST API
|
|
|
|
### Playbooks
|
|
|
|
| Endpoint | Method | Description |
|
|
|----------|--------|-------------|
|
|
| `/rest/playbook` | GET | List all playbooks |
|
|
| `/rest/playbook/{id}` | GET | Get playbook details |
|
|
| `/rest/playbook_run` | POST | Execute a playbook |
|
|
|
|
### Containers (Events/Incidents)
|
|
|
|
| Endpoint | Method | Description |
|
|
|----------|--------|-------------|
|
|
| `/rest/container` | GET | List containers |
|
|
| `/rest/container` | POST | Create new container |
|
|
| `/rest/container/{id}` | GET | Get container details |
|
|
| `/rest/container/{id}` | POST | Update container |
|
|
|
|
### Artifacts (IOCs)
|
|
|
|
| Endpoint | Method | Description |
|
|
|----------|--------|-------------|
|
|
| `/rest/artifact` | POST | Add artifact to container |
|
|
| `/rest/artifact/{id}` | GET | Get artifact details |
|
|
| CEF fields: `sourceAddress`, `destinationAddress`, `fileHash`, `fileName` |
|
|
|
|
### Actions
|
|
|
|
| Endpoint | Method | Description |
|
|
|----------|--------|-------------|
|
|
| `/rest/action_run` | POST | Run an action on an asset |
|
|
| `/rest/action_run/{id}` | GET | Get action results |
|
|
| `/rest/app` | GET | List installed apps |
|
|
| `/rest/asset` | GET | List configured assets |
|
|
|
|
### System
|
|
|
|
| Endpoint | Method | Description |
|
|
|----------|--------|-------------|
|
|
| `/rest/system_info` | GET | System version and status |
|
|
| `/rest/ph_user` | GET | List SOAR users |
|
|
|
|
## Common App Actions
|
|
|
|
| App | Action | Description |
|
|
|-----|--------|-------------|
|
|
| VirusTotal | `file_reputation` | Check hash reputation |
|
|
| VirusTotal | `url_reputation` | Check URL safety |
|
|
| CrowdStrike | `contain_device` | Network isolate host |
|
|
| ActiveDirectory | `disable_user` | Disable AD account |
|
|
| ServiceNow | `create_ticket` | Create incident ticket |
|
|
| Exchange | `quarantine_email` | Remove phishing email |
|
|
| Splunk | `run_query` | Execute SPL search |
|
|
|
|
## Playbook Types
|
|
- **Automation**: Fully automated, no analyst input
|
|
- **Investigation**: Enrichment with analyst decision gates
|
|
- **Response**: Containment actions with approval prompts
|
|
- **Reporting**: Data collection and notification
|
|
|
|
## External References
|
|
- SOAR REST API: https://docs.splunk.com/Documentation/SOAR/current/PlatformAPI/
|
|
- Playbook Guide: https://docs.splunk.com/Documentation/SOAR/current/DevelopPlaybooks/
|
|
- App Development: https://docs.splunk.com/Documentation/SOAR/current/DevelopApps/
|
|
- Splunkbase Apps: https://splunkbase.splunk.com/apps/#/product/soar
|