BLACKSHIELD

Documentação pública

Guias para onboarding, confiança e operações do dia 2.

Use estes guias para lançar rapidamente, concluir revisões de segurança, operar com fiabilidade e resolver problemas comuns de forma autónoma.

Start here

Go from workspace creation to first findings in one guided path with clear next steps and ownership checks.

Recomendado

15-20 minutos

Configure o seu workspace

Crie seu espaço de trabalho, primeiro administrador e chaves de integração para que sua equipe possa começar a ingerir descobertas com segurança.

Open guided path

Security review

Answer buyer, legal, and security-review questions with trust-center, shared-responsibility, and evidence guides.

12-18 minutos

Trust Center: visão geral da postura de segurança

O BlackShield deve ganhar confiança com controlos concretos no produto: acesso autenticado ao workspace, ações sensíveis com rate limit, triagem em `/findings` e `/alerts`, e evidência exportável de `/reports`, `/audit` e `/compliance`.

Open trust guide

Precisa de ajuda rápida?

Comece aqui para resolver os bloqueios mais comuns de onboarding e ingestão.

Abrir troubleshooting

Revisão de segurança?

Use o trust center e o pacote de questionários para responder a pedidos de due diligence legal e de segurança.

Abrir pacote do trust center

Escalação

Para incidentes urgentes em produção, inclua detalhes do workspace, IDs dos jobs e carimbos de data/hora no pedido de suporte.

Contactar suporte

Quick starts para developers

Copie o caminho de deploy mais rápido para o seu ambiente.

Comece com um snippet funcional, copie o comando ou ficheiro e abra o guia completo apenas se precisar de mais detalhe.

Ver todos os guias de deploy

Caminho rápido

Copy a working starter, run it in your environment, then come back here for the deeper rollout details.

GitHub Actions

GitHub Actions workflow

Drop one workflow into the repository and run Trivy, Semgrep, TruffleHog, and Syft in parallel.

.github/workflows/security-scan.yml
bash
BLACKSHIELD_PIPELINE_IMAGE=public.ecr.aws/blackshield-security/pipeline-scanner:1.0.0 \
bash <(curl -fsSL https://blackshield.chaplau.com/source-bundles/github-security-scan.sh)

GitLab CI

GitLab CI pipeline

Add one security stage that scans merge requests, default-branch builds, and scheduled pipelines.

.gitlab-ci.yml
bash
BLACKSHIELD_PIPELINE_IMAGE=public.ecr.aws/blackshield-security/pipeline-scanner:1.0.0 \
BLACKSHIELD_API_URL=https://api.blackshield.chaplau.com \
bash <(curl -fsSL https://blackshield.chaplau.com/source-bundles/gitlab-ci.sh)

GitHub Deploy Gate

GitHub Actions deploy gate

Drop in one workflow that evaluates the hosted Rego decision API before production deploys and prints the reasons inline.

.github/workflows/deploy-guardrails.yml
bash
BLACKSHIELD_POLICY_IMAGE=public.ecr.aws/blackshield-security/policy-client:1.0.0 \
bash <(curl -fsSL https://blackshield.chaplau.com/source-bundles/github-policy-guardrails.sh)

GitLab Deploy Gate

GitLab deploy gate job

Add one reusable deploy job that checks allow, warn, or deny outcomes against your tenant policy pack before release.

.gitlab/deploy-guardrails.yml
bash
BLACKSHIELD_POLICY_IMAGE=public.ecr.aws/blackshield-security/policy-client:1.0.0 \
BLACKSHIELD_API_URL=https://api.blackshield.chaplau.com \
bash <(curl -fsSL https://blackshield.chaplau.com/source-bundles/gitlab-policy-guardrails.sh)

AWS Lambda

AWS cloud scanner source

Bootstrap the AWS CDK project locally, then deploy the tenant-owned cloud posture scanner without rewriting the commands.

deploy/aws-cloud-scanner/
bash
bash <(curl -fsSL https://blackshield.chaplau.com/source-bundles/aws-cloud-scanner.sh)
cd deploy/aws-cloud-scanner

GCP Cloud Run

GCP cloud scanner source

Bootstrap the Terraform module locally, then deploy the cloud scanner to your target projects and regions with the same commands shown in the guide.

deploy/gcp-cloud-scanner/
bash
BLACKSHIELD_CLOUD_IMAGE=public.ecr.aws/blackshield-security/cloud-scanner:1.0.0 \
BLACKSHIELD_SITE_URL=https://blackshield.chaplau.com \
BLACKSHIELD_API_URL=https://api.blackshield.chaplau.com \
bash <(curl -fsSL https://blackshield.chaplau.com/source-bundles/gcp-cloud-scanner.sh)
cd deploy/gcp-cloud-scanner

Kubernetes

Helm chart source

Pull the Helm chart source locally, review the templates, and install the cluster scanner from your own repository.

deploy/helm/blackshield-k8s-scanner/
bash
BLACKSHIELD_SITE_URL=https://blackshield.chaplau.com \
BLACKSHIELD_API_URL=https://api.blackshield.chaplau.com \
bash <(curl -fsSL https://blackshield.chaplau.com/source-bundles/k8s-scanner-helm.sh)
cd deploy/helm/blackshield-k8s-scanner

SaaS on AWS

AWS SaaS scanner source

Bootstrap the AWS CDK project locally, then deploy the tenant-owned Lambda scanner without rewriting the commands.

deploy/aws-saas-scanner/
bash
bash <(curl -fsSL https://blackshield.chaplau.com/source-bundles/aws-saas-scanner.sh)
cd deploy/aws-saas-scanner

SaaS on GCP

GCP SaaS scanner source

Bootstrap the Terraform module locally, then deploy the Cloud Run Job scanner with the same commands shown in the guide.

deploy/gcp-saas-scanner/
bash
BLACKSHIELD_SAAS_IMAGE=public.ecr.aws/blackshield-security/saas-scanner:1.0.0 \
BLACKSHIELD_SITE_URL=https://blackshield.chaplau.com \
BLACKSHIELD_API_URL=https://api.blackshield.chaplau.com \
bash <(curl -fsSL https://blackshield.chaplau.com/source-bundles/gcp-saas-scanner.sh)
cd deploy/gcp-saas-scanner

Agent Runtime

Security agent Docker Compose bundle

Download the Compose bootstrap, point it at your tenant, and start governed blue-team automation with approval gates around every mutation.

deploy/security-agent/
bash
BLACKSHIELD_SECURITY_AGENT_IMAGE=public.ecr.aws/blackshield-security/security-agent:1.0.0 \
BLACKSHIELD_SITE_URL=https://blackshield.chaplau.com \
BLACKSHIELD_API_URL=https://api.blackshield.chaplau.com \
bash <(curl -fsSL https://blackshield.chaplau.com/source-bundles/security-agent-docker.sh)
cd deploy/security-agent

Entender e personalizar

Use the guided steps below when you want to tailor the rollout, validate ownership, or expand the deployment safely.

Coleções de guias

Browse the full catalog once you know whether you are onboarding, deploying, reviewing trust posture, or solving an operational issue.

Confiança e governança

Copy-paste-ready deployment guides for every scanner type plus the governed security agent runtime — CI/CD pipelines, cloud posture, Kubernetes, SaaS OAuth, host intrusion detection, and network telemetry.

Confiabilidade e suporte

Buyer-facing proof of how BlackShield handles access control, evidence, data rights, control coverage, and offboarding in the actual product.

Reliability and Support

Understand availability commitments, incident flow, continuity planning, troubleshooting, and network sensor operations.

15-20 minutos

Configure o seu workspace

Crie seu espaço de trabalho, primeiro administrador e chaves de integração para que sua equipe possa começar a ingerir descobertas com segurança.

Público: Proprietários de workspaces e primeiros administradores de locatários

Ler guia

30-45 minutos

Depois do login: próximos passos do primeiro dia

Use esta lista de verificação do primeiro dia para passar de um espaço de trabalho vazio para descobertas validadas e limpar a propriedade.

Público: Novos administradores de locatários e líderes de segurança

Ler guia

10-15 minutos

Ingerir os seus primeiros achados

Execute sua primeira verificação, envie as descobertas e confirme a qualidade dos dados antes de expandir para mais integrações.

Público: Engenheiros de segurança, proprietários de CI e engenheiros de integração

Ler guia

Revisão contínua e diária recomendada

Rever e priorizar achados

Priorize a correção usando risco, capacidade de exploração e propriedade para que as equipes resolvam o que é importante primeiro.

Público: Equipes de triagem de segurança, líderes de engenharia e proprietários de serviços

Ler guia

Primeiros 30 dias

O que fazer após os primeiros achados

Converta as descobertas iniciais em um programa de segurança repetível com métricas, propriedade e relatórios claros.

Público: Proprietários de programas de segurança e gerentes de engenharia

Ler guia

2 minutes

Deploy the Pipeline Scanner

Embed Trivy, Semgrep, TruffleHog, and Syft into every commit with a single workflow file. Works with GitHub Actions, GitLab CI, and Bitbucket Pipelines.

Público: DevOps engineers, platform engineers, and security engineers

Ler guia

3 minutes

Gate Deploys with Hosted Rego Guardrails

Add a lightweight CI step that sends deploy context to your tenant and gets an allow, warn, or deny decision back without self-hosting OPA.

Público: Platform engineers, release managers, and security engineers

Ler guia

5 minutes

Deploy the Cloud Scanner on AWS

Scan your AWS environment for misconfigurations with Prowler, deployed as a Lambda container on EventBridge Scheduler — no EC2, no always-on compute.

Público: Cloud engineers, security engineers, platform teams

Ler guia

5 minutes

Deploy the Cloud Scanner on GCP

Scan GCP project posture with Prowler via a serverless Cloud Run Job triggered by Cloud Scheduler. One Terraform apply deploys to any number of projects and regions.

Público: Cloud engineers, security engineers, platform teams

Ler guia

2 minutes

Deploy the Kubernetes Scanner

Scan cluster posture with kube-bench (CIS benchmarks), kubescape, and Kyverno policy telemetry. One Helm chart install, one kubectl secret — done.

Público: Platform engineers, Kubernetes administrators, security engineers

Ler guia

5 minutes

Deploy the SaaS Scanner

Discover over-privileged OAuth grants, stale app access, and shadow AI tool sprawl across Google Workspace, Microsoft 365, and GitHub. Runs entirely inside your tenant boundary.

Público: Security engineers, identity and access management teams, platform engineers

Ler guia

3 minutes

Deploy the VM and Host Scanner

Ingest OSSEC and Wazuh host intrusion detection alerts into the platform for correlation with cloud and container findings. Works with Docker Compose, systemd, or ECS Fargate.

Público: Security operations teams, infrastructure engineers

Ler guia

5 minutes

Deploy the Security Agent

Run BlackShield's governed Go security agent inside your environment with tenant-scoped assignments, MCP context, AI Gateway controls, and approval gates around every mutation.

Público: Security engineers, platform engineers, and security operations teams

Ler guia

10 minutes

Deploy Network Sensor on AWS

Capture live network traffic using VPC Traffic Mirroring, deploy sensor instances with CloudFormation or CDK, and stream findings automatically to the platform.

Público: Platform engineers, network architects, security engineers

Ler guia

10 minutes

Deploy Network Sensor on GCP

Stream live traffic using Packet Mirroring, deploy sensor VM with Terraform, and ingest findings via the managed SIEM connector.

Público: Platform engineers, GCP administrators, security engineers

Ler guia

10 minutes

Deploy Network Sensor on Azure

Capture traffic using Virtual Network TAP, deploy sensor VM with Bicep, and bridge network telemetry into the security platform.

Público: Platform engineers, Azure administrators, security engineers

Ler guia

5-15 minutes

Network Sensor Troubleshooting

Diagnostic runbook for container startup, traffic capture, API connectivity, health checks, resource usage, and ingestion gaps.

Público: Operations engineers, DevOps teams, security operations teams

Ler guia

10 minutes

Network Sensor Scaling and Performance

Capacity planning, performance tuning, and sizing guidance for high-volume network telemetry ingestion.

Público: Platform architects, operations engineers, security engineers

Ler guia

15 minutes

Network Sensor High Availability & Architecture

Design resilient network sensor deployments with failover, load balancing, and multi-region architectures.

Público: Platform architects, network engineers, SRE teams

Ler guia

10-15 minutos

Processamento de dados e subprocessadores

Entenda quais dados do cliente são processados, quais subprocessadores estão envolvidos e quais salvaguardas legais se aplicam.

Público: Revisores de segurança, equipes jurídicas, equipes de privacidade e partes interessadas em compras

Ler guia

12-18 minutos

Trust Center: visão geral da postura de segurança

O BlackShield deve ganhar confiança com controlos concretos no produto: acesso autenticado ao workspace, ações sensíveis com rate limit, triagem em `/findings` e `/alerts`, e evidência exportável de `/reports`, `/audit` e `/compliance`.

Público: Compradores de segurança, equipas de procurement, equipas jurídicas e stakeholders de risco

Ler guia

15-20 minutos

Pacote de questionário de segurança

Use este pacote de respostas para concluir rapidamente solicitações de due diligence de segurança com respostas reutilizáveis ​​e evidências vinculadas.

Público: Revisores de segurança do cliente, equipes de compras e partes interessadas jurídicas

Ler guia

15 minutos

Ciclo de vida dos dados e desativação do tenant

Planeje as etapas de retenção, exportação e exclusão para que o tratamento de dados permaneça previsível, auditável e alinhado às políticas.

Público: Equipes de conformidade, jurídica e operações de plataforma

Ler guia

10 minutos

Resposta a incidentes e notificações ao cliente

Entenda a gravidade do incidente, o fluxo de escalonamento e as expectativas de comunicação para que sua equipe possa responder rapidamente.

Público: Líderes de segurança, equipes de operações e equipes de sucesso do cliente

Ler guia

8-12 minutos

Disponibilidade, suporte e SLAs

Revise as metas de tempo de atividade, apoie os compromissos de resposta e os canais de escalonamento por nível de plano.

Público: Proprietários de operações, suporte, compras e serviços

Ler guia

15-20 minutos

Pacote de Relatórios Executivos: MTTR, Tendências de Risco e SLA

Monte relatórios executivos de remediação com MTTR, backlog crítico/alto, desempenho de SLA e ownership por repositório/equipe.

Público: Lideranças de segurança, gestores de engenharia e administradores do tenant

Ler guia

10-15 minutos

Cobertura de controles e mapas de calor por benchmark

Transforme achados mapeados em postura por benchmark, serviços e relatórios exportáveis para auditoria e liderança.

Público: Líderes de segurança, auditores, administradores do tenant e responsáveis por serviço

Ler guia

12-20 minutos

Recuperação de desastres e continuidade do negócio

Planeje objetivos de recuperação, validação de failover e etapas de comunicação antes de uma grande interrupção de serviço.

Público: Equipes de operações de plataforma e proprietários de continuidade de negócios

Ler guia

10 minutos

Confiança em segurança e responsabilidade partilhada

Veja quais controles de segurança o BlackShield gerencia e quais permanecem com sua equipe.

Público: Arquitetos de segurança, proprietários de conformidade e administradores de plataforma

Ler guia

12-15 minutos

Endurecimento de Segurança de APIs (OWASP API Top 10: 2023)

Revise como a BlackShield protege APIs públicas e de tenants contra riscos de autorização, abuso e má configuração do OWASP API Top 10.

Público: Arquitetos de segurança, revisores AppSec e partes interessadas de conformidade

Ler guia

15-20 minutos

Ciclo de vida de identidades e controlos de acesso

Configure o provisionamento de contas, mudanças de funções e desligamento rápido para que o acesso permaneça controlado à medida que as equipes evoluem.

Público: Administradores de TI, equipes de operações de segurança e proprietários de espaços de trabalho

Ler guia

10-15 minutos

Registo de auditoria imutável e exportação de evidências

Filtre eventos relevantes para a segurança e exporte pacotes de evidências defensáveis ​​para auditorias, investigações e análises de conformidade.

Público: Administradores de segurança, equipes de conformidade e auditores

Ler guia

10-15 minutos

Exercer direitos de dados do tenant (GDPR/CCPA)

Use ferramentas de autoatendimento de privacidade para rever dados da conta, exportar registos e solicitar eliminação do tenant quando necessário.

Público: Administradores do tenant, responsáveis de privacidade e partes interessadas legais

Ler guia

15-20 minutos

Configurar o AI Gateway para a sua equipe

Conecte uma chave de provedor aprovada, crie um cliente para a IDE ou automação da equipe, teste o gateway e aplique uma política inicial simples.

Público: Admins do tenant, líderes de segurança e donos do workspace

Ler guia

10-15 minutos

Resolução de problemas e limites da plataforma

Resolva rapidamente problemas comuns de ingestão, autenticação e taxa de transferência com um fluxo de solução de problemas repetível.

Público: Administradores de locatários, equipes de DevOps e operadores de scanner

Ler guia

5-10 minutes

Integrating Threat Intel Blocklists

Automate the deployment of Threat Intel indicators directly into your security stack, including AWS WAF, Egress Proxies, DNS sinkholes, and EDR systems.

Público: Security engineers, SOC analysts, and network administrators

Ler guia
Documentação pública | BlackShield