From b7f40c8d6a5cba902f89515a9c96f85e7ad6d9b3 Mon Sep 17 00:00:00 2001 From: Tim Ross Date: Mon, 6 Dec 2021 15:54:53 -0500 Subject: [PATCH] Prevent infinite dialing of Auth NewHTTPClient was not calling CheckAndSetDefault on the provided client.Config which allowed the DialTimeout to be 0. This allowed dialing auth to hang forever if auth is unreachable. Fixes #8866 --- lib/auth/clt.go | 4 +++ lib/auth/clt_test.go | 62 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 66 insertions(+) create mode 100644 lib/auth/clt_test.go diff --git a/lib/auth/clt.go b/lib/auth/clt.go index 66dcde8eada9d..40da91c8f5e34 100644 --- a/lib/auth/clt.go +++ b/lib/auth/clt.go @@ -119,6 +119,10 @@ type HTTPClient struct { // NewHTTPClient creates a new HTTP client with TLS authentication and the given dialer. func NewHTTPClient(cfg client.Config, tls *tls.Config, params ...roundtrip.ClientParam) (*HTTPClient, error) { + if err := cfg.CheckAndSetDefaults(); err != nil { + return nil, err + } + dialer := cfg.Dialer if dialer == nil { if len(cfg.Addrs) == 0 { diff --git a/lib/auth/clt_test.go b/lib/auth/clt_test.go new file mode 100644 index 0000000000000..b3f7d3853d855 --- /dev/null +++ b/lib/auth/clt_test.go @@ -0,0 +1,62 @@ +/* +Copyright 2021 Gravitational, Inc. + +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 + + http://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. +*/ + +package auth + +import ( + "crypto/tls" + "testing" + "time" + + apiclient "github.com/gravitational/teleport/api/client" + "github.com/gravitational/teleport/lib/session" + "github.com/stretchr/testify/require" +) + +func TestClient_DialTimeout(t *testing.T) { + cases := []struct { + desc string + timeout time.Duration + }{ + { + desc: "dial timeout set to valid value", + timeout: 1 * time.Second, + }, + { + desc: "defaults prevent infinite timeout", + }, + } + + for _, tt := range cases { + t.Run(tt.desc, func(t *testing.T) { + t.Parallel() + + // create a client that will attempt to connect a blackholed address. The address is reserved + // for benchmarking by RFC 6890. + clt, err := NewClient(apiclient.Config{ + DialTimeout: tt.timeout, + Addrs: []string{"198.18.0.254:1234"}, + Credentials: []apiclient.Credentials{ + apiclient.LoadTLS(&tls.Config{}), + }, + }) + require.NoError(t, err) + + // try to create a session - this will timeout after the DialTimeout threshold is exceeded + require.Error(t, clt.CreateSession(session.Session{Namespace: "test"})) + }) + } +}