forked from cockroachdb/cockroach
/
config.go
301 lines (257 loc) · 8.84 KB
/
config.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
// Copyright 2015 The Cockroach Authors.
//
// 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.
//
// Author: Marc Berhault (marc@cockroachlabs.com)
package base
import (
"crypto/tls"
"fmt"
"net/http"
"net/url"
"sync"
"time"
"github.com/cockroachdb/cockroach/pkg/security"
"github.com/cockroachdb/cockroach/pkg/util/retry"
"github.com/cockroachdb/cockroach/pkg/util/stop"
"github.com/pkg/errors"
)
// Base config defaults.
const (
defaultInsecure = false
defaultUser = security.RootUser
httpScheme = "http"
httpsScheme = "https"
// From IANA Service Name and Transport Protocol Port Number Registry. See
// https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml?search=cockroachdb
DefaultPort = "26257"
// The default port for HTTP-for-humans.
DefaultHTTPPort = "8080"
// NB: net.JoinHostPort is not a constant.
defaultAddr = ":" + DefaultPort
defaultHTTPAddr = ":" + DefaultHTTPPort
// NetworkTimeout is the timeout used for network operations.
NetworkTimeout = 3 * time.Second
// DefaultRaftTickInterval is the default resolution of the Raft timer.
DefaultRaftTickInterval = 200 * time.Millisecond
// DefaultCertsDirectory is the default value for the cert directory flag.
DefaultCertsDirectory = "${HOME}/.cockroach-certs"
)
type lazyHTTPClient struct {
once sync.Once
httpClient http.Client
err error
}
type lazyCertificateManager struct {
once sync.Once
cm *security.CertificateManager
err error
}
// Config is embedded by server.Config. A base config is not meant to be used
// directly, but embedding configs should call cfg.InitDefaults().
type Config struct {
// Insecure specifies whether to use SSL or not.
// This is really not recommended.
Insecure bool
// SSLCAKey is used to sign new certs.
SSLCAKey string
// SSLCertsDir is the path to the certificate/key directory.
SSLCertsDir string
// User running this process. It could be the user under which
// the server is running or the user passed in client calls.
User string
// Addr is the address the server is listening on.
Addr string
// AdvertiseAddr is the address advertised by the server to other nodes
// in the cluster. It should be reachable by all other nodes and should
// route to an interface that Addr is listening on.
AdvertiseAddr string
// HTTPAddr is server's public HTTP address.
//
// This is temporary, and will be removed when grpc.(*Server).ServeHTTP
// performance problems are addressed upstream.
//
// See https://github.com/grpc/grpc-go/issues/586.
HTTPAddr string
// The certificate manager. Must be accessed through GetCertificateManager.
certificateManager lazyCertificateManager
// httpClient uses the client TLS config. It is initialized lazily.
httpClient lazyHTTPClient
// HistogramWindowInterval is used to determine the approximate length of time
// that individual samples are retained in in-memory histograms. Currently,
// it is set to the arbitrary length of six times the Metrics sample interval.
// See the comment in server.Config for more details.
HistogramWindowInterval time.Duration
}
func didYouMeanInsecureError(err error) error {
return errors.Wrap(err, "problem using security settings, did you mean to use --insecure?")
}
// InitDefaults sets up the default values for a config.
// This is also used in tests to reset global objects.
func (cfg *Config) InitDefaults() {
cfg.Insecure = defaultInsecure
cfg.User = defaultUser
cfg.Addr = defaultAddr
cfg.AdvertiseAddr = cfg.Addr
cfg.HTTPAddr = defaultHTTPAddr
cfg.SSLCertsDir = DefaultCertsDirectory
cfg.certificateManager = lazyCertificateManager{}
}
// HTTPRequestScheme returns "http" or "https" based on the value of Insecure.
func (cfg *Config) HTTPRequestScheme() string {
if cfg.Insecure {
return httpScheme
}
return httpsScheme
}
// AdminURL returns the URL for the admin UI.
func (cfg *Config) AdminURL() string {
return fmt.Sprintf("%s://%s", cfg.HTTPRequestScheme(), cfg.HTTPAddr)
}
// GetClientCertPaths returns the paths to the client cert and key.
func (cfg *Config) GetClientCertPaths(user string) (string, string, error) {
cm, err := cfg.GetCertificateManager()
if err != nil {
return "", "", err
}
return cm.GetClientCertPaths(user)
}
// GetCACertPath returns the path to the CA certificate.
func (cfg *Config) GetCACertPath() (string, error) {
cm, err := cfg.GetCertificateManager()
if err != nil {
return "", err
}
return cm.GetCACertPath()
}
// ClientHasValidCerts returns true if the specified client has a valid client cert and key.
func (cfg *Config) ClientHasValidCerts(user string) bool {
_, _, err := cfg.GetClientCertPaths(user)
return err == nil
}
// PGURL returns the URL for the postgres endpoint.
func (cfg *Config) PGURL(user *url.Userinfo) (*url.URL, error) {
options := url.Values{}
if cfg.Insecure {
options.Add("sslmode", "disable")
} else {
// Fetch CA cert. This is required.
caCertPath, err := cfg.GetCACertPath()
if err != nil {
return nil, didYouMeanInsecureError(err)
}
options.Add("sslmode", "verify-full")
options.Add("sslrootcert", caCertPath)
// Fetch certs, but don't fail, we may be using a password.
certPath, keyPath, err := cfg.GetClientCertPaths(user.Username())
if err == nil {
options.Add("sslcert", certPath)
options.Add("sslkey", keyPath)
}
}
return &url.URL{
Scheme: "postgresql",
User: user,
Host: cfg.AdvertiseAddr,
RawQuery: options.Encode(),
}, nil
}
// GetCertificateManager returns the certificate manager, initializing it
// on the first call.
func (cfg *Config) GetCertificateManager() (*security.CertificateManager, error) {
cfg.certificateManager.once.Do(func() {
cfg.certificateManager.cm, cfg.certificateManager.err =
security.NewCertificateManager(cfg.SSLCertsDir)
})
return cfg.certificateManager.cm, cfg.certificateManager.err
}
// InitializeNodeTLSConfigs tries to load client and server-side TLS configs.
// It also enables the reload-on-SIGHUP functionality on the certificate manager.
// This should be called early in the life of the server to make sure there are no
// issues with TLS configs.
func (cfg *Config) InitializeNodeTLSConfigs(stopper *stop.Stopper) error {
if cfg.Insecure {
return nil
}
if _, err := cfg.GetServerTLSConfig(); err != nil {
return err
}
if _, err := cfg.GetClientTLSConfig(); err != nil {
return err
}
cm, err := cfg.GetCertificateManager()
if err != nil {
return err
}
cm.RegisterSignalHandler(stopper)
return nil
}
// GetClientTLSConfig returns the client TLS config, initializing it if needed.
// If Insecure is true, return a nil config, otherwise ask the certificate
// manager for a TLS config using certs for the config.User.
func (cfg *Config) GetClientTLSConfig() (*tls.Config, error) {
// Early out.
if cfg.Insecure {
return nil, nil
}
cm, err := cfg.GetCertificateManager()
if err != nil {
return nil, didYouMeanInsecureError(err)
}
tlsCfg, err := cm.GetClientTLSConfig(cfg.User)
if err != nil {
return nil, didYouMeanInsecureError(err)
}
return tlsCfg, nil
}
// GetServerTLSConfig returns the server TLS config, initializing it if needed.
// If Insecure is true, return a nil config, otherwise ask the certificate
// manager for a server TLS config.
func (cfg *Config) GetServerTLSConfig() (*tls.Config, error) {
// Early out.
if cfg.Insecure {
return nil, nil
}
cm, err := cfg.GetCertificateManager()
if err != nil {
return nil, didYouMeanInsecureError(err)
}
tlsCfg, err := cm.GetServerTLSConfig()
if err != nil {
return nil, didYouMeanInsecureError(err)
}
return tlsCfg, nil
}
// GetHTTPClient returns the http client, initializing it
// if needed. It uses the client TLS config.
func (cfg *Config) GetHTTPClient() (http.Client, error) {
cfg.httpClient.once.Do(func() {
cfg.httpClient.httpClient.Timeout = NetworkTimeout
var transport http.Transport
cfg.httpClient.httpClient.Transport = &transport
transport.TLSClientConfig, cfg.httpClient.err = cfg.GetClientTLSConfig()
})
return cfg.httpClient.httpClient, cfg.httpClient.err
}
// DefaultRetryOptions should be used for retrying most
// network-dependent operations.
func DefaultRetryOptions() retry.Options {
// TODO(bdarnell): This should vary with network latency.
// Derive the retry options from a configured or measured
// estimate of latency.
return retry.Options{
InitialBackoff: 10 * time.Millisecond,
MaxBackoff: 1 * time.Second,
Multiplier: 1.5,
}
}