
redact v0.2.2
قم بتجريد المحتوى الشبيه بالبيانات الاعتمادية من السلاسل النصية الحرة قبل وصولها إلى السجلات أو بيانات القياس عن بُعد. جزء من مجموعة أدوات phpboyscout Go. · https://redact.go.phpboyscout.uk
redact
إزالة المحتوى الشبيه ببيانات الاعتماد من النصوص الحرة قبل وصولها إلى السجلات أو القياسات عن بُعد أو أي واجهة خارجية
جزء من phpboyscout Go toolkit: وحدات Go صغيرة بلا إطار عمل، مستخرجة من go-tool-base. التوثيق: redact.go.phpboyscout.uk
تُزيل gitlab.com/phpboyscout/go/redact المحتوى الشبيه ببيانات الاعتماد من النصوص
الحرة عند الحدود بين أسطح المراقبة الموثوقة وغير الموثوقة، مثل
موردي القياسات عن بُعد ومجمِّعات السجلات ومخازن المقاييس. فرسائل الأخطاء ومعاملات
الأوامر وقيم ترويسات HTTP كثيرًا ما تحمل أسرارًا عن غير قصد (عنوان URL يحتوي
على معلومات مستخدم مضمّنة، أو علامة --api-key=sk-… في os.Args، أو ترويسة
Authorization مقتبسة في خطأ تصدير). مرِّر هذه عبر redact.String عند
الإخراج ولن تغادر العملية أبدًا بصورة مكشوفة.
التصميم
- بلا اعتماديات. مكتبة قياسية خالصة (
regexp،strings)، فلا يدخل رسمَ اعتمادياتك سوى الوحدة نفسها. ويفرض ذلك حارسٌ فيdepfootprint_test.go، ويُقيّد الاختبارات بـtestifyوبـgo/errorsالخاص بالمشروع. - إزالة عند الحدود. نظِّف البيانات حيث تغادر المضيف، لا في كل مكان.
- متحفّظة افتراضيًا. يتطلب البديل الاحتياطي للرموز المعتمة ≥41 حرفًا كي لا يُنتج إيجابيات كاذبة على UUIDs أو MD5 أو SHA-1.
التثبيت
go get gitlab.com/phpboyscout/go/redact
الاستخدام
import "gitlab.com/phpboyscout/go/redact"
safe := redact.String("failed calling https://user:[email protected]?api_key=sk-abc123…")
// → credentials in the URL userinfo, the api_key query param, and the sk- token are masked
msg := redact.Error(err) // redact.String applied to err.Error() (nil-safe)
if redact.IsSensitiveHeaderKey("Authorization") { /* … redact this header's value … */ }
redact.String يزيل معلومات المستخدم من عناوين URL لأي مخطط (https://، postgres://،
redis://، …)، وتعيينات بيانات الاعتماد بصيغة name=value، وحقول بيانات الاعتماد في JSON مثل
"access_token" و"client_secret"، ورموز ترويسة Authorization، ورموز JWT،
وبادئات المزوّدين المعروفة (sk-، ghp_، glpat-، AIza، AKIA، Slack، Hugging Face)،
والرموز المعتمة الطويلة. وتحدّد SensitiveHeaderKeys / IsSensitiveHeaderKey
الترويسات التي ينبغي حجب قيمها.
القيود
لا تبلغ كتالوجات الأنماط استدعاءً كاملًا بنسبة 100% أبدًا، وهذا الكتالوج متحفظ عمدًا:
- لا يوجد إعداد. لا يمكنك إضافة نمط أو تعطيله أو إعادة ترتيبه. تُصدّر الحزمة أربعة رموز ولا شيء قابل للضبط. ركّب حولها بدلًا من ذلك.
- لا تحجب
Stringقيم الترويسات العشوائية. فهي تعرفAuthorization:ولا شيء غيره؛ تمرّX-API-Key: …دون تغيير. وهذا هو الغرض من رموز الترويسات. - تتسرّب الأسرار المخصّصة والقصيرة. يحتاج النمط الاحتياطي الشامل إلى 41 حرفًا، ولكل بادئة مزوّد حدّ أدنى صارم للطول. كما يستثني تسلسلًا يُقرأ ككلمات، لذا تمرّ عبارة مرور مكوّنة من كلمات قاموسية.
- الأنماط بترميز ASCII فقط، والحجب أحادي الاتجاه: لا شيء قابل للعكس ولا سجل لما تم استبداله.
توضّح صفحة ما لا يفعله redact الحدود الكاملة.
التوثيق
أدلة كاملة ومرجع ونموذج تهديد: redact.go.phpboyscout.uk. وثائق API المولّدة وأمثلة قابلة للتشغيل: pkg.go.dev.
الترخيص
انظر LICENSE.