@garthk/canary-bus
v2.0.1
Published
I forward reports from canaries to you
Downloads
7
Maintainers
Readme
Canary Bus
In two minutes or less, deploy an anonymous target for your Thinkst Canarytokens that forwards to Slack, Honeycomb, or whatever else you have in mind.
Two Minute Deployment on Glitch
Glitch runs your JavaScript for free as long as you don't mind anyone on the Internet being able to read your source code. It's not the best for the OPSEC if you're a black hat, but you're a white hat hacker just trying to prove your gym saw your request to cancel your membership.
Start in the Glitch editor for
canary-bus
Click Remix this just above the Canary Bus title
Fill in
.env
with your Environment VariablesClick Show Live to visit your site, e.g.
https://wut.glitch.me
Create a web hook Canarytoken aimed at
https://wut.glitch.me/SECRET
Test it
Note:
You don't need an account if you only need five days and can keep your browser cookies that long.
Your
.env
needsSECRET
and at least oneNOTIFY_*
to be useful.Your
.env
is the one file that Glitch doesn't let everybody read; do let them know if you prove otherwise eh?
Customisation
To change the domain name on Glitch, click your project name in the upper left corner, then select and edit the name below it.
To change the site's appearance for a thin veneer of respectability, edit
public/index.html
.
Re-use
If you're sorted on catching web hooks, deployment, and a suitable masquerade, but want some quick and dirty notification code:
At a prompt:
npm install --save @garthk/canary-bus
In your code:
const bus = require('@garthk/canary-bus').auto(); // get a payload from a canary token webhook bus.notify(payload);
The notify
method returns a Promise
for null
. It'll wait for Slack, but not Honeycomb.
Environment Variables
The shortest useful environment in
.env
file format is:SECRET=SECRET NOTIFY_SLACK=https://hooks.slack.com/services/4615/nope/f3c3eeb919a8
SECRET
is mandatory, and gives the webhook path segment after/
to which you'll send your Canarytoken alerts.All other envars are optional.
TMI
will, iftrue
, expose thisREADME
file as the web server's index. By default, the web server's index will be whatever you put inpublic/index.html
.NOTIFY_SLACK
takes a Slack webhook URL.NOTIFY_HONEYCOMB
takes a Honeycomb write key. Honeycomb is my favourite telemetry destination ever. Unlike your usual time series databases, Honeycomb is utterly unfussed by high cardinality data, e.g. Canarytoken IDs, the IP addresses of the machines setting them off, user agents, whatevs.