Skip to content

Latest commit

 

History

History
42 lines (33 loc) · 1.77 KB

README.md

File metadata and controls

42 lines (33 loc) · 1.77 KB

hibp-bot-2

Features

  1. Check all emails in a slack organization, return a list of those pwned and not pwned, and privately DM each individual with details (allPwned).

  2. DM each new user upon sign-up to the Slack whether their associated email has been pwned. Returns the list of breaches in a text file. (automated)

  3. Check the email associated with your slack account as well as any email you pass as a parameter. Returns if you have been pwned along with details of the breaches. (pwned, pwned email)

Deploy

Deploy

  • Hit that button
  • Change the config variables
    1. You'll need to create a Slack app here
    2. Make the following config variables (in key - value format)
      • clientId - provided by slack
      • clientSecret - ditto
      • oauthRedirect - yourHerokuUrl/oauth
      • PORT - 80
  • Go toyourHerokuUrl/login and authorize it.
  • You might get something that says it didn't work but it did (we just haven't added a handler to acknowledge that it worked)
  • Your app should work!
    • Try DMing the bot any of the following:
      • Pwned
      • Pwned email
      • allPwned
      • help

Known Bugs

  • Each time you redeploy to Heroku, you'll have to go and login again
  • The app will fall asleep every day for at least 6 hours and whenever it hasn't been interacted with for an hour
    • To fix that, we recommend either paying Heroku (boo) or using https://kaffeine.herokuapp.com/ and selecting a time of day where it's acceptable for it be down
  • It's unknown what sleeping will do to Heroku deploy - will update when we know
  • It's very unsteady - if you get an error, Heroku will probably just restart the app

License

MIT.

Anything else?

Open an issue!