Richkit

Richkit एक python3 पैकेज है जो डोमेन नाम को इनपुट के रूप में लेने और उस डोमेन पर अतिरिक्त जानकारी लौटाने वाले उपकरण प्रदान करता है। यह डोमेन का विश्लेषण, डेटाबेस से प्राप्त जानकारी, अन्य सेवाओं से लाया गया डेटा, या इनका संयोजन हो सकता है।

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

दस्तावेज़ीकरण https://richkit.readthedocs.io/en/latest/ पर पाया जा सकता है।

आवश्यकताएँ

• Python >= 3.5

स्थापना

Richkit को स्थापित करने के लिए टर्मिनल में pip install richkit टाइप करें।

उपयोग

निम्नलिखित कोड का उपयोग क्रमशः TLD और URL श्रेणी प्राप्त करने के लिए किया जा सकता है।

• किसी दिए गए URL का प्रभावी शीर्ष-स्तरीय डोमेन प्राप्त करना:

  root@kitploit:~

  >>> from richkit.analyse import tld
  >>> urls = ["www.aau.dk","www.github.com","www.google.com"]
  >>>
  >>> for url in urls:
  ...     print(tld(url))
  dk
  com
  com
  
  

• किसी दिए गए URL की श्रेणी प्राप्त करना:

  root@kitploit:~

  >>> from richkit.retrieve.symantec import fetch_from_internet
  >>> from richkit.retrieve.symantec import LocalCategoryDB
  >>>
  >>> urls = ["www.aau.dk","www.github.com","www.google.com"]
  >>>
  >>> local_db = LocalCategoryDB()
  >>> for url in urls:
  ...     url_category=local_db.get_category(url)
  ...     if url_category=='':
  ...         url_category=fetch_from_internet(url)
  ...     print(url_category)
  Education
  Technology/Internet
  Search Engines/Portals
  
  

मॉड्यूल्स

Richkit निम्नलिखित मॉड्यूल्स द्वारा वर्गीकृत फ़ंक्शंस का एक सेट परिभाषित करता है:

• richkit.analyse: यह मॉड्यूल डोमेन नाम पर लागू किए जा सकने वाले फ़ंक्शंस प्रदान करता है। richkit.lookup के समान, और richkit.retrieve के विपरीत, यह डोमेन नाम को तीसरे पक्ष को प्रकट किए बिना और गोपनीयता भंग किए बिना किया जाता है।

• richkit.lookup: यह मॉड्यूल स्थानीय संसाधनों में डोमेन नामों को खोजने की क्षमता प्रदान करता है, अर्थात डोमेन नाम को तीसरे पक्ष को नहीं भेजा जा सकता है। मॉड्यूल संसाधनों, जैसे सूचियों या डेटाबेस को ला सकता है, लेकिन यह इस तरह से किया जाना चाहिए कि डोमेन नाम गोपनीय रहे। इसे richkit.retrieve से विपरीत देखें।

• richkit.retrieve: यह मॉड्यूल किसी भी प्रकार के डोमेन नामों पर डेटा प्राप्त करने की क्षमता प्रदान करता है। यह richkit.lookup के "गोपनीयता अनुबंध" के बिना आता है।

Docker पर परीक्षण चलाएँ

पर्यावरण से संबंधित किसी भी समस्या से बचने के लिए, हम Dockerfile.test फ़ाइल प्रदान कर रहे हैं जो मूल रूप से Richkit के परीक्षण चलाने के लिए एक Docker इमेज बनाती है।

• केवल एक चीज़ जोड़नी है वह है .github/local-test/run-test.sh की पंक्ति 3 में MAXMIND_LICENCE_KEY। lookup मॉड्यूल के परीक्षण मामलों को पास करने के लिए यह आवश्यक है।

Docker वातावरण में परीक्षण करने के आदेश:

• docker build -t richkit-test -f Dockerfile.test . : परीक्षण मामले चलाने के लिए आवश्यक इमेज बनाता है

• docker run -e MAXMIND_LICENSE_KEY="<licence-key> " richkit-test : Docker इमेज में run-test.sh फ़ाइल चलाता है

योगदान

योगदान का स्वागत है।

हम gitflow शाखाकरण रणनीति का उपयोग करते हैं, इसलिए यदि आप इस रिपॉजिटरी में एक शाखा धकेलने की योजना बनाते हैं तो कृपया उसका पालन करें। ध्यान दें कि हम शाखा नामों की जाँच .githooks/check-branch-name.py से करते हैं। Git प्री-कमिट हुक का उपयोग कमिट पर स्वचालित रूप से जाँच करने के लिए किया जा सकता है। एक उदाहरण जो निम्नानुसार सीधे उपयोग किया जा सकता है, लिनक्स पर उपलब्ध है, और इसे इस प्रकार सक्षम किया जा सकता है (python>=3.6 और bash मानते हुए):

ln -s $(pwd)/.githooks/pre-commit.linux.sample $(pwd)/.git/hooks/pre-commit

श्रेय

• लोगो indepedenthand द्वारा डिज़ाइन किया गया