Codex Security

@openai/codex-security هي أداة CLI وSDK بلغة TypeScript لاكتشاف الثغرات الأمنية في شيفرتك والتحقق منها وإصلاحها.

👉👉 راجع توثيق Codex Security للحصول على التوثيق الكامل.

تتطلب بعض طلبات الأمن السيبراني والنتائج المحمية موافقة عبر Trusted Access for Cyber. للانضمام إلى البرنامج، قم بزيارة chatgpt.com/cyber.

البدء السريع

يتطلب Node.js 22.13.0 أو أحدث وPython 3.10 أو أحدث.

npm install @openai/codex-security
codex-security login
codex-security scan /path/to/directory

بالنسبة لـ CI، قم بتعيين OPENAI_API_KEY بدلاً من تسجيل الدخول.

TypeScript SDK

Codex Security هي حزمة Javascript:

import { CodexSecurity } from "@openai/codex-security";

const security = new CodexSecurity();
const result = await security.run("/path/to/directory");
await security.run("/path/to/directory", {
  mode: "deep",
  workers: 2,
  subagents: 0,
  stopAfterNoNew: 3,
  maxDiscoveryRuns: 10,
  maxTimeHours: 1.5,
});

console.log(result.reportPath);
await security.close();

الفحوصات المجمّعة داخل الحاويات

استخدم إعداد Docker Compose المضمّن لفحص العديد من المستودعات. راجع البدء السريع للحاويات لمزيد من التفاصيل.

لمراحل CLI الفردية مع حالة دائمة والوصول إلى خدمة نتائج منشورة بشكل منفصل، استخدم نفس صورة الماسح مع مثال Compose لمشغّل سير العمل.

خدمة النتائج (معاينة)

شغّل codex-security serve لبدء الخدمة بدون Docker. راجع التشغيل بدون Docker لمتطلبات التشغيل وبيانات الاعتماد وإعداد التخزين.

تعمل خدمة النتائج من نفس صورة ghcr.io/openai/codex-security المستخدمة للماسح (أو من بناء محلي من المصدر)، مع حاوية منفصلة وحجم حالة يتم إعدادهما عبر compose.findings.yaml. تخزّن النتائج والتضمينات في SQLite وتعرض النتائج مع ترقيم الصفحات. تُحدَّث لوحة المعلومات للقراءة فقط على /dashboard كل خمس ثوانٍ وتعرض النتائج المخزّنة ومجموعات التكرار من قاعدة بيانات الخدمة. كما تُرجع التكرارات المحتملة بناءً على تشابه التضمينات ضمن مستودع واحد أو نطاق صريح يشمل جميع المستودعات. يقوم الأمر codex-security publish scan --to custom --findings-url http://localhost:3000 برفع النتائج المكتملة ومعرّف المستودع الخاص بها. يسترجع كل من SDK وأمر codex-security dedupe المرشّحين، ويشغّل مراجعات Codex مستقلة محليًا، ويحفظ مجموعات التكرار المقبولة؛ ويختار --all-repositories النطاق الأوسع.

مزوّدو الخدمة الآخرون

لاستخدام مزوّد استدلال آخر، قم بتعيين مفتاح API الخاص به واختر نموذجًا:

export AWS_BEARER_TOKEN_BEDROCK="<your-bedrock-api-key>"
export AWS_REGION="us-east-2"
codex-security scan . --provider amazon-bedrock --model openai.gpt-5.6-luna

export OPENROUTER_API_KEY="<your-openrouter-api-key>"
codex-security scan . --provider openrouter --model anthropic/claude-sonnet-4.5

export FIREWORKS_API_KEY="<your-fireworks-api-key>"
codex-security scan . --provider fireworks --model accounts/fireworks/models/qwen3-235b-a22b

التوثيق

👉👉 راجع توثيق Codex Security للحصول على التوثيق الكامل.