tls

Documentation

Overview

Package tls provides implementation of Go API for tls certificate provider

Package tls provides implementation of Go API for tls certificate provider

Index

• Variables
• func NewX509CertPool(path string) (pool *x509.CertPool, err error)
• type Config
  • func New(opts ...Option) (*Config, error)
  • func NewClientConfig(opts ...Option) (*Config, error)
• type Conn
• type Dialer
• type Option
  • func WithCa(ca string) Option
  • func WithCert(cert string) Option
  • func WithInsecureSkipVerify(insecure bool) Option
  • func WithKey(key string) Option
  • func WithTLSConfig(cfg *tls.Config) Option

Variables

var (
	Client         = tls.Client
	Dial           = tls.Dial
	DialWithDialer = tls.DialWithDialer
)

Functions

func NewX509CertPool

func NewX509CertPool(path string) (pool *x509.CertPool, err error)

NewX509CertPool returns *x509.CertPool struct or error. The CertPool will read the certificate from the path, and append the content to the system certificate pool, and return.

Types

type Config

type Config = tls.Config

func New

func New(opts ...Option) (*Config, error)

NewTLSConfig returns a *tls.Config struct or error This function read TLS configuration and initialize *tls.Config struct. This function initialize TLS configuration, for example the CA certificate and key to start TLS server. Server and CA Certificate, and private key will read from a file from the file path defined in environment variable.

func NewClientConfig

func NewClientConfig(opts ...Option) (*Config, error)

type Conn

type Conn = tls.Conn

type Dialer

type Dialer = tls.Dialer

type Option

type Option func(*credentials) error

func WithCa

func WithCa(ca string) Option

func WithCert

func WithCert(cert string) Option

func WithInsecureSkipVerify

func WithInsecureSkipVerify(insecure bool) Option

func WithKey

func WithKey(key string) Option

func WithTLSConfig

func WithTLSConfig(cfg *tls.Config) Option