Traefik TLS headers plugin

Usage

This plugin will take TLS information from the client connection and write them to some headers.

Copy
middlewares:
  my-middleware:
    plugin:
      tlsheaders:
        headers:
          cipher: X-Tls-Cipher

Supported fields

• cipher: The cipher used for the connection. See the docs CipherSuiteName for more information.

Configuration

Traefik static configuration must define the module name (as is usual for Go packages).

The following declaration (given here in YAML) defines a plugin:

Copy
# Static configuration

experimental:
  plugins:
    tlsheaders:
      moduleName: github.com/RiskIdent/traefik-tls-headers-plugin
      version: v0.1.1

Copy
# Static configuration

--experimental.plugins.tlsheaders.moduleName=github.com/RiskIdent/traefik-tls-headers-plugin
--experimental.plugins.tlsheaders.version=v0.1.1

Copy
# Dynamic configuration

apiVersion: traefik.io/v1alpha1
kind: Middleware
metadata:
  name: my-middleware
spec:
  plugin:
    tlsheaders:
      headers:
        cipher: X-Tls-Cipher

Test locally

In order to test the plugin locally, start the printheaders application:

Copy
make start_headers_reader

Then start Traefik with the plugin:

Copy
make testcontainer

The traefik test configuration is located in the testconfig directory.

And finally, make a request to the Traefik instance:

Copy
curl -sS https://localhost -k | grep X-Tls-Cipher

The response should contain the header(s) you set up.

X-Tls-Cipher: TLS_AES_128_GCM_SHA256

Credits

Icon made by https://www.flaticon.com/de/kostenloses-icon/tls-protokoll_4896619