Middleware Configuration

Plugin Config Block

caution

It is highly recommended to change the default encryption-secret by providing your own 32-character secret using the Secret-option. You can generate a random one here: https://it-tools.tech/token-generator?length=32

tip

Every property marked with a * also supports environment variables when enclosed with ${}. Eg.:

Provider:
  Url: "${MY_PROVIDER_URL}"
  ClientSecret: "${MY_CLIENT_SECRET}"

If a variable is not defined, the provided value is used as-is.
Please note that you can only use a single environment variable using this syntax and it does not allow templating. So something like this wouldn't work: https://auth.${MY_DOMAIN}/auth/${CLIENT_ID}.
But: If you're using YAML-files for configuration you can use traefik's templating.

Name	Required	Type	Default	Description
LogLevel*	no	string	WARN	Defines the logging level of the plugin. Can be one of DEBUG, INFO, WARN, ERROR.
Secret*	no	string	MLFs4TT99kOOq8h3UAVRtYoCTDYXiRcZ	A secret used for encryption. Must be a 32 character string. It is strongly suggested to change this.
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. This may be either a relative URL or an absolute URL -- see also Callback URLs
LoginUri*	no	string	none	An optional url, which should trigger the login-flow. The response of every other url is defined by the UnauthorizedBehavior-configuration.
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.
ValidPostLoginRedirectUris	no	string[]	none	A list of valid redirect uris when provided by the redirect_uri query parameter on the login-endpoint. The uri has to match exactly. Optionally you can use a * to match any character of a-z, A-Z, 0-9, -, _. You can also specify a single * which is a full wildcard but this is not recommended.
LogoutUri*	no	string	/logout	The url which should trigger the logout-flow. See here for more details.
PostLogoutRedirectUri*	no	string	/	The url where the user should be redirected after logout.
ValidPostLogoutRedirectUris	no	string[]	none	A list of valid redirect uris when provided by the redirect_uri query parameter on the logout-endpoint. The uri has to match exactly. Optionally you can use a * to match any character of a-z, A-Z, 0-9, -, _. You can also specify a single * which is a full wildcard but this is not recommended.
CookieNamePrefix*	no	string	TraefikOidcAuth	Specifies the prefix for all cookies used internally by the plugin. The final names are concatenated using dot-notation. Eg. TraefikOidcAuth.Session, TraefikOidcAuth.CodeVerifier etc. Please note that this prefix does not apply to AuthorizationCookie where the name can be set individually.
SessionCookie	no	SessionCookie	none	SessionCookie Configuration. See SessionCookieConfig block.
AuthorizationHeader	no	AuthorizationHeader	none	AuthorizationHeader Configuration. See AuthorizationHeader block.
AuthorizationCookie	no	AuthorizationCookie	none	AuthorizationCookie Configuration. See AuthorizationCookie block.
UnauthorizedBehavior*	no	string	Challenge	Defines the behavior for unauthenticated requests. Challenge means the user will be redirected to the IDP's login page, whereas Unauthorized will simply return a 401 status response.
Authorization	no	Authorization	none	Authorization Configuration. See Authorization block.
Headers	no	Header	none	Supplies a list of headers which will be attached to the upstream request. See Header block.
BypassAuthenticationRule*	no	string	none	Specifies an optional rule to bypass authentication. See Bypass Authentication Rule for more details.
ErrorPages	no	ErrorPages	none	Allows you to customize some error pages. See ErrorPages block.

Provider Block

Name	Required	Type	Default	Description
Url*	yes	string	none	The full URL of the Identity Provider.
InsecureSkipVerify*	no	bool	false	Disables SSL certificate verification of your provider. It's highly recommended to provide the real CA bundle via CABundleFile instead. So this option should only be used for quick testing.
CABundle*	no	string	none	An optional CA certificate bundle provided as a raw string in case you're using self-signed certificates for the provider. Please note that the string needs to represent a valid certificate, including new-lines. In case you cannot provide a multi-line argument you can base64-encode the bundle and provide it with the base64: prefix. Eg.: base64:<your-base64-encoded-bundle>.
CABundleFile*	no	string	none	Specifies the path to an optional CA certificate bundle in case you're using self-signed certificates for the provider. If you're using Docker, make sure the file is mounted into the traefik container.
ClientId*	yes	string	none	The client id of the application.
ClientSecret*	no	string	none	The client secret of the application. May not be needed for some providers when using PKCE.
UsePkce*	no	bool	false	Enable PKCE. In this case, a client secret may not be needed for some providers. The following algorithms are supported: RS, EC, ES.
ValidateIssuer*	no	bool	true	Specifies whether the iss claim in the JWT-token should be validated.
ValidIssuer*	no	string	discovery document	The issuer which must be present in the JWT-token. By default this will be read from the OIDC discovery document.
ValidateAudience*	no	bool	true	Specifies whether the aud claim in the JWT-token should be validated.
ValidAudience*	no	string	ClientId	The audience which must be present in the JWT-token. Defaults to the configured client id.
TokenValidation*	no	string	AccessToken	Specifies which token or method should be used to validate the authentication cookie. Can be either AccessToken, IdToken or Introspection. When using Microsoft EntraID, this will automatically default to IdToken. Introspection may not work when using PKCE.

SessionCookie Block

Name	Required	Type	Default	Description
Path	no	string	/	The path to which the cookie should be assigned to.
Domain	no	string	none	An optional domain to which the cookie should be assigned to. See Callback URLs for examples.
Secure	no	bool	true	Whether the cookie should be marked secure.
HttpOnly	no	bool	true	Whether the cookie should be marked http-only.
SameSite	no	string	default	Can be one of default, none, lax, strict.
MaxAge	no	int	0	Cookie time-to-live in seconds. 0 (default) is a ephemeral session cookie.

AuthorizationHeader Block

By specifying this configuration, a request can send an externally generated access token via this header to authenticate the request. In this case no session will be created by the middleware. You may also want to set UnauthorizedBehavior to Unauthorized.

Name	Required	Type	Default	Description
Name	no	string	none	The name of the header.

AuthorizationCookie Block

This works exactly the same as AuthorizationHeader, but using a cookie instead of a header. You can also use both.

Name	Required	Type	Default	Description
Name	no	string	none	The name of the cookie.

Authorization Block

Name	Required	Type	Default	Description
AssertClaims	no	ClaimAssertion[]	none	ClaimAssertion Configuration. See ClaimAssertion block.
CheckOnEveryRequest	no	bool	false	When set to true, authorization is checked on every single request. When set to false, authorization is only checked when the user logs in and the session is being created. When using external authentication using ˋAuthorizationHeaderˋ or ˋAuthorizationCookieˋ this is always treated as true.

ClaimAssertion Block

If only the Name property is set and no additional assertions are defined it is only checked whether there exist any matches for the name of this claim without any verification on their values. Additionaly, the Name field can be any json path. The Name gets prefixed with $. to match from the root element. The usage of json paths allows for assertions on deeply nested json structures.

Name	Required	Type	Default	Description
Name	yes	string	none	The name of the claim in the access token.
AnyOf	no	string[]	none	An array of allowed strings. The user is authorized if any value matching the name of the claim contains (or is) a value of this array.
AllOf	no	string[]	none	An array of required strings. The user is only authorized if any value matching the name of the claim contains (or is) a value of this array and all values of this array are covered in the end.

It is possible to combine AnyOf and AllOf quantifiers for one assertion.

tip

Also see the Authorization section for more details about how to use this feature.

important

Because the name is being interpreted as jsonpath, you may need to escape some names, if they contain special characters like a colon or minus. So instead of Name: "my:zitadel:grants", use Name: "['my:zitadel:grants']".

Header Block

Name	Required	Type	Default	Description
Name	yes	string	none	The name of the header which should be added to the upstream request.
Value	yes	string	none	The value of the header, which can use Go-Templates. Please see the info below.

By using Go-Templates you have access to the following attributes:

Template	Description
{{ .accessToken }}	The OAuth Access Token
{{ .idToken }}	The OAuth Id Token
{{ .claims.* }}	Replace * with the name or path to your desired claim

info

Because traefik configuration files already support Go-templating, you need to escape your templates in a weird way. Here are some examples:

Headers:
  - Name: "Authorization"
    Value: "{{`Bearer {{ .accessToken }}`}}"
  - Name: "X-Oidc-Username"
    Value: "{{`{{ .claims.preferred_username }}`}}"

The outer curly braces and backticks are used to escape the inner curly braces.

Note that this only applies for configuring Traefik from a YAML file, where it performs its own template expansion. If you are using the Kubernetes CRDs, you should not escape, just template as usual:

Headers:
  - Name: X-Oidc-Groups-Json-Array
    Value: '[{{with .claims.groups}}{{ range $i, $g := . }}{{if $i}},{{end}}"{{js $g}}"{{end}}{{end}}]'

ErrorPages Block

Name	Required	Type	Default	Description
Unauthenticated	no	ErrorPage	none	Configures the page or behavior when the user is not authenticated.
Unauthorized	no	ErrorPage	none	Configures the page or behavior when the user is not authorized.

ErrorPage Block

Name	Required	Type	Default	Description
FilePath*	no	string	none	Specifies the path to a local html file which should be served. If this is not set, the default page is shown. This html file needs to be self-contained which means all CSS and JS must be inlined.
RedirectTo*	no	string	none	If this is set to a URL, the user is redirected to this page in case of an error, instead of showing an error page.