b13c8745e3
- ✅ API sécurisée avec authentification par ID utilisateur - ✅ HTTPS obligatoire avec rejet des connexions HTTP - ✅ Clés individuelles par utilisateur ET par environnement - ✅ Rotation automatique des clés avec sauvegarde de l'ancienne - ✅ Stockage sécurisé dans storage/<env>/_keys/ - ✅ Client SDK mis à jour sans stockage de clés côté client - ✅ Documentation complète avec avertissements de sécurité - ✅ Tests complets du système sécurisé - 🔒 Protection des fichiers sensibles dans .gitignore
4.9 KiB
Documentation 4NK Vault
Bienvenue dans la documentation complète du projet 4NK Vault, un système de stockage sécurisé avec chiffrement quantique résistant.
📚 Documentation disponible
🚀 Guide principal
Vue d'ensemble du projet, architecture et utilisation de base.
🔧 Spécification API
Spécification technique complète de l'API REST avec tous les détails d'implémentation.
📖 Référence API
Référence complète des endpoints, paramètres, réponses et codes d'erreur.
🛡️ Modèle de sécurité
Architecture de sécurité, chiffrement quantique résistant et bonnes pratiques.
🚀 Guide de déploiement
Instructions complètes pour déployer le système en développement et production.
💻 Documentation SDK
Documentation complète du SDK TypeScript avec exemples et API reference.
🎯 Démarrage rapide
Installation et test
# 1. Installation des dépendances
pip install -r requirements.txt
# 2. Démarrage de l'API
./start_api.sh
# 3. Test de l'API
curl -k https://localhost:6666/health
# 4. Test du SDK
cd sdk-client
npm install && npm run build
node dist/examples/basic-usage.js
Utilisation basique
import { createVaultClient } from '@4nk/vault-sdk';
const client = createVaultClient('https://vault.4nkweb.com:6666');
const file = await client.getFile('dev', 'bitcoin/bitcoin.conf');
console.log(file.content); // Contenu déchiffré
🔍 Navigation par cas d'usage
Je veux...
- Comprendre le projet → Guide principal
- Utiliser l'API → Référence API
- Déployer le système → Guide de déploiement
- Développer avec le SDK → Documentation SDK
- Comprendre la sécurité → Modèle de sécurité
- Implémenter l'API → Spécification API
🏗️ Architecture du système
┌─────────────────┐ HTTPS ┌─────────────────┐ ┌─────────────────┐
│ Client SDK │ ──────────► │ API Vault │ ──► │ Storage │
│ TypeScript │ Port 6666 │ Python Flask │ │ Files │
└─────────────────┘ └─────────────────┘ └─────────────────┘
│
▼
┌─────────────────┐
│ Variables │
│ .env │
└─────────────────┘
🔐 Sécurité
- Chiffrement : ChaCha20-Poly1305 (quantique résistant)
- Transport : HTTPS uniquement (TLS 1.2+)
- Authentification : Chiffrement intégré avec nonce aléatoire
- Validation : Protection contre les accès non autorisés
📊 Fonctionnalités
- ✅ API REST : Endpoints pour la santé, info et fichiers
- ✅ Chiffrement : Quantique résistant avec ChaCha20-Poly1305
- ✅ Variables : Traitement automatique des variables composites
- ✅ SDK TypeScript : Client type-safe avec déchiffrement
- ✅ Monitoring : Logs détaillés et métriques
- ✅ Sécurité : Validation des chemins et protection d'accès
🛠️ Technologies
- Backend : Python 3.8+ avec Flask
- Frontend : TypeScript/JavaScript SDK
- Chiffrement : cryptography (Python), crypto (Node.js)
- Transport : HTTPS avec certificats SSL/TLS
- Stockage : Système de fichiers avec structure hiérarchique
📈 Versions
| Composant | Version | Statut |
|---|---|---|
| API Server | 1.0.0 | ✅ Stable |
| SDK Client | 1.0.0 | ✅ Stable |
| Documentation | 1.0.0 | ✅ Complète |
🤝 Support
Ressources
- Issues : Git Issues
- Wiki : Documentation Wiki
- Email : support@4nkweb.com
Communauté
- Discussions : Forum de la communauté
- Chat : Discord
- Newsletter : Abonnement
📄 Licence
MIT License - Voir le fichier LICENSE pour plus de détails.
🏷️ Tags et mots-clés
vault security encryption quantum-resistant api typescript python chacha20 poly1305 https configuration variables sdk
Dernière mise à jour : 2025-09-29 Version documentation : 1.0.0 Maintenu par : Équipe 4NK