
Regelbasierter Linter für OpenSSH-Client-Konfigurationsdateien, der doppelte Hosts, fehlende Identitätsdateien, schwache Algorithmen, Probleme mit der Wildcard-Reihenfolge und gefährliche Einstellungen erkennt und eine JSON-Ausgabe sowie CI-freundliche Exit-Codes bietet.
# sshconfig-lint
[](https://github.com/Noah4ever/sshconfig-lint/actions/workflows/tests.yml)
[](https://crates.io/crates/sshconfig-lint)
[](LICENSE)
**Eine Engine für jeden Ort, an dem sich deine SSH-Konfiguration ändert.**
sshconfig-lint findet semantische Fehler in OpenSSH-Client-Konfigurationen: doppelte Hosts, fehlerhafte Identitätspfade, unsichere Optionen, schwache Algorithmen, Wildcard-Reihenfolge und verworrene `Include`-Ketten. Verwende dieselben Regelcodes lokal, in Git-Hooks, GitHub Actions und Editoren.
[Probiere den privaten Browser-Playground aus](https://sshconfig-lint.apps.thiering.org/en) · [Lerne mit interaktiven Beispielen](https://sshconfig-lint.apps.thiering.org/en/learn) · [Lies jede Regel](https://sshconfig-lint.apps.thiering.org/en/rules)
Der Browser-Checker läuft auf deinem Gerät. Konfigurationsinhalte werden nicht hochgeladen und es werden keine Telemetriedaten erfasst.
## Schnellstart
```bash
# check ~/.ssh/config
sshconfig-lint
# check one or more repository configs
sshconfig-lint .ssh/config infrastructure/ssh_config
# fail on warnings and errors
sshconfig-lint .ssh/config --strict
```
## Installation
### Homebrew
```bash
brew tap Noah4ever/tap
brew install sshconfig-lint
```
### Cargo
```bash
cargo install sshconfig-lint
```
### Arch Linux
```bash
yay -S sshconfig-lint-bin
```
Die [Release-Seite](https://github.com/Noah4ever/sshconfig-lint/releases) bietet verifizierte Binärdateien für Linux, macOS und Windows. Der Komfort-Installer überprüft die Release-Prüfsumme vor der Installation:
```bash
curl -fsSL https://raw.githubusercontent.com/Noah4ever/sshconfig-lint/main/install.sh | bash
```
Setze `VERSION=v0.5.0` oder `INSTALL_DIR=~/.local/bin`, um die Standardwerte zu überschreiben.
## GitHub Actions
Die offizielle Action ist im
[GitHub Marketplace](https://github.com/marketplace/actions/sshconfig-lint) verfügbar.
```yaml
name: SSH config
on: [push, pull_request]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: Noah4ever/[email protected]
with:
paths: |
.ssh/config
infrastructure/ssh_config
strict: true
```
Befunde erscheinen als Annotationen an der exakten Datei und Zeile. Die Action lädt das zu ihrem Tag passende Release herunter und überprüft `SHA256SUMS` vor der Ausführung.
Für Repositories mit aktiviertem GitHub Code Scanning kann SARIF separat hochgeladen werden:
```yaml
- run: sshconfig-lint .ssh/config --format sarif > sshconfig-lint.sarif
- uses: github/codeql-action/upload-sarif@v3
with:
sarif_file: sshconfig-lint.sarif
```
## Pre-Commit
```yaml
repos:
- repo: https://github.com/Noah4ever/sshconfig-lint
rev: v1.0.0
hooks:
- id: sshconfig-lint-strict
```
Verwende `id: sshconfig-lint`, wenn Warnungen einen Commit nicht blockieren sollen. Überschreibe `files:` in deinem Projekt, wenn Konfigurationen einer anderen Namenskonvention folgen.
## Editoren
### VS Code
Installiere die [VS Code-Erweiterung](https://marketplace.visualstudio.com/items?itemName=NoahThiering.sshconfig-lint) aus dem Marketplace oder führe aus:
```bash
code --install-extension NoahThiering.sshconfig-lint
```
Die Erweiterung startet `sshconfig-lint lsp`, lädt einmalig eine passende verifizierte Binärdatei herunter und funktioniert danach offline. Sie erkennt `.ssh/config`, `ssh_config` und chezmois `dot_ssh/config`. Es werden keine Telemetriedaten erfasst. Der Quellcode ist in [`editors/vscode`](https://github.com/noah4ever/sshconfig-lint/blob/main/editors/vscode) verfügbar.
### Neovim
Das getestete Beispiel [`editors/neovim`](https://github.com/noah4ever/sshconfig-lint/blob/main/editors/neovim) verwendet den integrierten
LSP-Client von Neovim. Kopiere sein kleines Lua-Modul in deine Konfiguration und starte es mit:
```lua
require("sshconfig_lint").setup()
```
Es verwendet denselben `sshconfig-lint lsp`-Server wie VS Code und unterstützt einen benutzerdefinierten
Binärpfad.
Jeder Editor mit LSP-Unterstützung kann starten:
```bash
sshconfig-lint lsp
```
Der v0.5-Sprachserver veröffentlicht Diagnosen über die gesamte Zeile beim Öffnen, Ändern und Speichern. Unbenannte Puffer führen nur inhaltsbezogene Regeln aus; gespeicherte Dateien lösen zusätzlich `Include` und Dateisystempfade auf. Befunde aus verschachtelten Includes werden an die eingebundene Datei angehängt und mit dem Wurzeldokument gelöscht.
## Ausgabeformate
```bash
sshconfig-lint --format text
sshconfig-lint --format json
sshconfig-lint --format github
sshconfig-lint --format sarif
```
JSON-Befunde enthalten `severity`, `code`, `rule`, `line`, `file`, `message`, `hint` und `documentation`. Regelcodes und Exit-Codes sind stabile Automatisierungsschnittstellen.
| Exit | Bedeutung |
|---:|---|
| `0` | Kein Befund auf Fehlerstufe und keine Warnungen mit `--strict` |
| `1` | Mindestens ein blockierender Befund |
| `2` | Mindestens eine angeforderte Konfiguration konnte nicht gelesen werden |
## Regeln
| Code | Regel | Schweregrad |
|---|---|---|
| `INVALID_VALUE` | [Ungültiger Direktivenwert](https://sshconfig-lint.apps.thiering.org/en/rules/invalid-directive-value) | error |
| `DUP_HOST` | [Doppelter Host-Block](https://sshconfig-lint.apps.thiering.org/en/rules/duplicate-host) | warning |
| `MISSING_IDENTITY` | [IdentityFile nicht gefunden](https://sshconfig-lint.apps.thiering.org/en/rules/identity-file-exists) | error |
| `WILDCARD_ORDER` | [Reihenfolge der Host-Wildcards](https://sshconfig-lint.apps.thiering.org/en/rules/wildcard-host-order) | warning |
| `WEAK_ALGO` | [Schwacher Algorithmus](https://sshconfig-lint.apps.thiering.org/en/rules/deprecated-weak-algorithms) | warning |
| `DUP_DIRECTIVE` | [Doppelte Direktive](https://sshconfig-lint.apps.thiering.org/en/rules/duplicate-directives) | warning |
| `INSECURE_OPT` | [Unsichere Option](https://sshconfig-lint.apps.thiering.org/en/rules/insecure-option) | warning |
| `UNSAFE_CTRL_PATH` | [Unsichere ControlPath](https://sshconfig-lint.apps.thiering.org/en/rules/unsafe-control-path) | warning |
| `INCLUDE_CYCLE` | [Include-Zyklus](https://sshconfig-lint.apps.thiering.org/en/rules/include-cycle) | error |
| `INCLUDE_DEPTH` | [Include-Verschachtelung zu tief](https://sshconfig-lint.apps.thiering.org/en/rules/include-depth) | error |
| `INCLUDE_READ` | [Include kann nicht gelesen werden](https://sshconfig-lint.apps.thiering.org/en/rules/include-read) | error |
| `INCLUDE_GLOB` | [Ungültiges Include-Muster](https://sshconfig-lint.apps.thiering.org/en/rules/include-glob) | error |
| `INCLUDE_NO_MATCH` | [Include entspricht keiner Datei](https://sshconfig-lint.apps.thiering.org/en/rules/include-no-match) | info |
| `NEGATED_HOST` | [Host hat nur negierte Muster](https://sshconfig-lint.apps.thiering.org/en/rules/negated-only-host) | warning |
| `PROXY_CONFLICT` | [Konflikt zwischen ProxyCommand und ProxyJump](https://sshconfig-lint.apps.thiering.org/en/rules/proxy-command-jump-conflict) | warning |
| `REVOKED_HOST_KEYS_UNREADABLE` | [RevokedHostKeys-Datei ist nicht lesbar](https://sshconfig-lint.apps.thiering.org/en/rules/revoked-host-keys-readable) | error |
| `MISSING_CERTIFICATE` | [CertificateFile nicht gefunden](https://sshconfig-lint.apps.thiering.org/en/rules/certificate-file-exists) | error |
| `LOCAL_COMMAND_DISABLED` | [LocalCommand ist nicht aktiviert](https://sshconfig-lint.apps.thiering.org/en/rules/local-command-enabled) | warning |
| `INVALID_TOKEN` | [Ungültiges Prozent-Token](https://sshconfig-lint.apps.thiering.org/en/rules/invalid-percent-token) | error |
| `INVALID_SYNTAX` | [Ungültige Syntax](https://sshconfig-lint.apps.thiering.org/en/rules/invalid-syntax) | error |
| `UNKNOWN_DIRECTIVE` | [Unbekannte Direktive](https://sshconfig-lint.apps.thiering.org/en/rules/unknown-directive) | error |
| `DEPRECATED_OPTION` | [Veraltete Option](https://sshconfig-lint.apps.thiering.org/en/rules/deprecated-option) | warning |
| `INVALID_MATCH` | [Ungültige Match-Bedingung](https://sshconfig-lint.apps.thiering.org/en/rules/invalid-match-condition) | error |
| `CONTROL_PERSIST_UNUSED` | [ControlPersist ohne ControlMaster](https://sshconfig-lint.apps.thiering.org/en/rules/control-persist-requires-master) | warning |
| `UPDATE_HOSTKEYS_ASK_PERSIST` | [UpdateHostKeys ask mit ControlPersist](https://sshconfig-lint.apps.thiering.org/en/rules/update-hostkeys-control-persist) | warning |
Die Regelanleitungen zeigen das exakte fehlerhafte Fragment, eine korrigierte Konfiguration, warum es wichtig ist und wie das Ergebnis mit OpenSSH überprüft werden kann.
`INVALID_VALUE` prüft Ports, Wiederholungs- und Prompt-Zähler, Alive-Einstellungen, `ForwardX11Timeout`, `RequiredRSASize`, `ControlPersist`, boolesche Schalter, `ObscureKeystrokeTiming`, OpenSSH-Zeitwerte, `StreamLocalBindMask`, `IPQoS` und dokumentierte Wertemengen wie `AddressFamily`, `ControlMaster`, `StrictHostKeyChecking`, `LogLevel` und `PubkeyAuthentication`. Von OpenSSH akzeptierte quotierte und groß-/kleinschreibungsunabhängige Werte bleiben gültig. Der Linter akzeptiert moderne Syntax, ohne zu versuchen, die Version des SSH-Clients abzuleiten, der die Konfiguration verwenden wird.
Dateisystemprüfungen überspringen Pfade, die Prozent-Token oder Umgebungsvariablen enthalten, da ihr endgültiger Wert vom Verbindungskontext abhängt. `LOCAL_COMMAND_DISABLED` ist ebenfalls konservativ: Es wird unterdrückt, wenn ein unaufgelöstes `Include` oder ein mögliches `PermitLocalCommand yes` den Befehl wirksam machen könnte. Löse Includes über die normale CLI oder ein gespeichertes Editor-Dokument auf, um das präziseste Ergebnis zu erhalten.
## Entwicklung
Erfordert Rust 1.85 oder neuer.
```bash
cargo test --all
cargo clippy --all-targets --all-features -- -D warnings
cargo fmt -- --check
```
Siehe [CONTRIBUTING.md](https://github.com/noah4ever/sshconfig-lint/blob/main/CONTRIBUTING.md), die öffentliche [Roadmap](https://github.com/noah4ever/sshconfig-lint/blob/main/ROADMAP.md), den
[v1-Stabilitätsvertrag](https://github.com/noah4ever/sshconfig-lint/blob/main/STABILITY.md) und die [Sicherheitsrichtlinie](https://github.com/noah4ever/sshconfig-lint/blob/main/SECURITY.md).
## Lizenz
MIT