thinkst/canarytokensCanarytokensは、ネットワーク上のアクティビティとアクションを追跡するのに役立ちます。
by Thinkst Applied Research
Canarytokens は、ネットワーク上のアクティビティとアクションの追跡を支援します。
問題が発生した場合は、こちらの FAQ を確認するか、issue を作成してください。できるだけ早く対応いたします。
このプロジェクトおよびプロジェクトに参加するすべての人は、 行動規範に従うものとします。 参加することにより、あなたはこの規範を遵守することが期待されます。受け入れがたい行為を目撃した場合は [email protected] まで報告してください。
Docker イメージによるインストール手順を推奨します。
Canarytokens サーバーは、さまざまな設定構成を使用できます。設定は settings.py にあります。主な設定ファイルは
frontend.env と switchboard.env の 2 つです。
frontend.env には、以下のようなフロントエンドプロセスの設定が含まれます:
switchboard.env には、以下のようなスイッチボードプロセスの設定が含まれます:
| Variable Name | Value |
|---|---|
| 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 API キー Canarytokens は、IAM ユーザーを割り当て、セーフティネットチェックを実行するために AWS 側のインフラストラクチャを使用します。そのインフラストラクチャはプライベートリポジトリに移動しました。
このリポジトリは、Canarytokens に面する統合ポイントを引き続き所有しています:
frontend.env の CANARY_AWSID_URL は、プライベートリポジトリから管理される LinkAWSIDTokenUserToCanaryConsole エンドポイントの API Gateway/Lambda URL です。frontend.env の CANARY_AWSID_AUTH は、AWS ID シークレットの認証トークンと一致する必要があります。フロントエンドは AWS キートークンを作成する際に domain、token、auth、guid を送信します。CANARY_AWSID_GUID は、AWS キートークンを割り当ておよび削除する際に Canarytokens インスタンスを識別します。CANARY_AWSID_CONTROL_ACCOUNT_ID は、AWS ID 削除キューを所有する AWS アカウント ID です。CANARY_AWSID_URL または CANARY_AWSID_AUTH のいずれかが設定されていない場合、この Canarytokens インスタンスでは AWS キートークンの作成が無効になります。switchboard.env の CANARY_LAMBDA_AWS_CRED_REPORT_AUTH は、AWS ID 認証情報レポートチェッカーが使用する /a/cr コールバックを有効にします。送信 SMTP を設定する際は、以下を考慮してください:
制限事項:
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 で以下の設定を行う必要があります:
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 分あたり 1 件を超えるアラートは 許可されません。アクティビティは引き続きデータベースに記録され、トークン管理コンソールに表示されますが、 アラート (メールや Webhook) は生成されません。
これはスイッチボードの環境変数 CANARY_MAX_ALERTS_PER_MINUTE で調整できます。
Webhook が 5 回連続でエラーを返すと、その Webhook は無効になります。この動作は
MAX_ALERT_FAILURES で調整できます。
こちらに FAQ があります。
プルリクエストを送信する前に、行動規範とコントリビューションのドキュメントを確認してください。
皆様の貴重な貢献をお待ちしております。