Canarytokens

di Thinkst Applied Research

Panoramica

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

Se hai problemi, consulta le nostre FAQ qui, oppure apri un 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 guasti dei webhook
• FAQ
• Contribuire

Codice di Condotta

Questo progetto e tutti coloro che vi partecipano sono disciplinati dal Codice di Condotta. Partecipando, accetti di rispettare questo codice. Segnala comportamenti inaccettabili a [email protected].

Deprecazioni

• Lo Slack API Token è 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. Puoi trovarle in settings.py. Ci sono due file principali di impostazioni: frontend.env e switchboard.env.

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

• 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 ad esempio:

Nota: quando scegli quale provider di posta elettronica 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, useremo l'URL standard 'https://api.mailgun.net' come predefinito.

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 mantiene ancora i punti di integrazione rivolti a 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 segreto AWS ID. Il frontend invia domain, token, auth e guid quando crea un token con chiave AWS.
• CANARY_AWSID_GUID identifica l'istanza Canarytokens quando si allocano ed eliminano token con chiave AWS.
• CANARY_AWSID_CONTROL_ACCOUNT_ID è l'ID dell'account AWS proprietario della coda di eliminazione degli AWS ID.
• Se CANARY_AWSID_URL o CANARY_AWSID_AUTH non è impostato, la creazione di token con chiave AWS è disabilitata per questa istanza Canarytokens.

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 perché funzioni
• Per AWS SES CANARY_ALERT_EMAIL_FROM_DISPLAY deve essere nel formato: CANARY_ALERT_EMAIL_FROM_DISPLAY=CanaryAlert <[email protected]>

Le seguenti impostazioni devono essere configurate in switchboard.env affinché l'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: nome utente per il server SMTP (attualmente non è supportato l'SMTP anonimo)
• CANARY_SMTP_PASSWORD: la password corrispondente al nome utente

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.

Limitazione dei guasti dei webhook

Dopo che un webhook restituisce un errore 5 volte consecutive, viene disabilitato. Questo comportamento può essere regolato con MAX_ALERT_FAILURES.

FAQ

Abbiamo una sezione FAQ qui

Contribuire

Consulta i nostri documenti Codice di Condotta e Contribuire prima di inviare una pull request.

Non vediamo l'ora di ricevere i tuoi preziosi contributi.