sshconfig-lint

Lint deine ~/.ssh/config auf häufige Fehler.

Prüft auf doppelte Host-Blöcke, fehlende Identitätsdateien, Probleme mit der Wildcard-Reihenfolge, schwache Algorithmen, doppelte Direktiven und mehr. Unterstützt Include-Direktiven mit Zykluserkennung.

https://github.com/user-attachments/assets/4d995679-baed-4f20-9ba8-8f3ec94c64fd

Installation

Schnellinstallation (Linux / macOS)

curl -fsSL https://raw.githubusercontent.com/Noah4ever/sshconfig-lint/main/install.sh | bash

Setze VERSION=v0.1.0 oder INSTALL_DIR=~/.local/bin, um die Standardwerte zu überschreiben.

macOS (Homebrew)

brew tap Noah4ever/tap
brew install sshconfig-lint

optionaler Befehl untap Noah4ever/tap zum Entfernen des Taps und um die Tap-Liste sauber zu halten.

Cargo

cargo install sshconfig-lint

AUR

sshconfig-lint-bin - vorgefertigte Binärdateien

yay -S sshconfig-lint-bin

paru -S sshconfig-lint-bin

Vorgefertigte Binärdateien

Hole dir eine Binärdatei von der Releases-Seite.

Verwendung

# lint the default ~/.ssh/config
sshconfig-lint

# lint a specific file
sshconfig-lint --config /path/to/config

# json output
sshconfig-lint --format json

# treat warnings as errors (useful in CI)
sshconfig-lint --strict

# skip Include resolution
sshconfig-lint --no-includes

Beispielausgabe

line 4: [warning] WILDCARD_ORDER (wildcard-host-order) Host 'github.com' appears after 'Host *' (line 1); it will never match because Host * already matched (hint: move Host * to the end of the file)
line 7: [warning] DUP_HOST (duplicate-host) duplicate Host block 'github.com' (first seen at line 4) (hint: remove one of the duplicate Host blocks)
line 3: [error] MISSING_IDENTITY (identity-file-exists) IdentityFile not found: ~/.ssh/id_missing (hint: check the path or remove the directive)

Die Ausgabe ist nach Datei und Zeilennummer sortiert, sodass sie über verschiedene Läufe hinweg deterministisch ist (stabil für CI-Diffs und Snapshots).

Fehler sind rot, Warnungen gelb, Informationen cyan. Farben werden automatisch deaktiviert, wenn stdout kein Terminal ist oder wenn NO_COLOR gesetzt ist.

Exit-Codes

Regeln

Jeder Fund hat einen stabilen Code, nach dem Sie in Skripten greppen oder suchen können.

Funde enthalten wenn möglich einen Hinweis, z. B. „verschiebe Host * an das Ende der Datei“.

Was es behandelt

• Mehrere Host-Muster (Host github.com gitlab.com)
• Mehrere Include-Muster (Include conf.d/*.conf extra.conf)
• Inline-Kommentare (IdentityFile ~/.ssh/id # my key)
• Angeführte Werte (ProxyCommand "ssh -W %h:%p bastion")
• Include-Auflösung mit Zykluserkennung

Entwicklung

cargo test          # run all tests
cargo test --lib    # unit tests only
cargo clippy        # lint
cargo fmt --check   # formatting

Projektstruktur

src/
  main.rs        CLI
  lib.rs         Public API (lint_file, lint_str)
  model.rs       AST types
  lexer.rs       Tokenizer
  parser.rs      Builds config AST from tokens
  resolve.rs     Include expansion + cycle detection
  report.rs      Text and JSON formatters
  rules/
    mod.rs       Rule trait and runner
    basic.rs     Built-in rules
tests/
  fixtures/      Sample config files
  cli.rs         CLI integration tests
  integration.rs Fixture-based tests

Hinzufügen einer Regel

1. Implementiere das Rule-Trait in src/rules/basic.rs
2. Registriere es in run_all() in src/rules/mod.rs
3. Schreibe zuerst Tests, dann lass sie bestehen

Siehe CONTRIBUTING.md für weitere Details.

Lizenz

MIT