Cartographer

कोड कवरेज का मानचित्रण

Austin Peavy द्वारा विकसित - https://github.com/aus10pv

NCC Group Plc द्वारा ओपन सोर्स के रूप में जारी - https://www.nccgroup.com/
Apache 2.0 लाइसेंस के अंतर्गत जारी (अधिक जानकारी के लिए LICENSE देखें)

विवरण

Cartographer, Ghidra के लिए एक कोड कवरेज मैपिंग प्लगइन है, जो शोधकर्ताओं को सोर्स कोड की आवश्यकता के बिना यह देखने में सक्षम बनाता है कि प्रोग्राम के कौन से हिस्से निष्पादित किए गए हैं।

विषय-सूची

• मुख्य विशेषताएँ
• स्थापना
  • प्लगइन लोड करना
• उपयोग
  • कोड कवरेज फ़ाइलें लोड करना
  • कोड कवरेज विवरण
  • कवरेज के बीच स्विच करना
  • एक्सप्रेशन पार्सर
    • सिंटैक्स
    • उदाहरण
• योगदान
  • स्रोत से निर्माण
  • बग की रिपोर्ट करना
• श्रेय

मुख्य विशेषताएँ

• निष्पादित कोड को रंगीन करता है
  • फ़ंक्शन ग्राफ़
  • डिसअसेंबली (लिस्टिंग) दृश्य
  • डीकंपाइलर दृश्य
• पूरी तरह से अनुकूलन योग्य रंग
• Ghidra थीम का समर्थन करता है
• DRCOV फ़ाइलें और कस्टम EZCOV फ़ाइलें लोड करता है
  • EZCOV प्रारूप के विवरण के लिए EZCOV.md देखें
• फ़ंक्शन कवरेज का विस्तृत अवलोकन प्रदान करता है
  • इसमें हीट मैप शामिल है जो दिखाता है कि प्रत्येक फ़ंक्शन का कितना हिस्सा निष्पादित किया गया था
• लोड की गई कवरेज फ़ाइलों के बीच आसानी से स्विच करें
• नाम से फ़ंक्शन खोजें
• कवरेज मात्रा और अन्य मानदंडों द्वारा परिणाम फ़िल्टर करें
• शक्तिशाली एक्सप्रेशन पार्सर
  • कई लोड की गई कवरेज पर तार्किक संचालन करें
• विभिन्न एड्रेस स्पेस में कवरेज का समर्थन करता है

स्थापना

Cartographer का नवीनतम स्थिर संस्करण Releases पृष्ठ से डाउनलोड किया जा सकता है।

प्लगइन लोड करना

1. Ghidra लॉन्च करें।
2. इंस्टॉल एक्सटेंशन विंडो पर जाएँ।
   • File -> Install Extensions...
3. ऊपरी-दाएँ कोने में हरे "+" आइकन पर क्लिक करें।
4. Ghidra में प्लगइन लोड करने के लिए डाउनलोड की गई ZIP फ़ाइल चुनें।
5. इंस्टॉल एक्सटेंशन विंडो से बाहर निकलने के लिए "OK" बटन पर क्लिक करें।
6. संकेत मिलने पर Ghidra को पुनरारंभ करें।

उपयोग

प्लगइन लोड होने के बाद, कोड कवरेज डेटा के साथ काम करने के लिए CodeBrowser विंडो में अतिरिक्त नियंत्रण होंगे।

कोड कवरेज फ़ाइलें लोड करना

कोड कवरेज फ़ाइलें टूल्स मेनू के माध्यम से लोड की जा सकती हैं: Tools -> Code Coverage -> Load Code Coverage File(s)...

जब कोई कोड कवरेज फ़ाइल लोड की जाती है, तो सभी कवरेज डेटा तुरंत Listing दृश्य और Decompiler दृश्य में हाइलाइट हो जाता है।

कोड कवरेज विवरण

प्रत्येक फ़ंक्शन के कवरेज डेटा के बारे में विस्तृत जानकारी Code Coverage विंडो में पाई जा सकती है।

Code Coverage विंडो को Window -> Code Coverage पर नेविगेट करके, या Windows पर Ctrl-Shift-C दबाकर (Mac पर Cmd-Shift-C) खोला जा सकता है।

यह विंडो प्रोग्राम में प्रत्येक फ़ंक्शन के बारे में विभिन्न विवरण दिखाती है:

• Coverage %: फ़ंक्शन का वह प्रतिशत जो निष्पादित किया गया था
• Name: फ़ंक्शन का नाम
• Address: फ़ंक्शन का पता (एंट्री पॉइंट)
• Blocks Hit: निष्पादित बेसिक ब्लॉकों की संख्या
• Instructions Hit: निष्पादित निर्देशों की संख्या
• Function Size: बाइट्स में फ़ंक्शन का आकार

किसी भी फ़ंक्शन पर क्लिक करने से Listing दृश्य और Decompiler दृश्य में उस विशिष्ट फ़ंक्शन पर नेविगेट किया जाएगा।

खोजना और फ़िल्टर करना

Filter इनपुट बॉक्स का उपयोग नाम से फ़ंक्शन खोजने के लिए किया जा सकता है।

कवरेज तालिका में प्रदर्शित किसी भी डेटा को कॉलम फ़िल्टर के रूप में उपयोग किया जा सकता है।

कवरेज के बीच स्विच करना

Code Coverage विंडो के निचले-दाएँ कोने में स्थित ड्रॉपडाउन का उपयोग लोड की गई कोड कवरेज फ़ाइलों के बीच जल्दी और आसानी से स्विच करने के लिए किया जा सकता है।

एक्सप्रेशन पार्सर

Code Coverage विंडो के नीचे स्थित टेक्स्ट बॉक्स का उपयोग लोड की गई कोड कवरेज फ़ाइलों पर तार्किक संचालन करने के लिए किया जा सकता है।

यह एक प्रोग्राम के विभिन्न रनों के बीच अंतर और समानताओं की जाँच करने के लिए अत्यंत उपयोगी हो सकता है।

सिंटैक्स

नीचे तार्किक ऑपरेटर दिए गए हैं जिनका उपयोग एक्सप्रेशन पार्सर के भीतर किया जा सकता है।

• &: दोनों कवरेज द्वारा निष्पादित केवल कोड प्राप्त करता है
• |: किसी भी कवरेज द्वारा निष्पादित कोई भी कोड प्राप्त करता है
• ^: कवरेज के बीच भिन्न निष्पादित कोड केवल प्राप्त करता है
• -: बाएँ-हाथ वाले कवरेज के लिए अद्वितीय केवल निष्पादित कोड प्राप्त करता है

कवरेज को ड्रॉपडाउन मेनू में उनके वर्णानुक्रमिक आईडी द्वारा संदर्भित किया जाता है, जैसे A, B, XY, आदि।

प्रत्येक तार्किक ऑपरेशन को कोष्ठकों का उपयोग करके समूहीकृत किया जाता है, और एक्सप्रेशन किसी भी लंबाई या जटिलता के हो सकते हैं।

उदाहरण

1. दोनों कवरेज A और B में निष्पादित कोड दिखाएँ:

   A & B
   

2. कवरेज A और B के बीच भिन्न निष्पादित कोड दिखाएँ:

   A ^ B
   

3. वह कोड दिखाएँ जो केवल B में निष्पादित किया गया था:

   B - A
   

4. A और B में पाया गया सभी कवरेज डेटा संयोजित करें, फिर C से कोई भी अंतर खोजें:

   (A | B) ^ C
   

योगदान

स्रोत से निर्माण

स्रोत कोड से Cartographer बनाने के लिए Gradle का उपयोग किया जा सकता है।

1. Cartographer GitHub रिपॉजिटरी को क्लोन करें।

   $ git clone https://github.com/nccgroup/Cartographer.git
   

2. रिपॉजिटरी में प्रवेश करें और gradle के साथ बनाएँ।

   $ cd Cartographer
   $ gradle -PGHIDRA_INSTALL_DIR=<ghidra_install_dir>
   

   • <ghidra_install_dir> को अपने स्थानीय Ghidra इंस्टॉलेशन पथ के साथ बदलें।

3. निर्माण के बाद, प्लगइन ZIP फ़ाइल dist/ फ़ोल्डर में स्थित होगी।

बग की रिपोर्ट करना

यदि आपको Cartographer में कोई बग मिला है, तो कृपया GitHub के माध्यम से एक issue खोलें।

श्रेय

मूल रूप से Lighthouse से प्रेरित - https://github.com/gaasedelen/lighthouse