Skip to content
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.

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

Add logging for attempted and successful TLS connections to server #1486

Merged
merged 4 commits into from
Apr 23, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions common/auth/tlsConfigHelper.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ package auth
import (
"crypto/tls"
"crypto/x509"

"go.temporal.io/server/common/log"
"go.temporal.io/server/common/log/tag"
)

// Helper methods for creating tls.Config structs to ensure MinVersion is 1.3
Expand Down Expand Up @@ -72,10 +75,15 @@ func NewTLSConfigWithCertsAndCAs(
clientAuth tls.ClientAuthType,
certificates []tls.Certificate,
clientCAs *x509.CertPool,
logger log.Logger,
) *tls.Config {
c := NewEmptyTLSConfig()
c.ClientAuth = clientAuth
c.Certificates = certificates
c.ClientCAs = clientCAs
c.VerifyConnection = func(state tls.ConnectionState) error {
logger.Info("successfully established incoming TLS connection", tag.HostID(state.ServerName))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we think this should be Debug level log to avoid spamming if there are a lot of incoming connections? Or is Info fine?

return nil
}
return c
}
32 changes: 24 additions & 8 deletions common/rpc/encryption/localStoreTlsProvider.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import (
"time"

"github.com/uber-go/tally"
"go.temporal.io/server/common/log/tag"

"go.temporal.io/server/common/auth"
"go.temporal.io/server/common/config"
Expand Down Expand Up @@ -154,7 +155,7 @@ func (s *localStoreTlsProvider) GetFrontendServerConfig() (*tls.Config, error) {
return s.getOrCreateConfig(
&s.cachedFrontendServerConfig,
func() (*tls.Config, error) {
return newServerTLSConfig(s.frontendCertProvider, s.frontendPerHostCertProviderMap, &s.settings.Frontend)
return newServerTLSConfig(s.frontendCertProvider, s.frontendPerHostCertProviderMap, &s.settings.Frontend, s.logger)
},
s.settings.Frontend.IsEnabled())
}
Expand All @@ -163,7 +164,7 @@ func (s *localStoreTlsProvider) GetInternodeServerConfig() (*tls.Config, error)
return s.getOrCreateConfig(
&s.cachedInternodeServerConfig,
func() (*tls.Config, error) {
return newServerTLSConfig(s.internodeCertProvider, nil, &s.settings.Internode)
return newServerTLSConfig(s.internodeCertProvider, nil, &s.settings.Internode, s.logger)
},
s.settings.Internode.IsEnabled())
}
Expand Down Expand Up @@ -238,32 +239,45 @@ func newServerTLSConfig(
certProvider CertProvider,
perHostCertProviderMap PerHostCertProviderMap,
config *config.GroupTLS,
logger log.Logger,
) (*tls.Config, error) {

clientAuthRequired := config.Server.RequireClientAuth
tlsConfig, err := getServerTLSConfigFromCertProvider(certProvider, clientAuthRequired)
tlsConfig, err := getServerTLSConfigFromCertProvider(certProvider, clientAuthRequired, "", logger)
mastermanu marked this conversation as resolved.
Show resolved Hide resolved
if err != nil {
return nil, err
}

tlsConfig.GetConfigForClient = func(c *tls.ClientHelloInfo) (*tls.Config, error) {

remoteAddress := c.Conn.RemoteAddr().String()
logger.Info("attempted incoming TLS connection", tag.Address(remoteAddress), tag.HostID(c.ServerName))
mastermanu marked this conversation as resolved.
Show resolved Hide resolved

if perHostCertProviderMap != nil {
perHostCertProvider, hostClientAuthRequired, err := perHostCertProviderMap.GetCertProvider(c.ServerName)
if err != nil {
logger.Warn("cannot find a per-host provider for attempted incoming TLS connection",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to log the error here?

tag.HostID(c.ServerName), tag.Address(remoteAddress))
return nil, err
}

if perHostCertProvider != nil {
return getServerTLSConfigFromCertProvider(perHostCertProvider, hostClientAuthRequired)
return getServerTLSConfigFromCertProvider(perHostCertProvider, hostClientAuthRequired, remoteAddress, logger)
}
return getServerTLSConfigFromCertProvider(certProvider, clientAuthRequired)
return getServerTLSConfigFromCertProvider(certProvider, clientAuthRequired, remoteAddress, logger)
}
return getServerTLSConfigFromCertProvider(certProvider, clientAuthRequired)
return getServerTLSConfigFromCertProvider(certProvider, clientAuthRequired, remoteAddress, logger)
mastermanu marked this conversation as resolved.
Show resolved Hide resolved
}

return tlsConfig, nil
}

func getServerTLSConfigFromCertProvider(certProvider CertProvider, requireClientAuth bool) (*tls.Config, error) {
func getServerTLSConfigFromCertProvider(
certProvider CertProvider,
requireClientAuth bool,
remoteAddress string,
logger log.Logger) (*tls.Config, error) {

// Get serverCert from disk
serverCert, err := certProvider.FetchServerCertificate()
if err != nil {
Expand All @@ -290,10 +304,12 @@ func getServerTLSConfigFromCertProvider(certProvider CertProvider, requireClient

clientCaPool = ca
}
logger.Info("returning TLS config for connection", tag.Address(remoteAddress))
return auth.NewTLSConfigWithCertsAndCAs(
clientAuthType,
[]tls.Certificate{*serverCert},
clientCaPool), nil
clientCaPool,
logger), nil
}

func newClientTLSConfig(clientProvider CertProvider, serverName string, isAuthRequired bool,
Expand Down
8 changes: 6 additions & 2 deletions common/rpc/encryption/testDynamicTLSConfigProvider.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import (
"time"

"go.temporal.io/server/common/config"
"go.temporal.io/server/common/log"
)

type TestDynamicTLSConfigProvider struct {
Expand All @@ -47,18 +48,20 @@ type TestDynamicTLSConfigProvider struct {
internodeClientConfig *tls.Config
frontendServerConfig *tls.Config
frontendClientConfig *tls.Config

logger log.Logger
}

func (t *TestDynamicTLSConfigProvider) GetInternodeServerConfig() (*tls.Config, error) {
return newServerTLSConfig(t.InternodeCertProvider, nil, &t.settings.Internode)
return newServerTLSConfig(t.InternodeCertProvider, nil, &t.settings.Internode, t.logger)
}

func (t *TestDynamicTLSConfigProvider) GetInternodeClientConfig() (*tls.Config, error) {
return newClientTLSConfig(t.InternodeClientCertProvider, t.settings.Internode.Client.ServerName, true, false, true)
}

func (t *TestDynamicTLSConfigProvider) GetFrontendServerConfig() (*tls.Config, error) {
return newServerTLSConfig(t.FrontendCertProvider, t.FrontendPerHostCertProviderMap, &t.settings.Frontend)
return newServerTLSConfig(t.FrontendCertProvider, t.FrontendPerHostCertProviderMap, &t.settings.Frontend, t.logger)
}

func (t *TestDynamicTLSConfigProvider) GetFrontendClientConfig() (*tls.Config, error) {
Expand Down Expand Up @@ -91,5 +94,6 @@ func NewTestDynamicTLSConfigProvider(
WorkerCertProvider: frontendProvider,
FrontendPerHostCertProviderMap: frontendProvider,
settings: tlsConfig,
logger: log.NewDefaultLogger(),
}, nil
}