-
Notifications
You must be signed in to change notification settings - Fork 11
/
dial.go
352 lines (289 loc) · 11.5 KB
/
dial.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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
// Copyright (C) 2019 Storj Labs, Inc.
// See LICENSE for copying information.
package rpc
import (
"context"
"crypto/tls"
"fmt"
"net"
"time"
"github.com/jtolio/noiseconn"
"github.com/zeebo/errs"
"storj.io/common/experiment"
"storj.io/common/pb"
"storj.io/common/peertls/tlsopts"
"storj.io/common/rpc/noise"
"storj.io/common/rpc/rpcpool"
"storj.io/common/rpc/rpctracing"
"storj.io/common/storj"
"storj.io/drpc/drpcconn"
"storj.io/drpc/drpcmanager"
"storj.io/drpc/drpcmigrate"
"storj.io/drpc/drpcstream"
)
// NewDefaultManagerOptions returns the default options we use for drpc managers.
func NewDefaultManagerOptions() drpcmanager.Options {
return drpcmanager.Options{
SoftCancel: true,
WriterBufferSize: 64 * 1000, // we want to stay under 64*1024 + some headroom.
Stream: drpcstream.Options{
SplitSize: (4096 * 2) - 256,
},
// TODO: bring back inactivity timeouts once more clients support closed
// connections more robustly. once we do bring it back, it should probably
// be long enough to account for a full segment upload to nodes in most
// cases (the satellite conn will be inactive while uploading to storage
// nodes). Maybe this should be a couple of minutes at least?
InactivityTimeout: -1,
}
}
// Dialer holds configuration for dialing.
type Dialer struct {
// TLSOptions controls the tls options for dialing with NodeID verification.
// If it is nil, only insecure connections can be made.
TLSOptions *tlsopts.Options
// Override system TLS settings when using hostname verification
HostnameTLSConfig *tls.Config
// DialTimeout causes all the tcp dials to error if they take longer
// than it if it is non-zero.
DialTimeout time.Duration
// DialLatency sleeps this amount if it is non-zero before every dial.
// The timeout runs while the sleep is happening.
DialLatency time.Duration
// Pool is the shared connection pool for this dialer.
Pool *rpcpool.Pool
// ConnectionOptions controls the options that we pass to drpc connections.
ConnectionOptions drpcconn.Options
// AttemptBackgroundQoS controls whether QoS flags will be set on connection packets.
AttemptBackgroundQoS bool
// Connector is how sockets are opened. If nil, net.Dialer is used.
Connector Connector
}
// NewDefaultDialer returns a Dialer with default options set.
func NewDefaultDialer(tlsOptions *tlsopts.Options) Dialer {
return Dialer{
TLSOptions: tlsOptions,
DialTimeout: 20 * time.Second,
ConnectionOptions: drpcconn.Options{
Manager: NewDefaultManagerOptions(),
},
Connector: NewHybridConnector(),
}
}
// NewDefaultPooledDialer returns a Dialer with default options set and a
// long lived dialer shared connection pool. This is appropriate for longer
// lived processes with more resources.
func NewDefaultPooledDialer(tlsOptions *tlsopts.Options) Dialer {
dialer := NewDefaultDialer(tlsOptions)
dialer.Pool = NewDefaultConnectionPool()
return dialer
}
// NewDefaultConnectionPool returns a rpc Pool with default options set.
func NewDefaultConnectionPool() *rpcpool.Pool {
return rpcpool.New(rpcpool.Options{
Capacity: 100,
KeyCapacity: 5,
IdleExpiration: 2 * time.Minute,
})
}
//
// dialing APIs
//
// DialOptions provides a set of options around how to contact nodes.
type DialOptions struct {
ReplaySafe bool
// ForceTCPFastOpenMultidialSupport, if true, tells the dialer that TCP_FASTOPEN
// multidialing should be considered for this node, even if the nodeURL doesn't
// have a debounce limit set. This does not mean that TCP_FASTOPEN or multidialing
// will definitely be used, but it will be considered.
ForceTCPFastOpenMultidialSupport bool
}
var monDialNodeTask = mon.Task()
// DialNode dials to the specified node url using the provided options and asserts it has the given node id.
func (d Dialer) DialNode(ctx context.Context, nodeURL storj.NodeURL, opts DialOptions) (_ *Conn, err error) {
defer monDialNodeTask(&ctx, "node: "+nodeURL.String())(&err)
setCtx := func(ctx context.Context) context.Context {
ctx = setQUICRollout(ctx, nodeURL)
if opts.ForceTCPFastOpenMultidialSupport ||
(nodeURL.DebounceLimit >= 2 && (nodeURL.Features&uint64(pb.NodeAddress_TCP_FASTOPEN_ENABLED) != 0)) {
ctx = context.WithValue(ctx, ctxKeyTCPFastOpenMultidial{}, true)
}
if d.AttemptBackgroundQoS {
ctx = context.WithValue(ctx, ctxKeyBackgroundQoS{}, true)
}
return ctx
}
// check for a quic rollout or a forced choice
useQuic := checkQUICRolloutState(ctx, nodeURL.ID)
forcedKind, _ := ctx.Value(hybridConnectorForcedKind{}).(string)
// we don't use noise if the kind is already forced, or Quic is requested with rollout
if forcedKind == "" && !useQuic && opts.ReplaySafe && nodeURL.NoiseInfo != (storj.NoiseInfo{}) {
key := fmt.Sprintf("node+noise:%s", nodeURL)
return d.dialPool(ctx, key, func(ctx context.Context) (rpcpool.RawConn, *tls.ConnectionState, error) {
return d.dialNoiseConn(setCtx(ctx), nodeURL.Address, nodeURL.NoiseInfo)
})
}
// no pre-defined preference, no Quic rollout, no noise --> TCP is the only option
if !useQuic && forcedKind == "" {
ctx = WithForcedKind(ctx, "tcp")
}
if d.TLSOptions == nil {
return nil, Error.New("tls options not set when required for this dial")
}
return d.dialPool(ctx, "node:"+nodeURL.ID.String(), func(ctx context.Context) (rpcpool.RawConn, *tls.ConnectionState, error) {
return d.dialEncryptedConn(setCtx(ctx), nodeURL.Address, d.TLSOptions.ClientTLSConfig(nodeURL.ID))
})
}
// DialNodeURL dials to the specified node url and asserts it has the given node id.
func (d Dialer) DialNodeURL(ctx context.Context, nodeURL storj.NodeURL) (_ *Conn, err error) {
return d.DialNode(ctx, nodeURL, DialOptions{})
}
// DialAddressInsecure dials to the specified address and does not check the node id.
func (d Dialer) DialAddressInsecure(ctx context.Context, address string) (_ *Conn, err error) {
defer mon.Task()(&ctx)(&err)
if d.TLSOptions == nil {
return nil, Error.New("tls options not set when required for this dial")
}
return d.dialPool(ctx, "insecure:"+address, func(ctx context.Context) (rpcpool.RawConn, *tls.ConnectionState, error) {
// check for a quic rollout, and if not, force tcp.
ctx = setQUICRollout(ctx, storj.NodeURL{})
return d.dialEncryptedConn(ctx, address, d.TLSOptions.UnverifiedClientTLSConfig())
})
}
// DialAddressHostnameVerification dials to the specified address and assumes that the
// server will valdiate their hostname with the system/browser CA, unless overridden.
// It ignores any TLSOptions set on the dialer.
func (d Dialer) DialAddressHostnameVerification(ctx context.Context, address string) (_ *Conn, err error) {
defer mon.Task()(&ctx)(&err)
// clear out TLS options so that the cache does not include it as part of the key.
d.TLSOptions = nil
var tlsConfig *tls.Config
if d.HostnameTLSConfig == nil {
tlsConfig = new(tls.Config)
} else {
// clone for thread safety
tlsConfig = d.HostnameTLSConfig.Clone()
}
if tlsConfig.ServerName == "" {
host, _, err := net.SplitHostPort(address)
if err != nil {
return nil, Error.Wrap(err)
}
tlsConfig.ServerName = host
}
return d.dialPool(ctx, "hostname:"+address, func(ctx context.Context) (rpcpool.RawConn, *tls.ConnectionState, error) {
// check for a quic rollout, and if not, force tcp.
ctx = setQUICRollout(ctx, storj.NodeURL{})
return d.dialEncryptedConn(ctx, address, tlsConfig)
})
}
// DialAddressUnencrypted dials to the specified address without tls.
func (d Dialer) DialAddressUnencrypted(ctx context.Context, address string) (_ *Conn, err error) {
defer mon.Task()(&ctx)(&err)
// clear out TLS options so that the cache does not include it as part of the key.
d.TLSOptions = nil
return d.dialPool(ctx, "unencrypted:"+address, func(ctx context.Context) (rpcpool.RawConn, *tls.ConnectionState, error) {
// check for a quic rollout, and if not, force tcp.
ctx = setQUICRollout(ctx, storj.NodeURL{})
return d.dialUnencryptedConn(ctx, address)
})
}
//
// dialing helper functions
//
var monDialPoolTask = mon.Task()
// dialPool dials through the connection pool, reusing a connection if possible based on the
// key and calling the dialer if necessary.
func (d Dialer) dialPool(ctx context.Context, key string, dialer rpcpool.Dialer) (_ *Conn, err error) {
defer monDialPoolTask(&ctx)(&err)
// include the timeout here so that it includes all aspects of the dial
if d.DialTimeout > 0 {
var cancel func()
ctx, cancel = context.WithTimeout(ctx, d.DialTimeout)
defer cancel()
}
conn, err := d.Pool.Get(ctx, key, d.TLSOptions, rpcpool.WrapDialer(ctx, dialer))
if err != nil {
return nil, errs.Wrap(err)
}
return &Conn{
Conn: experiment.NewConnWrapper(rpctracing.NewTracingWrapper(conn)),
}, nil
}
// dialEncryptedConn performs dialing to the drpc endpoint with tls.
func (d Dialer) dialEncryptedConn(ctx context.Context, address string, tlsConfig *tls.Config) (_ *drpcconn.Conn, _ *tls.ConnectionState, err error) {
defer mon.Task()(&ctx)(&err)
if d.DialLatency > 0 {
timer := time.NewTimer(d.DialLatency)
select {
case <-timer.C:
case <-ctx.Done():
timer.Stop()
return nil, nil, Error.Wrap(ctx.Err())
}
}
conn, err := d.Connector.DialContext(ctx, tlsConfig, address)
if err != nil {
return nil, nil, Error.Wrap(err)
}
state := conn.ConnectionState()
return drpcconn.NewWithOptions(conn, d.ConnectionOptions), &state, nil
}
type unencryptedConnector interface {
DialContextUnencrypted(context.Context, string) (net.Conn, error)
DialContextUnencryptedUnprefixed(context.Context, string) (net.Conn, error)
}
// dialUnencryptedConn performs dialing to the drpc endpoint with no tls.
func (d Dialer) dialUnencryptedConn(ctx context.Context, address string) (_ *drpcconn.Conn, _ *tls.ConnectionState, err error) {
defer mon.Task()(&ctx)(&err)
if d.DialLatency > 0 {
timer := time.NewTimer(d.DialLatency)
select {
case <-timer.C:
case <-ctx.Done():
timer.Stop()
return nil, nil, Error.Wrap(ctx.Err())
}
}
if unencConnector, ok := d.Connector.(unencryptedConnector); ok {
// make sure multidialing doesn't happen.
ctx = context.WithValue(ctx, ctxKeyTCPFastOpenMultidial{}, false)
// open the tcp socket to the address
conn, err := unencConnector.DialContextUnencrypted(ctx, address)
if err != nil {
return nil, nil, Error.Wrap(err)
}
return drpcconn.NewWithOptions(conn, d.ConnectionOptions), nil, nil
}
return nil, nil, Error.New("unsupported transport type: %T, use TCPConnector", d.Connector)
}
// dialNoiseConn performs dialing to the drpc endpoint with noise.
func (d Dialer) dialNoiseConn(ctx context.Context, address string, noiseInfo storj.NoiseInfo) (_ *drpcconn.Conn, _ *tls.ConnectionState, err error) {
defer mon.Task()(&ctx)(&err)
if d.DialLatency > 0 {
timer := time.NewTimer(d.DialLatency)
select {
case <-timer.C:
case <-ctx.Done():
timer.Stop()
return nil, nil, Error.Wrap(ctx.Err())
}
}
if unencConnector, ok := d.Connector.(unencryptedConnector); ok {
// open the tcp socket to the address
conn, err := unencConnector.DialContextUnencryptedUnprefixed(ctx, address)
if err != nil {
return nil, nil, Error.Wrap(err)
}
noiseCfg, err := noise.GenerateInitiatorConf(pb.NoiseInfoConvert(noiseInfo))
if err != nil {
return nil, nil, Error.Wrap(errs.Combine(err, conn.Close()))
}
nconn, err := noiseconn.NewConn(drpcmigrate.NewHeaderConn(conn, noise.Header), noiseCfg)
if err != nil {
return nil, nil, Error.Wrap(errs.Combine(err, conn.Close()))
}
return drpcconn.NewWithOptions(nconn, d.ConnectionOptions), nil, nil
}
return nil, nil, Error.New("unsupported transport type: %T, use TCPConnector", d.Connector)
}