Firefox Monitor arms you with tools to keep your personal information safe. Find out what hackers already know about you and learn how to stay a step ahead of them.
Перейти к файлу
groovecoder 3c649f7ecb wip: start scan results page 2018-03-14 15:45:06 -05:00
db move saveSha1 logic 'up' into model code 2018-03-13 14:04:00 -05:00
public fix Foundation reveal modal and htmllint 2018-03-12 15:08:11 -05:00
routes wip: start scan results page 2018-03-14 15:45:06 -05:00
scripts Use sequelize for hashset script 2018-03-12 15:08:12 -05:00
tests don't need dotenv in test-user.js 2018-03-13 14:12:36 -05:00
views wip: start scan results page 2018-03-14 15:45:06 -05:00
.env-dist Use sequelize for hashset script 2018-03-12 15:08:12 -05:00
.eslintignore Use sequelize for hashset script 2018-03-12 15:08:12 -05:00
.eslintrc.js fix Foundation reveal modal and htmllint 2018-03-12 15:08:11 -05:00
.gitignore start get_hashsets.js 2018-02-12 16:17:43 -06:00
.htmllintrc Add attr-bans to .htmllintrc 2018-03-12 15:08:11 -05:00
.npmignore fix #24: add Travis and Coveralls 2018-02-09 07:37:47 -06:00
.sequelizerc Use sequelize for hashset script 2018-03-12 15:08:12 -05:00
.travis.yml Start database interface (#48) 2018-03-05 19:23:53 +05:30
README.md start code to load hashsets into aws 2018-02-20 14:37:00 -06:00
api.md Add basic info to api.md 2018-02-01 06:56:04 +05:30
app-constants.js Use sequelize for hashset script 2018-03-12 15:08:12 -05:00
db-utils.js db-utils.js: Use template string to avoid escaping newlines. 2018-03-09 04:37:28 +05:30
email-utils.js Enforce comma-dangle eslint rule correctly, fix indent in comment 2018-02-13 17:32:51 +05:30
package-lock.json Use sequelize for hashset script 2018-03-12 15:08:12 -05:00
package.json wip: start scan results page 2018-03-14 15:45:06 -05:00
server.js wip: start scan results page 2018-03-14 15:45:06 -05:00

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

Install

  1. Clone and change to the directory:

    git clone https://github.com/mozilla/blurts-server.git
    cd blurts-server
    
  2. Install dependencies:

    npm install
    
  3. Copy the .env-dist file to .env:

    cp .env-dist .env
    

Run

  1. Run the server:

    npm start
    
  2. 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