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.
Перейти к файлу
Luke Crouch 9ec4279de8 remove unused dompurify and jsdom dependencies 2019-10-23 16:00:16 -05:00
.circleci remove linting from circle; handled by travis 2018-08-30 15:34:02 -05:00
__mocks__ fix #1064: mock sns-validator during tests 2019-07-11 10:26:46 -05:00
controllers enforce query and session state values 2019-10-16 08:42:07 -05:00
db fix db migration for knext 0.19.5 2019-10-23 15:52:15 -05:00
docs add @mozilla/svcops to review db migrations 2019-07-17 15:02:13 -05:00
lib restore check for body.scope.includes monitor 2019-09-06 11:52:08 -05:00
loadtests change loadtests to locust 2018-08-28 15:29:32 -05:00
locales Pontoon: Update Turkish (tr) localization of Firefox Monitor Website 2019-10-19 22:13:13 +00:00
public Transparent button padding tweak 2019-10-21 10:30:58 -05:00
routes Add bento button to header. 2019-09-26 12:00:16 -05:00
scripts only select columns needed; separate script for subscribing 2019-09-19 15:16:17 -05:00
template-helpers Review updates 2019-10-01 12:55:35 -05:00
tests enforce query and session state values 2019-10-16 08:42:07 -05:00
views Gigantic UI Facelift 2019-10-21 08:43:44 -05:00
.dockerignore Removes version.json from the .dockerignore file. 2018-06-08 16:21:54 -04:00
.env-dist fix 1135: default SENTRY_DSN to blank 2019-10-10 11:03:00 -05:00
.eslintignore Credit sources and eslintignore polyfills 2018-09-24 22:12:42 -05:00
.eslintrc.js for #55: review fixes 2018-09-21 14:32:22 -05:00
.gitignore for #254: convert testing scripts to jest 2018-08-17 14:11:02 -05:00
.htmllintrc Add attr-bans to .htmllintrc 2018-03-08 11:22:13 -06:00
.npmignore fix #24: add Travis and Coveralls 2018-02-09 07:37:47 -06:00
.stylelintrc Ignore "selector-type-no-unknown" rule. 2019-09-27 15:31:13 -05:00
.travis.yml Merge pull request #895 from pdehaan/issue-888 2019-05-10 20:55:43 -05:00
CODE_OF_CONDUCT.md Add Mozilla Code of Conduct file 2019-03-30 00:10:15 -07:00
Dockerfile fix #547: fix locale args to hbs helpers 2018-10-22 15:39:18 -05:00
LICENSE Add LICENSE file and update package.json license 2018-06-07 14:49:16 -07:00
README.md Update README to include information on creating a test database 2019-07-11 09:04:31 -05:00
app-constants.js change updatebreaches.js from Bearer to Basic auth 2019-04-24 22:08:18 -05:00
basket.js for #669: check db array and catch basket error 2019-01-02 11:16:21 -06:00
email-utils.js Fix utm_source in email CTAs 2019-10-01 12:54:49 -05:00
hibp.js Add/update user dashboards. 2019-05-06 18:16:35 -05:00
l10n.toml Update l10n linter to moz-l10n-lint 2019-05-09 15:20:06 -07:00
locale-utils.js fix #562: use SUPPORTED_LOCALES to config locales 2018-10-29 16:28:19 -05:00
log.js for #55: MOZLOG_FMT for formatting 2018-09-21 13:41:29 -05:00
middleware.js Update "error" fluent ID and affected code. 2018-12-03 22:55:54 -05:00
package-lock.json remove unused dompurify and jsdom dependencies 2019-10-23 16:00:16 -05:00
package.json remove unused dompurify and jsdom dependencies 2019-10-23 16:00:16 -05:00
scan-results.js fix #1084 fix #1146 - only put ids and emails into user object 2019-07-29 11:59:14 -05:00
server.js update helmet and restore browser sniffing 2019-09-23 09:43:38 -05:00
sha1-utils.js Fix a bunch of ESLint errors 2018-04-18 16:39:05 +02:00

README.md

Firefox Monitor Server

Summary

Firefox Monitor notifies users when their credentials have been compromised in a data breach.

This code is for the monitor.firefox.com service & website.

Breach data is powered by haveibeenpwned.com.

See the Have I Been Pwned about page for the "what" and "why" of data breach alerts.

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
    

Note: npm start uses onchange and nodemon to automatically detect file changes, re-compile static assets, and restart the express process. If you want more control, see the scripts section of package.json for more commands.

  1. Navigate to localhost:6060/

Database

To create the database tables ...

  1. Create the blurts database:

    createdb blurts
    createdb test-blurts # for tests
    
  2. Update the DATABASE_URL value in your .env file with your local db credentials:

    DATABASE_URL="postgres://<username>@localhost:<port>/blurts"
    
  3. Run the migrations:

    npm run db:migrate
    

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

Subscribe with a Firefox Account is controlled via the FXA_ENABLED environment variable. (See .env-dist)

The repo comes with a development FxA oauth app pre-configured in .env, which should work fine running the app on http://localhost:6060

To use a different Firefox Accounts oauth relying party, 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:

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"

Testing

The full test suite can be run via npm test.

Individual tests

To run individual tests, use NODE_ENV=tests and jest:

NODE_ENV=tests jest --runInBand tests/home.test.js

To run tests with interactive debugger lines enabled:

NODE_ENV=tests node inspect --harmony ./node_modules/.bin/jest tests/home.test.js

Lint

After installing the dependencies, you can lint the code by calling:

npm run lint

Deployment

Firefox Monitor Breach Alerts is designed with 12-factor methodology.

Deploy on Heroku

You will need to set some required environment variables on Heroku.

heroku config:set COOKIE_SECRET=unsafe-cookie-secret-for-heroku
heroku config:set DEBUG_DUMMY_SMTP=1

And any others, depending on the features you're running on Heroku - e.g., Email or Firefox Accounts.