Express.js

Tested Versions

Assumptions

This example makes the following assumptions:

Application Root URL: https://express.{{< sitevar name="domain" nojs="example.com" >}}/
Authelia Root URL: https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/
Client ID: expressjs-example
Client Secret: insecure_secret

Some of the values presented in this guide can automatically be replaced with documentation variables.

Configuration

{{< callout context="tip" title="Did you know?" icon="outline/rocket" >}} This is a developer guide which can be used to create your open application. It's worth noting that some applications may also use the associated libraries so the configurations may be adaptable to those applications. {{< /callout >}}

Authelia

The following YAML configuration is an example Authelia client configuration for use with Express.js which will operate with the application example:

yaml

identity_providers:
  oidc:
    ## The other portions of the mandatory OpenID Connect 1.0 configuration go here.
    ## See: https://www.authelia.com/c/oidc
    clients:
      - client_id: 'expressjs-example'
        client_name: 'Express.js App'
        client_secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng'  # The digest of 'insecure_secret'.
        public: false
        authorization_policy: 'two_factor'
        require_pkce: true
        pkce_challenge_method: 'S256'
        require_pushed_authorization_requests: true
        redirect_uris:
          - 'https://express.{{< sitevar name="domain" nojs="example.com" >}}/callback'
        scopes:
          - 'openid'
          - 'profile'
          - 'email'
          - 'groups'
        response_types:
          - 'code'
        grant_types:
          - 'authorization_code'
        access_token_signed_response_alg: 'none'
        userinfo_signed_response_alg: 'none'
        token_endpoint_auth_method: 'client_secret_basic'

Application

To configure Express.js there is one method, using the Generalized Instructions.

Generalized Instructions

Because each project is different this guide just demonstrates how this is possible.

Project Initialization

shell

mkdir authelia-example && cd authelia-example && npm init -y && npm install express express-openid-connect

Create The Application

This application example assumes you're proxying the Node service with a proxy handling TLS termination for https://express.{{< sitevar name="domain" nojs="example.com" >}}.

"use strict";

const express = require('express');
const { auth, requiresAuth } = require('express-openid-connect');
const { randomBytes } = require('crypto');

const app = express();

app.use(
  auth({
    authRequired: false,
    baseURL: `${process.env.APP_BASE_URL || 'https://express.{{< sitevar name="domain" nojs="example.com" >}}'}`,
    secret: process.env.SESSION_ENCRYPTION_SECRET || randomBytes(64).toString('hex'),
    clientID: process.env.OIDC_CLIENT_ID || 'expressjs-example',
    clientSecret: process.env.OIDC_CLIENT_SECRET || 'insecure_secret',
    clientAuthMethod: process.env.OIDC_CLIENT_AUTH_METHOD || 'client_secret_basic',
    issuerBaseURL: process.env.OIDC_ISSUER || 'https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}',
    pushedAuthorizationRequests: toBoolean(process.env.OIDC_PUSHED_AUTHORIZATION_REQUESTS, true),
    authorizationParams: {
      response_type: 'code',
      scope: process.env.OIDC_SCOPE || 'openid profile email groups',
    },
  })
);

app.get('/', requiresAuth(), (req, res) => {
  req.oidc.fetchUserInfo().then((userInfo) => {
    const data = JSON.stringify(
      {
        accessToken: req.oidc.accessToken,
        refreshToken: req.oidc.refreshToken,
        idToken: req.oidc.idToken,
        claims: {
          id_token: req.oidc.idToken,
          userinfo: userInfo,
        },
        scopes: req.oidc.scope,
      }, null, 2);

    res.send(`<html lang='en'><body><pre><code>${data}</code></pre></body></html>`);
  });
});

app.listen(3000, function () {
  console.log("Listening on port 3000")
});

function toBoolean(value, defaultValue) {
  switch (value) {
    case "true":
    case "TRUE":
    case "1":
      return true
    case "false":
    case "FALSE":
    case "0":
      return false
    default:
      return defaultValue
  }
}

Environment Variables

To configure Express.js to utilize Authelia as an OpenID Connect 1.0 Provider, use the following environment variables:

Standard