Skip to content

Commit 5363ac1

Browse files
kylecarbskylecarbs
committed
fix: Replace access URL for built-in DERP servers
Fixes #4195.
1 parent 4054a9c commit 5363ac1

File tree

7 files changed

+114
-21
lines changed

7 files changed

+114
-21
lines changed

‎agent/agent_test.go

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -481,19 +481,6 @@ func TestAgent(t *testing.T) {
481481
}
482482
})
483483

484-
t.Run("Tailnet", func(t *testing.T) {
485-
t.Parallel()
486-
derpMap := tailnettest.RunDERPAndSTUN(t)
487-
conn, _ := setupAgent(t, codersdk.WorkspaceAgentMetadata{
488-
DERPMap: derpMap,
489-
}, 0)
490-
defer conn.Close()
491-
require.Eventually(t, func() bool {
492-
_, err := conn.Ping()
493-
return err == nil
494-
}, testutil.WaitLong, testutil.IntervalFast)
495-
})
496-
497484
t.Run("Speedtest", func(t *testing.T) {
498485
t.Parallel()
499486
if testing.Short() {

‎cli/server.go

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -328,9 +328,10 @@ func Server(newAPI func(context.Context, *coderd.Options) (*coderd.API, error))
328328
}
329329

330330
defaultRegion := &tailcfg.DERPRegion{
331-
RegionID: derpServerRegionID,
332-
RegionCode: derpServerRegionCode,
333-
RegionName: derpServerRegionName,
331+
EmbeddedRelay: true,
332+
RegionID: derpServerRegionID,
333+
RegionCode: derpServerRegionCode,
334+
RegionName: derpServerRegionName,
334335
Nodes: []*tailcfg.DERPNode{{
335336
Name: fmt.Sprintf("%db", derpServerRegionID),
336337
RegionID: derpServerRegionID,

‎coderd/workspaceagents.go

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,9 +226,29 @@ func (api *API) dialWorkspaceAgentTailnet(r *http.Request, agentID uuid.UUID) (*
226226
_ = serverConn.Close()
227227
}()
228228

229+
derpMap := api.DERPMap.Clone()
230+
for _, region := range derpMap.Regions {
231+
if !region.EmbeddedRelay {
232+
continue
233+
}
234+
for _, node := range region.Nodes {
235+
if node.STUNOnly {
236+
continue
237+
}
238+
// TODO: This should dial directly to execute the
239+
// DERP server instead of contacting localhost.
240+
//
241+
// This requires modification of Tailscale internals
242+
// to pipe through a proxy function per-region, so
243+
// this is an easy and mostly reliable hack for now.
244+
node.InsecureForTests = true
245+
node.HostName = "127.0.0.1"
246+
}
247+
}
248+
229249
conn, err := tailnet.NewConn(&tailnet.Options{
230250
Addresses: []netip.Prefix{netip.PrefixFrom(tailnet.IP(), 128)},
231-
DERPMap: api.DERPMap,
251+
DERPMap: derpMap,
232252
Logger: api.Logger.Named("tailnet").Leveled(slog.LevelDebug),
233253
})
234254
if err != nil {

‎codersdk/workspaceagents.go

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import (
1010
"net/http"
1111
"net/http/cookiejar"
1212
"net/netip"
13+
"strconv"
1314
"time"
1415

1516
"cloud.google.com/go/compute/metadata"
@@ -208,7 +209,42 @@ func (c *Client) WorkspaceAgentMetadata(ctx context.Context) (WorkspaceAgentMeta
208209
return WorkspaceAgentMetadata{}, readBodyAsError(res)
209210
}
210211
var agentMetadata WorkspaceAgentMetadata
211-
return agentMetadata, json.NewDecoder(res.Body).Decode(&agentMetadata)
212+
err = json.NewDecoder(res.Body).Decode(&agentMetadata)
213+
if err != nil {
214+
return WorkspaceAgentMetadata{}, err
215+
}
216+
accessingPort := c.URL.Port()
217+
if accessingPort == "" {
218+
accessingPort = "80"
219+
if c.URL.Scheme == "https" {
220+
accessingPort = "443"
221+
}
222+
}
223+
accessPort, err := strconv.Atoi(accessingPort)
224+
if err != nil {
225+
return WorkspaceAgentMetadata{}, xerrors.Errorf("convert accessing port %q: %w", accessingPort, err)
226+
}
227+
// Agents can provide an arbitrary access URL that may be different
228+
// that the globally configured one. This breaks the built-in DERP,
229+
// which would continue to reference the global access URL.
230+
//
231+
// This converts all built-in DERPs to use the access URL that the
232+
// metadata request was performed with.
233+
for _, region := range agentMetadata.DERPMap.Regions {
234+
if !region.EmbeddedRelay {
235+
continue
236+
}
237+
238+
for _, node := range region.Nodes {
239+
if node.STUNOnly {
240+
continue
241+
}
242+
node.HostName = c.URL.Hostname()
243+
node.DERPPort = accessPort
244+
node.ForceHTTP = c.URL.Scheme == "http"
245+
}
246+
}
247+
return agentMetadata, nil
212248
}
213249

214250
func (c *Client) ListenWorkspaceAgentTailnet(ctx context.Context) (net.Conn, error) {

‎codersdk/workspaceagents_test.go

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
package codersdk_test
2+
3+
import (
4+
"context"
5+
"net/http"
6+
"net/http/httptest"
7+
"net/url"
8+
"strconv"
9+
"testing"
10+
11+
"github.com/stretchr/testify/require"
12+
"tailscale.com/tailcfg"
13+
14+
"github.com/coder/coder/coderd/httpapi"
15+
"github.com/coder/coder/codersdk"
16+
)
17+
18+
func TestWorkspaceAgentMetadata(t *testing.T) {
19+
t.Parallel()
20+
// This test ensures that the DERP map returned properly
21+
// mutates built-in DERPs with the client access URL.
22+
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
23+
httpapi.Write(context.Background(), w, http.StatusOK, codersdk.WorkspaceAgentMetadata{
24+
DERPMap: &tailcfg.DERPMap{
25+
Regions: map[int]*tailcfg.DERPRegion{
26+
1: {
27+
EmbeddedRelay: true,
28+
RegionID: 1,
29+
Nodes: []*tailcfg.DERPNode{{
30+
HostName: "bananas.org",
31+
DERPPort: 1,
32+
}},
33+
},
34+
},
35+
},
36+
})
37+
}))
38+
parsed, err := url.Parse(srv.URL)
39+
require.NoError(t, err)
40+
client := codersdk.New(parsed)
41+
metadata, err := client.WorkspaceAgentMetadata(context.Background())
42+
require.NoError(t, err)
43+
region := metadata.DERPMap.Regions[1]
44+
require.True(t, region.EmbeddedRelay)
45+
require.Len(t, region.Nodes, 1)
46+
node := region.Nodes[0]
47+
require.Equal(t, parsed.Hostname(), node.HostName)
48+
require.Equal(t, parsed.Port(), strconv.Itoa(node.DERPPort))
49+
}

‎go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ replace github.com/tcnksm/go-httpstat => github.com/kylecarbs/go-httpstat v0.0.0
4040

4141
// There are a few minor changes we make to Tailscale that we're slowly upstreaming. Compare here:
4242
// https://github.com/tailscale/tailscale/compare/main...coder:tailscale:main
43-
replace tailscale.com => github.com/coder/tailscale v1.1.1-0.20220914175845-85b85d9a52ee
43+
replace tailscale.com => github.com/coder/tailscale v1.1.1-0.20220926024748-50f068456c6c
4444

4545
// Switch to our fork that imports fixes from http://github.com/tailscale/ssh.
4646
// See: https://github.com/coder/coder/issues/3371

‎go.sum

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -349,8 +349,8 @@ github.com/coder/retry v1.3.0 h1:5lAAwt/2Cm6lVmnfBY7sOMXcBOwcwJhmV5QGSELIVWY=
349349
github.com/coder/retry v1.3.0/go.mod h1:tXuRgZgWjUnU5LZPT4lJh4ew2elUhexhlnXzrJWdyFY=
350350
github.com/coder/ssh v0.0.0-20220811105153-fcea99919338 h1:tN5GKFT68YLVzJoA8AHuiMNJ0qlhoD3pGN3JY9gxSko=
351351
github.com/coder/ssh v0.0.0-20220811105153-fcea99919338/go.mod h1:ZSS+CUoKHDrqVakTfTWUlKSr9MtMFkC4UvtQKD7O914=
352-
github.com/coder/tailscale v1.1.1-0.20220914175845-85b85d9a52ee h1:77WUcIAL5FRQtd97/gOV66MJHLPhsPw+3vMxoEvcadI=
353-
github.com/coder/tailscale v1.1.1-0.20220914175845-85b85d9a52ee/go.mod h1:5amxy08qijEa8bcTW2SeIy4MIqcmd7LMsuOxqOlj2Ak=
352+
github.com/coder/tailscale v1.1.1-0.20220926024748-50f068456c6c h1:xa6lr5Pj87Is26tgpzwBsEGKL7aVz7/fRGgY9QIbf3E=
353+
github.com/coder/tailscale v1.1.1-0.20220926024748-50f068456c6c/go.mod h1:5amxy08qijEa8bcTW2SeIy4MIqcmd7LMsuOxqOlj2Ak=
354354
github.com/containerd/aufs v0.0.0-20200908144142-dab0cbea06f4/go.mod h1:nukgQABAEopAHvB6j7cnP5zJ+/3aVcE7hCYqvIwAHyE=
355355
github.com/containerd/aufs v0.0.0-20201003224125-76a6863f2989/go.mod h1:AkGGQs9NM2vtYHaUen+NljV0/baGCAPELGm2q9ZXpWU=
356356
github.com/containerd/aufs v0.0.0-20210316121734-20793ff83c97/go.mod h1:kL5kd6KM5TzQjR79jljyi4olc1Vrx6XBlcyj3gNv2PU=

0 commit comments

Comments
 (0)