
WuppieFuzz v1.7.1
LibAFL के ऊपर विकसित एक कवरेज-निर्देशित REST API फ़ज़र
WuppieFuzz v1.8.1
TNO ने WuppieFuzz विकसित किया है, जो LibAFL के ऊपर विकसित एक कवरेज-निर्देशित REST API फ़ज़र है, जो अंतिम-उपयोगकर्ताओं के व्यापक दर्शक-वर्ग को लक्षित करता है, और जिसमें उपयोग में आसानी, खोजे गए दोषों की व्याख्या-क्षमता तथा मॉड्यूलरता पर विशेष ध्यान दिया गया है। WuppieFuzz परीक्षण की तीनों शैलियों (ब्लैक बॉक्स, ग्रे बॉक्स और व्हाइट बॉक्स) का समर्थन करता है।
[!NOTE]
त्वरित, साथ-साथ चलने वाले मार्गदर्शन के लिए कृपया ट्यूटोरियल का पालन करें!
मीडिया कवरेज
WuppieFuzz को इनमें प्रदर्शित किया गया है:
- The ONE Conference e-magazine 2024
- Test your APIs easily with TNO's new REST API fuzzer
- OpenAPI.tools listing: WuppieFuzz
- Automated REST API Vulnerability Detection with WuppieFuzz (Nordic APIs on YouTube)
- Thoughtworks Technology Radar: WuppieFuzz
वैज्ञानिक प्रकाशन
यदि आप शैक्षणिक कार्य में WuppieFuzz का उद्धरण देना चाहते हैं, तो कृपया CITATION.cff में सूचीबद्ध पसंदीदा प्रकाशन का उपयोग करें:
Rooijakkers, T., Nijsten, A., Daniele, C., Weitenberg, E., Groenewegen, R., & Melissen, A. (2026). WuppieFuzz: Coverage-Guided, Stateful REST API Fuzzing. In Proceedings of the 12th International Conference on Information Systems Security and Privacy (ICISSP), Volume 2, 221-231. SciTePress. https://doi.org/10.5220/0000217100004061
लाइसेंस
WuppieFuzz Apache-2.0 के अंतर्गत लाइसेंस प्राप्त है; देखें LICENSE।
तृतीय-पक्ष लाइसेंस सूचनाएँ THIRD_PARTY_NOTICES में सूचीबद्ध हैं।
त्वरित इंस्टॉल
लोकप्रिय ऑपरेटिंग सिस्टम (MacOS, Windows, Linux) के लिए WuppieFuzz की त्वरित स्थापना हेतु देखें releases या उपयोग करें brew install wuppiefuzz
Docker
आप docker build . -t wuppiefuzz:local के साथ docker इमेज बना सकते हैं। इसका उपयोग करने के लिए, आपको अपने openapi स्पेक वाला एक फ़ोल्डर माउंट करना होगा। जब आप स्थानीय रूप से (Docker में नहीं) चल रही किसी सेवा को फ़ज़ कर रहे हों, तो आपको होस्ट नेटवर्किंग निर्दिष्ट करनी होगी:
docker run \
--network host \
-v ./fuzzing-folder:/fuzzing-folder \ # The folder will be populated with wuppiefuzz outputs
-w /fuzzing-folder \
wuppiefuzz:local fuzz --timeout 60 --report openapi.json
संक्षिप्त कैसे-करें
विकास के लिए पूर्वापेक्षाएँ
प्रोजेक्ट बनाने के लिए आपको निम्नलिखित निर्भरताएँ और टूलिंग इंस्टॉल करनी होंगी:
sudo apt install -y build-essential pkg-config cmake # General build tools
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh # Rust
चलाएँ
WuppieFuzz चलाने से पहले, आपको अपना (इंस्ट्रूमेंटेड) लक्ष्य एप्लिकेशन शुरू करना होगा।
इसके अतिरिक्त, आपको WuppieFuzz को एक OpenAPI-विनिर्देश प्रदान करना होगा ताकि उसे पता हो कि उसके अनुरोधों को कैसे उत्पन्न और परिवर्तित करना है। कमांड लाइन तर्कों के लिए सहायता हेतु, निम्नलिखित का उपयोग करें:
$ cargo run -- --help # shows help for required parameters and flags
Usage: wuppiefuzz [OPTIONS] [OPENAPI_SPEC.YAML]
...
उदाहरण के लिए, JaCoCo एजेंट संलग्न किए गए Java लक्ष्य के विरुद्ध WuppieFuzz चलाने के लिए, आप उसकी OpenAPI फ़ाइल निर्दिष्ट करते हैं (जिसमें API विनिर्देश में वह URL होता है जिस पर लक्ष्य चल रहा है)। इसके अतिरिक्त, आप निर्दिष्ट करते हैं कि कवरेज प्रारूप JaCoCo है, और classes निर्देशिका इस प्रकार देते हैं:
cargo run -- fuzz openapi.yaml --coverage-format jacoco --jacoco-class-dir ../Targets/app/target/classes/
कॉन्फ़िगरेशन फ़ाइल
यदि आप कमांड लाइन आर्ग्युमेंट्स के बजाय/के साथ-साथ कॉन्फ़िगरेशन फ़ाइल का उपयोग करना चाहते हैं, तो आप --config <CONFIG_FILE> फ़्लैग का उपयोग कर सकते हैं। यदि आप कमांड लाइन आर्ग्युमेंट्स का उपयोग कॉन्फ़िगरेशन फ़ाइल के साथ करते हैं, तो कमांड लाइन आर्ग्युमेंट्स को प्राथमिकता मिलती है।
कॉन्फ़िगरेशन फ़ाइल एक yaml फ़ाइल होनी चाहिए और इसमें प्रत्येक कमांड लाइन आर्ग्युमेंट के लिए एक पंक्ति होनी चाहिए जिसे आप निर्दिष्ट करना चाहते हैं, उदाहरण के लिए:
coverage_format: jacoco
output_format: human-readable
source_dir: "/swagger-petstore/src/main/java"
jacoco_class_dir: "/swagger-petstore/target"
timeout: 20
इस मामले में एक उदाहरण रन कमांड यह हो सकता है:
$ cargo run -- fuzz --config=config.yaml --report --coverage-host=localhost:6300 --timeout=10 ./openapi.yaml
यह पंक्ति कमांड लाइन और कॉन्फ़िग फ़ाइल दोनों से आर्ग्युमेंट्स को संयोजित करेगी। चूँकि --timeout फ़्लैग दोनों में निर्दिष्ट है, कमांड लाइन में निर्दिष्ट टाइमआउट (10 सेकंड) को प्राथमिकता मिलेगी।
निर्देशिका example_configs/ में आपको दो उदाहरण कॉन्फ़िग फ़ाइलें मिलेंगी, जिनका उपयोग Java कोड के लिए JaCoCo के साथ कवरेज रिपोर्ट बनाने और Python कोड के लिए LCOV के साथ कवरेज रिपोर्ट बनाने के लिए किया जा सकता है।
रिपोर्ट्स
जब आप WuppieFuzz को --report फ़्लैग के साथ चलाते हैं, तो reports/ के अंदर एक उपनिर्देशिका बनाई जाती है जिसका नाम टाइमस्टैम्प होता है। सभी समर्थित कवरेज रिपोर्ट इस उपनिर्देशिका में लिखी जाती हैं। कवरेज रिपोर्ट दो प्रकार की होती हैं:
- endpoint coverage: इसे हमेशा जनरेट किया जा सकता है क्योंकि इसके लिए केवल OpenAPI-spec की आवश्यकता होती है।
- code coverage: वर्तमान में केवल JaCoCo के लिए समर्थित है, लेकिन हमारा लक्ष्य अधिक का समर्थन करना है। कठिनाई इस बात में है कि इसके लिए कवरेज से स्रोत फ़ाइलों तक एक मैपिंग की आवश्यकता होती है, और इसका उपयोग करने वाली मज़बूत रिपोर्ट जनरेशन की भी।
इसके अतिरिक्त, एक डेटाबेस आपके फ़ज़िंग अभियान से संबंधित सभी अनुरोध जानकारी से भरा जाता है। इस डेटाबेस को Grafana डैशबोर्ड के माध्यम से विज़ुअलाइज़ और एक्सप्लोर किया जा सकता है।
Web Fuzzing Commons (WFC) रिपोर्ट
वही --report फ़्लैग reports/<timestamp> निर्देशिका में एक report.json फ़ाइल भी लिखता है, जो Web Fuzzing Commons रिपोर्ट स्कीमा का पालन करती है, जिससे परिणामों को WFC-संगत टूलिंग द्वारा उपभोग किया जा सके। यह जनरेट किए गए टेस्ट केसों, कवर किए गए एंडपॉइंट्स और HTTP स्टेटस कोड्स, पाई गई किसी भी गड़बड़ी (वैलिडेशन त्रुटियों), और बुनियादी कवरेज आँकड़ों का सारांश प्रदान करती है (कोड कवरेज केवल तब शामिल होती है जब कोई कवरेज एजेंट - जैसे JaCoCo - कॉन्फ़िगर किया गया हो; ब्लैक-बॉक्स/केवल-एंडपॉइंट मोड में केवल endpoint coverage की रिपोर्ट की जाती है)।
इस रिपॉज़िटरी की संरचना
- assets: लोगो, छवियाँ, आदि।
- coverage_agents: विभिन्न लक्ष्यों पर लगाने के लिए कवरेज ट्रैकिंग का कोड और निर्देश
- example_configs: WuppieFuzz को कॉन्फ़िगर करने के लिए उदाहरण कॉन्फ़िगरेशन फ़ाइलें
- src: WuppieFuzz का स्रोत कोड
- tutorial: किसी विशिष्ट लक्ष्य को फ़ज़ कैसे करें और फ़ज़िंग परिणामों की व्याख्या कैसे करें, इस पर एक गहन और निम्न-स्तरीय ट्यूटोरियल
- dashboard: फ़ज़िंग परिणामों और प्रदर्शन के ट्राइएज के लिए टूलिंग
इनमें से प्रत्येक के बारे में अधिक जानकारी के लिए, इन निर्देशिकाओं में README देखें।
