Canarytokens

di Thinkst Applied Research

Panoramica

I Canarytokens aiutano a tracciare l'attività e le azioni sulla tua rete.

Se riscontri problemi, consulta le nostre FAQ qui, oppure apri una issue e cercheremo di risponderti il prima possibile.

Indice

• Codice di condotta
• Deprecazioni
• Installazione
• Configurazione
• Infrastruttura AWS ID
• Configurazione dell'SMTP in uscita
• Limitazione degli avvisi
• Limitazione dei fallimenti dei webhook
• FAQ
• Contribuire

Codice di condotta

Questo progetto e tutti coloro che vi partecipano sono regolati dal Codice di condotta. Partecipando, ti impegni a rispettare questo codice. Ti preghiamo di segnalare comportamenti inaccettabili a [email protected].

Deprecazioni

• Il Token API di Slack è deprecato e non è più possibile crearne di nuovi. I vecchi token continueranno a funzionare.

Installazione

Consigliamo il processo di installazione tramite immagine Docker.

Configurazione

Il server Canarytokens può utilizzare molte configurazioni diverse. Le puoi trovare in settings.py. Ci sono due file di impostazioni principali: frontend.env e switchboard.env.

Il file frontend.env contiene le impostazioni del processo frontend come:

• 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

Il file switchboard.env contiene le impostazioni del processo switchboard come:

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

Tieni presente che quando scegli quale provider email desideri utilizzare, DEVI fornire solo le informazioni relative a quel provider. Ad esempio, se hai CANARY_MAILGUN_API_KEY devi rimuovere le altre come CANARY_SENDGRID_API_KEY e CANARY_MANDRILL_API_KEY.

Se utilizzi l'infrastruttura europea di Mailgun per il tuo Canarytokens Server, dovrai aggiungere CANARY_MAILGUN_BASE_URL=https://api.eu.mailgun.net al tuo switchboard.env. Se non lo specifichi, utilizzeremo come predefinito il normale URL 'https://api.mailgun.net'.

Infrastruttura AWS ID

I Canarytokens con chiave API AWS utilizzano un'infrastruttura lato AWS per allocare utenti IAM ed eseguire controlli di sicurezza. Tale infrastruttura è stata spostata in un repository privato.

Questo repository possiede ancora i punti di integrazione esposti ai Canarytokens:

• CANARY_AWSID_URL in frontend.env è l'URL API Gateway/Lambda per l'endpoint LinkAWSIDTokenUserToCanaryConsole gestito dal repository privato.
• CANARY_AWSID_AUTH in frontend.env deve corrispondere al token di autenticazione nel secret AWS ID. Il frontend invia domain, token, auth e guid quando crea un token con chiave AWS.
• CANARY_AWSID_GUID identifica l'istanza Canarytokens durante l'allocazione e l'eliminazione dei token con chiave AWS.
• CANARY_AWSID_CONTROL_ACCOUNT_ID è l'ID dell'account AWS che possiede la coda di eliminazione AWS ID.
• Se CANARY_AWSID_URL o CANARY_AWSID_AUTH non sono impostati, la creazione di token con chiave AWS è disabilitata per questa istanza Canarytokens.
• CANARY_LAMBDA_AWS_CRED_REPORT_AUTH in switchboard.env abilita il callback /a/cr utilizzato dal checker del report delle credenziali AWS ID.

Configurazione dell'SMTP in uscita

Quando configuri l'SMTP in uscita tieni presente quanto segue:

Restrizioni:

• nessun altro provider come Mailgun o Sendgrid deve essere configurato affinché funzioni
• Per AWS SES CANARY_ALERT_EMAIL_FROM_DISPLAY dovrebbe essere nel formato: CANARY_ALERT_EMAIL_FROM_DISPLAY=CanaryAlert <[email protected]>

Nota: le email di avviso SMTP inviano un header From conforme a RFC. Se CANARY_ALERT_EMAIL_FROM_DISPLAY è configurato come nome visualizzato, l'header risultante viene reso come Display Name <CANARY_ALERT_EMAIL_FROM_ADDRESS>, in linea con il comportamento esistente di Mailgun. Questo può cambiare leggermente l'aspetto del mittente nei client di posta per i deployment basati su SMTP, ma il corpo dell'email di avviso rimane invariato.

Le seguenti impostazioni devono essere configurate in switchboard.env affinché SMTP funzioni:

• CANARY_SMTP_SERVER: il server SMTP
• CANARY_SMTP_PORT: il numero di porta del server SMTP (deve essere una porta con StartTLS abilitato!)
• CANARY_SMTP_USERNAME: Username per il server SMTP (al momento non è supportato SMTP anonimo)
• CANARY_SMTP_PASSWORD: la password che corrisponde allo username

Un esempio completo di configurazione in switchboard.env appare quindi così:

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"

Limitazione degli avvisi

Per impostazione predefinita, a meno che non si sia in modalità DEBUG, non è consentito più di 1 avviso per IP chiamante univoco al minuto. L'attività verrà comunque registrata nel database e sarà visibile nella console di gestione dei token, ma gli avvisi non verranno generati (email e/o webhook).

Questo è regolabile tramite la variabile ENV dello switchboard CANARY_MAX_ALERTS_PER_MINUTE.