tlsdefaults

README

tlsdefaults provides sensible defaults for using TLS with Go.

Documentation

Overview

Package tlsdefaults provides sensible defaults for using TLS.

Index

• func BuildListenerConfig(addr string, pkfile string, certfile string) (*tls.Config, error)
• func Listen(addr, pkfile, certfile string) (net.Listener, error)
• func NewListener(l net.Listener, pkfile, certfile string) (net.Listener, error)
• func NewListenerAddr(l net.Listener, addr string, pkfile, certfile string) (net.Listener, error)
• func Server() *tls.Config
• type CertContext

Functions

func BuildListenerConfig

func BuildListenerConfig(addr string, pkfile string, certfile string) (*tls.Config, error)

BuildListenerConfig builds a tls.Config for a listener at the given addr

func Listen

func Listen(addr, pkfile, certfile string) (net.Listener, error)

Listen opens a TLS listener at the given address using the private key and certificate PEM files at the given paths. If no files exists, it creates a new key and self-signed certificate at those locations.

func NewListener

func NewListener(l net.Listener, pkfile, certfile string) (net.Listener, error)

NewListener creates a TLS listener based on the given listener using the private key and certificate PEM files at the given paths. If no files exists, it creates a new key and self-signed certificate at those locations.

func NewListenerAddr

func NewListenerAddr(l net.Listener, addr string, pkfile, certfile string) (net.Listener, error)

NewListenerAddr is like NewListener but uses the specified addr to generate the cert.

func Server

func Server() *tls.Config

Server provides a tls.Config with sensible defaults for server use. At this point, it mostly trusts the defaults from Go (assumes Go version 1.5 or or newer).

Types

type CertContext

type CertContext struct {
	PKFile         string
	ServerCertFile string
	PK             *keyman.PrivateKey
	ServerCert     *keyman.Certificate
}

CertContext encapsulates the certificates used by a Server