easytls

README

easy-tls

A set of packages for quickly and easily developing TLS-enabled Web Servers and Clients.

Documentation

Overview

Package easytls and the rest of this library is intended to provide a simple interface for creating simple HTTP(S) Client/Server applications.

This package provides a mechanism for preparing the tls.Config object of an http.Client or http.Server with common levels of enablement. The TLSBundle object intends to simplify preparing and understanding what components are necessary in a standard TLS setup, instead of needing to understand the full settings of the tls.Config struct.

Index

• func NewTLSConfig(TLS *TLSBundle) (*tls.Config, error)
• type KeyPair
• type TLSBundle

Functions

func NewTLSConfig

func NewTLSConfig(TLS *TLSBundle) (*tls.Config, error)

NewTLSConfig will convert the TLSBundle, containing the filenames of the relevant certificates and Authorization policy, into a workable tls.Config object, ready to be used by either a SimpleClient or SimpleServer application.

Types

type KeyPair

type KeyPair struct {
	Certificate string
	Key         string
}

KeyPair represents the filenames to a pair of matching TLS Key/Certificate files. This can be either a Server-side or Client-side Certificate/Key pair.

type TLSBundle

type TLSBundle struct {
	AuthorityCertificates []string
	KeyPair               KeyPair
	Auth                  tls.ClientAuthType
	Enabled               bool `json:"-"`
}

TLSBundle represents the set of TLS information required to generate a satisfactory tls.Config struct.