Canarytokens

Thinkst Applied Research द्वारा

अवलोकन

Canarytokens आपके नेटवर्क पर गतिविधि और क्रियाओं को ट्रैक करने में मदद करते हैं।

यदि आपको कोई समस्या आती है तो कृपया हमारा FAQ यहाँ देखें, या एक issue बनाएं और हम जल्द से जल्द आपसे संपर्क करने का प्रयास करेंगे।

विषय-सूची

• आचार संहिता
• अप्रचलन
• स्थापना
• कॉन्फ़िगरेशन
• AWS ID इन्फ्रास्ट्रक्चर
• आउटगोइंग SMTP का कॉन्फ़िगरेशन
• अलर्ट थ्रॉटलिंग
• वेबहुक विफलता सीमा
• FAQ
• योगदान

आचार संहिता

यह परियोजना और इसमें भाग लेने वाले सभी लोग आचार संहिता द्वारा शासित हैं। भाग लेकर, आपसे इस संहिता का पालन करने की अपेक्षा की जाती है। कृपया अनुचित व्यवहार की रिपोर्ट [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=
• 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 में स्विचबोर्ड प्रोसेस सेटिंग्स होती हैं जैसे:

कृपया ध्यान दें कि आप जिस ईमेल प्रदाता का उपयोग करना चाहते हैं उसे चुनते समय, आपको केवल उस प्रदाता से संबंधित जानकारी प्रदान करनी होगी। जैसे यदि आपके पास CANARY_MAILGUN_API_KEY है तो आपको अन्य जैसे CANARY_SENDGRID_API_KEY और CANARY_MANDRILL_API_KEY को हटाना होगा।

यदि आप अपने Canarytokens सर्वर के लिए Mailgun के यूरोपीय इन्फ्रास्ट्रक्चर का उपयोग कर रहे हैं, तो आपको अपने switchboard.env में CANARY_MAILGUN_BASE_URL=https://api.eu.mailgun.net जोड़ना होगा। यदि आप यह निर्दिष्ट नहीं करते हैं, तो हम डिफ़ॉल्ट रूप से नियमित URL 'https://api.mailgun.net' का उपयोग करेंगे।

AWS ID इन्फ्रास्ट्रक्चर

AWS API key Canarytokens IAM उपयोगकर्ताओं को आवंटित करने और safety-net जाँच चलाने के लिए AWS-पक्षीय इन्फ्रास्ट्रक्चर का उपयोग करते हैं। वह इन्फ्रास्ट्रक्चर एक निजी रिपॉजिटरी में स्थानांतरित हो गया है।

यह रिपॉजिटरी अभी भी Canarytokens-मुख वाले एकीकरण बिंदुओं का स्वामी है:

• frontend.env में CANARY_AWSID_URL निजी रिपॉजिटरी से प्रबंधित LinkAWSIDTokenUserToCanaryConsole एंडपॉइंट के लिए API Gateway/Lambda URL है।
• frontend.env में CANARY_AWSID_AUTH को AWS ID गोपनीय में auth टोकन से मेल खाना चाहिए। फ्रंटएंड AWS कुंजी टोकन बनाते समय domain, token, auth, और guid भेजता है।
• CANARY_AWSID_GUID AWS कुंजी टोकन आवंटित और हटाते समय Canarytokens इंस्टेंस की पहचान करता है।
• CANARY_AWSID_CONTROL_ACCOUNT_ID वह AWS खाता ID है जो AWS ID विलोपन कतार का स्वामी है।
• यदि CANARY_AWSID_URL या CANARY_AWSID_AUTH में से कोई भी सेट नहीं है, तो इस Canarytokens इंस्टेंस के लिए AWS कुंजी टोकन निर्माण अक्षम कर दिया जाता है।

आउटगोइंग SMTP का कॉन्फ़िगरेशन

आउटगोइंग SMTP कॉन्फ़िगर करते समय कृपया निम्नलिखित पर विचार करें:

प्रतिबंध:

• इसके काम करने के लिए Mailgun या Sendgrid जैसा कोई अन्य प्रदाता कॉन्फ़िगर नहीं होना चाहिए
• AWS SES के लिए CANARY_ALERT_EMAIL_FROM_DISPLAY इस प्रारूप में होना चाहिए: CANARY_ALERT_EMAIL_FROM_DISPLAY=CanaryAlert <[email protected]>

SMTP के काम करने के लिए निम्नलिखित सेटिंग्स switchboard.env में कॉन्फ़िगर की जानी चाहिए:

• 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 प्रति मिनट 1 से अधिक अलर्ट की अनुमति नहीं है। गतिविधि अभी भी डेटाबेस में दर्ज की जाएगी, और टोकन प्रबंधन कंसोल में दिखाई देगी, लेकिन अलर्ट उत्पन्न नहीं होंगे (ईमेल और/या वेबहुक)।

यह स्विचबोर्ड ENV चर CANARY_MAX_ALERTS_PER_MINUTE के साथ समायोज्य है।

वेबहुक विफलता सीमा

एक वेबहुक लगातार 5 बार त्रुटि लौटाने के बाद, वह अक्षम कर दिया जाता है। इस व्यवहार को MAX_ALERT_FAILURES से समायोजित किया जा सकता है।

FAQ

हमारा FAQ यहाँ है

योगदान

पुल अनुरोध जमा करने से पहले कृपया हमारे आचार संहिता और योगदान दस्तावेज़ देखें।

हम आपके मूल्यवान योगदानों की प्रतीक्षा कर रहे हैं।