Documentação ExposureX
Bem-vindo à documentação da ExposureX Platform - uma plataforma de Continuous Threat Exposure Management (CTEM) que executa o ciclo completo em cinco fases: Scoping (superfície de ataque + contexto de negócio), Discovery (assets e exposições), Prioritization (score transparente com EPSS, KEV, reachability e contexto de negócio), Validation (safe checks e reverificação), e Mobilization (campanhas de remediação, SLA, workflows e refinamento de escopo).
Este site é o hub público de documentação do ExposureX. Ele deriva da documentação do repositório e foi rebrandado para o deployment ExposureX.
Começando
Novo no ExposureX? Comece aqui:
| Guia | Descrição |
|---|---|
| Quick Start | Acesse a plataforma e valide os serviços principais. |
| Primeiro Scan | Registre um runner e ingira o primeiro resultado. |
Documentação por Audiência
Para Usuários
| Tópico | Descrição |
|---|---|
| Guia CTEM | Guia feature-by-feature: Scoping, Discovery, Prioritization, Validation e Mobilization. |
| Workflow ponta a ponta | Passo a passo completo de scan. |
| Gestão de scans | Configurar, executar e monitorar discovery runs. |
| Integrações de notificação | Slack, Teams, email, webhook, SIEM e ticketing. |
| Autenticação | Login, seleção de tenant, auth local, SSO e SAML. |
Para Desenvolvedores
| Tópico | Descrição |
|---|---|
| Runner Quick Start | Executar ferramentas e enviar resultados com runners de tenant. |
| API Reference | Endpoints REST de agent e ingestão. |
| Ferramentas customizadas | Criar scanner, parser, collector e integrações CTIS. |
| Schema CTIS | Modelo nativo de ingestão para assets e findings. |
Para Operadores
| Tópico | Descrição |
|---|---|
| Operação em produção | Docker Compose, Caddy, Cloudflare Tunnel e saúde dos serviços. |
| Configuração | Domínios, app URLs, CORS, CSRF, cookies e secrets. |
| Monitoramento | Saúde de containers, disco, backups e alertas. |
| Troubleshooting | Problemas operacionais comuns. |
Para Arquitetos
| Tópico | Descrição |
|---|---|
| Visão geral do sistema | Arquitetura de alto nível. |
| Scan Pipeline Design | Orquestração de scans e execução de workflows. |
| Controle de acesso | RBAC, grupos, permission sets e escopo de dados. |
| Modelo de comandos do agent | Comunicação servidor-agent e lifecycle de comandos. |
Seções da Documentação
Getting Started
Guias rápidos e procedimentos iniciais.
Platform Guides
Guias completos das funcionalidades:
- Autenticação e seleção de tenant
- Multi-tenancy e RBAC
- Scanning e findings
- Configuração de runners
- Integrações e notificações
Architecture
Design do sistema e arquitetura técnica:
- Interação entre componentes
- Fluxos de dados
- Design de segurança
- Padrões de integração
Operations
Deploy e operação:
- Deploy de produção
- Monitoramento e alertas
- Backup e restore
- Rollback
Features
Documentação por funcionalidade:
- Runners
- Scan profiles
- Scanner templates
- Capabilities registry
- Asset modules
Backend
Documentação do serviço de API:
- API reference
- JWT/session
- Agent ingest
- Command lifecycle
Web Console
Aplicação Next.js autenticada:
- Dashboard e command center
- Assets, findings e exposures
- Settings e administração
- Conta e notificações
Documentação de Componentes
| Componente | Documentação |
|---|---|
| Platform (API + web) | Arquitetura e Backend |
| Runner | Documentação de runners |
| SDK / Tools | Guia de desenvolvimento |
| Schemas | Referência CTIS |
Links Externos
| Link | Descrição |
|---|---|
| Platform | Aplicação ExposureX. |
| Website | Site público do produto. |
| EN-US Docs | Documentação em inglês. |
Roadmap
Veja Roadmap para cobertura planejada do ciclo CTEM e hardening de produção.