KcMapper

KcMapper एक टूल है जो Keycloak कॉन्फ़िगरेशन डेटा को Neo4j ग्राफ़ डेटाबेस में निर्यात करता है। यह प्रस्तुति realms, clients, users, groups और roles के बीच संबंधों के विश्लेषण की अनुमति देती है। टूल में विश्लेषण और सुरक्षा ऑडिटिंग के लिए पूर्व-निर्धारित Cypher क्वेरी चलाने हेतु एक वेब इंटरफ़ेस शामिल है।

विशेषताएँ

• सम्पूर्ण निर्यात: realms, clients, roles (composites सहित), groups (पदानुक्रम सहित), users, client scopes, mappers और authentication flows निकालता है।
• ग्राफ़ मॉडलिंग: Keycloak कॉन्फ़िगरेशन को Neo4j में ग्राफ़ के रूप में प्रस्तुत करता है।
• इंटरैक्टिव विश्लेषण: निर्यात किए गए डेटा पर पूर्व-निर्धारित विश्लेषण क्वेरी चलाने के लिए एक स्थानीय वेब इंटरफ़ेस प्रदान करता है।
• सुरक्षा ऑडिटिंग: संभावित कमज़ोर सुरक्षा कॉन्फ़िगरेशन की पहचान करने में सहायता के लिए क्वेरी शामिल करता है।
• विस्तार योग्य: webapp/queries.json फ़ाइल को संशोधित करके कस्टम विश्लेषण क्वेरी जोड़ी जा सकती हैं।

इंस्टॉलेशन और उपयोग

यह मार्गदर्शिका KcMapper की स्थानीय इंस्टॉलेशन को कवर करती है। इस विधि के लिए आपको अपनी मशीन पर Python और Neo4j इंस्टॉल करना आवश्यक है।

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

• Python 3.9+
• एक चालू Neo4j इंस्टेंस (Community या Desktop)।

Neo4j इंस्टॉलेशन (Debian/Ubuntu के लिए उदाहरण)

आप इन चरणों का पालन करके Neo4j Community Edition इंस्टॉल कर सकते हैं:

# Add the Neo4j GPG key
wget -O - https://debian.neo4j.com/neotechnology.gpg.key | sudo apt-key add -

# Add the Neo4j repository
echo 'deb https://debian.neo4j.com stable 5' | sudo tee /etc/apt/sources.list.d/neo4j.list

# Update packages and install Neo4j
sudo apt-get update
sudo apt-get install neo4j -y

# Start the Neo4j service
sudo systemctl start neo4j

इंस्टॉलेशन के बाद, अपने ब्राउज़र में http://localhost:7474 पर जाएँ और प्रारंभिक पासवर्ड सेट करें (डिफ़ॉल्ट neo4j/neo4j है)।

अन्य सिस्टम (Windows, macOS, आदि) के लिए:

• Neo4j Desktop: यह सबसे सरल विकल्प है। Neo4j Desktop डाउनलोड और इंस्टॉल करें, जो आपके डेटाबेस प्रबंधित करने के लिए एक ग्राफ़िकल इंटरफ़ेस प्रदान करता है।
• अन्य Linux इंस्टॉलेशन: Neo4j इंस्टॉलेशन पेज पर दिए गए आधिकारिक निर्देशों का पालन करें।

कॉन्फ़िगरेशन

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

   root@kitploit:~

   git clone https://github.com/synacktiv/kcmapper.git
   cd kcmapper
   

2. Python वर्चुअल वातावरण सेट करें (अनुशंसित)

   root@kitploit:~

   python -m venv venv
   source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
   

3. निर्भरताएँ इंस्टॉल करें

   root@kitploit:~

   pip install -r requirements.txt
   

4. पर्यावरण चर कॉन्फ़िगर करें .env.example फ़ाइल को .env में कॉपी करें।

   root@kitploit:~

   cp .env.example .env
   

   अपने Keycloak इंस्टेंस और अपने स्थानीय Neo4j डेटाबेस की ओर इंगित करने के लिए .env फ़ाइल को संशोधित करें।

   root@kitploit:~

   # --- Keycloak Connection ---
   KEYCLOAK_URL=http://your-keycloak-server:8080/
   KEYCLOAK_USER=admin
   KEYCLOAK_PASSWORD=your_keycloak_admin_password
   # Optional - for confidential clients
   KEYCLOAK_CLIENT_SECRET=
   # Optional - for users with 2FA enabled
   KEYCLOAK_TOTP=
   # Optional - for mTLS authentication
   KEYCLOAK_CERT_PATH=
   
   # --- Neo4j Connection (for local environment) ---
   NEO4J_URI=bolt://localhost:7687
   NEO4J_USER=neo4j
   NEO4J_PASSWORD=your_local_neo4j_password
   

उपयोग

1. डेटा निर्यात करें अपने Neo4j डेटाबेस को भरने के लिए export कमांड चलाएँ।

   root@kitploit:~

   python kcmapper_cli.py export
   

   • नए निर्यात से पहले डेटाबेस को साफ़ करने के लिए, --clean विकल्प का उपयोग करें:
     root@kitploit:~

     python kcmapper_cli.py export --clean
     

2. डेटा का विश्लेषण करें निर्यात पूरा हो जाने पर, वेब विश्लेषण इंटरफ़ेस लॉन्च करें।

   root@kitploit:~

   python kcmapper_cli.py analyze
   

   • सर्वर डिफ़ॉल्ट रूप से http://127.0.0.1:5001 पर उपलब्ध होगा।

आर्किटेक्चर

• kcmapper_cli.py: मुख्य कमांड-लाइन प्रवेश बिंदु।
• /processors: प्रत्येक Keycloak ऑब्जेक्ट प्रकार के लिए निष्कर्षण और लोडिंग तर्क शामिल करता है।
• /utils: उपयोगिता फ़ंक्शन, मुख्य रूप से Neo4j कनेक्शन और डेटा सफाई के लिए।
• /webapp: डेटा विश्लेषण के लिए Flask वेब एप्लिकेशन शामिल करता है।

योगदान

योगदान का स्वागत है। बग रिपोर्ट करने या नई सुविधा सुझाने के लिए स्वतंत्र रूप से एक issue खोलें। नई विश्लेषण क्वेरी जोड़ने के लिए, webapp/queries.json फ़ाइल को संशोधित करें और एक pull request सबमिट करें।

लाइसेंस

यह प्रोजेक्ट MIT लाइसेंस के तहत लाइसेंस प्राप्त है। विवरण के लिए LICENSE फ़ाइल देखें।