Traefik OpenID Connect Middleware

A traefik Plugin for securing the upstream service with OpenID Connect acting as a relying party.

Note

This document always represents the latest version, which may not have been released yet.
Therefore, some features may not be available currently but will be available soon. You can use the GIT-Tags to check individual versions.

Warning

This middleware is under development and only tested against ZITADEL yet. Although it should be compatible with any OIDC-compatible IDP.

💡 Getting Started

Enable the plugin in your traefik configuration.

experimental:
  plugins:
    traefik-oidc-auth:
      moduleName: "github.com/sevensolutions/traefik-oidc-auth"
      version: "v0.2.0"

Add a middleware and reference it in a route.

http:
  services:
    whoami:
      loadBalancer:
        servers:
          - url: http://whoami:80

  middlewares:
    oidc-auth:
      plugin:
        traefik-oidc-auth:
          Provider:
            Url: "https://..."
            ClientId: "<YourClientId>"
            ClientSecret: "<YourClientSecret>"
          Scopes: ["openid", "profile", "email"]
          Authorization:
            AssertClaims:
              - Name: "preferred_username"
                Values: "alice@gmail.com,bob@gmail.com"
          Headers:
            MapClaims:
              - Claim: "preferred_username"
                Header: "X-Oidc-Username"
              - Claim: "sub"
                Header: "X-Oidc-Subject"
  
  routers:
    whoami:
      entryPoints: ["web"]
      rule: "HostRegexp(`.+`)"
      service: whoami
      middlewares: ["oidc-auth"]

🛠 Configuration Options

Plugin Config Block

Name	Required	Type	Default	Description
Provider	yes	Provider	none	Identity Provider Configuration. See Provider block.
Scopes	no	string[]	["openid", "profile", "email"]	A list of scopes to request from the IDP.
CallbackUri	no	string	/oidc/callback	Defines the callback url used by the IDP. This needs to be registered in your IDP.
LoginUri	no	string	none	An optional url, which should trigger the login-flow. By default every url triggers a login-flow, if the user is not already logged in. If you set this to eg. /login, only this url will trigger a login-flow while all other requests return Unauthorized.
PostLoginRedirectUri	no	string	none	An optional static redirect url where the user should be redirected after login. By default the user will be redirected to the url which triggered the login-flow.
LogoutUri	no	string	/logout	The url which should trigger a logout-flow.
PostLogoutRedirectUri	no	string	/	The url where the user should be redirected after logout.
Authorization	no	Authorization	none	Authorization Configuration. See Authorization block.
Headers	no	Headers	none	Header Configuration. See Headers block.

Provider Block

Name	Required	Type	Default	Description
Url	no	string	none	The full URL of the Identity Provider. This is required, if UrlEnv is not used.
UrlEnv	no	string	none	The name of an environment variable, containing the full URL of the Identity Provider. This is required, if Url is not used.
ClientId	no	string	none	The client id of the application. This is required, if ClientIdEnv is not used.
ClientIdEnv	no	string	none	The name of an environment variable, containing the client id. This is required, if ClientId is not used.
ClientSecret	no	string	none	The client secret of the application. This is required, if ClientSecretEnv is not used.
ClientSecretEnv	no	string	none	The name of an environment variable, containing the client secret. This is required, if ClientSecret is not used.

Authorization Block

Name	Required	Type	Default	Description
AssertClaims	no	ClaimAssertion[]	none	ClaimAssertion Configuration. See ClaimAssertion block.

ClaimAssertion Block

Name	Required	Type	Default	Description
Name	yes	string	none	The name of the claim in the access token.
Value	no	string	none	The required value of the claim. If Value and Values are not set, only the presence of the claim will be checked.
Values	no	string[]	none	An array of allowed strings. The user is authorized if the claim matched any of these.

Headers Block

Name	Required	Type	Default	Description
MapClaims	no	ClaimHeader[]	none	A list of claims which should be mapped as headers when the request will be sent to the upstream. See ClaimHeader block.

ClaimHeader Block

Name	Required	Type	Default	Description
Claim	yes	string	none	The name of the claim
Header	yes	string	none	The name of the header which should receive the claim value.

🧪 Local Development

Create the following .env file:

PROVIDER_URL=...
CLIENT_ID=...
CLIENT_SECRET=...

The run docker compose up to run traefik locally.

Now browse to http://localhost:9080. You should be redirected to your IDP.
After you've logged in, you should be redirected back to http://localhost:9080 and see a WHOAMI page.