fcb15afb88
- API server with ChaCha20-Poly1305 encryption - TypeScript SDK client with full functionality - Complete documentation in docs/ - Environment variable processing with composite variables - HTTPS-only API on port 6666 - Storage structure for configuration files - Tests and examples included Features: - Quantum-resistant encryption (ChaCha20-Poly1305) - Variable substitution from .env files - Comprehensive TypeScript SDK - Full API documentation and specifications - Deployment guides and security model
143 lines
4.9 KiB
Markdown
143 lines
4.9 KiB
Markdown
# 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](README.md)
|
|
Vue d'ensemble du projet, architecture et utilisation de base.
|
|
|
|
### 🔧 [Spécification API](api-specification.md)
|
|
Spécification technique complète de l'API REST avec tous les détails d'implémentation.
|
|
|
|
### 📖 [Référence API](api-reference.md)
|
|
Référence complète des endpoints, paramètres, réponses et codes d'erreur.
|
|
|
|
### 🛡️ [Modèle de sécurité](security-model.md)
|
|
Architecture de sécurité, chiffrement quantique résistant et bonnes pratiques.
|
|
|
|
### 🚀 [Guide de déploiement](deployment-guide.md)
|
|
Instructions complètes pour déployer le système en développement et production.
|
|
|
|
### 💻 [Documentation SDK](sdk-documentation.md)
|
|
Documentation complète du SDK TypeScript avec exemples et API reference.
|
|
|
|
## 🎯 Démarrage rapide
|
|
|
|
### Installation et test
|
|
|
|
```bash
|
|
# 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
|
|
|
|
```typescript
|
|
import { createVaultClient } from '@4nk/vault-sdk';
|
|
|
|
const client = createVaultClient(
|
|
'https://vault.4nkweb.com:6666',
|
|
'quantum_resistant_demo_key_32byt'
|
|
);
|
|
|
|
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](README.md)
|
|
- **Utiliser l'API** → [Référence API](api-reference.md)
|
|
- **Déployer le système** → [Guide de déploiement](deployment-guide.md)
|
|
- **Développer avec le SDK** → [Documentation SDK](sdk-documentation.md)
|
|
- **Comprendre la sécurité** → [Modèle de sécurité](security-model.md)
|
|
- **Implémenter l'API** → [Spécification API](api-specification.md)
|
|
|
|
## 🏗️ 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](https://git.4nkweb.com/4nk/vault/issues)
|
|
- **Wiki** : [Documentation Wiki](https://git.4nkweb.com/4nk/vault/wiki)
|
|
- **Email** : support@4nkweb.com
|
|
|
|
### Communauté
|
|
|
|
- **Discussions** : [Forum de la communauté](https://forum.4nkweb.com)
|
|
- **Chat** : [Discord](https://discord.gg/4nk-vault)
|
|
- **Newsletter** : [Abonnement](https://newsletter.4nkweb.com)
|
|
|
|
## 📄 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
|