• O Slack API Token está obsoleto e não é mais possível criar novos. Tokens antigos ainda funcionarão.

Instalação

Recomendamos o processo de instalação por imagem Docker.

Configuração

O servidor Canarytokens pode usar muitas configurações diferentes. Você pode encontrá-las em settings.py. Existem dois arquivos de configuração principais: frontend.env e switchboard.env.

O frontend.env contém as configurações do processo frontend, tais 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

O switchboard.env contém as configurações do processo switchboard, tais como:

Observe que, ao escolher qual provedor de e-mail você deseja usar, você DEVE fornecer apenas informações relacionadas a esse provedor. Por exemplo, se você tiver CANARY_MAILGUN_API_KEY, deverá remover os outros, como CANARY_SENDGRID_API_KEY e CANARY_MANDRILL_API_KEY.

Se você estiver usando a infraestrutura europeia da Mailgun para o seu servidor Canarytokens, precisará adicionar CANARY_MAILGUN_BASE_URL=https://api.eu.mailgun.net ao seu switchboard.env. Se você não especificar isso, usaremos a URL regular 'https://api.mailgun.net' como padrão.

Infraestrutura do AWS ID

Os Canarytokens de chave de API da AWS usam a infraestrutura do lado da AWS para alocar usuários IAM e executar verificações de segurança. Essa infraestrutura foi movida para um repositório privado.

Este repositório ainda contém os pontos de integração voltados ao Canarytokens:

• CANARY_AWSID_URL em frontend.env é a URL do API Gateway/Lambda para o endpoint LinkAWSIDTokenUserToCanaryConsole gerenciado pelo repositório privado.
• CANARY_AWSID_AUTH em frontend.env deve corresponder ao token de autenticação no segredo do AWS ID. O frontend envia domain, token, auth e guid ao criar um token de chave da AWS.
• CANARY_AWSID_GUID identifica a instância do Canarytokens ao alocar e excluir tokens de chave da AWS.
• CANARY_AWSID_CONTROL_ACCOUNT_ID é o ID da conta AWS que possui a fila de exclusão do AWS ID.
• Se CANARY_AWSID_URL ou CANARY_AWSID_AUTH não estiver definido, a criação de tokens de chave da AWS será desativada para esta instância do Canarytokens.
• CANARY_LAMBDA_AWS_CRED_REPORT_AUTH em switchboard.env habilita o callback /a/cr usado pelo verificador de relatório de credenciais do AWS ID.

Configuração de SMTP de saída

Ao configurar o SMTP de saída, considere o seguinte:

Restrições:

• nenhum outro provedor como Mailgun ou Sendgrid deve estar configurado para que isso funcione
• Para AWS SES, CANARY_ALERT_EMAIL_FROM_DISPLAY deve estar no formato: CANARY_ALERT_EMAIL_FROM_DISPLAY=CanaryAlert <[email protected]>

As seguintes configurações precisam ser definidas em switchboard.env para que o SMTP funcione:

• CANARY_SMTP_SERVER: o servidor SMTP
• CANARY_SMTP_PORT: o número da porta do servidor SMTP (deve ser uma porta com StartTLS habilitado!)
• CANARY_SMTP_USERNAME: nome de usuário para o servidor SMTP (nenhum SMTP anônimo é suportado no momento)
• CANARY_SMTP_PASSWORD: a senha que corresponde ao nome de usuário

Um exemplo completo de configuração em switchboard.env fica assim:

Limitação de alertas

Por padrão, a menos que esteja sendo executado em modo DEBUG, não é permitido mais de 1 alerta por IP de origem exclusivo por minuto. A atividade ainda será registrada no banco de dados e ficará visível no console de gerenciamento de tokens, mas os alertas não serão gerados (e-mail e/ou webhook).

Isso é ajustável com a variável de ambiente do switchboard CANARY_MAX_ALERTS_PER_MINUTE.

Limitação de falhas de webhook

Depois que um webhook retorna um erro 5 vezes seguidas, ele é desativado. Esse comportamento pode ser ajustado com MAX_ALERT_FAILURES.

FAQ

Temos uma FAQ aqui

Contribuindo

Por favor, consulte nossos documentos de Código de Conduta e de Contribuição antes de enviar um pull request.

Estamos ansiosos pelas suas valiosas contribuições.