mozilla/eyedee.me

An sampe web based email provider that provides first class BrowserID support.

EyeDee.Me

EyeDee.Me is an example Indentity Provider for the BrowserID protocol. This protocol is used by Mozilla Persona to authenticate users across the web.

EyeDee.Me styles itself like an email provider, but does not actually handle any email. Rather, it exists solely as an example for how services, such as email providers, can provide first-class support for BrowserID.

Setup

EyeDee.Me requires Node.js, npm, a MySQL database, and a webserver acting as a reverse proxy / SSL terminator. Once those are in place:

1. Clone this repository.

2. Execute npm install in the root of your clone to get all of the necessary Node libraries.

3. Generate a signing keypair by launching node and running:

   jwk = require("jwcrypto/jwk");
   keypair = jwk.KeyPair.generate('RS', 128);
   console.log(keypair.publicKey.serialize());
   console.log(keypair.secretKey.serialize());
   

4. Store the keys somewhere safe.

5. Create a MySQL user and database:

   $ mysql -uroot -p
   > CREATE USER 'eyedeeme'@'localhost';
   > CREATE DATABASE eyedeeme;
   > GRANT ALL ON eyedeeme.* TO 'eyedeeme'@'localhost';
   > FLUSH PRIVILEGES;
   

Running

You must set four environment variables before EyeDee.Me will function:

1. PUBLIC_KEY: The public key, as printed by the script above. Default: Ephemeral key, generated at runtime.

2. PRIVATE_KEY: The secret key, as printed by the script above. Default: Ephemeral key, generated at runtime.

3. MYSQL_URL: A connection string for your MySQL database, in the form mysql://user:pass@host:port/dbname. Default: mysql://[email protected]:3306/eyedeeme

4. PORT: A port for EyeDee.Me to listen on. Default: random.

Once those are available, you can run EyeDee.me with ./bin/eyedeeme or npm start.

Because the BrowserID protocol requires SSL on connections to Identity Providers, you must also configure a reverse proxy or SSL teminator to accept HTTPS connections and forward them to a running EyeDee.Me instance, such as the one on the port defined above. Otherwise, your users will not be forwarded to your Identity Provider for authentication when logging in to sites with Persona.

eyedee.me's Issues

Deploy firefoxos commits

Help... can you (@lloyd, @shane-tomlinson, and @fmarier ) deploy master which has firefoxos commits?

Looking at /ver.txt, we aren't sure what is live and how it got deployed.

thanks!

two inputs with id password

on page https://eyedee.me/browserid/sign_in.html?email=klrmn%2B4%40eyedee.me

using firepath to evaluate for #password, it comes up with two inputs.

add autofocus to appropriate form fields for keyboard accessibility.

add information to README

I (and very likely others) would really appreciate crucial information here, including installation steps =)

Thanks!

sqlite3 as alternative to mysql

I would like to run it just for myself for testing, i use postgresql on my server and for such small apps usually just go with sqlite3

Add a quick/simple way to change a password and delete and email

Both will make testing of primaries a bit easier.

Link to user's inbox after logging in.

EyeDee.me mail ends up in mailboxes at Mailinator. Awesome! Let's make it easy to get there.

Local copies of browserid JS is confusing

When I went to create a primary, I saw that eyedee.me has some of BrowserID's js hosted locally.

I was confused.

I don't think we want other primaries to do that... do we?

• https://browserid.org/authentication_api.js
• https://eyedee.me/js/authentication_api.js

CC @davidillsley

please put id or class on submit button(s)

on page https://eyedee.me/browserid/sign_in.html?email=klrmn%2B1%40eyedee.me

<button type="submit">Create My Account</button>

on home page after having pressed 'sign in' link

<button>Sign In</button>

package.json points at a nonexistent tarball

npm install fails with a 404 on this entry in package.json:

    "client-sessions": "https://github.com/benadida/node-client-sessions/tarball/92fff32",

That repository of @benadida no longer exists on GitHub, or is private. I imagine that line should change to a released package version of mozilla/node-client-sessions.

Doesn't work with voo.st

I created an account on eyedee.me. I could not use this on voo.st or personashiro.appspot.com -- just kept going back to the login prompt.

Update language / branding (nix "BrowserID" and "Primary")

The https://eyedee.me/ homepage still refers to "BrowserID" and "Primaries" -- we should change that.

Custom MYSQL_URL parsed incorrectly

Eyedee.me parses the MYSQL_URL environment variable with:

var u = url.parse(process.env['MYSQL_URL']);
db_host = u.host;
db_port = u.port || db_port;

This fails, because u.host includes the port, which is redundant. The hostName property does not include the port, and should be used instead.

Point eyedee.me's MX records at Mailinator

Right now:

$ dig +short mx eyedee.me

Lame! Mail is just gonna' bounce!

Soon?

$ dig +short mx eyedee.me
10 mail.mailinator.com.

Awesome! I could check my eyedee.me mail over at Mailinator!

Custom MySQL_URL fails

MYSQL_URL='mysql://[email protected]:3306/eyedeeme' ./bin/eyedeeme

fails with

ReferenceError: url is not defined
    at Object.<anonymous> (eyedee.me/lib/db.js:13:11)

Doesn't work if Referer is blocked

Steps to reproduce:

1. Block the Referer header in requests to eyedee.me from other sites, e.g. using RefControl.
2. For simplicity, remove cookies, log out of eyedee.me and reload https://beta.myfavoriteshow.org/
3. Go to https://beta.myfavoriteshow.org/ and try to verify your id.

The popup window will appear, saying something like "Please wait while we are talking to the server…". Nothing will happen after that.