• El Slack API Token está deprecado y ya no es posible crear nuevos. Los tokens antiguos seguirán funcionando.

Instalación

Recomendamos el proceso de instalación mediante la imagen de Docker.

Configuración

El servidor de Canarytokens puede usar muchas configuraciones distintas. Puedes encontrarlas en settings.py. Hay dos archivos de configuración principales: frontend.env y switchboard.env.

El frontend.env contiene la configuración del proceso frontend, como:

• 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

El switchboard.env contiene la configuración del proceso switchboard, como:

Ten en cuenta que al elegir el proveedor de correo que quieras usar, DEBES proporcionar únicamente la 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 estás usando la infraestructura europea de Mailgun para tu servidor de Canarytokens, necesitará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 valor predeterminado.

Infraestructura de AWS ID

Los Canarytokens de claves de API de AWS utilizan infraestructura del lado de AWS para asignar usuarios de IAM y ejecutar comprobaciones de red de seguridad. Esa infraestructura se ha movido a un repositorio privado.

Este repositorio sigue siendo el responsable de los puntos de integración visibles para 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 cuenta de AWS propietaria de la cola de eliminación de AWS ID.
• Si CANARY_AWSID_URL o CANARY_AWSID_AUTH no están definidos, la creación de tokens de clave de AWS estará deshabilitada para esta instancia de Canarytokens.
• CANARY_LAMBDA_AWS_CRED_REPORT_AUTH en switchboard.env habilita el callback /a/cr usado por el comprobador de informes de credenciales de AWS ID.

Configuración del SMTP saliente

Al configurar el SMTP saliente, ten en cuenta lo siguiente:

Restricciones:

• no debe estar configurado ningún otro proveedor como Mailgun o Sendgrid para que esto funcione
• Para AWS SES, CANARY_ALERT_EMAIL_FROM_DISPLAY debe tener el formato: CANARY_ALERT_EMAIL_FROM_DISPLAY=CanaryAlert <[email protected]>

Los siguientes ajustes deben configurarse en switchboard.env para que SMTP funcione:

• CANARY_SMTP_SERVER: el servidor SMTP
• CANARY_SMTP_PORT: el número de puerto del servidor SMTP (¡debe ser un puerto con StartTLS habilitado!)
• CANARY_SMTP_USERNAME: nombre de usuario para el servidor SMTP (actualmente no se admite SMTP anónimo)
• CANARY_SMTP_PASSWORD: la contraseña que corresponde al nombre de usuario

Un ejemplo de configuración completa en switchboard.env sería así:

Limitación de alertas

De forma predeterminada, salvo que se ejecute en modo DEBUG, no se permite más de 1 alerta por IP que llama de forma única por minuto. La actividad aún se registrará en la base de datos y será visible en la consola de gestión de tokens, pero no se generarán alertas (por correo electrónico y/o webhook).

Esto se puede ajustar con la variable de entorno del switchboard CANARY_MAX_ALERTS_PER_MINUTE.

Limitación de fallos de webhook

Después de que un webhook devuelva un error 5 veces seguidas, se deshabilita. Este comportamiento se puede ajustar con MAX_ALERT_FAILURES.

FAQ

Tenemos unas FAQ aquí

Contribuciones

Por favor, consulta nuestros documentos de Código de conducta y Contribuciones antes de enviar un pull request.

Esperamos con interés tus valiosas contribuciones.