docs(15-03): complete log aggregator sources plan
- Elasticsearch, Grafana, Sentry, Kibana, Splunk sources implemented - 5 sources + 5 test files, all passing - Requirements RECON-LOG-01, RECON-LOG-02, RECON-LOG-03 complete
This commit is contained in:
@@ -0,0 +1,123 @@
|
||||
---
|
||||
phase: 15-osint_forums_collaboration_log_aggregators
|
||||
plan: 03
|
||||
subsystem: recon
|
||||
tags: [elasticsearch, grafana, sentry, kibana, splunk, log-aggregator, osint]
|
||||
|
||||
# Dependency graph
|
||||
requires:
|
||||
- phase: 10-osint-code-hosting
|
||||
provides: ReconSource interface, Client HTTP wrapper, ciLogKeyPattern, BuildQueries
|
||||
provides:
|
||||
- ElasticsearchSource scanning exposed ES instances for API keys
|
||||
- GrafanaSource scanning exposed Grafana dashboards for API keys
|
||||
- SentrySource scanning exposed Sentry error reports for API keys
|
||||
- KibanaSource scanning exposed Kibana saved objects for API keys
|
||||
- SplunkSource scanning exposed Splunk search exports for API keys
|
||||
affects: [recon-engine, register-all]
|
||||
|
||||
# Tech tracking
|
||||
tech-stack:
|
||||
added: []
|
||||
patterns: [log-aggregator-source-pattern, newline-delimited-json-parsing]
|
||||
|
||||
key-files:
|
||||
created:
|
||||
- pkg/recon/sources/elasticsearch.go
|
||||
- pkg/recon/sources/elasticsearch_test.go
|
||||
- pkg/recon/sources/grafana.go
|
||||
- pkg/recon/sources/grafana_test.go
|
||||
- pkg/recon/sources/sentry.go
|
||||
- pkg/recon/sources/sentry_test.go
|
||||
- pkg/recon/sources/kibana.go
|
||||
- pkg/recon/sources/kibana_test.go
|
||||
- pkg/recon/sources/splunk.go
|
||||
- pkg/recon/sources/splunk_test.go
|
||||
modified:
|
||||
- pkg/recon/sources/register.go
|
||||
|
||||
key-decisions:
|
||||
- "All five sources are credentialless (target exposed/misconfigured instances)"
|
||||
- "Splunk uses newline-delimited JSON parsing for search export format"
|
||||
- "Kibana uses kbn-xsrf header for saved objects API access"
|
||||
|
||||
patterns-established:
|
||||
- "Log aggregator source pattern: target exposed instances via base URL override, search API, parse response, apply ciLogKeyPattern"
|
||||
|
||||
requirements-completed: [RECON-LOG-01, RECON-LOG-02, RECON-LOG-03]
|
||||
|
||||
# Metrics
|
||||
duration: 4min
|
||||
completed: 2026-04-06
|
||||
---
|
||||
|
||||
# Phase 15 Plan 03: Log Aggregator Sources Summary
|
||||
|
||||
**Five log aggregator ReconSource implementations (Elasticsearch, Grafana, Sentry, Kibana, Splunk) targeting exposed instances for API key detection in logs, dashboards, and error reports**
|
||||
|
||||
## Performance
|
||||
|
||||
- **Duration:** 4 min
|
||||
- **Started:** 2026-04-06T13:27:23Z
|
||||
- **Completed:** 2026-04-06T13:31:30Z
|
||||
- **Tasks:** 2
|
||||
- **Files modified:** 11
|
||||
|
||||
## Accomplishments
|
||||
- Elasticsearch source searches exposed ES instances via POST _search API with query_string
|
||||
- Kibana source searches saved objects (dashboards, visualizations) via Kibana API with kbn-xsrf header
|
||||
- Splunk source searches exposed Splunk REST API with newline-delimited JSON response parsing
|
||||
- Grafana source searches dashboards via /api/search then fetches detail via /api/dashboards/uid
|
||||
- Sentry source searches issues then fetches events for key detection in error reports
|
||||
- All 5 sources registered in RegisterAll (67 total sources)
|
||||
|
||||
## Task Commits
|
||||
|
||||
Each task was committed atomically:
|
||||
|
||||
1. **Task 1: Elasticsearch, Kibana, Splunk sources** - `bc63ca1` (feat)
|
||||
2. **Task 2: Grafana and Sentry sources** - `d02cdcc` (feat)
|
||||
|
||||
## Files Created/Modified
|
||||
- `pkg/recon/sources/elasticsearch.go` - ElasticsearchSource: POST _search, parse hits._source, ciLogKeyPattern
|
||||
- `pkg/recon/sources/elasticsearch_test.go` - httptest mock for ES _search API
|
||||
- `pkg/recon/sources/kibana.go` - KibanaSource: GET saved_objects/_find with kbn-xsrf header
|
||||
- `pkg/recon/sources/kibana_test.go` - httptest mock for Kibana saved objects API
|
||||
- `pkg/recon/sources/splunk.go` - SplunkSource: GET search/jobs/export, NDJSON parsing
|
||||
- `pkg/recon/sources/splunk_test.go` - httptest mock for Splunk search export
|
||||
- `pkg/recon/sources/grafana.go` - GrafanaSource: dashboard search + detail fetch
|
||||
- `pkg/recon/sources/grafana_test.go` - httptest mock for Grafana search + dashboard APIs
|
||||
- `pkg/recon/sources/sentry.go` - SentrySource: issues search + events fetch
|
||||
- `pkg/recon/sources/sentry_test.go` - httptest mock for Sentry issues + events APIs
|
||||
- `pkg/recon/sources/register.go` - Added 5 log aggregator source registrations
|
||||
|
||||
## Decisions Made
|
||||
- All five sources are credentialless -- they target exposed/misconfigured instances rather than authenticated APIs
|
||||
- Splunk uses newline-delimited JSON parsing since the search export endpoint returns one JSON object per line
|
||||
- Kibana requires kbn-xsrf header for CSRF protection bypass on saved objects API
|
||||
- Response body reads limited to 512KB per response (ES, Kibana, Splunk responses can be large)
|
||||
|
||||
## Deviations from Plan
|
||||
|
||||
None - plan executed exactly as written.
|
||||
|
||||
## Issues Encountered
|
||||
- Initial Kibana test had API key embedded in a nested JSON-escaped string that didn't match ciLogKeyPattern; fixed test data to use plain attribute value
|
||||
- Initial Sentry test had invalid JSON in entries field and incorrect event data format; fixed to use proper JSON structure matching ciLogKeyPattern
|
||||
|
||||
## User Setup Required
|
||||
|
||||
None - no external service configuration required.
|
||||
|
||||
## Known Stubs
|
||||
|
||||
None - all sources are fully implemented with real API interaction logic.
|
||||
|
||||
## Next Phase Readiness
|
||||
- All 5 log aggregator sources complete and tested
|
||||
- RegisterAll updated with all Phase 15 sources
|
||||
- Ready for Phase 15 verification
|
||||
|
||||
---
|
||||
*Phase: 15-osint_forums_collaboration_log_aggregators*
|
||||
*Completed: 2026-04-06*
|
||||
Reference in New Issue
Block a user