Headers

Adding Headers to the Request / Response

Headers

The Headers middleware can manage the requests/responses headers.

Configuration Examples

Adding Headers to the Request and the Response

Add the X-Script-Name header to the proxied request and the X-Custom-Response-Header to the response

  1. labels:
  2.   - "traefik.http.middlewares.testHeader.headers.customrequestheaders.X-Script-Name=test"
  3.   - "traefik.http.middlewares.testHeader.headers.customresponseheaders.X-Custom-Response-Header=value"

  1. apiVersion: traefik.containo.us/v1alpha1
  2. kind: Middleware
  3. metadata:
  4.   name: testHeader
  5. spec:
  6.   headers:
  7.     customRequestHeaders:
  8.       X-Script-Name: "test"
  9.     customResponseHeaders:
  10.       X-Custom-Response-Header: "value"

  1. - "traefik.http.middlewares.testheader.headers.customrequestheaders.X-Script-Name=test"
  2. - "traefik.http.middlewares.testheader.headers.customresponseheaders.X-Custom-Response-Header=value"

  1. "labels": {
  2.   "traefik.http.middlewares.testheader.headers.customrequestheaders.X-Script-Name": "test",
  3.   "traefik.http.middlewares.testheader.headers.customresponseheaders.X-Custom-Response-Header": "value"
  4. }

  1. labels:
  2.   - "traefik.http.middlewares.testheader.headers.customrequestheaders.X-Script-Name=test"
  3.   - "traefik.http.middlewares.testheader.headers.customresponseheaders.X-Custom-Response-Header=value"

  1. [http.middlewares]
  2.   [http.middlewares.testHeader.headers]
  3.     [http.middlewares.testHeader.headers.customRequestHeaders]
  4.         X-Script-Name = "test"
  5.     [http.middlewares.testHeader.headers.customResponseHeaders]
  6.         X-Custom-Response-Header = "value"

  1. http:
  2.   middlewares:
  3.     testHeader:
  4.       headers:
  5.         customRequestHeaders:
  6.           X-Script-Name: "test"
  7.         customResponseHeaders:
  8.           X-Custom-Response-Header: "value"

Adding and Removing Headers

X-Script-Name header added to the proxied request, the X-Custom-Request-Header header removed from the request,and the X-Custom-Response-Header header removed from the response.

Please note that it is not possible to remove headers through the use of labels (Docker, Rancher, Marathon, …) for now.

  1. labels:
  2.   - "traefik.http.middlewares.testheader.headers.customrequestheaders.X-Script-Name=test"

  1. apiVersion: traefik.containo.us/v1alpha1
  2. kind: Middleware
  3. metadata:
  4.   name: testHeader
  5. spec:
  6.   headers:
  7.     customRequestHeaders:
  8.       X-Script-Name: "test" # Adds
  9.       X-Custom-Request-Header: "" # Removes
  10.     customResponseHeaders:
  11.       X-Custom-Response-Header: "" # Removes

  1. - "traefik.http.middlewares.testheader.headers.customrequestheaders.X-Script-Name=test"

  1. "labels": {
  2.   "traefik.http.middlewares.testheader.headers.customrequestheaders.X-Script-Name": "test",
  3. }

  1. labels:
  2.   - "traefik.http.middlewares.testheader.headers.customrequestheaders.X-Script-Name=test"

  1. [http.middlewares]
  2.   [http.middlewares.testHeader.headers]
  3.     [http.middlewares.testHeader.headers.customRequestHeaders]
  4.         X-Script-Name = "test" # Adds
  5.         X-Custom-Request-Header = "" # Removes
  6.     [http.middlewares.testHeader.headers.customResponseHeaders]
  7.         X-Custom-Response-Header = "" # Removes

  1. http:
  2.   middlewares:
  3.     testHeader:
  4.       headers:
  5.         customRequestHeaders:
  6.           X-Script-Name: "test" # Adds
  7.           X-Custom-Request-Header: "" # Removes
  8.         customResponseHeaders:
  9.           X-Custom-Response-Header: "" # Removes

Using Security Headers

Security related headers (HSTS headers, SSL redirection, Browser XSS filter, etc) can be added and configured in a manner similar to the custom headers above.This functionality allows for some easy security features to quickly be set.

  1. labels:
  2.   - "traefik.http.middlewares.testHeader.headers.framedeny=true"
  3.   - "traefik.http.middlewares.testHeader.headers.sslredirect=true"

  1. apiVersion: traefik.containo.us/v1alpha1
  2. kind: Middleware
  3. metadata:
  4.   name: testHeader
  5. spec:
  6.   headers:
  7.     frameDeny: "true"
  8.     sslRedirect: "true"

  1. - "traefik.http.middlewares.testheader.headers.framedeny=true"
  2. - "traefik.http.middlewares.testheader.headers.sslredirect=true"

  1. "labels": {
  2.   "traefik.http.middlewares.testheader.headers.framedeny": "true",
  3.   "traefik.http.middlewares.testheader.headers.sslredirect": "true"
  4. }

  1. labels:
  2.   - "traefik.http.middlewares.testheader.headers.framedeny=true"
  3.   - "traefik.http.middlewares.testheader.headers.sslredirect=true"

  1. [http.middlewares]
  2.   [http.middlewares.testHeader.headers]
  3.     frameDeny = true
  4.     sslRedirect = true

  1. http:
  2.   middlewares:
  3.     testHeader:
  4.       headers:
  5.         frameDeny: true
  6.         sslRedirect: true

CORS Headers

CORS (Cross-Origin Resource Sharing) headers can be added and configured in a manner similar to the custom headers above.This functionality allows for more advanced security features to quickly be set.

  1. labels:
  2.   - "traefik.http.middlewares.testheader.headers.accesscontrolallowmethods=GET,OPTIONS,PUT"
  3.   - "traefik.http.middlewares.testheader.headers.accesscontrolalloworigin=origin-list-or-null"
  4.   - "traefik.http.middlewares.testheader.headers.accesscontrolmaxage=100"
  5.   - "traefik.http.middlewares.testheader.headers.addvaryheader=true"

  1. apiVersion: traefik.containo.us/v1alpha1
  2. kind: Middleware
  3. metadata:
  4.   name: testHeader
  5. spec:
  6.   headers:
  7.     accessControlAllowMethods:
  8.       - "GET"
  9.       - "OPTIONS"
  10.       - "PUT"
  11.     accessControlAllowOrigin: "origin-list-or-null"
  12.     accessControlMaxAge: 100
  13.     addVaryHeader: "true"

  1. - "traefik.http.middlewares.testheader.headers.accesscontrolallowmethods=GET,OPTIONS,PUT"
  2. - "traefik.http.middlewares.testheader.headers.accesscontrolalloworigin=origin-list-or-null"
  3. - "traefik.http.middlewares.testheader.headers.accesscontrolmaxage=100"
  4. - "traefik.http.middlewares.testheader.headers.addvaryheader=true"

  1. "labels": {
  2.   "traefik.http.middlewares.testheader.headers.accesscontrolallowmethods": "GET,OPTIONS,PUT",
  3.   "traefik.http.middlewares.testheader.headers.accesscontrolalloworigin": "origin-list-or-null",
  4.   "traefik.http.middlewares.testheader.headers.accesscontrolmaxage": "100",
  5.   "traefik.http.middlewares.testheader.headers.addvaryheader": "true"
  6. }

  1. labels:
  2.   - "traefik.http.middlewares.testheader.headers.accesscontrolallowmethods=GET,OPTIONS,PUT"
  3.   - "traefik.http.middlewares.testheader.headers.accesscontrolalloworigin=origin-list-or-null"
  4.   - "traefik.http.middlewares.testheader.headers.accesscontrolmaxage=100"
  5.   - "traefik.http.middlewares.testheader.headers.addvaryheader=true"

  1. [http.middlewares]
  2.   [http.middlewares.testHeader.headers]
  3.     accessControlAllowMethods= ["GET", "OPTIONS", "PUT"]
  4.     accessControlAllowOrigin = "origin-list-or-null"
  5.     accessControlMaxAge = 100
  6.     addVaryHeader = true

  1. http:
  2.   middlewares:
  3.     testHeader:
  4.       headers:
  5.         accessControlAllowMethods:
  6.           - GET
  7.           - OPTIONS
  8.           - PUT
  9.         accessControlAllowOrigin: "origin-list-or-null"
  10.         accessControlMaxAge: 100
  11.         addVaryHeader: true

Configuration Options

General

Warning

If the custom header name is the same as one header name of the request or response, it will be replaced.

The detailed documentation for the security headers can be found in unrolled/secure.

customRequestHeaders

The customRequestHeaders option lists the Header names and values to apply to the request.

customResponseHeaders

The customResponseHeaders option lists the Header names and values to apply to the response.

accessControlAllowCredentials

The accessControlAllowCredentials indicates whether the request can include user credentials.

accessControlAllowHeaders

The accessControlAllowHeaders indicates which header field names can be used as part of the request.

accessControlAllowMethods

The accessControlAllowMethods indicates which methods can be used during requests.

accessControlAllowOrigin

The accessControlAllowOrigin indicates whether a resource can be shared by returning different values.The three options for this value are:

  • origin-list-or-null
  • *
  • null

accessControlExposeHeaders

The accessControlExposeHeaders indicates which headers are safe to expose to the api of a CORS API specification.

accessControlMaxAge

The accessControlMaxAge indicates how long a preflight request can be cached.

addVaryHeader

The addVaryHeader is used in conjunction with accessControlAllowOrigin to determine whether the vary header should be added or modified to demonstrate that server responses can differ beased on the value of the origin header.

allowedHosts

The allowedHosts option lists fully qualified domain names that are allowed.

hostsProxyHeaders

The hostsProxyHeaders option is a set of header keys that may hold a proxied hostname value for the request.

sslRedirect

The sslRedirect is set to true, then only allow https requests.

sslTemporaryRedirect

Set the sslTemporaryRedirect to true to force an SSL redirection using a 302 (instead of a 301).

sslHost

The sslHost option is the host name that is used to redirect http requests to https.

sslProxyHeaders

The sslProxyHeaders option is set of header keys with associated values that would indicate a valid https request.Useful when using other proxies with header like: "X-Forwarded-Proto": "https".

sslForceHost

Set sslForceHost to true and set SSLHost to forced requests to use SSLHost even the ones that are already using SSL.

stsSeconds

The stsSeconds is the max-age of the Strict-Transport-Security header.If set to 0, would NOT include the header.

stsIncludeSubdomains

The stsIncludeSubdomains is set to true, the includeSubDomains directive will be appended to the Strict-Transport-Security header.

stsPreload

Set stsPreload to true to have the preload flag appended to the Strict-Transport-Security header.

forceSTSHeader

Set forceSTSHeader to true, to add the STS header even when the connection is HTTP.

frameDeny

Set frameDeny to true to add the X-Frame-Options header with the value of DENY.

customFrameOptionsValue

The customFrameOptionsValue allows the X-Frame-Options header value to be set with a custom value.This overrides the FrameDeny option.

contentTypeNosniff

Set contentTypeNosniff to true to add the X-Content-Type-Options header with the value nosniff.

browserXssFilter

Set browserXssFilter to true to add the X-XSS-Protection header with the value 1; mode=block.

customBrowserXSSValue

The customBrowserXssValue option allows the X-XSS-Protection header value to be set with a custom value.This overrides the BrowserXssFilter option.

contentSecurityPolicy

The contentSecurityPolicy option allows the Content-Security-Policy header value to be set with a custom value.

publicKey

The publicKey implements HPKP to prevent MITM attacks with forged certificates.

referrerPolicy

The referrerPolicy allows sites to control when browsers will pass the Referer header to other sites.

featurePolicy

The featurePolicy allows sites to control browser features.

isDevelopment

Set isDevelopment to true when developing.The AllowedHosts, SSL, and STS options can cause some unwanted effects.Usually testing happens on http, not https, and on localhost, not your production domain.If you would like your development environment to mimic production with complete Host blocking, SSL redirects, and STS headers, leave this as false.