BLACKSHIELD

Documentation publique

Customer docs for onboarding, trust, and day-2 operations.

Use these guides to launch quickly, complete security reviews, run reliable operations, and solve common issues independently.

Start here

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

Recommended

15-20 minutes

Intégrez votre espace de travail

Créez votre espace de travail, votre premier administrateur et vos clés d'intégration afin que votre équipe puisse commencer à ingérer les résultats en toute sécurité.

Open guided path

Security review

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

12-18 minutes

Trust Center : vue d'ensemble de la posture de sécurité

Utilisez ce guide pour évaluer les contrôles de sécurité, la gestion des données et les engagements opérationnels de BlackShield avant le déploiement en production.

Open trust guide

Need Fast Help?

Start here to resolve the most common onboarding and ingestion blockers.

Open troubleshooting

Security Review?

Use the trust center and questionnaire pack to answer legal and security due-diligence requests.

Open trust center package

Escalation

For urgent production incidents, include workspace details, job IDs, and timestamps in your support request.

Contact support

Developer Quick Starts

Copy the fastest deployment path for your environment.

Start with a working snippet, copy the command or file, then open the full guide only if you need deeper rollout detail.

Browse all deployment guides

Fast path

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

Understand and customize

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

Collections de guides

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

Confiance et gouvernance

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.

Fiabilité et support

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 minutes

Intégrez votre espace de travail

Créez votre espace de travail, votre premier administrateur et vos clés d'intégration afin que votre équipe puisse commencer à ingérer les résultats en toute sécurité.

Audience: Propriétaires d'espaces de travail et premiers administrateurs de locataires

Lire le guide

30 à 45 minutes

Après la connexion : prochaines étapes du premier jour

Utilisez ceci liste de contrôle du premier jour pour passer d'un espace de travail vide à des résultats validés et à une propriété claire.

Audience: Nouveaux administrateurs de locataires et responsables de la sécurité

Lire le guide

10-15 minutes

Ingérer vos premières détections

Exécutez votre première analyse, soumettez les résultats et confirmez la qualité des données avant d'étendre à d'autres intégrations.

Audience: Ingénieurs de sécurité, propriétaires de CI et ingénieurs d'intégration

Lire le guide

Examen quotidien en cours recommandé

Examiner et prioriser les détections

Donnez la priorité aux mesures correctives en tenant compte du risque, de l’exploitabilité et de la propriété afin que les équipes corrigent ce qui compte en premier.

Audience: Équipes de tri de sécurité, responsables d'ingénierie et propriétaires de services

Lire le guide

Premiers 30 jours

Que faire après les premières détections

Convertissez les résultats initiaux en un programme de sécurité reproductible avec des mesures, une propriété et des rapports clairs.

Audience: Propriétaires de programmes de sécurité et responsables de l'ingénierie

Lire le guide

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.

Audience: DevOps engineers, platform engineers, and security engineers

Lire le guide

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.

Audience: Platform engineers, release managers, and security engineers

Lire le guide

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.

Audience: Cloud engineers, security engineers, platform teams

Lire le guide

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.

Audience: Cloud engineers, security engineers, platform teams

Lire le guide

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.

Audience: Platform engineers, Kubernetes administrators, security engineers

Lire le guide

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.

Audience: Security engineers, identity and access management teams, platform engineers

Lire le guide

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.

Audience: Security operations teams, infrastructure engineers

Lire le guide

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.

Audience: Security engineers, platform engineers, and security operations teams

Lire le guide

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.

Audience: Platform engineers, network architects, security engineers

Lire le guide

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.

Audience: Platform engineers, GCP administrators, security engineers

Lire le guide

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.

Audience: Platform engineers, Azure administrators, security engineers

Lire le guide

5-15 minutes

Network Sensor Troubleshooting

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

Audience: Operations engineers, DevOps teams, security operations teams

Lire le guide

10 minutes

Network Sensor Scaling and Performance

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

Audience: Platform architects, operations engineers, security engineers

Lire le guide

15 minutes

Network Sensor High Availability & Architecture

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

Audience: Platform architects, network engineers, SRE teams

Lire le guide

10-15 minutes

Traitement des données et sous-traitants

Comprendre quelles données client sont traitées, quels sous-traitants sont impliqués et quelles garanties juridiques apply.

Audience: Évaluateurs de sécurité, équipes juridiques, équipes de confidentialité et parties prenantes de l'approvisionnement

Lire le guide

12-18 minutes

Trust Center : vue d'ensemble de la posture de sécurité

Utilisez ce guide pour évaluer les contrôles de sécurité, la gestion des données et les engagements opérationnels de BlackShield avant le déploiement en production.

Audience: Évaluateurs de sécurité, parties prenantes des achats, juridiques et des risques

Lire le guide

15-20 minutes

Pack de questionnaire de sécurité

Utilisez ce pack de réponses pour compléter rapidement les demandes de diligence raisonnable en matière de sécurité avec des réponses réutilisables et des preuves liées.

Audience: Les réviseurs de sécurité des clients, les équipes d'approvisionnement et les parties prenantes juridiques

Lire le guide

15 minutes

Cycle de vie des données et offboarding du tenant

Planifiez les étapes de rétention, d’exportation et de désintégration afin que le traitement des données reste prévisible, vérifiable et aligné sur les politiques.

Audience: Équipes de conformité, juridiques et d'exploitation de la plateforme

Lire le guide

10 minutes

Réponse aux incidents et notifications clients

Comprendre la gravité des incidents, le flux d'escalade et les attentes en matière de communication afin que votre équipe puisse réagir rapidement.

Audience: Responsables de sécurité, équipes d'exploitation et équipes de réussite client

Lire le guide

8 à 12 minutes

Disponibilité, support et SLA

Examinez les objectifs de disponibilité, les engagements de réponse et les canaux de remontée par niveau de plan.

Audience: Propriétaires des opérations, du support, des achats et des services

Lire le guide

15-20 minutes

Pack de Reporting Exécutif: MTTR, Tendances de Risque et SLA

Préparez des rapports exécutifs de remédiation avec MTTR, backlog critique/élevé, performance SLA et ownership par dépôt/équipe.

Audience: Responsables sécurité, managers engineering et administrateurs tenant

Lire le guide

10-15 minutes

Couverture des contrôles et cartes thermiques par benchmark

Transformez les findings mappés en posture par benchmark, service et rapport exportable pour audit et direction.

Audience: Responsables sécurité, auditeurs, admins tenant et owners de service

Lire le guide

12-20 minutes

Reprise après sinistre et continuité d'activité

Planifiez les objectifs de récupération, la validation du basculement et les étapes de communication avant une interruption majeure du service.

Audience: Équipes d’exploitation de la plateforme et responsables de la continuité des activités

Lire le guide

10 minutes

Confiance sécurité et responsabilité partagée

Voir quels contrôles de sécurité BlackShield gère et quels contrôles restent avec votre équipe.

Audience: Architectes de sécurité, propriétaires de conformité et administrateurs de plateforme

Lire le guide

12-15 minutes

Renforcement de la sécurité des API (OWASP API Top 10 : 2023)

Examinez comment BlackShield protège les API publiques et locataires contre les risques d'autorisation, d'abus et de mauvaise configuration de l'OWASP API Top 10.

Audience: Architectes sécurité, réviseurs AppSec et parties prenantes conformité

Lire le guide

15-20 minutes

Cycle de vie des identités et contrôles d'accès

Configurez le provisionnement des comptes, les changements de rôle et le retrait rapide afin que l'accès reste contrôlé en tant qu'équipes. évoluer.

Audience: IT administrateurs, équipes d'opérations de sécurité et propriétaires d'espace de travail

Lire le guide

10-15 minutes

Journal d'audit immuable et export de preuves

Filtrer les événements liés à la sécurité et exporter des ensembles de preuves défendables pour les audits, les enquêtes et les examens de conformité.

Audience: Administrateurs de sécurité, équipes de conformité et auditeurs

Lire le guide

10-15 minutes

Exercer les droits sur les données du tenant (RGPD/CCPA)

Utilisez des outils de confidentialité en libre-service pour examiner les données de compte, exporter des enregistrements et demander la suppression des locataires si nécessaire.

Audience: Tenant administrateurs, responsables de la confidentialité et parties prenantes juridiques

Lire le guide

20-30 minutes

Activer AI Gateway et les connexions fournisseur IA

Connectez votre fournisseur d'IA préféré et votre client MCP afin que les équipes puissent effectuer un tri assisté et un examen sécurisé workflows.

Audience: Administrateurs de plateforme de sécurité et ingénieurs d'intégration

Lire le guide

10-15 minutes

Dépannage et limites de la plateforme

Résolvez rapidement les problèmes courants d’ingestion, d’authentification et de débit grâce à un flux de dépannage reproductible.

Audience: Administrateurs locataires, équipes DevOps et opérateurs de scanner

Lire le guide

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.

Audience: Security engineers, SOC analysts, and network administrators

Lire le guide
Public Docs | BlackShield