स्कैन रिपोर्ट

रिपोर्ट बाद में समीक्षा के लिए स्कैन का दायरा, कवरेज, सत्यापन परिणाम और खोजे गए परिणाम सुरक्षित रखती हैं। किसी प्रोजेक्ट को मैन्युअल रूप से जाँचते समय HTML रिपोर्ट से शुरुआत करें:

php scanner /var/www/example --lite --report-only

डिफ़ॉल्ट रूप से स्कैनर वर्तमान डायरेक्टरी में scanner-report.html लिखता है। दूसरा स्थान चुनने के लिए --path-report=<path> का उपयोग करें।

सारांश में खोजी गई, योग्य, स्कैन की गई, कैश की गई, सत्यापित और छोड़ी गई फ़ाइलों को अलग-अलग दिखाया जाता है। इससे आप जाँच सकते हैं कि इच्छित प्रोजेक्ट कवर हुआ या नहीं। गंभीरता के योग परिणामों का सार देते हैं। सूची को सीमित करने के लिए टेक्स्ट खोज और गंभीरता फ़िल्टर का उपयोग करें, फिर कार्रवाई करने से पहले प्रत्येक मिलान को उसके स्रोत संदर्भ में जाँचें।

रिपोर्ट मोड

विकल्प	व्यवहार
--report	रिपोर्ट सहेजता है और इंटरैक्टिव कार्रवाइयाँ बनाए रखता है
--report-only, -r	रिपोर्ट सहेजता है और इंटरैक्टिव कार्रवाइयाँ बंद करता है
--disable-report, --no-report	रिपोर्ट बनाना रोकता है

पहले स्कैन या ऐसे स्वचालित कार्य के लिए --report-only उपयोग करें जिसे स्कैन की गई फ़ाइलों में बदलाव नहीं करना चाहिए।

रिपोर्ट प्रारूप

--report-format=<format> से प्रारूप चुनें:

प्रारूप	उपयोग
html	हल्की और गहरी थीम, खोज और गंभीरता फ़िल्टर के साथ ब्राउज़र समीक्षा
txt	टर्मिनल और साधारण टेक्स्ट आर्काइव के लिए पोर्टेबल सारांश
json	स्क्रिप्ट और स्वचालित प्रोसेसिंग के लिए विस्तृत परिणाम
sarif	Static Analysis Results Interchange समर्थित टूल में आयात

उदाहरण के लिए, कस्टम पथ पर JSON रिपोर्ट बनाएँ:

php scanner /var/www/example --lite --report-only \
  --report-format=json \
  --path-report=/var/reports/amwscan.json

पहले कवरेज जाँचें

स्कैनर लक्ष्य के कुछ हिस्से छोड़ दे तो भी रिपोर्ट में कोई परिणाम नहीं हो सकता। परिणाम को साफ़ मानने से पहले कवरेज योग और छोड़ने के कारण जाँचें। आर्काइव सीमा, अपठनीय फ़ाइलें, पथ फ़िल्टर, एक्सटेंशन और फ़ाइल आकार सीमा कवरेज घटा सकती हैं।

रिपोर्ट में स्थानीय पथ और मिला हुआ कोड हो सकता है। उन्हें सार्वजनिक दस्तावेज़ रूट से बाहर रखें और बिल्ड आर्टिफैक्ट के रूप में रखने या किसी अन्य समीक्षक के साथ साझा करने पर पहुँच सीमित करें।

रिपोर्ट और लॉग के सभी विकल्पों के लिए CLI कमांड संदर्भ देखें।