Skip to content

browniebroke/cert-transparency-slackbot

Repository files navigation

Certificate Transparency Slackbot

CI Status Test coverage percentage pre-commit.ci status

Poetry Badge Code style by Black pre-commit enabled

Uses Facebook certificate alerts via webhook to receive alerts and send them to Slack.

Prerequisites

  • Have an AWS account setup
  • Have a Slack instance
  • Have a Facebook account

Deployment

These are the steps to get this serverless application deployed:

  • Create a Slack app and install it on your Slack instance
  • Create a Facebook app
  • Configure secrets and deploy the serverless app to AWS
  • Configure the Webhook product in Facebook to send alerts to the serverless function
  • Subscribe to the domains you care about

Set your local environment up

You should clone this repo and copy the .env.example as .env. This file is where you should keep your secrets, outside of source control.

Run yarn install to install all the serverless framework dependencies. You'll need to have Poetry installed, check out their installation instructions if you don't have it. Then run poetry install.

Set up Slack

You'll need to create a Slack app to send messages. You can give it a name like "Cert Transparency", icon and color. Then go over the "OAuth and permissions" section and select the following bot token scopes to the app: chat.write and chat.write.public.

Make sure to reinstall the app on your Slack instance. Copy the bot access token and set it as SLACK_API_TOKEN in your .env file.

While you're here, choose the channel where you want to receive the alerts, and set it as SLACK_CHANNEL in the .env file (with the leading #).

Create a Facebook app

Create a Facebook app in your developer dashboard, or use an existing one. Copy the App ID and secrets into your .env file.

Other environment variables

Finally add the domains you want to received alerts for in the DOMAINS_LIST environment variables. The domains should be comma separated:

DOMAINS_LIST=facebook.com,google.com

Deploy to AWS

Deploy your app to AWS with the profile and region that you want:

serverless deploy --region eu-west-2 --profile default

This should print out the URLs for the endpoints, you should see the same URL available for 2 HTTP verbs, GET and POST:

endpoints:
  POST - https://xxxxxxxxxx.execute-api.eu-west-2.amazonaws.com/dev
  GET - https://xxxxxxxxxx.execute-api.eu-west-2.amazonaws.com/dev

The endpoint is the URL where you'll receive the webhook from Facebook.

Setup the Webhook

Go back to your Facebook developers dashboard, and go into the app that you used earlier. Add the webhook product, and choose the Certificate Transparency. You should be prompted with a dialog asking for a callback URL as well as a verify token. The callback URL is the URL that was printed out at the end of the previous step and the verify token is cert-transparency-slack. Click verify and save.

Once the webhook is added, you can subscribe to 2 type of alerts: certificate or phishing alerts. Check out the facebook documentation to know more about each, this Slackbot only supports certificate for now.

Subscribe your domains

The final step is to register the domains you want to receive alerts for. You can do so by running:

poetry run subscribe.py

This should print out the domains in your .env file as they are registered.

Setup Sentry (optional)

To get error reports in Sentry, set the environment variable SENTRY_DSN to the URL that should be passed to sentry_sdk.init, it should be something like: https://xxxxxx@yyy.ingest.sentry.io/ddddd.