express-gateway-plugin-authorizing

Plugin Authorizing for Express Gateway

Usage no npm install needed!

<script type="module">
  import expressGatewayPluginAuthorizing from 'https://cdn.skypack.dev/express-gateway-plugin-authorizing';
</script>

README

express-gateway-plugin-authorizing

This is plugin for Express Gateway The main purpose for authenticate with auth service that impl OpenId Connect standard This plugin useful for integrating with old login merchanism

Getting Started in 5 minutes:

$ yarn add express-gateway-plugin-authorizing

Configure this plugin:

  1. [Fronted-end] Condition for invoking request: Add Extra Header Key-Value: Auth-Type = "SSO"
  2. Declare plugins.express-gateway-plugin-authorizing in system.config.yml
  3. [Config-Gateway] Add config SSO_ENDPOINT, USER_INFO_SERVICE or SSO_INTROSPECT_ENDPOINT to action params
  4. [How-it-work] Request will pass to introspect/userinfo endpoint and caching ttl and decide to pass-through or denied request.
  5. Re-test

Detailed documentation:

Express Gateway Overview

Express Gateway plugin explanation: Plugin Documentation

CLI for installing and configuring plugin: Plugins CLI

Guidlines how to write your custom plugin: Plugin Development Guide

Express Gateway Boot Sequence explains order in which plugin entities are loaded and executed.