Canarytokens

بواسطة Thinkst Applied Research

نظرة عامة

تساعد Canarytokens في تتبع النشاط والإجراءات على شبكتك.

إذا واجهت أي مشكلات، يرجى مراجعة الأسئلة الشائعة هنا، أو إنشاء issue وسنحاول الرد عليك في أقرب وقت ممكن.

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

• مدونة قواعد السلوك
• الميزات المهملة
• التثبيت
• الإعداد
• البنية التحتية لـ AWS ID
• إعداد SMTP الصادر
• الحد من التنبيهات
• الحد من فشل Webhook
• الأسئلة الشائعة
• المساهمة

مدونة قواعد السلوك

يخضع هذا المشروع وكل من يشارك فيه إلى مدونة قواعد السلوك. بالمشاركة، يُتوقع منك الالتزام بهذه المدونة. يرجى الإبلاغ عن السلوك غير المقبول إلى [email protected].

الميزات المهملة

• تم إهمال رمز Slack API ولم يعد من الممكن إنشاء رموز جديدة. ستظل الرموز القديمة تعمل.

التثبيت

نوصي بـ عملية التثبيت عبر صورة Docker.

الإعداد

يمكن لخادم Canarytokens استخدام العديد من إعدادات التهيئة المختلفة. يمكنك العثور عليها في settings.py. يوجد ملفا إعداد رئيسيان: frontend.env و switchboard.env.

يحتوي frontend.env على إعدادات عملية الواجهة الأمامية مثل:

• CANARY_DOMAINS=mytesttokensdomain.com
• CANARY_NXDOMAINS=pdf.demo.canarytokens.net
• CANARY_AWSID_URL=<رابط مخصص لـ awsid>
• CANARY_AWSID_AUTH=<رمز مصادقة مشترك لـ awsid>
• CANARY_AWSID_GUID=<معرّف guid مسجل لوحدة تحكم awsid>
• CANARY_AWSID_CONTROL_ACCOUNT_ID=<معرّف حساب تحكم awsid>
• CANARY_WEB_IMAGE_UPLOAD_PATH=/uploads
• CANARY_GOOGLE_API_KEY=<مفتاح api مخصص لـ google maps>
• LOG_FILE=frontend.log

يحتوي switchboard.env على إعدادات عملية switchboard مثل:

يرجى ملاحظة أنه عند اختيار مزود البريد الإلكتروني الذي ترغب في استخدامه، يجب عليك فقط تقديم المعلومات المتعلقة بذلك المزود. على سبيل المثال، إذا كان لديك CANARY_MAILGUN_API_KEY فيجب عليك إزالة المفاتيح الأخرى مثل CANARY_SENDGRID_API_KEY و CANARY_MANDRILL_API_KEY.

إذا كنت تستخدم البنية التحتية الأوروبية لـ Mailgun لخادم Canarytokens الخاص بك، فستحتاج إلى إضافة CANARY_MAILGUN_BASE_URL=https://api.eu.mailgun.net إلى switchboard.env الخاص بك. إذا لم تحدد ذلك، فسنستخدم الرابط المعتاد 'https://api.mailgun.net' كقيمة افتراضية.

البنية التحتية لـ AWS ID

تستخدم Canarytokens لمفاتيح AWS API البنية التحتية في جانب AWS لتخصيص مستخدمي IAM وتشغيل فحوصات شبكة الأمان. تم نقل تلك البنية التحتية إلى مستودع خاص.

ما يزال هذا المستودع يملك نقاط التكامل الموجهة لـ Canarytokens:

• CANARY_AWSID_URL في frontend.env هو رابط API Gateway/Lambda لنقطة النهاية LinkAWSIDTokenUserToCanaryConsole المُدارة من المستودع الخاص.
• يجب أن يتطابق CANARY_AWSID_AUTH في frontend.env مع رمز المصادقة في سر AWS ID. ترسل الواجهة الأمامية domain و token و auth و guid عند إنشاء رمز مفتاح AWS.
• يحدد CANARY_AWSID_GUID مثيل Canarytokens عند تخصيص وحذف رموز مفاتيح AWS.
• CANARY_AWSID_CONTROL_ACCOUNT_ID هو معرّف حساب AWS الذي يملك قائمة انتظار حذف AWS ID.
• إذا لم يتم تعيين أي من CANARY_AWSID_URL أو CANARY_AWSID_AUTH، فسيتم تعطيل إنشاء رموز مفاتيح AWS لمثيل Canarytokens هذا.

إعداد SMTP الصادر

عند إعداد SMTP الصادر، يرجى مراعاة ما يلي:

القيود:

• يجب عدم إعداد أي مزود آخر مثل Mailgun أو Sendgrid لكي يعمل هذا
• بالنسبة إلى AWS SES، يجب أن يكون CANARY_ALERT_EMAIL_FROM_DISPLAY بالتنسيق: CANARY_ALERT_EMAIL_FROM_DISPLAY=CanaryAlert <[email protected]>

يجب إعداد الإعدادات التالية في switchboard.env لكي يعمل SMTP:

• CANARY_SMTP_SERVER: خادم SMTP
• CANARY_SMTP_PORT: رقم منفذ خادم SMTP (يجب أن يكون منفذًا مفعّلًا فيه StartTLS!)
• CANARY_SMTP_USERNAME: اسم المستخدم لخادم SMTP (لا يُدعم SMTP المجهول حاليًا)
• CANARY_SMTP_PASSWORD: كلمة المرور المقابلة لاسم المستخدم

يبدو مثال الإعداد الكامل في switchboard.env بعد ذلك كما يلي:

CANARY_SMTP_SERVER=smtp.yourserver.com
CANARY_SMTP_PORT=587
CANARY_SMTP_USERNAME=<your smtp username>
CANARY_SMTP_PASSWORD=<your smtp password>
[email protected]
CANARY_ALERT_EMAIL_SUBJECT="Canary Alert via SMTP"

الحد من التنبيهات

افتراضيًا، ما لم يكن التشغيل في وضع DEBUG، لا يُسمح بأكثر من تنبيه واحد لكل عنوان IP فريد في الدقيقة. سيظل النشاط مُسجلًا في قاعدة البيانات ومرئيًا في وحدة تحكم إدارة الرموز، لكن لن يتم إنشاء تنبيهات (عبر البريد الإلكتروني و/أو webhook).

يمكن ضبط ذلك عبر متغير البيئة CANARY_MAX_ALERTS_PER_MINUTE الخاص بـ switchboard.

الحد من فشل Webhook

بعد أن يُرجع webhook خطأً 5 مرات متتالية، يتم تعطيله. يمكن ضبط هذا السلوك عبر MAX_ALERT_FAILURES.

الأسئلة الشائعة

لدينا صفحة أسئلة شائعة هنا

المساهمة

يرجى الاطلاع على وثائق مدونة قواعد السلوك والمساهمة قبل تقديم طلب سحب (pull request).

نتطلع إلى مساهماتكم القيمة.