Skip to content
KitploitKITPLOIT
ToolsExploitsBlog
Log in
Submit
ToolsExploitsBlog
Submit

Hacking, PenTest, and Cybersecurity Tools for Your Security Arsenal!

Kitploit is a directory of hacking, cybersecurity, and pentesting tools. Discover the latest project updates to find vulnerabilities, analyze systems, automate testing, and strengthen your security.

FeedsContactPrivacy© 2026 Kitploit

Tool Directory

Categories

View all categories
Loading categories
canarytokens — Canarytokens helps track activity and actions on your network | Kitploit
Tools/GitHubGitHub/thinkst/canarytokens
Defensive ToolsNetwork SecurityIntrusion DetectionIncident ResponseAnomaly Detection
GitHubthinkst/canarytokens

canarytokens

Canarytokens helps track activity and actions on your network

View Repository
2.1k294636 days agoReviewed by Kitploit
Share
Website

Canarytokens

by Thinkst Applied Research

Overview

Canarytokens help track activity and actions on your network.

If you have any issues please check out our FAQ over here, or create an issue and we'll try to get back to you as soon as possible.

Table of Contents

  • Code of Conduct
  • Deprecations
  • Installation
  • Configuration
  • AWS ID infrastructure
  • Configuration of Outgoing SMTP
  • Alert throttling
  • Webhook failure limiting
  • FAQ
  • Contributing

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Deprecations

  • The Slack API Token is deprecated and it's no longer possible to create new ones. Old tokens will still work.

Installation

We recommend the Docker image installation process.

Configuration

The Canarytokens server can use many different settings configurations. You can find them in settings.py. There are two main settings files: frontend.env and switchboard.env.

The frontend.env contains the frontend process settings such as:

  • 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

The switchboard.env contains the switchboard process settings such as:

Variable NameValue
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_MINUTE1000
CANARY_SMTP_USERNAME
CANARY_SMTP_PASSWORD
CANARY_SMTP_SERVERsmtp.gmail.com
CANARY_IPINFO_API_KEY<ipinfo.io api key>
CANARY_SMTP_PORT587
CANARY_WEB_IMAGE_UPLOAD_PATH/uploads
LOG_FILEswitchboard.log
ERROR_LOG_WEBHOOK
CANARY_FORCE_HTTPSforce https protocol scheme for Canarytokens
CANARY_LAMBDA_AWS_CRED_REPORT_AUTH

Please note that when choosing which email provider you would like to use, you MUST only provide information related to that provider. E.g. if you have CANARY_MAILGUN_API_KEY then you must remove the others such as CANARY_SENDGRID_API_KEY and CANARY_MANDRILL_API_KEY.

If you are using Mailgun's European infrastructure for your Canarytokens Server, you will need to add CANARY_MAILGUN_BASE_URL=https://api.eu.mailgun.net to your switchboard.env. If you do not specify that, we will use the regular URL as 'https://api.mailgun.net' as the default.

AWS ID infrastructure

AWS API key Canarytokens use AWS-side infrastructure to allocate IAM users and run safety-net checks. That infrastructure has moved to a private repo.

This repo still owns the Canarytokens-facing integration points:

  • CANARY_AWSID_URL in frontend.env is the API Gateway/Lambda URL for the LinkAWSIDTokenUserToCanaryConsole endpoint managed from the private repo.
  • CANARY_AWSID_AUTH in frontend.env must match the auth token in the AWS ID secret. The frontend sends domain, token, auth, and guid when creating an AWS key token.
  • CANARY_AWSID_GUID identifies the Canarytokens instance when allocating and deleting AWS key tokens.
  • CANARY_AWSID_CONTROL_ACCOUNT_ID is the AWS account ID that owns the AWS ID deletion queue.
  • If either CANARY_AWSID_URL or CANARY_AWSID_AUTH is unset, AWS key token creation is disabled for this Canarytokens instance.
  • CANARY_LAMBDA_AWS_CRED_REPORT_AUTH in switchboard.env enables the /a/cr callback used by the AWS ID credential report checker.

Configuration of Outgoing SMTP

When configuring outgoing SMTP please consider the following:

Restrictions:

  • no other provider like Mailgun or Sendgrid must be configured for this to work
  • For AWS SES CANARY_ALERT_EMAIL_FROM_DISPLAY should be in the format: CANARY_ALERT_EMAIL_FROM_DISPLAY=CanaryAlert <[email protected]>

Note: SMTP alert emails send an RFC-compliant From header. If CANARY_ALERT_EMAIL_FROM_DISPLAY is configured as a display name, the resulting header is rendered as Display Name <CANARY_ALERT_EMAIL_FROM_ADDRESS>, matching the existing Mailgun behaviour. This may slightly change how the sender appears in mail clients for SMTP-backed deployments, but the alert email body is unchanged.

The following settings have to be configured in switchboard.env for SMTP to work:

  • CANARY_SMTP_SERVER: the SMTP server
  • CANARY_SMTP_PORT: the port number of the SMTP server (must be a StartTLS enabled port!)
  • CANARY_SMTP_USERNAME: Username for the SMTP server (no anonymous SMTP supported right now)
  • CANARY_SMTP_PASSWORD: the password that corresponds to the username

A complete example config in switchboard.env then looks like this:

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"

Alert throttling

By default, unless running in DEBUG mode, no more than 1 alert per unique calling IP per minute is permitted. Activity will still be recorded in the database, and visible in the token management console, but alerts will not be generated (email and/or webhook).

This is tunable with the switchboard ENV variable CANARY_MAX_ALERTS_PER_MINUTE.

Webhook failure limiting

After a webhook returns an error 5 times in a row, it is disabled. This behaviour can be tuned with MAX_ALERT_FAILURES.

FAQ

We have a FAQ over here

Contributing

Please check out our Code of Conduct and Contributing documents before submitting a pull request.

Download Tool

Most Popular

View all →

Discover the most used tools by our community.

  • 1

    OsintHunter

    letox4/osinthunter

    🎯 The ultimate OSINT toolkit: investigation graph, confidence scoring, alias families, map, timeline and reports. 49 modules, 400+ sites, no API keys required.

    867
  • 2

    ghostlock-app

    yukonga/ghostlock-app

    GhostLock One-Tap Execution App (CVE-2026-43499)

    544
  • 3

    ARTEX

    baarai/artex

    LLM multi-agent autonomous penetration testing platform with planner/worker agents, asset and exploration graphs, MITM traffic recording, and vulnerability retesting.

    385
  • 4

    redforge

    cybersecurity91/redforge

    Browser-side red team toolkit with 102 offline tools for recon, payload generation, credential attacks, crypto, encoding and engagement reporting.

    360
  • 5

    looking-glass

    anonghosty/looking-glass

    CSIRT platform that ingests Shadowserver reports into MongoDB and replays them as interactive maps, analysis, findings, advisories and executive dashboards.

    302
  • 6

    CyberStrikeAI

    ed1s0nz/cyberstrikeai

    The system of action for AI-native cybersecurity—where intent becomes governed execution, evidence becomes operational memory, and every operation improves the next.

    279

Explore all tools

Browse our collection of tools

View all tools →