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
|
package client
import (
"context"
"crypto/tls"
"fmt"
"net"
"net/url"
"time"
"gitlab.com/gitlab-org/gitaly/internal/backchannel"
gitaly_x509 "gitlab.com/gitlab-org/gitaly/internal/x509"
grpccorrelation "gitlab.com/gitlab-org/labkit/correlation/grpc"
grpctracing "gitlab.com/gitlab-org/labkit/tracing/grpc"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials"
"google.golang.org/grpc/keepalive"
)
type connectionType int
const (
invalidConnection connectionType = iota
tcpConnection
tlsConnection
unixConnection
)
func getConnectionType(rawAddress string) connectionType {
u, err := url.Parse(rawAddress)
if err != nil {
return invalidConnection
}
switch u.Scheme {
case "tls":
return tlsConnection
case "unix":
return unixConnection
case "tcp":
return tcpConnection
default:
return invalidConnection
}
}
// Handshaker is an interface that allows for wrapping the transport credentials
// with a custom handshake.
type Handshaker interface {
// ClientHandshake wraps the provided credentials and returns new credentials.
ClientHandshake(credentials.TransportCredentials) credentials.TransportCredentials
}
// Dial dials a Gitaly node serving at the given address. Dial is used by the public 'client' package
// and the expected behavior is mostly documented there.
//
// If handshaker is provided, it's passed the transport credentials which would be otherwise set. The transport credentials
// returned by handshaker are then set instead.
func Dial(ctx context.Context, rawAddress string, connOpts []grpc.DialOption, handshaker Handshaker) (*grpc.ClientConn, error) {
var canonicalAddress string
var err error
var transportCredentials credentials.TransportCredentials
switch getConnectionType(rawAddress) {
case invalidConnection:
return nil, fmt.Errorf("invalid connection string: %q", rawAddress)
case tlsConnection:
canonicalAddress, err = extractHostFromRemoteURL(rawAddress) // Ensure the form: "host:port" ...
if err != nil {
return nil, fmt.Errorf("failed to extract host for 'tls' connection: %w", err)
}
certPool, err := gitaly_x509.SystemCertPool()
if err != nil {
return nil, fmt.Errorf("failed to get system certificat pool for 'tls' connection: %w", err)
}
transportCredentials = credentials.NewTLS(&tls.Config{
RootCAs: certPool,
MinVersion: tls.VersionTLS12,
})
case tcpConnection:
canonicalAddress, err = extractHostFromRemoteURL(rawAddress) // Ensure the form: "host:port" ...
if err != nil {
return nil, fmt.Errorf("failed to extract host for 'tcp' connection: %w", err)
}
case unixConnection:
canonicalAddress = rawAddress // This will be overridden by the custom dialer...
connOpts = append(
connOpts,
// Use a custom dialer to ensure that we don't experience
// issues in environments that have proxy configurations
// https://gitlab.com/gitlab-org/gitaly/merge_requests/1072#note_140408512
grpc.WithContextDialer(func(ctx context.Context, addr string) (conn net.Conn, err error) {
path, err := extractPathFromSocketURL(addr)
if err != nil {
return nil, fmt.Errorf("failed to extract host for 'unix' connection: %w", err)
}
d := net.Dialer{}
return d.DialContext(ctx, "unix", path)
}),
)
}
if handshaker != nil {
if transportCredentials == nil {
transportCredentials = backchannel.Insecure()
}
transportCredentials = handshaker.ClientHandshake(transportCredentials)
}
if transportCredentials == nil {
connOpts = append(connOpts, grpc.WithInsecure())
} else {
connOpts = append(connOpts, grpc.WithTransportCredentials(transportCredentials))
}
connOpts = append(connOpts,
// grpc.KeepaliveParams must be specified at least as large as what is allowed by the
// server-side grpc.KeepaliveEnforcementPolicy
grpc.WithKeepaliveParams(keepalive.ClientParameters{
Time: 20 * time.Second,
PermitWithoutStream: true,
}),
UnaryInterceptor(),
grpc.WithChainStreamInterceptor(
grpctracing.StreamClientTracingInterceptor(),
grpccorrelation.StreamClientCorrelationInterceptor(),
),
)
conn, err := grpc.DialContext(ctx, canonicalAddress, connOpts...)
if err != nil {
return nil, fmt.Errorf("failed to dial %q connection: %w", canonicalAddress, err)
}
return conn, nil
}
// UnaryInterceptor returns the unary interceptors that should be configured for a client.
func UnaryInterceptor() grpc.DialOption {
return grpc.WithChainUnaryInterceptor(
grpctracing.UnaryClientTracingInterceptor(),
grpccorrelation.UnaryClientCorrelationInterceptor(),
)
}
|
