thinkst/canarytokensCanarytokens ayuda a rastrear la actividad y las acciones en tu red.
por Thinkst Applied Research
Canarytokens ayuda a rastrear la actividad y las acciones en tu red.
Si tienes algún problema, consulta nuestras preguntas frecuentes aquí, o crea una incidencia y trataremos de responderte lo antes posible.
Este proyecto y todos los que participan en él se rigen por el Código de conducta. Al participar, se espera que cumplas con este código. Informa de cualquier comportamiento inaceptable a [email protected].
Recomendamos el proceso de instalación con imagen de Docker.
El servidor de Canarytokens puede usar muchas configuraciones diferentes. Puedes encontrarlas en settings.py. Hay dos
archivos de configuración principales: frontend.env y switchboard.env.
El archivo frontend.env contiene la configuración del proceso frontend, como:
El archivo switchboard.env contiene la configuración del proceso switchboard, como:
| 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 |
Ten en cuenta que al elegir qué proveedor de correo electrónico deseas usar, DEBES proporcionar únicamente
información relacionada con ese proveedor. Por ejemplo, si tienes CANARY_MAILGUN_API_KEY, debes eliminar las demás, como
CANARY_SENDGRID_API_KEY y CANARY_MANDRILL_API_KEY.
Si usas la infraestructura europea de Mailgun para tu servidor de Canarytokens, deberás añadir CANARY_MAILGUN_BASE_URL=https://api.eu.mailgun.net a tu switchboard.env. Si no lo especificas,
usaremos la URL habitual 'https://api.mailgun.net' como predeterminada.
Los Canarytokens de clave de API de AWS usan infraestructura del lado de AWS para asignar usuarios IAM y ejecutar comprobaciones de seguridad. Esa infraestructura se ha trasladado a un repositorio privado.
Este repositorio sigue siendo responsable de los puntos de integración orientados a Canarytokens:
CANARY_AWSID_URL en frontend.env es la URL de API Gateway/Lambda para el endpoint LinkAWSIDTokenUserToCanaryConsole gestionado desde el repositorio privado.CANARY_AWSID_AUTH en frontend.env debe coincidir con el token de autenticación del secreto de AWS ID. El frontend envía domain, token, auth y guid al crear un token de clave de AWS.CANARY_AWSID_GUID identifica la instancia de Canarytokens al asignar y eliminar tokens de clave de AWS.CANARY_AWSID_CONTROL_ACCOUNT_ID es el ID de la cuenta de AWS propietaria de la cola de eliminación de AWS ID.CANARY_AWSID_URL o CANARY_AWSID_AUTH no están configurados, la creación de tokens de clave de AWS está deshabilitada para esta instancia de Canarytokens.CANARY_LAMBDA_AWS_CRED_REPORT_AUTH en switchboard.env habilita la devolución de llamada /a/cr usada por el verificador de informes de credenciales de AWS ID.Al configurar SMTP saliente, ten en cuenta lo siguiente:
Restricciones:
CANARY_ALERT_EMAIL_FROM_DISPLAY debe tener el formato: CANARY_ALERT_EMAIL_FROM_DISPLAY=CanaryAlert <[email protected]>Nota: los correos de alerta SMTP envían una cabecera From conforme a RFC. Si CANARY_ALERT_EMAIL_FROM_DISPLAY está configurado como un nombre para mostrar, la cabecera resultante se representa como Display Name <CANARY_ALERT_EMAIL_FROM_ADDRESS>, coincidiendo con el comportamiento existente de Mailgun. Esto puede cambiar ligeramente cómo aparece el remitente en los clientes de correo para implementaciones basadas en SMTP, pero el cuerpo del correo de alerta no cambia.
Las siguientes opciones deben configurarse en switchboard.env para que SMTP funcione:
Un ejemplo completo de configuración en switchboard.env sería así:
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"
De forma predeterminada, salvo que se ejecute en modo DEBUG, no se permite más de 1 alerta por IP de origen única por minuto. La actividad seguirá registrándose en la base de datos y será visible en la consola de gestión de tokens, pero no se generarán alertas (correo electrónico y/o webhook).