xsshend 0.4.2

Simple CLI tool for uploading files to multiple SSH servers
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
# 🚀 xsshend

[![Crates.io](https://img.shields.io/crates/v/xsshend.svg)](https://crates.io/crates/xsshend)
[![Documentation](https://docs.rs/xsshend/badge.svg)](https://docs.rs/xsshend)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Rust](https://img.shields.io/badge/rust-2021%2B-orange.svg)](https://www.rust-lang.org)
[![Security: RUSTSEC-2023-0071](https://img.shields.io/badge/security-known%20limitation-yellow)](SECURITY.md)

**xsshend** est un outil Rust moderne et efficace pour le **téléversement de fichiers vers multiples serveurs SSH**. Interface en ligne de commande simple et intuitive avec suivi en temps réel des transferts.

## 🔧 Installation

### Pré-requis

- Rust 1.70+ (recommandé: version stable la plus récente)
- OpenSSL (optionnel, pour accélérer la compilation)

### Via Cargo (recommandé)

```bash
cargo install xsshend
```

#### 🚀 AccĂ©lĂ©rer l'installation

L'installation peut ĂȘtre longue car elle compile OpenSSL depuis les sources par dĂ©faut. Pour accĂ©lĂ©rer :

**Option 1 : Utiliser OpenSSL du systĂšme (Linux/macOS)**
```bash
# Installer OpenSSL si nécessaire
# Ubuntu/Debian:
sudo apt-get install libssl-dev pkg-config

# Fedora/RHEL:
sudo dnf install openssl-devel

# macOS:
brew install openssl pkg-config

# Installer xsshend (utilise OpenSSL systĂšme automatiquement)
cargo install xsshend
```

**Option 2 : Compilation parallĂšle**
```bash
# Utiliser tous les cƓurs CPU disponibles
cargo install xsshend -j $(nproc)
```

### Depuis les sources

```bash
git clone https://github.com/willisback/xsshend.git
cd xsshend
cargo install --path .
```

## 📚 Documentation

- [**Documentation complĂšte**]https://willisback.github.io/xsshend/
- [Guide d'utilisation]#-utilisation
- [Configuration]#%EF%B8%8F-configuration
- [**Politique de sécurité**]SECURITY.md

## 🔒 Note de SĂ©curitĂ©

⚠ **VulnĂ©rabilitĂ© connue**: xsshend dĂ©pend de `russh` qui utilise `rsa 0.9.8`, affectĂ© par [RUSTSEC-2023-0071](https://rustsec.org/advisories/RUSTSEC-2023-0071) (Marvin Attack - timing sidechannel).

**Recommandations** :
- ✅ Utilisez des **clĂ©s Ed25519** plutĂŽt que RSA (non affectĂ©es)
- ✅ Utilisez xsshend sur des **rĂ©seaux de confiance** (internes, VPN)
- ⚠ Évitez l'utilisation sur des **rĂ©seaux publics non sĂ©curisĂ©s**

**Contexte** : Aucun correctif n'est disponible actuellement. Cette vulnérabilité permet potentiellement la récupération de clés RSA via l'observation du timing réseau. Les clés Ed25519 et ECDSA ne sont pas affectées.

**Détails complets** : Consultez [SECURITY.md](SECURITY.md) pour plus d'informations et les recommandations détaillées.

## ✹ FonctionnalitĂ©s principales

- 🎯 **TĂ©lĂ©versement simple** vers plusieurs serveurs SSH
- 📊 **Barres de progression** en temps rĂ©el pour chaque transfert
- 🔐 **Authentification sĂ©curisĂ©e** par clĂ©s SSH avec dĂ©couverte automatique
- 🔍 **Filtrage avancĂ©** par environnement, rĂ©gion et type de serveur
- đŸ—ïž **Configuration hiĂ©rarchique** des serveurs (environnements, rĂ©gions, types)
- đŸ›Ąïž **Gestion d'erreurs robuste** avec rapports dĂ©taillĂ©s
- 📁 **Support multi-fichiers** avec validation automatique
- ⚡ **Mode dry-run** pour simulation sans transfert rĂ©el
- đŸ§Ș **Suite de tests complĂšte** avec 93 tests automatisĂ©s

## 🚀 DĂ©marrage rapide

### 1. Initialisation

```bash
# Initialiser la configuration avec assistant interactif
xsshend init

# Forcer la réinitialisation
xsshend init --force
```

### 2. Configuration des serveurs

Créez le fichier `~/.ssh/hosts.json` avec la structure hiérarchique :

```json
{
  "Production": {
    "Region-A": {
      "Public": {
        "WEB_SERVER_01": {
          "alias": "web01@prod-web-01.example.com",
          "env": "PROD"
        },
        "API_SERVER_01": {
          "alias": "api01@prod-api-01.example.com",
          "env": "PROD"
        }
      },
      "Private": {
        "DATABASE_01": {
          "alias": "db01@prod-db-01.example.com",
          "env": "PROD"
        }
      }
    }
  },
  "Staging": {
    "Region-A": {
      "Public": {
        "STAGE_WEB_01": {
          "alias": "web01@stage-web-01.example.com",
          "env": "STAGE"
        }
      }
    }
  },
  "Development": {
    "Local": {
      "Services": {
        "DEV_DATABASE": {
          "alias": "dev@dev-db.local.example.com",
          "env": "DEV"
        }
      }
    }
  }
}
```

### 3. Utilisation

```bash
# Lister les serveurs disponibles
xsshend list

# Téléverser un fichier vers tous les serveurs
xsshend upload myfile.txt

# Filtrer par environnement
xsshend upload config.json --env Production

# Mode dry-run (simulation)
xsshend upload deploy.sh --env Production --dry-run
```

## 🎼 Utilisation

### Commandes principales

```bash
# Aide générale
xsshend --help

# Initialiser la configuration
xsshend init [--force]

# Lister les serveurs disponibles
xsshend list
# ou
xsshend --list

# Téléverser des fichiers
xsshend upload <FILES>... [OPTIONS]
```

### Options de téléversement

```bash
# Filtrage par environnement
xsshend upload file.txt --env Production
xsshend upload file.txt --env Staging
xsshend upload file.txt --env Development

# Filtrage par région
xsshend upload file.txt --region Region-A
xsshend upload file.txt --region Region-B

# Filtrage par type de serveur
xsshend upload file.txt --type Public
xsshend upload file.txt --type Private

# Filtrage combiné
xsshend upload config.json --env Production --region Region-A
xsshend upload deploy.sh --env Production --type Public
xsshend upload app.war --env Staging --region Region-A --type Public

# Spécifier la destination
xsshend upload file.txt --dest /opt/app/
xsshend upload file.txt --dest /var/www/html/

# Mode simulation (dry-run)
xsshend upload file.txt --env Production --dry-run

# Téléverser plusieurs fichiers
xsshend upload file1.txt file2.json directory/
```

### Exemples d'utilisation

```bash
# Déploiement en production
xsshend upload app.war --env Production --dest /opt/tomcat/webapps/

# Mise Ă  jour de configuration de staging
xsshend upload config.json --env Staging --dest /etc/myapp/

# Déploiement sur serveurs publics uniquement
xsshend upload static-files/ --env Production --type Public --dest /var/www/

# Simulation d'un déploiement
xsshend upload deploy.sh --env Production --dry-run

# Upload vers une région spécifique
xsshend upload regional-config.json --env Production --region Region-A
```

### Interface de progression

Les transferts affichent une progression en temps réel :

```
🚀 DĂ©but du tĂ©lĂ©versement: 1 fichier(s) vers 3 serveur(s)
📂 Destination: /opt/uploads/
🎯 Serveurs ciblĂ©s:
   ‱ Production:Region-A:Public:WEB_SERVER_01 → web01@prod-web-01.example.com (PROD)
   ‱ Production:Region-A:Public:API_SERVER_01 → api01@prod-api-01.example.com (PROD)
   ‱ Production:Region-A:Private:DATABASE_01 → db01@prod-db-01.example.com (PROD)

đŸ“€ TĂ©lĂ©versement de ./myapp.jar en cours...

web01@prod-web-01... [████████████████████████████████] 2.3MB/2.3MB ✅
api01@prod-api-01... [██████████████████              ] 1.5MB/2.3MB ⏳
db01@prod-db-01..... [████████████████████████████     ] 2.1MB/2.3MB ⏳

✅ TĂ©lĂ©versement terminĂ© avec succĂšs!
📊 3 serveur(s) - 0 Ă©chec(s)
```

## 🔑 Gestion des clĂ©s SSH

### Découverte automatique

xsshend détecte automatiquement les clés SSH disponibles dans `~/.ssh/` :

- **Types supportés** : Ed25519, RSA, ECDSA, DSA
- **Gestion des passphrases** avec ssh-agent
- **Sélection automatique** de la meilleure clé disponible

### Priorité de sélection

1. **Ed25519** - Recommandé pour la sécurité et performance
2. **RSA** - Compatibilité étendue
3. **ECDSA** - Alternative moderne
4. **DSA** - Support basique

### Configuration SSH

```bash
# Vérifier les clés disponibles
ssh-add -l

# Ajouter une clé à l'agent SSH
ssh-add ~/.ssh/id_ed25519

# Copier une clé publique vers un serveur
ssh-copy-id user@server.example.com
```

## ⚙ Configuration

### Structure hiérarchique

La configuration suit une structure Ă  trois niveaux :

```
Environment/
├── Region/
│   ├── Type/
│   │   ├── SERVER_NAME_1
│   │   └── SERVER_NAME_2
│   └── Type/
└── Region/
```

**Exemple d'organisation :**

```
Production/
├── Region-A/
│   ├── Public/     # Serveurs web publics
│   └── Private/    # Bases de donnĂ©es internes
└── Region-B/
    ├── Public/
    └── Private/

Staging/
├── Region-A/
│   └── Public/
└── Region-B/

Development/
└── Local/
    └── Services/
```

### Commande init

La commande `xsshend init` vous guide dans la configuration :

1. **Détection des clés SSH** existantes
2. **Création du fichier hosts.json** avec template
3. **Configuration des permissions** sécurisées (.ssh/ en 700)
4. **Conseils d'utilisation** personnalisés

```bash
# Configuration initiale interactive
xsshend init

# Réinitialisation complÚte
xsshend init --force
```

### Format des entrées serveur

Chaque serveur est défini avec :

```json
{
  "SERVER_NAME": {
    "alias": "username@hostname.example.com",  // Obligatoire
    "env": "ENVIRONMENT_TAG"                   // Optionnel
  }
}
```

## đŸ› ïž DĂ©veloppement

### Prérequis

- **Rust 2021 Edition** ou plus récent
- **OpenSSH** pour les clés SSH
- **Git** pour le développement

### Installation développement

```bash
# Cloner le projet
git clone https://github.com/willisback/xsshend.git
cd xsshend

# Installer les outils de développement
rustup component add clippy rustfmt

# Compiler en mode debug
cargo build

# Compiler en mode release
cargo build --release
```

### Tests

Le projet inclut une suite de tests complĂšte avec **93 tests** :

```bash
# Tests unitaires et d'intégration
cargo test

# Tests avec sortie détaillée
cargo test -- --nocapture

# Tests de performance (benchmarks)
cargo bench
```

### Qualité de code

```bash
# Formatage automatique
cargo fmt

# Linting avec Clippy
cargo clippy -- -D warnings

# Vérification complÚte
cargo check --all-targets --all-features

# Documentation
cargo doc --open
```

## đŸ§Ș Architecture de tests

### Couverture de tests

- **Unit tests** : 6 tests (modules core)
- **Config tests** : 14 tests (configuration JSON)
- **SSH keys tests** : 10 tests (gestion des clés)
- **Uploader tests** : 14 tests (téléversements)
- **CLI tests** : 21 tests (interface ligne de commande)
- **Integration tests** : 12 tests (workflows complets)
- **Validator tests** : 16 tests (validation fichiers)

### Tests d'intégration

Les tests d'intégration valident :

- ✅ Initialisation et configuration
- ✅ DĂ©tection et sĂ©lection des clĂ©s SSH
- ✅ Parsing et filtrage des configurations
- ✅ Workflows complets (init → list → upload)
- ✅ Gestion des erreurs et cas limites
- ✅ Performance avec grandes configurations
- ✅ Interface CLI et validation des arguments

## 🔧 Stack technologique

### Dépendances principales

- **`ssh2`** - Client SSH/SFTP robuste
- **`clap`** - Interface ligne de commande moderne
- **`serde/serde_json`** - Sérialisation JSON
- **`indicatif`** - Barres de progression
- **`anyhow`** - Gestion d'erreurs ergonomique
- **`tempfile`** - Fichiers temporaires (tests)

### Architecture modulaire

```
src/
├── main.rs           # Point d'entrĂ©e CLI
├── lib.rs            # Interface bibliothùque
├── config/           # Configuration hosts.json
│   ├── mod.rs
│   └── hosts.rs
├── ssh/              # Client SSH et clĂ©s
│   ├── mod.rs
│   ├── client.rs
│   └── keys.rs
├── core/             # Logique mĂ©tier
│   ├── mod.rs
│   ├── uploader.rs
│   └── validator.rs
└── utils/            # Utilitaires
    ├── mod.rs
    └── logger.rs

tests/               # Tests d'intégration
├── cli_test.rs
├── config_test.rs
├── integration_test.rs
├── ssh_keys_test.rs
├── uploader_test.rs
├── validator_test.rs
└── common/
    └── mod.rs       # Utilitaires de test

benches/             # Tests de performance
└── performance_bench.rs
```

## đŸ›Ąïž DĂ©pannage

### ProblĂšmes courants

#### Erreur: "Permission denied (publickey)"

```bash
# Vérifier la configuration SSH
ssh -v user@server.example.com

# Vérifier l'agent SSH
ssh-add -l

# Ajouter une clé si nécessaire
ssh-add ~/.ssh/id_ed25519
```

#### Erreur: "hosts.json not found"

```bash
# Utiliser la commande d'initialisation
xsshend init

# Ou créer manuellement
mkdir -p ~/.ssh
nano ~/.ssh/hosts.json
```

#### Tests en échec

```bash
# Exécuter les tests avec détails
cargo test -- --nocapture

# Vérifier un test specific
cargo test test_name

# Tests d'intégration uniquement
cargo test --test integration_test
```

### Mode debug

```bash
# Logs détaillés
RUST_LOG=debug xsshend upload file.txt --env Production

# Mode trĂšs verbeux
RUST_LOG=trace xsshend upload file.txt --env Production
```

## đŸ€ Contribution

Les contributions sont les bienvenues !

### Processus de contribution

1. **Fork** le projet
2. Créer une **branche feature** (`git checkout -b feature/ma-fonctionnalite`)
3. **Commiter** les changements (`git commit -am 'Ajoute ma fonctionnalité'`)
4. **Pousser** vers la branche (`git push origin feature/ma-fonctionnalite`)
5. Ouvrir une **Pull Request**

### Standards de qualité

Avant de soumettre une PR, assurez-vous que :

- ✅ Code formatĂ© : `cargo fmt`
- ✅ Linting OK : `cargo clippy -- -D warnings`
- ✅ Tests passants : `cargo test`
- ✅ Documentation à jour

Le workflow GitHub Actions vérifie automatiquement ces critÚres.

## 📄 Licence

Ce projet est sous licence **MIT** - voir le fichier [LICENSE](LICENSE) pour les détails.

## đŸ§Ș Environnement de Test (Lab)

Un environnement de test Docker complet est disponible pour valider xsshend en conditions réelles :

**Documentation du Lab :**
- **[Index du Lab]docs/LAB-INDEX.md** - Point d'entrée principal
- **[Guide de Démarrage]docs/LAB-README.md** - Installation et configuration
- **[Guide de Test]docs/LAB-TESTING-GUIDE.md** - Tests détaillés (40+ tests)
- **[Dépannage]docs/LAB-TROUBLESHOOTING.md** - Résolution de problÚmes

**Démarrage Rapide :**
```bash
# 1. Setup
git clone https://github.com/WillIsback/xsshend.git
cd xsshend
./scripts/lab-setup.sh

# 2. Démarrer le lab (3 conteneurs : master + 2 targets)
cd lab/
docker-compose up -d --build

# 3. Tests automatisés
../scripts/test-lab.sh

# 4. Tests manuels
docker exec -it xsshend_master bash
xsshend list
xsshend upload test.txt --env Test
```

Le lab fournit :
- ✅ Environnement ArchLinux isolĂ© (Docker)
- ✅ 3 conteneurs configurĂ©s (master + 2 targets SSH)
- ✅ ClĂ©s SSH prĂ©-configurĂ©es (RSA + Ed25519)
- ✅ Suite de tests automatisĂ©s (40+ tests)
- ✅ Scripts de diagnostic et dĂ©pannage
- ✅ Documentation complùte

Voir **[docs/LAB-INDEX.md](docs/LAB-INDEX.md)** pour tous les détails.

## 🙏 Remerciements

- **[clap-rs]https://github.com/clap-rs/clap** pour l'excellent framework CLI
- **[russh]https://github.com/Eugeny/russh** pour l'implémentation SSH pure Rust
- **[indicatif]https://github.com/console-rs/indicatif** pour les barres de progression
- **[serde]https://github.com/serde-rs/serde** pour la sérialisation JSON
- Communauté **Rust** pour l'écosystÚme exceptionnel

---

**xsshend** - *TĂ©lĂ©versement SSH simple et efficace* 🚀