-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
dbconfigs.go
426 lines (376 loc) · 15 KB
/
dbconfigs.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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
/*
Copyright 2019 The Vitess 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.
*/
// Package dbconfigs provides the registration for command line options
// to collect db connection parameters. Once registered and collected,
// it provides variables and functions to build connection parameters
// for connecting to the database.
package dbconfigs
import (
"context"
"encoding/json"
"github.com/spf13/pflag"
"vitess.io/vitess/go/mysql"
"vitess.io/vitess/go/mysql/collations"
"vitess.io/vitess/go/vt/log"
vtrpcpb "vitess.io/vitess/go/vt/proto/vtrpc"
"vitess.io/vitess/go/vt/servenv"
"vitess.io/vitess/go/vt/vterrors"
"vitess.io/vitess/go/vt/vttls"
"vitess.io/vitess/go/yaml2"
)
// config flags
const (
App = "app"
AppDebug = "appdebug"
// AllPrivs user should have more privileges than App (should include possibility to do
// schema changes and write to internal Vitess tables), but it shouldn't have SUPER
// privilege like Dba has.
AllPrivs = "allprivs"
Dba = "dba"
Filtered = "filtered"
Repl = "repl"
ExternalRepl = "erepl"
)
var (
// GlobalDBConfigs contains the initial values of dbconfigs from flags.
GlobalDBConfigs DBConfigs
// All can be used to register all flags: RegisterFlags(All...)
All = []string{App, AppDebug, AllPrivs, Dba, Filtered, Repl, ExternalRepl}
)
// DBConfigs stores all the data needed to build various connection
// parameters for the db. It stores credentials for app, appdebug,
// allprivs, dba, filtered and repl users.
// It contains other connection parameters like socket, charset, etc.
// It also stores the default db name, which it can combine with the
// rest of the data to build db-sepcific connection parameters.
//
// The legacy way of initializing is as follows:
// App must call RegisterFlags to request the types of connections
// it wants support for. This must be done before invoking flags.Parse.
// After flag parsing, app invokes the Init function, which will return
// a DBConfigs object.
// The app must store the DBConfigs object internally, and use it to
// build connection parameters as needed.
type DBConfigs struct {
Socket string `json:"socket,omitempty"`
Host string `json:"host,omitempty"`
Port int `json:"port,omitempty"`
Charset string `json:"charset,omitempty"`
Flags uint64 `json:"flags,omitempty"`
Flavor string `json:"flavor,omitempty"`
SslMode vttls.SslMode `json:"sslMode,omitempty"`
SslCa string `json:"sslCa,omitempty"`
SslCaPath string `json:"sslCaPath,omitempty"`
SslCert string `json:"sslCert,omitempty"`
SslKey string `json:"sslKey,omitempty"`
TLSMinVersion string `json:"tlsMinVersion,omitempty"`
ServerName string `json:"serverName,omitempty"`
ConnectTimeoutMilliseconds int `json:"connectTimeoutMilliseconds,omitempty"`
DBName string `json:"dbName,omitempty"`
EnableQueryInfo bool `json:"enableQueryInfo,omitempty"`
App UserConfig `json:"app,omitempty"`
Dba UserConfig `json:"dba,omitempty"`
Filtered UserConfig `json:"filtered,omitempty"`
Repl UserConfig `json:"repl,omitempty"`
Appdebug UserConfig `json:"appdebug,omitempty"`
Allprivs UserConfig `json:"allprivs,omitempty"`
externalRepl UserConfig
appParams mysql.ConnParams
dbaParams mysql.ConnParams
filteredParams mysql.ConnParams
replParams mysql.ConnParams
appdebugParams mysql.ConnParams
allprivsParams mysql.ConnParams
externalReplParams mysql.ConnParams
}
// UserConfig contains user-specific configs.
type UserConfig struct {
User string `json:"user,omitempty"`
Password string `json:"password,omitempty"`
UseSSL bool `json:"useSsl,omitempty"`
UseTCP bool `json:"useTcp,omitempty"`
}
// RegisterFlags registers the base DBFlags, credentials flags, and the user
// specific ones for the specified system users for the requesting command.
// For instance, the vttablet command will register flags for all users
// as defined in the dbconfigs.All variable.
func RegisterFlags(userKeys ...string) {
servenv.OnParse(func(fs *pflag.FlagSet) {
registerBaseFlags(fs)
for _, userKey := range userKeys {
uc, cp := GlobalDBConfigs.getParams(userKey)
registerPerUserFlags(fs, userKey, uc, cp)
}
})
}
func registerBaseFlags(fs *pflag.FlagSet) {
fs.StringVar(&GlobalDBConfigs.Socket, "db_socket", "", "The unix socket to connect on. If this is specified, host and port will not be used.")
fs.StringVar(&GlobalDBConfigs.Host, "db_host", "", "The host name for the tcp connection.")
fs.IntVar(&GlobalDBConfigs.Port, "db_port", 0, "tcp port")
fs.StringVar(&GlobalDBConfigs.Charset, "db_charset", "utf8mb4", "Character set used for this tablet.")
fs.Uint64Var(&GlobalDBConfigs.Flags, "db_flags", 0, "Flag values as defined by MySQL.")
fs.StringVar(&GlobalDBConfigs.Flavor, "db_flavor", "", "Flavor overrid. Valid value is FilePos.")
fs.Var(&GlobalDBConfigs.SslMode, "db_ssl_mode", "SSL mode to connect with. One of disabled, preferred, required, verify_ca & verify_identity.")
fs.StringVar(&GlobalDBConfigs.SslCa, "db_ssl_ca", "", "connection ssl ca")
fs.StringVar(&GlobalDBConfigs.SslCaPath, "db_ssl_ca_path", "", "connection ssl ca path")
fs.StringVar(&GlobalDBConfigs.SslCert, "db_ssl_cert", "", "connection ssl certificate")
fs.StringVar(&GlobalDBConfigs.SslKey, "db_ssl_key", "", "connection ssl key")
fs.StringVar(&GlobalDBConfigs.TLSMinVersion, "db_tls_min_version", "", "Configures the minimal TLS version negotiated when SSL is enabled. Defaults to TLSv1.2. Options: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3.")
fs.StringVar(&GlobalDBConfigs.ServerName, "db_server_name", "", "server name of the DB we are connecting to.")
fs.IntVar(&GlobalDBConfigs.ConnectTimeoutMilliseconds, "db_connect_timeout_ms", 0, "connection timeout to mysqld in milliseconds (0 for no timeout)")
fs.BoolVar(&GlobalDBConfigs.EnableQueryInfo, "db_conn_query_info", false, "enable parsing and processing of QUERY_OK info fields")
}
// The flags will change the global singleton
func registerPerUserFlags(fs *pflag.FlagSet, userKey string, uc *UserConfig, cp *mysql.ConnParams) {
newUserFlag := "db_" + userKey + "_user"
fs.StringVar(&uc.User, newUserFlag, "vt_"+userKey, "db "+userKey+" user userKey")
newPasswordFlag := "db_" + userKey + "_password"
fs.StringVar(&uc.Password, newPasswordFlag, "", "db "+userKey+" password")
fs.BoolVar(&uc.UseSSL, "db_"+userKey+"_use_ssl", true, "Set this flag to false to make the "+userKey+" connection to not use ssl")
}
// Connector contains Connection Parameters for mysql connection
type Connector struct {
connParams *mysql.ConnParams
}
// New initializes a ConnParams from mysql connection parameters
func New(mcp *mysql.ConnParams) Connector {
return Connector{
connParams: mcp,
}
}
// Connect will invoke the mysql.connect method and return a connection
func (c *Connector) Connect(ctx context.Context) (*mysql.Conn, error) {
params, err := c.MysqlParams()
if err != nil {
return nil, err
}
conn, err := mysql.Connect(ctx, params)
if err != nil {
return nil, err
}
return conn, nil
}
// MysqlParams returns the connections params
func (c Connector) MysqlParams() (*mysql.ConnParams, error) {
if c.connParams == nil {
// This is only possible during tests.
return nil, vterrors.New(vtrpcpb.Code_INVALID_ARGUMENT, "parameters are empty")
}
params, err := withCredentials(c.connParams)
if err != nil {
return nil, err
}
return params, nil
}
// DBName gets the dbname from mysql.ConnParams
func (c Connector) DBName() string {
return c.connParams.DbName
}
// Host gets the host from mysql.ConnParams
func (c Connector) Host() string {
return c.connParams.Host
}
// AppWithDB returns connection parameters for app with dbname set.
func (dbcfgs *DBConfigs) AppWithDB() Connector {
return dbcfgs.makeParams(&dbcfgs.appParams, true)
}
// AppDebugWithDB returns connection parameters for appdebug with dbname set.
func (dbcfgs *DBConfigs) AppDebugWithDB() Connector {
return dbcfgs.makeParams(&dbcfgs.appdebugParams, true)
}
// AllPrivsConnector returns connection parameters for allprivs with no dbname set.
func (dbcfgs *DBConfigs) AllPrivsConnector() Connector {
return dbcfgs.makeParams(&dbcfgs.allprivsParams, false)
}
// AllPrivsWithDB returns connection parameters for allprivs with dbname set.
func (dbcfgs *DBConfigs) AllPrivsWithDB() Connector {
return dbcfgs.makeParams(&dbcfgs.allprivsParams, true)
}
// DbaConnector returns connection parameters for dba with no dbname set.
func (dbcfgs *DBConfigs) DbaConnector() Connector {
return dbcfgs.makeParams(&dbcfgs.dbaParams, false)
}
// DbaWithDB returns connection parameters for appdebug with dbname set.
func (dbcfgs *DBConfigs) DbaWithDB() Connector {
return dbcfgs.makeParams(&dbcfgs.dbaParams, true)
}
// FilteredWithDB returns connection parameters for filtered with dbname set.
func (dbcfgs *DBConfigs) FilteredWithDB() Connector {
return dbcfgs.makeParams(&dbcfgs.filteredParams, true)
}
// ReplConnector returns connection parameters for repl with no dbname set.
func (dbcfgs *DBConfigs) ReplConnector() Connector {
return dbcfgs.makeParams(&dbcfgs.replParams, false)
}
// ExternalRepl returns connection parameters for repl with no dbname set.
func (dbcfgs *DBConfigs) ExternalRepl() Connector {
return dbcfgs.makeParams(&dbcfgs.externalReplParams, true)
}
// ExternalReplWithDB returns connection parameters for repl with dbname set.
func (dbcfgs *DBConfigs) ExternalReplWithDB() Connector {
params := dbcfgs.makeParams(&dbcfgs.externalReplParams, true)
return params
}
// AppWithDB returns connection parameters for app with dbname set.
func (dbcfgs *DBConfigs) makeParams(cp *mysql.ConnParams, withDB bool) Connector {
result := *cp
if withDB {
result.DbName = dbcfgs.DBName
}
return Connector{
connParams: &result,
}
}
// IsZero returns true if DBConfigs was uninitialized.
func (dbcfgs *DBConfigs) IsZero() bool {
return *dbcfgs == DBConfigs{}
}
// HasGlobalSettings returns true if DBConfigs contains values
// for global configs.
func (dbcfgs *DBConfigs) HasGlobalSettings() bool {
return dbcfgs.Host != "" || dbcfgs.Socket != ""
}
func (dbcfgs *DBConfigs) String() string {
out, err := yaml2.Marshal(dbcfgs.Redacted())
if err != nil {
return err.Error()
}
return string(out)
}
// MarshalJSON marshals after redacting passwords.
func (dbcfgs *DBConfigs) MarshalJSON() ([]byte, error) {
type nonCustom DBConfigs
return json.Marshal((*nonCustom)(dbcfgs.Redacted()))
}
// Redacted redacts passwords from DBConfigs.
func (dbcfgs *DBConfigs) Redacted() *DBConfigs {
dbcfgs = dbcfgs.Clone()
dbcfgs.App.Password = "****"
dbcfgs.Dba.Password = "****"
dbcfgs.Filtered.Password = "****"
dbcfgs.Repl.Password = "****"
dbcfgs.Appdebug.Password = "****"
dbcfgs.Allprivs.Password = "****"
return dbcfgs
}
// Clone returns a clone of the DBConfig.
func (dbcfgs *DBConfigs) Clone() *DBConfigs {
result := *dbcfgs
return &result
}
// InitWithSocket will initialize all the necessary connection parameters.
// Precedence is as follows: if UserConfig settings are set,
// they supersede all other settings.
// The next priority is with per-user connection
// parameters. This is only for legacy support.
// If no per-user parameters are supplied, then the defaultSocketFile
// is used to initialize the per-user conn params.
func (dbcfgs *DBConfigs) InitWithSocket(defaultSocketFile string, collationEnv *collations.Environment) {
for _, userKey := range All {
uc, cp := dbcfgs.getParams(userKey)
// TODO @rafael: For ExternalRepl we need to respect the provided host / port
// At the moment this is an snowflake user connection type that it used by
// vreplication to connect to external mysql hosts that are not part of a vitess
// cluster. In the future we need to refactor all dbconfig to support custom users
// in a more flexible way.
if dbcfgs.HasGlobalSettings() && userKey != ExternalRepl {
cp.Host = dbcfgs.Host
cp.Port = dbcfgs.Port
if !uc.UseTCP {
cp.UnixSocket = dbcfgs.Socket
}
} else if cp.UnixSocket == "" && cp.Host == "" {
cp.UnixSocket = defaultSocketFile
}
// If the connection params has a charset defined, it will not be overridden by the
// global configuration.
if dbcfgs.Charset != "" && cp.Charset == collations.Unknown {
ch, err := collationEnv.ParseConnectionCharset(dbcfgs.Charset)
if err != nil {
log.Warningf("Error parsing charset %s: %v", dbcfgs.Charset, err)
ch = collationEnv.DefaultConnectionCharset()
}
cp.Charset = ch
}
if dbcfgs.Flags != 0 {
cp.Flags = dbcfgs.Flags
}
if userKey != ExternalRepl {
cp.Flavor = dbcfgs.Flavor
}
cp.ConnectTimeoutMs = uint64(dbcfgs.ConnectTimeoutMilliseconds)
cp.EnableQueryInfo = dbcfgs.EnableQueryInfo
cp.Uname = uc.User
cp.Pass = uc.Password
if uc.UseSSL {
cp.SslMode = dbcfgs.SslMode
cp.SslCa = dbcfgs.SslCa
cp.SslCaPath = dbcfgs.SslCaPath
cp.SslCert = dbcfgs.SslCert
cp.SslKey = dbcfgs.SslKey
cp.TLSMinVersion = dbcfgs.TLSMinVersion
cp.ServerName = dbcfgs.ServerName
}
}
log.Infof("DBConfigs: %v\n", dbcfgs.String())
}
func (dbcfgs *DBConfigs) getParams(userKey string) (*UserConfig, *mysql.ConnParams) {
var uc *UserConfig
var cp *mysql.ConnParams
switch userKey {
case App:
uc = &dbcfgs.App
cp = &dbcfgs.appParams
case AppDebug:
uc = &dbcfgs.Appdebug
cp = &dbcfgs.appdebugParams
case AllPrivs:
uc = &dbcfgs.Allprivs
cp = &dbcfgs.allprivsParams
case Dba:
uc = &dbcfgs.Dba
cp = &dbcfgs.dbaParams
case Filtered:
uc = &dbcfgs.Filtered
cp = &dbcfgs.filteredParams
case Repl:
uc = &dbcfgs.Repl
cp = &dbcfgs.replParams
case ExternalRepl:
uc = &dbcfgs.externalRepl
cp = &dbcfgs.externalReplParams
default:
log.Exitf("Invalid db user key requested: %s", userKey)
}
return uc, cp
}
// SetDbParams sets the dba and app params
func (dbcfgs *DBConfigs) SetDbParams(dbaParams, appParams, filteredParams mysql.ConnParams) {
dbcfgs.dbaParams = dbaParams
dbcfgs.appParams = appParams
dbcfgs.filteredParams = filteredParams
}
// NewTestDBConfigs returns a DBConfigs meant for testing.
func NewTestDBConfigs(genParams, appDebugParams mysql.ConnParams, dbname string) *DBConfigs {
return &DBConfigs{
appParams: genParams,
appdebugParams: appDebugParams,
allprivsParams: genParams,
dbaParams: genParams,
filteredParams: genParams,
replParams: genParams,
externalReplParams: genParams,
DBName: dbname,
Charset: "",
}
}