---

ggshield: احمِ كودك باستخدام GitGuardian

ggshield هو تطبيق واجهة سطر أوامر (CLI) يعمل في بيئتك المحلية أو في بيئة CI لمساعدتك في اكتشاف أكثر من 500 نوع من الأسرار.

يستخدم ggshield واجهة برمجة التطبيقات العامة الخاصة بنا عبر مكتبة py-gitguardian لفحص واكتشاف الثغرات المحتملة في الملفات والمحتويات النصية الأخرى.

يتم تخزين البيانات الوصفية فقط مثل وقت الاستدعاء وحجم الطلب ووضع الفحص من عمليات الفحص باستخدام ggshield، لذلك لن يتم عرض الأسرار في لوحة التحكم الخاصة بك و لن يتم تخزين ملفاتك وأسرارك.

جدول المحتويات

• التثبيت
  • نص التثبيت (موصى به)
  • macOS
    • Homebrew
    • الحزمة المستقلة .pkg
  • لينكس
    • حزم Deb و RPM
  • ويندوز
    • Chocolatey
    • مثبّت MSI
    • أرشيف .zip مستقل
  • جميع أنظمة التشغيل
    • باستخدام pipx
    • باستخدام pip
• الإعداد الأولي
  • باستخدام ggshield auth login
  • الإعداد اليدوي
• بدء الاستخدام
  • الأسرار
  • ترقية ملف إعدادات قديم
• التكاملات
  • مساعدي البرمجة بالذكاء الاصطناعي
• معرفة المزيد
• المخرجات
• مشاريع مفتوحة المصدر ذات صلة
• الترخيص

التثبيت

نص التثبيت (موصى به)

أسرع طريقة لتثبيت ggshield.

لينكس / macOS:

curl -sSfL \
  https://raw.githubusercontent.com/GitGuardian/ggshield/main/scripts/install/install.sh | bash

ويندوز (PowerShell):

irm https://raw.githubusercontent.com/GitGuardian/ggshield/main/scripts/install/install.ps1 | iex

أو إذا كنت تفضل curl (مضمن مع ويندوز 10+):

curl.exe -sSL https://raw.githubusercontent.com/GitGuardian/ggshield/main/scripts/install/install.ps1 | powershell -NoProfile -ExecutionPolicy Bypass -Command -

يقبل النص خيارات مثل --instance و --plugin (تثبيت إضافة). بالنسبة لمساحة العمل الأوروبية أو مثيل مستضاف ذاتيًا، قم بتعيين متغير البيئة GITGUARDIAN_INSTANCE (أو مرر --instance <URL>) قبل التشغيل.

راجع scripts/install/README.md للحصول على القائمة الكاملة للخيارات، وطرق التثبيت الأخرى، وكيفية إلغاء التثبيت.

الطرق أدناه تقوم بتثبيت CLI يدويًا بدلاً من ذلك.

macOS

Homebrew

يمكنك تثبيت ggshield باستخدام Homebrew:

brew install ggshield

تتم عملية الترقية بواسطة Homebrew.

الحزمة المستقلة .pkg

بدلاً من ذلك، يمكنك تنزيل وتثبيت حزمة .pkg مستقلة من صفحة إصدارات ggshield.

هذه الحزمة لا تتطلب تثبيت Python، ولكن عليك تنزيل الإصدارات الجديدة يدويًا.

لينكس

حزم Deb و RPM

حزم Deb و RPM متاحة على Cloudsmith.

تعليمات الإعداد:

• حزم Deb
• حزم RPM

تتم عملية الترقية بواسطة مدير الحزم.

ويندوز

Chocolatey

ggshield متاح عبر مدير حزم Chocolatey:

choco install ggshield

مثبّت MSI

قم بتنزيل مثبّت MSI من صفحة إصدارات ggshield وقم بتثبيته:

msiexec /i ggshield-VERSION-x86_64-pc-windows-msvc.msi

أرشيف .zip مستقل

نوفر أرشيف .zip مستقل على صفحة إصدارات ggshield.

قم بفك ضغط الأرشيف على القرص الخاص بك، ثم أضف الدليل الذي يحتوي على ملف ggshield.exe إلى %PATH%.

هذا الأرشيف لا يتطلب تثبيت Python، ولكن عليك تنزيل الإصدارات الجديدة يدويًا.

جميع أنظمة التشغيل

يمكن تثبيت ggshield على جميع أنظمة التشغيل المدعومة عبر حزمة PyPI.

يتطلب إصدارًا مدعومًا من Python (ليس منتهي الصلاحية) (باستثناء الحزم المستقلة) و git.

إذا كنت لا تستخدم الإصدارات المعبأة من ggshield، فيرجى العلم أننا نتبع دورة إصدار Python ولا ندعم الإصدارات التي وصلت إلى نهاية العمر الافتراضي.

باستخدام pipx

الطريقة الموصى بها لتثبيت ggshield من PyPI هي استخدام pipx، الذي سيقوم بتثبيته في بيئة معزولة:

pipx install ggshield

لترقية التثبيت الخاص بك، قم بتشغيل:

pipx upgrade ggshield

باستخدام pip

يمكنك أيضًا تثبيت ggshield من PyPI باستخدام pip، لكن هذا غير موصى به لأن التثبيت غير معزول، لذا قد تؤثر التطبيقات أو الحزم الأخرى المثبتة بهذه الطريقة على تثبيت ggshield. هذه الطريقة لن تعمل أيضًا إذا تم تعريف تثبيت Python الخاص بك بأنه مُدار خارجيًا (على سبيل المثال عند استخدام Python النظامي في أنظمة التشغيل مثل Debian 12):

pip install --user ggshield

لترقية التثبيت الخاص بك، قم بتشغيل:

pip install --user --upgrade ggshield

الإعداد الأولي

باستخدام ggshield auth login

لاستخدام ggshield، تحتاج إلى المصادقة ضد خوادم GitGuardian. للقيام بذلك، استخدم الأمر ggshield auth login. يقوم هذا الأمر بأتمتة توفير رمز الوصول الشخصي وتكوينه على محطة العمل المحلية.

يمكنك معرفة المزيد عنه من وثائق ggshield auth login.

الإعداد اليدوي

يمكنك أيضًا إنشاء رمز الوصول الشخصي يدويًا وتخزينه في متغير البيئة GITGUARDIAN_API_KEY لإكمال الإعداد.

بدء الاستخدام

الأسرار

يمكنك الآن استخدام ggshield للبحث عن الأسرار:

• في الملفات: ggshield secret scan path -r .
• في المستودعات: ggshield secret scan repo .
• في صور Docker (يجب أن يكون أمر docker متاحًا): ggshield secret scan docker ubuntu:22.04
• في حزم Pypi (يجب أن يكون أمر pip متاحًا): ggshield secret scan pypi flask
• والمزيد، ألق نظرة على مخرجات ggshield secret scan --help للحصول على التفاصيل.

ترقية ملف إعدادات قديم

إذا أبلغ ggshield أن ملف الإعدادات .gitguardian.yaml (أو .gitguardian.yml) الخاص بك يستخدم تنسيقًا قديمًا، فقم بترقيته إلى أحدث إصدار باستخدام:

ggshield config migrate

افتراضيًا، يبحث هذا عن ملف الإعدادات في الدليل الحالي، لذا قم بتشغيله من الدليل الذي يحتوي على الملف. لتشغيله من أي مكان، قم بتوجيه ggshield إلى الملف صراحة: