sshconfig-lint

Esegui il lint del tuo ~/.ssh/config per errori comuni.

Controlla la presenza di blocchi host duplicati, file identity mancanti, problemi di ordinamento dei wildcard, algoritmi deboli, direttive duplicate e altro. Supporta le direttive Include con rilevamento dei cicli.

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

Installazione

Installazione rapida (Linux / macOS)

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

Imposta VERSION=v0.1.0 o INSTALL_DIR=~/.local/bin per sovrascrivere i valori predefiniti.

macOS (Homebrew)

brew tap Noah4ever/tap
brew install sshconfig-lint

opzionale: untap Noah4ever/tap per rimuovere il tap e mantenere pulita la lista dei tap

Cargo

cargo install sshconfig-lint

AUR

sshconfig-lint-bin - binari precompilati

yay -S sshconfig-lint-bin

paru -S sshconfig-lint-bin

Binari precompilati

Scarica un binario dalla pagina delle release.

Utilizzo

# 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

Output di esempio

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)

L'output è ordinato per file e numero di riga, quindi è deterministico tra le esecuzioni (stabile per diff e snapshot CI).

Gli errori sono rossi, gli avvisi gialli, le informazioni ciano. I colori vengono disattivati automaticamente quando stdout non è un terminale o quando NO_COLOR è impostato.

Codici di uscita

Regole

Ogni riscontro ha un codice stabile che puoi cercare con grep o usare negli script.

I riscontri includono un suggerimento quando possibile, ad esempio «sposta Host * alla fine del file».

Cosa gestisce

• Pattern host multipli (Host github.com gitlab.com)
• Pattern include multipli (Include conf.d/*.conf extra.conf)
• Commenti inline (IdentityFile ~/.ssh/id # my key)
• Valori tra virgolette (ProxyCommand "ssh -W %h:%p bastion")
• Risoluzione Include con rilevamento dei cicli

Sviluppo

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

Struttura del progetto

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

Aggiungere una regola

1. Implementa il trait Rule in src/rules/basic.rs
2. Registralo in run_all() in src/rules/mod.rs
3. Scrivi prima i test, poi falli passare

Vedi CONTRIBUTING.md per maggiori dettagli.

Licenza

MIT