BLACKSHIELD

الوثائق العامة

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 دقيقة

تهيئة مساحة العمل

قم بإنشاء مساحة العمل الخاصة بك، والمسؤول الأول، ومفاتيح التكامل حتى يتمكن فريقك من البدء في استيعاب النتائج بأمان.

Open guided path

Security review

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

12-18 دقيقة

مركز الثقة: نظرة عامة على الوضع الأمني

استخدم هذا الدليل لتقييم ضوابط أمان BlackShield ومعالجة البيانات والالتزامات التشغيلية قبل بدء الإنتاج.

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.

مجموعات الأدلة

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

الثقة والحوكمة

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.

الموثوقية والدعم

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 دقيقة

تهيئة مساحة العمل

قم بإنشاء مساحة العمل الخاصة بك، والمسؤول الأول، ومفاتيح التكامل حتى يتمكن فريقك من البدء في استيعاب النتائج بأمان.

الجمهور: مالكو مساحة العمل ومسؤولو المستأجر الأول

قراءة الدليل

30-45 دقيقة

بعد تسجيل الدخول: الخطوات التالية لليوم الأول

استخدم قائمة التحقق لليوم الأول هذه للانتقال من مساحة عمل فارغة إلى النتائج التي تم التحقق من صحتها والملكية الواضحة.

الجمهور: مدراء المستأجرين الجدد وقيادات الأمان

قراءة الدليل

10-15 دقيقة

استيعاب أولى النتائج

قم بإجراء الفحص الأول الخاص بك، وأرسل النتائج، وتأكد من جودة البيانات قبل التوسع إلى المزيد من عمليات التكامل.

الجمهور: مهندسو الأمن ومالكو CI ومهندسو التكامل

قراءة الدليل

يوصى بالمراجعة اليومية المستمرة

مراجعة النتائج وتحديد الأولويات

أعط الأولوية للمعالجة باستخدام المخاطر وقابلية الاستغلال والملكية حتى تقوم الفرق بإصلاح ما يهم أولاً.

الجمهور: فرق فرز الأمان والعملاء الهندسيين وأصحاب الخدمات

قراءة الدليل

أول 30 يومًا

ماذا تفعل بعد أولى النتائج

تحويل النتائج الأولية إلى برنامج أمان قابل للتكرار بمقاييس وملكية وإعداد تقارير واضحة.

الجمهور: أصحاب برامج الأمان ومديرو الهندسة

قراءة الدليل

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.

الجمهور: DevOps engineers, platform engineers, and security engineers

قراءة الدليل

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.

الجمهور: Platform engineers, release managers, and security engineers

قراءة الدليل

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.

الجمهور: Cloud engineers, security engineers, platform teams

قراءة الدليل

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.

الجمهور: Cloud engineers, security engineers, platform teams

قراءة الدليل

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.

الجمهور: Platform engineers, Kubernetes administrators, security engineers

قراءة الدليل

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.

الجمهور: Security engineers, identity and access management teams, platform engineers

قراءة الدليل

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.

الجمهور: Security operations teams, infrastructure engineers

قراءة الدليل

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.

الجمهور: Security engineers, platform engineers, and security operations teams

قراءة الدليل

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.

الجمهور: Platform engineers, network architects, security engineers

قراءة الدليل

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.

الجمهور: Platform engineers, GCP administrators, security engineers

قراءة الدليل

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.

الجمهور: Platform engineers, Azure administrators, security engineers

قراءة الدليل

5-15 minutes

Network Sensor Troubleshooting

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

الجمهور: Operations engineers, DevOps teams, security operations teams

قراءة الدليل

10 minutes

Network Sensor Scaling and Performance

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

الجمهور: Platform architects, operations engineers, security engineers

قراءة الدليل

15 minutes

Network Sensor High Availability & Architecture

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

الجمهور: Platform architects, network engineers, SRE teams

قراءة الدليل

10-15 دقيقة

معالجة البيانات والمعالجات الفرعية

فهم بيانات العميل التي تتم معالجتها، والمعالجات الفرعية المشاركة، والضمانات القانونية Apply.

الجمهور: مراجعو الأمن والفرق القانونية وفرق الخصوصية وأصحاب المصلحة في مجال المشتريات

قراءة الدليل

12-18 دقيقة

مركز الثقة: نظرة عامة على الوضع الأمني

استخدم هذا الدليل لتقييم ضوابط أمان BlackShield ومعالجة البيانات والالتزامات التشغيلية قبل بدء الإنتاج.

الجمهور: مراجعو الأمن والمشتريات وأصحاب المصلحة القانونيون والمخاطرون

قراءة الدليل

15-20 دقيقة

حزمة الاستبيان الأمني

استخدم حزمة الاستجابة هذه لإكمال طلبات العناية الواجبة المتعلقة بالأمان بسرعة باستخدام الإجابات القابلة لإعادة الاستخدام والربط الأدلة.

الجمهور: مراجعو أمان العملاء وفرق المشتريات وأصحاب المصلحة القانونيين

قراءة الدليل

15 دقيقة

دورة حياة البيانات وإنهاء اشتراك المستأجر

تخطيط خطوات الاحتفاظ والتصدير والإخراج حتى تظل معالجة البيانات قابلة للتنبؤ بها وقابلة للتدقيق ومتوافقة مع السياسة.

الجمهور: فرق عمليات الامتثال والقانون والعمليات الأساسية

قراءة الدليل

10 دقائق

الاستجابة للحوادث وإشعارات العملاء

فهم خطورة الحادث وتدفق التصعيد وتوقعات الاتصال حتى يتمكن فريقك من الاستجابة بسرعة.

الجمهور: قادة الأمن وفرق العمليات وفرق نجاح العملاء

قراءة الدليل

8-12 دقيقة

التوافر والدعم واتفاقيات مستوى الخدمة

قم بمراجعة أهداف وقت التشغيل والتزامات الاستجابة الداعمة وقنوات التصعيد حسب طبقة الخطة.

الجمهور: العمليات والدعم والمشتريات وأصحاب الخدمات

قراءة الدليل

15-20 دقيقة

حزمة التقارير التنفيذية: MTTR واتجاهات المخاطر وSLA

أنشئ تقارير تنفيذية عن المعالجة تتضمن MTTR وتراكم الحالات الحرجة/العالية وأداء SLA وتوزيع الملكية حسب المستودع/الفريق.

الجمهور: قيادات الأمن ومديرو الهندسة ومسؤولو المستأجر

قراءة الدليل

10-15 دقيقة

تغطية الضوابط وخرائط الحرارة المعيارية

حوّل النتائج المربوطة إلى وضعية معيارية وخدمة وتقارير قابلة للتصدير للمراجعة والقيادة.

الجمهور: قادة الأمن والمدققون ومسؤولو المستأجر ومالكو الخدمات

قراءة الدليل

12-20 دقيقة

التعافي من الكوارث واستمرارية الأعمال

تخطيط أهداف الاسترداد والتحقق من تجاوز الفشل وخطوات الاتصال قبل حدوث انقطاع كبير في الخدمة.

الجمهور: فرق عمليات النظام الأساسي ومالكي استمرارية الأعمال

قراءة الدليل

10 دقائق

الثقة الأمنية والمسؤولية المشتركة

تعرف على عناصر التحكم الأمنية يدير BlackShield عناصر التحكم التي تظل مع فريقك.

الجمهور: مهندسو الأمن ومالكو الامتثال ومسؤولو النظام الأساسي

قراءة الدليل

12-15 دقيقة

تعزيز أمن واجهات API (OWASP API Top 10: 2023)

راجع كيف تحمي BlackShield واجهات API العامة وواجهات المستأجرين من مخاطر التفويض وسوء الاستخدام وسوء الإعداد ضمن OWASP API Top 10.

الجمهور: مهندسو أمن التطبيقات، معماريّو الأمن، وأصحاب مصلحة الامتثال

قراءة الدليل

15-20 دقيقة

دورة حياة الهوية وضوابط الوصول

قم بإعداد توفير الحساب وتغييرات الأدوار والخروج السريع بحيث يظل الوصول تحت السيطرة كفرق تتطور.

الجمهور: IT المسؤولون وفرق عمليات الأمان ومالكو مساحة العمل

قراءة الدليل

10-15 دقيقة

سجل تدقيق غير قابل للتغيير وتصدير الأدلة

تصفية الأحداث ذات الصلة بالأمان وتصدير حزم الأدلة التي يمكن الدفاع عنها لعمليات التدقيق والتحقيقات ومراجعات الامتثال.

الجمهور: مسؤولو الأمن وفرق الامتثال والمدققون

قراءة الدليل

10-15 دقيقة

ممارسة حقوق بيانات المستأجر (GDPR/CCPA)

استخدم أدوات خصوصية الخدمة الذاتية لمراجعة بيانات الحساب وتصدير السجلات وطلب حذف المستأجر عند الحاجة.

الجمهور: مسؤولو المستأجرون ومسؤولو الخصوصية وأصحاب المصلحة القانونيون

قراءة الدليل

20-30 دقيقة

تمكين AI Gateway واتصالات موفري الذكاء الاصطناعي

قم بتوصيل الذكاء الاصطناعي المفضل لديك الموفر وعميل MCP حتى تتمكن الفرق من تشغيل عمليات الفرز المدعومة وسير عمل المراجعة الآمنة.

الجمهور: منصة الأمان المسؤولون ومهندسو التكامل

قراءة الدليل

10-15 دقيقة

استكشاف الأخطاء وحدود المنصة

حل مشترك مشاكل العرض والمصادقة والإنتاجية بسرعة من خلال تدفق استكشاف الأخطاء وإصلاحها المتكرر.

الجمهور: مسؤولو Tenant وفرق DevOps والماسح الضوئي المشغلون

قراءة الدليل

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.

الجمهور: Security engineers, SOC analysts, and network administrators

قراءة الدليل
Public Docs | BlackShield