Canarytokens

作者：Thinkst Applied Research

概述

Canarytokens 可帮助您跟踪网络上的活动和操作。

如果您遇到任何问题，请查看此处的 FAQ，或创建一个 issue，我们会尽快回复您。

目录

• 行为准则
• 弃用说明
• 安装
• 配置
• AWS ID 基础设施
• 出站 SMTP 配置
• 告警限流
• Webhook 失败限制
• FAQ
• 贡献

行为准则

本项目及所有参与者均受行为准则的约束。 参与即表示您应遵守该准则。如发现不可接受的行为，请通过 [email protected] 举报。

弃用说明

• Slack API Token 已弃用，且不再支持创建新的 Token。旧 Token 仍可继续使用。

安装

我们推荐使用 Docker 镜像安装流程。

配置

Canarytokens 服务器可以使用多种不同的设置配置。您可以在 settings.py 中找到它们。主要有两个设置文件：frontend.env 和 switchboard.env。

frontend.env 包含前端进程的设置，例如：

• 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

switchboard.env 包含 switchboard 进程的设置，例如：

请注意，在选择要使用的电子邮件提供商时，您必须只提供与该提供商相关的信息。例如，如果您设置了 CANARY_MAILGUN_API_KEY，则必须移除其他密钥，如 CANARY_SENDGRID_API_KEY 和 CANARY_MANDRILL_API_KEY。

如果您为 Canarytokens 服务器使用 Mailgun 的欧洲基础设施，则需要在您的 switchboard.env 中添加 CANARY_MAILGUN_BASE_URL=https://api.eu.mailgun.net。如果您未指定该设置，我们将使用常规 URL 'https://api.mailgun.net' 作为默认值。

AWS ID 基础设施

AWS API 密钥 Canarytokens 使用 AWS 侧的基础设施来分配 IAM 用户并运行安全网检查。该基础设施已迁移至私有仓库。

本仓库仍然管理面向 Canarytokens 的集成点：

• frontend.env 中的 CANARY_AWSID_URL 是 LinkAWSIDTokenUserToCanaryConsole 端点的 API Gateway/Lambda URL，该端点由私有仓库管理。
• frontend.env 中的 CANARY_AWSID_AUTH 必须与 AWS ID 密钥中的认证令牌匹配。前端在创建 AWS 密钥 Token 时会发送 domain、token、auth 和 guid。
• CANARY_AWSID_GUID 用于在分配和删除 AWS 密钥 Token 时标识 Canarytokens 实例。
• CANARY_AWSID_CONTROL_ACCOUNT_ID 是拥有 AWS ID 删除队列的 AWS 账户 ID。
• 如果 CANARY_AWSID_URL 或 CANARY_AWSID_AUTH 任一未设置，则此 Canarytokens 实例将禁用 AWS 密钥 Token 的创建。
• switchboard.env 中的 用于启用 AWS ID 凭证报告检查器所使用的 回调。

出站 SMTP 配置

配置出站 SMTP 时，请考虑以下事项：

限制：

• 要使其正常工作，不得配置任何其他提供商（如 Mailgun 或 Sendgrid）
• 对于 AWS SES，CANARY_ALERT_EMAIL_FROM_DISPLAY 的格式应为：CANARY_ALERT_EMAIL_FROM_DISPLAY=CanaryAlert <[email protected]>

要使 SMTP 正常工作，必须在 switchboard.env 中配置以下设置：

• CANARY_SMTP_SERVER：SMTP 服务器
• CANARY_SMTP_PORT：SMTP 服务器的端口号（必须是启用 StartTLS 的端口！）
• CANARY_SMTP_USERNAME：SMTP 服务器的用户名（目前不支持匿名 SMTP）
• CANARY_SMTP_PASSWORD：与该用户名对应的密码

switchboard.env 中一个完整的配置示例如下：

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"

告警限流

默认情况下，除非以 DEBUG 模式运行，否则每个独立调用 IP 每分钟最多只允许生成 1 条告警。活动仍会记录在数据库中，并可在 Token 管理控制台中查看，但不会生成告警（电子邮件和/或 Webhook）。

可通过 switchboard 的环境变量 CANARY_MAX_ALERTS_PER_MINUTE 进行调整。

Webhook 失败限制

当 Webhook 连续返回错误 5 次后，该 Webhook 将被禁用。可通过 MAX_ALERT_FAILURES 调整此行为。

FAQ

我们在此处提供了 FAQ

贡献

在提交拉取请求之前，请先查阅我们的行为准则和贡献指南文档。

我们期待您宝贵的贡献。