Canarytokens

von Thinkst Applied Research

Übersicht

Canarytokens helfen dabei, Aktivitäten und Aktionen in Ihrem Netzwerk zu verfolgen.

Wenn Sie Probleme haben, schauen Sie sich bitte unsere FAQ hier an, oder erstellen Sie ein Issue, und wir werden uns so schnell wie möglich bei Ihnen melden.

Inhaltsverzeichnis

• Verhaltenskodex
• Veraltete Funktionen
• Installation
• Konfiguration
• AWS-ID-Infrastruktur
• Konfiguration des ausgehenden SMTP
• Drosselung von Warnungen
• Begrenzung von Webhook-Fehlern
• FAQ
• Mitwirken

Verhaltenskodex

Dieses Projekt und alle, die daran teilnehmen, unterliegen dem Verhaltenskodex. Durch die Teilnahme verpflichten Sie sich, diesen Kodex einzuhalten. Bitte melden Sie inakzeptables Verhalten an [email protected].

Veraltete Funktionen

• Das Slack-API-Token ist veraltet, und es ist nicht mehr möglich, neue zu erstellen. Alte Tokens funktionieren weiterhin.

Installation

Wir empfehlen die Installation über das Docker-Image.

Konfiguration

Der Canarytokens-Server kann viele verschiedene Einstellungskonfigurationen verwenden. Sie finden sie in settings.py. Es gibt zwei Haupt-Einstellungsdateien: frontend.env und switchboard.env.

Die Datei frontend.env enthält die Einstellungen des Frontend-Prozesses, wie zum Beispiel:

• 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=<benutzerdefinierter Google-Maps-API-Schlüssel>
• LOG_FILE=frontend.log

Die Datei switchboard.env enthält die Einstellungen des Switchboard-Prozesses, wie zum Beispiel:

Bitte beachten Sie, dass Sie bei der Auswahl des gewünschten E-Mail-Anbieters NUR Informationen angeben dürfen, die sich auf diesen Anbieter beziehen. Wenn Sie z. B. CANARY_MAILGUN_API_KEY haben, müssen Sie die anderen entfernen, z. B. CANARY_SENDGRID_API_KEY und CANARY_MANDRILL_API_KEY.

Wenn Sie für Ihren Canarytokens-Server die europäische Infrastruktur von Mailgun verwenden, müssen Sie CANARY_MAILGUN_BASE_URL=https://api.eu.mailgun.net zu Ihrer switchboard.env hinzufügen. Wenn Sie das nicht angeben, verwenden wir als Standard die reguläre URL 'https://api.mailgun.net'.

AWS-ID-Infrastruktur

AWS-API-Schlüssel-Canarytokens verwenden die AWS-seitige Infrastruktur, um IAM-Benutzer zuzuweisen und Sicherheitsnetz-Prüfungen durchzuführen. Diese Infrastruktur wurde in ein privates Repository verlagert.

Dieses Repository enthält weiterhin die Canarytokens-zugewandten Integrationspunkte:

• CANARY_AWSID_URL in frontend.env ist die API-Gateway/Lambda-URL für den Endpunkt LinkAWSIDTokenUserToCanaryConsole, der aus dem privaten Repository verwaltet wird.
• CANARY_AWSID_AUTH in frontend.env muss mit dem Authentifizierungstoken im AWS-ID-Secret übereinstimmen. Das Frontend sendet domain, token, auth und guid, wenn ein AWS-Schlüssel-Token erstellt wird.
• CANARY_AWSID_GUID identifiziert die Canarytokens-Instanz beim Zuweisen und Löschen von AWS-Schlüssel-Tokens.
• CANARY_AWSID_CONTROL_ACCOUNT_ID ist die AWS-Konto-ID, der die AWS-ID-Löschwarteschlange gehört.
• Wenn entweder CANARY_AWSID_URL oder CANARY_AWSID_AUTH nicht gesetzt ist, ist die Erstellung von AWS-Schlüssel-Tokens für diese Canarytokens-Instanz deaktiviert.

Konfiguration des ausgehenden SMTP

Beachten Sie bei der Konfiguration des ausgehenden SMTP Folgendes:

Einschränkungen:

• Für diese Funktion darf kein anderer Anbieter wie Mailgun oder Sendgrid konfiguriert sein.
• Für AWS SES sollte CANARY_ALERT_EMAIL_FROM_DISPLAY das folgende Format haben: CANARY_ALERT_EMAIL_FROM_DISPLAY=CanaryAlert <[email protected]>

Die folgenden Einstellungen müssen in switchboard.env konfiguriert werden, damit SMTP funktioniert:

• CANARY_SMTP_SERVER: der SMTP-Server
• CANARY_SMTP_PORT: die Portnummer des SMTP-Servers (muss ein StartTLS-fähiger Port sein!)
• CANARY_SMTP_USERNAME: Benutzername für den SMTP-Server (anonymes SMTP wird derzeit nicht unterstützt)
• CANARY_SMTP_PASSWORD: das Passwort, das zum Benutzernamen gehört

Eine vollständige Beispielkonfiguration in switchboard.env sieht dann wie folgt aus:

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"

Drosselung von Warnungen

Standardmäßig ist, außer im DEBUG-Modus, nicht mehr als 1 Warnung pro eindeutiger aufrufender IP pro Minute zulässig. Die Aktivität wird weiterhin in der Datenbank aufgezeichnet und in der Token-Verwaltungskonsole sichtbar sein, aber es werden keine Warnungen (per E-Mail und/oder Webhook) erzeugt.

Dies kann über die Switchboard-ENV-Variable CANARY_MAX_ALERTS_PER_MINUTE eingestellt werden.

Begrenzung von Webhook-Fehlern

Wenn ein Webhook fünfmal hintereinander einen Fehler zurückgibt, wird er deaktiviert. Dieses Verhalten kann über MAX_ALERT_FAILURES eingestellt werden.

FAQ

Wir haben eine FAQ hier

Mitwirken

Bitte sehen Sie sich vor dem Einreichen eines Pull-Requests unsere Dokumente Verhaltenskodex und Mitwirken an.

Wir freuen uns auf Ihre wertvollen Beiträge.