programmatically

sidebar_position: 1 sidebar_label: अवलोकन title: PHP SDK का अवलोकन description: PHP Antimalware Scanner के लिए समर्थित PHP API इंस्टॉल करें और उसका उपयोग करें।

जब आपके एप्लिकेशन को स्कैन शुरू करना हो, उसकी संरचित रिपोर्ट का उपयोग करना हो, या अंतर्निहित सिग्नेचर इंडेक्स से क्वेरी करनी हो, तो PHP SDK का उपयोग करें। समर्थित API में AMWScan\Scanner और केवल-पढ़ने-योग्य AMWScan\Signatures लुकअप विधियां शामिल हैं।

इंस्टॉल और लोड करें

Composer के साथ पैकेज इंस्टॉल करें और SDK का उपयोग करने से पहले Composer का autoloader लोड करें:

composer require marcocesarato/amwscan

require __DIR__ . '/vendor/autoload.php';

use AMWScan\Scanner;

पैकेज के लिए fileinfo, json, mbstring, और zlib एक्सटेंशन के साथ PHP 7.4 या बाद का संस्करण आवश्यक है। समर्थित परिवेशों के लिए आवश्यकताएं देखें।

एंट्री पॉइंट चुनें

आवश्यकता	API	परिणाम
फ़ाइलों या प्रोजेक्ट को स्कैन करना	Scanner::run()	stdClass स्कैन रिपोर्ट या पकड़ी गई स्कैन त्रुटि पर false
स्कैन पूरा होने के बाद उसका परिणाम पढ़ना	Scanner::getReport()	वर्तमान stdClass स्कैन रिपोर्ट
सटीक SHA-256 मैलवेयर हैश जांचना	Signatures::findKnownMalwareHash()	मिलान रिकॉर्ड या null
पुराने सामान्यीकृत फ़ाइल हैश की जांच करना	Signatures::matchesLegacyCoreFile()	bool
अंतर्निहित संदिग्ध डोमेन संकेतकों की सूची बनाना	Signatures::getDomainIndicators()	संकेतक रिकॉर्ड की ऐरे

स्कैन निष्पादन एकीकृत करने से पहले Scanner के साथ स्कैन करें पढ़ें। परिणामों को सहेजने या उन पर चेतावनी देने से पहले रिपोर्ट और फाइंडिंग्स पढ़ें।

न्यूनतम अनअटेंडेड स्कैन

use AMWScan\Scanner;

$scanner = new Scanner();
$report = $scanner
    ->enableLiteMode()
    ->setSilentMode()
    ->setAutoSkip()
    ->run([__DIR__ . '/project']);

if ($report === false) {
    throw new RuntimeException($scanner->getLastError() ?: 'Scan failed.');
}

printf("Scanned: %d; findings: %d\n", $report->scanned, $report->detected);

setSilentMode() गैर-इंटरैक्टिव संचालन कॉन्फ़िगर करता है और जब तक आप कोई दूसरा प्रॉम्प्ट सेट न करें, तब तक skip को डिफ़ॉल्ट कार्रवाई के रूप में चुनता है। यह अपने-आप स्कैन को केवल-पढ़ने-योग्य नहीं बनाता। स्वचालित सुधार को तब तक अक्षम रखें जब तक आपने प्रतिनिधि रिपोर्ट की समीक्षा नहीं कर ली हो।

API स्थिरता

Scanner और इस खंड में प्रलेखित लुकअप विधियां समर्थित एकीकरण सतह बनाती हैं। Archive, Checkpoint, Console, Findings, Integrity, Modules, Remote, और Reputation के अंतर्गत की क्लासें स्कैनर के आंतरिक भागों का समर्थन करती हैं। अपने एप्लिकेशन को उनसे या Scanner::$settings और Signatures::$raw जैसी सार्वजनिक स्थिर प्रॉपर्टी से न जोड़ें।

स्कैनर कॉन्फ़िगरेशन और रिपोर्ट को स्थिर स्थिति में रखता है। एक PHP प्रक्रिया को एक समय में एक स्कैन चलाना चाहिए। समवर्ती जॉब, क्यू किए गए स्कैन, या टेनेंट के बीच अलगाव के लिए अलग प्रक्रिया का उपयोग करें। किसी वर्कर या लंबे समय तक चलने वाली वेब प्रक्रिया में SDK चलाने से पहले सुरक्षा और स्थिति पढ़ें।

संदर्भ मानचित्र

संदर्भ	सामग्री
Scanner के साथ स्कैन करें	कंस्ट्रक्टर, लाइफसाइकल, विकल्प, फ़िल्टर, आउटपुट, और सुधार नियंत्रण
रिपोर्ट और फाइंडिंग्स	रिपोर्ट स्कीमा, कवरेज स्थिति, फाइंडिंग्स, डायग्नोस्टिक्स, और विफलता प्रबंधन
सिग्नेचर लुकअप	हैश और डोमेन लुकअप कॉन्ट्रैक्ट
सुरक्षा और स्थिति	स्थिति की अवधि, विनाशकारी क्रियाएं, नेटवर्क व्यवहार, और परिनियोजन मार्गदर्शन