Quipu

YARA नियम लिखने, सत्यापित करने, संकलित करने और परीक्षण करने के लिए एक डेस्कटॉप वर्कबेंच।

Quipu (उच्चारण “KEE-poo”) एक प्रोजेक्ट एक्सप्लोरर, एक YARA-सक्षम एडिटर, YARA-X कंपाइलर, और केंद्रित स्कैन परिणामों को एक ही स्थानीय एप्लिकेशन में लाता है। यह YARA-X और उसके भाषा सर्वर दोनों को एम्बेड करता है, इसलिए आपको अलग से YARA इंस्टॉलेशन की आवश्यकता नहीं है।

[!IMPORTANT] Quipu MVP चरण में है। प्रारंभिक समर्थित प्लेटफ़ॉर्म 64-बिट Linux है; Windows और macOS समर्थन बाद में आएगा।

विशेषताएँ

• .yar और .yara फ़ाइलों के फ़ोल्डर को वर्कस्पेस के रूप में खोलें, या एक स्क्रैच नियम से शुरू करें।
• अनुमानित या कॉन्फ़िगर किए गए एंट्रीपॉइंट, नेस्टेड इन्क्लूड, बाहरी इन्क्लूड, और प्रोजेक्ट समस्याओं का अन्वेषण करें।
• Monaco सिंटैक्स हाइलाइटिंग, कम्प्लीशन, हॉवर डॉक्युमेंटेशन, और लाइव YARA-X डायग्नोस्टिक्स के साथ संपादित करें।
• एक पूर्ण वर्कस्पेस संकलित करें, फिर टाइप किए गए टेक्स्ट या चयनित फ़ाइल को स्कैन करें।
• मेल खाते नियमों, पैटर्न, ऑफ़सेट, बाइट लंबाई, और हाइलाइट किए गए बाइट्स को हेक्स व्यूअर में निरीक्षण करें।
• डायग्नोस्टिक्स और मैचों से सीधे उनके स्रोत परिभाषाओं पर जाएँ।
• अपरिवर्तित संकलित रूलसेट्स को एक सीमित स्थानीय कैश से पुनर्स्थापित करें।
• एप्लिकेशन के साथ शामिल छोटे, स्व-निहित उदाहरण प्रोजेक्ट्स के एक सेट से काम करें।

नियम और स्कैन लक्ष्य स्थानीय रूप से संसाधित होते हैं। Quipu उनकी सामग्री को किसी दूरस्थ सेवा पर नहीं भेजता है।

Linux पर इंस्टॉल करें

Linux x86-64 पैकेज GitHub Releases पृष्ठ पर प्रकाशित किए जाते हैं:

पैकेज	किसके लिए सर्वोत्तम	इंस्टॉल या चलाएँ
AppImage	समर्थित वितरणों पर पोर्टेबल उपयोग	chmod +x Quipu_*.AppImage && ./Quipu_*.AppImage
.deb	Ubuntu 22.04+ और Debian 12+	sudo apt install ./Quipu_*.deb
.rpm	हाल के Fedora रिलीज़	sudo dnf install ./Quipu-*.rpm

.deb और .rpm पैकेज सिस्टम WebKitGTK रनटाइम का उपयोग करते हैं। यदि आपका वितरण उस निर्भरता को पूरा नहीं कर सकता, तो AppImage का उपयोग करें।

Quipu पैकेज वर्तमान में हस्ताक्षरित नहीं हैं। प्रत्येक रिलीज़ में एक SHA256SUMS फ़ाइल शामिल होती है; इसे पैकेजों के साथ डाउनलोड करें और आपके द्वारा डाउनलोड की गई फ़ाइलों को इससे सत्यापित करें:

sha256sum --ignore-missing --check SHA256SUMS

चेकसम आकस्मिक भ्रष्टाचार का पता लगाते हैं लेकिन ये प्रमाणित हस्ताक्षर नहीं हैं।

त्वरित शुरुआत

1. Quipu शुरू करें और File → Open Example… → Basic text match चुनें।
2. एडिटर में text_indicators.yar का अन्वेषण करें।
3. Rules → Compile Workspace चुनें या Ctrl+Shift+B दबाएँ।
4. Rules → Scan Target के साथ तैयार लक्ष्य को स्कैन करें या Ctrl+Shift+Enter दबाएँ।
5. किसी मैच का विस्तार करें और हाइलाइट किए गए बाइट्स का निरीक्षण करने के लिए उसे चुनें।

पूरी मार्गदर्शिका Quipu के साथ Help → Documentation के अंतर्गत बंडल की गई है। इसका स्रोत documentation/content में भी उपलब्ध है।

वर्कस्पेस और quipu.toml

कॉन्फ़िगरेशन के बिना, Quipu पुनरावर्ती रूप से नियम फ़ाइलों की खोज करता है और प्रत्येक फ़ाइल से एक एंट्रीपॉइंट का अनुमान लगाता है जो किसी अन्य फ़ाइल द्वारा शामिल नहीं है। जब आपको स्पष्ट एंट्रीपॉइंट, इन्क्लूड निर्देशिकाएँ, या बहिष्करण की आवश्यकता हो, तो वर्कस्पेस रूट पर एक quipu.toml जोड़ें:

schema = 1
entrypoints = ["main.yar"]
include_dirs = ["rules", "../shared-rules"]
exclude = ["fixtures/**", "vendor/legacy/**"]

पूर्ण प्रोजेक्ट मॉडल और मैनिफ़ेस्ट संदर्भ के लिए Workspaces and projects देखें।

स्रोत से बिल्ड करें

Quipu वर्तमान में Linux x86-64 को लक्षित करता है। बिल्ड के लिए आवश्यक है:

• Rust 1.93 या नया
• Node.js 22.6 या नया
• Zola 0.23
• Git
• Tauri और WebKitGTK द्वारा आवश्यक नेटिव लाइब्रेरीज़

Debian या Ubuntu पर, नेटिव निर्भरताएँ इस प्रकार इंस्टॉल करें:

sudo apt update
sudo apt install -y \
  build-essential \
  curl \
  file \
  libayatana-appindicator3-dev \
  libgtk-3-dev \
  librsvg2-dev \
  libssl-dev \
  libwebkit2gtk-4.1-dev \
  patchelf \
  rpm \
  wget

फिर तीनों Linux पैकेज प्रारूप बिल्ड करें:

git clone https://github.com/corelight/quipu.git
cd quipu/app
npm ci
npm run tauri -- build --bundles appimage,deb,rpm

आर्टिफ़ैक्ट्स app/src-tauri/target/release/bundle/ के नीचे लिखे जाते हैं। पहला बिल्ड कुछ समय ले सकता है क्योंकि Cargo YARA-X और उसकी निर्भरताओं को स्रोत से संकलित करता है।

विकास और परीक्षण

निर्भरताएँ इंस्टॉल करें और विकास एप्लिकेशन शुरू करें:

cd app
npm ci
npm run tauri -- dev

फ्रंटएंड यूनिट टेस्ट, प्रोडक्शन फ्रंटएंड बिल्ड, और Rust टेस्ट इस प्रकार चलाएँ:

cd app
npm test
npm run build

cd src-tauri
cargo test --locked

नेटिव-मेनू स्वीकृति सूट की अतिरिक्त Linux डिस्प्ले-सर्वर आवश्यकताएँ हैं। इसकी सेटअप और उपयोग के लिए test/README.md देखें।

आर्किटेक्चर

Quipu एक Tauri एप्लिकेशन है जिसमें वनीला TypeScript फ्रंटएंड और एक Rust बैकएंड है:

• Vite फ्रंटएंड और Monaco एडिटर को एप्लिकेशन वेबव्यू में बंडल करता है।
• Tauri IPC UI को Rust में वर्कस्पेस, फ़ाइलसिस्टम, कंपाइलेशन, कैश, और स्कैनिंग सेवाओं से जोड़ता है।
• YARA-X कंपाइलर और भाषा सर्वर इन-प्रोसेस चलते हैं।
• Zola एक ऑफ़लाइन डॉक्युमेंटेशन साइट बनाता है जो ऐप में एम्बेड की जाती है।

app/src/           TypeScript frontend
app/src-tauri/     Rust backend and desktop packaging
documentation/    Source for the bundled offline guide
examples/          Projects bundled with the application
test/ui/           Native-menu acceptance test harness

एप्लिकेशन संस्करण app/package.json में परिभाषित है; Tauri पैकेजों के नाम रखते समय और चल रहे संस्करण की रिपोर्ट करते समय उस मान को पढ़ता है।

वर्तमान सीमाएँ

• प्रारंभ में केवल Linux x86-64 पैकेज समर्थित हैं।
• Quipu एक बार में एक चयनित फ़ाइल या एक टेक्स्ट बफ़र स्कैन करता है, न कि निर्देशिकाएँ या बैच।
• नए नियम वर्कस्पेस रूट पर बनाए जाते हैं। मूव और डिलीट ऑपरेशन Quipu के बाहर किए जाते हैं।
• एक स्क्रैच नियम को संकलित और स्कैन किया जा सकता है, लेकिन सहेजा या कैश नहीं किया जा सकता।

योगदान और सुरक्षा

योगदान का स्वागत है। पुल रिक्वेस्ट खोलने से पहले CONTRIBUTING.md पढ़ें।

कृपया सार्वजनिक इश्यू में सुरक्षा भेद्यताओं की रिपोर्ट न करें। SECURITY.md में निजी रिपोर्टिंग प्रक्रिया का पालन करें।

आभार

Quipu को Corelight द्वारा बनाया गया है और यह YARA-X, Monaco Editor, और Tauri द्वारा संचालित है।

लाइसेंस

Quipu 3-clause BSD लाइसेंस के अंतर्गत वितरित किया जाता है। LICENSE देखें। तृतीय पक्षों से शामिल सॉफ़्टवेयर के नोटिस THIRD_PARTY_LICENSES में हैं।