openid-client

OpenID Certified Relying Party (OpenID Connect/OAuth 2.0 Client) implementa...

Authentication / Authorization
panva/node-openid-clientopenid-client

README

openid-client


openid-client is a server side [OpenID][openid-connect] Relying Party (RP, Client) implementation for
Node.js runtime, supports [passport][passport-url].

Implemented specs & features


The following client/RP features from OpenID Connect/OAuth2.0 specifications are implemented by
openid-client.

- [OpenID Connect Core 1.0][feature-core]
  - Authorization Callback
    - Authorization Code Flow
    - Implicit Flow
    - Hybrid Flow
  - UserInfo Request
  - Offline Access / Refresh Token Grant
  - Client Credentials Grant
  - Client Authentication
    - none
    - client_secret_basic
    - client_secret_post
    - client_secret_jwt
    - private_key_jwt
  - Consuming Self-Issued OpenID Provider ID Token response
- [OpenID Connect Discovery 1.0][feature-discovery]
  - Discovery of OpenID Provider (Issuer) Metadata
  - Discovery of OpenID Provider (Issuer) Metadata via user provided inputs (via [webfinger][documentation-webfinger])
- [OpenID Connect Dynamic Client Registration 1.0][feature-registration]
  - Dynamic Client Registration request
  - Client initialization via registration client uri
- [RFC7009 - OAuth 2.0 Token revocation][feature-revocation]
  - Client Authenticated request to token revocation
- [RFC7662 - OAuth 2.0 Token introspection][feature-introspection]
  - Client Authenticated request to token introspection
- [RFC8628 - OAuth 2.0 Device Authorization Grant (Device Flow)][feature-device-flow]
- [RFC8705 - OAuth 2.0 Mutual TLS Client Authentication and Certificate-Bound Access Tokens][feature-mtls]
  - Mutual TLS Client Certificate-Bound Access Tokens
  - Metadata for Mutual TLS Endpoint Aliases
  - Client Authentication
    - tls_client_auth
    - self_signed_tls_client_auth
- [RFC9101 - OAuth 2.0 JWT-Secured Authorization Request (JAR)][feature-jar]
- [RFC9126 - OAuth 2.0 Pushed Authorization Requests (PAR)][feature-par]
- [OpenID Connect RP-Initiated Logout 1.0][feature-rp-logout]
- [Financial-grade API Security Profile 1.0 - Part 2: Advanced (FAPI)][feature-fapi]
- [JWT Secured Authorization Response Mode for OAuth 2.0 (JARM)][feature-jarm]
- [OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP) - draft 04][feature-dpop]
- [OAuth 2.0 Authorization Server Issuer Identification][feature-iss]

Updates to draft specifications are released as MINOR library versions,
if you utilize these specification implementations consider using the tilde ~ operator in your
package.json since breaking changes may be introduced as part of these version updates.

Certification

[OpenID Certification][openid-certified-link]
Filip Skokan has [certified][openid-certified-link] that [openid-client][npm-url]
conforms to the following profiles of the OpenID Connect™ protocol

- Basic, Implicit, Hybrid, Config, Dynamic, and Form Post RP
- FAPI 1.0 Advanced RP

Sponsor


[auth0-logo][sponsor-auth0] If you want to quickly add OpenID Connect authentication to Node.js apps, feel free to check out Auth0's Node.js SDK and free plan. [Create an Auth0 account; it's free!][sponsor-auth0]


Support


If you or your business use openid-client, please consider becoming a [sponsor][support-sponsor] so I can continue maintaining it and adding new features carefree.


Documentation


The library exposes what are essentially steps necessary to be done by a relying party consuming
OpenID Connect Authorization Server responses or wrappers around requests to its endpoints. Aside
from a generic OpenID Connect [passport][passport-url] strategy it does not expose any framework
specific middlewares. Those can however be built using the exposed API, one such example is [express-openid-connect][]

- [openid-client API Documentation][documentation]
  - [Issuer][documentation-issuer]
  - [Client][documentation-client]
  - [Customizing][documentation-customizing]
  - [TokenSet][documentation-tokenset]
  - [Strategy][documentation-strategy]
  - [generators][documentation-generators]
  - [errors][documentation-errors]

Install


Node.js LTS releases Codename Erbium and newer LTS releases are supported.

  1. ```console
  2. npm install openid-client
  3. ```

Quick start


Discover an Issuer configuration using its published .well-known endpoints
  1. ``` js
  2. import { Issuer } from 'openid-client';

  4. const googleIssuer = await Issuer.discover('https://accounts.google.com');
  5. console.log('Discovered issuer %s %O', googleIssuer.issuer, googleIssuer.metadata);
  6. ```

Authorization Code Flow


Authorization Code flow is for obtaining Access Tokens (and optionally Refresh Tokens) to use with
third party APIs securely as well as Refresh Tokens. In this quick start your application also uses
PKCE instead of state parameter for CSRF protection.

Create a Client instance for that issuer's authorization server intended for Authorization Code
flow.

See the [documentation][] for full API details.

  1. ``` js
  2. const client = new googleIssuer.Client({
  3.   client_id: 'zELcpfANLqY7Oqas',
  4.   client_secret: 'TQV5U29k1gHibH5bx1layBo0OSAvAbRT3UYW3EWrSYBB5swxjVfWUa1BS8lqzxG/0v9wruMcrGadany3',
  5.   redirect_uris: ['http://localhost:3000/cb'],
  6.   response_types: ['code'],
  7.   // id_token_signed_response_alg (default "RS256")
  8.   // token_endpoint_auth_method (default "client_secret_basic")
  9. }); // => Client
  10. ```

When you want to have your end-users authorize you need to send them to the issuer's
authorization_endpoint. Consult the web framework of your choice on how to redirect but here's how
to get the authorization endpoint's URL with parameters already encoded in the query to redirect
to.

  1. ``` js
  2. import { generators } from 'openid-client';
  3. const code_verifier = generators.codeVerifier();
  4. // store the code_verifier in your framework's session mechanism, if it is a cookie based solution
  5. // it should be httpOnly (not readable by javascript) and encrypted.

  7. const code_challenge = generators.codeChallenge(code_verifier);

  9. client.authorizationUrl({
  10.   scope: 'openid email profile',
  11.   resource: 'https://my.api.example.com/resource/32178',
  12.   code_challenge,
  13.   code_challenge_method: 'S256',
  14. });
  15. ```

When end-users are redirected back to your redirect_uri your application consumes the callback and
passes in the code_verifier to include it in the authorization code grant token exchange.
  1. ``` js
  2. const params = client.callbackParams(req);
  3. const tokenSet = await client.callback('https://client.example.com/callback', params, { code_verifier });
  4. console.log('received and validated tokens %j', tokenSet);
  5. console.log('validated ID Token claims %j', tokenSet.claims());
  6. ```

You can then call the userinfo_endpoint.
  1. ``` js
  2. const userinfo = await client.userinfo(access_token);
  3. console.log('userinfo %j', userinfo);
  4. ```

And later refresh the tokenSet if it had a refresh_token.
  1. ``` js
  2. const tokenSet = await client.refresh(refresh_token);
  3. console.log('refreshed and validated tokens %j', tokenSet);
  4. console.log('refreshed ID Token claims %j', tokenSet.claims());
  5. ```

Implicit ID Token Flow


Implicit response_type=id_token flow is perfect for simply authenticating your end-users, assuming
the only job you want done is authenticating the user and then relying on your own session mechanism
with no need for accessing any third party APIs with an Access Token from the Authorization Server.

Create a Client instance for that issuer's authorization server intended for ID Token implicit flow.

See the [documentation][] for full API details.
  1. ``` js
  2. const client = new googleIssuer.Client({
  3.   client_id: 'zELcpfANLqY7Oqas',
  4.   redirect_uris: ['http://localhost:3000/cb'],
  5.   response_types: ['id_token'],
  6.   // id_token_signed_response_alg (default "RS256")
  7. }); // => Client
  8. ```

When you want to have your end-users authorize you need to send them to the issuer's
authorization_endpoint. Consult the web framework of your choice on how to redirect but here's how
to get the authorization endpoint's URL with parameters already encoded in the query to redirect
to.

  1. ``` js
  2. import { generators } from 'openid-client';
  3. const nonce = generators.nonce();
  4. // store the nonce in your framework's session mechanism, if it is a cookie based solution
  5. // it should be httpOnly (not readable by javascript) and encrypted.

  7. client.authorizationUrl({
  8.   scope: 'openid email profile',
  9.   response_mode: 'form_post',
  10.   nonce,
  11. });
  12. ```

When end-users hit back your redirect_uri with a POST (authorization request included form_post
response mode) your application consumes the callback and passes the nonce in to include it in the
ID Token verification steps.
  1. ``` js
  2. // assumes req.body is populated from your web framework's body parser
  3. const params = client.callbackParams(req);
  4. const tokenSet = await client.callback('https://client.example.com/callback', params, { nonce });
  5. console.log('received and validated tokens %j', tokenSet);
  6. console.log('validated ID Token claims %j', tokenSet.claims());
  7. ```

Device Authorization Grant (Device Flow)


RFC8628 - OAuth 2.0 Device Authorization Grant (Device Flow)
is started by starting a Device Authorization Request.

  1. ``` js
  2. const handle = await client.deviceAuthorization();
  3. console.log('User Code: ', handle.user_code);
  4. console.log('Verification URI: ', handle.verification_uri);
  5. console.log('Verification URI (complete): ', handle.verification_uri_complete);
  6. ```

The handle represents a Device Authorization Response with the verification_uri, user_code and
other defined response properties.

You will display the instructions to the end-user and have him directed at verification_uri or
verification_uri_complete, afterwards you can start polling for the Device Access Token Response.
  1. ``` js
  2. const tokenSet = await handle.poll();
  3. console.log('received tokens %j', tokenSet);
  4. ```

This will poll in the defined interval and only resolve with a TokenSet once one is received. This
will handle the defined authorization_pending and slow_down "soft" errors and continue polling
but upon any other error it will reject. With tokenSet received you can throw away the handle.

FAQ


Semver?


Yes. Everything that's either exported in the TypeScript definitions file or
[documented][documentation] is subject to
Semantic Versioning 2.0.0. The rest is to be considered
private API and is subject to change between any versions.

How do I use it outside of Node.js


It is only built for Node.js environments - including openid-client in
browser-environment targeted projects is not supported.

How to make the client send client_id and client_secret in the body?


See [Client Authentication Methods (docs)][documentation-methods].

Can I adjust the HTTP timeout?


See [Customizing (docs)][documentation-customizing].


[openid-connect]: https://openid.net/connect/
[feature-core]: https://openid.net/specs/openid-connect-core-1_0.html
[feature-discovery]: https://openid.net/specs/openid-connect-discovery-1_0.html
[feature-registration]: https://openid.net/specs/openid-connect-registration-1_0.html
[feature-revocation]: https://tools.ietf.org/html/rfc7009
[feature-introspection]: https://tools.ietf.org/html/rfc7662
[feature-mtls]: https://tools.ietf.org/html/rfc8705
[feature-device-flow]: https://tools.ietf.org/html/rfc8628
[feature-rp-logout]: https://openid.net/specs/openid-connect-rpinitiated-1_0.html
[feature-jarm]: https://openid.net/specs/oauth-v2-jarm.html
[feature-fapi]: https://openid.net/specs/openid-financial-api-part-2-1_0.html
[feature-dpop]: https://tools.ietf.org/html/draft-ietf-oauth-dpop-04
[feature-par]: https://www.rfc-editor.org/rfc/rfc9126.html
[feature-jar]: https://www.rfc-editor.org/rfc/rfc9101.html
[feature-iss]: https://www.rfc-editor.org/rfc/rfc9207.html
[openid-certified-link]: https://openid.net/certification/
[passport-url]: http://passportjs.org
[npm-url]: https://www.npmjs.com/package/openid-client
[sponsor-auth0]: https://a0.to/try-auth0
[support-sponsor]: https://github.com/sponsors/panva
[documentation]: https://github.com/panva/node-openid-client/blob/master/docs/README.md
[documentation-issuer]: https://github.com/panva/node-openid-client/blob/master/docs/README.md#issuer
[documentation-client]: https://github.com/panva/node-openid-client/blob/master/docs/README.md#client
[documentation-customizing]: https://github.com/panva/node-openid-client/blob/master/docs/README.md#customizing
[documentation-tokenset]: https://github.com/panva/node-openid-client/blob/master/docs/README.md#tokenset
[documentation-strategy]: https://github.com/panva/node-openid-client/blob/master/docs/README.md#strategy
[documentation-errors]: https://github.com/panva/node-openid-client/blob/master/docs/README.md#errors
[documentation-generators]: https://github.com/panva/node-openid-client/blob/master/docs/README.md#generators
[documentation-methods]: https://github.com/panva/node-openid-client/blob/master/docs/README.md#client-authentication-methods
[documentation-webfinger]: https://github.com/panva/node-openid-client/blob/master/docs/README.md#issuerwebfingerinput
[express-openid-connect]: https://www.npmjs.com/package/express-openid-connect