--- name: implementing-canary-tokens-for-network-intrusion-4dbf9ac613fb description: 'Deploys DNS, HTTP, and AWS API key canary tokens across network infrastructure to detect unauthorized access and lateral movement. Integrates with webhook alerting (Slack, Teams, email, generic HTTP) for real-time intrusion notifications. Provides automated token generation, placement strategies, and monitoring for enterprise network environments. Use when building deception-based network intrusion detection with Canarytokens.org and Thinkst Canary platforms. ' domain: cybersecurity subdomain: security-operations tags: - canary-tokens - intrusion-detection - deception - network-security - honeytokens - breach-detection version: '1.0' author: Krishna Kumar (xalgord) license: Apache-2.0 nist_csf: - DE.CM-01 - RS.MA-01 - GV.OV-01 - DE.AE-02 --- ## Helper prerequisites This bundled skill supplies methodology text; it does not install the local helper files invoked below. Before running a command using `agent.py` or a `scripts/` path, create that file from a complete implementation when one is supplied, or obtain and review the matching upstream helper. Check its `--help` and dependencies against the shown arguments. If no implementation is available, the invocation is a workflow illustration rather than a runnable command; use the documented underlying tools instead. # Implementing Canary Tokens for Network Intrusion Detection ## When to Use - When deploying deception-based tripwires across network infrastructure to detect intrusions - When building early warning systems that alert on unauthorized access to sensitive resources - When planting fake AWS credentials, DNS beacons, or HTTP tokens to catch attackers during lateral movement - When integrating canary token alerts with SOC workflows via Slack, Microsoft Teams, or SIEM webhooks - When complementing traditional IDS/IPS with zero-false-positive deception technology ## Common Misconfigurations & Verification - **The token never triggers because nobody finds it:** a canary planted in a path no attacker traverses is dead weight. Place tokens where recon actually lands — `~/.aws/credentials`, `.env`, config files with enticing memos, files named `passwords.docx` — and make them discoverable, not buried. - **Egress/whitelisting silently swallows alerts:** DNS tokens require outbound DNS to reach `canarytokens.com`; HTTP/AWS tokens need egress to the token server. In segmented or proxy-forced networks the resolution/callback is dropped and the trip is never recorded. AWS-key tokens also fail if the org's allowlist or SCP blocks calls to the canary's account/region — confirm the path end-to-end. - **Tokens that leak as real-looking credentials get auto-quarantined:** secret scanners (GitHub push protection, GitGuardian) and EDR may delete or block a planted AWS key before an attacker uses it — exclude canary paths from scanners. - **Memo/source-IP context missing:** an alert with no memo or NAT'd source IP can't be triaged; ensure each token's `memo` encodes its location and that the webhook payload carries `src_ip`. - **Verification:** trigger every token type before relying on it — resolve the DNS FQDN (`dig`), `curl` the HTTP URL, and run `aws sts get-caller-identity` with the fake key — and confirm the Slack/Teams/SIEM alert arrives within ~60s (the Validation Checklist below). Re-test after any firewall/egress change, since that is what most often silently breaks tokens. ## Prerequisites - Python 3.8+ with `requests` library installed - Network access to canarytokens.org API (or self-hosted Canarytokens instance) - Webhook endpoint for alert delivery (Slack, Teams, email, or generic HTTP) - For Thinkst Canary enterprise: valid console domain and API auth token - Administrative access to target systems where tokens will be planted - Appropriate authorization for all deployment activities ## Core Concepts ### What Are Canary Tokens? Canary tokens are digital tripwires -- resources that should never be accessed during normal operations. When an attacker interacts with a canary token, it immediately triggers an alert with near-zero false positives. Unlike signature-based detection, canary tokens detect attackers by their behavior (accessing bait resources) rather than matching known patterns. ### Token Types for Network Intrusion Detection | Token Type | Trigger Mechanism | Best Placement | Detection Scenario | |------------|-------------------|----------------|-------------------| | DNS Token | DNS resolution of FQDN | Config files, scripts, internal docs | Attacker reads configs during recon | | HTTP Token | HTTP GET to unique URL | Internal wikis, bookmark files, HTML | Attacker browses internal resources | | AWS API Key | AWS API call with fake creds | `.aws/credentials`, env files, repos | Attacker tests found credentials | | Cloned Site | Visit to cloned page | Internal portals, admin panels | Attacker accesses cloned services | | SVN Token | SVN checkout | Repository configs | Attacker clones repositories | | SQL Server | Database login attempt | Connection strings, config files | Attacker attempts DB access | ### Alert Flow Architecture ``` [Attacker Action] --> [Token Triggered] --> [Canarytokens Server] | [Webhook POST] | +-------------------------+-------------------------+ | | | [Slack Alert] [Email Alert] [SIEM Ingestion] | | | [SOC Analyst] [On-Call Page] [Correlation Rule] ``` ## Instructions ### Step 1: Generate DNS Canary Tokens DNS tokens are the most versatile -- they trigger on any DNS resolution, even from air-gapped networks with only DNS egress. The token is an FQDN that, when resolved, alerts the token owner. ```python import requests # Create DNS canary token via Canarytokens.org response = requests.post("https://canarytokens.org/generate", data={ "type": "dns", "email": "soc@company.com", "memo": "Production database server - /etc/app/db.conf", "webhook_url": "https://hooks.slack.com/services/T.../B.../xxx" }, timeout=15) token_data = response.json() dns_hostname = token_data["hostname"] # Example: abc123def456.canarytokens.com ``` Plant DNS tokens in locations attackers commonly inspect: - `/etc/hosts` entries pointing to the canary FQDN - Application configuration files (`database_host`, `backup_server`) - SSH config files (`~/.ssh/config`) with canary hostnames - Internal DNS zone files as decoy A records - CI/CD pipeline environment variables ### Step 2: Deploy HTTP Canary Tokens HTTP tokens generate a unique URL that triggers on any HTTP request. They reveal the source IP, User-Agent, and other HTTP headers of the requester. ```python # Create HTTP token response = requests.post("https://canarytokens.org/generate", data={ "type": "http", "email": "soc@company.com", "memo": "Internal wiki - IT admin passwords page", "webhook_url": "https://hooks.slack.com/services/T.../B.../xxx" }, timeout=15) http_url = response.json()["url"] # Embed in internal HTML pages, documents, or bookmark files ``` Placement strategies for HTTP tokens: - Hidden `` tags in internal wiki pages with sensitive titles - URL shortener redirects in shared bookmark collections - Links in internal documentation labeled "admin credentials" or "VPN configs" - `.url` or `.webloc` shortcut files in network shares - Browser bookmark exports in user profile backups ### Step 3: Create AWS API Key Tokens AWS key tokens are among the highest-fidelity canary tokens. They generate real-looking AWS access keys that trigger an alert whenever anyone attempts to use them against any AWS API endpoint. ```python # Create AWS API key canary token response = requests.post("https://canarytokens.org/generate", data={ "type": "aws_keys", "email": "soc@company.com", "memo": "DevOps jump box - /home/deploy/.aws/credentials", "webhook_url": "https://hooks.slack.com/services/T.../B.../xxx" }, timeout=15) aws_token = response.json() access_key_id = aws_token["access_key_id"] secret_access_key = aws_token["secret_access_key"] ``` Deploy the fake credentials: ```ini # Place in ~/.aws/credentials on honeypot or jump servers [default] aws_access_key_id = AKIAIOSFODNN7EXAMPLE aws_secret_access_key = wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY region = us-east-1 # Also plant in: # - .env files in code repositories # - Docker environment configurations # - Terraform state files (decoy) # - Jenkins/CI credential stores ``` ### Step 4: Configure Webhook Alert Integration Set up real-time alerting to your SOC through multiple channels: ```python # Slack webhook integration def send_slack_alert(webhook_url, alert_data): """Forward canary token alert to Slack channel.""" payload = { "text": f":rotating_light: *Canary Token Triggered*", "attachments": [{ "color": "#FF0000", "fields": [ {"title": "Token Memo", "value": alert_data.get("memo", "Unknown"), "short": True}, {"title": "Source IP", "value": alert_data.get("src_ip", "Unknown"), "short": True}, {"title": "Token Type", "value": alert_data.get("channel", "Unknown"), "short": True}, {"title": "Triggered At", "value": alert_data.get("time", "Unknown"), "short": True}, ], "footer": "Canarytokens Alert System", }] } requests.post(webhook_url, json=payload, timeout=10) ``` ```python # Generic webhook receiver (Flask) for SIEM ingestion from flask import Flask, request, jsonify import json, logging app = Flask(__name__) logging.basicConfig(filename="/var/log/canary_alerts.json", level=logging.INFO) @app.route("/canary-webhook", methods=["POST"]) def receive_alert(): alert = request.json or request.form.to_dict() logging.info(json.dumps({ "event_type": "canarytoken_triggered", "memo": alert.get("memo"), "src_ip": alert.get("src_ip"), "token_type": alert.get("channel"), "time": alert.get("time"), "manage_url": alert.get("manage_url"), "additional_data": alert.get("additional_data", {}), })) return jsonify({"status": "received"}), 200 ``` ### Step 5: Enterprise Deployment with Thinkst Canary API For organizations using Thinkst Canary, leverage the API for mass deployment and centralized management: ```python import canarytools # Connect to Thinkst Canary console console = canarytools.Console( domain="yourcompany", api_key="your_api_auth_token" ) # Create tokens programmatically at scale token_types = { "dns": "DNS beacon in config files", "aws-id": "AWS credentials on jump servers", "http": "Web bug in internal documentation", "doc-msword": "Word document in finance share", "slack-api": "Fake Slack bot token in source code", } for kind, memo in token_types.items(): result = console.tokens.create(memo=memo, kind=kind) print(f"[+] Created {kind} token: {result}") # Monitor for triggered alerts alerts = console.tokens.alerts() for alert in alerts: print(f"[ALERT] {alert.memo} triggered from {alert.src_ip}") ``` ### Step 6: Token Placement Strategy by Network Zone **DMZ / Public-Facing:** - HTTP tokens in admin panel login pages (hidden image tag) - DNS tokens in web server configuration files - AWS keys in `.env` files on staging servers **Internal Network / Corporate:** - DNS tokens in Active Directory Group Policy scripts - AWS keys in developer workstation backup directories - HTTP tokens in internal SharePoint/Confluence pages titled "Emergency Credentials" - Word document tokens in network shares (`\\fileserver\IT\passwords.docx`) **Production / Data Center:** - DNS tokens in database configuration files - AWS keys in CI/CD environment variables - SQL Server tokens in connection strings on application servers - SVN/Git tokens in repository configuration files **Cloud Infrastructure:** - AWS key tokens in S3 bucket policies (decoy) - DNS tokens in CloudFormation/Terraform templates - HTTP tokens in Lambda function environment variables - Cloned-site tokens mimicking cloud admin consoles ## Examples ### Full Deployment Script ```bash # Deploy a comprehensive canary token network python scripts/agent.py --action full_deploy \ --email soc@company.com \ --webhook https://hooks.slack.com/services/T.../B.../xxx \ --output deployment_report.json ``` ### Monitor Triggered Tokens ```bash # Check for triggered alerts python scripts/agent.py --action monitor \ --console-domain yourcompany \ --api-key YOUR_AUTH_TOKEN ``` ### Generate Token Inventory ```bash # Create inventory of all deployed tokens python scripts/agent.py --action inventory \ --output token_inventory.json ``` ## Validation Checklist - [ ] DNS tokens resolve correctly and generate alerts within 60 seconds - [ ] HTTP tokens return a valid response and log source IP - [ ] AWS key tokens trigger alerts when used with `aws sts get-caller-identity` - [ ] Webhook alerts arrive in Slack/Teams/SIEM within acceptable latency - [ ] Token memo fields contain sufficient context for SOC triage - [ ] Deployment locations are documented in token inventory - [ ] Alert escalation procedures are defined and tested - [ ] Tokens do not interfere with legitimate operations - [ ] Self-hosted Canarytokens instance (if used) is hardened and monitored - [ ] Token rotation schedule is established (quarterly recommended) ## References - Canarytokens Documentation: https://docs.canarytokens.org/guide/ - Thinkst Canary Platform: https://canary.tools/ - Thinkst Canary API: https://docs.canary.tools/canarytokens/actions.html - Canarytokens Open Source: https://github.com/thinkst/canarytokens - Zeltser Honeytoken Setup Guide: https://zeltser.com/honeytokens-canarytokens-setup/ - Grafana Canary Token Case Study: https://grafana.com/blog/2025/08/25/canary-tokens-learn-all-about-the-unsung-heroes-of-security-at-grafana-labs/ - AWS Infrastructure Canarytoken: https://blog.thinkst.com/2025/09/introducing-the-aws-infrastructure-canarytoken.html --- Source attribution: xalgord Original project: https://github.com/xalgord/xalgorix/blob/cec44d71b1d998208e1e2091982d0ee2f928041f/internal/tools/skills/data/security-operations/implementing-canary-tokens-for-network-intrusion/SKILL.md License: Apache-2.0 License information: https://www.apache.org/licenses/LICENSE-2.0 Original upstream instructions; downloaded from Mega AI Hub. ## Upstream license notice Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2026 xalgord Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. # Mega AI Hub resource metadata Creator / publisher: xalgord Original project: https://github.com/xalgord/xalgorix/blob/cec44d71b1d998208e1e2091982d0ee2f928041f/internal/tools/skills/data/security-operations/implementing-canary-tokens-for-network-intrusion/SKILL.md Attribution basis: Source repository record Fields of work: Development & Engineering Roles: DevOps / SRE, Security Engineer Specialties: API, Backend Tools: Email (SMTP/IMAP), Microsoft Teams, Thinkst Canary, Slack, Canarytokens.Org Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: 022a138431600f2407d03d17eceaf67fe3bf54ee5ca5b7ffd396ae0df5e18e20