अप्रचलन सूचना

प्रिय Leaktopus उपयोगकर्ताओं,

हम आपको सूचित करना चाहते हैं कि Leaktopus परियोजना को आधिकारिक रूप से अप्रचलित किया जाएगा। सावधानीपूर्वक मूल्यांकन के बाद, हमने इस लाइब्रेरी के सक्रिय विकास और रखरखाव को बंद करने का निर्णय लिया है।

इसका आपके लिए क्या मतलब है?

• कोई नई सुविधाएँ या अपडेट नहीं: हम Leaktopus में कोई नई सुविधाएँ या अपडेट नहीं जोड़ेंगे।
• सुरक्षा पैच: हम अब किसी भी कमजोरी के लिए सुरक्षा पैच या फिक्स प्रदान नहीं करेंगे।
• रिपॉजिटरी स्थिति: रिपॉजिटरी को संग्रहीत किया जाएगा, और परियोजना GitHub पर केवल-पढ़ने योग्य हो जाएगी, आज से प्रभावी।

---

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

• Plug&Play - Docker के साथ एक लाइन इंस्टॉलेशन।

• विभिन्न स्रोतों को स्कैन करें जिनमें कीवर्ड का एक सेट होता है, जैसे ORGANIZATION-NAME.com।

  वर्तमान में समर्थित:

  • GitHub
    • रिपॉजिटरीज़
    • Gists (जल्द आ रहा है)
  • पेस्ट साइट्स (जैसे, PasteBin) (जल्द आ रहा है)

• अंतर्निहित ह्यूरिस्टिक इंजन के साथ परिणामों को फ़िल्टर करें।

• IOLs (लीक के संकेतक) के साथ परिणामों को बढ़ाएँ:

  • पाए गए स्रोतों में गुप्त (Git रिपॉजिटरी कमिट इतिहास सहित):
    • Shhgit के साथ (एक अनुकूलित नियम सूची का उपयोग करके)।
    • TruffleHog के साथ।
  • URIs (आपके संगठन के डोमेन का संकेत सहित)
  • ईमेल (आपके संगठन के ईमेल पतों का संकेत सहित)
  • योगदानकर्ता
  • संवेदनशील कीवर्ड (जैसे, कैनरी टोकन, आंतरिक डोमेन)

• सार्वजनिक स्रोतों को अनदेखा करने की अनुमति देता है, (जैसे, वेब क्रॉलर्स द्वारा "जंक" रिपॉजिटरीज़)।

• सामान्य "जंक" स्रोतों की OOTB अनदेखा सूची।

• एक लीक को स्वीकार करें, और केवल तभी सूचित किया जाएगा जब पिछले स्कैन के बाद से स्रोत संशोधित किया गया हो।

• लीक में डेटा खोजने के लिए अंतर्निहित ELK (IOLs के साथ Git रिपॉजिटरीज़ का पूरा इंडेक्स शामिल है)।

• नए लीक पर सूचित करें

  • MS Teams Webhook.
  • Slack Bot.
  • Cortex XSOAR® (Palo Alto Networks द्वारा) एकीकरण (प्रगति पर)।

प्रौद्योगिकी स्टैक

• पूरी तरह से Dockerized।
• API-प्रथम Python Flask बैकएंड।
• डिकपल्ड Vue.js (3.x) फ्रंटएंड।
• SQLite DB।
• Celery + Redis कतारों के साथ अतुल्यकालिक कार्य।

आवश्यक शर्तें

• Docker-Compose

स्थापना

• रिपॉजिटरी क्लोन करें
• एक स्थानीय .env फ़ाइल बनाएँ
  root@kitploit:~

  cd Leaktopus
  cp .env.example .env
  

• अपनी स्थानीय सेटअप के अनुसार .env संपादित करें (आंतरिक टिप्पणियाँ देखें)।
• Leaktopus चलाएँ
  root@kitploit:~

  docker-compose up -d
  

• इंस्टॉलेशन API तक पहुँच कर इंस्टॉलेशन अनुक्रम शुरू करें। अपने ब्राउज़र में http://{LEAKTOPUS_HOST}:8000/api/install खोलें।
• जाँचें कि API http://{LEAKTOPUS_HOST}:8000/up पर चालू और चल रहा है।
• UI http://{LEAKTOPUS_HOST}:8080 पर उपलब्ध होना चाहिए।

Github ऐप का उपयोग करना

मूल व्यक्तिगत एक्सेस टोकन विकल्प के अतिरिक्त, Leaktopus Github ऐप प्रमाणीकरण का समर्थन करता है। बढ़ी हुई दर सीमाओं के कारण Github ऐप का उपयोग करने की अनुशंसा की जाती है।

1. Github ऐप प्रमाणीकरण का उपयोग करने के लिए, आपको एक Github ऐप बनाना होगा और इसे अपने संगठन/खाते पर स्थापित करना होगा। अधिक विवरण के लिए Github की दस्तावेज़ीकरण देखें।

2. ऐप बनाने के बाद, आपको निम्नलिखित पर्यावरण चर सेट करने होंगे:

   • GITHUB_USE_APP=True
   • GITHUB_APP_ID
   • GITHUB_INSTALLATION_ID - इंस्टॉलेशन आईडी आपके ऐप इंस्टॉलेशन में पाई जा सकती है।
   • GITHUB_APP_PRIVATE_KEY_PATH (defaults to /app/private-key.pem)

3. प्राइवेट की फ़ाइल को कंटेनर में माउंट करें (उदाहरण के लिए docker-compose.yml देखें)। ./leaktopus_backend/private-key.pem:/app/private-key.pem

* ध्यान दें कि यदि GITHUB_USE_APP को True पर सेट किया गया है तो GITHUB_ACCESS_TOKEN को अनदेखा कर दिया जाएगा।

Leaktopus को अपडेट करना

यदि आप अपने Leaktopus संस्करण को अपडेट करना चाहते हैं (नया संस्करण खींचना), तो बस अगले चरणों का पालन करें।

• नवीनतम संस्करण खींचें।
  root@kitploit:~

  git pull
  

• Docker इमेज का पुनर्निर्माण करें (डेटा नहीं हटाया जाएगा)।
  root@kitploit:~

  # Force image recreation
  docker-compose up --force-recreate --build
  

• DB अपडेट को उसके API से कॉल करके चलाएँ (कुछ अपडेट के बाद आवश्यक हो सकता है)। http://{LEAKTOPUS_HOST}/api/updatedb

परिणाम फ़िल्टरिंग ह्यूरिस्टिक इंजन

अंतर्निहित ह्यूरिस्टिक इंजन खोज परिणामों को फ़िल्टर कर रहा है ताकि गलत सकारात्मकता को कम किया जा सके:

• सामग्री:
  • गैर-संगठनात्मक डोमेन वाले X से अधिक ईमेल।
  • गैर-संगठनात्मक डोमेन वाले X से अधिक URI।
• मेटाडेटा:
  • X से अधिक सितारे।
  • X से अधिक फोर्क।
• स्रोत अनदेखा सूची।

API दस्तावेज़ीकरण

OpenAPI दस्तावेज़ीकरण http://{LEAKTOPUS_HOST}:8000/apidocs पर उपलब्ध है।

Leaktopus सेवाएँ

उपरोक्त को कस्टम docker-compose.yml फ़ाइल का उपयोग करके अनुकूलित किया जा सकता है।

सुरक्षा नोट्स

अभी के लिए, Leaktopus कोई प्रमाणीकरण तंत्र प्रदान नहीं करता है। सुनिश्चित करें कि आप इसे दुनिया के सामने उजागर नहीं कर रहे हैं, और अपने Leaktopus इंस्टेंस (ओं) तक पहुँच को प्रतिबंधित करने की पूरी कोशिश करें।

योगदान

योगदान का स्वागत है। कृपया हमारे योगदान दिशानिर्देश और दस्तावेज़ीकरण का पालन करें।