@digitalbazaar/oauth2-client-registration-handler

Bedrock OAuth2 Dynamic Client Registration (@digitalbazaar/oauth2-client-registration-handler)

OAuth2 Dynamic Registration handler for custom authorization servers.

Background

Constraints/Limitations:

Only supporting client_credentials grant type for now.
Initial registration authentication method is bearer token.
Does not support the signed Software Statement mechanism.

Relevant specifications:

Security

TBD

Install

Node.js >= 16 is required.

To install locally (for development):

git clone https://github.com/digitalbazaar/oauth2-client-registration-handler.git
cd oauth2-client-registration-handler
npm install

Usage

This library exports a route handler to perform OAuth2 Dynamic Client Registration that can be added to an existing Bedrock or Express.js application.

import {clientRegistrationHandler} from '@digitalbazaar/oauth2-client-registration-handler';

app.post('/oauth2/register',
  clientRegistrationHandler({
    baseUrl: 'https://as.example.com',
    authentication: {
      strategy: 'bearer',
      validateInitialAccessToken: async ({token}) => {/* custom token validation logic */}
    },
    register: async ({registration, credentials: {initialAccessToken}}) => {
      // custom registration callback (saves client to database etc)
    },
    defaults: {
      clientSecretExpiresAt: 0, // never expires
      grantTypes: ['client_credentials'],
      tokenEndpointAuthMethod: 'client_secret_post'
    },
    logger: console
  }))
);