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

Expose TLS connection state when possible #996

Merged
merged 1 commit into from Jun 10, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
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
19 changes: 19 additions & 0 deletions nats.go
Expand Up @@ -168,6 +168,7 @@ var (
ErrStreamNameAlreadyInUse = errors.New("nats: stream name already in use")
ErrMaxConnectionsExceeded = errors.New("nats: server maximum connections exceeded")
ErrBadRequest = errors.New("nats: bad request")
ErrConnectionNotTLS = errors.New("nats: connection is not tls")
)

func init() {
Expand Down Expand Up @@ -1807,6 +1808,24 @@ func (nc *Conn) makeTLSConn() error {
return nil
}

// TLSConnectionState retrieves the state of the TLS connection to the server
func (nc *Conn) TLSConnectionState() (tls.ConnectionState, error) {
derekcollison marked this conversation as resolved.
Show resolved Hide resolved
if !nc.isConnected() {
return tls.ConnectionState{}, ErrDisconnected
}

nc.mu.RLock()
conn := nc.conn
nc.mu.RUnlock()

tc, ok := conn.(*tls.Conn)
if !ok {
return tls.ConnectionState{}, ErrConnectionNotTLS
}

return tc.ConnectionState(), nil
}

// waitForExits will wait for all socket watcher Go routines to
// be shutdown before proceeding.
func (nc *Conn) waitForExits() {
Expand Down
13 changes: 13 additions & 0 deletions test/basic_test.go
Expand Up @@ -110,6 +110,19 @@ func TestLeakingGoRoutinesOnFailedConnect(t *testing.T) {
checkNoGoroutineLeak(t, base, "failed connect")
}

func TestTLSConnectionStateNonTLS(t *testing.T) {
s := RunDefaultServer()
defer s.Shutdown()

nc := NewDefaultConnection(t)
defer nc.Close()

_, err := nc.TLSConnectionState()
if err != nats.ErrConnectionNotTLS {
t.Fatalf("Expected a not tls error, got: %v", err)
}
}

func TestConnectedServer(t *testing.T) {
s := RunDefaultServer()
defer s.Shutdown()
Expand Down
8 changes: 8 additions & 0 deletions test/conn_test.go
Expand Up @@ -161,6 +161,14 @@ func TestServerSecureConnections(t *testing.T) {
}
nc.Flush()

state, err := nc.TLSConnectionState()
if err != nil {
t.Fatalf("Expected connection state: %v", err)
}
if !state.HandshakeComplete {
t.Fatalf("Expected valid connection state")
}

if err := Wait(checkRecv); err != nil {
t.Fatal("Failed receiving message")
}
Expand Down