
مدقق قائم على القواعد لملفات تكوين عميل OpenSSH يكتشف الـhosts المكررة، ملفات الهوية المفقودة، الخوارزميات الضعيفة، مشاكل ترتيب wildcard، والإعدادات الخطرة مع إخراج JSON ورموز خروج مناسبة لـ CI.
# sshconfig-lint
[](https://github.com/Noah4ever/sshconfig-lint/actions/workflows/tests.yml)
[](https://crates.io/crates/sshconfig-lint)
[](LICENSE)
**محرك واحد لكل مكان يتغير فيه إعداد SSH الخاص بك.**
يكتشف sshconfig-lint الأخطاء الدلالية في إعدادات عميل OpenSSH: المضيفات المكررة، مسارات الهوية المعطوبة، الخيارات غير الآمنة، الخوارزميات الضعيفة، ترتيب أحرف البدل، وسلاسل `Include` المتشابكة. استخدم نفس رموز القواعد محليًا، في خطافات Git، وGitHub Actions، والمحررات.
[جرّب ساحة اللعب الخاصة في المتصفح](https://sshconfig-lint.apps.thiering.org/en) · [تعلّم من خلال أمثلة تفاعلية](https://sshconfig-lint.apps.thiering.org/en/learn) · [اقرأ كل قاعدة](https://sshconfig-lint.apps.thiering.org/en/rules)
يعمل مدقق المتصفح على جهازك. لا يتم رفع محتويات الإعداد ولا يتم جمع أي بيانات قياس عن بُعد.
## البدء السريع
```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
```
## التثبيت
### Homebrew
```bash
brew tap Noah4ever/tap
brew install sshconfig-lint
```
### Cargo
```bash
cargo install sshconfig-lint
```
### Arch Linux
```bash
yay -S sshconfig-lint-bin
```
توفر [صفحة الإصدارات](https://github.com/Noah4ever/sshconfig-lint/releases) ملفات ثنائية موثقة لأنظمة Linux وmacOS وWindows. يتحقق مثبّت الراحة من مجموع التحقق للإصدار قبل التثبيت:
```bash
curl -fsSL https://raw.githubusercontent.com/Noah4ever/sshconfig-lint/main/install.sh | bash
```
قم بتعيين `VERSION=v0.5.0` أو `INSTALL_DIR=~/.local/bin` لتجاوز الإعدادات الافتراضية.
## GitHub Actions
الإجراء الرسمي متاح في
[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
```
تظهر النتائج كتعليقات توضيحية على الملف والسطر المحددين. يقوم الإجراء بتنزيل الإصدار المطابق لوسمه ويتحقق من `SHA256SUMS` قبل التنفيذ.
بالنسبة للمستودعات التي تحتوي على GitHub Code Scanning مفعّل، يمكن رفع SARIF بشكل منفصل:
```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
```
استخدم `id: sshconfig-lint` عندما لا ينبغي للتحذيرات أن تمنع الالتزام. تجاوز `files:` في مشروعك عندما تستخدم الإعدادات اصطلاح تسمية آخر.
## المحررات
### VS Code
ثبّت [إضافة VS Code](https://marketplace.visualstudio.com/items?itemName=NoahThiering.sshconfig-lint) من Marketplace أو شغّل:
```bash
code --install-extension NoahThiering.sshconfig-lint
```
تبدأ الإضافة `sshconfig-lint lsp`، وتنزّل ملفًا ثنائيًا موثقًا مطابقًا مرة واحدة، ثم تعمل دون اتصال. تتعرف على `.ssh/config` و`ssh_config` و`dot_ssh/config` الخاص بـ chezmoi. لا يتم جمع أي بيانات قياس عن بُعد. مصدرها متاح في [`editors/vscode`](https://github.com/noah4ever/sshconfig-lint/blob/main/editors/vscode).
### Neovim
يستخدم مثال [`editors/neovim`](https://github.com/noah4ever/sshconfig-lint/blob/main/editors/neovim) المُختبر عميل
LSP المدمج في Neovim. انسخ وحدة Lua الصغيرة الخاصة به إلى إعداداتك وابدأها بـ:
```lua
require("sshconfig_lint").setup()
```
يستخدم نفس خادم `sshconfig-lint lsp` المستخدم في VS Code ويدعم مسارًا
مخصصًا للملف الثنائي.
يمكن لأي محرر يدعم LSP أن يبدأ:
```bash
sshconfig-lint lsp
```
ينشر خادم اللغة v0.5 تشخيصات كاملة الأسطر عند الفتح والتغيير والحفظ. تشغّل المخازن المؤقتة غير المسماة قواعد المحتوى فقط؛ بينما تحل الملفات المحفوظة بالإضافة إلى ذلك `Include` ومسارات نظام الملفات. تُرفق النتائج من Includes المتداخلة بالملف المُضمّن وتُمسح مع المستند الجذر.
## صيغ الإخراج
```bash
sshconfig-lint --format text
sshconfig-lint --format json
sshconfig-lint --format github
sshconfig-lint --format sarif
```
تحتوي نتائج JSON على `severity` و`code` و`rule` و`line` و`file` و`message` و`hint` و`documentation`. رموز القواعد ورموز الخروج هي واجهات أتمتة مستقرة.
| الخروج | المعنى |
|---:|---|
| `0` | لا توجد نتيجة بمستوى خطأ، ولا تحذيرات مع `--strict` |
| `1` | نتيجة حاجبة واحدة على الأقل |
| `2` | تعذّر قراءة إعداد واحد مطلوب على الأقل |
## القواعد
| الرمز | القاعدة | الخطورة |
|---|---|---|
| `INVALID_VALUE` | [قيمة توجيه غير صالحة](https://sshconfig-lint.apps.thiering.org/en/rules/invalid-directive-value) | error |
| `DUP_HOST` | [كتلة Host مكررة](https://sshconfig-lint.apps.thiering.org/en/rules/duplicate-host) | warning |
| `MISSING_IDENTITY` | [IdentityFile غير موجود](https://sshconfig-lint.apps.thiering.org/en/rules/identity-file-exists) | error |
| `WILDCARD_ORDER` | [ترتيب أحرف البدل في Host](https://sshconfig-lint.apps.thiering.org/en/rules/wildcard-host-order) | warning |
| `WEAK_ALGO` | [خوارزمية ضعيفة](https://sshconfig-lint.apps.thiering.org/en/rules/deprecated-weak-algorithms) | warning |
| `DUP_DIRECTIVE` | [توجيه مكرر](https://sshconfig-lint.apps.thiering.org/en/rules/duplicate-directives) | warning |
| `INSECURE_OPT` | [خيار غير آمن](https://sshconfig-lint.apps.thiering.org/en/rules/insecure-option) | warning |
| `UNSAFE_CTRL_PATH` | [ControlPath غير آمن](https://sshconfig-lint.apps.thiering.org/en/rules/unsafe-control-path) | warning |
| `INCLUDE_CYCLE` | [دورة Include](https://sshconfig-lint.apps.thiering.org/en/rules/include-cycle) | error |
| `INCLUDE_DEPTH` | [تداخل Include عميق جدًا](https://sshconfig-lint.apps.thiering.org/en/rules/include-depth) | error |
| `INCLUDE_READ` | [تعذّر قراءة Include](https://sshconfig-lint.apps.thiering.org/en/rules/include-read) | error |
| `INCLUDE_GLOB` | [نمط Include غير صالح](https://sshconfig-lint.apps.thiering.org/en/rules/include-glob) | error |
| `INCLUDE_NO_MATCH` | [Include لا يطابق أي ملفات](https://sshconfig-lint.apps.thiering.org/en/rules/include-no-match) | info |
| `NEGATED_HOST` | [Host يحتوي على أنماط منفية فقط](https://sshconfig-lint.apps.thiering.org/en/rules/negated-only-host) | warning |
| `PROXY_CONFLICT` | [تعارض ProxyCommand وProxyJump](https://sshconfig-lint.apps.thiering.org/en/rules/proxy-command-jump-conflict) | warning |
| `REVOKED_HOST_KEYS_UNREADABLE` | [ملف RevokedHostKeys غير قابل للقراءة](https://sshconfig-lint.apps.thiering.org/en/rules/revoked-host-keys-readable) | error |
| `MISSING_CERTIFICATE` | [CertificateFile غير موجود](https://sshconfig-lint.apps.thiering.org/en/rules/certificate-file-exists) | error |
| `LOCAL_COMMAND_DISABLED` | [LocalCommand غير مفعّل](https://sshconfig-lint.apps.thiering.org/en/rules/local-command-enabled) | warning |
| `INVALID_TOKEN` | [رمز نسبة مئوية غير صالح](https://sshconfig-lint.apps.thiering.org/en/rules/invalid-percent-token) | error |
| `INVALID_SYNTAX` | [صيغة غير صالحة](https://sshconfig-lint.apps.thiering.org/en/rules/invalid-syntax) | error |
| `UNKNOWN_DIRECTIVE` | [توجيه غير معروف](https://sshconfig-lint.apps.thiering.org/en/rules/unknown-directive) | error |
| `DEPRECATED_OPTION` | [خيار مهمل](https://sshconfig-lint.apps.thiering.org/en/rules/deprecated-option) | warning |
| `INVALID_MATCH` | [شرط Match غير صالح](https://sshconfig-lint.apps.thiering.org/en/rules/invalid-match-condition) | error |
| `CONTROL_PERSIST_UNUSED` | [ControlPersist بدون ControlMaster](https://sshconfig-lint.apps.thiering.org/en/rules/control-persist-requires-master) | warning |
| `UPDATE_HOSTKEYS_ASK_PERSIST` | [UpdateHostKeys ask مع ControlPersist](https://sshconfig-lint.apps.thiering.org/en/rules/update-hostkeys-control-persist) | warning |
تعرض أدلة القواعد الجزء المعطوب بالضبط، وإعدادًا مصححًا، وسبب أهميته، وكيفية التحقق من النتيجة باستخدام OpenSSH.
يتحقق `INVALID_VALUE` من المنافذ، وعدادات إعادة المحاولة والمطالبات، وإعدادات alive، و`ForwardX11Timeout`، و`RequiredRSASize`، و`ControlPersist`، والمفاتيح المنطقية، و`ObscureKeystrokeTiming`، وقيم الوقت في OpenSSH، و`StreamLocalBindMask`، و`IPQoS`، ومجموعات القيم الموثقة مثل `AddressFamily` و`ControlMaster` و`StrictHostKeyChecking` و`LogLevel` و`PubkeyAuthentication`. تظل القيم المقتبسة وغير الحساسة لحالة الأحرف المقبولة من OpenSSH صالحة. يقبل المدقق الصيغة الحديثة دون محاولة استنتاج إصدار عميل SSH الذي سيستهلك الإعداد.
تتخطى فحوصات نظام الملفات المسارات التي تحتوي على رموز نسبة مئوية أو متغيرات بيئة لأن قيمتها النهائية تعتمد على سياق الاتصال. `LOCAL_COMMAND_DISABLED` متحفظ بالمثل: يتم تعطيله عندما يمكن لـ `Include` غير محلول أو أي `PermitLocalCommand yes` محتمل أن يجعل الأمر فعّالًا. حلّل Includes من خلال CLI العادي أو مستند محرر محفوظ للحصول على أدق نتيجة.
## التطوير
يتطلب Rust 1.85 أو أحدث.
```bash
cargo test --all
cargo clippy --all-targets --all-features -- -D warnings
cargo fmt -- --check
```
راجع [CONTRIBUTING.md](https://github.com/noah4ever/sshconfig-lint/blob/main/CONTRIBUTING.md)، و[خارطة الطريق](https://github.com/noah4ever/sshconfig-lint/blob/main/ROADMAP.md) العامة، و
[عقد استقرار v1](https://github.com/noah4ever/sshconfig-lint/blob/main/STABILITY.md)، و[سياسة الأمان](https://github.com/noah4ever/sshconfig-lint/blob/main/SECURITY.md).
## الترخيص
MIT