Why?

This plugin adapts oidc-client-js to the Aurelia router. While it is possible to use the oidc-client-js on its own, you will find yourself writing a fair amount of code to handling the routing within Aurelia.

Alpha

If the most recent aurelia-open-id-connect release does not work, try an earlier or later one such as 0.11.2.

Usage

Install the package

We recommend NPM instead of JSPM.

npm install --save shaunluttin/aurelia-open-id-connect#0.11.2

jspm install github:shaunluttin/aurelia-open-id-connect@0.11.2

Add it to Aurelia

We recommend the Aurelia CLI.

Add the following dependencies to aurelia.json.

{
  "name": "aurelia-open-id-connect",
  "path": "../node_modules/aurelia-open-id-connect/dist/amd",
  "main": "index"
},
"oidc-client"

Also: set build.loader.plugins.stub = false to load the plugin's HTML.

Configure the OpenID Connect client

We recommend TypeScript.

Create a src/open-id-connect-configuration.ts file. There is an example in the demo project.

In your src/main.ts, import the configuration file, add the plugin, and invoke the callback, passing it the imported configuration.

import oidcConfig from "./open-id-connect-configuration";

...

aurelia.use
    .plugin("aurelia-open-id-connect", (callback) => callback(oidcConfig));

Demo Project

The demo has an example of how to configure everything.

See it LIVE here: https://zamboni-app.azurewebsites.net

Or, clone and run it locally:

git clone https://github.com/shaunluttin/aurelia-open-id-connect.git
cd aurelia-open-id-connect/demo
git checkout 0.11.2
npm install -y
npm run demo

Note: a complete demo requires the following running locally:

an OpenId Connect authorization server at http://localhost:5000
a Resource Server at http://localhost:5001
another Resource Server at http://localhost:5002

Find examples of those here:

git clone https://github.com/openiddict/openiddict-samples.git
cd openiddict-samples/samples/ImplicitFlow

Publish

npm run package

Implicit Flow Implementor Guide

The OpenID Connect Implicit Client Implementer's Guide 1.0 contains a subset of the OpenID Connect Core 1.0 specification.

It is designed to be easy to read and implement for basic Web-based Relying Parties using the OAuth 2.0 Implicit Flow.

mttmccb / aurelia-open-id-connect