Skip to content

Feature: configurable minimum TLS version #2122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
btgoodwin wants to merge 4 commits into
base: master
Choose a base branch
from
+32 −5
Open

Feature: configurable minimum TLS version #2122

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ec3b818
feat(api): configurable minimum TLS version
btgoodwin Feb 27, 2026
95d5e0b
fix(api): minimum TLS default should be 1.2
btgoodwin Mar 3, 2026
72ed669
fix(api): typo in tlsVersionMap(p)
btgoodwin Mar 3, 2026
c8e0d8c
fix(api): moved minTLSVersion parsing to before I/O calls
btgoodwin Mar 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 32 additions & 5 deletions internal/api/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ func Init() {
TLSListen string `yaml:"tls_listen"`
TLSCert string `yaml:"tls_cert"`
TLSKey string `yaml:"tls_key"`
TLSMinVer string `yaml:"tls_min_ver"`
UnixListen string `yaml:"unix_listen"`

AllowPaths []string `yaml:"allow_paths"`
Expand All @@ -39,6 +40,7 @@ func Init() {

// default config
cfg.Mod.Listen = ":1984"
cfg.Mod.TLSMinVer = "TLS1.2"

// load config from YAML
app.LoadConfig(&cfg)
Expand Down Expand Up @@ -86,7 +88,7 @@ func Init() {

// Initialize the HTTPS server
if cfg.Mod.TLSListen != "" && cfg.Mod.TLSCert != "" && cfg.Mod.TLSKey != "" {
go tlsListen("tcp", cfg.Mod.TLSListen, cfg.Mod.TLSCert, cfg.Mod.TLSKey)
go tlsListen("tcp", cfg.Mod.TLSListen, cfg.Mod.TLSCert, cfg.Mod.TLSKey, cfg.Mod.TLSMinVer)
}
}

Expand All @@ -108,9 +110,32 @@ func listen(network, address string) {
}
}

func tlsListen(network, address, certFile, keyFile string) {
func parseTLSVersion(versionStr string) (uint16, error) {
v := strings.ToUpper(strings.TrimSpace(versionStr))
if val, ok := tlsVersionMap[v]; ok {
return val, nil
}
return 0, fmt.Errorf("invalid TLS version: %s", versionStr)
}

// Map string values to the crypto/tls constants
var tlsVersionMap = map[string]uint16{
"TLS1.0": tls.VersionTLS10,
"TLS1.1": tls.VersionTLS11,
"TLS1.2": tls.VersionTLS12,
"TLS1.3": tls.VersionTLS13,
}

func tlsListen(network, address, certFile, keyFile string, minVersion string) {
var minTLSVersion uint16
var cert tls.Certificate
var err error

minTLSVersion, err = parseTLSVersion(minVersion)
if err != nil {
log.Error().Err(err).Caller().Send()
return
}
if strings.IndexByte(certFile, '\n') < 0 && strings.IndexByte(keyFile, '\n') < 0 {
// check if file path
cert, err = tls.LoadX509KeyPair(certFile, keyFile)
Expand All @@ -122,7 +147,6 @@ func tlsListen(network, address, certFile, keyFile string) {
log.Error().Err(err).Caller().Send()
return
}

ln, err := net.Listen(network, address)
if err != nil {
log.Error().Err(err).Msg("[api] tls listen")
Expand All @@ -132,8 +156,11 @@ func tlsListen(network, address, certFile, keyFile string) {
log.Info().Str("addr", address).Msg("[api] tls listen")

server := &http.Server{
Handler: Handler,
TLSConfig: &tls.Config{Certificates: []tls.Certificate{cert}},
Handler: Handler,
TLSConfig: &tls.Config{
Certificates: []tls.Certificate{cert},
MinVersion: minTLSVersion,
},
ReadHeaderTimeout: 5 * time.Second,
}
if err = server.ServeTLS(ln, "", ""); err != nil {
Expand Down