Canarytokens

от Thinkst Applied Research

Обзор

Canarytokens помогают отслеживать активность и действия в вашей сети.

Если у вас возникли проблемы, пожалуйста, ознакомьтесь с нашим FAQ здесь, или создайте issue, и мы постараемся ответить вам как можно скорее.

Оглавление

• Кодекс поведения
• Устаревшие функции
• Установка
• Настройка
• Инфраструктура AWS ID
• Настройка исходящего SMTP
• Ограничение частоты оповещений
• Лимит сбоев вебхуков
• FAQ
• Участие в разработке

Кодекс поведения

Этот проект и все его участники регулируются Кодексом поведения. Участвуя в проекте, вы обязуетесь соблюдать этот кодекс. Пожалуйста, сообщайте о неприемлемом поведении на [email protected].

Устаревшие функции

• Slack API Token устарел, и создать новые токены больше невозможно. Старые токены продолжат работать.

Установка

Мы рекомендуем установку через Docker-образ.

Настройка

Сервер Canarytokens может использовать множество различных конфигураций настроек. Вы можете найти их в settings.py. Есть два основных файла настроек: frontend.env и switchboard.env.

Файл frontend.env содержит настройки frontend-процесса, такие как:

• CANARY_DOMAINS=mytesttokensdomain.com
• CANARY_NXDOMAINS=pdf.demo.canarytokens.net
• CANARY_AWSID_URL=<свой awsid url>
• CANARY_AWSID_AUTH=<общий токен аутентификации awsid>
• CANARY_AWSID_GUID=<зарегистрированный guid консоли awsid>
• CANARY_AWSID_CONTROL_ACCOUNT_ID=<id контрольной учётной записи awsid>
• CANARY_WEB_IMAGE_UPLOAD_PATH=/uploads
• CANARY_GOOGLE_API_KEY=<свой api-ключ google maps>
• LOG_FILE=frontend.log

Файл switchboard.env содержит настройки switchboard-процесса, такие как:

Имя переменной	Значение
CANARY_MAILGUN_DOMAIN_NAME	<домен mailgun>
CANARY_MAILGUN_API_KEY
CANARY_MANDRILL_API_KEY
CANARY_SENDGRID_API_KEY
CANARY_PUBLIC_IP	<вместо использования домена>
CANARY_PUBLIC_DOMAIN	<вместо использования IP>
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	<имя пользователя smtp>
CANARY_SMTP_PASSWORD	<пароль smtp>
CANARY_SMTP_SERVER	smtp.gmail.com
CANARY_IPINFO_API_KEY	<api-ключ ipinfo.io>
CANARY_SMTP_PORT	587
CANARY_WEB_IMAGE_UPLOAD_PATH	/uploads
LOG_FILE	switchboard.log
ERROR_LOG_WEBHOOK	<URI вебхука, на который вы хотите получать журналы ошибок>
CANARY_FORCE_HTTPS	принудительно использовать схему протокола https для Canarytokens
CANARY_LAMBDA_AWS_CRED_REPORT_AUTH	<общий токен аутентификации проверки отчёта об учётных данных>

Обратите внимание: при выборе почтового провайдера вы ОБЯЗАНЫ указать информацию только об этом провайдере. Например, если у вас есть CANARY_MAILGUN_API_KEY, вы должны удалить остальные, такие как CANARY_SENDGRID_API_KEY и CANARY_MANDRILL_API_KEY.

Если вы используете европейскую инфраструктуру Mailgun для сервера Canarytokens, вам нужно добавить CANARY_MAILGUN_BASE_URL=https://api.eu.mailgun.net в ваш switchboard.env. Если вы не укажете это, по умолчанию будет использоваться обычный URL 'https://api.mailgun.net'.

Инфраструктура AWS ID

Canarytokens для AWS API-ключей используют инфраструктуру на стороне AWS для выделения IAM-пользователей и выполнения проверок безопасности (safety-net). Эта инфраструктура перенесена в приватный репозиторий.

Этот репозиторий по-прежнему содержит точки интеграции, обращённые к Canarytokens:

• CANARY_AWSID_URL в frontend.env — это URL API Gateway/Lambda для конечной точки LinkAWSIDTokenUserToCanaryConsole, управляемой из приватного репозитория.
• CANARY_AWSID_AUTH в frontend.env должен совпадать с токеном аутентификации в секрете AWS ID. Frontend отправляет domain, token, auth и guid при создании токена AWS-ключа.
• CANARY_AWSID_GUID идентифицирует экземпляр Canarytokens при выделении и удалении токенов AWS-ключей.
• CANARY_AWSID_CONTROL_ACCOUNT_ID — это идентификатор учётной записи AWS, которой принадлежит очередь удаления AWS ID.
• Если CANARY_AWSID_URL или CANARY_AWSID_AUTH не заданы, создание токенов AWS-ключей отключено для этого экземпляра Canarytokens.
• CANARY_LAMBDA_AWS_CRED_REPORT_AUTH в switchboard.env включает callback /a/cr, используемый средством проверки отчёта об учётных данных 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, разрешено не более 1 оповещения с одного уникального IP-адреса в минуту. Активность по-прежнему будет записываться в базу данных и будет видна в консоли управления токенами, но оповещения (по email и/или через вебхук) генерироваться не будут.

Это можно настроить с помощью переменной окружения switchboard CANARY_MAX_ALERTS_PER_MINUTE.

Лимит сбоев вебхуков

После того как вебхук возвращает ошибку 5 раз подряд, он отключается. Это поведение можно настроить с помощью MAX_ALERT_FAILURES.

FAQ

Наш FAQ находится здесь

Участие в разработке

Пожалуйста, ознакомьтесь с документами Кодекс поведения и Участие в разработке перед отправкой pull request.

С нетерпением ждём вашего ценного вклада.