
Linter baseado em regras para arquivos de configuração do cliente OpenSSH que detecta hosts duplicados, arquivos de identidade ausentes, algoritmos fracos, problemas de ordenação de curingas e configurações perigosas, com saída JSON e códigos de saída compatíveis com CI.
# sshconfig-lint
[](https://github.com/Noah4ever/sshconfig-lint/actions/workflows/tests.yml)
[](https://crates.io/crates/sshconfig-lint)
[](LICENSE)
**Um único motor para todos os lugares onde sua configuração SSH muda.**
O sshconfig-lint encontra erros semânticos em configurações de cliente OpenSSH: hosts duplicados, caminhos de identidade quebrados, opções inseguras, algoritmos fracos, ordenação de curingas e cadeias de `Include` emaranhadas. Use os mesmos códigos de regra localmente, em hooks do Git, GitHub Actions e editores.
[Experimente o playground privado no navegador](https://sshconfig-lint.apps.thiering.org/en) · [Aprenda com exemplos interativos](https://sshconfig-lint.apps.thiering.org/en/learn) · [Leia todas as regras](https://sshconfig-lint.apps.thiering.org/en/rules)
O verificador no navegador é executado no seu dispositivo. O conteúdo da configuração não é enviado e nenhuma telemetria é coletada.
## Início rápido
```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
```
## Instalação
### Homebrew
```bash
brew tap Noah4ever/tap
brew install sshconfig-lint
```
### Cargo
```bash
cargo install sshconfig-lint
```
### Arch Linux
```bash
yay -S sshconfig-lint-bin
```
A [página de releases](https://github.com/Noah4ever/sshconfig-lint/releases) fornece binários verificados para Linux, macOS e Windows. O instalador de conveniência verifica o checksum da release antes de instalar:
```bash
curl -fsSL https://raw.githubusercontent.com/Noah4ever/sshconfig-lint/main/install.sh | bash
```
Defina `VERSION=v0.5.0` ou `INSTALL_DIR=~/.local/bin` para substituir os padrões.
## GitHub Actions
A Action oficial está disponível no
[GitHub Marketplace](https://github.com/marketplace/actions/sshconfig-lint).
```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
```
Os achados aparecem como anotações no arquivo e na linha exatos. A Action baixa a release correspondente à sua tag e verifica o `SHA256SUMS` antes da execução.
Para repositórios com o GitHub Code Scanning habilitado, o SARIF pode ser enviado separadamente:
```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
```
Use `id: sshconfig-lint` quando os avisos não devem bloquear um commit. Substitua `files:` no seu projeto quando as configurações usarem outra convenção de nomenclatura.
## Editores
### VS Code
Instale a [extensão do VS Code](https://marketplace.visualstudio.com/items?itemName=NoahThiering.sshconfig-lint) pelo Marketplace ou execute:
```bash
code --install-extension NoahThiering.sshconfig-lint
```
A extensão inicia `sshconfig-lint lsp`, baixa uma vez um binário verificado correspondente e depois funciona offline. Ela reconhece `.ssh/config`, `ssh_config` e `dot_ssh/config` do chezmoi. Nenhuma telemetria é coletada. Seu código-fonte está disponível em [`editors/vscode`](https://github.com/noah4ever/sshconfig-lint/blob/main/editors/vscode).
### Neovim
O exemplo testado em [`editors/neovim`](https://github.com/noah4ever/sshconfig-lint/blob/main/editors/neovim) usa o cliente
LSP integrado do Neovim. Copie seu pequeno módulo Lua para sua configuração e inicie-o com:
```lua
require("sshconfig_lint").setup()
```
Ele usa o mesmo servidor `sshconfig-lint lsp` que o VS Code e suporta um caminho
personalizado para o binário.
Qualquer editor com suporte a LSP pode iniciar:
```bash
sshconfig-lint lsp
```
O servidor de linguagem v0.5 publica diagnósticos de linha completa ao abrir, alterar e salvar. Buffers sem título executam apenas regras de conteúdo; arquivos salvos também resolvem `Include` e caminhos do sistema de arquivos. Achados de Includes aninhados são anexados ao arquivo incluído e limpos com o documento raiz.
## Formatos de saída
```bash
sshconfig-lint --format text
sshconfig-lint --format json
sshconfig-lint --format github
sshconfig-lint --format sarif
```
Os achados em JSON contêm `severity`, `code`, `rule`, `line`, `file`, `message`, `hint` e `documentation`. Os códigos de regra e os códigos de saída são interfaces de automação estáveis.
| Saída | Significado |
|---:|---|
| `0` | Nenhum achado de nível de erro, e nenhum aviso com `--strict` |
| `1` | Pelo menos um achado bloqueante |
| `2` | Pelo menos uma configuração solicitada não pôde ser lida |
## Regras
| Código | Regra | Severidade |
|---|---|---|
| `INVALID_VALUE` | [Valor de diretiva inválido](https://sshconfig-lint.apps.thiering.org/en/rules/invalid-directive-value) | error |
| `DUP_HOST` | [Bloco Host duplicado](https://sshconfig-lint.apps.thiering.org/en/rules/duplicate-host) | warning |
| `MISSING_IDENTITY` | [IdentityFile não encontrado](https://sshconfig-lint.apps.thiering.org/en/rules/identity-file-exists) | error |
| `WILDCARD_ORDER` | [Ordem de curinga em Host](https://sshconfig-lint.apps.thiering.org/en/rules/wildcard-host-order) | warning |
| `WEAK_ALGO` | [Algoritmo fraco](https://sshconfig-lint.apps.thiering.org/en/rules/deprecated-weak-algorithms) | warning |
| `DUP_DIRECTIVE` | [Diretiva duplicada](https://sshconfig-lint.apps.thiering.org/en/rules/duplicate-directives) | warning |
| `INSECURE_OPT` | [Opção insegura](https://sshconfig-lint.apps.thiering.org/en/rules/insecure-option) | warning |
| `UNSAFE_CTRL_PATH` | [ControlPath inseguro](https://sshconfig-lint.apps.thiering.org/en/rules/unsafe-control-path) | warning |
| `INCLUDE_CYCLE` | [Ciclo de Include](https://sshconfig-lint.apps.thiering.org/en/rules/include-cycle) | error |
| `INCLUDE_DEPTH` | [Aninhamento de Include muito profundo](https://sshconfig-lint.apps.thiering.org/en/rules/include-depth) | error |
| `INCLUDE_READ` | [Include não pode ser lido](https://sshconfig-lint.apps.thiering.org/en/rules/include-read) | error |
| `INCLUDE_GLOB` | [Padrão de Include inválido](https://sshconfig-lint.apps.thiering.org/en/rules/include-glob) | error |
| `INCLUDE_NO_MATCH` | [Include não corresponde a nenhum arquivo](https://sshconfig-lint.apps.thiering.org/en/rules/include-no-match) | info |
| `NEGATED_HOST` | [Host tem apenas padrões negados](https://sshconfig-lint.apps.thiering.org/en/rules/negated-only-host) | warning |
| `PROXY_CONFLICT` | [Conflito entre ProxyCommand e ProxyJump](https://sshconfig-lint.apps.thiering.org/en/rules/proxy-command-jump-conflict) | warning |
| `REVOKED_HOST_KEYS_UNREADABLE` | [Arquivo RevokedHostKeys não pode ser lido](https://sshconfig-lint.apps.thiering.org/en/rules/revoked-host-keys-readable) | error |
| `MISSING_CERTIFICATE` | [CertificateFile não encontrado](https://sshconfig-lint.apps.thiering.org/en/rules/certificate-file-exists) | error |
| `LOCAL_COMMAND_DISABLED` | [LocalCommand não está habilitado](https://sshconfig-lint.apps.thiering.org/en/rules/local-command-enabled) | warning |
| `INVALID_TOKEN` | [Token de porcentagem inválido](https://sshconfig-lint.apps.thiering.org/en/rules/invalid-percent-token) | error |
| `INVALID_SYNTAX` | [Sintaxe inválida](https://sshconfig-lint.apps.thiering.org/en/rules/invalid-syntax) | error |
| `UNKNOWN_DIRECTIVE` | [Diretiva desconhecida](https://sshconfig-lint.apps.thiering.org/en/rules/unknown-directive) | error |
| `DEPRECATED_OPTION` | [Opção obsoleta](https://sshconfig-lint.apps.thiering.org/en/rules/deprecated-option) | warning |
| `INVALID_MATCH` | [Condição Match inválida](https://sshconfig-lint.apps.thiering.org/en/rules/invalid-match-condition) | error |
| `CONTROL_PERSIST_UNUSED` | [ControlPersist sem ControlMaster](https://sshconfig-lint.apps.thiering.org/en/rules/control-persist-requires-master) | warning |
| `UPDATE_HOSTKEYS_ASK_PERSIST` | [UpdateHostKeys ask com ControlPersist](https://sshconfig-lint.apps.thiering.org/en/rules/update-hostkeys-control-persist) | warning |
Os guias de regras mostram o fragmento quebrado exato, uma configuração corrigida, por que isso importa e como verificar o resultado com o OpenSSH.
`INVALID_VALUE` verifica portas, contadores de retry e prompt, configurações de alive, `ForwardX11Timeout`, `RequiredRSASize`, `ControlPersist`, chaves booleanas, `ObscureKeystrokeTiming`, valores de tempo do OpenSSH, `StreamLocalBindMask`, `IPQoS` e conjuntos de valores documentados como `AddressFamily`, `ControlMaster`, `StrictHostKeyChecking`, `LogLevel` e `PubkeyAuthentication`. Valores entre aspas e sem distinção de maiúsculas/minúsculas aceitos pelo OpenSSH permanecem válidos. O linter aceita sintaxe moderna sem tentar inferir a versão do cliente SSH que consumirá a configuração.
As verificações de sistema de arquivos ignoram caminhos que contêm tokens de porcentagem ou variáveis de ambiente, pois seu valor final depende do contexto da conexão. `LOCAL_COMMAND_DISABLED` é igualmente conservador: é suprimido quando um `Include` não resolvido ou qualquer possível `PermitLocalCommand yes` poderia tornar o comando efetivo. Resolva Includes pelo CLI normal ou por um documento salvo no editor para obter o resultado mais preciso.
## Desenvolvimento
Requer Rust 1.85 ou mais recente.
```bash
cargo test --all
cargo clippy --all-targets --all-features -- -D warnings
cargo fmt -- --check
```
Consulte [CONTRIBUTING.md](https://github.com/noah4ever/sshconfig-lint/blob/main/CONTRIBUTING.md), o [roadmap](https://github.com/noah4ever/sshconfig-lint/blob/main/ROADMAP.md) público, o
[contrato de estabilidade v1](https://github.com/noah4ever/sshconfig-lint/blob/main/STABILITY.md) e a [política de segurança](https://github.com/noah4ever/sshconfig-lint/blob/main/SECURITY.md).
## Licença
MITDescubra as ferramentas mais usadas pela nossa comunidade.
Sem dados de popularidade ainda.