/
module.go
264 lines (223 loc) · 6.31 KB
/
module.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
// Package tscaddy provides a set of Caddy modules to integrate Tailscale into Caddy.
package tscaddy
// module.go contains the Tailscale network listeners for caddy
// as well as some shared logic for registered Tailscale nodes.
import (
"context"
"crypto/tls"
"fmt"
"net"
"os"
"path/filepath"
"strings"
"github.com/caddyserver/caddy/v2"
"go.uber.org/zap"
"tailscale.com/tsnet"
)
func init() {
caddy.RegisterNetwork("tailscale", getPlainListener)
caddy.RegisterNetwork("tailscale+tls", getTLSListener)
}
func getPlainListener(c context.Context, _ string, addr string, _ net.ListenConfig) (any, error) {
ctx, ok := c.(caddy.Context)
if !ok {
return nil, fmt.Errorf("context is not a caddy.Context: %T", c)
}
network, host, port, err := caddy.SplitNetworkAddress(addr)
if err != nil {
return nil, err
}
s, err := getNode(ctx, host)
if err != nil {
return nil, err
}
if network == "" {
network = "tcp"
}
return s.Listen(network, ":"+port)
}
func getTLSListener(c context.Context, _ string, addr string, _ net.ListenConfig) (any, error) {
ctx, ok := c.(caddy.Context)
if !ok {
return nil, fmt.Errorf("context is not a caddy.Context: %T", c)
}
network, host, port, err := caddy.SplitNetworkAddress(addr)
if err != nil {
return nil, err
}
s, err := getNode(ctx, host)
if err != nil {
return nil, err
}
if network == "" {
network = "tcp"
}
ln, err := s.Listen(network, ":"+port)
if err != nil {
return nil, err
}
localClient, _ := s.LocalClient()
ln = tls.NewListener(ln, &tls.Config{
GetCertificate: localClient.GetCertificate,
})
return ln, nil
}
// nodes are the Tailscale nodes that have been configured and started.
// Node configuration comes from the global Tailscale Caddy app.
// When nodes are no longer in used (e.g. all listeners have been closed), they are shutdown.
//
// Callers should use getNode() to get a node by name, rather than accessing this pool directly.
var nodes = caddy.NewUsagePool()
// getNode returns a tailscale node for Caddy apps to interface with.
//
// The specified name will be used to lookup the node configuration from the tailscale caddy app,
// used to register the node the first time it is used.
// Only one tailscale node is created per name, even if multiple listeners are created for the node.
func getNode(ctx caddy.Context, name string) (*tailscaleNode, error) {
appIface, err := ctx.App("tailscale")
if err != nil {
return nil, err
}
app := appIface.(*App)
s, _, err := nodes.LoadOrNew(name, func() (caddy.Destructor, error) {
s := &tsnet.Server{
Logf: func(format string, args ...any) {
app.logger.Sugar().Debugf(format, args...)
},
UserLogf: func(format string, args ...any) {
app.logger.Sugar().Infof(format, args...)
},
Ephemeral: getEphemeral(name, app),
RunWebClient: getWebUI(name, app),
}
if s.AuthKey, err = getAuthKey(name, app); err != nil {
return nil, err
}
if s.ControlURL, err = getControlURL(name, app); err != nil {
return nil, err
}
if s.Hostname, err = getHostname(name, app); err != nil {
return nil, err
}
if s.Dir, err = getStateDir(name, app); err != nil {
return nil, err
}
if err := os.MkdirAll(s.Dir, 0700); err != nil {
return nil, err
}
return &tailscaleNode{
s,
}, nil
})
if err != nil {
return nil, err
}
return s.(*tailscaleNode), nil
}
var repl = caddy.NewReplacer()
func getAuthKey(name string, app *App) (string, error) {
if node, ok := app.Nodes[name]; ok {
if node.AuthKey != "" {
return repl.ReplaceOrErr(node.AuthKey, true, true)
}
}
if app.DefaultAuthKey != "" {
return repl.ReplaceOrErr(app.DefaultAuthKey, true, true)
}
// Set authkey to "TS_AUTHKEY_<HOST>".
// If empty, fall back to "TS_AUTHKEY".
authKey := os.Getenv("TS_AUTHKEY_" + strings.ToUpper(name))
if authKey != "" {
app.logger.Warn("Relying on TS_AUTHKEY_{HOST} env var is deprecated. Set caddy config instead.", zap.Any("host", name))
return authKey, nil
}
return os.Getenv("TS_AUTHKEY"), nil
}
func getControlURL(name string, app *App) (string, error) {
if node, ok := app.Nodes[name]; ok {
if node.ControlURL != "" {
return repl.ReplaceOrErr(node.ControlURL, true, true)
}
}
return repl.ReplaceOrErr(app.ControlURL, true, true)
}
func getEphemeral(name string, app *App) bool {
if node, ok := app.Nodes[name]; ok {
if v, ok := node.Ephemeral.Get(); ok {
return v
}
}
return app.Ephemeral
}
func getHostname(name string, app *App) (string, error) {
if app == nil {
return name, nil
}
if node, ok := app.Nodes[name]; ok {
if node.Hostname != "" {
return repl.ReplaceOrErr(node.Hostname, true, true)
}
}
return name, nil
}
func getStateDir(name string, app *App) (string, error) {
if node, ok := app.Nodes[name]; ok {
if node.StateDir != "" {
return repl.ReplaceOrErr(node.StateDir, true, true)
}
}
if app.StateDir != "" {
s, err := repl.ReplaceOrErr(app.StateDir, true, true)
if err != nil {
return "", err
}
return filepath.Join(s, name), nil
}
// By default, tsnet will use the name of the running program in the state directory,
// but we also include the hostname so that a single caddy instance can have multiple nodes.
configDir, err := os.UserConfigDir()
if err != nil {
return "", err
}
return filepath.Join(configDir, "tsnet-caddy-"+name), nil
}
func getWebUI(name string, app *App) bool {
if node, ok := app.Nodes[name]; ok {
if v, ok := node.WebUI.Get(); ok {
return v
}
}
return app.WebUI
}
// tailscaleNode is a wrapper around a tsnet.Server that provides a fully self-contained Tailscale node.
// This node can listen on the tailscale network interface, or be used to connect to other nodes in the tailnet.
type tailscaleNode struct {
*tsnet.Server
}
func (t tailscaleNode) Destruct() error {
return t.Close()
}
func (t *tailscaleNode) Listen(network string, addr string) (net.Listener, error) {
ln, err := t.Server.Listen(network, addr)
if err != nil {
return nil, err
}
serverListener := &tsnetServerListener{
name: t.Hostname,
Listener: ln,
}
return serverListener, nil
}
type tsnetServerListener struct {
name string
net.Listener
}
func (t *tsnetServerListener) Close() error {
if err := t.Listener.Close(); err != nil {
return err
}
// Decrement usage count of this node.
// If usage reaches zero, then the node is actually shutdown.
_, err := nodes.Delete(t.name)
return err
}