OpenID Connect (OIDC) and OAuth2 library for browser based JavaScript applications.
### Features
- Silent Authentication
- Automatic Access Token Renewal
- [OAuth 2.0 Token Revocation](http://tools.ietf.org/html/rfc7009)
- [Session Management](https://openid.net/specs/openid-connect-session-1_0.html) (with logout functionality)
- [PKCE](https://tools.ietf.org/html/rfc7636)
- JWT payload validation
- Can be used with any OAuth 2.0 / OpenID Connect provider
- Cross tab/window login synchronization
- Dispatches single request per tab/window to prevent inconsistency
- Official TypeScript support
### Table of Contents
- [Installation](#installation)
- [Documentation](#documentation)
- [Access Token Refreshing](#automatically-renew-access-token)
- [Use Refresh Token](#use-refresh-tokens-for-access-token-renewal)
- [Login with popup](#login-with-popup)
- [Logout with popup](#logout-with-popup)
- [Third-party cookies and Session Management](#third-party-cookies-and-session-management)
- [Additional Methods](#additional-methods)
- [Examples](/examples)
## Installation
From the CDN:
```html
```
Using package managers:
```bash
npm install @plusauth/oidc-client-js
yarn add @plusauth/oidc-client-js
pnpm add @plusauth/oidc-client-js
```
## Documentation
### Initialization
Create the `OIDCClient` instance before rendering or initializing your application.
```js
import { OIDCClient } from '@plusauth/oidc-client-js';
const oidcClient = new OIDCClient({
issuer: 'YOUR_OIDC_PROVIDER',
client_id: 'YOUR_CLIENT_ID',
redirect_uri: 'YOUR_CALLBACK_PAGE_URI'
});
oidcClient.initialize().then( function(){
// client initialized
})
```
Or with create helper method:
```js
import createOIDCClient from '@plusauth/oidc-client-js';
createOIDCClient({
issuer: 'YOUR_OIDC_PROVIDER',
client_id: 'YOUR_CLIENT_ID',
redirect_uri: 'YOUR_CALLBACK_PAGE_URI'
}).then(oidcClient => {
//...
});
```
Using `createOIDCClient` does a couple of things automatically:
* It creates an instance of `OIDCClient`.
* It calls `silentLogin` to refresh the user session.
* It suppresses all errors from `silentLogin`.
### Create callback page
OpenID Connect / OAuth2 authorization flows require a redirect uri to return the authorization result back. Create a
page and register its url to your client's allowed redirect uris. In your page initialize OIDCClient and all you
need to do is call `loginCallback` method.
```js
oidcClient.loginCallback()
.then( function(localState){
// successful login
console.log('User successfully logged in')
})
.catch( function(error) {
console.error('Authorization error:', error)
})
```
### Login and get user info
Create a login button users can click.
```html
```
In the click event handler of button you created, call login method for redirecting user to provider's login page
. Make sure `redirect_uri` is registered on the provider, and you have created a callback handler as defined in [above
](#create-callback-page).
```js
document.getElementById('login').addEventListener('click', function() {
oidcClient.login({
redirect_uri: 'http://localhost:8080/'
});
});
```
### Make authenticated requests to your API
After user is successfully logged in we can use access_token retrieved from authentication response to call the API.
```html
```
On the event handler you can get access token and use it like this:
```js
document.getElementById('makeRequest').addEventListener('click', function () {
oidcClient.getAccessToken().then(accessToken =>
fetch('https://any.exampleapi.com/api', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + accessToken
}
})
)
.then(result => result.json())
.then(data => {
console.log(data);
});
});
```
### Logout
Add a logout button.
```html
```
In event handler, call equivalent method.
```js
document.getElementById('logout').addEventListener('click', function(){
oidcClient.logout();
});
```
## Automatically renew access token
Generally, access tokens have a short lifetime, so it is common to renew the access token before its expiration.
This feature is enabled by default, but you can disable it by passing `autoSilentRenew: false` to client options.
```js
new OIDCClient({
autoSilentRenew: false,
...// other options
})
```
### Use different callback page for silent renew
In silent renew the library performs the flow in a hidden iframe. When you are developing a single page application,
assuming your callback page is handled by the app itself, the iframe will load your whole application after the
oauth2 redirection.
You can prevent this overhead by creating a different page which will handle silent renew only. To accomplish this you
should pass `silent_redirect_uri` to client options which should have your silent redirect handler page uri. If you don't use
`silent_redirect_uri`, `redirect_uri` will be used instead. Don't forget to include it to your providers redirect uri whitelist.
Have a look at following snippets for an example:
```js
// auth.js
import { OIDCClient } from '@plusauth/oidc-client-js';
const oidcClient = new OIDCClient({
redirect_uri: 'https://YOUR_SITE/callback'
silent_redirect_uri: 'https://YOUR_SITE/silent-renew.html',
...//other options
});
```
```html
```
## Use Refresh Tokens for access token renewal
Configure the library by passing the setting `useRefreshTokens` to `true` on initialization:
```js
const oidcClient = new OIDCClient({
issuer: 'YOUR_OIDC_ISSUER',
client_id: 'YOUR_CLIENT-ID',
useRefreshTokens: true
});
```
Don't forget to include `offline_access` in your scope for retrieving refresh tokens. If there is not any refresh token stored locally, the library will fallback to using silent authorization request.
Most browsers block popups if they are not happened as a result of user actions. In order to display login popup you must call `loginWithPopup` in an event handler listening for a user action like button click.