vttls

Documentation

Index

• func ClientConfig(mode SslMode, cert, key, ca, name string, minTLSVersion uint16) (*tls.Config, error)
• func ServerConfig(cert, key, ca, serverCA string, minTLSVersion uint16) (*tls.Config, error)
• func TLSVersionToNumber(tlsVersion string) (uint16, error)
• type SslMode
  • func (mode *SslMode) Set(value string) error
  • func (mode *SslMode) String() string

Functions

func ClientConfig

func ClientConfig(mode SslMode, cert, key, ca, name string, minTLSVersion uint16) (*tls.Config, error)

ClientConfig returns the TLS config to use for a client to connect to a server with the provided parameters.

func ServerConfig

func ServerConfig(cert, key, ca, serverCA string, minTLSVersion uint16) (*tls.Config, error)

ServerConfig returns the TLS config to use for a server to accept client connections.

func TLSVersionToNumber

func TLSVersionToNumber(tlsVersion string) (uint16, error)

TLSVersionToNumber converts a text description of the TLS protocol to the internal Go number representation.

Types

type SslMode

type SslMode string

SslMode indicates the type of SSL mode to use. This matches the MySQL SSL modes as mentioned at: https://dev.mysql.com/doc/refman/8.0/en/connection-options.html#option_general_ssl-mode

const Disabled SslMode = "disabled"

Disabled disables SSL and connects over plain text

const Preferred SslMode = "preferred"

Preferred establishes an SSL connection if the server supports it. It does not validate the certificate provided by the server.

const Required SslMode = "required"

Required requires an SSL connection to the server. It does not validate the certificate provided by the server.

const VerifyCA SslMode = "verify_ca"

VerifyCA requires an SSL connection to the server. It validates the CA against the configured CA certificate(s).

const VerifyIdentity SslMode = "verify_identity"

VerifyIdentity requires an SSL connection to the server. It validates the CA against the configured CA certificate(s) and also validates the certificate based on the hostname. This is the setting you want when you want to connect safely to a MySQL server and want to be protected against man-in-the-middle attacks.

func (*SslMode) Set

func (mode *SslMode) Set(value string) error

Set updates the value of the SslMode pointer, part of the Value interface for allowing to update a flag.

func (*SslMode) String

func (mode *SslMode) String() string

String returns the string representation, part of the Value interface for allowing this to be retrieved for a flag.