-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
auth_server_static.go
364 lines (316 loc) · 12.3 KB
/
auth_server_static.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
/*
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 mysql
import (
"bytes"
"crypto/subtle"
"crypto/x509"
"encoding/json"
"flag"
"net"
"os"
"os/signal"
"sync"
"syscall"
"time"
"vitess.io/vitess/go/vt/log"
querypb "vitess.io/vitess/go/vt/proto/query"
"vitess.io/vitess/go/vt/proto/vtrpc"
"vitess.io/vitess/go/vt/vterrors"
)
var (
mysqlAuthServerStaticFile = flag.String("mysql_auth_server_static_file", "", "JSON File to read the users/passwords from.")
mysqlAuthServerStaticString = flag.String("mysql_auth_server_static_string", "", "JSON representation of the users/passwords config.")
mysqlAuthServerStaticReloadInterval = flag.Duration("mysql_auth_static_reload_interval", 0, "Ticker to reload credentials")
)
const (
localhostName = "localhost"
)
// AuthServerStatic implements AuthServer using a static configuration.
type AuthServerStatic struct {
methods []AuthMethod
file, jsonConfig string
reloadInterval time.Duration
// This mutex helps us prevent data races between the multiple updates of entries.
mu sync.Mutex
// entries contains the users, passwords and user data.
entries map[string][]*AuthServerStaticEntry
sigChan chan os.Signal
ticker *time.Ticker
}
// AuthServerStaticEntry stores the values for a given user.
type AuthServerStaticEntry struct {
// MysqlNativePassword is generated by password hashing methods in MySQL.
// These changes are illustrated by changes in the result from the PASSWORD() function
// that computes password hash values and in the structure of the user table where passwords are stored.
// mysql> SELECT PASSWORD('mypass');
// +-------------------------------------------+
// | PASSWORD('mypass') |
// +-------------------------------------------+
// | *6C8989366EAF75BB670AD8EA7A7FC1176A95CEF4 |
// +-------------------------------------------+
// MysqlNativePassword's format looks like "*6C8989366EAF75BB670AD8EA7A7FC1176A95CEF4", it store a hashing value.
// Use MysqlNativePassword in auth config, maybe more secure. After all, it is cryptographic storage.
MysqlNativePassword string
Password string
UserData string
SourceHost string
Groups []string
}
// InitAuthServerStatic Handles initializing the AuthServerStatic if necessary.
func InitAuthServerStatic() {
// Check parameters.
if *mysqlAuthServerStaticFile == "" && *mysqlAuthServerStaticString == "" {
// Not configured, nothing to do.
log.Infof("Not configuring AuthServerStatic, as mysql_auth_server_static_file and mysql_auth_server_static_string are empty")
return
}
if *mysqlAuthServerStaticFile != "" && *mysqlAuthServerStaticString != "" {
// Both parameters specified, can only use one.
log.Exitf("Both mysql_auth_server_static_file and mysql_auth_server_static_string specified, can only use one.")
}
// Create and register auth server.
RegisterAuthServerStaticFromParams(*mysqlAuthServerStaticFile, *mysqlAuthServerStaticString, *mysqlAuthServerStaticReloadInterval)
}
// RegisterAuthServerStaticFromParams creates and registers a new
// AuthServerStatic, loaded for a JSON file or string. If file is set,
// it uses file. Otherwise, load the string. It log.Exits out in case
// of error.
func RegisterAuthServerStaticFromParams(file, jsonConfig string, reloadInterval time.Duration) {
authServerStatic := NewAuthServerStatic(file, jsonConfig, reloadInterval)
if len(authServerStatic.entries) <= 0 {
log.Exitf("Failed to populate entries from file: %v", file)
}
RegisterAuthServer("static", authServerStatic)
}
// NewAuthServerStatic returns a new empty AuthServerStatic.
func NewAuthServerStatic(file, jsonConfig string, reloadInterval time.Duration) *AuthServerStatic {
a := &AuthServerStatic{
file: file,
jsonConfig: jsonConfig,
reloadInterval: reloadInterval,
entries: make(map[string][]*AuthServerStaticEntry),
}
a.methods = []AuthMethod{NewMysqlNativeAuthMethod(a, a)}
a.reload()
a.installSignalHandlers()
return a
}
// NewAuthServerStaticWithAuthMethodDescription returns a new empty AuthServerStatic
// but with support for a different auth method. Mostly used for testing purposes.
func NewAuthServerStaticWithAuthMethodDescription(file, jsonConfig string, reloadInterval time.Duration, authMethodDescription AuthMethodDescription) *AuthServerStatic {
a := &AuthServerStatic{
file: file,
jsonConfig: jsonConfig,
reloadInterval: reloadInterval,
entries: make(map[string][]*AuthServerStaticEntry),
}
var authMethod AuthMethod
switch authMethodDescription {
case CachingSha2Password:
authMethod = NewSha2CachingAuthMethod(a, a, a)
case MysqlNativePassword:
authMethod = NewMysqlNativeAuthMethod(a, a)
case MysqlClearPassword:
authMethod = NewMysqlClearAuthMethod(a, a)
case MysqlDialog:
authMethod = NewMysqlDialogAuthMethod(a, a, "")
}
a.methods = []AuthMethod{authMethod}
a.reload()
a.installSignalHandlers()
return a
}
// HandleUser is part of the Validator interface. We
// handle any user here since we don't check up front.
func (a *AuthServerStatic) HandleUser(user string) bool {
return true
}
// UserEntryWithPassword implements password lookup based on a plain
// text password that is negotiated with the client.
func (a *AuthServerStatic) UserEntryWithPassword(userCerts []*x509.Certificate, user string, password string, remoteAddr net.Addr) (Getter, error) {
a.mu.Lock()
entries, ok := a.entries[user]
a.mu.Unlock()
if !ok {
return &StaticUserData{}, NewSQLError(ERAccessDeniedError, SSAccessDeniedError, "Access denied for user '%v'", user)
}
for _, entry := range entries {
// Validate the password.
if MatchSourceHost(remoteAddr, entry.SourceHost) && subtle.ConstantTimeCompare([]byte(password), []byte(entry.Password)) == 1 {
return &StaticUserData{entry.UserData, entry.Groups}, nil
}
}
return &StaticUserData{}, NewSQLError(ERAccessDeniedError, SSAccessDeniedError, "Access denied for user '%v'", user)
}
// UserEntryWithHash implements password lookup based on a
// mysql_native_password hash that is negotiated with the client.
func (a *AuthServerStatic) UserEntryWithHash(userCerts []*x509.Certificate, salt []byte, user string, authResponse []byte, remoteAddr net.Addr) (Getter, error) {
a.mu.Lock()
entries, ok := a.entries[user]
a.mu.Unlock()
if !ok {
return &StaticUserData{}, NewSQLError(ERAccessDeniedError, SSAccessDeniedError, "Access denied for user '%v'", user)
}
for _, entry := range entries {
if entry.MysqlNativePassword != "" {
hash, err := DecodeMysqlNativePasswordHex(entry.MysqlNativePassword)
if err != nil {
return &StaticUserData{entry.UserData, entry.Groups}, NewSQLError(ERAccessDeniedError, SSAccessDeniedError, "Access denied for user '%v'", user)
}
isPass := VerifyHashedMysqlNativePassword(authResponse, salt, hash)
if MatchSourceHost(remoteAddr, entry.SourceHost) && isPass {
return &StaticUserData{entry.UserData, entry.Groups}, nil
}
} else {
computedAuthResponse := ScrambleMysqlNativePassword(salt, []byte(entry.Password))
// Validate the password.
if MatchSourceHost(remoteAddr, entry.SourceHost) && subtle.ConstantTimeCompare(authResponse, computedAuthResponse) == 1 {
return &StaticUserData{entry.UserData, entry.Groups}, nil
}
}
}
return &StaticUserData{}, NewSQLError(ERAccessDeniedError, SSAccessDeniedError, "Access denied for user '%v'", user)
}
// UserEntryWithCacheHash implements password lookup based on a
// caching_sha2_password hash that is negotiated with the client.
func (a *AuthServerStatic) UserEntryWithCacheHash(userCerts []*x509.Certificate, salt []byte, user string, authResponse []byte, remoteAddr net.Addr) (Getter, CacheState, error) {
a.mu.Lock()
entries, ok := a.entries[user]
a.mu.Unlock()
if !ok {
return &StaticUserData{}, AuthRejected, NewSQLError(ERAccessDeniedError, SSAccessDeniedError, "Access denied for user '%v'", user)
}
for _, entry := range entries {
computedAuthResponse := ScrambleCachingSha2Password(salt, []byte(entry.Password))
// Validate the password.
if MatchSourceHost(remoteAddr, entry.SourceHost) && subtle.ConstantTimeCompare(authResponse, computedAuthResponse) == 1 {
return &StaticUserData{entry.UserData, entry.Groups}, AuthAccepted, nil
}
}
return &StaticUserData{}, AuthRejected, NewSQLError(ERAccessDeniedError, SSAccessDeniedError, "Access denied for user '%v'", user)
}
// AuthMethods returns the AuthMethod instances this auth server can handle.
func (a *AuthServerStatic) AuthMethods() []AuthMethod {
return a.methods
}
// DefaultAuthMethodDescription returns the default auth method in the handshake which
// is MysqlNativePassword for this auth server.
func (a *AuthServerStatic) DefaultAuthMethodDescription() AuthMethodDescription {
return MysqlNativePassword
}
func (a *AuthServerStatic) reload() {
jsonBytes := []byte(a.jsonConfig)
if a.file != "" {
data, err := os.ReadFile(a.file)
if err != nil {
log.Errorf("Failed to read mysql_auth_server_static_file file: %v", err)
return
}
jsonBytes = data
}
entries := make(map[string][]*AuthServerStaticEntry)
if err := ParseConfig(jsonBytes, &entries); err != nil {
log.Errorf("Error parsing auth server config: %v", err)
return
}
a.mu.Lock()
a.entries = entries
a.mu.Unlock()
}
func (a *AuthServerStatic) installSignalHandlers() {
if a.file == "" {
return
}
a.sigChan = make(chan os.Signal, 1)
signal.Notify(a.sigChan, syscall.SIGHUP)
go func() {
for range a.sigChan {
a.reload()
}
}()
// If duration is set, it will reload configuration every interval
if a.reloadInterval > 0 {
a.ticker = time.NewTicker(a.reloadInterval)
go func() {
for range a.ticker.C {
a.sigChan <- syscall.SIGHUP
}
}()
}
}
func (a *AuthServerStatic) close() {
if a.ticker != nil {
a.ticker.Stop()
}
if a.sigChan != nil {
signal.Stop(a.sigChan)
}
}
// ParseConfig takes a JSON MySQL static config and converts to a validated map
func ParseConfig(jsonBytes []byte, config *map[string][]*AuthServerStaticEntry) error {
decoder := json.NewDecoder(bytes.NewReader(jsonBytes))
decoder.DisallowUnknownFields()
if err := decoder.Decode(config); err != nil {
// Couldn't parse, will try to parse with legacy config
return parseLegacyConfig(jsonBytes, config)
}
return validateConfig(*config)
}
func parseLegacyConfig(jsonBytes []byte, config *map[string][]*AuthServerStaticEntry) error {
// legacy config doesn't have an array
legacyConfig := make(map[string]*AuthServerStaticEntry)
decoder := json.NewDecoder(bytes.NewReader(jsonBytes))
decoder.DisallowUnknownFields()
if err := decoder.Decode(&legacyConfig); err != nil {
return err
}
log.Warningf("Config parsed using legacy configuration. Please update to the latest format: {\"user\":[{\"Password\": \"xxx\"}, ...]}")
for key, value := range legacyConfig {
(*config)[key] = append((*config)[key], value)
}
return nil
}
func validateConfig(config map[string][]*AuthServerStaticEntry) error {
for _, entries := range config {
for _, entry := range entries {
if entry.SourceHost != "" && entry.SourceHost != localhostName {
return vterrors.Errorf(vtrpc.Code_INVALID_ARGUMENT, "invalid SourceHost found (only localhost is supported): %v", entry.SourceHost)
}
}
}
return nil
}
// MatchSourceHost validates host entry in auth configuration
func MatchSourceHost(remoteAddr net.Addr, targetSourceHost string) bool {
// Legacy support, there was not matcher defined default to true
if targetSourceHost == "" {
return true
}
switch remoteAddr.(type) {
case *net.UnixAddr:
if targetSourceHost == localhostName {
return true
}
}
return false
}
// StaticUserData holds the username and groups
type StaticUserData struct {
Username string
Groups []string
}
// Get returns the wrapped username and groups
func (sud *StaticUserData) Get() *querypb.VTGateCallerID {
return &querypb.VTGateCallerID{Username: sud.Username, Groups: sud.Groups}
}