Canarytokens

بواسطة Thinkst Applied Research

نظرة عامة

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

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

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

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

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

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

الإهمالات

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

التثبيت

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

الإعداد

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

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

• CANARY_DOMAINS=mytesttokensdomain.com
• CANARY_NXDOMAINS=pdf.demo.canarytokens.net
• CANARY_AWSID_URL=
• CANARY_AWSID_AUTH=
• CANARY_AWSID_GUID=
• CANARY_AWSID_CONTROL_ACCOUNT_ID=
• CANARY_WEB_IMAGE_UPLOAD_PATH=/uploads
• CANARY_GOOGLE_API_KEY=
• LOG_FILE=frontend.log

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

Variable Name	Value
CANARY_MAILGUN_DOMAIN_NAME
CANARY_MAILGUN_API_KEY
CANARY_MANDRILL_API_KEY
CANARY_SENDGRID_API_KEY
CANARY_PUBLIC_IP
CANARY_PUBLIC_DOMAIN
CANARY_ALERT_EMAIL_FROM_ADDRESS	[email protected]
CANARY_ALERT_EMAIL_FROM_DISPLAY	"Canarytoken Mailer"
CANARY_ALERT_EMAIL_SUBJECT	"Alert"
CANARY_MAX_ALERTS_PER_MINUTE	1000
CANARY_SMTP_USERNAME
CANARY_SMTP_PASSWORD
CANARY_SMTP_SERVER	smtp.gmail.com
CANARY_IPINFO_API_KEY	<ipinfo.io api key>
CANARY_SMTP_PORT	587
CANARY_WEB_IMAGE_UPLOAD_PATH	/uploads
LOG_FILE	switchboard.log
ERROR_LOG_WEBHOOK
CANARY_FORCE_HTTPS	force https protocol scheme for Canarytokens
CANARY_LAMBDA_AWS_CRED_REPORT_AUTH

يرجى ملاحظة أنه عند اختيار مزود البريد الإلكتروني الذي ترغب في استخدامه، يجب عليك تقديم معلومات متعلقة بذلك المزود فقط. على سبيل المثال، إذا كان لديك 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

تستخدم 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 هذه.
• يفعّل CANARY_LAMBDA_AWS_CRED_REPORT_AUTH في switchboard.env رد الاتصال /a/cr المستخدم بواسطة مدقق تقرير بيانات اعتماد AWS ID.

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

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

القيود:

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

ملاحظة: ترسل رسائل تنبيه SMTP ترويسة From متوافقة مع RFC. إذا تم تكوين CANARY_ALERT_EMAIL_FROM_DISPLAY كاسم عرض، فسيتم عرض الترويسة الناتجة كـ Display Name <CANARY_ALERT_EMAIL_FROM_ADDRESS>، بما يتطابق مع سلوك Mailgun الحالي. قد يغيّر هذا قليلاً كيفية ظهور المرسل في عملاء البريد لعمليات النشر المدعومة بـ SMTP، لكن نص رسالة التنبيه يبقى دون تغيير.

يجب تكوين الإعدادات التالية في 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).

يمكن ضبط هذا باستخدام متغير ENV في لوحة التبديل CANARY_MAX_ALERTS_PER_MINUTE.

تحديد فشل Webhook

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

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

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

المساهمة

يرجى الاطلاع على مدونة قواعد السلوك و المساهمة قبل تقديم طلب سحب.

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