openai/codex-securityOpenAI का Codex Security CLI और TypeScript SDK सुरक्षा भेद्यताओं को खोजने, सत्यापित करने और ठीक करने के लिए। npm: https://www.npmjs.com/package/@openai/codex-security
Codex Security आपको अपने कोड में कमज़ोरियों को खोजने, जाँचने और ठीक करने में मदद करता है।
इसके सुरक्षा वर्कफ़्लो का उपयोग Codex में करें, या उन्हें
@openai/codex-security CLI और TypeScript SDK के साथ स्वचालित करें।
SECURITY.md नीतियों का मसौदा तैयार करें और बाद की समीक्षा के लिए थ्रेट मॉडल सहेजें।Codex Security प्लगइन सक्षम के साथ अपने रिपॉज़िटरी को Codex सत्र में खोलें, फिर पूछें:
इस रिपॉज़िटरी पर एक Codex Security स्कैन चलाएँ, जिसमें प्रमाणीकरण और प्राधिकरण पर ध्यान केंद्रित हो। सहेजी गई रिपोर्ट, स्रोत साक्ष्य, और कवरेज सीमाएँ लौटाएँ।
एक पूर्ण स्कैन रिपोर्ट, निष्कर्ष, कवरेज, और उपलब्ध होने पर एक थ्रेट मॉडल सहेजता है। इन परिणामों का उपयोग निष्कर्षों की जाँच करने, पैच का अनुरोध करने, या मौजूदा फ़िक्स को सत्यापित करने के लिए करें। प्लगइन सेटअप, कार्य चयन, और आवश्यक टूल्स अनुपलब्ध होने पर रिकवरी के लिए एजेंट वर्कफ़्लो गाइड देखें।
22.x के भीतर Node.js 22.13.0+, या Node.js 24.x या 26.x, और Python 3.10+ आवश्यक है।
Python 3.10 के लिए tomli भी आवश्यक है।
CLI को विश्व स्तर पर इंस्टॉल करें और साइन इन करें:
npm install --global @openai/codex-security
cs login
cs, codex-security के लिए एक छोटा उपनाम है; दोनों कमांड एक ही CLI चलाते हैं।
इंस्टॉलेशन npm की ग्लोबल एक्ज़ीक्यूटेबल डायरेक्टरी में दोनों कमांड बनाता है,
जो आपके PATH में होनी चाहिए। यदि cs पहले से किसी अन्य टूल के लिए रिज़ॉल्व होता है, तो
इसके बजाय codex-security का उपयोग करें। यदि npm cs के लिए EEXIST त्रुटि के साथ रुक जाता है, तो
ग्लोबल इंस्टॉलेशन के बिना npx @openai/codex-security का उपयोग करें।
अपना स्कैन रिपॉज़िटरी डायरेक्टरी से चलाएँ:
cs scan .
यदि आपके पास Daybreak Blue एक्सेस है, तो स्कैन कमांड में --cyber-access-program daybreak_blue जोड़ें। अन्यथा, फ़्लैग को छोड़ दें या --cyber-access-program standard का उपयोग करें।
Codex के Daybreak टॉगल का उपयोग करने के लिए, --codex daybreak=true पास करें। यह डिफ़ॉल्ट रूप से बंद रहता है और इसके लिए संगत एक्सेस आवश्यक है। SDK और प्लगइन उपयोग, जिसमें Deep Scan वर्कर शामिल हैं, के लिए Daybreak कॉन्फ़िगरेशन देखें।
स्कैन आपके मौजूदा SECURITY.md मार्गदर्शन का उपयोग करते हैं। इसे परिभाषित या अपडेट करने के लिए, वैकल्पिक रूप से एक नीति का प्रारूप तैयार करें:
cs policy .
ड्राफ़्ट आपके रिपॉज़िटरी के बाहर सहेजा गया है। diff और नोट्स की समीक्षा करें, ड्राफ़्ट को संपादित करें, फिर केवल SECURITY.md को दिखाए गए Policy target में कॉपी करें। आप पॉलिसी बनाए बिना स्कैन कर सकते हैं।
वैश्विक इंस्टॉलेशन के बिना चलाने के लिए, इन उदाहरणों में cs को npx @openai/codex-security से बदलें, उदाहरण के लिए:
npx @openai/codex-security scan .
CI के लिए, स्कैन प्रक्रिया के environment में OPENAI_API_KEY या CODEX_API_KEY सेट करें।
रिमोट या हेडलेस मशीनों पर, यदि आपका workspace अनुमति देता है तो login --device-auth का उपयोग करें, या SSH के माध्यम से साइन इन करें।
कुछ साइबरसुरक्षा अनुरोधों और संरक्षित findings के लिए Trusted Access for Cyber स्वीकृति आवश्यक है।
एक scope और scan mode चुनें:
# Scan selected paths.
cs scan . --path src --path tests
# Scan committed changes from a base revision to HEAD.
cs scan . --diff origin/main
# Run a deep scan of the repository.
cs scan . --mode deep
एक सलाहकारी 15-मिनट के Standard जाँच भत्ते के लिए cs scan . --max-time 15 का उपयोग करें। समय-निर्धारण अर्थशास्त्र और Deep Scan सीमाओं के लिए जाँच समय देखें।
कमांड ब्राउज़ करने के लिए cs --help का उपयोग करें, या स्कैन विकल्पों, लागत सीमाओं और स्कैन के बाद पैचिंग के लिए cs scan --help देखें।
कई रिपॉज़िटरी में फैले किसी एप्लिकेशन के लिए, रिपॉज़िटरी में एक सिस्टम की समीक्षा करें देखें। एक ही फिर से शुरू होने योग्य अभियान में स्वतंत्र रिपॉज़िटरी समीक्षाओं के लिए बल्क स्कैन का उपयोग करें।
स्कैन के बाद, दर्ज किए गए बहिष्करणों को समझने और यह तय करने के लिए कि निष्कर्षों की समीक्षा करनी है, केंद्रित स्कैन चलाना है, या बाधित रन को पुनर्प्राप्त करना है, इसके दायरे और अनुवर्ती कार्य का निरीक्षण करें।
अपने TypeScript प्रोजेक्ट में पैकेज को स्थानीय रूप से इंस्टॉल करें:
npm install @openai/codex-security
फिर इसे इम्पोर्ट करें:
import { CodexSecurity } from "@openai/codex-security";
const security = new CodexSecurity();
try {
const result = await security.run("/path/to/repository");
console.log(result.reportPath);
} finally {
await security.close();
}
SDK गाइड में डीप-स्कैन कॉन्फ़िगरेशन, वैलिडेशन, गंभीरता वर्गीकरण, स्वामी सुझाव और परिणाम प्रबंधन शामिल हैं।
जब Codex Security Cloud आपके खाते के लिए उपलब्ध हो, तो Security प्लगइन का
$cloud-findings स्किल Codex डेस्कटॉप या Codex CLI में findings, रिपोर्ट, रिकॉर्ड किए गए असाइनमेंट और
सत्यापन, तथा स्कैन स्थिति पढ़ सकता है। Cloud एक
वैकल्पिक कनेक्शन है; लोकल स्कैन इसके बिना भी काम करते हैं।
प्रमाणीकरण आवश्यकताओं और एक रीड-ओनली उदाहरण के लिए Cloud कनेक्शन सेटअप और CLI रीड्स देखें।
नया SECURITY.md ड्राफ़्ट करने या मौजूदा को अपडेट करने के लिए policy का उपयोग करें। किसी कंपोनेंट का चयन करने के लिए --path का उपयोग करें:
cs policy .
cs policy . --path services/api --knowledge-base architecture.md
कमांड अपना ड्राफ़्ट रिपॉज़िटरी के बाहर सहेजता है और मौजूदा फ़ाइलों को
अपरिवर्तित छोड़ देता है। diff और नोट्स की समीक्षा करें, ड्राफ़्ट को संपादित करें, फिर केवल SECURITY.md
को प्रदर्शित Policy target पर कॉपी करें। सहेजे गए आर्किटेक्चर और थ्रेट-मॉडल
दस्तावेज़ों को रिपॉज़िटरी के बाहर रखें।
स्कैन पहले से ही रूट और कंपोनेंट SECURITY.md फ़ाइलों का उपयोग करते हैं। यदि आपकी वर्तमान नीति
में कोई बदलाव की आवश्यकता नहीं है तो उसे रखें। इसे अपडेट करते समय, इसके भेद्यता-रिपोर्टिंग
निर्देशों को सुरक्षित रखें। यदि कमांड कहता है कि नीति पहले से ही अद्यतित है, तो किसी कॉपी की
आवश्यकता नहीं है।