Hotpot 🍲

Authy / Google Authenticator pour la ligne de commande.

Hotpot est un outil en ligne de commande simple et sécurisé pour gérer les codes d'authentification à deux facteurs basés sur TOTP. Hotpot stocke de manière sécurisée vos secrets 2FA dans le trousseau de votre système et génère des mots de passe uniques temporels lorsque vous en avez besoin.

Construit avec Rust pour la sécurité, les performances et la fiabilité.

Fonctionnalités

• Stockage sécurisé utilisant le trousseau système (Keychain/libsecret/Gestionnaire d'identifiants)
• Génération de codes TOTP (RFC 6238) avec algorithmes personnalisables (SHA1/SHA256/SHA512)
• Tableau de bord interactif avec codes en temps réel, barres de progression et recherche floue
• Copie en un clic dans le presse-papiers avec retour visuel
• Export de code QR pour une configuration facile sur application mobile
• Capture d'écran (macOS) pour importer des codes QR
• Interface terminal rapide et réactive avec animations fluides
• Recherche floue pour trouver rapidement des comptes

Installation

Clonez ce dépôt, puis exécutez

cargo install --path . --locked

Utilisation

Ajouter un nouveau compte

hotpot add <account-name>

Il vous sera demandé de saisir le secret Base32 de manière sécurisée.

Exemple :

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

Ajouter depuis une image de code QR (macOS)

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

Ou utilisez la capture d'écran interactive dans le tableau de bord en appuyant sur [A] puis [S].

Tableau de bord interactif

Exécutez simplement hotpot pour ouvrir le tableau de bord interactif où vous pouvez :

• Visualiser tous les codes TOTP en temps réel avec des barres de progression fluides
• Naviguer avec les flèches haut/bas
• Copier les codes en appuyant sur Entrée (affiche l'indicateur "copié")
• Rechercher en appuyant sur [F] et en tapant (correspondance floue)
• Ajouter des comptes en appuyant sur [A], puis choisir [M]anuel ou [S]creenshot (macOS)
• Supprimer des comptes en appuyant sur [D] (avec confirmation)
• Exporter les codes QR en appuyant sur [E] pour la configuration sur application mobile
• Quitter avec 'q', 'Échap' ou Ctrl+C

Le tableau de bord se rafraîchit automatiquement toutes les 250 ms et gère le redimensionnement du terminal avec élégance.

Générer un seul code

hotpot code <account-name>

Exemple :

hotpot code github

Supprimer un compte

hotpot delete <account-name>

Exporter un code QR

Vous pouvez exporter un code QR pour un compte soit via le tableau de bord (appuyez sur [E]), soit en utilisant la commande :

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

Cela affichera un code QR dans le terminal qui peut être scanné par les applications d'authentification.

Mode de stockage basé sur fichier

Pour les configurations portables ou lorsque l'accès au trousseau n'est pas disponible, vous pouvez utiliser le drapeau --file pour stocker les comptes dans un fichier JSON au lieu du trousseau sécurisé.

# Interactive dashboard with file storage
hotpot --file ~/.config/hotpot/accounts.json

# Add account to file
hotpot --file ./my-accounts.json add work-account

# Generate code from file-stored account
hotpot --file ./my-accounts.json code work-account

# Delete account from file
hotpot --file ./my-accounts.json delete work-account

Cas d'utilisation du stockage basé sur fichier :

• Configurations portables : Stocker les comptes dans un fichier pouvant être synchronisé ou sauvegardé
• Environnements serveur : Utiliser lorsque les services de trousseau ne sont pas disponibles
• Développement/Test : Isoler les comptes de test du stockage sécurisé
• Partage en équipe : Partager les configurations de comptes (assurez la sécurité du fichier)

Note de sécurité : Le stockage basé sur fichier stocke les secrets en JSON en clair. Assurez des permissions de fichier appropriées (600) et envisagez de chiffrer le fichier pour les environnements sensibles.

Sécurité

Stockage sécurisé par défaut : Hotpot stocke tous les secrets de manière sécurisée dans le trousseau de votre système :

• macOS : Keychain
• Linux : Secret Service API/libsecret
• Windows : Gestionnaire d'identifiants Windows

Stockage basé sur fichier : Lors de l'utilisation du drapeau --file, les comptes sont stockés dans un fichier JSON au chemin spécifié. Le fichier est créé avec les permissions appropriées (600) et les répertoires sont créés automatiquement si nécessaire. Ce mode est utile pour les configurations portables ou lorsque l'accès au trousseau n'est pas disponible.

Développement

Compilation à partir des sources

1. Assurez-vous d'avoir Rust installé
2. Clonez le dépôt
3. Exécutez :

cargo build --release

Le binaire sera disponible à target/release/hotpot

Exécution des tests

Le projet comprend des tests unitaires complets couvrant les fonctionnalités principales :

cargo test

La couverture des tests comprend :

• Génération et validation de codes TOTP
• Logique de filtrage et de recherche de comptes
• Analyse et validation de codes QR
• Gestion de l'état du tableau de bord
• Gestion des entrées et changement de mode

Commandes de développement

# Run in development mode
cargo run

# Run with specific arguments
cargo run -- add github

# Test with file storage
cargo run -- --file test-accounts.json add test-account

# Check code quality
cargo clippy

# Quick compile check
cargo check

Architecture

Hotpot est construit avec une architecture modulaire axée sur la sécurité et la maintenabilité :

• main.rs : Interface CLI et gestion du stockage
• totp.rs : Implémentation de l'algorithme TOTP (RFC 6238) avec une couverture de tests complète
• dashboard.rs : Interface terminal interactive avec mises à jour en temps réel et tests unitaires complets
• lib.rs : Gestion des erreurs courantes et utilitaires partagés

Dépendances clés

• Security & Storage : keyring, base32, hmac, sha1/sha2
• CLI & Terminal : clap, crossterm, rpassword
• Interactive Features : fuzzy-matcher, qrcode, arboard
• Data Handling : serde, serde_json, url, urlencoding
• Image Processing : image, (QR code detection)

Licence

Licence MIT

Contribuer

Les contributions sont les bienvenues ! N'hésitez pas à soumettre une Pull Request.

Qualité du code

Le projet maintient des normes de qualité de code élevées :

• Tests unitaires complets (exécutez cargo test)
• Vérification Clippy (exécutez cargo clippy)
• Fonctions et modules bien documentés
• Pratiques de codage sécurisées avec une gestion appropriée des erreurs

Améliorations récentes

• Tableau de bord amélioré : Code de l'interface refactorisé pour une meilleure maintenabilité et performances
• Tests complets : Ajout de plus de 25 tests unitaires couvrant les fonctionnalités principales
• UX améliorée : Ajout d'un retour visuel pour les codes copiés et barres de progression fluides
• Qualité du code : Extraction de fonctions d'assistance et réduction de la duplication de code