3c649f7ecb | ||
---|---|---|
db | ||
public | ||
routes | ||
scripts | ||
tests | ||
views | ||
.env-dist | ||
.eslintignore | ||
.eslintrc.js | ||
.gitignore | ||
.htmllintrc | ||
.npmignore | ||
.sequelizerc | ||
.travis.yml | ||
README.md | ||
api.md | ||
app-constants.js | ||
db-utils.js | ||
email-utils.js | ||
package-lock.json | ||
package.json | ||
server.js |
README.md
Breach Alerts
Summary
Firefox Breach Alerts notifies users when their credentials have possibly been leaked or stolen in a data breach. Powered by haveibeenpwned.com.
Context
See the Have I Been Pwned about page for the "what" and "why" of data breach alerts.
This project aims to explore how Firefox - as the user agent - can support this.
See the Breach Alert Product Brief for more background, objectives, key use cases.
Development
Requirements
- Node 9 (with npm)
Install
-
Clone and change to the directory:
git clone https://github.com/mozilla/blurts-server.git cd blurts-server
-
Install dependencies:
npm install
-
Copy the
.env-dist
file to.env
:cp .env-dist .env
Run
-
Run the server:
npm start
-
Visit the
test.html
page at localhost:6060/test.html
Emails
The included .env-dist
sets DEBUG_DUMMY_SMTP=1
which disables emails.
To send emails, you'll need to unset DEBUG_DUMMY_SMTP
and supply real SMTP
config values for sending email.
You can set and source these via the .env
file, or set them directly:
export DEBUG_DUMMY_SMTP=
export SMTP_HOST=<your-smtp-host>
export SMTP_PORT=<your-smtp-port>
export SMTP_USERNAME=<your-username>
export SMTP_PASSWORD=<your-password>
Firefox Accounts
To use Firefox Accounts, you'll need to create an FxA Oauth Client
and then set some OAUTH
config values.
You can set and source these via the .env
file, or set them directly:
OAUTH_CLIENT_ID=<your-fxa-oauth-client-id>
OAUTH_CLIENT_SECRET=<your-fxa-oauth-client-secret>
OAUTH_AUTHORIZATION_URI="https://oauth-stable.dev.lcip.org/v1/authorization"
OAUTH_PROFILE_URI="https://stable.dev.lcip.org/profile/v1/profile"
OAUTH_TOKEN_URI="https://oauth-stable.dev.lcip.org/v1/token"
Breach Hashsets
This requires an enterprise subscriber API token from HIBP, which you will have
to get manually. Please ask a project admin if you need one. To download HIBP
breach hashsets, set a HIBP_API_TOKEN
environment variable. You can set and
source it via the .env
file, or set it directly:
export HIBP_API_TOKEN="<HIBP-API-TOKEN>"
With the HIBP_API_TOKEN
set, run the get-hashsets.js
script:
npm run scripts/get-hashsets.js
This will download the .zip
files into breach_hashsets/
directory.
Testing
Lint
After installing the dependencies, you can lint the code by calling:
npm run lint
Deployment
blurts is designed with 12-factor methodology.
Deploy on Heroku
You will need to set required environment variables on Heroku.
heroku config:set COOKIE_SECRET=unsafe-cookie-secret-for-heroku
heroku config:set DEBUG_DUMMY_SMTP=1