forked from mongodb/mongo-tools-common
/
db.go
544 lines (459 loc) · 15.9 KB
/
db.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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
// Copyright (C) MongoDB, Inc. 2014-present.
//
// 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
// Package db implements generic connection to MongoDB, and contains
// subpackages for specific methods of connection.
package db
import (
"bytes"
"context"
"crypto/tls"
"crypto/x509"
"encoding/pem"
"errors"
"fmt"
"io/ioutil"
"strings"
"sync"
"time"
"github.com/mongodb/mongo-tools-common/log"
"github.com/mongodb/mongo-tools-common/options"
"github.com/mongodb/mongo-tools-common/password"
"go.mongodb.org/mongo-driver/bson"
"go.mongodb.org/mongo-driver/mongo"
mopt "go.mongodb.org/mongo-driver/mongo/options"
"go.mongodb.org/mongo-driver/mongo/readconcern"
"go.mongodb.org/mongo-driver/mongo/readpref"
"go.mongodb.org/mongo-driver/mongo/writeconcern"
"go.mongodb.org/mongo-driver/tag"
)
type (
sessionFlag uint32
)
// Session flags.
const (
None sessionFlag = 0
Monotonic sessionFlag = 1 << iota
DisableSocketTimeout
)
// MongoDB enforced limits.
const (
MaxBSONSize = 16 * 1024 * 1024 // 16MB - maximum BSON document size
)
// Default port for integration tests
const (
DefaultTestPort = "33333"
)
const (
ErrLostConnection = "lost connection to server"
ErrNoReachableServers = "no reachable servers"
ErrNsNotFound = "ns not found"
// replication errors list the replset name if we are talking to a mongos,
// so we can only check for this universal prefix
ErrReplTimeoutPrefix = "waiting for replication timed out"
ErrCouldNotContactPrimaryPrefix = "could not contact primary for replica set"
ErrWriteResultsUnavailable = "write results unavailable from"
ErrCouldNotFindPrimaryPrefix = `could not find host matching read preference { mode: "primary"`
ErrUnableToTargetPrefix = "unable to target"
ErrNotMaster = "not master"
ErrConnectionRefusedSuffix = "Connection refused"
// ignorable errors
ErrDuplicateKeyCode = 11000
ErrFailedDocumentValidation = 121
ErrUnacknowledgedWrite = "unacknowledged write"
)
var ignorableWriteErrorCodes = map[int]bool{ErrDuplicateKeyCode: true, ErrFailedDocumentValidation: true}
const (
continueThroughErrorFormat = "continuing through error: %v"
)
// Used to manage database sessions
type SessionProvider struct {
sync.Mutex
// the master client used for operations
client *mongo.Client
}
// Returns a mongo.Client connected to the database server for which the
// session provider is configured.
func (sp *SessionProvider) GetSession() (*mongo.Client, error) {
sp.Lock()
defer sp.Unlock()
if sp.client == nil {
return nil, errors.New("SessionProvider already closed")
}
return sp.client, nil
}
// Close closes the master session in the connection pool
func (sp *SessionProvider) Close() {
sp.Lock()
defer sp.Unlock()
if sp.client != nil {
_ = sp.client.Disconnect(context.Background())
sp.client = nil
}
}
// DB provides a database with the default read preference
func (sp *SessionProvider) DB(name string) *mongo.Database {
return sp.client.Database(name)
}
// NewSessionProvider constructs a session provider, including a connected client.
func NewSessionProvider(opts options.ToolOptions) (*SessionProvider, error) {
// finalize auth options, filling in missing passwords
if opts.Auth.ShouldAskForPassword() {
pass, err := password.Prompt()
if err != nil {
return nil, fmt.Errorf("error reading password: %v", err)
}
opts.Auth.Password = pass
}
client, err := configureClient(opts)
if err != nil {
return nil, fmt.Errorf("error configuring the connector: %v", err)
}
err = client.Connect(context.Background())
if err != nil {
return nil, err
}
err = client.Ping(context.Background(), nil)
if err != nil {
return nil, fmt.Errorf("could not connect to server: %v", err)
}
// create the provider
return &SessionProvider{client: client}, nil
}
// addClientCertFromFile adds a client certificate to the configuration given a path to the
// containing file and returns the certificate's subject name.
func addClientCertFromFile(cfg *tls.Config, clientFile, keyPassword string) (string, error) {
data, err := ioutil.ReadFile(clientFile)
if err != nil {
return "", err
}
return addClientCertFromBytes(cfg, data, keyPassword)
}
func addClientCertFromSeparateFiles(cfg *tls.Config, keyFile, certFile, keyPassword string) (string, error) {
keyData, err := ioutil.ReadFile(keyFile)
if err != nil {
return "", err
}
certData, err := ioutil.ReadFile(certFile)
if err != nil {
return "", err
}
data := append(keyData, '\n')
data = append(data, certData...)
return addClientCertFromBytes(cfg, data, keyPassword)
}
// addClientCertFromBytes adds a client certificate to the configuration given a path to the
// containing file and returns the certificate's subject name.
func addClientCertFromBytes(cfg *tls.Config, data []byte, keyPasswd string) (string, error) {
var currentBlock *pem.Block
var certBlock, certDecodedBlock, keyBlock []byte
remaining := data
start := 0
for {
currentBlock, remaining = pem.Decode(remaining)
if currentBlock == nil {
break
}
if currentBlock.Type == "CERTIFICATE" {
certBlock = data[start : len(data)-len(remaining)]
certDecodedBlock = currentBlock.Bytes
start += len(certBlock)
} else if strings.HasSuffix(currentBlock.Type, "PRIVATE KEY") {
if keyPasswd != "" && x509.IsEncryptedPEMBlock(currentBlock) {
var encoded bytes.Buffer
buf, err := x509.DecryptPEMBlock(currentBlock, []byte(keyPasswd))
if err != nil {
return "", err
}
pem.Encode(&encoded, &pem.Block{Type: currentBlock.Type, Bytes: buf})
keyBlock = encoded.Bytes()
start = len(data) - len(remaining)
} else {
keyBlock = data[start : len(data)-len(remaining)]
start += len(keyBlock)
}
}
}
if len(certBlock) == 0 {
return "", fmt.Errorf("failed to find CERTIFICATE")
}
if len(keyBlock) == 0 {
return "", fmt.Errorf("failed to find PRIVATE KEY")
}
cert, err := tls.X509KeyPair(certBlock, keyBlock)
if err != nil {
return "", err
}
cfg.Certificates = append(cfg.Certificates, cert)
// The documentation for the tls.X509KeyPair indicates that the Leaf certificate is not
// retained.
crt, err := x509.ParseCertificate(certDecodedBlock)
if err != nil {
return "", err
}
return crt.Subject.String(), nil
}
// create a username for x509 authentication from an x509 certificate subject.
func extractX509UsernameFromSubject(subject string) string {
// the Go x509 package gives the subject with the pairs in the reverse order from what we want.
pairs := strings.Split(subject, ",")
for left, right := 0, len(pairs)-1; left < right; left, right = left+1, right-1 {
pairs[left], pairs[right] = pairs[right], pairs[left]
}
return strings.Join(pairs, ",")
}
// addCACertsFromFile adds root CA certificate and all the intermediate certificates in the same file to the configuration given a path
// to the containing file.
func addCACertsFromFile(cfg *tls.Config, file string) error {
data, err := ioutil.ReadFile(file)
if err != nil {
return err
}
if cfg.RootCAs == nil {
cfg.RootCAs = x509.NewCertPool()
}
if cfg.RootCAs.AppendCertsFromPEM(data) == false {
return fmt.Errorf("SSL trusted server certificates file does not contain any valid certificates. File: `%v`", file)
}
return nil
}
// configure the client according to the options set in the uri and in the provided ToolOptions, with ToolOptions having precedence.
func configureClient(opts options.ToolOptions) (*mongo.Client, error) {
if opts.URI == nil || opts.URI.ConnectionString == "" {
// XXX Normal operations shouldn't ever reach here because a URI should
// be created in options parsing, but tests still manually construct
// options and generally don't construct a URI, so we invoke the URI
// normalization routine here to correct for that.
opts.NormalizeOptionsAndURI()
}
clientopt := mopt.Client()
cs := opts.URI.ParsedConnString()
clientopt.Hosts = cs.Hosts
if opts.RetryWrites != nil {
clientopt.SetRetryWrites(*opts.RetryWrites)
}
clientopt.SetConnectTimeout(time.Duration(opts.Timeout) * time.Second)
clientopt.SetSocketTimeout(time.Duration(opts.SocketTimeout) * time.Second)
if opts.Connection.ServerSelectionTimeout > 0 {
clientopt.SetServerSelectionTimeout(time.Duration(opts.Connection.ServerSelectionTimeout) * time.Second)
}
clientopt.SetReplicaSet(opts.ReplicaSetName)
clientopt.SetAppName(opts.AppName)
if opts.Direct {
clientopt.SetDirect(true)
t := true
clientopt.AuthenticateToAnything = &t
}
if opts.ReadPreference != nil {
clientopt.SetReadPreference(opts.ReadPreference)
}
if opts.WriteConcern != nil {
clientopt.SetWriteConcern(opts.WriteConcern)
} else {
// If no write concern was specified, default to majority
clientopt.SetWriteConcern(writeconcern.New(writeconcern.WMajority()))
}
if opts.Compressors != "" && opts.Compressors != "none" {
clientopt.SetCompressors(strings.Split(opts.Compressors, ","))
}
if cs.ZlibLevelSet {
clientopt.SetZlibLevel(cs.ZlibLevel)
}
if cs.ZstdLevelSet {
clientopt.SetZstdLevel(cs.ZstdLevel)
}
if cs.HeartbeatIntervalSet {
clientopt.SetHeartbeatInterval(cs.HeartbeatInterval)
}
if cs.LocalThresholdSet {
clientopt.SetLocalThreshold(cs.LocalThreshold)
}
if cs.MaxConnIdleTimeSet {
clientopt.SetMaxConnIdleTime(cs.MaxConnIdleTime)
}
if cs.MaxPoolSizeSet {
clientopt.SetMaxPoolSize(cs.MaxPoolSize)
}
if cs.MinPoolSizeSet {
clientopt.SetMinPoolSize(cs.MinPoolSize)
}
if cs.ReadConcernLevel != "" {
rc := readconcern.New(readconcern.Level(cs.ReadConcernLevel))
clientopt.SetReadConcern(rc)
}
if cs.ReadPreference != "" || len(cs.ReadPreferenceTagSets) > 0 || cs.MaxStalenessSet {
readPrefOpts := make([]readpref.Option, 0, 1)
tagSets := tag.NewTagSetsFromMaps(cs.ReadPreferenceTagSets)
if len(tagSets) > 0 {
readPrefOpts = append(readPrefOpts, readpref.WithTagSets(tagSets...))
}
if cs.MaxStaleness != 0 {
readPrefOpts = append(readPrefOpts, readpref.WithMaxStaleness(cs.MaxStaleness))
}
mode, err := readpref.ModeFromString(cs.ReadPreference)
if err != nil {
return nil, err
}
readPref, err := readpref.New(mode, readPrefOpts...)
if err != nil {
return nil, err
}
clientopt.SetReadPreference(readPref)
}
if cs.RetryReadsSet {
clientopt.SetRetryReads(cs.RetryReads)
}
if cs.JSet || cs.WString != "" || cs.WNumberSet || cs.WTimeoutSet {
opts := make([]writeconcern.Option, 0, 1)
if len(cs.WString) > 0 {
opts = append(opts, writeconcern.WTagSet(cs.WString))
} else if cs.WNumberSet {
opts = append(opts, writeconcern.W(cs.WNumber))
}
if cs.JSet {
opts = append(opts, writeconcern.J(cs.J))
}
if cs.WTimeoutSet {
opts = append(opts, writeconcern.WTimeout(cs.WTimeout))
}
clientopt.SetWriteConcern(writeconcern.New(opts...))
}
if opts.Auth != nil && opts.Auth.IsSet() {
cred := mopt.Credential{
Username: opts.Auth.Username,
Password: opts.Auth.Password,
AuthSource: opts.GetAuthenticationDatabase(),
AuthMechanism: opts.Auth.Mechanism,
}
if cs.AuthMechanism == "MONGODB-AWS" {
cred.Username = cs.Username
cred.Password = cs.Password
cred.AuthSource = cs.AuthSource
cred.AuthMechanism = cs.AuthMechanism
cred.AuthMechanismProperties = cs.AuthMechanismProperties
}
// Technically, an empty password is possible, but the tools don't have the
// means to easily distinguish and so require a non-empty password.
if cred.Password != "" {
cred.PasswordSet = true
}
if opts.Kerberos != nil && cred.AuthMechanism == "GSSAPI" {
props := make(map[string]string)
if opts.Kerberos.Service != "" {
props["SERVICE_NAME"] = opts.Kerberos.Service
}
// XXX How do we use opts.Kerberos.ServiceHost if at all?
cred.AuthMechanismProperties = props
}
clientopt.SetAuth(cred)
}
if opts.SSL != nil && opts.UseSSL {
// Error on unsupported features
if opts.SSLFipsMode {
return nil, fmt.Errorf("FIPS mode not supported")
}
if opts.SSLCRLFile != "" {
return nil, fmt.Errorf("CRL files are not supported on this platform")
}
tlsConfig := &tls.Config{}
if opts.SSLAllowInvalidCert || opts.SSLAllowInvalidHost {
tlsConfig.InsecureSkipVerify = true
}
var x509Subject string
var keyPasswd string
var err error
if cs.SSLClientCertificateKeyPasswordSet && cs.SSLClientCertificateKeyPassword != nil {
keyPasswd = cs.SSLClientCertificateKeyPassword()
}
if cs.SSLClientCertificateKeyFileSet {
x509Subject, err = addClientCertFromFile(tlsConfig, cs.SSLClientCertificateKeyFile, keyPasswd)
} else if cs.SSLCertificateFileSet || cs.SSLPrivateKeyFileSet {
x509Subject, err = addClientCertFromSeparateFiles(tlsConfig, cs.SSLCertificateFile, cs.SSLPrivateKeyFile, keyPasswd)
}
if err != nil {
return nil, fmt.Errorf("error configuring client, can't load client certificate: %v", err)
}
if opts.SSLCAFile != "" {
if err := addCACertsFromFile(tlsConfig, opts.SSLCAFile); err != nil {
return nil, fmt.Errorf("error configuring client, can't load CA file: %v", err)
}
}
// If a username wasn't specified for x509, add one from the certificate.
if clientopt.Auth != nil && strings.ToLower(clientopt.Auth.AuthMechanism) == "mongodb-x509" && clientopt.Auth.Username == "" {
// The Go x509 package gives the subject with the pairs in reverse order that we want.
clientopt.Auth.Username = extractX509UsernameFromSubject(x509Subject)
}
clientopt.SetTLSConfig(tlsConfig)
}
if cs.SSLDisableOCSPEndpointCheckSet {
clientopt.SetDisableOCSPEndpointCheck(cs.SSLDisableOCSPEndpointCheck)
}
return mongo.NewClient(clientopt)
}
// FilterError determines whether an error needs to be propagated back to the user or can be continued through. If an
// error cannot be ignored, a non-nil error is returned. If an error can be continued through, it is logged and nil is
// returned.
func FilterError(stopOnError bool, err error) error {
if err == nil || err.Error() == ErrUnacknowledgedWrite {
return nil
}
if !stopOnError && CanIgnoreError(err) {
// Just log the error but don't propagate it.
if bwe, ok := err.(mongo.BulkWriteException); ok {
for _, be := range bwe.WriteErrors {
log.Logvf(log.Always, continueThroughErrorFormat, be.Message)
}
} else {
log.Logvf(log.Always, continueThroughErrorFormat, err)
}
return nil
}
// Propagate this error, since it's either a fatal error or the user has turned on --stopOnError
return err
}
// Returns whether the tools can continue when encountering the given error.
// Currently, only DuplicateKeyErrors are ignorable.
func CanIgnoreError(err error) bool {
if err == nil {
return true
}
switch mongoErr := err.(type) {
case mongo.WriteError:
_, ok := ignorableWriteErrorCodes[mongoErr.Code]
return ok
case mongo.BulkWriteException:
for _, writeErr := range mongoErr.WriteErrors {
if _, ok := ignorableWriteErrorCodes[writeErr.Code]; !ok {
return false
}
}
if mongoErr.WriteConcernError != nil {
log.Logvf(log.Always, "write concern error when inserting documents: %v", mongoErr.WriteConcernError)
return false
}
return true
case mongo.CommandError:
_, ok := ignorableWriteErrorCodes[int(mongoErr.Code)]
return ok
}
return false
}
// IsMMAPV1 returns whether the storage engine is MMAPV1. Also returns false
// if the storage engine type cannot be determined for some reason.
func IsMMAPV1(database *mongo.Database, collectionName string) (bool, error) {
// mmapv1 does not announce itself like other storage engines. Instead,
// we check for the key 'numExtents', which only occurs on MMAPV1.
const numExtents = "numExtents"
var collStats map[string]interface{}
singleRes := database.RunCommand(context.Background(), bson.M{"collStats": collectionName})
if err := singleRes.Err(); err != nil {
return false, err
}
if err := singleRes.Decode(&collStats); err != nil {
return false, err
}
_, ok := collStats[numExtents]
return ok, nil
}