0.7.1 • Published 4 years ago

@igi2k/shield v0.7.1

Weekly downloads
1
License
Apache-2.0
Repository
github
Last release
4 years ago

Shield

Authentication shield for web apps

Configuration

Configuration is read form config/config.json.

apps

Define routing or application modules.

  • routing (proxy)
    {
      "name": "Application",
      "path": "app",
      "alias": "/test/app"
      "url": "http://localhost:8080"
    }
  • application module
    {
      "name": "Application",
      "path": "app",
      "module": "app-module",
      "config": {
        "compress": true
      }
    }

hostname

Setting to limit listening interfaces.

port

Custom listening port, default is 8080.

tls

Enables https module by specifying certificate/key pair in pem format.

  • key - private key
  • cert - public certificate
  • ca - certificate issuing authority

sso

Enables third party authentication through json web tokens.

  • url - handshake server
  • cert - server certificate in pem format

plugins

Customization of internal services, when you need to pass config it has form of an array module, config (optional)

  • authentication - authentication provider
    1. BasicAuthentication (default)
    2. CertificateAuthentication
  • logging - custom logging output
    async (morgan, executeSync, config) => {}