Canarytokens

由 Thinkst Applied Research 开发

概述

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

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

目录

• 行为准则
• 弃用
• 安装
• 配置
• AWS ID 基础设施
• 出站 SMTP 配置
• 告警限流
• Webhook 失败限制
• 常见问题解答
• 贡献

行为准则

本项目及所有参与者均受 行为准则约束。 参与本项目即表示您应遵守此准则。请将不可接受的行为报告至 [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_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

请注意，在选择要使用的电子邮件提供商时，您必须只提供 与该提供商相关的信息。例如，如果您设置了 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 key Canarytokens 使用 AWS 侧基础设施来分配 IAM 用户并运行安全网检查。该基础设施已迁移至私有仓库。

本仓库仍负责 Canarytokens 面向的集成点：

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

出站 SMTP 配置

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

限制：

• 不得配置其他提供商（如 Mailgun 或 Sendgrid），此功能才能正常工作
• 对于 AWS SES，CANARY_ALERT_EMAIL_FROM_DISPLAY 应采用以下格式：CANARY_ALERT_EMAIL_FROM_DISPLAY=CanaryAlert <[email protected]>

注意：SMTP 告警邮件发送符合 RFC 规范的 From 头。如果 CANARY_ALERT_EMAIL_FROM_DISPLAY 配置为显示名称，则生成的头将呈现为 Display Name <CANARY_ALERT_EMAIL_FROM_ADDRESS>，与现有 Mailgun 行为一致。这可能会略微改变 SMTP 后端部署中发件人在邮件客户端中的显示方式，但告警邮件正文保持不变。

要使 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 次后，它将被禁用。此行为可以通过 MAX_ALERT_FAILURES 进行调整。

常见问题解答

我们在此处提供了常见问题解答

贡献

在提交 pull request 之前，请查看我们的行为准则和贡献指南文档。

我们期待您的宝贵贡献。