rafrombrc / picl-idp

An Identity Provider for Profile In the CLoud

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

picl-idp

An Identity Provider for Profile In the CLoud

API documentation

API design document

Install

You'll need node 0.10.x or higher and npm to run the server.

Clone the git repository and install dependencies:

git clone git://github.com/mozilla/picl-idp.git
cd picl-idp
npm install
node ./scripts/gen_keys.js

To start the server, run:

npm start

It doesn't do much of anything, yet.

Testing

Run tests with:

npm test

Reference Client

A node library that implements the client side of the protocol and an example script is located in the /client directory.

/client/index.js /client/example.js

Dev Deployment

There is a development server running the moz-svc-dev AWS environment, at the following address:

http://idp.dev.lcip.org/

It is managed using awsbox, and currently needs manual updating. To push the latest changes, do:

$> git remote add idp-dev-lcip-org app@idp.dev.lcip.org:git
$> git push idp-dev-lcip-org HEAD:master

You can stand up a similar single-server testing deployment using awsbox, which we have wrapped in a simple helper script at /scripts/awsbox/deploy.js. Invoke it like so:

$> ./scripts/awsbox/deploy.js create -n <unique-name>
$> git push <unique-name> HEAD:master

To let the deployment send emails through Amazon SES, you will need to obtain the file 'awsbox-secrets.json' containing the necessary credentials. Contact one of the developers for more details.

SES in the development environment is in sandbox mode, so the server is only allowed to send emails to a restricted whitelist of addresses. You have two options for testing the email flow:

  • Use a restmail address of the form @restmail.lcip.org. Emails sent to such an address can then be viewed online at http://restmail.lcip.org/mail/.
  • Individually verify your email address with SES, via the AWS management console.

License

MPL 2.0

About

An Identity Provider for Profile In the CLoud

License:Other


Languages

Language:JavaScript 96.5%Language:Shell 2.2%Language:Lua 1.3%