Canarytokens

Thinkst Applied Research 著

概要

Canarytokens は、ネットワーク上のアクティビティやアクションを追跡するのに役立ちます。

問題がある場合は、こちらの FAQ をご確認いただくか、issue を作成してください。できるだけ早くご連絡いたします。

目次

• 行動規範
• 非推奨事項
• インストール
• 設定
• AWS ID インフラストラクチャ
• 送信 SMTP の設定
• アラートのスロットリング
• Webhook 失敗制限
• FAQ
• コントリビューション

行動規範

このプロジェクトと、それに参加するすべての人は、行動規範に従って運営されています。 参加することで、この規範の遵守が期待されます。受け入れがたい行為は [email protected] までご報告ください。

非推奨事項

• Slack API トークンは非推奨であり、新しく作成することはできなくなりました。古いトークンは引き続き機能します。

インストール

Docker イメージによるインストール手順を推奨します。

設定

Canarytokens サーバーは、さまざまな設定構成を使用できます。それらは settings.py にあります。主な設定ファイルは frontend.env と switchboard.env の 2 つです。

frontend.env には、フロントエンドプロセスの設定が含まれます。例:

• CANARY_DOMAINS=mytesttokensdomain.com
• CANARY_NXDOMAINS=pdf.demo.canarytokens.net
• CANARY_AWSID_URL=<カスタム awsid URL>
• CANARY_AWSID_AUTH=<共有 awsid 認証トークン>
• CANARY_AWSID_GUID=<登録済み awsid コンソール GUID>
• CANARY_AWSID_CONTROL_ACCOUNT_ID=<awsid コントロールアカウント ID>
• CANARY_WEB_IMAGE_UPLOAD_PATH=/uploads
• CANARY_GOOGLE_API_KEY=<カスタム Google マップ API キー>
• LOG_FILE=frontend.log

switchboard.env には、スイッチボードプロセスの設定が含まれます。例:

使用するメールプロバイダーを選択するときは、そのプロバイダーに関連する情報のみを指定する必要があります。たとえば、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 キートークンを作成するときに 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 キートークンの作成が無効になります。

送信 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 件を超えるアラートは許可されません。アクティビティはデータベースに記録され、トークン管理コンソールで表示されますが、アラート (メールや Webhook) は生成されません。

これは、switchboard の ENV 変数 CANARY_MAX_ALERTS_PER_MINUTE で調整できます。

Webhook 失敗制限

Webhook がエラーを 5 回連続で返した後、その Webhook は無効になります。この動作は MAX_ALERT_FAILURES で調整できます。

FAQ

FAQ はこちらにあります。

コントリビューション

プルリクエストを送信する前に、行動規範とコントリビューションガイドをご確認ください。

皆様からの貴重なご貢献をお待ちしております。