This repository contains several distinct things related to BrowserID:
- the browserid server - a node.js server which implements a web services api, stores a record of users, the email addresses they've verified, a bcrypted password, outstanding verification tokens, etc
- the verifier - a stateless node.js server which does cryptographic verification of assertions. This thing is hosted on browserid.org as a convenience, but people using browserid can choose to host their own version if they wish to.
- sample and test code - to test the above
node.js (>= 0.6.2): http://nodejs.org
npm: http://npmjs.org/ (or bundled with node in 0.6.3+)
sudo apt-get install python-software-properties
sudo apt-add-repository ppa:chris-lea/node.js
sudo apt-get update
sudo apt-get install nodejs npm git-core libgmp3-dev g++
Set the git configuration
git config --global user.name "Your Username"
git config --global user.email "Your Email"
(optional steps if you want to cache your credentials)
git config --global credential.helper cache
git config --global credential.helper 'cache --timeout=3600'
Generate an ssh rsa key
Login to github
- Click your user name
- Click "Edit Your Profile"
- Click "SSH Keys" (on the left) and click "Add SSH key"
- Name the SSH key, copy file contents of the
$HOME/.ssh/id_rsa.pubfile, and click "Save"
- Go to https://github.com/mozilla/browserid and click Fork.
Clone browserid to your local repository
git clone firstname.lastname@example.org:YOURUSERNAME/browserid.git
npm install to install 3rd party libraries and generate keys
npm start to start the servers locally
Visit the demo application ('rp') in your web browser (url output on the console at runtime)
You can stop the servers with a Cntl-C in the terminal.
rm -Rf var node_modules
Unit tests can be run by invoking
npm test at the top level. At present,
there are three classes of unit tests to be run:
- Backend unit tests against a custom, zero-dependency JSON database
- Backend unit tests against MySQL, what we use in production
- Frontend unit tests run headlessly against PhantomJS
You can control which tests are run using the
WHAT_TESTS env var, see
scripts/test for details.
Integration tests are done with Travis-CI. It is recommended that you setup Travis-CI for your BrowserID fork so that tests are automatically run when you push changes. This will give the BrowserID team confidence that your changes both function correctly and do not cause regressions in other parts of the code. Configuration files are already included in the repo but some setup is necessary.
- Sign in to GitHub
- Open Travis-CI
- Click "Sign in with GitHub" if you are not signed in. If you are signed in, click on your username then "Profile" and go to step 5.
- Click "Allow" if this is your first time signing in.
- Find "browserid" in "Your Repositories"
- Move the switch from "OFF" to "ON"
- Open your fork of BrowserID on GitHub
- Click the "Admin" button
- Click "Service Hooks"
- Ensure that "Travis" has a green radio button
- Push to your fork and return to Travis-CI. Watch the tests run.
branching & release model - You'll notice some funky branching conventions, like the default branch is named
dev rather than
master as you might expect. We're using gitflow: the approach is described in a blog post.
contributions - please issue pull requests targeted at the
All source code here is available under the MPL 2.0 license, unless otherwise indicated.