thinkst/canarytokensDéployez et gérez des honeytokens numériques dans les environnements réseau et cloud pour détecter et alerter sur les accès ou activités non autorisés.
par Thinkst Applied Research
Les Canarytokens aident à suivre l'activité et les actions sur votre réseau.
Si vous rencontrez des problèmes, veuillez consulter notre FAQ ici, ou créer un ticket et nous essaierons de vous répondre dès que possible.
Ce projet et toutes les personnes y participant sont régis par le Code de conduite. En participant, vous êtes tenu de respecter ce code. Veuillez signaler tout comportement inacceptable à [email protected].
Nous recommandons le processus d'installation via l'image Docker.
Le serveur Canarytokens peut utiliser de nombreux paramètres de configuration différents. Vous pouvez les trouver dans settings.py. Il existe deux
fichiers de paramètres principaux : frontend.env et switchboard.env.
Le fichier frontend.env contient les paramètres du processus frontend tels que :
Le fichier 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 | |
| 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 |
Veuillez noter que lorsque vous choisissez le fournisseur de messagerie que vous souhaitez utiliser, vous DEVEZ fournir uniquement
les informations relatives à ce fournisseur. Par exemple, si vous avez CANARY_MAILGUN_API_KEY, vous devez alors supprimer les autres telles que
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 fichier switchboard.env. Si vous ne le spécifiez pas,
nous utiliserons l'URL habituelle 'https://api.mailgun.net' par défaut.
Les Canarytokens de clé API AWS utilisent une infrastructure côté AWS pour allouer des utilisateurs IAM et exécuter des vérifications de sécurité. Cette infrastructure a été déplacée vers un dépôt privé.
Ce dépôt possède toujours les points d'intégration côté 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 token de clé AWS.CANARY_AWSID_GUID identifie l'instance Canarytokens lors de l'allocation et de la suppression des tokens de clé AWS.CANARY_AWSID_CONTROL_ACCOUNT_ID est l'ID du compte AWS qui possède la file de suppression AWS ID.CANARY_AWSID_URL ou CANARY_AWSID_AUTH n'est pas défini, la création de tokens de clé AWS est désactivée pour cette instance Canarytokens.CANARY_LAMBDA_AWS_CRED_REPORT_AUTH dans switchboard.env active le callback /a/cr utilisé par le vérificateur de rapport d'identification AWS ID.Lors de la configuration du SMTP sortant, veuillez prendre en compte les éléments suivants :
Restrictions :
CANARY_ALERT_EMAIL_FROM_DISPLAY doit être au format : CANARY_ALERT_EMAIL_FROM_DISPLAY=CanaryAlert <[email protected]>Remarque : les e-mails d'alerte SMTP envoient un en-tête From conforme à la RFC. Si CANARY_ALERT_EMAIL_FROM_DISPLAY est configuré comme nom d'affichage, l'en-tête résultant est rendu sous la forme Display Name <CANARY_ALERT_EMAIL_FROM_ADDRESS>, correspondant au comportement existant de Mailgun. Cela peut légèrement modifier la façon dont l'expéditeur apparaît dans les clients de messagerie pour les déploiements basés sur SMTP, mais le corps de l'e-mail d'alerte reste inchangé.
Les paramètres suivants doivent être configurés dans switchboard.env pour que SMTP fonctionne :
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"