Skip to content

Commit

Permalink
fix: use handshake context when possible (#427)
Browse files Browse the repository at this point in the history
Fixes #409.
  • Loading branch information
enocom authored Jan 9, 2023
1 parent 52b7633 commit 37c4e70
Show file tree
Hide file tree
Showing 3 changed files with 92 additions and 10 deletions.
44 changes: 44 additions & 0 deletions connect_tls_117.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//go:build go1.17
// +build go1.17

package cloudsqlconn

import (
"context"
"crypto/tls"
"net"

"cloud.google.com/go/cloudsqlconn/errtype"
"cloud.google.com/go/cloudsqlconn/internal/cloudsql"
)

// connectTLS returns a new TLS client side connection
// using conn as the underlying transport.
//
// The returned connection has already completed its TLS handshake.
func connectTLS(ctx context.Context, conn net.Conn, c *tls.Config, i *cloudsql.Instance) (net.Conn, error) {
tlsConn := tls.Client(conn, c)
// HandshakeContext was introduced in Go 1.17, hence
// this file is conditionally compiled on only Go versions >= 1.17.
if err := tlsConn.HandshakeContext(ctx); err != nil {
// refresh the instance info in case it caused the handshake failure
i.ForceRefresh()
_ = tlsConn.Close() // best effort close attempt
return nil, errtype.NewDialError("handshake failed", i.String(), err)
}
return tlsConn, nil
}
42 changes: 42 additions & 0 deletions connect_tls_other.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//go:build !go1.17
// +build !go1.17

package cloudsqlconn

import (
"context"
"crypto/tls"
"net"

"cloud.google.com/go/cloudsqlconn/errtype"
"cloud.google.com/go/cloudsqlconn/internal/cloudsql"
)

// connectTLS returns a new TLS client side connection
// using conn as the underlying transport.
//
// The returned connection has already completed its TLS handshake.
func connectTLS(_ context.Context, conn net.Conn, c *tls.Config, i *cloudsql.Instance) (net.Conn, error) {
tlsConn := tls.Client(conn, c)
if err := tlsConn.Handshake(); err != nil {
// refresh the instance info in case it caused the handshake failure
i.ForceRefresh()
_ = tlsConn.Close() // best effort close attempt
return nil, errtype.NewDialError("handshake failed", i.String(), err)
}
return tlsConn, nil
}
16 changes: 6 additions & 10 deletions dialer.go
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
// Copyright 2020 Google LLC

//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at

//
// https://www.apache.org/licenses/LICENSE-2.0

//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Expand All @@ -20,7 +20,6 @@ import (
"context"
"crypto/rand"
"crypto/rsa"
"crypto/tls"
_ "embed"
"fmt"
"net"
Expand Down Expand Up @@ -224,12 +223,9 @@ func (d *Dialer) Dial(ctx context.Context, instance string, opts ...DialOption)
return nil, errtype.NewDialError("failed to set keep-alive period", i.String(), err)
}
}
tlsConn := tls.Client(conn, tlsCfg)
if err := tlsConn.Handshake(); err != nil {
// refresh the instance info in case it caused the handshake failure
i.ForceRefresh()
_ = tlsConn.Close() // best effort close attempt
return nil, errtype.NewDialError("handshake failed", i.String(), err)
tlsConn, err := connectTLS(ctx, conn, tlsCfg, i)
if err != nil {
return nil, err
}
latency := time.Since(startTime).Milliseconds()
go func() {
Expand Down

0 comments on commit 37c4e70

Please sign in to comment.