defaultcspheader

README

traefik-default-csp-header-plugin

This is a traefik middleware plugin that adds a default CSP header on every upstream response without a CSP header.

This plugin implements the following behavior:

• If any upstream traefik middleware or service set a Content-Security-Policy header in the response, this plugin does nothing.
• Otherwise, this plugin set a default Content-Security-Policy header. You can provide the default Content-Security-Policy in the traefik configuration.

Setup

To configure this plugin you should add its static and dynamic configuration to the Traefik dynamic configuration as explained here.

You find an example for the static configuration and the dynamic configuration in the integration test.

Configuration

You must set the plugin configuration in the runtime configuration of traefik.

Option	Required	Description
defaultCSPHeader	true	The Content-Security-Policy header value that is set on every http response, that does not contains a Content-Security-Policy header

Documentation

Index

• Constants
• func New(ctx context.Context, next http.Handler, config *Config, name string) (http.Handler, error)
• type Config
  • func CreateConfig() *Config
• type DefaultCSPHeaderPlugin
  • func (d *DefaultCSPHeaderPlugin) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type MyResponseWriter
  • func (m *MyResponseWriter) WriteHeader(statusCode int)

Constants

const CSPHeaderKey = "Content-Security-Policy"

Functions

func New

func New(ctx context.Context, next http.Handler, config *Config, name string) (http.Handler, error)

Types

type Config

type Config struct {
	DefaultCSPHeader string `json:"defaultCspHeader,omitempty"`
}

func CreateConfig

func CreateConfig() *Config

type DefaultCSPHeaderPlugin

type DefaultCSPHeaderPlugin struct {
	// contains filtered or unexported fields
}

func (*DefaultCSPHeaderPlugin) ServeHTTP

func (d *DefaultCSPHeaderPlugin) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implements http.Handler

type MyResponseWriter

type MyResponseWriter struct {
	http.ResponseWriter
	DefaultCSPEntry string
}

func (*MyResponseWriter) WriteHeader

func (m *MyResponseWriter) WriteHeader(statusCode int)