Canarytokens

par Thinkst Applied Research

Aperçu

Canarytokens aide à suivre l'activité et les actions sur votre réseau.

Si vous rencontrez le moindre problème, consultez notre FAQ ici, ou créez une issue et nous essaierons de vous répondre dans les plus brefs délais.

Table des matières

• Code de conduite
• Dépréciations
• Installation
• Configuration
• Infrastructure AWS ID
• Configuration du SMTP sortant
• Limitation du débit des alertes
• Limitation des échecs de webhook
• FAQ
• Contribution

Code de conduite

Ce projet et toutes les personnes qui y participent sont régis par le Code de conduite. En participant, vous vous engagez à respecter ce code. Veuillez signaler tout comportement inacceptable à [email protected].

Dépréciations

• Le jeton d'API Slack est déprécié et il n'est plus possible d'en créer de nouveaux. Les anciens jetons continueront de fonctionner.

Installation

Nous recommandons le processus d'installation de l'image Docker.

Configuration

Le serveur Canarytokens peut utiliser de nombreuses configurations de paramètres différentes. Vous les trouverez dans settings.py. Il existe deux fichiers de paramètres principaux : frontend.env et switchboard.env.

Le frontend.env contient les paramètres du processus frontend, tels que :

• 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

Le switchboard.env contient les paramètres du processus switchboard, tels que :

Nom de la variable	Valeur
CANARY_MAILGUN_DOMAIN_NAME
CANARY_MAILGUN_API_KEY
CANARY_MANDRILL_API_KEY
CANARY_SENDGRID_API_KEY
CANARY_PUBLIC_IP	<au lieu d'utiliser un domaine>
CANARY_PUBLIC_DOMAIN	<au lieu d'utiliser une adresse IP>
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	<nom d'utilisateur smtp>
CANARY_SMTP_PASSWORD
CANARY_SMTP_SERVER	smtp.gmail.com
CANARY_IPINFO_API_KEY	<clé API ipinfo.io>
CANARY_SMTP_PORT	587
CANARY_WEB_IMAGE_UPLOAD_PATH	/uploads
LOG_FILE	switchboard.log
ERROR_LOG_WEBHOOK	<URI d'un webhook vers lequel envoyer les journaux d'erreurs>
CANARY_FORCE_HTTPS	force le schéma de protocole https pour Canarytokens
CANARY_LAMBDA_AWS_CRED_REPORT_AUTH	<jeton d'authentification partagé du vérificateur de rapport d'identifiants>

Veuillez noter que lorsque vous choisissez le fournisseur de messagerie que vous souhaitez utiliser, vous DEVEZ ne fournir que les informations relatives à ce fournisseur. Par exemple, si vous avez CANARY_MAILGUN_API_KEY, vous devez supprimer les autres, comme CANARY_SENDGRID_API_KEY et CANARY_MANDRILL_API_KEY.

Si vous utilisez l'infrastructure européenne de Mailgun pour votre serveur Canarytokens, vous devrez ajouter CANARY_MAILGUN_BASE_URL=https://api.eu.mailgun.net à votre switchboard.env. Si vous ne le spécifiez pas, nous utiliserons l'URL standard « https://api.mailgun.net » par défaut.

Infrastructure AWS ID

Les Canarytokens à clé API AWS utilisent une infrastructure côté AWS pour allouer les utilisateurs IAM et effectuer des contrôles de sécurité. Cette infrastructure a été déplacée vers un dépôt privé.

Ce dépôt conserve toujours les points d'intégration orientés Canarytokens :

• CANARY_AWSID_URL dans frontend.env est l'URL API Gateway/Lambda pour le point de terminaison LinkAWSIDTokenUserToCanaryConsole géré depuis le dépôt privé.
• CANARY_AWSID_AUTH dans frontend.env doit correspondre au jeton d'authentification du secret AWS ID. Le frontend envoie domain, token, auth et guid lors de la création d'un jeton de clé AWS.
• CANARY_AWSID_GUID identifie l'instance Canarytokens lors de l'allocation et de la suppression des jetons de clé AWS.
• CANARY_AWSID_CONTROL_ACCOUNT_ID est l'ID de compte AWS propriétaire de la file d'attente de suppression des identifiants AWS.
• Si CANARY_AWSID_URL ou CANARY_AWSID_AUTH n'est pas défini, la création de jetons de clé AWS est désactivée pour cette instance Canarytokens.
• CANARY_LAMBDA_AWS_CRED_REPORT_AUTH dans switchboard.env active le rappel /a/cr utilisé par le vérificateur de rapport d'identifiants AWS.

Configuration du SMTP sortant

Lors de la configuration du SMTP sortant, veuillez prendre en compte les points suivants :

Restrictions :

• aucun autre fournisseur comme Mailgun ou Sendgrid ne doit être configuré pour que cela fonctionne
• Pour AWS SES, CANARY_ALERT_EMAIL_FROM_DISPLAY doit être au format : CANARY_ALERT_EMAIL_FROM_DISPLAY=CanaryAlert <[email protected]>

Les paramètres suivants doivent être configurés dans switchboard.env pour que le SMTP fonctionne :

• CANARY_SMTP_SERVER : le serveur SMTP
• CANARY_SMTP_PORT : le numéro de port du serveur SMTP (doit être un port avec StartTLS activé !)
• CANARY_SMTP_USERNAME : nom d'utilisateur pour le serveur SMTP (aucun SMTP anonyme n'est pris en charge actuellement)
• CANARY_SMTP_PASSWORD : le mot de passe correspondant au nom d'utilisateur

Un exemple complet de configuration dans switchboard.env ressemble alors à ceci :

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"

Limitation du débit des alertes

Par défaut, sauf en mode DEBUG, un maximum d'une alerte par IP appelante unique et par minute est autorisé. L'activité sera toujours enregistrée dans la base de données et visible dans la console de gestion des jetons, mais les alertes ne seront pas générées (e-mail et/ou webhook).

Ceci est réglable via la variable d'environnement CANARY_MAX_ALERTS_PER_MINUTE du switchboard.

Limitation des échecs de webhook

Après qu'un webhook renvoie une erreur 5 fois de suite, il est désactivé. Ce comportement peut être réglé avec MAX_ALERT_FAILURES.

FAQ

Notre FAQ se trouve ici

Contribution