Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thinkst/canarytokens
Canarytokens helps track activity and actions on your network.
https://github.com/thinkst/canarytokens
Last synced: 7 days ago
JSON representation
Canarytokens helps track activity and actions on your network.
- Host: GitHub
- URL: https://github.com/thinkst/canarytokens
- Owner: thinkst
- License: other
- Created: 2015-07-30T12:39:30.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-11-27T14:48:31.000Z (15 days ago)
- Last Synced: 2024-11-27T15:22:53.340Z (15 days ago)
- Language: HTML
- Homepage: http://canarytokens.org
- Size: 58.9 MB
- Stars: 1,759
- Watchers: 44
- Forks: 258
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cybersecurity-blueteam - CanaryTokens - Self-hostable honeytoken generator and reporting dashboard; demo version available at [CanaryTokens.org](https://canarytokens.org/). (Honeypots / Supply chain security)
- awesome-network-stuff - **405**星
- awesome-cybersecurity-blueteam-cn - CanaryTokens - 可以自承载的Honey Token生成器及报告模版，演示版本可查看：[CanaryTokens.org](https://canarytokens.org/). (蜜罐 / 策略执行)
README
# 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](https://github.com/thinkst/canarytokens/wiki#), or create an issue and we'll try to get back to you as soon as possible.
## Table of Contents
- [Code of Conduct](#code-of-conduct)
- [Deprecations](#deprecations)
- [Installation](#installation)
- [Configuration](#configuration)
- [Configuration of Outgoing SMTP](#configuration-of-outgoing-smtp)
- [Alert throttling](#alert-throttling)
- [Webhook failure limiting](#webhook-failure-limiting)
- [FAQ](#faq)
- [Contributing](#contributing)
## Code of Conduct
This project and everyone participating in it is governed by the
[Code of Conduct](https://github.com/thinkst/.github/blob/master/CODE_OF_CONDUCT.md).
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](https://github.com/thinkst/canarytokens-docker).
## 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_WEB_IMAGE_UPLOAD_PATH=/uploads
- CANARY_GOOGLE_API_KEY=
- LOG_FILE=frontend.log
The `switchboard.env` contains the switchboard process settings such as:
| 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 | |
| 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 |
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.
Lastly, we have added the ability to specify your own AWSID lambda so that you may host your own. The setting is placed in
`frontend.env` under `CANARY_AWSID_URL`. If this value is not specified, it will use our default hosted lambda.
### 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
* only supports StartTLS right now (you have to use the corresponding port)
* no anonymous SMTP is supported right now (you have to use a username/password to authenticate)
* For AWS SES `CANARY_ALERT_EMAIL_FROM_DISPLAY` should be in the format: `CANARY_ALERT_EMAIL_FROM_DISPLAY=CanaryAlert `
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=
CANARY_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](https://github.com/thinkst/canarytokens/wiki)
## Contributing
Please check out our [Code of Conduct](https://github.com/thinkst/.github/blob/master/CODE_OF_CONDUCT.md) and [Contributing](https://github.com/thinkst/.github/blob/master/CONTRIBUTING.md) documents before submitting a pull request.
We look forward to your valuable contributions.