tlspolicy

Documentation

Overview

Package tlspolicy provides for configuration and enforcement of policies relating to TLS.

Index

• func ApplyPolicy(config *tls.Config, policy Policy) error
• func LogPolicy(policy Policy, logger hclog.Logger)
• type Policy

Functions

func ApplyPolicy

func ApplyPolicy(config *tls.Config, policy Policy) error

ApplyPolicy applies the policy options in policy to a given tls.Config, which is assumed to have already been obtained from the go-spiffe tlsconfig package.

func LogPolicy

func LogPolicy(policy Policy, logger hclog.Logger)

LogPolicy logs an informational message reporting the configured policy, aiding administrators to determine what policy options have been successfully enabled.

Types

type Policy

type Policy struct {
	// RequirePQKEM determines if a post-quantum-safe KEM should be required for
	// TLS connections.
	RequirePQKEM bool
}

Policy describes policy options to be applied to a TLS configuration.

A zero-initialised Policy provides reasonable defaults.