
ماسح الأسرار عالي الأداء. CLI، مكتبة Go، إضافة Burp Suite، وإضافة Chrome. 487 قاعدة كشف مع التحقق المباشر من بيانات الاعتماد.
<img width="1200" height="628" alt="Titus - ماسح أسرار عالي الأداء للشيفرة المصدرية وسجل git والملفات الثنائية" src="https://assets.kitploit.com/production/public/readmes/11969/d2f6b99d686a073185db1b7299fa5f033067b057000062cf592a4ae15a796034.png" />
# Titus: ماسح أسرار عالي الأداء
[](https://go.dev)
[](LICENSE)
[](https://github.com/praetorian-inc/titus/actions)
**Titus** هو ماسح أسرار عالي الأداء يكتشف بيانات الاعتماد ومفاتيح API والرموز المميزة في الشيفرة المصدرية والملفات وسجل git. يأتي مزوّدًا بـ 487 قاعدة كشف تغطي مئات الخدمات وأنواع بيانات الاعتماد، مستمدة من [NoseyParker](https://github.com/praetorian-inc/noseyparker) و[Kingfisher](https://github.com/mongodb/kingfisher). يعمل Titus كأداة سطر أوامر CLI، ومكتبة Go، وإضافة Burp Suite، وإضافة لمتصفح Chrome — وجميعها تشترك في محرك الكشف ومجموعة القواعد نفسها.
صُمم Titus لمهندسي الأمن واختباري الاختراق وفرق DevSecOps، وهو يجمع بين مطابقة التعبيرات النمطية المعجّلة بواسطة [Hyperscan](https://github.com/intel/hyperscan)/[Vectorscan](https://github.com/VectorCamp/vectorscan) والتحقق المباشر من بيانات الاعتماد للعثور على الأسرار المسرّبة والتحقق منها عبر قاعدة شيفرتك بالكامل.
## جدول المحتويات
- [لماذا Titus؟](#why-titus)
- [التثبيت](#installation)
- [البدء السريع](#quick-start)
- [خيارات الفحص](#scanning-options)
- [تقييم النتائج](#finding-scoring)
- [مكتبة Go](#go-library-for-secrets-detection)
- [إضافة Burp Suite](#burp-suite-extension-for-secret-scanning)
- [إضافة المتصفح](#chrome-browser-extension-for-secret-scanning)
- [البناء من المصدر](#building-from-source)
- [المساهمة](#contributing)
- [الترخيص](#license)
## لماذا Titus؟
- **فحص سريع للأسرار**: مطابقة التعبيرات النمطية معجّلة بواسطة [Hyperscan](https://github.com/intel/hyperscan)/[Vectorscan](https://github.com/VectorCamp/vectorscan) عند توفّرها، مع بديل مكتوب بلغة Go خالص لضمان قابلية النقل على أي منصة.
- **تغطية واسعة لكشف بيانات الاعتماد**: تكشف 487 قاعدة مفاتيح API والرموز المميزة وبيانات الاعتماد الخاصة بـ AWS وGCP وAzure وGitHub وSlack وقواعد البيانات وأنظمة CI/CD ومئات الخدمات الأخرى.
- **التحقق المباشر من الأسرار**: يتم فحص الأسرار المكتشفة مقابل واجهات API المصدرية الخاصة بها للتأكد مما إذا كانت نشطة، مما يقلل من الإيجابيات الكاذبة ويعطي الأولوية للمعالجة.
- **تقييم الخطورة القائم على المخاطر**: تحصل كل نتيجة على درجة رقمية (0–100) ومستوى خطورة (info → critical). تُضبط الدرجات بناءً على البيانات الوصفية الثابتة للقواعد، وسياق إمكانية الوصول إلى الشيفرة، واستدعاءات API المباشرة التي تقيس نطاق التأثير الفعلي لبيانات الاعتماد — بحيث تظهر النتائج الأكثر خطورة دائمًا أولًا.
- **فحص صور الحاويات**: افحص صور Docker وOCI مباشرة من أي سجل (registry) أو ملف tarball أو دليل تخطيط OCI — دون الحاجة إلى Docker daemon أو ملف ثنائي.
- **واجهات متعددة لكل سير عمل**: افحص من سطر الأوامر CLI، أو ضمّنه كمكتبة Go، أو افحص حركة مرور HTTP بشكل سلبي في Burp Suite، أو افحص صفحات الويب في Chrome أثناء اختبار أمن التطبيقات.
- **استخراج الملفات الثنائية**: استخرج وافحص الأسرار من مستندات Office وملفات PDF والأرشيفات (zip، tar، 7z) وتطبيقات الهاتف المحمول (APK، IPA) وإضافات المتصفح وغيرها.
## التثبيت
نزّل ملفًا ثنائيًا جاهزًا من صفحة [Releases](../../releases)، أو ابنِ من المصدر:
```bash
make build
```
سيكون الملف التنفيذي في `dist/titus`.
## البدء السريع
```bash
# Scan a file for secrets
titus scan path/to/file.txt
# Scan a directory for leaked credentials
titus scan path/to/directory
# Scan a public GitHub repository (no token needed)
titus scan github.com/org/repo
# Scan a public GitLab project (no token needed)
titus scan gitlab.com/namespace/project
# Scan git history for secrets in past commits
titus scan --git path/to/repo
# Scan a Docker / OCI image (pulled from a registry — no docker daemon required)
titus scan --docker alpine:latest
# Validate detected secrets against source APIs
titus scan path/to/code --validate
```
تُكتب النتائج إلى مخزن بيانات (`titus.ds` افتراضيًا) وتُطبع إلى الطرفية.
### الأوامر الفرعية
<!-- BEGIN generated: cli-subcommands -->
ينظّم Titus وظائفه في هذه الأوامر الفرعية المتخصصة:
```bash
titus analyze # Analyze a credential on demand — detect type, validate, score, and enumerate resources
titus enum # Enumerate remote services for secrets
titus explore # Interactively explore scan results
titus report # Generate a report from scan results
titus rules # Manage detection rules
titus scan # Scan a target for secrets
titus serve # Run as streaming server for Burp extension integration
titus version # Show version information
```
<!-- END generated: cli-subcommands -->
كل أمر فرعي يقبل `--help` لعرض خياراته الخاصة. لا تزال صيغ `titus <provider>` على المستوى الأعلى التي سبقت `titus enum <provider>` تعمل، لكنها مخفية ومهملة بدلاً من كونها أسماء مستعارة، لذا تُدرج في المرجع المُولَّد بدلاً من هنا.
<!-- BEGIN generated: cli-aliases -->
يُولَّد المرجع الكامل — كل أمر فرعي واسم مستعار وخيار، بما في ذلك تلك المخفية من `--help` — في [docs/CLI.md](https://github.com/praetorian-inc/titus/blob/main/docs/CLI.md).
<!-- END generated: cli-aliases -->
## خيارات الفحص
### فحص GitHub وGitLab
افحص المستودعات العامة مباشرةً عبر URL — دون الحاجة إلى رمز API:
```bash
# Scan a GitHub repository
titus scan github.com/kubernetes/kubernetes
# Scan a GitLab project
titus scan gitlab.com/gitlab-org/cli
# Full URLs work too
titus scan https://github.com/org/repo
titus scan https://gitlab.com/namespace/project.git
```
بالنسبة للفحص على مستوى المؤسسة أو على مستوى المستخدم، استخدم الأوامر الفرعية المخصصة:
```bash
# Scan all public repos in a GitHub org
titus github --org kubernetes
# Scan all repos in a GitHub org with a token (private repos + higher rate limits)
titus github --org kubernetes --token $GITHUB_TOKEN
# Scan all repos for a GitHub user
titus github --user octocat
# Scan all projects in a GitLab group
titus gitlab scan --group mygroup --token $GITLAB_TOKEN
# Scan a single repo with git history (finds deleted secrets)
titus github scan owner/repo --git
```
الرموز المميزة (tokens) اختيارية للمستودعات العامة. عيّن `GITHUB_TOKEN` أو `GITLAB_TOKEN` (أو استخدم `--token`) للوصول إلى المستودعات الخاصة وحدود معدل API الأعلى.
### فحص صور Docker / OCI
افحص صور الحاويات مباشرةً — دون الحاجة إلى docker daemon أو إلى ملف `docker` التنفيذي. يسحب Titus الصور مباشرةً من أي سجل OCI عبر HTTPS (باستخدام بيانات الاعتماد من `~/.docker/config.json`)، أو يقرأ الصور من أرشيف `docker save` محلي أو من دليل تخطيط صور OCI. ثم يفحص بيانات manifest/config الوصفية للصورة وكل ملف عادي في كل طبقة، بما في ذلك الملفات الموجودة في الطبقات السفلى التي حذفتها طبقات لاحقة (لأن الأسرار يمكن أن تبقى قابلة للاسترداد من تاريخ الصورة).
```bash
# Pull from a registry and scan
titus scan --docker alpine:latest
titus scan docker://ghcr.io/owner/repo:tag
# Scan an image saved to a tarball:
# docker save my-app:latest -o my-app.tar
# podman save my-app:latest -o my-app.tar
titus scan --docker ./my-app.tar
# Scan an OCI image layout directory:
# docker buildx build --output type=oci,dest=./img/ .
# skopeo copy docker://my-app:latest oci:./img:latest
titus scan --docker ./img/
```
تستخدم المصادقة إعدادات Docker / Podman الموجودة لديك (`~/.docker/config.json`، `${XDG_RUNTIME_DIR}/containers/auth.json`). يجب أولاً مصادقة السجلات الخاصة التي تحتاج إلى تسجيل دخول جديد باستخدام `docker login` (أو `podman login`، أو `crane auth login`) — لا يطلب titus بيانات الاعتماد.
### عرض نتائج الفحص
استخدم `report` لإعادة قراءة النتائج من فحص سابق:
```bash
# Human-readable summary of detected secrets
titus report
# JSON output for programmatic processing
titus report --format json
# SARIF output for CI/CD integration with GitHub Advanced Security
titus report --format sarif
# Report from a specific datastore
titus report --datastore path/to/titus.ds
# Only findings from one repository (host-qualified as recorded, or without the host)
titus report --repo github.com/acme/api
# Repeat a selector, or combine selectors; a location matching any value is kept
titus report --namespace github.com/acme --namespace gitlab.example.com/acme --path src/config.yaml
# List the repository, namespace and path values that select current findings
titus report sources
# List every recorded source, including sources with no findings
titus report sources all
```
يمكنك أيضًا التحكم في صيغة المخرجات وقت الفحص باستخدام `--format`:
```bash
titus scan path/to/code --format json
```
### التحقق من الأسرار المكتشفة
مرّر `--validate` أثناء الفحص للتحقق من الأسرار المكتشفة مقابل واجهات API المصدرية الخاصة بها:
```bash
titus scan path/to/code --validate
```
تُنفَّذ عملية التحقق بشكل متزامن (4 عمّال افتراضيًا، وقابلة للضبط عبر `--validate-workers`) وتضع علامة على كل نتيجة على أنها مؤكدة أو منفية أو غير معروفة.
### قواعد كشف التصفية
```bash
# List all available detection rules
titus rules list
# Scan with only specific rules (e.g., AWS and GCP credentials)
titus scan path/to/code --rules-include "aws,gcp"
# Exclude rules by pattern
titus scan path/to/code --rules-exclude "kingfisher.generic"
# Use a custom rules file for organization-specific secrets
titus scan path/to/code --rules path/to/custom-rules.yaml
# Opt in to rules marked noisy: true (high false-positive rate, off by default)
titus scan path/to/code --include-noisy
```
القواعد المعلَّمة بـ `visible: false` هي قواعد مساعدة تلتقط السياق لقواعد أخرى، مثل معرّف عميل أو اسم حساب أو مضيف، بدلاً من أن تكون سرًّا. لا تزال أنماطها تُشغَّل، لكن لا يتم الإبلاغ عن مطابقاتها أبدًا، سواء عبر CLI أو مكتبة Go، حتى عند تحديد القاعدة صراحةً.
### استخراج الأسرار من الملفات الثنائية
يستطيع Titus استخراج النص من صيغ الملفات الثنائية وفحص المحتويات بحثًا عن الأسرار:
```bash
# Extract and scan all supported binary formats
titus scan path/to/files --extract=all
# Target specific formats
titus scan path/to/files --extract=xlsx,docx,pdf,zip
```
تشمل الصيغ المدعومة مستندات Office (xlsx، docx، pptx، odp، ods، odt)، وملفات PDF، ودفاتر Jupyter، وقواعد بيانات SQLite، والبريد الإلكتروني (eml، rtf)، والأرشيفات (zip، tar، tar.gz، jar، war، ear، apk، ipa، crx، xpi، 7z). تُستخرج الأرشيفات بشكل متكرر حتى حدود عمق وحجم قابلة للتهيئة.
```bash
# Tune extraction limits for large codebases
titus scan path/to/files --extract=all \
--extract-max-size 10MB \
--extract-max-total 100MB \
--extract-max-depth 5
```
بالنسبة لقواعد بيانات SQLite، يستخرج Titus النص من جميع الجداول (1000 صف لكل جدول افتراضيًا). استخدم `--sqlite-row-limit` للتعديل:
```bash
# Full dump of all SQLite tables (no row limit)
titus scan path/to/files --extract=all --sqlite-row-limit 0
# Custom row limit per table
titus scan path/to/files --extract=all --sqlite-row-limit 5000
```
## تقييم النتائج
كل نتيجة يُصدرها Titus تحمل درجة رقمية من 0–100 وفئة خطورة:
| الدرجة | الخطورة |
|-------|----------|
| 0–20 | info |
| 21–40 | low |
| 41–60 | medium |
| 61–80 | high |
| 81–100 | critical |
تبدأ الدرجات من `base_score` الخاص بالقاعدة ويتم تعديلها بواسطة **المعدِّلات** — وهي شروط ترفع أو تخفض الدرجة بناءً على ما هو معروف عن بيانات الاعتماد:
```bash
# Score findings using static rule metadata only (no network calls)
titus scan path/to/code
# Score findings AND make live API calls to verify credential blast radius
# (calls AWS STS/IAM and GitHub API for supported credential types)
titus scan path/to/code --score-scope
# Override the accessibility context (default: auto-detected from git remote)
titus scan path/to/code --accessibility public # no penalty for public repos
titus scan path/to/code --accessibility private # -25 penalty (default for local scans)
```
يأتي Titus مزوّدًا بُمقيّمات YAML لبيانات اعتماد AWS، ورموز GitHub PATs، ورموز Slack، بالإضافة إلى مُقيّمات SDK المبنية على Go التي تُجري تعدادًا حيًّا لسياسات IAM (AWS) وفحوصات أذونات المستودعات (رموز GitHub PATs الدقيقة) عند تفعيل `--score-scope`.
راجع [docs/scoring.md](https://github.com/praetorian-inc/titus/blob/main/docs/scoring.md) للحصول على المرجع الكامل: مستويات الخطورة، وأنواع المُعدِّلات، وتفاصيل المُقيّمات المدمجة، وكيفية كتابة مُقيّمات YAML أو Go الخاصة بك.
## مكتبة Go لاكتشاف الأسرار
يمكن استيراد Titus كمكتبة Go لإضافة اكتشاف الأسرار إلى أدواتك وخطوط أنابيبك الخاصة.
```bash
go get github.com/praetorian-inc/titus
```
```go
package main
import (
"fmt"
"log"
"github.com/praetorian-inc/titus"
)
func main() {
// Initialize the secrets scanner with default rules
scanner, err := titus.NewScanner()
if err != nil {
log.Fatal(err)
}
defer scanner.Close()
// Scan a string for API keys, tokens, and credentials
matches, err := scanner.ScanString(`aws_access_key_id = AKIADEADBEEFDEADBEEF`)
if err != nil {
log.Fatal(err)
}
for _, match := range matches {
fmt.Printf("%s (rule: %s) at line %d\n",
match.RuleName, match.RuleID,
match.Location.SourceSpan.Start.Line,
)
}
}
```
تدعم المكتبة أيضًا فحص البايتات والملفات، والتحقق من الأسرار المكتشفة، وتحميل قواعد مخصصة:
```go
// Scan a file for leaked credentials
matches, err := scanner.ScanFile("/path/to/config.json")
// Enable validation to check if detected secrets are live
scanner, err := titus.NewScanner(titus.WithValidation())
// Load custom detection rules for organization-specific secrets
rules, err := titus.LoadRulesFromFile("/path/to/rules.yaml")
scanner, err := titus.NewScanner(titus.WithRules(rules))
```
راجع [docs/library-usage.md](https://github.com/praetorian-inc/titus/blob/main/docs/library-usage.md) للحصول على مرجع API الكامل وأنماط التزامن والمزيد من الأمثلة.
## إضافة Burp Suite لفحص الأسرار
تقوم إضافة Burp بفحص استجابات HTTP بحثًا عن الأسرار أثناء حركة المرور عبر الوكيل واختبار الاختراق النشط.
### الإعداد
#### Linux / macOS (البناء من المصدر)
```bash
# Build the CLI and Burp extension JAR, install CLI to ~/.titus/
make install-burp
```
ثم حمّل `dist/titus-burp-1.0.0-all.jar` في Burp Suite ضمن Extensions > Add.
#### Windows (التنزيل من Releases)
1. نزّل `titus-windows-amd64.exe` و`titus-burp-<version>.jar` من [Releases](../../releases)
2. أنشئ دليل Titus وثبّت الملف التنفيذي:
```powershell
mkdir %USERPROFILE%\.titus
copy titus-windows-amd64.exe %USERPROFILE%\.titus\titus.exe
```
3. حمّل ملف JAR في Burp Suite ضمن Extensions > Add
#### Linux / macOS (التنزيل من Releases)
1. نزّل الملف التنفيذي المناسب لمنصّتك و`titus-burp-<version>.jar` من [Releases](../../releases):
- `titus-linux-amd64` أو `titus-linux-arm64` لنظام Linux
- `titus-darwin-amd64` أو `titus-darwin-arm64` لنظام macOS
2. ثبّت الملف التنفيذي:
```bash
mkdir -p ~/.titus
cp titus-<platform> ~/.titus/titus
chmod +x ~/.titus/titus
```
3. حمّل ملف JAR في Burp Suite ضمن Extensions > Add
يشغّل الامتداد عملية `titus serve` في الخلفية ويتواصل عبر stdin/stdout باستخدام NDJSON. تُحمَّل قواعد الكشف مرة واحدة عند بدء التشغيل.
### ميزات امتداد Burp
- **فحص الأسرار السلبي**: يفحص حركة مرور الوكيل تلقائيًا أثناء تدفقها عبر Burp
- **فحص الأسرار النشط**: قائمة سياق بالنقر الأيمن لفحص الطلبات المحددة
- **إزالة التكرار**: يُبلَّغ عن السر نفسه مرة واحدة فقط لكل عملية
- **تصفية المسار السريع**: تُتخطى المحتويات الثنائية والصور والاستجابات غير النصية
- **التحقق المباشر من بيانات الاعتماد**: فحص الأسرار المكتشفة مقابل واجهات برمجة التطبيقات المصدرية للتأكد من كونها نشطة
- **إدارة الإيجابيات الكاذبة**: وضع علامة على النتائج كإيجابيات كاذبة لتصفية الضوضاء
- **تصنيف الخطورة**: تُلوَّن النتائج حسب المخاطر (عالية/متوسطة/منخفضة)
- **التصدير**: حفظ النتائج بصيغة JSON لإعداد التقارير
### واجهة امتداد Burp
يضيف الامتداد علامة تبويب **Titus** إلى Burp بثلاث علامات تبويب فرعية:
**Secrets**: جميع الأسرار المكتشفة مع التصفية حسب النوع والمضيف وحالة التحقق.
Titus Burp Suite extension secrets tab showing detected API keys and credentials with validation status
- **حالة التحقق**: تُظهر ما إذا كانت الأسرار قد فُحصت (نشط/غير نشط/غير معروف)
- **التصفية**: انقر على أزرار Type أو Host أو Status للتصفية حسب قيم محددة؛ استخدم مربع البحث لمطابقة النص والتعبيرات النمطية
- **الإجراءات الجماعية**: حدد عدة صفوف للتحقق منها أو وضع علامة إيجابية كاذبة عليها دفعة واحدة
- **لوحة تفاصيل السر**: حدد نتيجة لعرض:
- **Details**: معلومات القاعدة، والفئة، وقيمة السر الكاملة، وطابع وقت أول ظهور
- **URLs**: جميع المواقع التي وُجد فيها هذا السر
- **Validation**: نتيجة التحقق مع التفاصيل (مثل معرّف حساب AWS وARN)
- **Request/Response**: حركة مرور HTTP الكاملة مع إبراز السر
**Statistics**: عرض مجمّع للأسرار مجمّعة حسب النوع والمضيف.
<img width="1964" height="848" alt="Titus Burp Suite extension statistics tab showing secrets by type and host" src="https://assets.kitploit.com/production/public/readmes/11969/4a3d6f997049bb8bba621ceb8511b9a41c63867a5c1e8add6065c483706ac36a.png" />
- **Summary**: إجمالي الأسرار الفريدة، والمضيفون المفحوصون، وتفصيل التحقق (نشط مقابل غير نشط)، وعدد الإيجابيات الكاذبة
- **Secrets by Type**: عدد كل نوع من الأسرار مع تصنيف الفئة
- **Secrets by Host**: عدد الأسرار الموجودة لكل مضيف
**Settings**: تكوين خيارات الفحص والتحقق وتعيينات الخطورة.
Titus Burp Suite extension settings tab with scan configuration options
- **إعدادات الفحص**:
- *الفحص السلبي*: فحص جميع حركة مرور الوكيل تلقائيًا (مفعّل افتراضيًا)
- *فحص جسم الطلب*: فحص أجسام الطلبات أيضًا بحثًا عن الأسرار التي يرسلها التطبيق
- *التحقق*: فعّله لفحص الأسرار مقابل واجهات برمجة التطبيقات المصدرية (يُجري طلبات صادرة وقد يُطلق تنبيهات)
- **معاملات الفحص**: خيوط العمال، والحد الأقصى لحجم الملف، وطول مقتطف السياق
- **تكوين الخطورة**: تخصيص مستويات الخطورة لكل فئة من الأسرار
- **الإجراءات**: مسح ذاكرة التخزين المؤقت، وإعادة تعيين الإعدادات، وحفظ/تصدير النتائج بصيغة JSON
عند عرض أي طلب في Burp، تظهر علامة تبويب **Titus** في مفتّش الاستجابة إذا اكتُشفت أسرار، مما يتيح وصولًا سريعًا إلى النتائج دون التبديل إلى علامة تبويب Titus الرئيسية.
Titus tab in Burp Suite response inspector highlighting detected secrets in HTTP responses
## امتداد متصفح Chrome لفحص الأسرار
يفحص امتداد Chrome صفحات الويب بحثًا عن الأسرار أثناء تقييمات أمان تطبيقات الويب.
### الإعداد
```bash
make build-extension
```
1. انتقل إلى `chrome://extensions/`
2. فعّل **وضع المطوّر**
3. انقر على **تحميل غير المحزّم** واختر دليل `extension/`
### ميزات إضافة المتصفح
- تفحص JavaScript وأوراق الأنماط المضمّنة والخارجية بحثًا عن مفاتيح API والرموز المميزة
- تفحص localStorage وsessionStorage بحثًا عن بيانات اعتماد مسرّبة
- التقاط اختياري لاستجابات الشبكة للكشف الشامل عن الأسرار
- تُعرض النتائج في النافذة المنبثقة ولوحة التحكم
<img width="1719" height="958" alt="Titus Chrome extension popup showing detected secrets on a web page" src="https://assets.kitploit.com/production/public/readmes/11969/057a24e2746412ceabe1aac0292a2de463de1efee5bca2489ca34b59d8b0dc2c.png" />
<img width="1744" height="827" alt="Titus Chrome extension dashboard with aggregated secret detection results" src="https://assets.kitploit.com/production/public/readmes/11969/265d972fadcc7f212944d7a1d8fd58a43446e7199d1209900e83b96a546ffb00.png" />
### تنبيه أمني
تُزيل إضافة المتصفح ترويسات Content Security Policy وCORS من الصفحات التي تمت زيارتها لفحص الموارد الخارجية. يؤدي هذا إلى إضعاف الوضع الأمني للمواقع التي تزورها أثناء تفعيل الإضافة. **فعّلها فقط أثناء اختبار الأمان النشط.**
## البناء من المصدر
### البناء القياسي (المُسرَّع بـ Vectorscan)
افتراضيًا، يُجمَّع Titus باستخدام [Vectorscan](https://github.com/VectorCamp/vectorscan) (ARM) / [Hyperscan](https://github.com/intel/hyperscan) (x86) لمطابقة التعبيرات النمطية المُسرَّعة بـ SIMD. يتطلب هذا CGO ومكتبة C و`pkg-config` (الذي يستخدمه cgo لتحديد موقع المكتبة). يتحقق `make build` من وجود هذه العناصر ويحاول تثبيت أي شيء مفقود عبر Homebrew / apt / dnf:
```bash
# Build the CLI binary with vectorscan acceleration (outputs to dist/titus)
make build
# Build the Burp Suite extension JAR
make build-burp
# Build the Chrome browser extension
make build-extension
# Run unit tests
make test
# Run integration tests
make integration-test
```
سترى `[vectorscan] N/N rules compiled for Hyperscan` عند بدء التشغيل عندما يكون المحرك المُسرَّع نشطًا.
لتثبيت مكتبة C بنفسك بدلاً من الاعتماد على التثبيت التلقائي:
```bash
# macOS (Homebrew)
brew install pkg-config vectorscan
# Ubuntu/Debian
sudo apt-get install pkg-config libhyperscan-dev
# Fedora/RHEL
sudo dnf install pkgconf-pkg-config vectorscan-devel
# Or build vectorscan from source:
git clone --depth 1 --branch vectorscan/5.4.11 https://github.com/VectorCamp/vectorscan.git
cd vectorscan && cmake -B build -DCMAKE_INSTALL_PREFIX=/usr/local && cmake --build build && sudo cmake --install build
```
إذا استدعيت `go build` مباشرةً (على سبيل المثال، عند تضمين Titus)، فمرّر الوسم وفعّل CGO:
```bash
# macOS (Homebrew) — adjust PKG_CONFIG_PATH to your installed version
CGO_ENABLED=1 PKG_CONFIG_PATH="$(brew --prefix vectorscan)/lib/pkgconfig" \
go build -tags vectorscan -o dist/titus ./cmd/titus
# Linux (system-installed)
CGO_ENABLED=1 go build -tags vectorscan -o dist/titus ./cmd/titus
```
### بناء Pure-Go (بدون تبعيات C)
إذا لم تتمكن من تثبيت مكتبة C — أو أردت ملفًا تنفيذيًا ثابتًا ومحمولًا بالكامل — فقم ببناء محرك Pure-Go بدلًا من ذلك. يتراجع Titus تلقائيًا إليه في وقت التشغيل كلما لم يكن vectorscan مُجمَّعًا:
```bash
# Portable pure-Go binary (no CGO, no vectorscan)
make build-pure
# Fully static binary
make build-static
```
#### ذاكرة التخزين المؤقت التلقائية لقاعدة بيانات Hyperscan
يقوم Titus تلقائيًا بتسلسل كل قاعدة بيانات Hyperscan تم تجميعها بنجاح إلى ذاكرة التخزين المؤقت القياسية للمستخدم. تقوم نسخ الماسح الضوئي اللاحقة التي تحتوي على نفس القواعد والأعلام بالترتيب نفسه بتحميل تلك القاعدة بدلاً من تجميعها مرة أخرى. ملف ذاكرة التخزين المؤقت هو تدفق البايتات غير المعدّل الذي ينتجه `hs_serialize_database` الخاص بـ Hyperscan، ويقوم Titus بتحميله باستخدام `hs_deserialize_database`.
يمكن لـ `TITUS_CACHE_DIR` تجاوز موقع ذاكرة التخزين المؤقت. عمليات الكتابة إلى ذاكرة التخزين المؤقت ذرّية وبذل أفضل جهد: ذاكرة تخزين مؤقت غير متاحة أو للقراءة فقط لا تمنع الفحص. قاعدة بيانات مفقودة أو تالفة أو غير متوافقة أو ذات بصمة مختلفة تؤدي إلى التجميع العادي وتحدّث ذاكرة التخزين المؤقت عند الإمكان.
قواعد البيانات المتسلسلة خاصة بالمعمارية وميزات المعالج وإصدار Hyperscan. يكتشف Titus الإدخالات غير المتوافقة أثناء إلغاء التسلسل ويستبدلها بقاعدة بيانات مجمّعة للبيئة التشغيلية الحالية.
## المساهمة
المساهمات مرحّب بها! راجع [CONTRIBUTING.md](https://github.com/praetorian-inc/titus/blob/main/CONTRIBUTING.md) للحصول على إرشادات حول كيفية المساهمة في Titus.
## الترخيص
Apache License 2.0 — راجع [LICENSE](https://github.com/praetorian-inc/titus/blob/main/LICENSE).
قواعد الكشف مستمدة من [NoseyParker](https://github.com/praetorian-inc/noseyparker) (Praetorian Security, Inc.) و[Kingfisher](https://github.com/mongodb/kingfisher) (MongoDB, Inc.)، وكلاهما مرخّص بموجب Apache 2.0. راجع [NOTICE](https://github.com/praetorian-inc/titus/blob/main/NOTICE) للحصول على الإسناد الكامل.