Hotpot 🍲

कमांड लाइन के लिए Authy / Google Authenticator।

Hotpot TOTP-आधारित टू-फैक्टर प्रमाणीकरण कोड प्रबंधित करने के लिए एक सरल और सुरक्षित कमांड-लाइन टूल है। Hotpot आपके 2FA रहस्यों को आपके सिस्टम के keyring में सुरक्षित रूप से संग्रहीत करता है और जब आपको आवश्यकता होती है तो समय-आधारित वन-टाइम पासवर्ड उत्पन्न करता है।

सुरक्षा, प्रदर्शन और विश्वसनीयता के लिए Rust के साथ निर्मित।

विशेषताएँ

• सुरक्षित भंडारण सिस्टम keyring (Keychain/libsecret/Credential Manager) का उपयोग करके
• TOTP (RFC 6238) कोड जनरेशन अनुकूलन योग्य एल्गोरिदम (SHA1/SHA256/SHA512) के साथ
• इंटरैक्टिव डैशबोर्ड रीयल-टाइम कोड, प्रगति बार और फ़ज़ी खोज के साथ
• वन-क्लिक कॉपी विज़ुअल प्रतिक्रिया के साथ क्लिपबोर्ड पर
• QR कोड निर्यात आसान मोबाइल ऐप सेटअप के लिए
• स्क्रीनशॉट कैप्चर (macOS) QR कोड आयात करने के लिए
• तेज़ और उत्तरदायी टर्मिनल UI स्मूद एनिमेशन के साथ
• फ़ज़ी खोज खातों को शीघ्रता से खोजने के लिए

स्थापना

इस रिपो को क्लोन करें, और चलाएँ

cargo install --path . --locked

उपयोग

एक नया खाता जोड़ें

hotpot add <account-name>

आपको Base32 सीक्रेट सुरक्षित रूप से दर्ज करने के लिए कहा जाएगा।

उदाहरण:

hotpot add github
Enter the Base32 secret: ********

QR कोड छवि से जोड़ें (macOS)

hotpot --load-image /path/to/qr-code.png

या डैशबोर्ड में इंटरैक्टिव स्क्रीनशॉट कैप्चर का उपयोग करें [A] फिर [S] दबाकर।

इंटरैक्टिव डैशबोर्ड

इंटरैक्टिव डैशबोर्ड खोलने के लिए बस hotpot चलाएँ, जहाँ आप यह कर सकते हैं:

• सभी TOTP कोड देखें रीयल-टाइम में स्मूद प्रोग्रेस बार के साथ
• नेविगेट करें ऊपर/नीचे तीर कुंजियों से
• कोड कॉपी करें Enter दबाकर ("कॉपी किया गया" संकेतक दिखाता है)
• खोजें [F] दबाकर और टाइप करके (फ़ज़ी मिलान)
• खाते जोड़ें [A] दबाकर, फिर [M]ैनुअल या [S]क्रीनशॉट (macOS) चुनें
• खाते हटाएँ [D] दबाकर (पुष्टि के साथ)
• QR कोड निर्यात करें [E] दबाकर मोबाइल ऐप सेटअप के लिए
• बाहर निकलें 'q', 'Esc', या Ctrl+C से

डैशबोर्ड हर 250ms में स्वतः रीफ़्रेश होता है और टर्मिनल आकार परिवर्तन को सुचारू रूप से संभालता है।

एक एकल कोड उत्पन्न करें

hotpot code <account-name>

उदाहरण:

hotpot code github

एक खाता हटाएँ

hotpot delete <account-name>

QR कोड निर्यात करें

आप किसी खाते के लिए QR कोड निर्यात कर सकते हैं या तो डैशबोर्ड के माध्यम से ([E] दबाकर) या कमांड का उपयोग करके:

hotpot export-qr --name <account-name>

यह टर्मिनल में एक QR कोड प्रदर्शित करेगा जिसे प्रमाणीकरण ऐप्स द्वारा स्कैन किया जा सकता है।

फ़ाइल-समर्थित भंडारण मोड

पोर्टेबल कॉन्फ़िगरेशन के लिए या जब keyring पहुँच उपलब्ध नहीं है, तो आप सुरक्षित keyring के बजाय खातों को एक JSON फ़ाइल में संग्रहीत करने के लिए --file फ़्लैग का उपयोग कर सकते हैं।

# फ़ाइल भंडारण के साथ इंटरैक्टिव डैशबोर्ड
hotpot --file ~/.config/hotpot/accounts.json

# फ़ाइल में खाता जोड़ें
hotpot --file ./my-accounts.json add work-account

# फ़ाइल-संग्रहीत खाते से कोड उत्पन्न करें
hotpot --file ./my-accounts.json code work-account

# फ़ाइल से खाता हटाएँ
hotpot --file ./my-accounts.json delete work-account

फ़ाइल-समर्थित भंडारण के उपयोग के मामले:

• पोर्टेबल कॉन्फ़िगरेशन: खातों को एक फ़ाइल में संग्रहीत करें जिसे सिंक या बैकअप किया जा सके
• सर्वर वातावरण: उपयोग करें जब keyring सेवाएँ उपलब्ध न हों
• विकास/परीक्षण: परीक्षण खातों को सुरक्षित भंडारण से अलग करें
• टीम साझाकरण: खाता कॉन्फ़िगरेशन साझा करें (फ़ाइल सुरक्षा सुनिश्चित करें)

सुरक्षा नोट: फ़ाइल-समर्थित भंडारण रहस्यों को सादे पाठ JSON में संग्रहीत करता है। उचित फ़ाइल अनुमतियाँ (600) सुनिश्चित करें और संवेदनशील वातावरणों के लिए फ़ाइल को एन्क्रिप्ट करने पर विचार करें।

सुरक्षा

डिफ़ॉल्ट सुरक्षित भंडारण: Hotpot सभी रहस्यों को आपके सिस्टम के keyring में सुरक्षित रूप से संग्रहीत करता है:

• macOS: Keychain
• Linux: Secret Service API/libsecret
• Windows: Windows Credential Manager

फ़ाइल-समर्थित भंडारण: --file फ़्लैग का उपयोग करते समय, खातों को निर्दिष्ट पथ पर एक JSON फ़ाइल में संग्रहीत किया जाता है। फ़ाइल उचित अनुमतियों (600) के साथ बनाई जाती है और आवश्यकता पड़ने पर निर्देशिकाएँ स्वतः बनाई जाती हैं। यह मोड पोर्टेबल कॉन्फ़िगरेशन या जब keyring पहुँच उपलब्ध न हो, के लिए उपयोगी है।

विकास

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

1. सुनिश्चित करें कि आपके पास Rust स्थापित है
2. रिपोजिटरी को क्लोन करें
3. चलाएँ:

cargo build --release

बाइनरी target/release/hotpot पर उपलब्ध होगी

परीक्षण चलाना

परियोजना में कोर कार्यक्षमता को कवर करने वाले व्यापक यूनिट परीक्षण शामिल हैं:

cargo test

परीक्षण कवरेज में शामिल है:

• TOTP कोड जनरेशन और सत्यापन
• खाता फ़िल्टरिंग और खोज तर्क
• QR कोड पार्सिंग और सत्यापन
• डैशबोर्ड स्थिति प्रबंधन
• इनपुट हैंडलिंग और मोड स्विचिंग

विकास कमांड

# विकास मोड में चलाएँ
cargo run

# विशिष्ट तर्कों के साथ चलाएँ
cargo run -- add github

# फ़ाइल भंडारण के साथ परीक्षण करें
cargo run -- --file test-accounts.json add test-account


# कोड गुणवत्ता जाँचें
cargo clippy

# त्वरित संकलन जाँच
cargo check

आर्किटेक्चर

Hotpot सुरक्षा और रखरखाव पर केंद्रित एक मॉड्यूलर आर्किटेक्चर के साथ निर्मित है:

• main.rs: CLI इंटरफ़ेस और भंडारण प्रबंधन
• totp.rs: TOTP एल्गोरिदम कार्यान्वयन (RFC 6238) व्यापक परीक्षण कवरेज के साथ
• dashboard.rs: इंटरैक्टिव टर्मिनल UI रीयल-टाइम अपडेट और व्यापक यूनिट परीक्षणों के साथ
• lib.rs: सामान्य त्रुटि प्रबंधन और साझा उपयोगिताएँ

प्रमुख निर्भरताएँ

• सुरक्षा और भंडारण: keyring, base32, hmac, sha1/sha2
• CLI और टर्मिनल: clap, crossterm, rpassword
• इंटरैक्टिव सुविधाएँ: fuzzy-matcher, qrcode, arboard
• डेटा हैंडलिंग: serde, serde_json, url, urlencoding
• छवि प्रसंस्करण: image, (QR कोड पहचान)

लाइसेंस

MIT लाइसेंस

योगदान

योगदान का स्वागत है! कृपया बेझिझक एक पुल रिक्वेस्ट सबमिट करें।

कोड गुणवत्ता

परियोजना उच्च कोड गुणवत्ता मानकों को बनाए रखती है:

• व्यापक यूनिट परीक्षण (cargo test चलाएँ)
• Clippy लिंटिंग (cargo clippy चलाएँ)
• अच्छी तरह से प्रलेखित फ़ंक्शन और मॉड्यूल
• उचित त्रुटि प्रबंधन के साथ सुरक्षित कोडिंग अभ्यास

हालिया सुधार

• उन्नत डैशबोर्ड: बेहतर रखरखाव और प्रदर्शन के लिए UI कोड का पुनर्गठन
• व्यापक परीक्षण: कोर कार्यक्षमता को कवर करने वाले 25+ यूनिट परीक्षण जोड़े गए
• बेहतर UX: कॉपी किए गए कोड के लिए विज़ुअल प्रतिक्रिया और स्मूद प्रोग्रेस बार जोड़े गए
• कोड गुणवत्ता: सहायक फ़ंक्शन निकाले गए और कोड दोहराव कम किया गया