Canarytokens

Thinkst Applied Research द्वारा

अवलोकन

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

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

विषय-सूची

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

आचार संहिता

यह परियोजना और इसमें भाग लेने वाला प्रत्येक व्यक्ति आचार संहिता द्वारा शासित है। भाग लेकर, आपसे इस संहिता का पालन करने की अपेक्षा की जाती है। कृपया अस्वीकार्य व्यवहार की रिपोर्ट [email protected] पर करें।

अप्रचलन

• Slack API Token अप्रचलित है और अब नए बनाना संभव नहीं है। पुराने tokens अभी भी काम करेंगे।

स्थापना

हम Docker image स्थापना प्रक्रिया की सिफारिश करते हैं।

कॉन्फ़िगरेशन

Canarytokens सर्वर कई अलग-अलग सेटिंग्स कॉन्फ़िगरेशन का उपयोग कर सकता है। आप उन्हें settings.py में पा सकते हैं। दो मुख्य सेटिंग्स फ़ाइलें हैं: frontend.env और switchboard.env।

frontend.env में frontend प्रक्रिया सेटिंग्स होती हैं जैसे:

• 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 में switchboard प्रक्रिया सेटिंग्स होती हैं जैसे:

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

कृपया ध्यान दें कि जब आप चुनते हैं कि आप किस email प्रदाता का उपयोग करना चाहते हैं, तो आपको केवल उस प्रदाता से संबंधित जानकारी प्रदान करनी चाहिए। उदाहरण के लिए यदि आपके पास 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-पक्षीय अधोसंरचना का उपयोग करते हैं। वह अधोसंरचना एक निजी repo में स्थानांतरित हो गई है।

यह repo अभी भी Canarytokens-मुखी एकीकरण बिंदुओं का स्वामित्व रखता है:

• frontend.env में CANARY_AWSID_URL निजी repo से प्रबंधित LinkAWSIDTokenUserToCanaryConsole endpoint के लिए API Gateway/Lambda URL है।
• frontend.env में CANARY_AWSID_AUTH को AWS ID secret में auth token से मेल खाना चाहिए। AWS key token बनाते समय frontend domain, token, auth, और guid भेजता है।
• CANARY_AWSID_GUID AWS key tokens आवंटित और हटाते समय Canarytokens instance की पहचान करता है।
• CANARY_AWSID_CONTROL_ACCOUNT_ID वह AWS account ID है जो AWS ID deletion queue का स्वामी है।
• यदि CANARY_AWSID_URL या CANARY_AWSID_AUTH में से कोई भी सेट नहीं है, तो इस Canarytokens instance के लिए AWS key token निर्माण अक्षम है।
• switchboard.env में CANARY_LAMBDA_AWS_CRED_REPORT_AUTH AWS ID credential report checker द्वारा उपयोग किए जाने वाले /a/cr callback को सक्षम करता है।

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

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

प्रतिबंध:

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

नोट: SMTP अलर्ट ईमेल एक RFC-अनुरूप From header भेजते हैं। यदि CANARY_ALERT_EMAIL_FROM_DISPLAY को display name के रूप में कॉन्फ़िगर किया गया है, तो परिणामी header Display Name <CANARY_ALERT_EMAIL_FROM_ADDRESS> के रूप में प्रस्तुत होता है, जो मौजूदा Mailgun व्यवहार से मेल खाता है। यह SMTP-समर्थित deployments के लिए mail clients में प्रेषक कैसे दिखाई देता है, इसे थोड़ा बदल सकता है, लेकिन अलर्ट ईमेल का मुख्य भाग अपरिवर्तित रहता है।

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

• CANARY_SMTP_SERVER: SMTP सर्वर
• CANARY_SMTP_PORT: SMTP सर्वर का पोर्ट नंबर (StartTLS सक्षम पोर्ट होना चाहिए!)
• CANARY_SMTP_USERNAME: SMTP सर्वर के लिए उपयोगकर्ता नाम (अभी anonymous 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 अलर्ट की अनुमति होती है। गतिविधि अभी भी डेटाबेस में दर्ज की जाएगी, और token प्रबंधन कंसोल में दिखाई देगी, लेकिन अलर्ट उत्पन्न नहीं होंगे (email और/या webhook)।

यह switchboard ENV वेरिएबल CANARY_MAX_ALERTS_PER_MINUTE के साथ समायोज्य है।

Webhook विफलता सीमित करना

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

FAQ

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

योगदान