OpenIDConnect Sample RP

A sample OpenID Connect Relying Party ("RP") using the openid_connect gem.

YearOne instructions

To get the app running on your M1 Mac, you'll need a working installation of Ruby 2.3.3. Assuming that you already have homebrew and rbenv installed, this should be fairly easy to achieve:

CFLAGS="-Wno-error=implicit-function-declaration" RUBY_CONFIGURE_OPTS='--with-readline-dir=/usr/local/opt/readline/' arch -x86_64 rbenv install 2.3.3

Then, you'll need a working install of sqlite3:

brew install sqlite3

And, finally, you can install the bundle and get the database set up:

gem install bundler:1.17.3
bundle config build.sqlite3 --with-sqlite3-include=/opt/local/include --with-sqlite3-lib=/opt/local/lib --with-cflags="-Wno-error=implicit-function-declaration"
bundle install
rake db:create db:migrate db:seed

Start it up on an alternative port

To use the app to test changes to the platform OpenID auth flow, start up the platform (on port 3000 as usual), then start up this app on a different port. Avoid port 3001 because that's used by the platform for attaching debuggers.

rails s -p 3100

Now you can load up (localhost:3100)[http://localhost:3100]. From there you should see a button labelled "Login with YearOne dev instance". Click it to start your fabulous OpenID adventure!

Resources

For this sample:

• View source on GitHub: https://github.com/nov/openid_connect_sample_rp
• Report Issues on GitHub: https://github.com/nov/openid_connect_sample_rp/issues

For more information, see readme and wiki for openid_connect gem:

• https://github.com/nov/openid_connect

Also of interest, the corresponding sample OP:

• https://github.com/nov/openid_connect_sample

Live Example

Nov has this sample running on Heroku: https://connect-rp.herokuapp.com

To see it in action right now:

• visit Nov's Sample RP on Heroku
• enter connect-op.herokuapp.com in the form
• press "Discover"
• the RP will use the OP to authenticate

How to Run This Example on Your Machine

There are no configuration file changes needed to run the RP.

To run this in development mode:

• Download (or fork or clone) this repo
• bundle install (see "Note" section below if you get "pg"-gem-related problems)
• bundle exec rake db:create db:migrate db:seed (you have SQLite installed, right?)
• bundle exec rails server -p 3001

Point your browser at http://localhost:3001

If you download and run the sample OP server you can have this RP use that OP for authentication (use the OP's address in the "Discover" field, e.g. localhost:3000). The two servers on localhost must run on different ports.

You can also use the address of Nov's Sample OP on Heroku in the "Discover" field and your RP will use that to authenticate.

Notes

• The Gemfile includes gem 'pg' (for PostgreSQL), but you can remove it. Nov uses PostgreSQL for his Heroku deployment, but the default DB configs are all SQLite.

Centos OpenSSL Complications

Centos' default OpenSSL package does not include some Elliptic Curve algorithms for patent reasons. Unfortunately, the gem dependency json-jwt calls on one of those excluded algorithms.

If you see uninitialized constant OpenSSL::PKey::EC when you try to run the server, this is your problem. You need to rebuild OpenSSL to include those missing algorithms.

This problem is beyond the scope of this README, but this question on StackOverflow may be of help.

Copyright

Copyright (c) 2011 nov matake. See LICENSE for details.