diff --git a/v2/configurations/database_info.go b/v2/configurations/database_info.go index 0b079809..75b5fa0e 100755 --- a/v2/configurations/database_info.go +++ b/v2/configurations/database_info.go @@ -38,6 +38,9 @@ type ServerAddr struct { Protocol string Addr string Port int + // TLSServerName, if set, is used instead of Addr to verify the server + // certificate. It keeps the original host across a listener redirect. + TLSServerName string } type DatabaseInfo struct { @@ -154,6 +157,11 @@ func (info *DatabaseInfo) UpdateDatabaseInfoForRedirect(redirectAddr string, rec redirectAddr = strings.ReplaceAll(redirectAddr, "\n", "") reconnectData = strings.ReplaceAll(reconnectData, "\r", "") reconnectData = strings.ReplaceAll(reconnectData, "\n", "") + // Verify the certificate against the original host, not the redirect address. + var tlsServerName string + if current := info.GetActiveServer(false); current != nil { + tlsServerName = current.TLSHostName() + } var err error info.Servers, err = ExtractServers(redirectAddr) if err != nil { @@ -162,6 +170,9 @@ func (info *DatabaseInfo) UpdateDatabaseInfoForRedirect(redirectAddr string, rec if len(info.Servers) == 0 { return errors.New("no address passed in connection string") } + for i := range info.Servers { + info.Servers[i].TLSServerName = tlsServerName + } r, err := regexp.Compile(`(?i)\(\s*SERVICE_NAME\s*=\s*([\w.-]+)\s*\)`) if err != nil { return err @@ -208,6 +219,14 @@ func (serv *ServerAddr) NetworkAddr() string { return net.JoinHostPort(serv.Addr, strconv.Itoa(serv.Port)) } +// TLSHostName returns TLSServerName if set, otherwise Addr. +func (serv *ServerAddr) TLSHostName() string { + if len(serv.TLSServerName) > 0 { + return serv.TLSServerName + } + return serv.Addr +} + func (info *DatabaseInfo) ResetServerIndex() { info.serverIndex = 0 } diff --git a/v2/configurations/database_info_test.go b/v2/configurations/database_info_test.go new file mode 100644 index 00000000..2a4baf51 --- /dev/null +++ b/v2/configurations/database_info_test.go @@ -0,0 +1,49 @@ +package configurations + +import "testing" + +func TestUpdateDatabaseInfoForRedirectKeepsTLSHostName(t *testing.T) { + info := DatabaseInfo{} + err := info.UpdateDatabaseInfo(`(DESCRIPTION=(ADDRESS=(PROTOCOL=TCPS)(HOST=scan.example.com)(PORT=2484))(CONNECT_DATA=(SERVICE_NAME=svc)))`) + if err != nil { + t.Fatalf("UpdateDatabaseInfo: %v", err) + } + if got := info.GetActiveServer(false).TLSHostName(); got != "scan.example.com" { + t.Fatalf("TLSHostName before redirect = %q, want %q", got, "scan.example.com") + } + + // A SCAN listener redirects to a node listener by IP address. + err = info.UpdateDatabaseInfoForRedirect( + `(ADDRESS=(PROTOCOL=TCPS)(HOST=10.0.0.42)(PORT=2484))`, + `(DESCRIPTION=(CONNECT_DATA=(SERVICE_NAME=svc)(INSTANCE_NAME=inst1)))`) + if err != nil { + t.Fatalf("UpdateDatabaseInfoForRedirect: %v", err) + } + info.ResetServerIndex() + server := info.GetActiveServer(false) + if server.Addr != "10.0.0.42" { + t.Errorf("Addr after redirect = %q, want %q", server.Addr, "10.0.0.42") + } + if got := server.TLSHostName(); got != "scan.example.com" { + t.Errorf("TLSHostName after redirect = %q, want %q", got, "scan.example.com") + } + + // A second redirect keeps the host from the original descriptor. + err = info.UpdateDatabaseInfoForRedirect( + `(ADDRESS=(PROTOCOL=TCPS)(HOST=10.0.0.48)(PORT=2484))`, + `(DESCRIPTION=(CONNECT_DATA=(SERVICE_NAME=svc)))`) + if err != nil { + t.Fatalf("second UpdateDatabaseInfoForRedirect: %v", err) + } + info.ResetServerIndex() + if got := info.GetActiveServer(false).TLSHostName(); got != "scan.example.com" { + t.Errorf("TLSHostName after second redirect = %q, want %q", got, "scan.example.com") + } +} + +func TestTLSHostNameDefaultsToAddr(t *testing.T) { + server := ServerAddr{Addr: "10.0.0.42", Port: 2484} + if got := server.TLSHostName(); got != "10.0.0.42" { + t.Errorf("TLSHostName() = %q, want %q", got, "10.0.0.42") + } +} diff --git a/v2/network/session.go b/v2/network/session.go index 6e901d0f..fffb0c74 100755 --- a/v2/network/session.go +++ b/v2/network/session.go @@ -342,7 +342,9 @@ func (session *Session) negotiate() { host := connOption.GetActiveServer(false) if tlsConfig := connOption.TLSConfig; tlsConfig != nil { - tlsConfig.ServerName = host.Addr + // clone: TLSConfig is shared by all connections of the connector + tlsConfig = tlsConfig.Clone() + tlsConfig.ServerName = host.TLSHostName() sslConn := tls.Client(session.conn, tlsConfig) session.mu.Lock() session.sslConn = sslConn @@ -357,7 +359,7 @@ func (session *Session) negotiate() { } } config := &tls.Config{ - ServerName: host.Addr, + ServerName: host.TLSHostName(), } if len(session.SSL.tlsCertificates) > 0 { config.Certificates = session.SSL.tlsCertificates diff --git a/v2/network/session_tls_test.go b/v2/network/session_tls_test.go new file mode 100644 index 00000000..aeb0c8bd --- /dev/null +++ b/v2/network/session_tls_test.go @@ -0,0 +1,186 @@ +package network + +import ( + "crypto/ecdsa" + "crypto/elliptic" + "crypto/rand" + "crypto/tls" + "crypto/x509" + "crypto/x509/pkix" + "math/big" + "net" + "strings" + "sync" + "testing" + "time" + + "github.com/sijms/go-ora/v2/configurations" + "github.com/sijms/go-ora/v2/trace" +) + +// newTestCertificate returns a CA pool and a server certificate whose only SAN is dnsName. +func newTestCertificate(t *testing.T, dnsName string) (*x509.CertPool, tls.Certificate) { + t.Helper() + caKey, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader) + if err != nil { + t.Fatal(err) + } + caTemplate := &x509.Certificate{ + SerialNumber: big.NewInt(1), + Subject: pkix.Name{CommonName: "test-ca"}, + NotBefore: time.Now().Add(-time.Hour), + NotAfter: time.Now().Add(time.Hour), + IsCA: true, + KeyUsage: x509.KeyUsageCertSign, + BasicConstraintsValid: true, + } + caDER, err := x509.CreateCertificate(rand.Reader, caTemplate, caTemplate, &caKey.PublicKey, caKey) + if err != nil { + t.Fatal(err) + } + caCert, err := x509.ParseCertificate(caDER) + if err != nil { + t.Fatal(err) + } + serverKey, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader) + if err != nil { + t.Fatal(err) + } + serverTemplate := &x509.Certificate{ + SerialNumber: big.NewInt(2), + Subject: pkix.Name{CommonName: dnsName}, + DNSNames: []string{dnsName}, + NotBefore: time.Now().Add(-time.Hour), + NotAfter: time.Now().Add(time.Hour), + KeyUsage: x509.KeyUsageDigitalSignature, + ExtKeyUsage: []x509.ExtKeyUsage{x509.ExtKeyUsageServerAuth}, + } + serverDER, err := x509.CreateCertificate(rand.Reader, serverTemplate, caCert, &serverKey.PublicKey, caKey) + if err != nil { + t.Fatal(err) + } + pool := x509.NewCertPool() + pool.AddCert(caCert) + return pool, tls.Certificate{Certificate: [][]byte{serverDER}, PrivateKey: serverKey} +} + +// handshakeAfterRedirect runs negotiate after a redirect from scan.example.com to 10.0.0.42. +func handshakeAfterRedirect(t *testing.T, certName string, useTLSConfig bool) error { + t.Helper() + pool, serverCert := newTestCertificate(t, certName) + + connOption := &configurations.ConnectionConfig{ + DatabaseInfo: configurations.DatabaseInfo{ + Servers: []configurations.ServerAddr{ + {Protocol: "TCPS", Addr: "scan.example.com", Port: 2484}, + }, + ServiceName: "svc", + }, + SessionInfo: configurations.SessionInfo{ + SessionDataUnitSize: 0xFFFF, + TransportDataUnitSize: 0xFFFF, + SSLVerify: true, + }, + } + if useTLSConfig { + connOption.TLSConfig = &tls.Config{RootCAs: pool} + } + err := connOption.UpdateDatabaseInfoForRedirect( + `(ADDRESS=(PROTOCOL=TCPS)(HOST=10.0.0.42)(PORT=2484))`, + `(DESCRIPTION=(CONNECT_DATA=(SERVICE_NAME=svc)))`) + if err != nil { + t.Fatalf("UpdateDatabaseInfoForRedirect: %v", err) + } + connOption.ResetServerIndex() + + // not net.Pipe: it is unbuffered and deadlocks when the client sends an alert + listener, err := net.Listen("tcp", "127.0.0.1:0") + if err != nil { + t.Fatal(err) + } + defer listener.Close() + go func() { + serverConn, err := listener.Accept() + if err != nil { + return + } + defer serverConn.Close() + _ = tls.Server(serverConn, &tls.Config{Certificates: []tls.Certificate{serverCert}}).Handshake() + }() + clientConn, err := net.Dial("tcp", listener.Addr().String()) + if err != nil { + t.Fatal(err) + } + defer clientConn.Close() + if err := clientConn.SetDeadline(time.Now().Add(10 * time.Second)); err != nil { + t.Fatal(err) + } + + session := NewSession(connOption, trace.NilTracer()) + session.conn = clientConn + session.SSL.roots = pool + session.negotiate() + return session.sslConn.Handshake() +} + +func TestNegotiateVerifiesOriginalHostAfterRedirect(t *testing.T) { + for _, tc := range []struct { + name string + useTLSConfig bool + }{ + {name: "wallet roots", useTLSConfig: false}, + {name: "caller tls.Config", useTLSConfig: true}, + } { + t.Run(tc.name, func(t *testing.T) { + if err := handshakeAfterRedirect(t, "scan.example.com", tc.useTLSConfig); err != nil { + t.Fatalf("TLS handshake after redirect failed: %v", err) + } + }) + } +} + +func TestNegotiateStillVerifiesHostName(t *testing.T) { + err := handshakeAfterRedirect(t, "other.example.com", false) + if err == nil { + t.Fatal("TLS handshake succeeded with a certificate for the wrong host") + } + if !strings.Contains(err.Error(), "scan.example.com") { + t.Errorf("error = %v, want a host name mismatch for scan.example.com", err) + } +} + +func TestNegotiateDoesNotModifyCallerTLSConfig(t *testing.T) { + shared := &tls.Config{} + var wg sync.WaitGroup + for _, addr := range []string{"a.example.com", "b.example.com", "c.example.com", "d.example.com"} { + wg.Add(1) + go func(addr string) { + defer wg.Done() + connOption := &configurations.ConnectionConfig{ + DatabaseInfo: configurations.DatabaseInfo{ + Servers: []configurations.ServerAddr{ + {Protocol: "TCPS", Addr: addr, Port: 2484}, + }, + ServiceName: "svc", + }, + SessionInfo: configurations.SessionInfo{ + SessionDataUnitSize: 0xFFFF, + TransportDataUnitSize: 0xFFFF, + SSLVerify: true, + }, + } + connOption.TLSConfig = shared + connOption.ResetServerIndex() + clientConn, serverConn := net.Pipe() + defer clientConn.Close() + defer serverConn.Close() + session := NewSession(connOption, trace.NilTracer()) + session.conn = clientConn + session.negotiate() + }(addr) + } + wg.Wait() + if shared.ServerName != "" { + t.Errorf("caller tls.Config ServerName = %q, want it left empty", shared.ServerName) + } +} diff --git a/v3/configurations/database_info.go b/v3/configurations/database_info.go index 0b079809..75b5fa0e 100755 --- a/v3/configurations/database_info.go +++ b/v3/configurations/database_info.go @@ -38,6 +38,9 @@ type ServerAddr struct { Protocol string Addr string Port int + // TLSServerName, if set, is used instead of Addr to verify the server + // certificate. It keeps the original host across a listener redirect. + TLSServerName string } type DatabaseInfo struct { @@ -154,6 +157,11 @@ func (info *DatabaseInfo) UpdateDatabaseInfoForRedirect(redirectAddr string, rec redirectAddr = strings.ReplaceAll(redirectAddr, "\n", "") reconnectData = strings.ReplaceAll(reconnectData, "\r", "") reconnectData = strings.ReplaceAll(reconnectData, "\n", "") + // Verify the certificate against the original host, not the redirect address. + var tlsServerName string + if current := info.GetActiveServer(false); current != nil { + tlsServerName = current.TLSHostName() + } var err error info.Servers, err = ExtractServers(redirectAddr) if err != nil { @@ -162,6 +170,9 @@ func (info *DatabaseInfo) UpdateDatabaseInfoForRedirect(redirectAddr string, rec if len(info.Servers) == 0 { return errors.New("no address passed in connection string") } + for i := range info.Servers { + info.Servers[i].TLSServerName = tlsServerName + } r, err := regexp.Compile(`(?i)\(\s*SERVICE_NAME\s*=\s*([\w.-]+)\s*\)`) if err != nil { return err @@ -208,6 +219,14 @@ func (serv *ServerAddr) NetworkAddr() string { return net.JoinHostPort(serv.Addr, strconv.Itoa(serv.Port)) } +// TLSHostName returns TLSServerName if set, otherwise Addr. +func (serv *ServerAddr) TLSHostName() string { + if len(serv.TLSServerName) > 0 { + return serv.TLSServerName + } + return serv.Addr +} + func (info *DatabaseInfo) ResetServerIndex() { info.serverIndex = 0 } diff --git a/v3/configurations/database_info_test.go b/v3/configurations/database_info_test.go new file mode 100644 index 00000000..2a4baf51 --- /dev/null +++ b/v3/configurations/database_info_test.go @@ -0,0 +1,49 @@ +package configurations + +import "testing" + +func TestUpdateDatabaseInfoForRedirectKeepsTLSHostName(t *testing.T) { + info := DatabaseInfo{} + err := info.UpdateDatabaseInfo(`(DESCRIPTION=(ADDRESS=(PROTOCOL=TCPS)(HOST=scan.example.com)(PORT=2484))(CONNECT_DATA=(SERVICE_NAME=svc)))`) + if err != nil { + t.Fatalf("UpdateDatabaseInfo: %v", err) + } + if got := info.GetActiveServer(false).TLSHostName(); got != "scan.example.com" { + t.Fatalf("TLSHostName before redirect = %q, want %q", got, "scan.example.com") + } + + // A SCAN listener redirects to a node listener by IP address. + err = info.UpdateDatabaseInfoForRedirect( + `(ADDRESS=(PROTOCOL=TCPS)(HOST=10.0.0.42)(PORT=2484))`, + `(DESCRIPTION=(CONNECT_DATA=(SERVICE_NAME=svc)(INSTANCE_NAME=inst1)))`) + if err != nil { + t.Fatalf("UpdateDatabaseInfoForRedirect: %v", err) + } + info.ResetServerIndex() + server := info.GetActiveServer(false) + if server.Addr != "10.0.0.42" { + t.Errorf("Addr after redirect = %q, want %q", server.Addr, "10.0.0.42") + } + if got := server.TLSHostName(); got != "scan.example.com" { + t.Errorf("TLSHostName after redirect = %q, want %q", got, "scan.example.com") + } + + // A second redirect keeps the host from the original descriptor. + err = info.UpdateDatabaseInfoForRedirect( + `(ADDRESS=(PROTOCOL=TCPS)(HOST=10.0.0.48)(PORT=2484))`, + `(DESCRIPTION=(CONNECT_DATA=(SERVICE_NAME=svc)))`) + if err != nil { + t.Fatalf("second UpdateDatabaseInfoForRedirect: %v", err) + } + info.ResetServerIndex() + if got := info.GetActiveServer(false).TLSHostName(); got != "scan.example.com" { + t.Errorf("TLSHostName after second redirect = %q, want %q", got, "scan.example.com") + } +} + +func TestTLSHostNameDefaultsToAddr(t *testing.T) { + server := ServerAddr{Addr: "10.0.0.42", Port: 2484} + if got := server.TLSHostName(); got != "10.0.0.42" { + t.Errorf("TLSHostName() = %q, want %q", got, "10.0.0.42") + } +} diff --git a/v3/network/session.go b/v3/network/session.go index f603189a..a543f987 100755 --- a/v3/network/session.go +++ b/v3/network/session.go @@ -316,7 +316,9 @@ func (session *Session) negotiate() { host := connOption.GetActiveServer(false) if tlsConfig := connOption.TLSConfig; tlsConfig != nil { - tlsConfig.ServerName = host.Addr + // clone: TLSConfig is shared by all connections of the connector + tlsConfig = tlsConfig.Clone() + tlsConfig.ServerName = host.TLSHostName() sslConn := tls.Client(session.conn, tlsConfig) session.mu.Lock() session.sslConn = sslConn @@ -331,7 +333,7 @@ func (session *Session) negotiate() { } } config := &tls.Config{ - ServerName: host.Addr, + ServerName: host.TLSHostName(), } if len(session.SSL.tlsCertificates) > 0 { config.Certificates = session.SSL.tlsCertificates diff --git a/v3/network/session_tls_test.go b/v3/network/session_tls_test.go new file mode 100644 index 00000000..bcdc8a11 --- /dev/null +++ b/v3/network/session_tls_test.go @@ -0,0 +1,186 @@ +package network + +import ( + "crypto/ecdsa" + "crypto/elliptic" + "crypto/rand" + "crypto/tls" + "crypto/x509" + "crypto/x509/pkix" + "math/big" + "net" + "strings" + "sync" + "testing" + "time" + + "github.com/sijms/go-ora/v3/configurations" + "github.com/sijms/go-ora/v3/trace" +) + +// newTestCertificate returns a CA pool and a server certificate whose only SAN is dnsName. +func newTestCertificate(t *testing.T, dnsName string) (*x509.CertPool, tls.Certificate) { + t.Helper() + caKey, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader) + if err != nil { + t.Fatal(err) + } + caTemplate := &x509.Certificate{ + SerialNumber: big.NewInt(1), + Subject: pkix.Name{CommonName: "test-ca"}, + NotBefore: time.Now().Add(-time.Hour), + NotAfter: time.Now().Add(time.Hour), + IsCA: true, + KeyUsage: x509.KeyUsageCertSign, + BasicConstraintsValid: true, + } + caDER, err := x509.CreateCertificate(rand.Reader, caTemplate, caTemplate, &caKey.PublicKey, caKey) + if err != nil { + t.Fatal(err) + } + caCert, err := x509.ParseCertificate(caDER) + if err != nil { + t.Fatal(err) + } + serverKey, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader) + if err != nil { + t.Fatal(err) + } + serverTemplate := &x509.Certificate{ + SerialNumber: big.NewInt(2), + Subject: pkix.Name{CommonName: dnsName}, + DNSNames: []string{dnsName}, + NotBefore: time.Now().Add(-time.Hour), + NotAfter: time.Now().Add(time.Hour), + KeyUsage: x509.KeyUsageDigitalSignature, + ExtKeyUsage: []x509.ExtKeyUsage{x509.ExtKeyUsageServerAuth}, + } + serverDER, err := x509.CreateCertificate(rand.Reader, serverTemplate, caCert, &serverKey.PublicKey, caKey) + if err != nil { + t.Fatal(err) + } + pool := x509.NewCertPool() + pool.AddCert(caCert) + return pool, tls.Certificate{Certificate: [][]byte{serverDER}, PrivateKey: serverKey} +} + +// handshakeAfterRedirect runs negotiate after a redirect from scan.example.com to 10.0.0.42. +func handshakeAfterRedirect(t *testing.T, certName string, useTLSConfig bool) error { + t.Helper() + pool, serverCert := newTestCertificate(t, certName) + + connOption := &configurations.ConnectionConfig{ + DatabaseInfo: configurations.DatabaseInfo{ + Servers: []configurations.ServerAddr{ + {Protocol: "TCPS", Addr: "scan.example.com", Port: 2484}, + }, + ServiceName: "svc", + }, + SessionInfo: configurations.SessionInfo{ + SessionDataUnitSize: 0xFFFF, + TransportDataUnitSize: 0xFFFF, + SSLVerify: true, + }, + } + if useTLSConfig { + connOption.TLSConfig = &tls.Config{RootCAs: pool} + } + err := connOption.UpdateDatabaseInfoForRedirect( + `(ADDRESS=(PROTOCOL=TCPS)(HOST=10.0.0.42)(PORT=2484))`, + `(DESCRIPTION=(CONNECT_DATA=(SERVICE_NAME=svc)))`) + if err != nil { + t.Fatalf("UpdateDatabaseInfoForRedirect: %v", err) + } + connOption.ResetServerIndex() + + // not net.Pipe: it is unbuffered and deadlocks when the client sends an alert + listener, err := net.Listen("tcp", "127.0.0.1:0") + if err != nil { + t.Fatal(err) + } + defer listener.Close() + go func() { + serverConn, err := listener.Accept() + if err != nil { + return + } + defer serverConn.Close() + _ = tls.Server(serverConn, &tls.Config{Certificates: []tls.Certificate{serverCert}}).Handshake() + }() + clientConn, err := net.Dial("tcp", listener.Addr().String()) + if err != nil { + t.Fatal(err) + } + defer clientConn.Close() + if err := clientConn.SetDeadline(time.Now().Add(10 * time.Second)); err != nil { + t.Fatal(err) + } + + session := NewSession(connOption, trace.NilTracer()) + session.conn = clientConn + session.SSL.roots = pool + session.negotiate() + return session.sslConn.Handshake() +} + +func TestNegotiateVerifiesOriginalHostAfterRedirect(t *testing.T) { + for _, tc := range []struct { + name string + useTLSConfig bool + }{ + {name: "wallet roots", useTLSConfig: false}, + {name: "caller tls.Config", useTLSConfig: true}, + } { + t.Run(tc.name, func(t *testing.T) { + if err := handshakeAfterRedirect(t, "scan.example.com", tc.useTLSConfig); err != nil { + t.Fatalf("TLS handshake after redirect failed: %v", err) + } + }) + } +} + +func TestNegotiateStillVerifiesHostName(t *testing.T) { + err := handshakeAfterRedirect(t, "other.example.com", false) + if err == nil { + t.Fatal("TLS handshake succeeded with a certificate for the wrong host") + } + if !strings.Contains(err.Error(), "scan.example.com") { + t.Errorf("error = %v, want a host name mismatch for scan.example.com", err) + } +} + +func TestNegotiateDoesNotModifyCallerTLSConfig(t *testing.T) { + shared := &tls.Config{} + var wg sync.WaitGroup + for _, addr := range []string{"a.example.com", "b.example.com", "c.example.com", "d.example.com"} { + wg.Add(1) + go func(addr string) { + defer wg.Done() + connOption := &configurations.ConnectionConfig{ + DatabaseInfo: configurations.DatabaseInfo{ + Servers: []configurations.ServerAddr{ + {Protocol: "TCPS", Addr: addr, Port: 2484}, + }, + ServiceName: "svc", + }, + SessionInfo: configurations.SessionInfo{ + SessionDataUnitSize: 0xFFFF, + TransportDataUnitSize: 0xFFFF, + SSLVerify: true, + }, + } + connOption.TLSConfig = shared + connOption.ResetServerIndex() + clientConn, serverConn := net.Pipe() + defer clientConn.Close() + defer serverConn.Close() + session := NewSession(connOption, trace.NilTracer()) + session.conn = clientConn + session.negotiate() + }(addr) + } + wg.Wait() + if shared.ServerName != "" { + t.Errorf("caller tls.Config ServerName = %q, want it left empty", shared.ServerName) + } +}